putLoginBackground

PUT

/api/v1/settings/login-background

curl --request PUT \
  --url https://example.com/api/v1/settings/login-background \
  --header 'Content-Type: application/json' \
  --header 'X-CSRF-Token: example' \
  --data '{ "assetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Select the login background image asset. Requires an Owner or Administrator in an enrolled dashboard session. Cookie-authenticated unsafe requests require X-CSRF-Token.

Parameters

Header Parameters

X-CSRF-Token

required

string

Request Body^required

Media typeapplication/json

object

assetId

required

string format: uuid

Example^generated

{
  "assetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

200

Login background selected

Media typeapplication/json

object

data

required

object

assetId

Chosen image asset, or null when no background is set and the login page falls back to its default artwork.

string | null format: uuid

imageUrl

required

string

Example^generated

{
  "data": {
    "assetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "imageUrl": "example"
  }
}

400

Invalid request body

401

Dashboard authentication required

403

Insufficient role

409

Setup is not complete

422

Asset is not a valid image asset