Chilkat Online Tools

PureBasic / Anypoint Platform APIs / Create an alert

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; 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": [
    ;       "*"
    ;     ]
    ;   }
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"name","Platform API Postman Test 001")
    CkJsonObject::ckUpdateString(json,"severity","INFO")
    CkJsonObject::ckUpdateString(json,"actions[0].type","email")
    CkJsonObject::ckUpdateString(json,"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}%'.")
    CkJsonObject::ckUpdateString(json,"actions[0].subject","${severity}: memory usage ${state}")
    CkJsonObject::ckUpdateString(json,"actions[0].userIds[0]","2909a63d-c57a-47b0-90f1-7ddfb815efba")
    CkJsonObject::ckUpdateString(json,"condition.operator","GREATER_THAN")
    CkJsonObject::ckUpdateInt(json,"condition.periodCount",20)
    CkJsonObject::ckUpdateInt(json,"condition.value",80)
    CkJsonObject::ckUpdateString(json,"condition.resourceType","cloudhub-application")
    CkJsonObject::ckUpdateString(json,"condition.type","memory")
    CkJsonObject::ckUpdateInt(json,"condition.periodMins",1)
    CkJsonObject::ckUpdateString(json,"condition.resources[0]","*")

    CkHttp::ckSetRequestHeader(http,"X-ANYPNT-ENV-ID","{{environment_id}}")
    ; Adds the "Authorization: Bearer {{token}}" header.
    CkHttp::setCkAuthToken(http, "{{token}}")
    CkHttp::ckSetRequestHeader(http,"X-ANYPNT-ORG-ID","{{organization_id}}")

    resp.i = CkHttp::ckPostJson3(http,"https://domain.com/armui/api/v1/alerts/cloudhub","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

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": [
  ]
}