Create an alert (API Explorer) | Astro API Reference

Platform API ReferenceOrganization
Platform API ReferenceAlerts
Platform API ReferenceOptions
- GETGet cluster options
- GETGet Deployment options
Platform API ReferenceCluster
Platform API ReferenceDeployment
Platform API ReferenceDeploy
Platform API ReferenceEnvironment
Platform API ReferenceNotification Channels
Platform API ReferenceWorkspace
IAM API ReferenceAuthorization
- GETList authorization permission groups
IAM API ReferenceAllowed IP Address Range
IAM API ReferenceInvite
- POSTCreate a user invitation
- DELDelete a user invite
IAM API ReferenceRole
IAM API ReferenceTeam
IAM API ReferenceAPI Token
IAM API ReferenceUser

Built with

POSThttps://api.astronomer.io/platform/v1beta1/organizations/organizationId/alerts

Path Parameters

organizationIdstringRequired

Body

entityIdstringRequired
entityTypeenumRequired
namestringRequired>=1 character<=500 characters
notificationChannelIdslist of stringsRequired(1 item)
- 1
rulesobjectRequired
- patternMatcheslist of objectsRequired(1 item)
  1
  entityTypeenumRequired
  operatorTypeenumRequired
  valueslist of stringsRequired(1 item)
  1
- propertiesobjectRequired
  dagDurationSecondsintegerRequired>=60<=86400
  deploymentIdstringRequired
severityenumRequired
typeenumRequired

View in API Reference

Request

$ curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/alerts \
>      -H "Authorization: Bearer " \
>      -H "Content-Type: application/json" \
>      -d '{
>   "entityId": "entityId",
>   "entityType": "DEPLOYMENT",
>   "name": "name",
>   "notificationChannelIds": [
>     "notificationChannelIds"
>   ],
>   "rules": {
>     "patternMatches": [
>       {
>         "entityType": "TASK_ID",
>         "operatorType": "IS",
>         "values": [
>           "values"
>         ]
>       }
>     ],
>     "properties": {
>       "dagDurationSeconds": 0,
>       "deploymentId": "deploymentId"
>     }
>   },
>   "severity": "INFO",
>   "type": "DAG_SUCCESS"
> }'

Response

$	curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/alerts \
>	-H "Authorization: Bearer " \
>	-H "Content-Type: application/json" \
>	-d '{
>	"entityId": "entityId",
>	"entityType": "DEPLOYMENT",
>	"name": "name",
>	"notificationChannelIds": [
>	"notificationChannelIds"
>	],
>	"rules": {
>	"patternMatches": [
>	{
>	"entityType": "TASK_ID",
>	"operatorType": "IS",
>	"values": [
>	"values"
>	]
>	}
>	],
>	"properties": {
>	"dagDurationSeconds": 0,
>	"deploymentId": "deploymentId"
>	}
>	},
>	"severity": "INFO",
>	"type": "DAG_SUCCESS"
>	}'