Chilkat Online Tools

Foxpro / Anypoint Platform APIs / Create an alert

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* Use this online tool to generate code from sample JSON: Generate Code to Create JSON

* The following JSON is sent in the request body.

* {
*   "name": "Platform API Postman Test 001",
*   "severity": "INFO",
*   "actions": [
*     {
*       "type": "email",
*       "content": "Hello,\nYou are receiving this alert because:\nThe application ${resource} is now in an ${state} state, based on the condition 'memory ${operator} ${value}%'.",
*       "subject": "${severity}: memory usage ${state}",
*       "userIds": [
*         "2909a63d-c57a-47b0-90f1-7ddfb815efba"
*       ]
*     }
*   ],
*   "condition": {
*     "operator": "GREATER_THAN",
*     "periodCount": 20,
*     "value": 80,
*     "resourceType": "cloudhub-application",
*     "type": "memory",
*     "periodMins": 1,
*     "resources": [
*       "*"
*     ]
*   }
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("name","Platform API Postman Test 001")
loJson.UpdateString("severity","INFO")
loJson.UpdateString("actions[0].type","email")
loJson.UpdateString("actions[0].content","Hello," + CHR(10) + "You are receiving this alert because:" + CHR(10) + "The application ${resource} is now in an ${state} state, based on the condition 'memory ${operator} ${value}%'.")
loJson.UpdateString("actions[0].subject","${severity}: memory usage ${state}")
loJson.UpdateString("actions[0].userIds[0]","2909a63d-c57a-47b0-90f1-7ddfb815efba")
loJson.UpdateString("condition.operator","GREATER_THAN")
loJson.UpdateInt("condition.periodCount",20)
loJson.UpdateInt("condition.value",80)
loJson.UpdateString("condition.resourceType","cloudhub-application")
loJson.UpdateString("condition.type","memory")
loJson.UpdateInt("condition.periodMins",1)
loJson.UpdateString("condition.resources[0]","*")

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

loResp = loHttp.PostJson3("https://domain.com/armui/api/v1/alerts/cloudhub","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp

RELEASE loHttp
RELEASE loJson

Curl Command

curl -X POST
	-H "Authorization: Bearer {{token}}"
	-H "X-ANYPNT-ORG-ID: {{organization_id}}"
	-H "X-ANYPNT-ENV-ID: {{environment_id}}"
	-d '{
    "name": "Platform API Postman Test 001",
    "severity": "INFO",
    "actions": [
        {
            "type": "email",
            "content": "Hello,\nYou are receiving this alert because:\nThe application ${resource} is now in an ${state} state, based on the condition \'memory ${operator} ${value}%\'.",
            "subject": "${severity}: memory usage ${state}",
            "userIds": [
                "2909a63d-c57a-47b0-90f1-7ddfb815efba"
            ]
        }
    ],
    "condition": {
        "operator": "GREATER_THAN",
        "periodCount": 20,
        "value": 80,
        "resourceType": "cloudhub-application",
        "type": "memory",
        "periodMins": 1,
        "resources": [
            "*"
        ]
    }
}'
https://domain.com/armui/api/v1/alerts/cloudhub

Postman Collection Item JSON

{
  "name": "Create an alert",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer {{token}}",
        "type": "text"
      },
      {
        "key": "X-ANYPNT-ORG-ID",
        "value": "{{organization_id}}",
        "type": "text"
      },
      {
        "key": "X-ANYPNT-ENV-ID",
        "value": "{{environment_id}}",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\r\n    \"name\": \"Platform API Postman Test 001\",\r\n    \"severity\": \"INFO\",\r\n    \"actions\": [\r\n        {\r\n            \"type\": \"email\",\r\n            \"content\": \"Hello,\\nYou are receiving this alert because:\\nThe application ${resource} is now in an ${state} state, based on the condition 'memory ${operator} ${value}%'.\",\r\n            \"subject\": \"${severity}: memory usage ${state}\",\r\n            \"userIds\": [\r\n                \"2909a63d-c57a-47b0-90f1-7ddfb815efba\"\r\n            ]\r\n        }\r\n    ],\r\n    \"condition\": {\r\n        \"operator\": \"GREATER_THAN\",\r\n        \"periodCount\": 20,\r\n        \"value\": 80,\r\n        \"resourceType\": \"cloudhub-application\",\r\n        \"type\": \"memory\",\r\n        \"periodMins\": 1,\r\n        \"resources\": [\r\n            \"*\"\r\n        ]\r\n    }\r\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{url}}/armui/api/v1/alerts/cloudhub",
      "host": [
        "{{url}}"
      ],
      "path": [
        "armui",
        "api",
        "v1",
        "alerts",
        "cloudhub"
      ]
    }
  },
  "response": [
  ]
}