Back to Collection Items
var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
Sample_rate: Integer;
filterQuery: PWideChar;
is_enabled: Boolean;
name: PWideChar;
Query: PWideChar;
daily_limit: Integer;
is_rate_limited: Boolean;
num_retention_days: Integer;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
// 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
// }
json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'filter.query','source:python');
CkJsonObject_UpdateInt(json,'daily_limit',300000000);
CkJsonObject_UpdateBool(json,'disable_daily_limit',False);
CkJsonObject_UpdateString(json,'exclusion_filters[0].name','payment');
CkJsonObject_UpdateInt(json,'exclusion_filters[0].filter.sample_rate',1);
CkJsonObject_UpdateString(json,'exclusion_filters[0].filter.query','*');
CkJsonObject_UpdateBool(json,'exclusion_filters[0].is_enabled',False);
CkJsonObject_UpdateString(json,'exclusion_filters[1].name','payment');
CkJsonObject_UpdateInt(json,'exclusion_filters[1].filter.sample_rate',1);
CkJsonObject_UpdateString(json,'exclusion_filters[1].filter.query','*');
CkJsonObject_UpdateBool(json,'exclusion_filters[1].is_enabled',True);
CkJsonObject_UpdateInt(json,'num_retention_days',15);
CkHttp_SetRequestHeader(http,'Content-Type','application/json');
CkHttp_SetRequestHeader(http,'Accept','application/json');
sbRequestBody := CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);
resp := CkHttp_PTextSb(http,'PUT','https://api.app.ddog-gov.com/api/v1/logs/config/indexes/:name',sbRequestBody,'utf-8','application/json',False,False);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(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
name := CkJsonObject__stringOf(jResp,'name');
Query := CkJsonObject__stringOf(jResp,'filter.query');
daily_limit := CkJsonObject_IntOf(jResp,'daily_limit');
is_rate_limited := CkJsonObject_BoolOf(jResp,'is_rate_limited');
num_retention_days := CkJsonObject_IntOf(jResp,'num_retention_days');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'exclusion_filters');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
name := CkJsonObject__stringOf(jResp,'exclusion_filters[i].name');
Sample_rate := CkJsonObject_IntOf(jResp,'exclusion_filters[i].filter.sample_rate');
filterQuery := CkJsonObject__stringOf(jResp,'exclusion_filters[i].filter.query');
is_enabled := CkJsonObject_BoolOf(jResp,'exclusion_filters[i].is_enabled');
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
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"
}
]
}
