Cycle Docs | API Reference | List Announcements

List Announcements

Use this API call to fetch a list of announcements for a given hub.

Returns

Returns a collection of announcements, otherwise returns an Error.

GET /v1/announcements

Example Request

$ curl https://api.cycle.io/v1/announcements \
  -H "Authorization: Bearer  API_KEY"
 \
  -H "X-HUB-ID:  HUB_ID"

Example Response

{
  "data": [
    {
      "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"
      }
    }
  ]
}