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.
// {
// "filter": {
// "query": "source:python"
// },
// "daily_limit": 300000000,
// "disable_daily_limit": false,
// "exclusion_filters": [
// {
// "name": "payment",
// "filter": {
// "sample_rate": 1,
// "query": "*"
// },
// "is_enabled": false
// },
// {
// "name": "payment",
// "filter": {
// "sample_rate": 1,
// "query": "*"
// },
// "is_enabled": true
// }
// ],
// "num_retention_days": 15
// }
loJson = createobject("CkJsonObject")
loJson.UpdateString("filter.query","source:python")
loJson.UpdateInt("daily_limit",300000000)
loJson.UpdateBool("disable_daily_limit",.F.)
loJson.UpdateString("exclusion_filters[0].name","payment")
loJson.UpdateInt("exclusion_filters[0].filter.sample_rate",1)
loJson.UpdateString("exclusion_filters[0].filter.query","*")
loJson.UpdateBool("exclusion_filters[0].is_enabled",.F.)
loJson.UpdateString("exclusion_filters[1].name","payment")
loJson.UpdateInt("exclusion_filters[1].filter.sample_rate",1)
loJson.UpdateString("exclusion_filters[1].filter.query","*")
loJson.UpdateBool("exclusion_filters[1].is_enabled",.T.)
loJson.UpdateInt("num_retention_days",15)
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/v1/logs/config/indexes/:name",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)
// {
// "name": "main",
// "filter": {
// "query": "source:python"
// },
// "daily_limit": 300000000,
// "exclusion_filters": [
// {
// "name": "payment",
// "filter": {
// "sample_rate": 1,
// "query": "*"
// },
// "is_enabled": false
// },
// {
// "name": "payment",
// "filter": {
// "sample_rate": 1,
// "query": "*"
// },
// "is_enabled": true
// }
// ],
// "is_rate_limited": false,
// "num_retention_days": 15
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcName = loJResp.StringOf("name")
lcQuery = loJResp.StringOf("filter.query")
lnDaily_limit = loJResp.IntOf("daily_limit")
llIs_rate_limited = loJResp.BoolOf("is_rate_limited")
lnNum_retention_days = loJResp.IntOf("num_retention_days")
i = 0
lnCount_i = loJResp.SizeOfArray("exclusion_filters")
do while i < lnCount_i
loJResp.I = i
lcName = loJResp.StringOf("exclusion_filters[i].name")
lnSample_rate = loJResp.IntOf("exclusion_filters[i].filter.sample_rate")
lcFilterQuery = loJResp.StringOf("exclusion_filters[i].filter.query")
llIs_enabled = loJResp.BoolOf("exclusion_filters[i].is_enabled")
i = i + 1
enddo
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 '{
"filter": {
"query": "source:python"
},
"daily_limit": 300000000,
"disable_daily_limit": false,
"exclusion_filters": [
{
"name": "payment",
"filter": {
"sample_rate": 1,
"query": "*"
},
"is_enabled": false
},
{
"name": "payment",
"filter": {
"sample_rate": 1,
"query": "*"
},
"is_enabled": true
}
],
"num_retention_days": 15
}'
https://api.app.ddog-gov.com/api/v1/logs/config/indexes/:name
Postman Collection Item JSON
{
"name": "Update an index",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"daily_limit\": 300000000,\n \"disable_daily_limit\": false,\n \"exclusion_filters\": [\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": false\n },\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": true\n }\n ],\n \"num_retention_days\": 15\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes",
":name"
],
"variable": [
{
"key": "name",
"value": "tempor Ut sed velit"
}
]
},
"description": "Update an index as identified by its name.\nReturns the Index object passed in the request body when the request is successful.\n\nUsing the `PUT` method updates your index’s configuration by **replacing**\nyour current configuration with the new one sent to your Datadog 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 \"filter\": {\n \"query\": \"source:python\"\n },\n \"daily_limit\": 300000000,\n \"disable_daily_limit\": false,\n \"exclusion_filters\": [\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": false\n },\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": true\n }\n ],\n \"num_retention_days\": 15\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes",
":name"
],
"variable": [
{
"key": "name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"name\": \"main\",\n \"filter\": {\n \"query\": \"source:python\"\n },\n \"daily_limit\": 300000000,\n \"exclusion_filters\": [\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": false\n },\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": true\n }\n ],\n \"is_rate_limited\": false,\n \"num_retention_days\": 15\n}"
},
{
"name": "Invalid Parameter Error",
"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 \"filter\": {\n \"query\": \"source:python\"\n },\n \"daily_limit\": 300000000,\n \"disable_daily_limit\": false,\n \"exclusion_filters\": [\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": false\n },\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": true\n }\n ],\n \"num_retention_days\": 15\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes",
":name"
],
"variable": [
{
"key": "name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "null"
},
{
"name": "Forbidden",
"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 \"filter\": {\n \"query\": \"source:python\"\n },\n \"daily_limit\": 300000000,\n \"disable_daily_limit\": false,\n \"exclusion_filters\": [\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": false\n },\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": true\n }\n ],\n \"num_retention_days\": 15\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes",
":name"
],
"variable": [
{
"key": "name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\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 \"filter\": {\n \"query\": \"source:python\"\n },\n \"daily_limit\": 300000000,\n \"disable_daily_limit\": false,\n \"exclusion_filters\": [\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": false\n },\n {\n \"name\": \"payment\",\n \"filter\": {\n \"sample_rate\": 1,\n \"query\": \"*\"\n },\n \"is_enabled\": true\n }\n ],\n \"num_retention_days\": 15\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes/:name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes",
":name"
],
"variable": [
{
"key": "name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "null"
}
]
}
