Update an Alert Notification Channel (API Explorer)

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/notification-channels/notificationChannelId

Path Parameters

organizationIdstringRequired
notificationChannelIdstringRequired

Body

definitionobject
- dagIdstringRequired>=1 character
- deploymentApiTokenstringRequired
- deploymentIdstringRequired
isSharedboolean
namestring>=1 character<=255 characters
typeenum

View in API Reference

Request

$ curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/notification-channels/notificationChannelId \
>      -H "Authorization: Bearer " \
>      -H "Content-Type: application/json" \
>      -d '{
>   "definition": {
>     "dagId": "dagId",
>     "deploymentApiToken": "deploymentApiToken",
>     "deploymentId": "deploymentId"
>   },
>   "isShared": false,
>   "name": "name",
>   "type": "SLACK"
> }'

Response

$	curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/notification-channels/notificationChannelId \
>	-H "Authorization: Bearer " \
>	-H "Content-Type: application/json" \
>	-d '{
>	"definition": {
>	"dagId": "dagId",
>	"deploymentApiToken": "deploymentApiToken",
>	"deploymentId": "deploymentId"
>	},
>	"isShared": false,
>	"name": "name",
>	"type": "SLACK"
>	}'