Back to Collection Items
use chilkat();
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = chilkat::CkHttp->new();
# 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 = chilkat::CkJsonObject->new();
$json->UpdateString("name","New private location");
$json->UpdateString("description","Description of private location");
$json->UpdateString("tags[0]","team:front");
$json->UpdateString("id","Duis incididunt ea Lorem");
$json->UpdateString("metadata.restricted_roles[0]","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx");
$json->UpdateString("secrets.authentication.id","quis aliqua dolor reprehenderit");
$json->UpdateString("secrets.authentication.key","laboris pariatur");
$json->UpdateString("secrets.config_decryption.key","voluptate mollit commodo deserunt");
$http->SetRequestHeader("Content-Type","application/json");
$http->SetRequestHeader("Accept","application/json");
# resp is a HttpResponse
$resp = $http->PostJson3("https://api.app.ddog-gov.com/api/v1/synthetics/private-locations","application/json",$json);
if ($http->get_LastMethodSuccess() == 0) {
print $http->lastErrorText() . "\r\n";
exit;
}
$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);
$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);
print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";
$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
print "Response Header:" . "\r\n";
print $resp->header() . "\r\n";
print "Failed." . "\r\n";
exit;
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "config": {},
# "private_location": {
# "name": "New private location",
# "description": "Description of private location",
# "tags": [
# "team:front"
# ],
# "id": "amet",
# "metadata": {
# "restricted_roles": [
# "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
# ]
# },
# "secrets": {
# "authentication": {
# "id": "voluptate enim labore adipisicing",
# "key": "cillum"
# },
# "config_decryption": {
# "key": "anim nostrud et"
# }
# }
# },
# "result_encryption": {
# "id": "e",
# "key": "laboris"
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$Name = $jResp->stringOf("private_location.name");
$Description = $jResp->stringOf("private_location.description");
$Id = $jResp->stringOf("private_location.id");
$AuthenticationId = $jResp->stringOf("private_location.secrets.authentication.id");
$Key = $jResp->stringOf("private_location.secrets.authentication.key");
$Config_decryptionKey = $jResp->stringOf("private_location.secrets.config_decryption.key");
$result_encryptionId = $jResp->stringOf("result_encryption.id");
$result_encryptionKey = $jResp->stringOf("result_encryption.key");
$i = 0;
$count_i = $jResp->SizeOfArray("private_location.tags");
while ($i < $count_i) {
$jResp->put_I($i);
$strVal = $jResp->stringOf("private_location.tags[i]");
$i = $i + 1;
}
$i = 0;
$count_i = $jResp->SizeOfArray("private_location.metadata.restricted_roles");
while ($i < $count_i) {
$jResp->put_I($i);
$strVal = $jResp->stringOf("private_location.metadata.restricted_roles[i]");
$i = $i + 1;
}
Curl Command
curl -X POST
-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
Postman Collection Item JSON
{
"name": "Create a private location",
"request": {
"method": "POST",
"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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations"
]
},
"description": "Create a new Synthetic private location."
},
"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\": \"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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"config\": {},\n \"private_location\": {\n \"name\": \"New private location\",\n \"description\": \"Description of private location\",\n \"tags\": [\n \"team:front\"\n ],\n \"id\": \"amet\",\n \"metadata\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"secrets\": {\n \"authentication\": {\n \"id\": \"voluptate enim labore adipisicing\",\n \"key\": \"cillum\"\n },\n \"config_decryption\": {\n \"key\": \"anim nostrud et\"\n }\n }\n },\n \"result_encryption\": {\n \"id\": \"e\",\n \"key\": \"laboris\"\n }\n}"
},
{
"name": "Quota reached for private locations",
"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\": \"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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations"
]
}
},
"status": "Payment Required",
"code": 402,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Private locations are not activated for the user",
"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\": \"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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations"
]
}
},
"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": "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\": \"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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"private-locations"
]
}
},
"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}"
}
]
}
