Instance Message

Get the administrative instance message

Fetches the active administrative instance message.

Request

get
/instance_message

Response

{
  "status": "200"
}

Update the administrative instance message

Updates the existing active administrative instance message.

Parameters

Name Type Required Description
active boolean false
color false
message string false

Errors

StatusDescription
404 Not found
409 No active message set

Request

patch
/instance_message

Response

{
  "example": {
    "active": true,
    "color": "red",
    "created_at": "2022-11-24T19:40:03.320000Z",
    "id": 3,
    "message": "Changed the third instance message",
    "updated_at": "2022-11-24T19:40:03.320000Z",
    "user": {
      "administrator": true,
      "handle": "ianboyes",
      "id": "ian"
    }
  },
  "status": "200"
}

Create an administrative instance message

Creates a new administrative instance message.

Parameters

Name Type Required Description
color true
message string true

Request

put
/instance_message

Response

{
  "example": {
    "active": true,
    "color": "yellow",
    "created_at": "2022-11-24T19:40:03.320000Z",
    "id": 3,
    "message": "Third instance message",
    "updated_at": "2022-11-24T19:40:03.320000Z",
    "user": {
      "administrator": true,
      "handle": "ianboyes",
      "id": "ian"
    }
  },
  "status": "200"
}