Chilkat Online Tools

TCL / Datadog API Collection / Update IP Allowlist

Back to Collection Items

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

# 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>"
#   }
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "data.type" "ip_allowlist"
CkJsonObject_UpdateString $json "data.attributes.enabled" "<boolean>"
CkJsonObject_UpdateString $json "data.attributes.entries[0].data.type" "ip_allowlist_entry"
CkJsonObject_UpdateString $json "data.attributes.entries[0].data.attributes.cidr_block" "<string>"
CkJsonObject_UpdateString $json "data.attributes.entries[0].data.attributes.created_at" "<dateTime>"
CkJsonObject_UpdateString $json "data.attributes.entries[0].data.attributes.modified_at" "<dateTime>"
CkJsonObject_UpdateString $json "data.attributes.entries[0].data.attributes.note" "<string>"
CkJsonObject_UpdateString $json "data.attributes.entries[0].data.id" "<string>"
CkJsonObject_UpdateString $json "data.attributes.entries[1].data.type" "ip_allowlist_entry"
CkJsonObject_UpdateString $json "data.attributes.entries[1].data.attributes.cidr_block" "<string>"
CkJsonObject_UpdateString $json "data.attributes.entries[1].data.attributes.created_at" "<dateTime>"
CkJsonObject_UpdateString $json "data.attributes.entries[1].data.attributes.modified_at" "<dateTime>"
CkJsonObject_UpdateString $json "data.attributes.entries[1].data.attributes.note" "<string>"
CkJsonObject_UpdateString $json "data.attributes.entries[1].data.id" "<string>"
CkJsonObject_UpdateString $json "data.id" "<string>"

CkHttp_SetRequestHeader $http "Content-Type" "application/json"
CkHttp_SetRequestHeader $http "Accept" "application/json"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody

# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PATCH" "https://api.app.ddog-gov.com/api/v2/ip_allowlist" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

# 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

set v_Type [CkJsonObject_stringOf $jResp "data.type"]
set Enabled [CkJsonObject_stringOf $jResp "data.attributes.enabled"]
set Id [CkJsonObject_stringOf $jResp "data.id"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "data.attributes.entries"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set dataType [CkJsonObject_stringOf $jResp "data.attributes.entries[i].data.type"]
    set Cidr_block [CkJsonObject_stringOf $jResp "data.attributes.entries[i].data.attributes.cidr_block"]
    set Created_at [CkJsonObject_stringOf $jResp "data.attributes.entries[i].data.attributes.created_at"]
    set Modified_at [CkJsonObject_stringOf $jResp "data.attributes.entries[i].data.attributes.modified_at"]
    set Note [CkJsonObject_stringOf $jResp "data.attributes.entries[i].data.attributes.note"]
    set dataId [CkJsonObject_stringOf $jResp "data.attributes.entries[i].data.id"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

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}"
    }
  ]
}