Get notice

GET

/notices/{id}

Last modified:2026-10-12 18:08:01

OperationId:GetNotice

Returns a single notice by its numeric id. Requires Super User or Reseller scope. A Reseller may read a notice only if its target is within their own territory; a notice targeted elsewhere returns 403. The id is the per-server auto-increment key and is not stable across servers in the cluster. To look a notice up by its cluster-wide identity, filter GET /notices or use the notice_uid.

Request

Path Params

Responses

🟢200

application/json

A single notice.

Bodyapplication/json

🟠401Err401

🟠403Err403

🟠404Err404

Response Example

200 - Success Example

{
    "id": 4821,
    "notice_uid": "7c3a2f14-9b5e-4d21-8f6a-1c2d3e4f5a6b",
    "type": "scheduled_maintenance",
    "title": "Planned maintenance on Saturday",
    "message": "The platform will undergo scheduled maintenance on Saturday between 02:00 and 04:00 UTC. Calls may be briefly interrupted.",
    "link_url": "https://status.example.com/incidents/2026-09-05",
    "target_type": "domain",
    "target_value": "acme.example.com",
    "active": 1,
    "created_by": "1001@example.com",
    "starts_at": "2026-09-05T02:00:00Z",
    "ends_at": "2026-09-05T04:00:00Z",
    "created_at": "2026-09-01T14:30:00Z",
    "updated_at": "2026-09-01T14:30:00Z"
}

Modified at 2026-10-12 18:08:01

Create notice

Update notice