monitoring.subscribers.add

Add a webhook, or invite an email address (it confirms by link first)

POST /monitoring/api/status-pages/{id}/subscribersIAM monitoring:UpdateStatusPageChanges stateDestructive

A webhook gets a JSON POST (type ews.monitoring.status-page.incident.created|updated|resolved, component.down|up). An email address gets nothing until it opens the confirmation link. At most 1000 per page.

Request syntax

POST /monitoring/api/status-pages/{id}/subscribers
{
  "kind": "enum",
  "target": "string"
}

Path parameters

  • idRequired

    string

    Constraints: uuid

Request body

  • kindRequired

    enum

    email: sent a confirmation link and told nothing else until it is opened; webhook: confirmed at once

    One of: email, webhook

  • targetRequired

    string

    An email address (up to 254 characters, stored lower-case), or an https URL on a public address (up to 2048). 409 when it is already subscribed

Response

201 with the subscriber, { id, kind, target, confirmed, createdAt }: confirmed is true for a webhook, false for an address until its link is opened. 409 when the target is already subscribed or the page has 1000 subscribers; 404 when the organization has no such page.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow monitoring:UpdateStatusPage on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud monitoring subscribers add id --kind email --target example

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_monitoring_subscribers_add.