Chilkat Online Tools

TCL / Anypoint Platform APIs / Create an alert

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

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

set json [new_CkJsonObject]

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

CkHttp_SetRequestHeader $http "X-ANYPNT-ENV-ID" "{{environment_id}}"
# Adds the "Authorization: Bearer {{token}}" header.
CkHttp_put_AuthToken $http "{{token}}"
CkHttp_SetRequestHeader $http "X-ANYPNT-ORG-ID" "{{organization_id}}"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://domain.com/armui/api/v1/alerts/cloudhub" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json

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