Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
http.SetRequestHeader("Accept","application/json")
Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://api.app.ddog-gov.com/api/v1/synthetics/variables",sbResponseBody)
If (success = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(http.LastHeader)
Debug.WriteLine("Failed.")
Exit Sub
End If
' 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
Dim description As String
Dim name As String
Dim Secure As Boolean
Dim Value As String
Dim id As String
Dim v_Type As String
Dim Field As String
Dim LocalVariableName As String
Dim ParserType As String
Dim ParserValue As String
Dim parse_test_public_id As String
Dim j As Integer
Dim count_j As Integer
Dim strVal As String
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("variables")
While i < count_i
jResp.I = i
description = jResp.StringOf("variables[i].description")
name = jResp.StringOf("variables[i].name")
Secure = jResp.BoolOf("variables[i].value.secure")
Value = jResp.StringOf("variables[i].value.value")
id = jResp.StringOf("variables[i].id")
v_Type = jResp.StringOf("variables[i].parse_test_options.type")
Field = jResp.StringOf("variables[i].parse_test_options.field")
LocalVariableName = jResp.StringOf("variables[i].parse_test_options.localVariableName")
ParserType = jResp.StringOf("variables[i].parse_test_options.parser.type")
ParserValue = jResp.StringOf("variables[i].parse_test_options.parser.value")
parse_test_public_id = jResp.StringOf("variables[i].parse_test_public_id")
j = 0
count_j = jResp.SizeOfArray("variables[i].tags")
While j < count_j
jResp.J = j
strVal = jResp.StringOf("variables[i].tags[j]")
j = j + 1
End While
j = 0
count_j = jResp.SizeOfArray("variables[i].attributes.restricted_roles")
While j < count_j
jResp.J = j
strVal = jResp.StringOf("variables[i].attributes.restricted_roles[j]")
j = j + 1
End While
i = i + 1
End While
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}"
}
]
}
