Air APIAPI ReferenceAnnouncements

Create a global announcement

View as Markdown

Creates a global announcement. Used to display announcements to the user.

Required scope: air:sre (roles: air_sre)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
messagestringRequired1-512 characters
The message of the announcement
severityenumOptionalDefaults to INFO

The severity of the announcement

  • INFO - Info
  • ALERT - Alert
stateenumOptional

The state of the announcement. State was added to allow soft delete of announcements. By default, announcements are active and you will only see active announcements.

  • ACTIVE - Active
  • INACTIVE - Inactive

Response

idstringRead-onlyformat: "uuid"
messagestring<=512 characters
The message of the announcement
createddatetimeRead-only
severityenumOptionalDefaults to INFO

The severity of the announcement

  • INFO - Info
  • ALERT - Alert
stateenumOptional

The state of the announcement. State was added to allow soft delete of announcements. By default, announcements are active and you will only see active announcements.

  • ACTIVE - Active
  • INACTIVE - Inactive

Errors

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error