Chilkat Online Tools

Powershell / Anypoint Platform APIs / Get alert history by id

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = New-Object Chilkat.Http

$http.SetRequestHeader("X-ANYPNT-ENV-ID","{{environment_id}}")
# Adds the "Authorization: Bearer {{token}}" header.
$http.AuthToken = "{{token}}"
$http.SetRequestHeader("X-ANYPNT-ORG-ID","{{organization_id}}")

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://domain.com/armui/api/v1/alerts/cloudhub/{{alert_id}}/history",$sbResponseBody)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($http.LastHeader)
    $("Failed.")
    exit
}

Curl Command

curl -X GET
	-H "X-ANYPNT-ENV-ID: {{environment_id}}"
	-H "X-ANYPNT-ORG-ID: {{organization_id}}"
	-H "Authorization: Bearer {{token}}"
https://domain.com/armui/api/v1/alerts/cloudhub/{{alert_id}}/history

Postman Collection Item JSON

{
  "name": "Get alert history by id",
  "request": {
    "method": "GET",
    "header": [
      {
        "description": "(Required) Identifier of the environment where the api user is currently working.",
        "key": "X-ANYPNT-ENV-ID",
        "value": "{{environment_id}}"
      },
      {
        "description": "(Required) Identifier of the sub org where the api user is currently working.",
        "key": "X-ANYPNT-ORG-ID",
        "value": "{{organization_id}}"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{token}}",
        "type": "text"
      }
    ],
    "url": {
      "raw": "{{url}}/armui/api/v1/alerts/cloudhub/{{alert_id}}/history",
      "host": [
        "{{url}}"
      ],
      "path": [
        "armui",
        "api",
        "v1",
        "alerts",
        "cloudhub",
        "{{alert_id}}",
        "history"
      ]
    },
    "description": "Returns a list of the alert history for this particular alert id"
  },
  "response": [
    {
      "name": "Untitled Example",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "(Required) Identifier of the environment where the api user is currently working.",
            "key": "X-ANYPNT-ENV-ID",
            "value": "pariatur magna in id esse"
          },
          {
            "description": "(Required) Identifier of the sub org where the api user is currently working.",
            "key": "X-ANYPNT-ORG-ID",
            "value": "pariatur magna in id esse"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/alerts/:alertId/history",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "alerts",
            ":alertId",
            "history"
          ],
          "variable": [
            {
              "key": "alertId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{}"
    },
    {
      "name": "Not Found.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "(Required) Identifier of the environment where the api user is currently working.",
            "key": "X-ANYPNT-ENV-ID",
            "value": "pariatur magna in id esse"
          },
          {
            "description": "(Required) Identifier of the sub org where the api user is currently working.",
            "key": "X-ANYPNT-ORG-ID",
            "value": "pariatur magna in id esse"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/alerts/:alertId/history",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "alerts",
            ":alertId",
            "history"
          ],
          "variable": [
            {
              "key": "alertId"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{}"
    }
  ]
}