Chilkat Online Tools

Ruby / Anypoint Platform APIs / Update alert by id

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# 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": "Low CPU usage",
#   "severity": "WARNING",
#   "actions": [
#     {
#       "type": "email",
#       "content": "Hello,\nYou are receiving this alert because:\nThe application ${resource} is now in an ${state} state, based on the condition 'CPU ${operator} ${value}%.",
#       "subject": "${severity}: CPU usage ${state}",
#       "emails": [
#         "angel.alberici+testalerts@mulesoft.com",
#         "angel.alberici@mulesoft.com"
#       ]
#     }
#   ],
#   "condition": {
#     "operator": "LESS_THAN",
#     "value": 50,
#     "periodCount": 1,
#     "resourceType": "cloudhub-application",
#     "type": "cpu",
#     "periodMins": 1,
#     "resources": [
#       "*"
#     ]
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("name","Low CPU usage")
json.UpdateString("severity","WARNING")
json.UpdateString("actions[0].type","email")
json.UpdateString("actions[0].content","Hello,\nYou are receiving this alert because:\nThe application ${resource} is now in an ${state} state, based on the condition 'CPU ${operator} ${value}%.")
json.UpdateString("actions[0].subject","${severity}: CPU usage ${state}")
json.UpdateString("actions[0].emails[0]","angel.alberici+testalerts@mulesoft.com")
json.UpdateString("actions[0].emails[1]","angel.alberici@mulesoft.com")
json.UpdateString("condition.operator","LESS_THAN")
json.UpdateInt("condition.value",50)
json.UpdateInt("condition.periodCount",1)
json.UpdateString("condition.resourceType","cloudhub-application")
json.UpdateString("condition.type","cpu")
json.UpdateInt("condition.periodMins",1)
json.UpdateString("condition.resources[0]","*")

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

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PUT","https://anypoint.mulesoft.com/armui/api/v1/alerts/cloudhub/02213013-10f2-4bbb-b399-718c0a543e18",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "id": 2312,
#   "timeCreated": 342423432142342,
#   "timeUpdated": 342423432154342,
#   "severity": "CRITICAL",
#   "description": "Notify when one server of cluster 45 went down",
#   "enabled": true,
#   "action": {
#     "notification": {
#       "recipients": [
#         "alex.tiavo",
#         "greg.kio"
#       ]
#     }
#   },
#   "condition": {
#     "resourceType": "CLUSTER",
#     "resources": [
#       45
#     ],
#     "event": "DISCONNECTED"
#   }
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

id = jResp.IntOf("id")
timeCreated = jResp.IntOf("timeCreated")
timeUpdated = jResp.IntOf("timeUpdated")
severity = jResp.stringOf("severity")
description = jResp.stringOf("description")
enabled = jResp.BoolOf("enabled")
ResourceType = jResp.stringOf("condition.resourceType")
v_Event = jResp.stringOf("condition.event")
i = 0
count_i = jResp.SizeOfArray("action.notification.recipients")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("action.notification.recipients[i]")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("condition.resources")
while i < count_i
    jResp.put_I(i)
    intVal = jResp.IntOf("condition.resources[i]")
    i = i + 1
end

Curl Command

curl -X PUT
	-H "X-ANYPNT-ENV-ID: {{environment_id}}"
	-H "X-ANYPNT-ORG-ID: {{organization_id}}"
	-H "Authorization: Bearer {{token}}"
	-d '{
    "name": "Low CPU usage",
    "severity": "WARNING",
    "actions": [
        {
            "type": "email",
            "content": "Hello,\nYou are receiving this alert because:\nThe application ${resource} is now in an ${state} state, based on the condition \'CPU ${operator} ${value}%.",
            "subject": "${severity}: CPU usage ${state}",
            "emails": [
                "angel.alberici+testalerts@mulesoft.com",
                "angel.alberici@mulesoft.com"
            ]
        }
    ],
    "condition": {
        "operator": "LESS_THAN",
        "value": 50,
        "periodCount": 1,
        "resourceType": "cloudhub-application",
        "type": "cpu",
        "periodMins": 1,
        "resources": [
            "*"
        ]
    }
}'
https://anypoint.mulesoft.com/armui/api/v1/alerts/cloudhub/02213013-10f2-4bbb-b399-718c0a543e18

Postman Collection Item JSON

{
  "name": "Update alert by id",
  "request": {
    "method": "PUT",
    "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"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"name\": \"Low CPU usage\",\n    \"severity\": \"WARNING\",\n    \"actions\": [\n        {\n            \"type\": \"email\",\n            \"content\": \"Hello,\\nYou are receiving this alert because:\\nThe application ${resource} is now in an ${state} state, based on the condition 'CPU ${operator} ${value}%.\",\n            \"subject\": \"${severity}: CPU usage ${state}\",\n            \"emails\": [\n                \"angel.alberici+testalerts@mulesoft.com\",\n                \"angel.alberici@mulesoft.com\"\n            ]\n        }\n    ],\n    \"condition\": {\n        \"operator\": \"LESS_THAN\",\n        \"value\": 50,\n        \"periodCount\": 1,\n        \"resourceType\": \"cloudhub-application\",\n        \"type\": \"cpu\",\n        \"periodMins\": 1,\n        \"resources\": [\n            \"*\"\n        ]\n    }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://anypoint.mulesoft.com/armui/api/v1/alerts/cloudhub/02213013-10f2-4bbb-b399-718c0a543e18",
      "protocol": "https",
      "host": [
        "anypoint",
        "mulesoft",
        "com"
      ],
      "path": [
        "armui",
        "api",
        "v1",
        "alerts",
        "cloudhub",
        "02213013-10f2-4bbb-b399-718c0a543e18"
      ]
    }
  },
  "response": [
    {
      "name": "Untitled Example",
      "originalRequest": {
        "method": "PATCH",
        "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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "alerts",
            ":alertId"
          ],
          "variable": [
            {
              "key": "alertId"
            }
          ]
        }
      },
      "status": "Accepted",
      "code": 202,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"id\": 2312,\n \"timeCreated\": 342423432142342,\n \"timeUpdated\": 342423432154342,\n \"severity\": \"CRITICAL\",\n \"description\": \"Notify when one server of cluster 45 went down\",\n \"enabled\": true,\n \"action\": {\n  \"notification\": {\n   \"recipients\": [\n    \"alex.tiavo\",\n    \"greg.kio\"\n   ]\n  }\n },\n \"condition\": {\n  \"resourceType\": \"CLUSTER\",\n  \"resources\": [\n   45\n  ],\n  \"event\": \"DISCONNECTED\"\n }\n}"
    }
  ]
}