Chilkat Online Tools

Perl / Squadcast API V3 / Get suppression rules

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

# Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken("<access_token>");

$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $http->QuickGetSb("https://api.squadcast.com/v3/services/:serviceID/suppression-rules",$sbResponseBody);
if ($success == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $http->get_LastStatus();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $http->lastHeader() . "\r\n";
    print "Failed." . "\r\n";
    exit;
}

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

# {
#   "data": {
#     "id": "5fa50748a2e7e47f1436c0fc",
#     "created_at": "2020-11-06T08:20:24.756Z",
#     "updated_at": "2020-11-11T09:28:19.972Z",
#     "service_id": "5f8ed89e39e4a959da360537",
#     "organization_id": "5db92749f8d4da1473169533",
#     "rules": [
#       {
#         "description": "Suppress low latency alerts",
#         "expression": "re(payload.policy_name, \"low latency\")",
#         "is_basic": false
#       }
#     ]
#   }
# }

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

$Id = $jResp->stringOf("data.id");
$Created_at = $jResp->stringOf("data.created_at");
$Updated_at = $jResp->stringOf("data.updated_at");
$Service_id = $jResp->stringOf("data.service_id");
$Organization_id = $jResp->stringOf("data.organization_id");
$i = 0;
$count_i = $jResp->SizeOfArray("data.rules");
while ($i < $count_i) {
    $jResp->put_I($i);
    $description = $jResp->stringOf("data.rules[i].description");
    $expression = $jResp->stringOf("data.rules[i].expression");
    $is_basic = $jResp->BoolOf("data.rules[i].is_basic");
    $i = $i + 1;
}

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://api.squadcast.com/v3/services/:serviceID/suppression-rules

Postman Collection Item JSON

{
  "name": "Get suppression rules",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{sq_pb_auth_header}}",
          "type": "string"
        }
      ]
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/services/:serviceID/suppression-rules",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "services",
        ":serviceID",
        "suppression-rules"
      ],
      "variable": [
        {
          "key": "serviceID",
          "value": "5c7cf71ad517f500100b37d6",
          "type": "string"
        }
      ]
    },
    "description": "This endpoint returns the default suppression rules for the service if not already created. Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope."
  },
  "response": [
    {
      "name": "200 - suppression rules",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/services/:serviceID/suppression-rules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "services",
            ":serviceID",
            "suppression-rules"
          ],
          "variable": [
            {
              "key": "serviceID",
              "value": ""
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "Vary",
          "value": "Origin"
        },
        {
          "key": "Date",
          "value": "Fri, 18 Sep 2020 06:21:12 GMT"
        },
        {
          "key": "Content-Length",
          "value": "63"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"data\": {\n        \"id\": \"5fa50748a2e7e47f1436c0fc\",\n        \"created_at\": \"2020-11-06T08:20:24.756Z\",\n        \"updated_at\": \"2020-11-11T09:28:19.972Z\",\n        \"service_id\": \"5f8ed89e39e4a959da360537\",\n        \"organization_id\": \"5db92749f8d4da1473169533\",\n        \"rules\": [\n            {\n                \"description\": \"Suppress low latency alerts\",\n                \"expression\": \"re(payload.policy_name, \\\"low latency\\\")\",\n                \"is_basic\": false\n            }\n        ]\n    }\n}"
    }
  ]
}