Get an alert schedule

GET/alertSchedules/{alertScheduleId}

Base URL: https://api.tinkermode.com

Return the alert schedule with the specified ID.

Authentication

Send an Authorization header of the form ModeCloud <AUTH_CODE>.

Must contain the key of a user or service account with permissions to read alert schedules or a project API key.

Path parameters

Name	Type	Required	Constraints	Description
`alertScheduleId`	string	Yes		The unique ID for a specified alert schedule.

Responses

`200` Successfully retrieved the alert schedule with specified ID.

Content type: application/json

Property	Type	Required	Constraints	Description
`description`	string	No	default: ""	Optional description for the alert schedule
`entityId`	string	No		Optional entity ID if the schedule is associated with a specific entity
`name`	string	No		The name of the alert schedule
`projectId`	integer	No		The unique identifier for the project the alert rule belongs to
`timeZone`	string	No		The time zone to use for the schedule (IANA time zone database format, e.g. 'America/New_York')
`weeklySchedules`	object	No		Weekly schedule configuration

Response example

{
  "creationTime": "2023-01-03T00:05:00.000Z",
  "description": "Standard business hours for monitoring alerts",
  "entityId": "entity123456",
  "id": "507f1f77bcf86cd799439011",
  "name": "Business Hours Schedule",
  "projectId": 123,
  "timeZone": "America/Los_Angeles",
  "updateTime": "2023-01-04T00:10:00.000Z",
  "weeklySchedules": {
    "friday": {
      "timeWindows": [
        {
          "end": "17:00:00",
          "start": "09:00:00"
        }
      ]
    },
    "monday": {
      "timeWindows": [
        {
          "end": "17:00:00",
          "start": "09:00:00"
        }
      ]
    },
    "saturday": {
      "timeWindows": []
    },
    "sunday": {
      "timeWindows": []
    },
    "thursday": {
      "timeWindows": [
        {
          "end": "17:00:00",
          "start": "09:00:00"
        }
      ]
    },
    "tuesday": {
      "timeWindows": [
        {
          "end": "17:00:00",
          "start": "09:00:00"
        }
      ]
    },
    "wednesday": {
      "timeWindows": [
        {
          "end": "17:00:00",
          "start": "09:00:00"
        }
      ]
    }
  }
}

`401` Authorization is required to access this resource.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`403` Request failed because of denied permission.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`404` The requested alertSchedule does not exist or is not accessible.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`429` Request failed because of rate limit.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`500` An unexpected error has occurred.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`503` The service is temporarily unavailable.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.