Back to Collection Items
var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
strVal: PWideChar;
name: PWideChar;
description: PWideChar;
id: PWideChar;
Id: PWideChar;
Key: PWideChar;
Config_decryptionKey: PWideChar;
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.
// {
// "name": "New private location",
// "description": "Description of private location",
// "tags": [
// "team:front"
// ],
// "id": "Duis incididunt ea Lorem",
// "metadata": {
// "restricted_roles": [
// "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
// ]
// },
// "secrets": {
// "authentication": {
// "id": "quis aliqua dolor reprehenderit",
// "key": "laboris pariatur"
// },
// "config_decryption": {
// "key": "voluptate mollit commodo deserunt"
// }
// }
// }
json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'name','New private location');
CkJsonObject_UpdateString(json,'description','Description of private location');
CkJsonObject_UpdateString(json,'tags[0]','team:front');
CkJsonObject_UpdateString(json,'id','Duis incididunt ea Lorem');
CkJsonObject_UpdateString(json,'metadata.restricted_roles[0]','xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx');
CkJsonObject_UpdateString(json,'secrets.authentication.id','quis aliqua dolor reprehenderit');
CkJsonObject_UpdateString(json,'secrets.authentication.key','laboris pariatur');
CkJsonObject_UpdateString(json,'secrets.config_decryption.key','voluptate mollit commodo deserunt');
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/synthetics/private-locations/:location_id',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": "New private location",
// "description": "Description of private location",
// "tags": [
// "team:front"
// ],
// "id": "Duis incididunt ea Lorem",
// "metadata": {
// "restricted_roles": [
// "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
// ]
// },
// "secrets": {
// "authentication": {
// "id": "quis aliqua dolor reprehenderit",
// "key": "laboris pariatur"
// },
// "config_decryption": {
// "key": "voluptate mollit commodo deserunt"
// }
// }
// }
// 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');
description := CkJsonObject__stringOf(jResp,'description');
id := CkJsonObject__stringOf(jResp,'id');
Id := CkJsonObject__stringOf(jResp,'secrets.authentication.id');
Key := CkJsonObject__stringOf(jResp,'secrets.authentication.key');
Config_decryptionKey := CkJsonObject__stringOf(jResp,'secrets.config_decryption.key');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'tags');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
strVal := CkJsonObject__stringOf(jResp,'tags[i]');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'metadata.restricted_roles');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
strVal := CkJsonObject__stringOf(jResp,'metadata.restricted_roles[i]');
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 '{
"name": "New private location",
"description": "Description of private location",
"tags": [
"team:front"
],
"id": "Duis incididunt ea Lorem",
"metadata": {
"restricted_roles": [
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
]
},
"secrets": {
"authentication": {
"id": "quis aliqua dolor reprehenderit",
"key": "laboris pariatur"
},
"config_decryption": {
"key": "voluptate mollit commodo deserunt"
}
}
}'
https://api.app.ddog-gov.com/api/v1/synthetics/private-locations/:location_id
Postman Collection Item JSON
{
"name": "Edit a private location",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"New private location\",\n \"description\": \"Description of private location\",\n \"tags\": [\n \"team:front\"\n ],\n \"id\": \"Duis incididunt ea Lorem\",\n \"metadata\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"secrets\": {\n \"authentication\": {\n \"id\": \"quis aliqua dolor reprehenderit\",\n \"key\": \"laboris pariatur\"\n },\n \"config_decryption\": {\n \"key\": \"voluptate mollit commodo deserunt\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/private-locations/:location_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations",
":location_id"
],
"variable": [
{
"key": "location_id",
"value": "tempor Ut sed velit"
}
]
},
"description": "Edit a Synthetic private location."
},
"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 \"name\": \"New private location\",\n \"description\": \"Description of private location\",\n \"tags\": [\n \"team:front\"\n ],\n \"id\": \"Duis incididunt ea Lorem\",\n \"metadata\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"secrets\": {\n \"authentication\": {\n \"id\": \"quis aliqua dolor reprehenderit\",\n \"key\": \"laboris pariatur\"\n },\n \"config_decryption\": {\n \"key\": \"voluptate mollit commodo deserunt\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/private-locations/:location_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations",
":location_id"
],
"variable": [
{
"key": "location_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"name\": \"New private location\",\n \"description\": \"Description of private location\",\n \"tags\": [\n \"team:front\"\n ],\n \"id\": \"Duis incididunt ea Lorem\",\n \"metadata\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"secrets\": {\n \"authentication\": {\n \"id\": \"quis aliqua dolor reprehenderit\",\n \"key\": \"laboris pariatur\"\n },\n \"config_decryption\": {\n \"key\": \"voluptate mollit commodo deserunt\"\n }\n }\n}"
},
{
"name": "- Private locations are not activated for the user\n- Private location does not exist",
"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 \"name\": \"New private location\",\n \"description\": \"Description of private location\",\n \"tags\": [\n \"team:front\"\n ],\n \"id\": \"Duis incididunt ea Lorem\",\n \"metadata\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"secrets\": {\n \"authentication\": {\n \"id\": \"quis aliqua dolor reprehenderit\",\n \"key\": \"laboris pariatur\"\n },\n \"config_decryption\": {\n \"key\": \"voluptate mollit commodo deserunt\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/private-locations/:location_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations",
":location_id"
],
"variable": [
{
"key": "location_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_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 \"name\": \"New private location\",\n \"description\": \"Description of private location\",\n \"tags\": [\n \"team:front\"\n ],\n \"id\": \"Duis incididunt ea Lorem\",\n \"metadata\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"secrets\": {\n \"authentication\": {\n \"id\": \"quis aliqua dolor reprehenderit\",\n \"key\": \"laboris pariatur\"\n },\n \"config_decryption\": {\n \"key\": \"voluptate mollit commodo deserunt\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/private-locations/:location_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations",
":location_id"
],
"variable": [
{
"key": "location_id"
}
]
}
},
"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}"
}
]
}
