Get alert schedules
GET/alertSchedules
Base URL: https://api.tinkermode.com
Get a list of alert schedules.
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.
Query parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
entityId | string | No | Return alert schedules associated with the specified entity. This parameter can't be used with the hasEntity parameter. | |
hasEntity | boolean | No | Return alert schedules that are associated with an entity or not. This parameter can't be used with the entityId parameter. | |
includeDescendants | boolean | No | Only meaningful together with the entityId filter. If true, an entity filter also matches alert schedules attached to its descendants. Defaults to false. | |
limit | integer | No | default: 25; min: 1; max: 100 | Maximum number of alert schedules to return. |
projectId | integer | Yes | Return alert schedules of the specified project. | |
skip | integer | No | default: 0; min: 0 | Number of alert schedules to skip over. |
Responses
200 Successfully retrieved the alert schedules.
Content type: application/json
Represents an alert schedule
An array of objects with the following shape:
| 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 |
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. |
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. |