API keys API

API keys API reference

Scalar API Reference
v1.0
OpenAPI 3.0.2

MapTiler Service API

Support
Terms of Service
Server:https://service.maptiler.com/v1

MapTiler Service API

Client Libraries
Shell Curl

API keys

​
API keys Operations

List API keys belonging to account

​
Query Parameters
  • cursor
    Type: string • base64

    Page cursor

  • limit
    Type: integer
    min:  
    10
    max:  
    100

    Page limit

Responses
  • application/json
Request Example for get/api_keys
curl https://service.maptiler.com/v1/api_keys

{
  "cursor": null,
  "total_count": 1,
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "token": "string",
      "name": "string",
      "description": null,
      "user_agent": null,
      "origins": [
        "string"
      ],
      "created": "2026-08-31T17:00:00.000Z",
      "changed": "2026-08-31T17:00:00.000Z"
    }
  ]
}

Create new key

​
Body·APIKeySettings
application/json
  • description
    Type: string | null
  • name
    Type: string | null

    Will be generated automatically unless provided explicitly.

  • origins
    Type: array string[]

    Specifies which HTTP origins are allowed to access the API.

    For example [mydomain.com] will ensure, that only requests coming from mydomain.com will be processed. Use *.mydomain.com to allow all subdomains.

    Ensure your application sends the Origin or Referer header; otherwise, requests are treated as unknown and will be rejected if any origin is specified.

    Use ? placeholder to explicitly allow unknown origins.

  • user_agent
    Type: string | null

    Processes only requests where the User-Agent HTTP header contains this exact, case-sensitive substring.

    Wildcards are not supported; only a single string is allowed.

    Useful for increasing security of your key used in custom mobile or desktop applications.

    Leave empty to allow requests from any user-agent.

Responses
  • application/json
Request Example for post/api_keys
curl https://service.maptiler.com/v1/api_keys \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "name": null,
  "description": null,
  "user_agent": null,
  "origins": [
    ""
  ]
}'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "token": "string",
  "name": "string",
  "description": null,
  "user_agent": null,
  "origins": [
    "string"
  ],
  "created": "2026-08-31T17:00:00.000Z",
  "changed": "2026-08-31T17:00:00.000Z"
}

Get key

​
Path Parameters
  • key_id
Responses
  • application/json
Request Example for get/api_keys/{key_id}
curl 'https://service.maptiler.com/v1/api_keys/{key_id}'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "token": "string",
  "name": "string",
  "description": null,
  "user_agent": null,
  "origins": [
    "string"
  ],
  "created": "2026-08-31T17:00:00.000Z",
  "changed": "2026-08-31T17:00:00.000Z"
}

Delete given key

​
Path Parameters
  • key_id
Responses
  • 200

    Successfully deleted

Request Example for delete/api_keys/{key_id}
curl 'https://service.maptiler.com/v1/api_keys/{key_id}' \
  --request DELETE
No Body

Successfully deleted

Update given key

​
Path Parameters
  • key_id
Body·APIKeySettings
application/json
  • description
    Type: string | null
  • name
    Type: string | null

    Will be generated automatically unless provided explicitly.

  • origins
    Type: array string[]

    Specifies which HTTP origins are allowed to access the API.

    For example [mydomain.com] will ensure, that only requests coming from mydomain.com will be processed. Use *.mydomain.com to allow all subdomains.

    Ensure your application sends the Origin or Referer header; otherwise, requests are treated as unknown and will be rejected if any origin is specified.

    Use ? placeholder to explicitly allow unknown origins.

  • user_agent
    Type: string | null

    Processes only requests where the User-Agent HTTP header contains this exact, case-sensitive substring.

    Wildcards are not supported; only a single string is allowed.

    Useful for increasing security of your key used in custom mobile or desktop applications.

    Leave empty to allow requests from any user-agent.

Responses
  • application/json
Request Example for post/api_keys/{key_id}/change_settings
curl 'https://service.maptiler.com/v1/api_keys/{key_id}/change_settings' \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "name": null,
  "description": null,
  "user_agent": null,
  "origins": [
    ""
  ]
}'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "token": "string",
  "name": "string",
  "description": null,
  "user_agent": null,
  "origins": [
    "string"
  ],
  "created": "2026-08-31T17:00:00.000Z",
  "changed": "2026-08-31T17:00:00.000Z"
}
Using the OpenAPI Specification?
Get the openapi.yaml
Was this helpful?
MapTiler Service API
API keys API
API keys API