Update a notification channel

PATCH

/notifications/channels/{id}

const url = 'https://api.krakenkey.io/notifications/channels/example';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"example","url":"example","events":["cert.issued"],"enabled":true}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://api.krakenkey.io/notifications/channels/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "url": "example", "events": [ "cert.issued" ], "enabled": true }'

Authorizations

bearer

Parameters

Path Parameters

required

string

Channel UUID

Request Body^required

application/json

object

name

string

<= 100 characters

url

Destination URL. Slack: an incoming webhook (https://hooks.slack.com/services/…). Teams: a Workflows webhook URL (Office 365 connectors are retired). Webhook: any https URL that resolves only to public addresses. Stored encrypted and never returned in full.

string

events

Array<string>

Allowed values: cert.issued cert.renewed cert.failed cert.expiring cert.revoked cert.replacement_requested domain.verification_failed endpoint.scan_failed deploy.failed connector.stale

enabled

boolean

Responses

200

Channel updated

404

Channel not found

Update a notification channel

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

200

404

Request Body^required