Releases Index
Current site-wide notice
View .md

Current site-wide notice

GET
/site-notice

Returns the single active site notice, or { notice: null } when none is published. An admin Bearer additionally sees a stored-but-inactive (draft) notice.

Authorization

bearerAuth
headerAuthorizationBearer <relk_… | relu_… | OAuth JWT>

Machine/operator tokens use the relk_ prefix; self-serve read-only user keys use relu_; Sign in with Releases supplies an OAuth access token. Required scope depends on the endpoint.

Response Body

The current notice or null

application/json
  1. response
notice*|null
Example Request
curl -X GET 'https://api.releases.sh/v1/site-notice'
Example Response200
{  "notice": {    "active": true,    "message": "string",    "linkText": "string",    "href": "string",    "placement": "home",    "color": "string",    "dismissible": true,    "updatedAt": "2019-08-24T14:15:22Z"  }}