Chilkat Online Tools

TCL / Squadcast API V3 / Create or Update Tagging Rules

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.

# {
#   "rules": [
#     {
#       "expression": "<string>",
#       "tags": {
#         "key": {
#           "value": "<string>",
#           "color": "<string>"
#         }
#       }
#     },
#     {
#       "expression": "<string>",
#       "tags": {
#         "key": {
#           "value": "<string>",
#           "color": "<string>"
#         }
#       }
#     }
#   ]
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "rules[0].expression" "<string>"
CkJsonObject_UpdateString $json "rules[0].tags.key.value" "<string>"
CkJsonObject_UpdateString $json "rules[0].tags.key.color" "<string>"
CkJsonObject_UpdateString $json "rules[1].expression" "<string>"
CkJsonObject_UpdateString $json "rules[1].tags.key.value" "<string>"
CkJsonObject_UpdateString $json "rules[1].tags.key.color" "<string>"

CkHttp_SetRequestHeader $http "Authorization" ""
CkHttp_SetRequestHeader $http "Content-Type" "application/json"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://api.squadcast.com/v3/services/:serviceID/tagging-rules" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

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

# {
#   "data": {
#     "id": "5d8c7b6905f5b9cfbfd30816",
#     "created_at": "2019-09-26T08:48:41.869Z",
#     "updated_at": "2019-09-26T08:48:41.869Z",
#     "deleted_at": null,
#     "service_id": "5d8c79cb3f00de06d5fed406",
#     "organization_id": "5d81d9187000fb6b9def7e32",
#     "rules": [
#       {
#         "expression": "re(current.labels.alertname, \"^CPUThrottlingHigh.*\") && re(past.labels.alertname, \"^CPUThrottlingHigh.*\")",
#         "tags": {
#           "severity": {
#             "value": "high",
#             "color": "#ff0000"
#           }
#         }
#       }
#     ]
#   }
# }

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

set Id [CkJsonObject_stringOf $jResp "data.id"]
set Created_at [CkJsonObject_stringOf $jResp "data.created_at"]
set Updated_at [CkJsonObject_stringOf $jResp "data.updated_at"]
set Deleted_at [CkJsonObject_stringOf $jResp "data.deleted_at"]
set Service_id [CkJsonObject_stringOf $jResp "data.service_id"]
set Organization_id [CkJsonObject_stringOf $jResp "data.organization_id"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data.rules"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set expression [CkJsonObject_stringOf $jResp "data.rules[i].expression"]
    set Value [CkJsonObject_stringOf $jResp "data.rules[i].tags.severity.value"]
    set Color [CkJsonObject_stringOf $jResp "data.rules[i].tags.severity.color"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -X POST
	-H "Authorization: "
	-H "Content-Type: application/json"
	-d '{
    "rules": [
        {
            "expression": "<string>",
            "tags": {
                "key": {
                    "value": "<string>",
                    "color": "<string>"
                }
            }
        },
        {
            "expression": "<string>",
            "tags": {
                "key": {
                    "value": "<string>",
                    "color": "<string>"
                }
            }
        }
    ]
}'
https://api.squadcast.com/v3/services/:serviceID/tagging-rules

Postman Collection Item JSON

{
  "name": "Create or Update Tagging Rules",
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "POST",
    "header": [
      {
        "key": "Authorization",
        "value": ""
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"rules\": [\n        {\n            \"expression\": \"<string>\",\n            \"tags\": {\n                \"key\": {\n                    \"value\": \"<string>\",\n                    \"color\": \"<string>\"\n                }\n            }\n        },\n        {\n            \"expression\": \"<string>\",\n            \"tags\": {\n                \"key\": {\n                    \"value\": \"<string>\",\n                    \"color\": \"<string>\"\n                }\n            }\n        }\n    ]\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/services/:serviceID/tagging-rules",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "services",
        ":serviceID",
        "tagging-rules"
      ],
      "variable": [
        {
          "key": "serviceID",
          "value": "<string>",
          "type": "string",
          "description": "(Required) service id"
        }
      ]
    },
    "description": "This endpoint creates or updates the tagging rules for the given service.\nIf default rules not found it creates otherwise it updates the new rules.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `write` scope."
  },
  "response": [
    {
      "name": "Created",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"rules\": [\n        {\n            \"expression\": \"re(current.labels.alertname, \\\"^CPUThrottlingHigh.*\\\") && re(past.labels.alertname, \\\"^CPUThrottlingHigh.*\\\")\",\n            \"tags\": {\n                \"severity\": {\n                    \"value\": \"high\",\n                    \"color\": \"#ff0000\"\n                }\n            }\n        }\n    ]\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/services/:serviceID/tagging-rules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "services",
            ":serviceID",
            "tagging-rules"
          ],
          "variable": [
            {
              "key": "serviceID"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"data\": {\n  \"id\": \"5d8c7b6905f5b9cfbfd30816\",\n  \"created_at\": \"2019-09-26T08:48:41.869Z\",\n  \"updated_at\": \"2019-09-26T08:48:41.869Z\",\n  \"deleted_at\": null,\n  \"service_id\": \"5d8c79cb3f00de06d5fed406\",\n  \"organization_id\": \"5d81d9187000fb6b9def7e32\",\n  \"rules\": [\n   {\n    \"expression\": \"re(current.labels.alertname, \\\"^CPUThrottlingHigh.*\\\") && re(past.labels.alertname, \\\"^CPUThrottlingHigh.*\\\")\",\n    \"tags\": {\n     \"severity\": {\n      \"value\": \"high\",\n      \"color\": \"#ff0000\"\n     }\n    }\n   }\n  ]\n }\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"rules\": [\n        {\n            \"expression\": \"re(current.labels.alertname, \\\"^CPUThrottlingHigh.*\\\") && re(past.labels.alertname, \\\"^CPUThrottlingHigh.*\\\")\",\n            \"tags\": {\n                \"severity\": {\n                    \"value\": \"high\",\n                    \"color\": \"#ff0000\"\n                }\n            }\n        }\n    ]\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/services/:serviceID/tagging-rules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "services",
            ":serviceID",
            "tagging-rules"
          ],
          "variable": [
            {
              "key": "serviceID"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": \"<integer>\",\n  \"error_message\": \"<string>\"\n }\n}"
    },
    {
      "name": "Internal Server Error",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"rules\": [\n        {\n            \"expression\": \"re(current.labels.alertname, \\\"^CPUThrottlingHigh.*\\\") && re(past.labels.alertname, \\\"^CPUThrottlingHigh.*\\\")\",\n            \"tags\": {\n                \"severity\": {\n                    \"value\": \"high\",\n                    \"color\": \"#ff0000\"\n                }\n            }\n        }\n    ]\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/services/:serviceID/tagging-rules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "services",
            ":serviceID",
            "tagging-rules"
          ],
          "variable": [
            {
              "key": "serviceID"
            }
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": \"<integer>\",\n  \"error_message\": \"<string>\"\n }\n}"
    },
    {
      "name": "Forbidden",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"rules\": [\n        {\n            \"expression\": \"re(current.labels.alertname, \\\"^CPUThrottlingHigh.*\\\") && re(past.labels.alertname, \\\"^CPUThrottlingHigh.*\\\")\",\n            \"tags\": {\n                \"severity\": {\n                    \"value\": \"high\",\n                    \"color\": \"#ff0000\"\n                }\n            }\n        }\n    ]\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/services/:serviceID/tagging-rules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "services",
            ":serviceID",
            "tagging-rules"
          ],
          "variable": [
            {
              "key": "serviceID"
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": \"<integer>\",\n  \"error_message\": \"<string>\"\n }\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"rules\": [\n        {\n            \"expression\": \"re(current.labels.alertname, \\\"^CPUThrottlingHigh.*\\\") && re(past.labels.alertname, \\\"^CPUThrottlingHigh.*\\\")\",\n            \"tags\": {\n                \"severity\": {\n                    \"value\": \"high\",\n                    \"color\": \"#ff0000\"\n                }\n            }\n        }\n    ]\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/services/:serviceID/tagging-rules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "services",
            ":serviceID",
            "tagging-rules"
          ],
          "variable": [
            {
              "key": "serviceID"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"meta\": {\n  \"status\": \"<integer>\",\n  \"error_message\": \"<string>\"\n }\n}"
    }
  ]
}