PureBasic / Datadog API Collection / Edit a monitor configuration policy
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "data": {
; "id": "<string>",
; "type": "monitor-config-policy",
; "attributes": {
; "policy_type": "tag",
; "policy": {
; "tag_key": "<string>",
; "tag_key_required": "<boolean>",
; "valid_tag_values": [
; "<string>",
; "<string>"
; ]
; }
; }
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"data.id","<string>")
CkJsonObject::ckUpdateString(json,"data.type","monitor-config-policy")
CkJsonObject::ckUpdateString(json,"data.attributes.policy_type","tag")
CkJsonObject::ckUpdateString(json,"data.attributes.policy.tag_key","<string>")
CkJsonObject::ckUpdateString(json,"data.attributes.policy.tag_key_required","<boolean>")
CkJsonObject::ckUpdateString(json,"data.attributes.policy.valid_tag_values[0]","<string>")
CkJsonObject::ckUpdateString(json,"data.attributes.policy.valid_tag_values[1]","<string>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"PATCH","https://api.app.ddog-gov.com/api/v2/monitor/policy/:policy_id",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "data": {
; "attributes": {
; "policy": {
; "tag_key": "<string>",
; "tag_key_required": "<boolean>",
; "valid_tag_values": [
; "<string>",
; "<string>"
; ]
; },
; "policy_type": "tag"
; },
; "id": "<string>",
; "type": "monitor-config-policy"
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
strVal.s
Tag_key.s = CkJsonObject::ckStringOf(jResp,"data.attributes.policy.tag_key")
Tag_key_required.s = CkJsonObject::ckStringOf(jResp,"data.attributes.policy.tag_key_required")
Policy_type.s = CkJsonObject::ckStringOf(jResp,"data.attributes.policy_type")
Id.s = CkJsonObject::ckStringOf(jResp,"data.id")
v_Type.s = CkJsonObject::ckStringOf(jResp,"data.type")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data.attributes.policy.valid_tag_values")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"data.attributes.policy.valid_tag_values[i]")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X PATCH
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"id": "<string>",
"type": "monitor-config-policy",
"attributes": {
"policy_type": "tag",
"policy": {
"tag_key": "<string>",
"tag_key_required": "<boolean>",
"valid_tag_values": [
"<string>",
"<string>"
]
}
}
}
}'
https://api.app.ddog-gov.com/api/v2/monitor/policy/:policy_id
Postman Collection Item JSON
{
"name": "Edit a monitor configuration policy",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"monitor-config-policy\",\n \"attributes\": {\n \"policy_type\": \"tag\",\n \"policy\": {\n \"tag_key\": \"<string>\",\n \"tag_key_required\": \"<boolean>\",\n \"valid_tag_values\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id",
"value": "<string>"
}
]
},
"description": "Edit a monitor configuration policy."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"monitor-config-policy\",\n \"attributes\": {\n \"policy_type\": \"tag\",\n \"policy\": {\n \"tag_key\": \"<string>\",\n \"tag_key_required\": \"<boolean>\",\n \"valid_tag_values\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"attributes\": {\n \"policy\": {\n \"tag_key\": \"<string>\",\n \"tag_key_required\": \"<boolean>\",\n \"valid_tag_values\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"policy_type\": \"tag\"\n },\n \"id\": \"<string>\",\n \"type\": \"monitor-config-policy\"\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"monitor-config-policy\",\n \"attributes\": {\n \"policy_type\": \"tag\",\n \"policy\": {\n \"tag_key\": \"<string>\",\n \"tag_key_required\": \"<boolean>\",\n \"valid_tag_values\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"monitor-config-policy\",\n \"attributes\": {\n \"policy_type\": \"tag\",\n \"policy\": {\n \"tag_key\": \"<string>\",\n \"tag_key_required\": \"<boolean>\",\n \"valid_tag_values\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Unprocessable Entity",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"monitor-config-policy\",\n \"attributes\": {\n \"policy_type\": \"tag\",\n \"policy\": {\n \"tag_key\": \"<string>\",\n \"tag_key_required\": \"<boolean>\",\n \"valid_tag_values\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Unprocessable Entity (WebDAV) (RFC 4918)",
"code": 422,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"monitor-config-policy\",\n \"attributes\": {\n \"policy_type\": \"tag\",\n \"policy\": {\n \"tag_key\": \"<string>\",\n \"tag_key_required\": \"<boolean>\",\n \"valid_tag_values\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/monitor/policy/:policy_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"monitor",
"policy",
":policy_id"
],
"variable": [
{
"key": "policy_id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
}
]
}
