Chilkat Online Tools

Powershell / Datadog API Collection / Get an SLO's details

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-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

$queryParams = New-Object Chilkat.JsonObject
$queryParams.UpdateString("with_configured_alert_ids","true")

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

$resp = $http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v1/slo/:slo_id",$queryParams)
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)

# {
#   "data": {
#     "configured_alert_ids": [
#       123,
#       456,
#       789
#     ],
#     "created_at": 17466638,
#     "creator": {
#       "email": "proident ex ullamco",
#       "handle": "laborum ad ex non",
#       "name": "officia dolor consectetur nisi"
#     },
#     "description": "est id",
#     "groups": [
#       "env:prod",
#       "role:mysql"
#     ],
#     "id": "esse cillum anim ",
#     "modified_at": -26273532,
#     "monitor_ids": [
#       -91642399,
#       93741
#     ],
#     "monitor_tags": [
#       "aliquip nulla Lorem ut",
#       "reprehenderit velit"
#     ],
#     "name": "Custom Metric SLO",
#     "query": {
#       "numerator": "sum:my.custom.metric{type:good}.as_count()",
#       "denominator": "sum:my.custom.metric{*}.as_count()"
#     },
#     "tags": [
#       "env:prod",
#       "app:core"
#     ],
#     "target_threshold": 99.9,
#     "thresholds": [
#       {
#         "target": 95,
#         "timeframe": "7d"
#       },
#       {
#         "target": 95,
#         "timeframe": "30d",
#         "warning": 97
#       }
#     ],
#     "timeframe": "30d",
#     "type": "metric",
#     "warning_threshold": 99.95
#   },
#   "errors": [
#     "consectetur velit",
#     "elit in"
#   ]
# }

# 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.IntOf("data.created_at")
$v_Email = $jResp.StringOf("data.creator.email")
$Handle = $jResp.StringOf("data.creator.handle")
$Name = $jResp.StringOf("data.creator.name")
$Description = $jResp.StringOf("data.description")
$Id = $jResp.StringOf("data.id")
$Modified_at = $jResp.IntOf("data.modified_at")
$dataName = $jResp.StringOf("data.name")
$Numerator = $jResp.StringOf("data.query.numerator")
$Denominator = $jResp.StringOf("data.query.denominator")
$Target_threshold = $jResp.StringOf("data.target_threshold")
$Timeframe = $jResp.StringOf("data.timeframe")
$v_Type = $jResp.StringOf("data.type")
$Warning_threshold = $jResp.StringOf("data.warning_threshold")
$i = 0
$count_i = $jResp.SizeOfArray("data.configured_alert_ids")
while ($i -lt $count_i) {
    $jResp.I = $i
    $intVal = $jResp.IntOf("data.configured_alert_ids[i]")
    $i = $i + 1
}

$i = 0
$count_i = $jResp.SizeOfArray("data.groups")
while ($i -lt $count_i) {
    $jResp.I = $i
    $strVal = $jResp.StringOf("data.groups[i]")
    $i = $i + 1
}

$i = 0
$count_i = $jResp.SizeOfArray("data.monitor_ids")
while ($i -lt $count_i) {
    $jResp.I = $i
    $intVal = $jResp.IntOf("data.monitor_ids[i]")
    $i = $i + 1
}

$i = 0
$count_i = $jResp.SizeOfArray("data.monitor_tags")
while ($i -lt $count_i) {
    $jResp.I = $i
    $strVal = $jResp.StringOf("data.monitor_tags[i]")
    $i = $i + 1
}

$i = 0
$count_i = $jResp.SizeOfArray("data.tags")
while ($i -lt $count_i) {
    $jResp.I = $i
    $strVal = $jResp.StringOf("data.tags[i]")
    $i = $i + 1
}

$i = 0
$count_i = $jResp.SizeOfArray("data.thresholds")
while ($i -lt $count_i) {
    $jResp.I = $i
    $target = $jResp.IntOf("data.thresholds[i].target")
    $timeframe = $jResp.StringOf("data.thresholds[i].timeframe")
    $warning = $jResp.IntOf("data.thresholds[i].warning")
    $i = $i + 1
}

$i = 0
$count_i = $jResp.SizeOfArray("errors")
while ($i -lt $count_i) {
    $jResp.I = $i
    $strVal = $jResp.StringOf("errors[i]")
    $i = $i + 1
}

Curl Command

curl -G -d "with_configured_alert_ids=true"
	-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/slo/:slo_id

Postman Collection Item JSON

{
  "name": "Get an SLO's details",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v1/slo/:slo_id?with_configured_alert_ids=true",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "slo",
        ":slo_id"
      ],
      "query": [
        {
          "key": "with_configured_alert_ids",
          "value": "true",
          "description": "Get the IDs of SLO monitors that reference this SLO."
        }
      ],
      "variable": [
        {
          "key": "slo_id",
          "value": "tempor Ut sed velit"
        }
      ]
    },
    "description": "Get a service level objective object."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/slo/:slo_id?with_configured_alert_ids=true",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "slo",
            ":slo_id"
          ],
          "query": [
            {
              "key": "with_configured_alert_ids",
              "value": "true",
              "description": "Get the IDs of SLO monitors that reference this SLO."
            }
          ],
          "variable": [
            {
              "key": "slo_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"configured_alert_ids\": [\n      123,\n      456,\n      789\n    ],\n    \"created_at\": 17466638,\n    \"creator\": {\n      \"email\": \"proident ex ullamco\",\n      \"handle\": \"laborum ad ex non\",\n      \"name\": \"officia dolor consectetur nisi\"\n    },\n    \"description\": \"est id\",\n    \"groups\": [\n      \"env:prod\",\n      \"role:mysql\"\n    ],\n    \"id\": \"esse cillum anim \",\n    \"modified_at\": -26273532,\n    \"monitor_ids\": [\n      -91642399,\n      93741\n    ],\n    \"monitor_tags\": [\n      \"aliquip nulla Lorem ut\",\n      \"reprehenderit velit\"\n    ],\n    \"name\": \"Custom Metric SLO\",\n    \"query\": {\n      \"numerator\": \"sum:my.custom.metric{type:good}.as_count()\",\n      \"denominator\": \"sum:my.custom.metric{*}.as_count()\"\n    },\n    \"tags\": [\n      \"env:prod\",\n      \"app:core\"\n    ],\n    \"target_threshold\": 99.9,\n    \"thresholds\": [\n      {\n        \"target\": 95,\n        \"timeframe\": \"7d\"\n      },\n      {\n        \"target\": 95,\n        \"timeframe\": \"30d\",\n        \"warning\": 97\n      }\n    ],\n    \"timeframe\": \"30d\",\n    \"type\": \"metric\",\n    \"warning_threshold\": 99.95\n  },\n  \"errors\": [\n    \"consectetur velit\",\n    \"elit in\"\n  ]\n}"
    },
    {
      "name": "Forbidden",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/slo/:slo_id?with_configured_alert_ids=true",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "slo",
            ":slo_id"
          ],
          "query": [
            {
              "key": "with_configured_alert_ids",
              "value": "true",
              "description": "Get the IDs of SLO monitors that reference this SLO."
            }
          ],
          "variable": [
            {
              "key": "slo_id"
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    },
    {
      "name": "Not found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/slo/:slo_id?with_configured_alert_ids=true",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "slo",
            ":slo_id"
          ],
          "query": [
            {
              "key": "with_configured_alert_ids",
              "value": "true",
              "description": "Get the IDs of SLO monitors that reference this SLO."
            }
          ],
          "variable": [
            {
              "key": "slo_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    },
    {
      "name": "Too many requests",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "DD-API-KEY",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/slo/:slo_id?with_configured_alert_ids=true",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "slo",
            ":slo_id"
          ],
          "query": [
            {
              "key": "with_configured_alert_ids",
              "value": "true",
              "description": "Get the IDs of SLO monitors that reference this SLO."
            }
          ],
          "variable": [
            {
              "key": "slo_id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"errors\": [\n    \"Bad Request\",\n    \"Bad Request\"\n  ]\n}"
    }
  ]
}