System Configuration

Setting a new hero image for the server

Changed on

(introduced: version 2026.1)

An Administrator can use this endpoint to set a custom hero image for the entire server. The hero image will be shown to all users who visit the login page, as well as other pages, including the reset password page and set password page. If a hero image is already set, the current image will be overwritten with the new one.

post/v1/config/hero-image

Request

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

Response

OK

keystring required

The type of system configuration.

setAtstring required

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

blobExistsboolean required

Whether a file has been set for this configuration.

Example response

{
  "key": "hero-image",
  "setAt": "2018-01-06T00:32:52.787Z",
  "blobExists": true
}

Changes