Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkHttpResponseW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW json;
HCkStringBuilderW sbRequestBody;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *dataType;
const wchar_t *Cidr_block;
const wchar_t *Created_at;
const wchar_t *Modified_at;
const wchar_t *Note;
const wchar_t *dataId;
const wchar_t *v_Type;
const wchar_t *Enabled;
const wchar_t *Id;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_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.
// {
// "data": {
// "type": "ip_allowlist",
// "attributes": {
// "enabled": "<boolean>",
// "entries": [
// {
// "data": {
// "type": "ip_allowlist_entry",
// "attributes": {
// "cidr_block": "<string>",
// "created_at": "<dateTime>",
// "modified_at": "<dateTime>",
// "note": "<string>"
// },
// "id": "<string>"
// }
// },
// {
// "data": {
// "type": "ip_allowlist_entry",
// "attributes": {
// "cidr_block": "<string>",
// "created_at": "<dateTime>",
// "modified_at": "<dateTime>",
// "note": "<string>"
// },
// "id": "<string>"
// }
// }
// ]
// },
// "id": "<string>"
// }
// }
json = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(json,L"data.type",L"ip_allowlist");
CkJsonObjectW_UpdateString(json,L"data.attributes.enabled",L"<boolean>");
CkJsonObjectW_UpdateString(json,L"data.attributes.entries[0].data.type",L"ip_allowlist_entry");
CkJsonObjectW_UpdateString(json,L"data.attributes.entries[0].data.attributes.cidr_block",L"<string>");
CkJsonObjectW_UpdateString(json,L"data.attributes.entries[0].data.attributes.created_at",L"<dateTime>");
CkJsonObjectW_UpdateString(json,L"data.attributes.entries[0].data.attributes.modified_at",L"<dateTime>");
CkJsonObjectW_UpdateString(json,L"data.attributes.entries[0].data.attributes.note",L"<string>");
CkJsonObjectW_UpdateString(json,L"data.attributes.entries[0].data.id",L"<string>");
CkJsonObjectW_UpdateString(json,L"data.attributes.entries[1].data.type",L"ip_allowlist_entry");
CkJsonObjectW_UpdateString(json,L"data.attributes.entries[1].data.attributes.cidr_block",L"<string>");
CkJsonObjectW_UpdateString(json,L"data.attributes.entries[1].data.attributes.created_at",L"<dateTime>");
CkJsonObjectW_UpdateString(json,L"data.attributes.entries[1].data.attributes.modified_at",L"<dateTime>");
CkJsonObjectW_UpdateString(json,L"data.attributes.entries[1].data.attributes.note",L"<string>");
CkJsonObjectW_UpdateString(json,L"data.attributes.entries[1].data.id",L"<string>");
CkJsonObjectW_UpdateString(json,L"data.id",L"<string>");
CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");
CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");
sbRequestBody = CkStringBuilderW_Create();
CkJsonObjectW_EmitSb(json,sbRequestBody);
resp = CkHttpW_PTextSb(http,L"PATCH",L"https://api.app.ddog-gov.com/api/v2/ip_allowlist",sbRequestBody,L"utf-8",L"application/json",FALSE,FALSE);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": {
// "type": "ip_allowlist",
// "attributes": {
// "enabled": "<boolean>",
// "entries": [
// {
// "data": {
// "type": "ip_allowlist_entry",
// "attributes": {
// "cidr_block": "<string>",
// "created_at": "<dateTime>",
// "modified_at": "<dateTime>",
// "note": "<string>"
// },
// "id": "<string>"
// }
// },
// {
// "data": {
// "type": "ip_allowlist_entry",
// "attributes": {
// "cidr_block": "<string>",
// "created_at": "<dateTime>",
// "modified_at": "<dateTime>",
// "note": "<string>"
// },
// "id": "<string>"
// }
// }
// ]
// },
// "id": "<string>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
v_Type = CkJsonObjectW_stringOf(jResp,L"data.type");
Enabled = CkJsonObjectW_stringOf(jResp,L"data.attributes.enabled");
Id = CkJsonObjectW_stringOf(jResp,L"data.id");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"data.attributes.entries");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
dataType = CkJsonObjectW_stringOf(jResp,L"data.attributes.entries[i].data.type");
Cidr_block = CkJsonObjectW_stringOf(jResp,L"data.attributes.entries[i].data.attributes.cidr_block");
Created_at = CkJsonObjectW_stringOf(jResp,L"data.attributes.entries[i].data.attributes.created_at");
Modified_at = CkJsonObjectW_stringOf(jResp,L"data.attributes.entries[i].data.attributes.modified_at");
Note = CkJsonObjectW_stringOf(jResp,L"data.attributes.entries[i].data.attributes.note");
dataId = CkJsonObjectW_stringOf(jResp,L"data.attributes.entries[i].data.id");
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -X PATCH
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"type": "ip_allowlist",
"attributes": {
"enabled": "<boolean>",
"entries": [
{
"data": {
"type": "ip_allowlist_entry",
"attributes": {
"cidr_block": "<string>",
"created_at": "<dateTime>",
"modified_at": "<dateTime>",
"note": "<string>"
},
"id": "<string>"
}
},
{
"data": {
"type": "ip_allowlist_entry",
"attributes": {
"cidr_block": "<string>",
"created_at": "<dateTime>",
"modified_at": "<dateTime>",
"note": "<string>"
},
"id": "<string>"
}
}
]
},
"id": "<string>"
}
}'
https://api.app.ddog-gov.com/api/v2/ip_allowlist
Postman Collection Item JSON
{
"name": "Update IP Allowlist",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"ip_allowlist\",\n \"attributes\": {\n \"enabled\": \"<boolean>\",\n \"entries\": [\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n },\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n }\n ]\n },\n \"id\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ip_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ip_allowlist"
]
},
"description": "Edit the entries in the IP allowlist, and enable or disable it."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"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 \"type\": \"ip_allowlist\",\n \"attributes\": {\n \"enabled\": \"<boolean>\",\n \"entries\": [\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n },\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n }\n ]\n },\n \"id\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ip_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ip_allowlist"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"type\": \"ip_allowlist\",\n \"attributes\": {\n \"enabled\": \"<boolean>\",\n \"entries\": [\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n },\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n }\n ]\n },\n \"id\": \"<string>\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"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 \"type\": \"ip_allowlist\",\n \"attributes\": {\n \"enabled\": \"<boolean>\",\n \"entries\": [\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n },\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n }\n ]\n },\n \"id\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ip_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ip_allowlist"
]
}
},
"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": "Forbidden",
"originalRequest": {
"method": "PATCH",
"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 \"type\": \"ip_allowlist\",\n \"attributes\": {\n \"enabled\": \"<boolean>\",\n \"entries\": [\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n },\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n }\n ]\n },\n \"id\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ip_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ip_allowlist"
]
}
},
"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": "PATCH",
"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 \"type\": \"ip_allowlist\",\n \"attributes\": {\n \"enabled\": \"<boolean>\",\n \"entries\": [\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n },\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n }\n ]\n },\n \"id\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ip_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ip_allowlist"
]
}
},
"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": "PATCH",
"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 \"type\": \"ip_allowlist\",\n \"attributes\": {\n \"enabled\": \"<boolean>\",\n \"entries\": [\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n },\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n }\n ]\n },\n \"id\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ip_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ip_allowlist"
]
}
},
"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}"
}
]
}
