Tile Ingest API

Tile Ingest API reference

Scalar API Reference
v4.8.0
OpenAPI 3.1.0

MapTiler Server Admin API

Support
MapTiler Server License Agreement
Terms of Service
Server:http://{host}/api/v1/admin

MapTiler Server Admin API

Client Libraries
Shell Curl

Tile Ingest

​

Ingest new tilesets from uploaded files.

Tile Ingest Operations

Create new tileset ingest

​

Creates a new tileset ingest.

Body·TileIngestCreate
application/json

JSON containing file name and file size for new tile ingest

  • filename
    Type: string

    Tileset file name

  • size
    Type: integer

    Size of the uploading file

Responses
  • application/json
  • application/json
  • application/json
Request Example for post/tiles/ingest
curl http://localhost:3650/api/v1/admin/tiles/ingest \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Basic username:password' \
  --data '{
  "filename": "maptiler-osm.mbtiles",
  "size": 6930432
}'

{
  "id": "b4362feb-6573-451e-b707-cada462c37f7",
  "document_id": "86e2836d-d30e-4767-85f0-12a33bed2393",
  "filename": "maptiler-osm.mbtiles",
  "size": 6930432,
  "state": "upload",
  "upload_url": "http://localhost:3650/api/v1/admin/tiles/ingest/b4362feb-6573-451e-b707-cada462c37f7/upload",
  "errors": [
    {
      "message": "Error message"
    }
  ],
  "date_created": "Thu, 01 Jan 2026 00:00:00 GMT",
  "type": "tile"
}

OK

Detail of the given tileset ingest

​

Gets information about the given tileset ingest.

Path Parameters
  • id
    Type: string
    required

    Identifier of the ingesting tileset

Responses
  • application/json
  • application/json
  • application/json
Request Example for get/tiles/ingest/{id}
curl http://localhost:3650/api/v1/admin/tiles/ingest/b4362feb-6573-451e-b707-cada462c37f7 \
  --header 'Authorization: Basic username:password'

{
  "id": "b4362feb-6573-451e-b707-cada462c37f7",
  "document_id": "86e2836d-d30e-4767-85f0-12a33bed2393",
  "filename": "maptiler-osm.mbtiles",
  "size": 6930432,
  "state": "upload",
  "upload_url": "http://localhost:3650/api/v1/admin/tiles/ingest/b4362feb-6573-451e-b707-cada462c37f7/upload",
  "errors": [
    {
      "message": "Error message"
    }
  ],
  "date_created": "Thu, 01 Jan 2026 00:00:00 GMT",
  "type": "tile"
}

OK

Upload data to tileset ingest

​

Uploads sent data to the given tileset ingest.

Path Parameters
  • id
    Type: string
    required

    Identifier of the ingesting tileset

Body
application/json

A binary file

Responses
  • 200

    OK, file is completely uploaded

  • application/json
  • application/json
Request Example for put/tiles/ingest/{id}/upload
curl http://localhost:3650/api/v1/admin/tiles/ingest/b4362feb-6573-451e-b707-cada462c37f7/upload \
  --request PUT \
  --header 'Content-Type: application/octet-stream' \
  --data-binary '@filename'
No Body

OK, file is completely uploaded

Process tileset ingest

​

Processes the data of given tileset ingest and creates a tileset with given document_id

Path Parameters
  • id
    Type: string
    required

    Identifier of the ingesting tileset

Responses
  • application/json
  • application/json
  • application/json
Request Example for post/tiles/ingest/{id}/process
curl http://localhost:3650/api/v1/admin/tiles/ingest/b4362feb-6573-451e-b707-cada462c37f7/process \
  --request POST \
  --header 'Authorization: Basic username:password'

{
  "id": "b4362feb-6573-451e-b707-cada462c37f7",
  "document_id": "86e2836d-d30e-4767-85f0-12a33bed2393",
  "filename": "maptiler-osm.mbtiles",
  "size": 6930432,
  "state": "upload",
  "upload_url": "http://localhost:3650/api/v1/admin/tiles/ingest/b4362feb-6573-451e-b707-cada462c37f7/upload",
  "errors": [
    {
      "message": "Error message"
    }
  ],
  "date_created": "Thu, 01 Jan 2026 00:00:00 GMT",
  "type": "tile"
}

OK

Using the OpenAPI Specification?
Get the openapi.yaml
Was this helpful?