Upload API
MapTiler Cloud has an Upload API that allows you to add new datasets or update existing ones from the command line.
To simplify the uploading process, we recommend you use the CLI to run the commands. Follow the guide for installing and using the CLI.
Ingest dataset container into a new dataset
POST https://service.maptiler.com/v1/datasets/ingest
Request
You must include an Service Token with every API request
Body
| Content-Type | Data | application/json |
|---|
Responses
| Code | Content | Description |
|---|---|---|
| 200 | application/json | DatasetIngest |
Ingest dataset container into existing tileset
POST https://service.maptiler.com/v1/datasets/{document_id}/ingest
Request
You must include an Service Token with every API request
Path Parameters
| Parameters | Type | Description |
|---|---|---|
| document_id | string <uuid> |
|
Body
| Content-Type | Data | application/json |
|---|
Responses
| Code | Content | Description |
|---|---|---|
| 200 | application/json | DatasetIngest |
Get dataset ingest details
GET https://service.maptiler.com/v1/datasets/ingest/{ingest_id}
Request
You must include an Service Token with every API request
Path Parameters
| Parameters | Type | Description |
|---|---|---|
| ingest_id | string <uuid> |
|
Responses
| Code | Content | Description |
|---|---|---|
| 200 | application/json | DatasetIngest |
Cancel dataset ingest
POST https://service.maptiler.com/v1/datasets/ingest/{ingest_id}/cancel
Request
You must include an Service Token with every API request
Path Parameters
| Parameters | Type | Description |
|---|---|---|
| ingest_id | string <uuid> |
|
Responses
| Code | Content | Description |
|---|---|---|
| 200 | application/json | DatasetIngest |
Start dataset ingest processing
POST https://service.maptiler.com/v1/datasets/ingest/{ingest_id}/process
Request
You must include an Service Token with every API request
Path Parameters
| Parameters | Type | Description |
|---|---|---|
| ingest_id | string <uuid> |
|
Responses
| Code | Content | Description |
|---|---|---|
| 200 | application/json | DatasetIngest |
DatasetIngestCreate
| Property | Type | Description |
|---|---|---|
| filename | string | |
| size | integer | size in bytes
|
| output | DatasetIngestOutput |
DatasetIngestOutput
Specify output properties
| Property | Type | Description |
|---|---|---|
| type | string | Force output type (if not set, then output type is tileset determined based on input file)
Allowed values:
raster_tileset
raster_terrain
vector_features
vector_terrain
vector_tileset |
DatasetIngest
| Property | Type | Description |
|---|---|---|
| id | string <uuid> | |
| document_id | string <uuid> | |
| state | string | Allowed values:
upload
processing
completed
canceled
failed |
| filename | string | |
| size | number | size in bytes
|
| errors | array[Error ] | |
| progress | number | |
| upload_url | string <URL> | URL for the uploaded resource
|
Error
| Property | Type | Description |
|---|---|---|
| message | string |
Using the OpenAPI Specification?
Get the openapi.yaml