Air APIAPI ReferenceAnnouncements

Update individual fields of an announcement

View as Markdown

Updates individual fields of an announcement.

Required scope: air:sre (roles: air_sre)

Authentication

AuthorizationBearer

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

Path parameters

idstringRequiredformat: "uuid"
A UUID string identifying this announcements.

Request

This endpoint expects an object.
severityenumOptionalDefaults to INFO

The severity of the announcement

  • INFO - Info
  • ALERT - Alert
messagestringOptional1-512 characters
The message of the announcement
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
404
Not Found Error
500
Internal Server Error