Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcDescription
LOCAL lcName
LOCAL lnSecure
LOCAL lcValue
LOCAL lcId
LOCAL lcV_Type
LOCAL lcField
LOCAL lcLocalVariableName
LOCAL lcParserType
LOCAL lcParserValue
LOCAL lcParse_test_public_id
LOCAL j
LOCAL lnCount_j
LOCAL lcStrVal
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
loHttp.SetRequestHeader("Accept","application/json")
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://api.app.ddog-gov.com/api/v1/synthetics/variables",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)
* {
* "variables": [
* {
* "description": "Example description",
* "name": "MY_VARIABLE",
* "tags": [
* "team:front",
* "test:workflow-1"
* ],
* "value": {
* "secure": true,
* "value": "value"
* },
* "attributes": {
* "restricted_roles": [
* "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
* ]
* },
* "id": "id Ut Excepteur commodo consectetur",
* "parse_test_options": {
* "type": "http_body",
* "field": "content-type",
* "localVariableName": "LOCAL_VARIABLE",
* "parser": {
* "type": "regex",
* "value": ".*"
* }
* },
* "parse_test_public_id": "abc-def-123"
* },
* {
* "description": "Example description",
* "name": "MY_VARIABLE",
* "tags": [
* "team:front",
* "test:workflow-1"
* ],
* "value": {
* "secure": true,
* "value": "value"
* },
* "attributes": {
* "restricted_roles": [
* "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
* ]
* },
* "id": "consectetur enim magna",
* "parse_test_options": {
* "type": "http_body",
* "field": "content-type",
* "localVariableName": "LOCAL_VARIABLE",
* "parser": {
* "type": "regex",
* "value": ".*"
* }
* },
* "parse_test_public_id": "abc-def-123"
* }
* ]
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
i = 0
lnCount_i = loJResp.SizeOfArray("variables")
DO WHILE i < lnCount_i
loJResp.I = i
lcDescription = loJResp.StringOf("variables[i].description")
lcName = loJResp.StringOf("variables[i].name")
lnSecure = loJResp.BoolOf("variables[i].value.secure")
lcValue = loJResp.StringOf("variables[i].value.value")
lcId = loJResp.StringOf("variables[i].id")
lcV_Type = loJResp.StringOf("variables[i].parse_test_options.type")
lcField = loJResp.StringOf("variables[i].parse_test_options.field")
lcLocalVariableName = loJResp.StringOf("variables[i].parse_test_options.localVariableName")
lcParserType = loJResp.StringOf("variables[i].parse_test_options.parser.type")
lcParserValue = loJResp.StringOf("variables[i].parse_test_options.parser.value")
lcParse_test_public_id = loJResp.StringOf("variables[i].parse_test_public_id")
j = 0
lnCount_j = loJResp.SizeOfArray("variables[i].tags")
DO WHILE j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("variables[i].tags[j]")
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("variables[i].attributes.restricted_roles")
DO WHILE j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("variables[i].attributes.restricted_roles[j]")
j = j + 1
ENDDO
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -X GET
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/synthetics/variables
Postman Collection Item JSON
{
"name": "Get all global variables",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables"
]
},
"description": "Get the list of all Synthetic global variables."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"variables\": [\n {\n \"description\": \"Example description\",\n \"name\": \"MY_VARIABLE\",\n \"tags\": [\n \"team:front\",\n \"test:workflow-1\"\n ],\n \"value\": {\n \"secure\": true,\n \"value\": \"value\"\n },\n \"attributes\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"id\": \"id Ut Excepteur commodo consectetur\",\n \"parse_test_options\": {\n \"type\": \"http_body\",\n \"field\": \"content-type\",\n \"localVariableName\": \"LOCAL_VARIABLE\",\n \"parser\": {\n \"type\": \"regex\",\n \"value\": \".*\"\n }\n },\n \"parse_test_public_id\": \"abc-def-123\"\n },\n {\n \"description\": \"Example description\",\n \"name\": \"MY_VARIABLE\",\n \"tags\": [\n \"team:front\",\n \"test:workflow-1\"\n ],\n \"value\": {\n \"secure\": true,\n \"value\": \"value\"\n },\n \"attributes\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"id\": \"consectetur enim magna\",\n \"parse_test_options\": {\n \"type\": \"http_body\",\n \"field\": \"content-type\",\n \"localVariableName\": \"LOCAL_VARIABLE\",\n \"parser\": {\n \"type\": \"regex\",\n \"value\": \".*\"\n }\n },\n \"parse_test_public_id\": \"abc-def-123\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables"
]
}
},
"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": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables"
]
}
},
"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}"
}
]
}
