Describe a notification channel.

GET

/v1/projects/{projectId}/observability/notification-channels/{channelId}

Code sample: Shell / cURL

curl --request GET \
  --url https://stratum.example.com/v1/projects/example/observability/notification-channels/example \
  --header 'Authorization: Bearer <token>'

• A Stratum cluster endpoint.

Authorizations

• bearerAuth

Parameters

Path Parameters

projectId

required

string

/^p-[a-z0-9-]+$/

channelId

required

string

/^nch-[a-z0-9]{1,32}$/

Responses

200

The notification channel.

Media typeapplication/json

object

id

required

string

/^nch-[a-z0-9]{1,32}$/

projectId

required

string

name

required

string

displayName

required

string

description

string

type

required

string

Allowed values: webhook email slack pagerduty

config

required

Type-specific configuration. Shape depends on type:

• webhook: { url:..., headers: {...} }
• email: { addresses: [...] }
• slack: { webhook_url:... }
• pagerduty: { integration_key:... }

Webhook headers is an object of header name to string value, sent on every delivery. At most 16 headers. Values are visible ASCII, space or tab, up to 4096 characters. Headers the sender sets itself (Host, Content-Type, Content-Length, User-Agent, and the rest of Alertmanager’s reserved list) are refused with 400. Authorization must be <scheme> <credentials>; a Basic value must decode to user:password. Header values are write-only: every read returns them as REDACTED, and a PATCH that sends REDACTED back keeps the stored value. Headers apply to webhook channels only.

A tenant channel’s destination (url, or Slack webhook_url) may not be, or resolve to, loopback, link-local, unspecified, multicast, or one of the cluster’s own node and VIP addresses: 400 on create and PATCH. The system project’s channels are exempt.

object

key

additional properties

any

state

required

string

Allowed values: active deleted

tags

object

key

additional properties

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

deletedAt

string format: date-time

nullable

createdBy

required

string

Example

{
  "type": "webhook",
  "state": "active"
}

404

Resource not found.

Media typeapplication/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

>= 400 <= 599

detail

string

instance

string format: uri-reference

requestId

required

string

code

required

string

issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object

code

required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string

statement

required

Index of the statement at fault; -1 for the document as a whole.

integer

>= -1

detail

required

string

action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string

errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object

field

required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string

message

required

string

details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object

key

additional properties

any

Example

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}