Skip to content
getgeolens.com
GeoLens Docs

Patch Map Layers Endpoint

PATCH
/maps/{map_id}/layers
 
curl --request PATCH \
  --url https://example.com/maps/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/layers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "added": [ { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "dataset_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "sort_order": 0, "visible": true, "opacity": 1, "paint": {}, "layout": {}, "display_name": "example", "filter": [ "example" ], "label_config": {}, "popup_config": { "enabled": true, "expression": "example", "visible_fields": [ "example" ] }, "style_config": {}, "layer_type": "example", "show_in_legend": true } ], "updated": [ { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "sort_order": 1, "visible": true, "opacity": 1, "paint": {}, "layout": {}, "display_name": "example", "filter": [ "example" ], "label_config": {}, "popup_config": { "enabled": true, "expression": "example", "visible_fields": [ "example" ] }, "style_config": {}, "layer_type": "example", "show_in_legend": true } ], "removed": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "order": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "fallback_full_replace": false }'

Apply incremental layer additions, patches, removals, and ordering.

Declared on both slash variants directly, mirroring the POST route below. FastAPI’s default redirect_slashes builds a relative Location header that resolves against the request’s Host header, which would leak the in-container api:8000 hostname through Vite’s dev proxy on a 307 redirect. The canonical (OpenAPI-published) form is the no-slash sub-collection convention documented in the GeoLens API guide (https://docs.getgeolens.com/guides/api/); the trailing-slash form is a hidden alias.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
map_id
required
Map Id
string format: uuid

Request Body required

Section titled “ Request Body required ”
Media type application/json
MapLayerDiffRequest
object
added
Added

Layers to append (max 200)

Array<object>
<= 200 items
MapLayerInput
object
id
Any of:
string format: uuid
dataset_id
required
Dataset Id
string format: uuid
sort_order
Sort Order

Draw order (lower draws first)

integer
0 <= 32767
visible
Visible
boolean
default: true
opacity
Opacity

Layer opacity 0.0-1.0

number
default: 1 <= 1
paint
Any of:
object
key
additional properties
any
layout
Any of:
object
key
additional properties
any
display_name
Any of:
string
<= 255 characters
filter
Any of:
Array
label_config
Any of:
object
key
additional properties
any
popup_config
Any of:
PopupConfig

Per-layer popup configuration: enable/disable + custom title template

  • ordered visible-fields allowlist. Persisted as JSONB on map_layers.
object
enabled
required
Enabled
boolean
expression
Any of:
string
<= 500 characters
visible_fields
Any of:
Array<string>
<= 100 items
style_config
Any of:
object
key
additional properties
any
layer_type
Any of:
string
/^(vector_geolens|raster_geolens|geojson)$/
show_in_legend
Show In Legend

Whether to include in the map legend

boolean
default: true
updated
Updated
Array<object>
MapLayerPatch
object
id
required
Id
string format: uuid
sort_order
Any of:
integer
<= 32767
visible
Any of:
boolean
opacity
Any of:
number
<= 1
paint
Any of:
object
key
additional properties
any
layout
Any of:
object
key
additional properties
any
display_name
Any of:
string
<= 255 characters
filter
Any of:
Array
label_config
Any of:
object
key
additional properties
any
popup_config
Any of:
PopupConfig

Per-layer popup configuration: enable/disable + custom title template

  • ordered visible-fields allowlist. Persisted as JSONB on map_layers.
object
enabled
required
Enabled
boolean
expression
Any of:
string
<= 500 characters
visible_fields
Any of:
Array<string>
<= 100 items
style_config
Any of:
object
key
additional properties
any
layer_type
Any of:
string
/^(vector_geolens|raster_geolens|geojson)$/
show_in_legend
Any of:
boolean
removed
Removed
Array<string>
order
Any of:
Array<string>
fallback_full_replace
Fallback Full Replace

Client hint only; PATCH never performs full replacement

boolean

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Successful Response

Media type application/json
MapResponse
object
id
required
Id
string format: uuid
name
required
Name
string
description
required
Any of:
string
notes
Any of:
string
center_lng
required
Any of:
number
center_lat
required
Any of:
number
zoom
required
Any of:
number
bearing
required
Bearing
number
pitch
required
Pitch
number
basemap_style
required
Basemap Style
string
show_basemap_labels
required
Show Basemap Labels
boolean
basemap_config
Any of:
BasemapConfig
object
label_mode
BasemapLabelMode

Basemap label prominence.

string
default: full
Allowed values: full subtle hidden
road_visibility
BasemapSublayerVisibility

Road and transit sublayer visibility where supported.

string
default: full
Allowed values: full subtle hidden
boundary_visibility
BasemapSublayerVisibility

Administrative boundary sublayer visibility where supported.

string
default: full
Allowed values: full subtle hidden
building_visibility
Building Visibility

Whether supported building/3D building basemap layers are shown.

boolean
default: true
land_water_tone
BasemapLandWaterTone

Land and water color treatment where supported.

string
default: default
Allowed values: default muted contrast monochrome
relief_contrast
Any of:
BasemapReliefContrast
string
Allowed values: soft standard strong
opacity
Opacity

Master basemap opacity 0.0-1.0

number
default: 1 <= 1
background_color
Any of:
string
sublayer_overrides
Any of:
object
key
additional properties
SublayerOverride

Per-sublayer style override for a single basemap sublayer.

All fields are nullable — a None value means “use the basemap default”. Only #RRGGBB hex strings are accepted for color fields; None means the basemap default color is preserved. Numeric ranges are clamped at validation time (Pydantic ge/le constraints).

The key set of BasemapConfig.sublayer_overrides is treated as opaque (forward-compatible with future sublayer IDs).

Security: extra=“forbid” locks the scope guardrail: unknown style axes such as dash patterns, line caps, halo blur, and text-font are rejected at validation time.

object
stroke_color
Any of:
string
stroke_width
Any of:
number
<= 20
casing_color
Any of:
string
casing_width
Any of:
number
<= 20
min_zoom
Any of:
number
<= 24
max_zoom
Any of:
number
<= 24
opacity
Any of:
number
<= 1
basemap_position
Any of:
BasemapPosition

Whether the basemap renders below (‘bottom’, default) or above (‘top’) data layers.

string
Allowed values: bottom top
projection
Any of:
BasemapProjection

Map projection. ‘mercator’ (default) or experimental ‘globe’.

string
Allowed values: mercator globe
terrain_config
Any of:
TerrainConfig
object
enabled
Enabled
boolean
source_dataset_id
Any of:
string format: uuid
exaggeration
Exaggeration
number
default: 1 <= 3
visibility
required
MapVisibility
string
Allowed values: private internal public
thumbnail_url
Any of:
string
og_image_url
Any of:
string
forked_from_id
Any of:
string format: uuid
forked_from_name
Any of:
string
created_by
required
Any of:
string format: uuid
created_by_username
Any of:
string
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
layers
required
Layers
Array<object>
MapLayerResponse
object
id
required
Id
string format: uuid
dataset_id
required
Dataset Id
string format: uuid
dataset_name
required
Dataset Name
string
dataset_geometry_type
required
Any of:
string
dataset_table_name
required
Dataset Table Name
string
dataset_extent_bbox
required
Any of:
Array<number>
dataset_column_info
Any of:
Array<object>
object
key
additional properties
any
dataset_feature_count
Any of:
integer
dataset_sample_values
Any of:
object
key
additional properties
any
display_name
Any of:
string
sort_order
required
Sort Order
integer
visible
required
Visible
boolean
opacity
required
Opacity
number
paint
required
Paint
object
key
additional properties
any
layout
required
Layout
object
key
additional properties
any
layer_type
Layer Type
string
default: vector_geolens
dataset_record_type
Any of:
string
filter
Any of:
Array
label_config
Any of:
object
key
additional properties
any
popup_config
Any of:
PopupConfig

Per-layer popup configuration: enable/disable + custom title template

  • ordered visible-fields allowlist. Persisted as JSONB on map_layers.
object
enabled
required
Enabled
boolean
expression
Any of:
string
<= 500 characters
visible_fields
Any of:
Array<string>
<= 100 items
style_config
Any of:
object
key
additional properties
any
show_in_legend
Show In Legend
boolean
default: true
is_3d
Any of:
boolean
is_dem
Any of:
boolean
dem_vertical_units
Any of:
string
band_count
Any of:
integer
tile_version
Any of:
integer
publication_version
Any of:
integer
dataset_visibility
Any of:
string
dataset_status
Any of:
string
dataset_attribution
Any of:
string
layer_count
required
Layer Count
integer
plugins
Any of:
Array<string>
legend_title
Any of:
string
Example 
{
  "basemap_config": {
    "label_mode": "full",
    "road_visibility": "full",
    "boundary_visibility": "full",
    "building_visibility": true,
    "land_water_tone": "default",
    "relief_contrast": "soft",
    "opacity": 1,
    "basemap_position": "bottom",
    "projection": "mercator"
  },
  "terrain_config": {
    "enabled": false,
    "exaggeration": 1
  },
  "visibility": "private",
  "layers": [
    {
      "layer_type": "vector_geolens",
      "show_in_legend": true
    }
  ]
}

400

Section titled “ 400 ”

Bad request — invalid payload

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

401

Section titled “ 401 ”

Unauthorized — missing or invalid credentials

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

403

Section titled “ 403 ”

Forbidden — caller lacks write access

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

404

Section titled “ 404 ”

Not found

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

409

Section titled “ 409 ”

Conflict — resource state prevents the operation

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

422

Section titled “ 422 ”

Validation error

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

429

Section titled “ 429 ”

Too many requests — retry after the advertised interval

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

Headers

Section titled “ Headers ”
Retry-After
integer

Seconds until the request may be retried

500

Section titled “ 500 ”

Internal server error

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

503

Section titled “ 503 ”

Service unavailable — the database could not serve the request

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}
Privacy Apache 2.0 getgeolens.com