---
title: "MapTiler Server Admin Reference"
description: "Reference documentation for the 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.

  Scalar API Reference

-   Introduction
    
-   Maps
    
    Close Group
    
    -   List maps
        
        HTTP Method:  GET
    -   Detail of the map
        
        HTTP Method:  GET
    -   Change metadata of the map
        
        HTTP Method:  POST
    -   Delete the map
        
        HTTP Method:  DEL
    -   Publish the map
        
        HTTP Method:  POST
    -   Unpublish the map
        
        HTTP Method:  POST
-   Tiles
    
    Close Group
    
    -   List the tiles
        
        HTTP Method:  GET
    -   Rescan the tiles
        
        HTTP Method:  POST
    -   Reload the tiles
        
        HTTP Method:  POST
    -   Add remote tile
        
        HTTP Method:  POST
    -   Detail of the tileset
        
        HTTP Method:  GET
    -   Change metadata of the given tileset
        
        HTTP Method:  POST
    -   Delete the tileset
        
        HTTP Method:  DEL
    -   Publish the tileset
        
        HTTP Method:  POST
    -   Unpublish the tileset
        
        HTTP Method:  POST
-   Tile Ingest
    
    Close Group
    
    -   Create new tileset ingest
        
        HTTP Method:  POST
    -   Detail of the given tileset ingest
        
        HTTP Method:  GET
    -   Upload data to tileset ingest
        
        HTTP Method:  PUT
    -   Process tileset ingest
        
        HTTP Method:  POST

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

v4.8.0

OpenAPI 3.0.2

# MapTiler Server Admin API

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

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

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

Download OpenAPI Document

json

Download OpenAPI Document

yaml

Reference for MapTiler Server Admin API. 🔑 You are required to authorize every request using your Credentials token in the request header. The token can be acquired in the "Credentials" section of settings. Through the Admin API, you can run maps' and tiles' operations, such as get list, get detail, publish, remove, and more.

Server

Server:http://localhost:3650/api/v1/admin

MapTiler Server Admin API

Client Libraries

Shell

Ruby

Node.js

PHP

Python

MoreSelect from all clients

Shell Curl

## Maps

​Copy link

Maps Operations

-   get/maps
-   get/maps/{id}
-   post/maps/{id}
-   delete/maps/{id}
-   post/maps/{id}/publish
-   post/maps/{id}/unpublish

### List maps

​Copy link

Auth Required

Lists maps from maps directory. It can be paginated with offset and limit parameters, otherwise first 50 items are returned.

Query Parameters

-   offsetCopy link to offset
    
    Type: integer
    
    Default
    
    0
    
    Example
    
    10
    
    The starting position of returned list of items.
    
-   limitCopy link to limit
    
    Type: integer
    
    Default
    
    50
    
    Example
    
    50
    
    Maximum number of items which will be returned.
    

Responses

-   200
    
    OK
    
    application/json
    
-   400
    
    Invalid request
    
    application/json
    

Request Example for get/maps

Shell Curl

```curl
curl http://localhost:3650/api/v1/admin/maps \
  --header 'Authorization: Basic username:password'
```

cURLCopy

cURLCopy

Status: 200Status: 400

Show Schema 

```json
{
  "items": [
    {
      "id": "streets",
      "name": "streets",
      "title": "Streets",
      "published": true,
      "format": "jpeg"
    }
  ]
}
```

JSONCopy

JSONCopy

OK

### Detail of the map

​Copy link

Auth Required

Gets information about the given map.

Path Parameters

-   idCopy link to id
    
    Type: string
    
    required
    
    Example
    
    streets
    
    Identifier of the map.
    

Responses

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

Request Example for get/maps/_{id}_

Shell Curl

```curl
curl http://localhost:3650/api/v1/admin/maps/streets \
  --header 'Authorization: Basic username:password'
```

cURLCopy

cURLCopy

Status: 200Status: 400Status: 404

Show Schema 

```json
{
  "id": "streets",
  "name": "streets",
  "title": "Streets",
  "published": true,
  "format": "jpeg",
  "quality": 92,
  "urls": {
    "embeddable": "http://localhost:3650/api/maps/streets",
    "ogcTiles": "http://localhost:3650/api/maps/streets/tiles",
    "stylejson": "http://localhost:3650/api/maps/streets/style.json",
    "tilejson": "http://localhost:3650/api/maps/streets/tiles.json",
    "tilejson256": "http://localhost:3650/api/maps/streets/256/tiles.json",
    "wms": "http://localhost:3650/api/maps/streets/wms?service=WMS&request=GetCapabilities",
    "wmts": "http://localhost:3650/api/maps/streets/WMTSCapabilities.xml",
    "xyz": "http://localhost:3650/api/maps/streets/{z}/{x}/{y}.jpg",
    "xyz256": "http://localhost:3650/api/maps/streets/256/{z}/{x}/{y}.jpg"
  }
}
```

JSONCopy

JSONCopy

OK

### Change metadata of the map

​Copy link

Auth Required

Changes metadata (format, quality, published) of the given map.

Path Parameters

-   idCopy link to id
    
    Type: string
    
    required
    
    Example
    
    streets
    
    Identifier of the map.
    

Body·MapChange

application/json

A JSON object containing metadata information

-   formatCopy link to format
    
    Type: string enum
    
    Example
    
    jpeg
    
    New format
    
    values
    
    -   jpeg
        
    -   png
        
    -   webp
        
    
-   publishedCopy link to published
    
    Type: boolean
    
    Example
    
    true
    
    New state of the map serving
    
-   qualityCopy link to quality
    
    Type: integer
    
    min:  
    
    0
    
    max:  
    
    100
    
    Example
    
    92
    
    New quality in percent
    

Responses

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

Request Example for post/maps/_{id}_

Shell Curl

```curl
curl http://localhost:3650/api/v1/admin/maps/streets \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Basic username:password' \
  --data '{
  "format": "jpeg",
  "quality": 92,
  "published": true
}'
```

cURLCopy

cURLCopy

Status: 200Status: 400Status: 404

Show Schema 

```json
{
  "id": "streets",
  "name": "streets",
  "title": "Streets",
  "published": true,
  "format": "jpeg",
  "quality": 92,
  "urls": {
    "embeddable": "http://localhost:3650/api/maps/streets",
    "ogcTiles": "http://localhost:3650/api/maps/streets/tiles",
    "stylejson": "http://localhost:3650/api/maps/streets/style.json",
    "tilejson": "http://localhost:3650/api/maps/streets/tiles.json",
    "tilejson256": "http://localhost:3650/api/maps/streets/256/tiles.json",
    "wms": "http://localhost:3650/api/maps/streets/wms?service=WMS&request=GetCapabilities",
    "wmts": "http://localhost:3650/api/maps/streets/WMTSCapabilities.xml",
    "xyz": "http://localhost:3650/api/maps/streets/{z}/{x}/{y}.jpg",
    "xyz256": "http://localhost:3650/api/maps/streets/256/{z}/{x}/{y}.jpg"
  }
}
```

JSONCopy

JSONCopy

OK

### Delete the map

​Copy link

Auth Required

Deletes the given map. Before deleting, it is automatically unpublished and cannot be served anymore.

Path Parameters

-   idCopy link to id
    
    Type: string
    
    required
    
    Example
    
    streets
    
    Identifier of the map.
    

Responses

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

Request Example for delete/maps/_{id}_

Shell Curl

```curl
curl http://localhost:3650/api/v1/admin/maps/streets \
  --request DELETE \
  --header 'Authorization: Basic username:password'
```

cURLCopy

cURLCopy

Status: 200Status: 400Status: 404

Show Schema 

```json
{
  "removed": [
    "streets"
  ]
}
```

JSONCopy

JSONCopy

OK

### Publish the map

​Copy link

Auth Required

Publishes the given map. Does nothing, if the map is already published.

Path Parameters

-   idCopy link to id
    
    Type: string
    
    required
    
    Example
    
    streets
    
    Identifier of the map.
    

Responses

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

Request Example for post/maps/_{id}_/publish

Shell Curl

```curl
curl http://localhost:3650/api/v1/admin/maps/streets/publish \
  --request POST \
  --header 'Authorization: Basic username:password'
```

cURLCopy

cURLCopy

Status: 200Status: 400Status: 404

Show Schema 

```json
{
  "id": "streets",
  "name": "streets",
  "title": "Streets",
  "published": true,
  "format": "jpeg",
  "quality": 92,
  "urls": {
    "embeddable": "http://localhost:3650/api/maps/streets",
    "ogcTiles": "http://localhost:3650/api/maps/streets/tiles",
    "stylejson": "http://localhost:3650/api/maps/streets/style.json",
    "tilejson": "http://localhost:3650/api/maps/streets/tiles.json",
    "tilejson256": "http://localhost:3650/api/maps/streets/256/tiles.json",
    "wms": "http://localhost:3650/api/maps/streets/wms?service=WMS&request=GetCapabilities",
    "wmts": "http://localhost:3650/api/maps/streets/WMTSCapabilities.xml",
    "xyz": "http://localhost:3650/api/maps/streets/{z}/{x}/{y}.jpg",
    "xyz256": "http://localhost:3650/api/maps/streets/256/{z}/{x}/{y}.jpg"
  }
}
```

JSONCopy

JSONCopy

OK

### Unpublish the map

​Copy link

Auth Required

Unpublishes the given map. Does nothing, if the map is already unpublished.

Path Parameters

-   idCopy link to id
    
    Type: string
    
    required
    
    Example
    
    streets
    
    Identifier of the map.
    

Responses

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

Request Example for post/maps/_{id}_/unpublish

Shell Curl

```curl
curl http://localhost:3650/api/v1/admin/maps/streets/unpublish \
  --request POST \
  --header 'Authorization: Basic username:password'
```

cURLCopy

cURLCopy

Status: 200Status: 400Status: 404

Show Schema 

```json
{
  "id": "streets",
  "name": "streets",
  "title": "Streets",
  "published": true,
  "format": "jpeg",
  "quality": 92,
  "urls": {
    "embeddable": "http://localhost:3650/api/maps/streets",
    "ogcTiles": "http://localhost:3650/api/maps/streets/tiles",
    "stylejson": "http://localhost:3650/api/maps/streets/style.json",
    "tilejson": "http://localhost:3650/api/maps/streets/tiles.json",
    "tilejson256": "http://localhost:3650/api/maps/streets/256/tiles.json",
    "wms": "http://localhost:3650/api/maps/streets/wms?service=WMS&request=GetCapabilities",
    "wmts": "http://localhost:3650/api/maps/streets/WMTSCapabilities.xml",
    "xyz": "http://localhost:3650/api/maps/streets/{z}/{x}/{y}.jpg",
    "xyz256": "http://localhost:3650/api/maps/streets/256/{z}/{x}/{y}.jpg"
  }
}
```

JSONCopy

JSONCopy

OK

## Tiles

​Copy link

Tiles Operations

-   get/tiles
-   post/tiles/rescan
-   post/tiles/reload
-   post/tiles/add
-   get/tiles/{id}
-   post/tiles/{id}
-   delete/tiles/{id}
-   post/tiles/{id}/publish
-   post/tiles/{id}/unpublish

### List the tiles

​Copy link

Auth Required

Lists the tilesets from the tiles directory. Can be paginated with offset and limit parameters, otherwise first 50 items are returned.

Query Parameters

-   offsetCopy link to offset
    
    Type: integer
    
    Default
    
    0
    
    Example
    
    10
    
    The starting position of returned list of items.
    
-   limitCopy link to limit
    
    Type: integer
    
    Default
    
    50
    
    Example
    
    50
    
    Maximum number of items which will be returned.
    

Responses

-   200
    
    OK
    
    application/json
    

Request Example for get/tiles

Shell Curl

```curl
curl http://localhost:3650/api/v1/admin/tiles \
  --header 'Authorization: Basic username:password'
```

cURLCopy

cURLCopy

Status: 200

Show Schema 

```json
{
  "items": [
    {
      "id": "b142543e-ffa2-4994-acbc-825012e75a97",
      "name": "maptiler-osm",
      "title": "Maptiler OSM Data",
      "fileName": "maptiler-osm.mbtiles",
      "published": true,
      "type": "mbtiles",
      "tileType": "vector"
    }
  ]
}
```

JSONCopy

JSONCopy

OK

### Rescan the tiles

​Copy link

Auth Required

Rescans tiles directory. Does NOT remove dead files.

Responses

-   200
    
    OK
    
    application/json
    

Request Example for post/tiles/rescan

Shell Curl

```curl
curl http://localhost:3650/api/v1/admin/tiles/rescan \
  --request POST \
  --header 'Authorization: Basic username:password'
```

cURLCopy

cURLCopy

Status: 200

Show Schema 

```json
{
  "items": [
    {
      "id": "b142543e-ffa2-4994-acbc-825012e75a97",
      "name": "maptiler-osm",
      "title": "Maptiler OSM Data",
      "fileName": "maptiler-osm.mbtiles",
      "published": true,
      "type": "mbtiles",
      "tileType": "vector"
    }
  ]
}
```

JSONCopy

JSONCopy

OK

### Reload the tiles

​Copy link

Auth Required

Rescans the tiles directory and automatically removes dead files. Optionally may remove remote tile records.

Query Parameters

-   removeRemoteCopy link to removeRemote
    
    Type: boolean
    
    Default
    
    false
    
    Example
    
    true
    
    Removes remote tile records. Does not remove files from the remote server.
    

Responses

-   200
    
    OK
    
    application/json
    

Request Example for post/tiles/reload

Shell Curl

```curl
curl http://localhost:3650/api/v1/admin/tiles/reload \
  --request POST \
  --header 'Authorization: Basic username:password'
```

cURLCopy

cURLCopy

Status: 200

Show Schema 

```json
{
  "removed": [
    "maptiler-osm"
  ]
}
```

JSONCopy

JSONCopy

OK

### Add remote tile

​Copy link

Auth Required

Adds MTPKG remote tile record.

Body·TileAdd

application/json

A JSON object containing storage and url for remote tile

-   storageCopy link to storage
    
    Type: string enum
    
    Example
    
    http
    
    Storage type of remote server
    
    values
    
    -   http
        
    -   s3
        
    
-   urlCopy link to url
    
    Type: string
    
    Example
    
    https://data.maptiler.com/downloads/tileset/europe/switzerland/zurich.mtpkg
    
    URL of remote file
    

Responses

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

Request Example for post/tiles/add

Shell Curl

```curl
curl http://localhost:3650/api/v1/admin/tiles/add \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Basic username:password' \
  --data '{
  "storage": "http",
  "url": "https://data.maptiler.com/downloads/tileset/europe/switzerland/zurich.mtpkg"
}'
```

cURLCopy

cURLCopy

Status: 200Status: 400Status: 404

Show Schema 

```json
{
  "id": "b142543e-ffa2-4994-acbc-825012e75a97",
  "name": "maptiler-osm",
  "title": "Maptiler OSM Data",
  "fileName": "maptiler-osm.mbtiles",
  "published": true,
  "type": "mbtiles",
  "tileType": "vector"
}
```

JSONCopy

JSONCopy

OK

### Detail of the tileset

​Copy link

Auth Required

Gets information about the given tileset.

Path Parameters

-   idCopy link to id
    
    Type: string
    
    required
    
    Example
    
    b142543e-ffa2-4994-acbc-825012e75a97
    
    Identifier of the tileset
    

Responses

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

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

Shell Curl

```curl
curl http://localhost:3650/api/v1/admin/tiles/b142543e-ffa2-4994-acbc-825012e75a97 \
  --header 'Authorization: Basic username:password'
```

cURLCopy

cURLCopy

Status: 200Status: 400Status: 404

Show Schema 

```json
{
  "id": "b142543e-ffa2-4994-acbc-825012e75a97",
  "name": "maptiler-osm",
  "title": "Maptiler OSM Data",
  "fileName": "maptiler-osm.mbtiles",
  "published": true,
  "type": "mbtiles",
  "tileType": "vector",
  "urls": {
    "embeddable": "http://localhost:3650/api/tiles/maptiler-osm",
    "ogcTiles": "http://localhost:3650/api/tiles/maptiler-osm/tiles",
    "tilejson": "http://localhost:3650/api/tiles/maptiler-osm/tiles.json",
    "wmts": "http://localhost:3650/api/tiles/maptiler-osm/WMTSCapabilities.xml",
    "xyz": "http://localhost:3650/api/tiles/maptiler-osm/{z}/{x}/{y}"
  }
}
```

JSONCopy

JSONCopy

OK

### Change metadata of the given tileset

​Copy link

Auth Required

Changes metadata (name, published) of the given tileset.

Path Parameters

-   idCopy link to id
    
    Type: string
    
    required
    
    Example
    
    b142543e-ffa2-4994-acbc-825012e75a97
    
    Identifier of the tileset
    

Body·TileChange

application/json

A JSON object containing metadata information

-   nameCopy link to name
    
    Type: string
    
    Example
    
    maptiler-osm
    
    New name
    
-   publishedCopy link to published
    
    Type: boolean
    
    Example
    
    true
    
    New state of the tile serving
    

Responses

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

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

Shell Curl

```curl
curl http://localhost:3650/api/v1/admin/tiles/b142543e-ffa2-4994-acbc-825012e75a97 \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Basic username:password' \
  --data '{
  "name": "maptiler-osm",
  "published": true
}'
```

cURLCopy

cURLCopy

Status: 200Status: 400Status: 404

Show Schema 

```json
{
  "id": "b142543e-ffa2-4994-acbc-825012e75a97",
  "name": "maptiler-osm",
  "title": "Maptiler OSM Data",
  "fileName": "maptiler-osm.mbtiles",
  "published": true,
  "type": "mbtiles",
  "tileType": "vector",
  "urls": {
    "embeddable": "http://localhost:3650/api/tiles/maptiler-osm",
    "ogcTiles": "http://localhost:3650/api/tiles/maptiler-osm/tiles",
    "tilejson": "http://localhost:3650/api/tiles/maptiler-osm/tiles.json",
    "wmts": "http://localhost:3650/api/tiles/maptiler-osm/WMTSCapabilities.xml",
    "xyz": "http://localhost:3650/api/tiles/maptiler-osm/{z}/{x}/{y}"
  }
}
```

JSONCopy

JSONCopy

OK

### Delete the tileset

​Copy link

Auth Required

Deletes the given tileset. Before deleting, it is automatically unpublished and cannot be served anymore.

Path Parameters

-   idCopy link to id
    
    Type: string
    
    required
    
    Example
    
    b142543e-ffa2-4994-acbc-825012e75a97
    
    Identifier of the tileset
    

Responses

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

Request Example for delete/tiles/_{id}_

Shell Curl

```curl
curl http://localhost:3650/api/v1/admin/tiles/b142543e-ffa2-4994-acbc-825012e75a97 \
  --request DELETE \
  --header 'Authorization: Basic username:password'
```

cURLCopy

cURLCopy

Status: 200Status: 400Status: 404

Show Schema 

```json
{
  "removed": [
    "maptiler-osm"
  ]
}
```

JSONCopy

JSONCopy

OK

### Publish the tileset

​Copy link

Auth Required

Publishes the given tileset. Does nothing, if the tileset is already published.

Path Parameters

-   idCopy link to id
    
    Type: string
    
    required
    
    Example
    
    b142543e-ffa2-4994-acbc-825012e75a97
    
    Identifier of the tileset
    

Responses

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

Request Example for post/tiles/_{id}_/publish

Shell Curl

```curl
curl http://localhost:3650/api/v1/admin/tiles/b142543e-ffa2-4994-acbc-825012e75a97/publish \
  --request POST \
  --header 'Authorization: Basic username:password'
```

cURLCopy

cURLCopy

Status: 200Status: 400Status: 404

Show Schema 

```json
{
  "id": "b142543e-ffa2-4994-acbc-825012e75a97",
  "name": "maptiler-osm",
  "title": "Maptiler OSM Data",
  "fileName": "maptiler-osm.mbtiles",
  "published": true,
  "type": "mbtiles",
  "tileType": "vector",
  "urls": {
    "embeddable": "http://localhost:3650/api/tiles/maptiler-osm",
    "ogcTiles": "http://localhost:3650/api/tiles/maptiler-osm/tiles",
    "tilejson": "http://localhost:3650/api/tiles/maptiler-osm/tiles.json",
    "wmts": "http://localhost:3650/api/tiles/maptiler-osm/WMTSCapabilities.xml",
    "xyz": "http://localhost:3650/api/tiles/maptiler-osm/{z}/{x}/{y}"
  }
}
```

JSONCopy

JSONCopy

OK

### Unpublish the tileset

​Copy link

Auth Required

Unpublishes the given tileset. Does nothing, if the tileset is already unpublished.

Path Parameters

-   idCopy link to id
    
    Type: string
    
    required
    
    Example
    
    b142543e-ffa2-4994-acbc-825012e75a97
    
    Identifier of the tileset
    

Responses

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

Request Example for post/tiles/_{id}_/unpublish

Shell Curl

```curl
curl http://localhost:3650/api/v1/admin/tiles/b142543e-ffa2-4994-acbc-825012e75a97/unpublish \
  --request POST \
  --header 'Authorization: Basic username:password'
```

cURLCopy

cURLCopy

Status: 200Status: 400Status: 404

Show Schema 

```json
{
  "id": "b142543e-ffa2-4994-acbc-825012e75a97",
  "name": "maptiler-osm",
  "title": "Maptiler OSM Data",
  "fileName": "maptiler-osm.mbtiles",
  "published": true,
  "type": "mbtiles",
  "tileType": "vector",
  "urls": {
    "embeddable": "http://localhost:3650/api/tiles/maptiler-osm",
    "ogcTiles": "http://localhost:3650/api/tiles/maptiler-osm/tiles",
    "tilejson": "http://localhost:3650/api/tiles/maptiler-osm/tiles.json",
    "wmts": "http://localhost:3650/api/tiles/maptiler-osm/WMTSCapabilities.xml",
    "xyz": "http://localhost:3650/api/tiles/maptiler-osm/{z}/{x}/{y}"
  }
}
```

JSONCopy

JSONCopy

OK

## Tile Ingest

​Copy link

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"
    }
  ]
}
```

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": "b142543e-ffa2-4994-acbc-825012e75a97",
  "name": "maptiler-osm",
  "title": "Maptiler OSM Data",
  "fileName": "maptiler-osm.mbtiles",
  "published": true,
  "type": "mbtiles",
  "tileType": "vector",
  "urls": {
    "embeddable": "http://localhost:3650/api/tiles/maptiler-osm",
    "ogcTiles": "http://localhost:3650/api/tiles/maptiler-osm/tiles",
    "tilejson": "http://localhost:3650/api/tiles/maptiler-osm/tiles.json",
    "wmts": "http://localhost:3650/api/tiles/maptiler-osm/WMTSCapabilities.xml",
    "xyz": "http://localhost:3650/api/tiles/maptiler-osm/{z}/{x}/{y}"
  }
}
```

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

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": "b142543e-ffa2-4994-acbc-825012e75a97",
  "name": "maptiler-osm",
  "title": "Maptiler OSM Data",
  "fileName": "maptiler-osm.mbtiles",
  "published": true,
  "type": "mbtiles",
  "tileType": "vector",
  "urls": {
    "embeddable": "http://localhost:3650/api/tiles/maptiler-osm",
    "ogcTiles": "http://localhost:3650/api/tiles/maptiler-osm/tiles",
    "tilejson": "http://localhost:3650/api/tiles/maptiler-osm/tiles.json",
    "wmts": "http://localhost:3650/api/tiles/maptiler-osm/WMTSCapabilities.xml",
    "xyz": "http://localhost:3650/api/tiles/maptiler-osm/{z}/{x}/{y}"
  }
}
```

JSONCopy

JSONCopy

OK
