Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
# 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": {
# "attributes": {
# "name": "<string>",
# "filter": {
# "query": "<string>"
# },
# "enabled": "<boolean>",
# "filter_type": "spans-sampling-processor",
# "rate": "<double>"
# },
# "type": "apm_retention_filter"
# }
# }
$json = New-Object Chilkat.JsonObject
$json.UpdateString("data.attributes.name","<string>")
$json.UpdateString("data.attributes.filter.query","<string>")
$json.UpdateString("data.attributes.enabled","<boolean>")
$json.UpdateString("data.attributes.filter_type","spans-sampling-processor")
$json.UpdateString("data.attributes.rate","<double>")
$json.UpdateString("data.type","apm_retention_filter")
$http.SetRequestHeader("Content-Type","application/json")
$http.SetRequestHeader("Accept","application/json")
$resp = $http.PostJson3("https://api.app.ddog-gov.com/api/v2/apm/config/retention-filters","application/json",$json)
if ($http.LastMethodSuccess -eq $false) {
$($http.LastErrorText)
exit
}
$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($resp.Header)
$("Failed.")
exit
}
# 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
$Id = $jResp.StringOf("data.id")
$v_Type = $jResp.StringOf("data.type")
$Created_at = $jResp.StringOf("data.attributes.created_at")
$Created_by = $jResp.StringOf("data.attributes.created_by")
$Editable = $jResp.StringOf("data.attributes.editable")
$Enabled = $jResp.StringOf("data.attributes.enabled")
$Execution_order = $jResp.StringOf("data.attributes.execution_order")
$Query = $jResp.StringOf("data.attributes.filter.query")
$Filter_type = $jResp.StringOf("data.attributes.filter_type")
$Modified_at = $jResp.StringOf("data.attributes.modified_at")
$Modified_by = $jResp.StringOf("data.attributes.modified_by")
$Name = $jResp.StringOf("data.attributes.name")
$Rate = $jResp.StringOf("data.attributes.rate")
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"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
Postman Collection Item JSON
{
"name": "Create a retention filter",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters"
]
},
"description": "Create a retention filter to index spans in your organization.\nReturns the retention filter definition when the request is successful."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"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 \"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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters"
]
}
},
"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": "POST",
"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 \"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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters"
]
}
},
"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": "POST",
"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 \"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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters"
]
}
},
"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": "Conflict",
"originalRequest": {
"method": "POST",
"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 \"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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters"
]
}
},
"status": "Conflict",
"code": 409,
"_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": "POST",
"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 \"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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"apm",
"config",
"retention-filters"
]
}
},
"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}"
}
]
}
