List dashboard notifications

Returns notifications the caller is entitled to see, newest first. Notifications addressed to all are visible to everyone; those addressed to roles are only returned when the caller holds one of the listed roles. A local admin sees every notification.

Read and dismissed state is not stored server-side, so every caller sees the full page regardless of what they have already opened.

GET /api/notifications

Error

A valid request URL is required to generate request examples

200

{
  "notifications": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "audience": "all",
      "severity": "info",
      "title": "<string>",
      "message": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "expires_at": "2023-11-07T05:31:56Z",
      "role_ids": [
        123
      ],
      "action_label": "<string>",
      "action_path": "<string>"
    }
  ],
  "next_cursor": "<string>"
}

Authorizations

ManagementBearerAuthBasicAuth

Authorization · string · header · required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <token>, where <token> is one of:

• a Bifrost management API key,
• a dashboard session token issued by POST /api/session/login,
• base64 of <admin-username>:<admin-password> (legacy equivalent of BasicAuth).

Virtual keys (sk-bf-*) and the x-api-key header are not accepted on management APIs - the sole exception is GET /api/governance/virtual-keys/quota, which is virtual-key-only.

Query Parameters

limit · integer · default: 50

Notifications per page. Values above the server page size of 50 are clamped down to it.

Required range: 1 <= x <= 50

cursor · string

The next_cursor from a previous response.

Response

200

application/json

A page of notifications

A page of notifications, newest first, already filtered to what the caller's role may see.

notifications · object[] · required

Show child attributes

next_cursor · string

Opaque cursor for the next page. Absent when there are no further results. Pass it back as the cursor query parameter.