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
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "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": "anim irure id cupidatat",
// "parse_test_options": {
// "type": "http_body",
// "field": "content-type",
// "localVariableName": "LOCAL_VARIABLE",
// "parser": {
// "type": "regex",
// "value": ".*"
// }
// },
// "parse_test_public_id": "abc-def-123"
// }
Dim json As New Chilkat.JsonObject
success = json.UpdateString("description","Example description")
success = json.UpdateString("name","MY_VARIABLE")
success = json.UpdateString("tags[0]","team:front")
success = json.UpdateString("tags[1]","test:workflow-1")
success = json.UpdateBool("value.secure",True)
success = json.UpdateString("value.value","value")
success = json.UpdateString("attributes.restricted_roles[0]","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")
success = json.UpdateString("id","anim irure id cupidatat")
success = json.UpdateString("parse_test_options.type","http_body")
success = json.UpdateString("parse_test_options.field","content-type")
success = json.UpdateString("parse_test_options.localVariableName","LOCAL_VARIABLE")
success = json.UpdateString("parse_test_options.parser.type","regex")
success = json.UpdateString("parse_test_options.parser.value",".*")
success = json.UpdateString("parse_test_public_id","abc-def-123")
http.SetRequestHeader "Content-Type","application/json"
http.SetRequestHeader "Accept","application/json"
Dim sbRequestBody As New Chilkat.StringBuilder
success = json.EmitSb(sbRequestBody)
Dim resp As Chilkat.HttpResponse
resp = http.PTextSb("PUT","https://api.app.ddog-gov.com/api/v1/synthetics/variables/:variable_id",sbRequestBody,"utf-8","application/json",False,False)
If (http.LastMethodSuccess = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())
Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
System.DebugLog("Response Header:")
System.DebugLog(resp.Header)
System.DebugLog("Failed.")
Return
End If
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "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": "anim irure id cupidatat",
// "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 strVal As String
Dim description As String
description = jResp.StringOf("description")
Dim name As String
name = jResp.StringOf("name")
Dim Secure As Boolean
Secure = jResp.BoolOf("value.secure")
Dim Value As String
Value = jResp.StringOf("value.value")
Dim id As String
id = jResp.StringOf("id")
Dim v_Type As String
v_Type = jResp.StringOf("parse_test_options.type")
Dim Field As String
Field = jResp.StringOf("parse_test_options.field")
Dim LocalVariableName As String
LocalVariableName = jResp.StringOf("parse_test_options.localVariableName")
Dim ParserType As String
ParserType = jResp.StringOf("parse_test_options.parser.type")
Dim ParserValue As String
ParserValue = jResp.StringOf("parse_test_options.parser.value")
Dim parse_test_public_id As String
parse_test_public_id = jResp.StringOf("parse_test_public_id")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("tags")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("tags[i]")
i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("attributes.restricted_roles")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("attributes.restricted_roles[i]")
i = i + 1
Wend
Curl Command
curl -X PUT
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"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": "anim irure id cupidatat",
"parse_test_options": {
"type": "http_body",
"field": "content-type",
"localVariableName": "LOCAL_VARIABLE",
"parser": {
"type": "regex",
"value": ".*"
}
},
"parse_test_public_id": "abc-def-123"
}'
https://api.app.ddog-gov.com/api/v1/synthetics/variables/:variable_id
Postman Collection Item JSON
{
"name": "Edit a global variable",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\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\": \"anim irure id cupidatat\",\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables",
":variable_id"
],
"variable": [
{
"key": "variable_id",
"value": "tempor Ut sed velit"
}
]
},
"description": "Edit a Synthetic global variable."
},
"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 \"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\": \"anim irure id cupidatat\",\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables",
":variable_id"
],
"variable": [
{
"key": "variable_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\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\": \"anim irure id cupidatat\",\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}"
},
{
"name": "Invalid request",
"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 \"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\": \"anim irure id cupidatat\",\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables",
":variable_id"
],
"variable": [
{
"key": "variable_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
},
{
"name": "Forbidden",
"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 \"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\": \"anim irure id cupidatat\",\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables",
":variable_id"
],
"variable": [
{
"key": "variable_id"
}
]
}
},
"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": "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 \"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\": \"anim irure id cupidatat\",\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}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables/:variable_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables",
":variable_id"
],
"variable": [
{
"key": "variable_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}"
}
]
}
