Get alert schedules
GET/projects/{projectId}/entities/{entityId}/alertSchedules
Base URL: https://api.tinkermode.com
Get a list of alert schedules for this entity.
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 of the entity or a project API key.
Path parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
projectId | integer | Yes | The unique ID for a specified project. | |
entityId | string | Yes | Entity ID (unique within project) |
Query parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
includeDescendants | boolean | No | If true, the result also includes alert schedules attached to the entity's descendants. Alert schedules of descendants that the requesting user has no permission to view are excluded. Defaults to false. | |
limit | integer | No | default: 25; min: 1; max: 100 | Maximum number of alert schedules to return. |
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. |