Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("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.
// {
// "data": {
// "id": "<string>",
// "attributes": {
// "name": "<string>",
// "filter": {
// "query": "<string>"
// },
// "enabled": "<boolean>",
// "filter_type": "spans-sampling-processor",
// "rate": "<double>"
// },
// "type": "apm_retention_filter"
// }
// }
loJson = createobject("CkJsonObject")
loJson.UpdateString("data.id","<string>")
loJson.UpdateString("data.attributes.name","<string>")
loJson.UpdateString("data.attributes.filter.query","<string>")
loJson.UpdateString("data.attributes.enabled","<boolean>")
loJson.UpdateString("data.attributes.filter_type","spans-sampling-processor")
loJson.UpdateString("data.attributes.rate","<double>")
loJson.UpdateString("data.type","apm_retention_filter")
loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Accept","application/json")
loSbRequestBody = createobject("CkStringBuilder")
loJson.EmitSb(loSbRequestBody)
loResp = loHttp.PTextSb("PUT","https://api.app.ddog-gov.com/api/v2/apm/config/retention-filters/:filter_id",loSbRequestBody,"utf-8","application/json",.F.,.F.)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJson
release loSbRequestBody
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp
return
endif
release loResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": {
// "id": "<string>",
// "type": "apm_retention_filter",
// "attributes": {
// "created_at": "<long>",
// "created_by": "<string>",
// "editable": "<boolean>",
// "enabled": "<boolean>",
// "execution_order": "<long>",
// "filter": {
// "query": "<string>"
// },
// "filter_type": "spans-sampling-processor",
// "modified_at": "<long>",
// "modified_by": "<string>",
// "name": "<string>",
// "rate": "<double>"
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcId = loJResp.StringOf("data.id")
lcV_Type = loJResp.StringOf("data.type")
lcCreated_at = loJResp.StringOf("data.attributes.created_at")
lcCreated_by = loJResp.StringOf("data.attributes.created_by")
lcEditable = loJResp.StringOf("data.attributes.editable")
lcEnabled = loJResp.StringOf("data.attributes.enabled")
lcExecution_order = loJResp.StringOf("data.attributes.execution_order")
lcQuery = loJResp.StringOf("data.attributes.filter.query")
lcFilter_type = loJResp.StringOf("data.attributes.filter_type")
lcModified_at = loJResp.StringOf("data.attributes.modified_at")
lcModified_by = loJResp.StringOf("data.attributes.modified_by")
lcName = loJResp.StringOf("data.attributes.name")
lcRate = loJResp.StringOf("data.attributes.rate")
release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp
Curl Command
curl -X PUT
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"id": "<string>",
"attributes": {
"name": "<string>",
"filter": {
"query": "<string>"
},
"enabled": "<boolean>",
"filter_type": "spans-sampling-processor",
"rate": "<double>"
},
"type": "apm_retention_filter"
}
}'
https://api.app.ddog-gov.com/api/v2/apm/config/retention-filters/:filter_id
Postman Collection Item JSON
{
"name": "Update a retention filter",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"<string>\",\n \"attributes\": {\n \"name\": \"<string>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"enabled\": \"<boolean>\",\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": \"<double>\"\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_id",
"value": "<string>"
}
]
},
"description": "Update a retention filter from your organization."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"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 \"attributes\": {\n \"name\": \"<string>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"enabled\": \"<boolean>\",\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": \"<double>\"\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"apm_retention_filter\",\n \"attributes\": {\n \"created_at\": \"<long>\",\n \"created_by\": \"<string>\",\n \"editable\": \"<boolean>\",\n \"enabled\": \"<boolean>\",\n \"execution_order\": \"<long>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"filter_type\": \"spans-sampling-processor\",\n \"modified_at\": \"<long>\",\n \"modified_by\": \"<string>\",\n \"name\": \"<string>\",\n \"rate\": \"<double>\"\n }\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"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 \"attributes\": {\n \"name\": \"<string>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"enabled\": \"<boolean>\",\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": \"<double>\"\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Not Authorized",
"originalRequest": {
"method": "PUT",
"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 \"attributes\": {\n \"name\": \"<string>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"enabled\": \"<boolean>\",\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": \"<double>\"\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_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": "PUT",
"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 \"attributes\": {\n \"name\": \"<string>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"enabled\": \"<boolean>\",\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": \"<double>\"\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_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": "Too many requests",
"originalRequest": {
"method": "PUT",
"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 \"attributes\": {\n \"name\": \"<string>\",\n \"filter\": {\n \"query\": \"<string>\"\n },\n \"enabled\": \"<boolean>\",\n \"filter_type\": \"spans-sampling-processor\",\n \"rate\": \"<double>\"\n },\n \"type\": \"apm_retention_filter\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/apm/config/retention-filters/:filter_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters",
":filter_id"
],
"variable": [
{
"key": "filter_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}"
}
]
}
