List Scheduled Downtimes

Use this API to list all the Downtimes of a Schedule.

get/schedules/{schedule_id}/downtime/

Request

Base URL
https://client.apimetrics.io/api/2
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/apicontext/apis/api-settings/docs/schedules/:schedule_id/downtime/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

schedule_idstring required

The ID of the Schedule you want to find downtimes for

Response

200

Example response

{
  "meta": {
    "project_id": "<< project id >>",
    "schedule_id": "<< scheduled id >>",
    "next_cursor": "<< cursor value >>"
  },
  "results": [
    {
      "meta": {
        "project_id": "<< project id >>",
        "state": "inactive",
        "created": "2024-09-13T20:12:19.076491Z",
        "schedule_id": "<<< schedule id >>",
        "last_update": "2024-09-13T20:12:19.076500Z"
      },
      "id": "<< downtime id >>",
      "schedule": {
        "start_time": "2024-09-13T13:20:00",
        "end_time": "2024-09-13T13:45:01",
        "zone": "America/Los_Angeles"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.