System Configuration

Setting a new title and description for the login page

Changed on

(introduced: version 2026.1)

An Administrator can use this endpoint to set a custom title and/or description to show to all users who visit the login page. The description will be shown as a subtitle. If a title or description is already set, the current configuration will be overwritten with the new one; the two configurations will not be merged.

post/v1/config/login-appearance

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/config/login-appearance
  • Auth
    none declared

Request body */*

titlestring

A custom title to show on the login page.

descriptionstring

A custom description to show on the login page as a subtitle.

Example request

{
  "title": "Better Data, Better Cocoa"
}

Response

OK

keystring required

The type of system configuration.

setAtstring required

ISO date format. The last time this system configuration was set.

Example response

{
  "key": "login-appearance",
  "setAt": "2018-01-06T00:32:52.787Z",
  "value": {
    "title": "Better Data, Better Cocoa"
  }
}

Changes