Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "data": {
; "type": "ip_allowlist",
; "attributes": {
; "enabled": "<boolean>",
; "entries": [
; {
; "data": {
; "type": "ip_allowlist_entry",
; "attributes": {
; "cidr_block": "<string>",
; "created_at": "<dateTime>",
; "modified_at": "<dateTime>",
; "note": "<string>"
; },
; "id": "<string>"
; }
; },
; {
; "data": {
; "type": "ip_allowlist_entry",
; "attributes": {
; "cidr_block": "<string>",
; "created_at": "<dateTime>",
; "modified_at": "<dateTime>",
; "note": "<string>"
; },
; "id": "<string>"
; }
; }
; ]
; },
; "id": "<string>"
; }
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("data.type","ip_allowlist")
$oJson.UpdateString("data.attributes.enabled","<boolean>")
$oJson.UpdateString("data.attributes.entries[0].data.type","ip_allowlist_entry")
$oJson.UpdateString("data.attributes.entries[0].data.attributes.cidr_block","<string>")
$oJson.UpdateString("data.attributes.entries[0].data.attributes.created_at","<dateTime>")
$oJson.UpdateString("data.attributes.entries[0].data.attributes.modified_at","<dateTime>")
$oJson.UpdateString("data.attributes.entries[0].data.attributes.note","<string>")
$oJson.UpdateString("data.attributes.entries[0].data.id","<string>")
$oJson.UpdateString("data.attributes.entries[1].data.type","ip_allowlist_entry")
$oJson.UpdateString("data.attributes.entries[1].data.attributes.cidr_block","<string>")
$oJson.UpdateString("data.attributes.entries[1].data.attributes.created_at","<dateTime>")
$oJson.UpdateString("data.attributes.entries[1].data.attributes.modified_at","<dateTime>")
$oJson.UpdateString("data.attributes.entries[1].data.attributes.note","<string>")
$oJson.UpdateString("data.attributes.entries[1].data.id","<string>")
$oJson.UpdateString("data.id","<string>")
$oHttp.SetRequestHeader "Content-Type","application/json"
$oHttp.SetRequestHeader "Accept","application/json"
$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)
Local $oResp = $oHttp.PTextSb("PATCH","https://api.app.ddog-gov.com/api/v2/ip_allowlist",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "data": {
; "type": "ip_allowlist",
; "attributes": {
; "enabled": "<boolean>",
; "entries": [
; {
; "data": {
; "type": "ip_allowlist_entry",
; "attributes": {
; "cidr_block": "<string>",
; "created_at": "<dateTime>",
; "modified_at": "<dateTime>",
; "note": "<string>"
; },
; "id": "<string>"
; }
; },
; {
; "data": {
; "type": "ip_allowlist_entry",
; "attributes": {
; "cidr_block": "<string>",
; "created_at": "<dateTime>",
; "modified_at": "<dateTime>",
; "note": "<string>"
; },
; "id": "<string>"
; }
; }
; ]
; },
; "id": "<string>"
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sDataType
Local $sCidr_block
Local $sCreated_at
Local $sModified_at
Local $sNote
Local $sDataId
Local $sV_Type = $oJResp.StringOf("data.type")
Local $sEnabled = $oJResp.StringOf("data.attributes.enabled")
Local $sId = $oJResp.StringOf("data.id")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data.attributes.entries")
While $i < $iCount_i
$oJResp.I = $i
$sDataType = $oJResp.StringOf("data.attributes.entries[i].data.type")
$sCidr_block = $oJResp.StringOf("data.attributes.entries[i].data.attributes.cidr_block")
$sCreated_at = $oJResp.StringOf("data.attributes.entries[i].data.attributes.created_at")
$sModified_at = $oJResp.StringOf("data.attributes.entries[i].data.attributes.modified_at")
$sNote = $oJResp.StringOf("data.attributes.entries[i].data.attributes.note")
$sDataId = $oJResp.StringOf("data.attributes.entries[i].data.id")
$i = $i + 1
Wend
Curl Command
curl -X PATCH
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"type": "ip_allowlist",
"attributes": {
"enabled": "<boolean>",
"entries": [
{
"data": {
"type": "ip_allowlist_entry",
"attributes": {
"cidr_block": "<string>",
"created_at": "<dateTime>",
"modified_at": "<dateTime>",
"note": "<string>"
},
"id": "<string>"
}
},
{
"data": {
"type": "ip_allowlist_entry",
"attributes": {
"cidr_block": "<string>",
"created_at": "<dateTime>",
"modified_at": "<dateTime>",
"note": "<string>"
},
"id": "<string>"
}
}
]
},
"id": "<string>"
}
}'
https://api.app.ddog-gov.com/api/v2/ip_allowlist
Postman Collection Item JSON
{
"name": "Update IP Allowlist",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"ip_allowlist\",\n \"attributes\": {\n \"enabled\": \"<boolean>\",\n \"entries\": [\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n },\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n }\n ]\n },\n \"id\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ip_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ip_allowlist"
]
},
"description": "Edit the entries in the IP allowlist, and enable or disable it."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PATCH",
"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 \"data\": {\n \"type\": \"ip_allowlist\",\n \"attributes\": {\n \"enabled\": \"<boolean>\",\n \"entries\": [\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n },\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n }\n ]\n },\n \"id\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ip_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ip_allowlist"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"type\": \"ip_allowlist\",\n \"attributes\": {\n \"enabled\": \"<boolean>\",\n \"entries\": [\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n },\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n }\n ]\n },\n \"id\": \"<string>\"\n }\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PATCH",
"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 \"data\": {\n \"type\": \"ip_allowlist\",\n \"attributes\": {\n \"enabled\": \"<boolean>\",\n \"entries\": [\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n },\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n }\n ]\n },\n \"id\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ip_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ip_allowlist"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "PATCH",
"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 \"data\": {\n \"type\": \"ip_allowlist\",\n \"attributes\": {\n \"enabled\": \"<boolean>\",\n \"entries\": [\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n },\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n }\n ]\n },\n \"id\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ip_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ip_allowlist"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PATCH",
"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 \"data\": {\n \"type\": \"ip_allowlist\",\n \"attributes\": {\n \"enabled\": \"<boolean>\",\n \"entries\": [\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n },\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n }\n ]\n },\n \"id\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ip_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ip_allowlist"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "PATCH",
"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 \"data\": {\n \"type\": \"ip_allowlist\",\n \"attributes\": {\n \"enabled\": \"<boolean>\",\n \"entries\": [\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n },\n {\n \"data\": {\n \"type\": \"ip_allowlist_entry\",\n \"attributes\": {\n \"cidr_block\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"note\": \"<string>\"\n },\n \"id\": \"<string>\"\n }\n }\n ]\n },\n \"id\": \"<string>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/ip_allowlist",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ip_allowlist"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
}
]
}
