Announcements
Create an announcement
Create an announcement
Authorization
ApiKey read, writeAuthorization<token>
In: header
Scope: read, write
Request Body
application/json
Announcement request body
Create announcement request body
isDismissible*boolean
true if the announcement is dismissible
title*string
The title of the announcement
message*string
The message of the announcement
startTime*integer
The start time of the announcement. This is a Unix timestamp in milliseconds.
Format
int64endTime?integer
The end time of the announcement. This is a Unix timestamp in milliseconds.
Format
int64severity*string
The severity of the announcement
Value in
- "info"
- "warning"
- "critical"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v2/announcements" \ -H "Content-Type: application/json" \ -d '{ "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**." }'{ "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"}