The Announcement Resource

Announcements are a way for Cycle to communicate important information to the end user.

Attributes
  • id
    string

    The ID of the Announcement.

  • title
    string

    The title of the announcement.

  • description
    string

    More detailed information about the announcement.

  • updates
    array of objects

    Updates for the announcement.

    Show child fields
  • affected_providers
    array of strings

    An array listing the providers affected by the annoucement. Returns an empty array if there are no affected providers.

  • priority
    string

    The priority of the announcement. This can be:

    notice | low | medium | high | severe

  • events
    object

    A collection of timestamps for each event in the announcements's lifetime.

    Show child fields
  • creator
    object

    Information on the ID and account type of the creator.

    Show child fields
  • state
    object

    The state of the announcment.

    Show child fields
Example Announcement
{
"id": "5b9c2a77b6393d0001eb45fd",
"title": "Demo Title",
"description": "Demo Description",
"priority": "severe",
"updates": [
{
"id": "5b9c2a77b6393d0001eb45fd",
"message": "This is an example update.",
"creator": {
"type": "employee",
"id": "5b9c2a77b6393d0001eb45fd"
},
"time": "2022-09-14T21:39:03.096Z"
}
],
"affected_providers": [
"aws",
"vultr",
"equinix-metal"
],
"events": {
"created": "2020-12-18T19:20:25.258Z",
"updated": "2020-12-18T18:49:59.413Z",
"deleted": "0001-01-01T00:00:00Z",
"resolved": "2020-12-18T19:20:25.258Z"
},
"creator": {
"type": "employee",
"id": "5b9c2a77b6393d0001eb45fd"
},
"state": {
"changed": "2020-12-18T19:20:25.258Z",
"current": "live"
}
}