--- title: "Maps API" description: "Maps 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. # Maps API ## Maps API reference Scalar API Reference - [ Introduction ](#description/introduction) - [ Maps ](#tag/maps) Close Group - Maps - [ List maps HTTP Method:  GET](#tag/maps/GET/maps) - [ Detail of the map HTTP Method:  GET](#tag/maps/GET/maps/{id}) - [ Change metadata of the map HTTP Method:  POST](#tag/maps/POST/maps/{id}) - [ Delete the map HTTP Method:  DEL](#tag/maps/DELETE/maps/{id}) - [ Publish the map HTTP Method:  POST](#tag/maps/POST/maps/{id}/publish) - [ Unpublish the map HTTP Method:  POST](#tag/maps/POST/maps/{id}/unpublish) [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 ## Maps ​Copy link Manage self-hosted vector and raster maps. 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", "staticAuto": "http://localhost:3650/api/maps/streets/static/auto/{width}x{height}.jpg", "staticBounds": "http://localhost:3650/api/maps/streets/static/{minx},{miny},{maxx},{maxy}/{width}x{height}.jpg", "staticCenter": "http://localhost:3650/api/maps/streets/static/{lon},{lat},{zoom}/{width}x{height}.jpg", "tmsRaster": "http://localhost:3650/api/maps/streets/raster/tms", "tmsVector": "http://localhost:3650/api/maps/streets/vector/tms", "wmsGlobal": "http://localhost:3650/api/maps/wms?service=WMS&request=GetCapabilities", "wmtsGlobal": "http://localhost:3650/api/WMTSCapabilities.xml" } } ``` 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", "staticAuto": "http://localhost:3650/api/maps/streets/static/auto/{width}x{height}.jpg", "staticBounds": "http://localhost:3650/api/maps/streets/static/{minx},{miny},{maxx},{maxy}/{width}x{height}.jpg", "staticCenter": "http://localhost:3650/api/maps/streets/static/{lon},{lat},{zoom}/{width}x{height}.jpg", "tmsRaster": "http://localhost:3650/api/maps/streets/raster/tms", "tmsVector": "http://localhost:3650/api/maps/streets/vector/tms", "wmsGlobal": "http://localhost:3650/api/maps/wms?service=WMS&request=GetCapabilities", "wmtsGlobal": "http://localhost:3650/api/WMTSCapabilities.xml" } } ``` 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", "staticAuto": "http://localhost:3650/api/maps/streets/static/auto/{width}x{height}.jpg", "staticBounds": "http://localhost:3650/api/maps/streets/static/{minx},{miny},{maxx},{maxy}/{width}x{height}.jpg", "staticCenter": "http://localhost:3650/api/maps/streets/static/{lon},{lat},{zoom}/{width}x{height}.jpg", "tmsRaster": "http://localhost:3650/api/maps/streets/raster/tms", "tmsVector": "http://localhost:3650/api/maps/streets/vector/tms", "wmsGlobal": "http://localhost:3650/api/maps/wms?service=WMS&request=GetCapabilities", "wmtsGlobal": "http://localhost:3650/api/WMTSCapabilities.xml" } } ``` 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", "staticAuto": "http://localhost:3650/api/maps/streets/static/auto/{width}x{height}.jpg", "staticBounds": "http://localhost:3650/api/maps/streets/static/{minx},{miny},{maxx},{maxy}/{width}x{height}.jpg", "staticCenter": "http://localhost:3650/api/maps/streets/static/{lon},{lat},{zoom}/{width}x{height}.jpg", "tmsRaster": "http://localhost:3650/api/maps/streets/raster/tms", "tmsVector": "http://localhost:3650/api/maps/streets/vector/tms", "wmsGlobal": "http://localhost:3650/api/maps/wms?service=WMS&request=GetCapabilities", "wmtsGlobal": "http://localhost:3650/api/WMTSCapabilities.xml" } } ``` 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)