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.
' {
' "is_secret": false,
' "name": "CUSTOM_VARIABLE_NAME",
' "value": "CUSTOM_VARIABLE_VALUE"
' }
Dim json As New Chilkat.JsonObject
json.UpdateBool("is_secret",False)
json.UpdateString("name","CUSTOM_VARIABLE_NAME")
json.UpdateString("value","CUSTOM_VARIABLE_VALUE")
http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("Accept","application/json")
Dim sbRequestBody As New Chilkat.StringBuilder
json.EmitSb(sbRequestBody)
Dim resp As Chilkat.HttpResponse = http.PTextSb("PUT","https://api.app.ddog-gov.com/api/v1/integration/webhooks/configuration/custom-variables/:custom_variable_name",sbRequestBody,"utf-8","application/json",False,False)
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(resp.Header)
Debug.WriteLine("Failed.")
Exit Sub
End If
' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)
' {
' "name": "CUSTOM_VARIABLE_NAME",
' "is_secret": true,
' "value": "CUSTOM_VARIABLE_VALUE"
' }
' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Dim name As String = jResp.StringOf("name")
Dim is_secret As Boolean = jResp.BoolOf("is_secret")
Dim value As String = jResp.StringOf("value")
Curl Command
curl -X PUT
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"is_secret": false,
"name": "CUSTOM_VARIABLE_NAME",
"value": "CUSTOM_VARIABLE_VALUE"
}'
https://api.app.ddog-gov.com/api/v1/integration/webhooks/configuration/custom-variables/:custom_variable_name
Postman Collection Item JSON
{
"name": "Update a custom variable",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"is_secret\": false,\n \"name\": \"CUSTOM_VARIABLE_NAME\",\n \"value\": \"CUSTOM_VARIABLE_VALUE\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables/:custom_variable_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables",
":custom_variable_name"
],
"variable": [
{
"key": "custom_variable_name",
"value": "tempor Ut sed velit"
}
]
},
"description": "Updates the endpoint with the name `<CUSTOM_VARIABLE_NAME>`."
},
"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 \"is_secret\": false,\n \"name\": \"CUSTOM_VARIABLE_NAME\",\n \"value\": \"CUSTOM_VARIABLE_VALUE\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables/:custom_variable_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables",
":custom_variable_name"
],
"variable": [
{
"key": "custom_variable_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"name\": \"CUSTOM_VARIABLE_NAME\",\n \"is_secret\": true,\n \"value\": \"CUSTOM_VARIABLE_VALUE\"\n}"
},
{
"name": "Bad 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 \"is_secret\": false,\n \"name\": \"CUSTOM_VARIABLE_NAME\",\n \"value\": \"CUSTOM_VARIABLE_VALUE\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables/:custom_variable_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables",
":custom_variable_name"
],
"variable": [
{
"key": "custom_variable_name"
}
]
}
},
"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": "Authentication error",
"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 \"is_secret\": false,\n \"name\": \"CUSTOM_VARIABLE_NAME\",\n \"value\": \"CUSTOM_VARIABLE_VALUE\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables/:custom_variable_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables",
":custom_variable_name"
],
"variable": [
{
"key": "custom_variable_name"
}
]
}
},
"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": "Item Not Found",
"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 \"is_secret\": false,\n \"name\": \"CUSTOM_VARIABLE_NAME\",\n \"value\": \"CUSTOM_VARIABLE_VALUE\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables/:custom_variable_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables",
":custom_variable_name"
],
"variable": [
{
"key": "custom_variable_name"
}
]
}
},
"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": "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 \"is_secret\": false,\n \"name\": \"CUSTOM_VARIABLE_NAME\",\n \"value\": \"CUSTOM_VARIABLE_VALUE\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/integration/webhooks/configuration/custom-variables/:custom_variable_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"integration",
"webhooks",
"configuration",
"custom-variables",
":custom_variable_name"
],
"variable": [
{
"key": "custom_variable_name"
}
]
}
},
"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}"
}
]
}
