Skip to main content
PATCH
Update a notification route

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization
string | null
x-ankra-organisation-id
string | null

Path Parameters

route_id
string<uuid4>
required

Body

application/json
kind
string | null
kinds
string[] | null
kinds_negated
boolean | null
severity
string | null
cluster_id
string<uuid4> | null
source_id
string | null
application_id
string<uuid4> | null

Only notifications about this application (its data.application_id); null matches every application.

reference_pattern
string | null

Only notifications about a branch, tag or pull request matching this glob (data.reference): main or refs/heads/main for the main branch, release/* within one path segment, release/** across segments, pull/* for every pull request, refs/tags/v* for tags. A pull request targeting main does not match main. Null matches every reference.

Maximum string length: 255
destination_id
string<uuid4> | null
priority
integer | null
stop_on_match
boolean | null
mode
string | null
enabled
boolean | null

Response

Successful Response

id
string<uuid4>
required
organisation_id
string<uuid4>
required
kind
string | null
required
kinds
string[] | null
required
kinds_negated
boolean
required
severity
string | null
required
cluster_id
string<uuid4> | null
required
source_id
string | null
required
application_id
string<uuid4> | null
required

Only notifications about this application (its data.application_id); null matches every application.

reference_pattern
string | null
required

Only notifications about a branch, tag or pull request matching this glob (data.reference): main or refs/heads/main for the main branch, release/* within one path segment, release/** across segments, pull/* for every pull request, refs/tags/v* for tags. A pull request targeting main does not match main. Null matches every reference.

Maximum string length: 255
destination_id
string<uuid4>
required
priority
integer
required
stop_on_match
boolean
required
mode
string
required
enabled
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required