getLoginBackground

GET

/api/v1/settings/login-background

const url = 'https://example.com/api/v1/settings/login-background';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/settings/login-background

Read the login background selection. Requires an enrolled dashboard session.

Responses

200

application/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"
  }
}

401

Dashboard authentication required

getLoginBackground

Responses

200

Examplegenerated

401

Example^generated