Chilkat Online Tools

Classic ASP / Datadog API Collection / Delete items from a dashboard list

Back to Collection Items

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<%
' 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 = Server.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.

' {
'   "dashboards": [
'     {
'       "type": "host_timeboard",
'       "id": "<string>"
'     },
'     {
'       "type": "integration_screenboard",
'       "id": "<string>"
'     }
'   ]
' }

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set json = Server.CreateObject("Chilkat.JsonObject")
success = json.UpdateString("dashboards[0].type","host_timeboard")
success = json.UpdateString("dashboards[0].id","<string>")
success = json.UpdateString("dashboards[1].type","integration_screenboard")
success = json.UpdateString("dashboards[1].id","<string>")

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 = Server.CreateObject("Chilkat.StringBuilder")
success = json.EmitSb(sbRequestBody)

' resp is a Chilkat.HttpResponse
Set resp = http.PTextSb("DELETE","https://api.app.ddog-gov.com/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",sbRequestBody,"utf-8","application/json",0,0)
If (http.LastMethodSuccess = 0) Then
    Response.Write "<pre>" & Server.HTMLEncode( http.LastErrorText) & "</pre>"
    Response.End
End If

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

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

Response.Write "<pre>" & Server.HTMLEncode( "Response Body:") & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( jResp.Emit()) & "</pre>"

respStatusCode = resp.StatusCode
Response.Write "<pre>" & Server.HTMLEncode( "Response Status Code = " & respStatusCode) & "</pre>"
If (respStatusCode >= 400) Then
    Response.Write "<pre>" & Server.HTMLEncode( "Response Header:") & "</pre>"
    Response.Write "<pre>" & Server.HTMLEncode( resp.Header) & "</pre>"
    Response.Write "<pre>" & Server.HTMLEncode( "Failed.") & "</pre>"

    Response.End
End If

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

' {
'   "deleted_dashboards_from_list": [
'     {
'       "type": "custom_timeboard",
'       "id": "<string>"
'     },
'     {
'       "type": "host_timeboard",
'       "id": "<string>"
'     }
'   ]
' }

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

i = 0
count_i = jResp.SizeOfArray("deleted_dashboards_from_list")
Do While i < count_i
    jResp.I = i
    v_type = jResp.StringOf("deleted_dashboards_from_list[i].type")
    id = jResp.StringOf("deleted_dashboards_from_list[i].id")
    i = i + 1
Loop

%>
</body>
</html>

Curl Command

curl -X DELETE
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "dashboards": [
    {
      "type": "host_timeboard",
      "id": "<string>"
    },
    {
      "type": "integration_screenboard",
      "id": "<string>"
    }
  ]
}'
https://api.app.ddog-gov.com/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards

Postman Collection Item JSON

{
  "name": "Delete items from a dashboard list",
  "request": {
    "method": "DELETE",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"dashboards\": [\n    {\n      \"type\": \"host_timeboard\",\n      \"id\": \"<string>\"\n    },\n    {\n      \"type\": \"integration_screenboard\",\n      \"id\": \"<string>\"\n    }\n  ]\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "dashboard",
        "lists",
        "manual",
        ":dashboard_list_id",
        "dashboards"
      ],
      "variable": [
        {
          "key": "dashboard_list_id",
          "value": "<long>"
        }
      ]
    },
    "description": "Delete dashboards from an existing dashboard list."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "DELETE",
        "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  \"dashboards\": [\n    {\n      \"type\": \"host_timeboard\",\n      \"id\": \"<string>\"\n    },\n    {\n      \"type\": \"integration_screenboard\",\n      \"id\": \"<string>\"\n    }\n  ]\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "dashboard",
            "lists",
            "manual",
            ":dashboard_list_id",
            "dashboards"
          ],
          "variable": [
            {
              "key": "dashboard_list_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"deleted_dashboards_from_list\": [\n    {\n      \"type\": \"custom_timeboard\",\n      \"id\": \"<string>\"\n    },\n    {\n      \"type\": \"host_timeboard\",\n      \"id\": \"<string>\"\n    }\n  ]\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "DELETE",
        "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  \"dashboards\": [\n    {\n      \"type\": \"host_timeboard\",\n      \"id\": \"<string>\"\n    },\n    {\n      \"type\": \"integration_screenboard\",\n      \"id\": \"<string>\"\n    }\n  ]\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "dashboard",
            "lists",
            "manual",
            ":dashboard_list_id",
            "dashboards"
          ],
          "variable": [
            {
              "key": "dashboard_list_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": "DELETE",
        "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  \"dashboards\": [\n    {\n      \"type\": \"host_timeboard\",\n      \"id\": \"<string>\"\n    },\n    {\n      \"type\": \"integration_screenboard\",\n      \"id\": \"<string>\"\n    }\n  ]\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "dashboard",
            "lists",
            "manual",
            ":dashboard_list_id",
            "dashboards"
          ],
          "variable": [
            {
              "key": "dashboard_list_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": "DELETE",
        "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  \"dashboards\": [\n    {\n      \"type\": \"host_timeboard\",\n      \"id\": \"<string>\"\n    },\n    {\n      \"type\": \"integration_screenboard\",\n      \"id\": \"<string>\"\n    }\n  ]\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "dashboard",
            "lists",
            "manual",
            ":dashboard_list_id",
            "dashboards"
          ],
          "variable": [
            {
              "key": "dashboard_list_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": "DELETE",
        "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  \"dashboards\": [\n    {\n      \"type\": \"host_timeboard\",\n      \"id\": \"<string>\"\n    },\n    {\n      \"type\": \"integration_screenboard\",\n      \"id\": \"<string>\"\n    }\n  ]\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "dashboard",
            "lists",
            "manual",
            ":dashboard_list_id",
            "dashboards"
          ],
          "variable": [
            {
              "key": "dashboard_list_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}"
    }
  ]
}