Chilkat Online Tools

VBScript / Datadog API Collection / Edit an API key

Back to Collection Items

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

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

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = CreateObject("Chilkat.Http")

' 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": {
'     "attributes": {
'       "name": "<string>"
'     },
'     "id": "<string>",
'     "type": "api_keys"
'   }
' }

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set json = CreateObject("Chilkat.JsonObject")
success = json.UpdateString("data.attributes.name","<string>")
success = json.UpdateString("data.id","<string>")
success = json.UpdateString("data.type","api_keys")

http.SetRequestHeader "Content-Type","application/json"
http.SetRequestHeader "Accept","application/json"

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbRequestBody = CreateObject("Chilkat.StringBuilder")
success = json.EmitSb(sbRequestBody)

' resp is a Chilkat.HttpResponse
Set resp = http.PTextSb("PATCH","https://api.app.ddog-gov.com/api/v2/api_keys/:api_key_id",sbRequestBody,"utf-8","application/json",0,0)
If (http.LastMethodSuccess = 0) Then
    outFile.WriteLine(http.LastErrorText)
    WScript.Quit
End If

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbResponseBody = CreateObject("Chilkat.StringBuilder")
success = resp.GetBodySb(sbResponseBody)

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set jResp = CreateObject("Chilkat.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

outFile.WriteLine("Response Body:")
outFile.WriteLine(jResp.Emit())

respStatusCode = resp.StatusCode
outFile.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    outFile.WriteLine("Response Header:")
    outFile.WriteLine(resp.Header)
    outFile.WriteLine("Failed.")

    WScript.Quit
End If

' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)

' {
'   "data": {
'     "attributes": {
'       "created_at": "<string>",
'       "key": "<string>",
'       "last4": "<string>",
'       "modified_at": "<string>",
'       "name": "<string>"
'     },
'     "id": "<string>",
'     "relationships": {
'       "created_by": {
'         "data": {
'           "id": "<string>",
'           "type": "users"
'         }
'       },
'       "modified_by": {
'         "data": {
'           "id": "<string>",
'           "type": "users"
'         }
'       }
'     },
'     "type": "api_keys"
'   },
'   "included": [
'     {
'       "attributes": {
'         "created_at": "<dateTime>",
'         "disabled": "<boolean>",
'         "email": "<string>",
'         "handle": "<string>",
'         "icon": "<string>",
'         "modified_at": "<dateTime>",
'         "name": "<string>",
'         "service_account": "<boolean>",
'         "status": "<string>",
'         "title": "<string>",
'         "verified": "<boolean>"
'       },
'       "id": "<string>",
'       "relationships": {
'         "org": {
'           "data": {
'             "id": "<string>",
'             "type": "orgs"
'           }
'         },
'         "other_orgs": {
'           "data": [
'             {
'               "id": "<string>",
'               "type": "orgs"
'             },
'             {
'               "id": "<string>",
'               "type": "orgs"
'             }
'           ]
'         },
'         "other_users": {
'           "data": [
'             {
'               "id": "<string>",
'               "type": "users"
'             },
'             {
'               "id": "<string>",
'               "type": "users"
'             }
'           ]
'         },
'         "roles": {
'           "data": [
'             {
'               "id": "<string>",
'               "type": "roles"
'             },
'             {
'               "id": "<string>",
'               "type": "roles"
'             }
'           ]
'         }
'       },
'       "type": "users"
'     },
'     {
'       "attributes": {
'         "created_at": "<dateTime>",
'         "disabled": "<boolean>",
'         "email": "<string>",
'         "handle": "<string>",
'         "icon": "<string>",
'         "modified_at": "<dateTime>",
'         "name": "<string>",
'         "service_account": "<boolean>",
'         "status": "<string>",
'         "title": "<string>",
'         "verified": "<boolean>"
'       },
'       "id": "<string>",
'       "relationships": {
'         "org": {
'           "data": {
'             "id": "<string>",
'             "type": "orgs"
'           }
'         },
'         "other_orgs": {
'           "data": [
'             {
'               "id": "<string>",
'               "type": "orgs"
'             },
'             {
'               "id": "<string>",
'               "type": "orgs"
'             }
'           ]
'         },
'         "other_users": {
'           "data": [
'             {
'               "id": "<string>",
'               "type": "users"
'             },
'             {
'               "id": "<string>",
'               "type": "users"
'             }
'           ]
'         },
'         "roles": {
'           "data": [
'             {
'               "id": "<string>",
'               "type": "roles"
'             },
'             {
'               "id": "<string>",
'               "type": "roles"
'             }
'           ]
'         }
'       },
'       "type": "users"
'     }
'   ]
' }

' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Created_at = jResp.StringOf("data.attributes.created_at")
Key = jResp.StringOf("data.attributes.key")
Last4 = jResp.StringOf("data.attributes.last4")
Modified_at = jResp.StringOf("data.attributes.modified_at")
Name = jResp.StringOf("data.attributes.name")
Id = jResp.StringOf("data.id")
DataId = jResp.StringOf("data.relationships.created_by.data.id")
v_Type = jResp.StringOf("data.relationships.created_by.data.type")
DataId = jResp.StringOf("data.relationships.modified_by.data.id")
DataType = jResp.StringOf("data.relationships.modified_by.data.type")
dataType = jResp.StringOf("data.type")
i = 0
count_i = jResp.SizeOfArray("included")
Do While i < count_i
    jResp.I = i
    attributesCreated_at = jResp.StringOf("included[i].attributes.created_at")
    Disabled = jResp.StringOf("included[i].attributes.disabled")
    v_Email = jResp.StringOf("included[i].attributes.email")
    Handle = jResp.StringOf("included[i].attributes.handle")
    Icon = jResp.StringOf("included[i].attributes.icon")
    attributesModified_at = jResp.StringOf("included[i].attributes.modified_at")
    attributesName = jResp.StringOf("included[i].attributes.name")
    Service_account = jResp.StringOf("included[i].attributes.service_account")
    Status = jResp.StringOf("included[i].attributes.status")
    Title = jResp.StringOf("included[i].attributes.title")
    Verified = jResp.StringOf("included[i].attributes.verified")
    id = jResp.StringOf("included[i].id")
    DataId = jResp.StringOf("included[i].relationships.org.data.id")
    DataType = jResp.StringOf("included[i].relationships.org.data.type")
    v_type = jResp.StringOf("included[i].type")
    j = 0
    count_j = jResp.SizeOfArray("included[i].relationships.other_orgs.data")
    Do While j < count_j
        jResp.J = j
        id = jResp.StringOf("included[i].relationships.other_orgs.data[j].id")
        v_type = jResp.StringOf("included[i].relationships.other_orgs.data[j].type")
        j = j + 1
    Loop
    j = 0
    count_j = jResp.SizeOfArray("included[i].relationships.other_users.data")
    Do While j < count_j
        jResp.J = j
        id = jResp.StringOf("included[i].relationships.other_users.data[j].id")
        v_type = jResp.StringOf("included[i].relationships.other_users.data[j].type")
        j = j + 1
    Loop
    j = 0
    count_j = jResp.SizeOfArray("included[i].relationships.roles.data")
    Do While j < count_j
        jResp.J = j
        id = jResp.StringOf("included[i].relationships.roles.data[j].id")
        v_type = jResp.StringOf("included[i].relationships.roles.data[j].type")
        j = j + 1
    Loop
    i = i + 1
Loop

outFile.Close

Curl Command

curl -X PATCH
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "data": {
    "attributes": {
      "name": "<string>"
    },
    "id": "<string>",
    "type": "api_keys"
  }
}'
https://api.app.ddog-gov.com/api/v2/api_keys/:api_key_id

Postman Collection Item JSON

{
  "name": "Edit an API key",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"data\": {\n    \"attributes\": {\n      \"name\": \"<string>\"\n    },\n    \"id\": \"<string>\",\n    \"type\": \"api_keys\"\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "api_keys",
        ":api_key_id"
      ],
      "variable": [
        {
          "key": "api_key_id",
          "value": "<string>"
        }
      ]
    },
    "description": "Update an API key."
  },
  "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    \"attributes\": {\n      \"name\": \"<string>\"\n    },\n    \"id\": \"<string>\",\n    \"type\": \"api_keys\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "api_keys",
            ":api_key_id"
          ],
          "variable": [
            {
              "key": "api_key_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"attributes\": {\n      \"created_at\": \"<string>\",\n      \"key\": \"<string>\",\n      \"last4\": \"<string>\",\n      \"modified_at\": \"<string>\",\n      \"name\": \"<string>\"\n    },\n    \"id\": \"<string>\",\n    \"relationships\": {\n      \"created_by\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"users\"\n        }\n      },\n      \"modified_by\": {\n        \"data\": {\n          \"id\": \"<string>\",\n          \"type\": \"users\"\n        }\n      }\n    },\n    \"type\": \"api_keys\"\n  },\n  \"included\": [\n    {\n      \"attributes\": {\n        \"created_at\": \"<dateTime>\",\n        \"disabled\": \"<boolean>\",\n        \"email\": \"<string>\",\n        \"handle\": \"<string>\",\n        \"icon\": \"<string>\",\n        \"modified_at\": \"<dateTime>\",\n        \"name\": \"<string>\",\n        \"service_account\": \"<boolean>\",\n        \"status\": \"<string>\",\n        \"title\": \"<string>\",\n        \"verified\": \"<boolean>\"\n      },\n      \"id\": \"<string>\",\n      \"relationships\": {\n        \"org\": {\n          \"data\": {\n            \"id\": \"<string>\",\n            \"type\": \"orgs\"\n          }\n        },\n        \"other_orgs\": {\n          \"data\": [\n            {\n              \"id\": \"<string>\",\n              \"type\": \"orgs\"\n            },\n            {\n              \"id\": \"<string>\",\n              \"type\": \"orgs\"\n            }\n          ]\n        },\n        \"other_users\": {\n          \"data\": [\n            {\n              \"id\": \"<string>\",\n              \"type\": \"users\"\n            },\n            {\n              \"id\": \"<string>\",\n              \"type\": \"users\"\n            }\n          ]\n        },\n        \"roles\": {\n          \"data\": [\n            {\n              \"id\": \"<string>\",\n              \"type\": \"roles\"\n            },\n            {\n              \"id\": \"<string>\",\n              \"type\": \"roles\"\n            }\n          ]\n        }\n      },\n      \"type\": \"users\"\n    },\n    {\n      \"attributes\": {\n        \"created_at\": \"<dateTime>\",\n        \"disabled\": \"<boolean>\",\n        \"email\": \"<string>\",\n        \"handle\": \"<string>\",\n        \"icon\": \"<string>\",\n        \"modified_at\": \"<dateTime>\",\n        \"name\": \"<string>\",\n        \"service_account\": \"<boolean>\",\n        \"status\": \"<string>\",\n        \"title\": \"<string>\",\n        \"verified\": \"<boolean>\"\n      },\n      \"id\": \"<string>\",\n      \"relationships\": {\n        \"org\": {\n          \"data\": {\n            \"id\": \"<string>\",\n            \"type\": \"orgs\"\n          }\n        },\n        \"other_orgs\": {\n          \"data\": [\n            {\n              \"id\": \"<string>\",\n              \"type\": \"orgs\"\n            },\n            {\n              \"id\": \"<string>\",\n              \"type\": \"orgs\"\n            }\n          ]\n        },\n        \"other_users\": {\n          \"data\": [\n            {\n              \"id\": \"<string>\",\n              \"type\": \"users\"\n            },\n            {\n              \"id\": \"<string>\",\n              \"type\": \"users\"\n            }\n          ]\n        },\n        \"roles\": {\n          \"data\": [\n            {\n              \"id\": \"<string>\",\n              \"type\": \"roles\"\n            },\n            {\n              \"id\": \"<string>\",\n              \"type\": \"roles\"\n            }\n          ]\n        }\n      },\n      \"type\": \"users\"\n    }\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    \"attributes\": {\n      \"name\": \"<string>\"\n    },\n    \"id\": \"<string>\",\n    \"type\": \"api_keys\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "api_keys",
            ":api_key_id"
          ],
          "variable": [
            {
              "key": "api_key_id"
            }
          ]
        }
      },
      "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    \"attributes\": {\n      \"name\": \"<string>\"\n    },\n    \"id\": \"<string>\",\n    \"type\": \"api_keys\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "api_keys",
            ":api_key_id"
          ],
          "variable": [
            {
              "key": "api_key_id"
            }
          ]
        }
      },
      "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    \"attributes\": {\n      \"name\": \"<string>\"\n    },\n    \"id\": \"<string>\",\n    \"type\": \"api_keys\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "api_keys",
            ":api_key_id"
          ],
          "variable": [
            {
              "key": "api_key_id"
            }
          ]
        }
      },
      "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    \"attributes\": {\n      \"name\": \"<string>\"\n    },\n    \"id\": \"<string>\",\n    \"type\": \"api_keys\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/api_keys/:api_key_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "api_keys",
            ":api_key_id"
          ],
          "variable": [
            {
              "key": "api_key_id"
            }
          ]
        }
      },
      "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}"
    }
  ]
}