Query: active portal messages for the user-shell banner strip.

GET

/announcements

const url = 'https://example.com/api/v1/announcements';
const options = {method: 'GET', headers: {cookie: 'dnse_session=<dnse_session>'}};

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

curl --request GET \
  --url https://example.com/api/v1/announcements \
  --cookie dnse_session=<dnse_session>

Authorizations

session

Responses

200

Active announcements.

application/json

Array<object>

Portal message shown as a banner in the user shell.

object

string format: uuid

title

string

body

Longer context, shown in a dialog.

string

severity

string

Allowed values: info warning critical

active

boolean

startsAt

string format: date-time

nullable

endsAt

string format: date-time

nullable

updatedAt

string format: date-time

Example

[
  {
    "severity": "info"
  }
]