Create Scheduled Downtime

Use this API to create Downtime for a Schedule.

post/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/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

schedule_idstring required

The ID of the Schedule to add Downtime to

Request body

Response

201

idstring

Example response

{
  "meta": {
    "project_id": "<< project id >>",
    "schedule_id": "<< schedule id >>",
    "created": "2024-03-05T23:01:11.294265Z",
    "state": "inactive",
    "last_update": "2024-03-05T23:01:11.493080Z"
  },
  "id": "<< id >>",
  "schedule": {
    "start_time": "2024-03-05T15:00:00",
    "end_time": "2024-03-05T15:05:00",
    "zone": "America/Los_Angeles"
  }
}

Changes

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