Objective-C / Squadcast API V3 / Create or Update Tagging Rules
Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
// 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>"
// }
// }
// }
// ]
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"rules[0].expression" value: @"<string>"];
[json UpdateString: @"rules[0].tags.key.value" value: @"<string>"];
[json UpdateString: @"rules[0].tags.key.color" value: @"<string>"];
[json UpdateString: @"rules[1].expression" value: @"<string>"];
[json UpdateString: @"rules[1].tags.key.value" value: @"<string>"];
[json UpdateString: @"rules[1].tags.key.color" value: @"<string>"];
[http SetRequestHeader: @"Authorization" value: @""];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];
CkoHttpResponse *resp = [http PostJson3: @"https://api.squadcast.com/v3/services/:serviceID/tagging-rules" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// 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
NSString *expression = 0;
NSString *Value = 0;
NSString *Color = 0;
NSString *Id = [jResp StringOf: @"data.id"];
NSString *Created_at = [jResp StringOf: @"data.created_at"];
NSString *Updated_at = [jResp StringOf: @"data.updated_at"];
NSString *Deleted_at = [jResp StringOf: @"data.deleted_at"];
NSString *Service_id = [jResp StringOf: @"data.service_id"];
NSString *Organization_id = [jResp StringOf: @"data.organization_id"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"data.rules"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
expression = [jResp StringOf: @"data.rules[i].expression"];
Value = [jResp StringOf: @"data.rules[i].tags.severity.value"];
Color = [jResp StringOf: @"data.rules[i].tags.severity.color"];
i = i + 1;
}
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}"
}
]
}
