---
title: "Tile Ingest API"
description: "Tile Ingest API for MapTiler Server Admin API."
---

> For AI agents: a documentation index is available at [/llms.txt](https://docs.maptiler.com/llms.txt). Markdown versions of all pages are available by appending .md to any URL.

# Tile Ingest API

## Tile Ingest API reference

  Scalar API Reference

-   [
    
    Introduction
    
    ](#description/introduction)
-   [
    
    Tile Ingest
    
    ](#tag/tile-ingest)
    
    Close Group - Tile Ingest
    
    -   [
        
        Create new tileset ingest
        
        HTTP Method:  POST](#tag/tile-ingest/POST/tiles/ingest)
    -   [
        
        Detail of the given tileset ingest
        
        HTTP Method:  GET](#tag/tile-ingest/GET/tiles/ingest/{id})
    -   [
        
        Upload data to tileset ingest
        
        HTTP Method:  PUT](#tag/tile-ingest/PUT/tiles/ingest/{id}/upload)
    -   [
        
        Process tileset ingest
        
        HTTP Method:  POST](#tag/tile-ingest/POST/tiles/ingest/{id}/process)

[Powered by Scalar](https://www.scalar.com)

v4.9.0

OpenAPI 3.1.0

# MapTiler Server Admin API

[Support](mailto:support@maptiler.com)

[](https://docs.maptiler.com)

[MapTiler Server License Agreement](https://www.maptiler.com/server/license/)

[Terms of Service](https://www.maptiler.com/server/license/)

Server

Server:http://{host}/api/v1/admin

host

MapTiler Server Admin API

Client Libraries

Shell

Ruby

Node.js

PHP

Python

MoreSelect from all clients

Shell Curl

## Tile Ingest

​Copy link

Ingest new tilesets from uploaded files.

Tile Ingest Operations

-   post/tiles/ingest
-   get/tiles/ingest/{id}
-   put/tiles/ingest/{id}/upload
-   post/tiles/ingest/{id}/process

### Create new tileset ingest

​Copy link

Auth Required

Creates a new tileset ingest.

Body·TileIngestCreate

application/json

JSON containing file name and file size for new tile ingest

-   filenameCopy link to filename
    
    Type: string
    
    Example
    
    maptiler-osm.mbtiles
    
    Tileset file name
    
-   sizeCopy link to size
    
    Type: integer
    
    Example
    
    6930432
    
    Size of the uploading file
    

Responses

-   200
    
    OK
    
    application/json
    
-   400
    
    Invalid request
    
    application/json
    
-   404
    
    Requested item not found
    
    application/json
    

Request Example for post/tiles/ingest

Shell Curl

```curl
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
}'
```

cURLCopy

cURLCopy

Status: 200Status: 400Status: 404

Show Schema 

```json
{
  "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"
}
```

JSONCopy

JSONCopy

OK

### Detail of the given tileset ingest

​Copy link

Auth Required

Gets information about the given tileset ingest.

Path Parameters

-   idCopy link to id
    
    Type: string
    
    required
    
    Example
    
    b4362feb-6573-451e-b707-cada462c37f7
    
    Identifier of the ingesting tileset
    

Responses

-   200
    
    OK
    
    application/json
    
-   400
    
    Invalid request
    
    application/json
    
-   404
    
    Requested item not found
    
    application/json
    

Request Example for get/tiles/ingest/_{id}_

Shell Curl

```curl
curl http://localhost:3650/api/v1/admin/tiles/ingest/b4362feb-6573-451e-b707-cada462c37f7 \
  --header 'Authorization: Basic username:password'
```

cURLCopy

cURLCopy

Status: 200Status: 400Status: 404

Show Schema 

```json
{
  "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"
}
```

JSONCopy

JSONCopy

OK

### Upload data to tileset ingest

​Copy link

Uploads sent data to the given tileset ingest.

Path Parameters

-   idCopy link to id
    
    Type: string
    
    required
    
    Example
    
    b4362feb-6573-451e-b707-cada462c37f7
    
    Identifier of the ingesting tileset
    

Body

application/json

A binary file

Responses

-   200
    
    OK, file is completely uploaded
    
-   308
    
    Part of the file data is uploaded
    
-   400
    
    Invalid request
    
    application/json
    
-   404
    
    Requested item not found
    
    application/json
    

Request Example for put/tiles/ingest/_{id}_/upload

Shell Curl

```curl
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'
```

cURLCopy

cURLCopy

Status: 200Status: 308Status: 400Status: 404

No Body

OK, file is completely uploaded

### Process tileset ingest

​Copy link

Auth Required

Processes the data of given tileset ingest and creates a tileset with given document\_id

Path Parameters

-   idCopy link to id
    
    Type: string
    
    required
    
    Example
    
    b4362feb-6573-451e-b707-cada462c37f7
    
    Identifier of the ingesting tileset
    

Responses

-   200
    
    OK
    
    application/json
    
-   400
    
    Invalid request
    
    application/json
    
-   404
    
    Requested item not found
    
    application/json
    

Request Example for post/tiles/ingest/_{id}_/process

Shell Curl

```curl
curl http://localhost:3650/api/v1/admin/tiles/ingest/b4362feb-6573-451e-b707-cada462c37f7/process \
  --request POST \
  --header 'Authorization: Basic username:password'
```

cURLCopy

cURLCopy

Status: 200Status: 400Status: 404

Show Schema 

```json
{
  "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"
}
```

JSONCopy

JSONCopy

OK

![](https://docs.maptiler.com/assets/img/open-api.png)

Using the OpenAPI Specification?

Get the [openapi.yaml](https://docs.maptiler.com/_data/server/admin-api/openapi.yml)
