API keys API

List API keys belonging to account

GET https://service.maptiler.com/v1/api_keys

Request

You must include an Service Token with every API request

Query Parameters

Parameters Type Description
cursor
string <byte>
Page cursor
limit
integer
Page limit
>= 10<= 100
Default: 50

Responses

Code Content Description
200 application/json APIKeyPage Object

Create new key

POST https://service.maptiler.com/v1/api_keys

Request

You must include an Service Token with every API request

Body

Content-Type Data
application/json

Responses

Code Content Description
200 application/json APIKey Object

Get key

GET https://service.maptiler.com/v1/api_keys/{key_id}

Request

You must include an Service Token with every API request

Path Parameters

Parameters Type Description
keyId
string <uuid>
Identifier of API Key.

Responses

Code Content Description
200 application/json APIKey Object

Delete given key

DELETE https://service.maptiler.com/v1/api_keys/{key_id}

Request

You must include an Service Token with every API request

Path Parameters

Parameters Type Description
keyId
string <uuid>
Identifier of API Key.

Responses

Code Content Description
200

Successfully deleted

Update given key

POST https://service.maptiler.com/v1/api_keys/{key_id}/change_settings

Request

You must include an Service Token with every API request

Path Parameters

Parameters Type Description
keyId
string <uuid>
Identifier of API Key.

Body

Content-Type Data
application/json

Responses

Code Content Description
200 application/json APIKey Object

APIKeyPage Object

Property Type Description
cursor
string <byte>  or null
total_count
integer
items
array [ APIKey Object]

APIKey Object

Property Type Description
id
string <uuid>
token
string
description
string or null
user_agent
string or null
origins
array [string]
created
string <date-time>
changed
string <date-time>

APIKeySettings Object

Property Type Description
description
string or null
user_agent
string or null
origins
array [string]
Using the OpenAPI Specification?
Get the openapi.yaml