Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcStrVal
LOCAL lcName
LOCAL lcDescription
LOCAL lcId
LOCAL lcAuthenticationId
LOCAL lcKey
LOCAL lcConfig_decryptionKey
LOCAL lcResult_encryptionId
LOCAL lcResult_encryptionKey
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
* 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"
* }
* }
* }
loJson = CreateObject('Chilkat_9_5_0.JsonObject')
loJson.UpdateString("name","New private location")
loJson.UpdateString("description","Description of private location")
loJson.UpdateString("tags[0]","team:front")
loJson.UpdateString("id","Duis incididunt ea Lorem")
loJson.UpdateString("metadata.restricted_roles[0]","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")
loJson.UpdateString("secrets.authentication.id","quis aliqua dolor reprehenderit")
loJson.UpdateString("secrets.authentication.key","laboris pariatur")
loJson.UpdateString("secrets.config_decryption.key","voluptate mollit commodo deserunt")
loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.PostJson3("https://api.app.ddog-gov.com/api/v1/synthetics/private-locations","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcName = loJResp.StringOf("private_location.name")
lcDescription = loJResp.StringOf("private_location.description")
lcId = loJResp.StringOf("private_location.id")
lcAuthenticationId = loJResp.StringOf("private_location.secrets.authentication.id")
lcKey = loJResp.StringOf("private_location.secrets.authentication.key")
lcConfig_decryptionKey = loJResp.StringOf("private_location.secrets.config_decryption.key")
lcResult_encryptionId = loJResp.StringOf("result_encryption.id")
lcResult_encryptionKey = loJResp.StringOf("result_encryption.key")
i = 0
lnCount_i = loJResp.SizeOfArray("private_location.tags")
DO WHILE i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("private_location.tags[i]")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("private_location.metadata.restricted_roles")
DO WHILE i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("private_location.metadata.restricted_roles[i]")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
