Get Basemaps

GET

/settings/basemaps/

const url = 'https://example.com/api/settings/basemaps/';
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/settings/basemaps/

Return the configured basemap list (public, no auth required).

Basemaps with {api_key} in the URL are filtered out when no key is configured. When a key IS set the placeholder is resolved server-side. The response uses BasemapPublicResponse which excludes api_key.

Responses

200

Successful Response

application/json

Response Get Basemaps Settings Basemaps Get

Array<object>

BasemapPublicResponse

Public basemap response — excludes api_key.

object

required

Unique basemap identifier.

string

label

required

Label

Display label.

string

url

required

Url

Tile URL or style JSON URL with API key already substituted (or omitted) for client use.

string

enabled

required

Enabled

Whether the basemap is currently selectable.

boolean

is_preset

required

Is Preset

Whether this is a built-in preset.

boolean

attribution

Any of:

string
null

string

Example ^generated

[
  {
    "id": "example",
    "label": "example",
    "url": "example",
    "enabled": true,
    "is_preset": true,
    "attribution": "example"
  }
]

Get Basemaps

Responses

200

Example generated

Example ^generated