Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
integer li_Sample_rate
string ls_FilterQuery
integer li_Is_enabled
string ls_Name
string ls_Query
integer li_Daily_limit
integer li_Is_rate_limited
integer li_Num_retention_days
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "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
// }
loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")
loo_Json.UpdateString("name","main")
loo_Json.UpdateString("filter.query","source:python")
loo_Json.UpdateInt("daily_limit",300000000)
loo_Json.UpdateString("exclusion_filters[0].name","payment")
loo_Json.UpdateInt("exclusion_filters[0].filter.sample_rate",1)
loo_Json.UpdateString("exclusion_filters[0].filter.query","*")
loo_Json.UpdateBool("exclusion_filters[0].is_enabled",0)
loo_Json.UpdateString("exclusion_filters[1].name","payment")
loo_Json.UpdateInt("exclusion_filters[1].filter.sample_rate",1)
loo_Json.UpdateString("exclusion_filters[1].filter.query","*")
loo_Json.UpdateBool("exclusion_filters[1].is_enabled",1)
loo_Json.UpdateBool("is_rate_limited",0)
loo_Json.UpdateInt("num_retention_days",15)
loo_Http.SetRequestHeader("Content-Type","application/json")
loo_Http.SetRequestHeader("Accept","application/json")
loo_Resp = loo_Http.PostJson3("https://api.app.ddog-gov.com/api/v1/logs/config/indexes","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Json
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// 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
ls_Name = loo_JResp.StringOf("name")
ls_Query = loo_JResp.StringOf("filter.query")
li_Daily_limit = loo_JResp.IntOf("daily_limit")
li_Is_rate_limited = loo_JResp.BoolOf("is_rate_limited")
li_Num_retention_days = loo_JResp.IntOf("num_retention_days")
i = 0
li_Count_i = loo_JResp.SizeOfArray("exclusion_filters")
do while i < li_Count_i
loo_JResp.I = i
ls_Name = loo_JResp.StringOf("exclusion_filters[i].name")
li_Sample_rate = loo_JResp.IntOf("exclusion_filters[i].filter.sample_rate")
ls_FilterQuery = loo_JResp.StringOf("exclusion_filters[i].filter.query")
li_Is_enabled = loo_JResp.BoolOf("exclusion_filters[i].is_enabled")
i = i + 1
loop
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"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
}'
https://api.app.ddog-gov.com/api/v1/logs/config/indexes
Postman Collection Item JSON
{
"name": "Create an index",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes"
]
},
"description": "Creates a new index. Returns the Index object passed in the request body 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 \"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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes"
]
}
},
"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": "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 \"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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "null"
},
{
"name": "Forbidden",
"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 \"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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes"
]
}
},
"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": "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 \"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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/logs/config/indexes",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"logs",
"config",
"indexes"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
