Error
A valid request URL is required to generate request examples{
"alerts": [
{
"createdAt": "2022-11-22T04:37:12Z",
"createdBy": {
"id": "clm8qv74h000008mlf08scq7k",
"apiTokenName": "my-token",
"avatarUrl": "https://avatar.url",
"fullName": "Jane Doe",
"subjectType": "USER",
"username": "user1@company.com"
},
"entityId": "<string>",
"entityType": "DEPLOYMENT",
"id": "<string>",
"name": "<string>",
"organizationId": "<string>",
"rules": {
"properties": "<unknown>",
"patternMatches": [
{
"entityType": "DAG_ID TASK_ID",
"operatorType": "IS IS_NOT INCLUDES EXCLUDES",
"values": [
"<string>"
]
}
]
},
"severity": "INFO",
"type": "DAG_SUCCESS",
"updatedAt": "2022-11-22T04:37:12Z",
"updatedBy": {
"id": "clm8qv74h000008mlf08scq7k",
"apiTokenName": "my-token",
"avatarUrl": "https://avatar.url",
"fullName": "Jane Doe",
"subjectType": "USER",
"username": "user1@company.com"
},
"deploymentId": "<string>",
"entityName": "<string>",
"notificationChannels": [
{
"createdAt": "2022-11-22T04:37:12Z",
"definition": "<unknown>",
"entityId": "<string>",
"entityType": "ORGANIZATION",
"id": "<string>",
"name": "<string>",
"organizationId": "<string>",
"type": "SLACK",
"updatedAt": "2022-11-22T04:37:12Z",
"deploymentId": "<string>",
"workspaceId": "<string>"
}
],
"workspaceId": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}Alerts
Bulk create alerts
Create up to 30 alerts in a single request.
POST
/
organizations
/
{organizationId}
/
create-alerts
Error
A valid request URL is required to generate request examples{
"alerts": [
{
"createdAt": "2022-11-22T04:37:12Z",
"createdBy": {
"id": "clm8qv74h000008mlf08scq7k",
"apiTokenName": "my-token",
"avatarUrl": "https://avatar.url",
"fullName": "Jane Doe",
"subjectType": "USER",
"username": "user1@company.com"
},
"entityId": "<string>",
"entityType": "DEPLOYMENT",
"id": "<string>",
"name": "<string>",
"organizationId": "<string>",
"rules": {
"properties": "<unknown>",
"patternMatches": [
{
"entityType": "DAG_ID TASK_ID",
"operatorType": "IS IS_NOT INCLUDES EXCLUDES",
"values": [
"<string>"
]
}
]
},
"severity": "INFO",
"type": "DAG_SUCCESS",
"updatedAt": "2022-11-22T04:37:12Z",
"updatedBy": {
"id": "clm8qv74h000008mlf08scq7k",
"apiTokenName": "my-token",
"avatarUrl": "https://avatar.url",
"fullName": "Jane Doe",
"subjectType": "USER",
"username": "user1@company.com"
},
"deploymentId": "<string>",
"entityName": "<string>",
"notificationChannels": [
{
"createdAt": "2022-11-22T04:37:12Z",
"definition": "<unknown>",
"entityId": "<string>",
"entityType": "ORGANIZATION",
"id": "<string>",
"name": "<string>",
"organizationId": "<string>",
"type": "SLACK",
"updatedAt": "2022-11-22T04:37:12Z",
"deploymentId": "<string>",
"workspaceId": "<string>"
}
],
"workspaceId": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the Organization to which the alerts will belong to.
Body
application/json
The request body for creating multiple alerts.
alerts
(DAG_DURATION · object | DAG_FAILURE · object | DAG_SUCCESS · object | DAG_TIMELINESS · object | TASK_DURATION · object | TASK_FAILURE · object)[]
required
The alerts to create. At most 30 per request.
Required array length:
1 - 30 elements- DAG_DURATION
- DAG_FAILURE
- DAG_SUCCESS
- DAG_TIMELINESS
- TASK_DURATION
- TASK_FAILURE
Show child attributes
Show child attributes
Response
OK
The alerts that were created or updated.
Show child attributes
Show child attributes
Was this page helpful?
⌘I