v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB

Announcements

Create an announcement

Create an announcement

post/api/v2/announcements

Request body

isDismissibleboolean required

true if the announcement is dismissible

titlestring required

The title of the announcement

messagestring required

The message of the announcement

startTimeinteger required

The start time of the announcement. This is a Unix timestamp in milliseconds.

endTimeinteger

The end time of the announcement. This is a Unix timestamp in milliseconds.

severity'info' | 'warning' | 'critical' required

The severity of the announcement

Example request

{
  "severity": "warning",
  "startTime": 1731439812,
  "isDismissible": true,
  "endTime": 1731439880,
  "title": "System Maintenance Notice",
  "message": "**Important Update:**\n\nPlease be aware of the upcoming maintenance scheduled for *October 31st, 2024*. The system will be unavailable from **12:00 AM** to **4:00 AM**."
}

Response

Created announcement

_idstring required

The ID of the announcement

isDismissibleboolean required

true if the announcement is dismissible

titlestring required

The title of the announcement

messagestring required

The message of the announcement

startTimeinteger required

The start time of the announcement. This is a Unix timestamp in milliseconds.

endTimeinteger

The end time of the announcement. This is a Unix timestamp in milliseconds.

severity'info' | 'warning' | 'critical' required

The severity of the announcement

_status'active' | 'inactive' | 'scheduled' required

The status of the announcement

Example response

{
  "severity": "info",
  "_access": {
    "allowed": [
      {
        "reason": {
          "role_name": "role_name",
          "notActions": [
            null,
            null
          ],
          "notResources": [
            "notResources",
            "notResources"
          ],
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ]
        },
        "action": "action"
      },
      {
        "reason": {
          "role_name": "role_name",
          "notActions": [
            null,
            null
          ],
          "notResources": [
            "notResources",
            "notResources"
          ],
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ]
        },
        "action": "action"
      }
    ],
    "denied": [
      {
        "reason": {
          "role_name": "role_name",
          "notActions": [
            null,
            null
          ],
          "notResources": [
            "notResources",
            "notResources"
          ],
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ]
        },
        "action": "action"
      },
      {
        "reason": {
          "role_name": "role_name",
          "notActions": [
            null,
            null
          ],
          "notResources": [
            "notResources",
            "notResources"
          ],
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ]
        },
        "action": "action"
      }
    ]
  },
  "_links": {
    "parent": {
      "href": "href",
      "type": "type"
    }
  },
  "startTime": 1731439812,
  "_id": "1234567890",
  "isDismissible": true,
  "endTime": 1731439880,
  "title": "System Maintenance Notice",
  "message": "**Important Update:**\n\nPlease be aware of the upcoming maintenance scheduled for *October 31st, 2024*. The system will be unavailable from **12:00 AM** to **4:00 AM**.",
  "_status": "active"
}