Skip to content
getgeolens.com
GeoLens Docs

Create Embed Token Endpoint

POST
/maps/{map_id}/embed-tokens/
 
curl --request POST \
  --url https://example.com/maps/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/embed-tokens/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "allowed_origins": [ "https://dashboard.example.com" ], "expires_in_days": 30, "name": "Public dashboard embed" }'

Create an embed token scoped to a map’s current layers.

Community supports the default 30-day unrestricted token. Custom lifetimes and non-empty origin restrictions require the enterprise edition.

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
EmbedTokenCreate
object
allowed_origins
Any of:
Array<string>
<= 50 items
expires_in_days
Expires In Days

Token lifetime in days (1-365). The default 30-day lifetime is available in Community; custom lifetimes require the enterprise edition.

integer
default: 30 >= 1 <= 365
Example 
90
name
Any of:
string
>= 1 characters <= 255 characters

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Successful Response

Media type application/json
EmbedTokenCreatedResponse
object
allowed_origins
Any of:
Array<string>
created_at
required
Created At
string format: date-time
expires_at
required
Expires At
string format: date-time
id
required
Id
string format: uuid
is_active
required
Is Active
boolean
last_used_at
Any of:
string format: date-time
map_id
required
Map Id
string format: uuid
name
Any of:
string
raw_token
required
Raw Token
string
scoped_dataset_ids
required
Scoped Dataset Ids
Array<string>
token_hint
required
Token Hint
string
use_count
Use Count
integer
0
Example 
{
  "use_count": 0
}

400

Section titled “400 ”

Bad request — invalid payload

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "type": "about:blank"
}

401

Section titled “401 ”

Unauthorized — missing or invalid credentials

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "type": "about:blank"
}

403

Section titled “403 ”

Forbidden — caller lacks write access

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "type": "about:blank"
}

404

Section titled “404 ”

Not found

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "type": "about:blank"
}

409

Section titled “409 ”

Conflict — resource state prevents the operation

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "type": "about:blank"
}

422

Section titled “422 ”

Validation error

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "type": "about:blank"
}

500

Section titled “500 ”

Internal server error

ProblemDetail
object
detail
required
Detail
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
Example 
{
  "type": "about:blank"
}