VB.NET / Squadcast API V3 / Create or Update Tagging Rules
Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
' 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>"
' }
' }
' }
' ]
' }
Dim json As New Chilkat.JsonObject
json.UpdateString("rules[0].expression","<string>")
json.UpdateString("rules[0].tags.key.value","<string>")
json.UpdateString("rules[0].tags.key.color","<string>")
json.UpdateString("rules[1].expression","<string>")
json.UpdateString("rules[1].tags.key.value","<string>")
json.UpdateString("rules[1].tags.key.color","<string>")
http.SetRequestHeader("Authorization","")
http.SetRequestHeader("Content-Type","application/json")
Dim resp As Chilkat.HttpResponse = http.PostJson3("https://api.squadcast.com/v3/services/:serviceID/tagging-rules","application/json",json)
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(resp.Header)
Debug.WriteLine("Failed.")
Exit Sub
End If
' 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
Dim expression As String
Dim Value As String
Dim Color As String
Dim Id As String = jResp.StringOf("data.id")
Dim Created_at As String = jResp.StringOf("data.created_at")
Dim Updated_at As String = jResp.StringOf("data.updated_at")
Dim Deleted_at As String = jResp.StringOf("data.deleted_at")
Dim Service_id As String = jResp.StringOf("data.service_id")
Dim Organization_id As String = jResp.StringOf("data.organization_id")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("data.rules")
While i < count_i
jResp.I = 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
End While
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}"
}
]
}
