Chilkat Online Tools

Powershell / Datadog API Collection / Add Items to a Dashboard List

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

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

$http = New-Object 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": "custom_timeboard",
#       "id": "<string>"
#     },
#     {
#       "type": "integration_timeboard",
#       "id": "<string>"
#     }
#   ]
# }

$json = New-Object Chilkat.JsonObject
$json.UpdateString("dashboards[0].type","custom_timeboard")
$json.UpdateString("dashboards[0].id","<string>")
$json.UpdateString("dashboards[1].type","integration_timeboard")
$json.UpdateString("dashboards[1].id","<string>")

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

$resp = $http.PostJson3("https://api.app.ddog-gov.com/api/v2/dashboard/lists/manual/:dashboard_list_id/dashboards","application/json",$json)
if ($http.LastMethodSuccess -eq $false) {
    $($http.LastErrorText)
    exit
}

$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($resp.Header)
    $("Failed.")

    exit
}

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

# {
#   "added_dashboards_to_list": [
#     {
#       "type": "integration_timeboard",
#       "id": "<string>"
#     },
#     {
#       "type": "custom_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("added_dashboards_to_list")
while ($i -lt $count_i) {
    $jResp.I = $i
    $v_type = $jResp.StringOf("added_dashboards_to_list[i].type")
    $id = $jResp.StringOf("added_dashboards_to_list[i].id")
    $i = $i + 1
}

Curl Command

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

Postman Collection Item JSON

{
  "name": "Add Items to a Dashboard List",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"dashboards\": [\n    {\n      \"type\": \"custom_timeboard\",\n      \"id\": \"<string>\"\n    },\n    {\n      \"type\": \"integration_timeboard\",\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": "Add dashboards to an existing dashboard list."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "POST",
        "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\": \"custom_timeboard\",\n      \"id\": \"<string>\"\n    },\n    {\n      \"type\": \"integration_timeboard\",\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  \"added_dashboards_to_list\": [\n    {\n      \"type\": \"integration_timeboard\",\n      \"id\": \"<string>\"\n    },\n    {\n      \"type\": \"custom_timeboard\",\n      \"id\": \"<string>\"\n    }\n  ]\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "POST",
        "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\": \"custom_timeboard\",\n      \"id\": \"<string>\"\n    },\n    {\n      \"type\": \"integration_timeboard\",\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": "POST",
        "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\": \"custom_timeboard\",\n      \"id\": \"<string>\"\n    },\n    {\n      \"type\": \"integration_timeboard\",\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": "POST",
        "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\": \"custom_timeboard\",\n      \"id\": \"<string>\"\n    },\n    {\n      \"type\": \"integration_timeboard\",\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": "POST",
        "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\": \"custom_timeboard\",\n      \"id\": \"<string>\"\n    },\n    {\n      \"type\": \"integration_timeboard\",\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}"
    }
  ]
}