Skip to content

API Tara: announcements ​

Announcements from PhillipCLI (maintenance, incidents, news) shown as banners in the Portal and printed by ph

This page is generated from openapi.yaml by npm run gen, so do not edit it by hand. Authentication is described on the overview page.

GET/v1/announcements

Active announcements for the current organization

Announcements from PhillipCLI that are active now, aimed at the caller's organization (by plan or by organization), without the ones this user dismissed. The organization is the one of the session, token or CLI login; org (a slug the caller belongs to) picks another one for a Portal session. Plain text; links are written as plain https:// addresses.

Parameters ​

NameInTypeRequiredDescription
orgquerystringOrganization slug (the caller must be a member; otherwise 404)

Responses ​

CodeDescriptionType
200Active announcements, most severe first, then newestapplication/json · object
401Not signed inapplication/problem+json · object
404Not foundapplication/problem+json · object

Example response ​

json
{
  "items": [
    {
      "id": "string",
      "title": "string",
      "body": "string",
      "severity": "info",
      "dismissible": false,
      "startsAt": "2026-11-01T00:00:00Z"
    }
  ]
}

Call with curl ​

bash
curl "https://tara.phillipcli.cloud/v1/announcements" \
  -H "Authorization: Bearer $TARA_TOKEN"
POST/v1/announcements/{id}/dismiss

Dismiss an announcement for the signed-in user

Only announcements marked dismissible; 409 otherwise. Dismissing again is fine.

Parameters ​

NameInTypeRequiredDescription
idpathstringyes

Responses ​

CodeDescriptionType
204Dismissed
401Not signed inapplication/problem+json · object
404Not found, or not active for this organizationapplication/problem+json · object
409The announcement cannot be dismissedapplication/problem+json · object

Call with curl ​

bash
curl -X POST "https://tara.phillipcli.cloud/v1/announcements/<id>/dismiss" \
  -H "Authorization: Bearer $TARA_TOKEN"