Alert Schedules data models
getAlertSchedules — 200 response
Successfully retrieved the alert schedules.
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 |
getAlertSchedules — 401 response
Authorization is required to access this resource.
| 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. |
getAlertSchedules — 403 response
Request failed because of denied permission.
| 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. |
getAlertSchedules — 429 response
Request failed because of rate limit.
| 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. |
getAlertSchedules — 500 response
An unexpected error has occurred.
| 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. |
getAlertSchedules — 503 response
The service is temporarily unavailable.
| 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. |
createAlertSchedule — request
Request body for Create an alert schedule.
| 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 | Yes | The name of the alert schedule | |
timeZone | string | Yes | The time zone to use for the schedule (IANA time zone database format, e.g. 'America/New_York') | |
weeklySchedules | object | Yes | Weekly schedule configuration |
createAlertSchedule — 201 response
Successfully created a new alert schedule.
| 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 |
createAlertSchedule — 401 response
Authorization is required to access this resource.
| 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. |
createAlertSchedule — 403 response
Request failed because of invalid data or denied permission.
| 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. |
createAlertSchedule — 429 response
Request failed because of rate limit.
| 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. |
createAlertSchedule — 500 response
An unexpected error has occurred.
| 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. |
createAlertSchedule — 503 response
The service is temporarily unavailable.
| 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. |
deleteAlertSchedule — 401 response
Authorization is required to access this resource.
| 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. |
deleteAlertSchedule — 403 response
Request failed because of invalid data or denied permission.
| 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. |
deleteAlertSchedule — 404 response
The required alertSchedule does not exist or is not accessible.
| 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. |
deleteAlertSchedule — 409 response
The alertSchedule cannot be deleted because it is being used by another part of the system.
| 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. |
deleteAlertSchedule — 429 response
Request failed because of rate limit.
| 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. |
deleteAlertSchedule — 500 response
An unexpected error has occurred.
| 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. |
deleteAlertSchedule — 503 response
The service is temporarily unavailable.
| 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. |
getAlertSchedule — 200 response
Successfully retrieved the alert schedule with specified ID.
| 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 |
getAlertSchedule — 401 response
Authorization is required to access this resource.
| 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. |
getAlertSchedule — 403 response
Request failed because of denied permission.
| 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. |
getAlertSchedule — 404 response
The requested alertSchedule does not exist or is not accessible.
| 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. |
getAlertSchedule — 429 response
Request failed because of rate limit.
| 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. |
getAlertSchedule — 500 response
An unexpected error has occurred.
| 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. |
getAlertSchedule — 503 response
The service is temporarily unavailable.
| 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. |
updateAlertSchedule — request
Request body for Update an alert schedule.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
description | string | No | default: "" | Optional description for the alert schedule |
name | string | No | The name of the alert schedule | |
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 |
updateAlertSchedule — 401 response
Authorization is required to access this resource.
| 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. |
updateAlertSchedule — 403 response
Request failed because of invalid data or denied permission.
| 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. |
updateAlertSchedule — 404 response
The requested alertSchedule does not exist or is not accessible.
| 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. |
updateAlertSchedule — 429 response
Request failed because of rate limit.
| 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. |
updateAlertSchedule — 500 response
An unexpected error has occurred.
| 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. |
updateAlertSchedule — 503 response
The service is temporarily unavailable.
| 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. |