openapi: 3.0.2
info:
  title: MapTiler Server Admin API
  version: 4.7.0
  description: |-
    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.
  termsOfService: https://www.maptiler.com/server/license/
  contact:
    name: Support
    email: support@maptiler.com
    url: https://docs.maptiler.com
servers:
  - description: MapTiler Server Admin API
    url: http://localhost:3650/api/v1/admin
security:
  - Token: []
tags:
  - name: Maps
  - name: Tiles
  - name: Tile Ingest
paths:
  /maps:
    get:
      operationId: mapList
      summary: List maps
      description: Lists maps from maps directory. It can be paginated with offset and limit parameters, otherwise first 50 items are returned.
      x-since: 4.3.0
      tags:
        - Maps
      parameters:
        - name: offset
          in: query
          description: The starting position of returned list of items.
          x-since: 4.2.0
          example: 10
          required: false
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: Maximum number of items which will be returned.
          x-since: 4.2.0
          example: 50
          required: false
          schema:
            type: integer
            default: 50
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MapList'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
  /maps/{id}:
    get:
      operationId: mapDetail
      summary: Detail of the map
      description: Gets information about the given map.
      x-since: 4.3.0
      tags:
        - Maps
      parameters:
        - name: id
          in: path
          description: Identifier of the map.
          x-since: 4.3.0
          example: streets
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MapItemDetail'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
        '404':
          description: Requested item not found
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
    post:
      operationId: mapChange
      summary: Change metadata of the map
      description: Changes metadata (format, quality, published) of the given map.
      x-since: 4.3.0
      tags:
        - Maps
      parameters:
        - name: id
          in: path
          description: Identifier of the map.
          x-since: 4.3.0
          example: streets
          required: true
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/MapChange'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MapItemDetail'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
        '404':
          description: Requested item not found
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
    delete:
      operationId: mapDelete
      summary: Delete the map
      description: Deletes the given map. Before deleting, it is automatically unpublished and cannot be served anymore.
      x-since: 4.3.0
      tags:
        - Maps
      parameters:
        - name: id
          in: path
          description: Identifier of the map.
          x-since: 4.3.0
          example: streets
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MapRemove'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
        '404':
          description: Requested item not found
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
  /maps/{id}/publish:
    post:
      operationId: mapPublish
      summary: Publish the map
      description: Publishes the given map. Does nothing, if the map is already published.
      x-since: 4.3.0
      tags:
        - Maps
      parameters:
        - name: id
          in: path
          description: Identifier of the map.
          x-since: 4.3.0
          example: streets
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MapItemDetail'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
        '404':
          description: Requested item not found
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
  /maps/{id}/unpublish:
    post:
      operationId: mapUnpublish
      summary: Unpublish the map
      description: Unpublishes the given map. Does nothing, if the map is already unpublished.
      x-since: 4.3.0
      tags:
        - Maps
      parameters:
        - name: id
          in: path
          description: Identifier of the map.
          x-since: 4.3.0
          example: streets
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MapItemDetail'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
        '404':
          description: Requested item not found
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
  /tiles:
    get:
      operationId: tileList
      summary: List the tiles
      description: Lists the tilesets from the tiles directory. Can be paginated with offset and limit parameters, otherwise first 50 items are returned.
      x-since: 4.2.0
      tags:
        - Tiles
      parameters:
        - name: offset
          in: query
          description: The starting position of returned list of items.
          x-since: 4.2.0
          example: 10
          required: false
          schema:
            type: integer
            default: 0
        - name: limit
          in: query
          description: Maximum number of items which will be returned.
          x-since: 4.2.0
          example: 50
          required: false
          schema:
            type: integer
            default: 50
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TileList'
  /tiles/rescan:
    post:
      operationId: tileRescan
      summary: Rescan the tiles
      description: Rescans tiles directory. Does NOT remove dead files.
      x-since: 4.2.0
      tags:
        - Tiles
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TileList'
  /tiles/reload:
    post:
      operationId: tileReload
      summary: Reload the tiles
      description: Rescans the tiles directory and automatically removes dead files. Optionally may remove remote tile records.
      x-since: 4.2.0
      tags:
        - Tiles
      parameters:
        - name: removeRemote
          in: query
          description: Removes remote tile records. Does not remove files from the remote server.
          x-since: 4.6.0
          example: true
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TileRemove'
  /tiles/add:
    post:
      operationId: tileAdd
      summary: Add remote tile
      description: Adds MTPKG remote tile record.
      x-since: 4.6.0
      tags:
        - Tiles
      requestBody:
        $ref: '#/components/requestBodies/TileAdd'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TileItem'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
        '404':
          description: Requested item not found
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
  /tiles/{id}:
    get:
      operationId: tileDetail
      summary: Detail of the tileset
      description: Gets information about the given tileset.
      x-since: 4.2.0
      tags:
        - Tiles
      parameters:
        - name: id
          in: path
          description: Identifier of the tileset
          x-since: 4.2.0
          example: b142543e-ffa2-4994-acbc-825012e75a97
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TileItemDetail'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
        '404':
          description: Requested item not found
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
    post:
      operationId: tileChange
      summary: Change metadata of the given tileset
      description: Changes metadata (name, published) of the given tileset.
      x-since: 4.2.0
      tags:
        - Tiles
      parameters:
        - name: id
          in: path
          description: Identifier of the tileset
          x-since: 4.2.0
          example: b142543e-ffa2-4994-acbc-825012e75a97
          required: true
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/TileChange'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TileItemDetail'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
        '404':
          description: Requested item not found
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
    delete:
      operationId: tileDelete
      summary: Delete the tileset
      description: Deletes the given tileset. Before deleting, it is automatically unpublished and cannot be served anymore.
      x-since: 4.2.0
      tags:
        - Tiles
      parameters:
        - name: id
          in: path
          description: Identifier of the tileset
          x-since: 4.2.0
          example: b142543e-ffa2-4994-acbc-825012e75a97
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TileRemove'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
        '404':
          description: Requested item not found
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
  /tiles/{id}/publish:
    post:
      operationId: tilePublish
      summary: Publish the tileset
      description: Publishes the given tileset. Does nothing, if the tileset is already published.
      x-since: 4.2.0
      tags:
        - Tiles
      parameters:
        - name: id
          in: path
          description: Identifier of the tileset
          x-since: 4.2.0
          example: b142543e-ffa2-4994-acbc-825012e75a97
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TileItemDetail'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
        '404':
          description: Requested item not found
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
  /tiles/{id}/unpublish:
    post:
      operationId: tileUnpublish
      summary: Unpublish the tileset
      description: Unpublishes the given tileset. Does nothing, if the tileset is already unpublished.
      x-since: 4.2.0
      tags:
        - Tiles
      parameters:
        - name: id
          in: path
          description: Identifier of the tileset
          x-since: 4.2.0
          example: b142543e-ffa2-4994-acbc-825012e75a97
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TileItemDetail'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
        '404':
          description: Requested item not found
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
  /tiles/ingest:
    post:
      operationId: tileIngestCreate
      summary: Create new tileset ingest
      description: Creates a new tileset ingest.
      x-since: 4.3.0
      tags:
        - Tile Ingest
      requestBody:
        $ref: '#/components/requestBodies/TileIngestCreate'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TileIngestDetail'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
        '404':
          description: Requested item not found
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
  /tiles/ingest/{id}:
    get:
      operationId: tileIngestDetail
      summary: Detail of the given tileset ingest
      description: Gets information about the given tileset ingest.
      x-since: 4.3.0
      tags:
        - Tile Ingest
      parameters:
        - name: id
          in: path
          description: Identifier of the ingesting tileset
          example: b4362feb-6573-451e-b707-cada462c37f7
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TileItemDetail'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
        '404':
          description: Requested item not found
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
  /tiles/ingest/{id}/upload:
    put:
      operationId: tileIngestUpload
      summary: Upload data to tileset ingest
      description: Uploads sent data to the given tileset ingest.
      x-since: 4.3.0
      tags:
        - Tile Ingest
      parameters:
        - name: id
          in: path
          description: Identifier of the ingesting tileset
          example: b4362feb-6573-451e-b707-cada462c37f7
          required: true
          schema:
            type: string
      security: []
      requestBody:
        $ref: '#/components/requestBodies/TileIngestUpload'
      responses:
        '200':
          description: OK, file is completely uploaded
        '308':
          description: Part of the file data is uploaded
          headers:
            Range:
              description: Specifies the range of uploaded bytes
              schema:
                example: Range="bytes 0-1024"
                type: string
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
        '404':
          description: Requested item not found
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
  /tiles/ingest/{id}/process:
    post:
      operationId: tileIngestProcess
      summary: Process tileset ingest
      description: Processes the data of given tileset ingest and creates a tileset with given document_id
      x-since: 4.3.0
      tags:
        - Tile Ingest
      parameters:
        - name: id
          in: path
          description: Identifier of the ingesting tileset
          example: b4362feb-6573-451e-b707-cada462c37f7
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TileItemDetail'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
        '404':
          description: Requested item not found
          content:
            application/json:
              schema:
                type: object
                title: Errors
                properties:
                  errors:
                    $ref: '#/components/schemas/Error'
components:
  parameters:
    listLimit:
      name: limit
      in: query
      description: Maximum number of items which will be returned.
      x-since: 4.2.0
      example: 50
      required: false
      schema:
        type: integer
        default: 50
    listOffset:
      name: offset
      in: query
      description: The starting position of returned list of items.
      x-since: 4.2.0
      example: 10
      required: false
      schema:
        type: integer
        default: 0
    mapId:
      name: id
      in: path
      description: Identifier of the map.
      x-since: 4.3.0
      example: streets
      required: true
      schema:
        type: string
    removeRemote:
      name: removeRemote
      in: query
      description: Removes remote tile records. Does not remove files from the remote server.
      x-since: 4.6.0
      example: true
      required: false
      schema:
        type: boolean
        default: false
    tileId:
      name: id
      in: path
      description: Identifier of the tileset
      x-since: 4.2.0
      example: b142543e-ffa2-4994-acbc-825012e75a97
      required: true
      schema:
        type: string
    tileIngestId:
      name: id
      in: path
      description: Identifier of the ingesting tileset
      example: b4362feb-6573-451e-b707-cada462c37f7
      required: true
      schema:
        type: string
  requestBodies:
    MapChange:
      description: A JSON object containing metadata information
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MapChange'
    TileAdd:
      description: A JSON object containing storage and url for remote tile
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TileAdd'
    TileChange:
      description: A JSON object containing metadata information
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TileChange'
    TileIngestCreate:
      description: JSON containing file name and file size for new tile ingest
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TileIngestCreate'
    TileIngestUpload:
      description: A binary file
      content:
        application/octet-stream:
          schema:
            $ref: '#/components/schemas/BinaryFile'
  responses:
    '400':
      description: Invalid request
      content:
        application/json:
          schema:
            type: object
            title: Errors
            properties:
              errors:
                $ref: '#/components/schemas/Error'
    '404':
      description: Requested item not found
      content:
        application/json:
          schema:
            type: object
            title: Errors
            properties:
              errors:
                $ref: '#/components/schemas/Error'
    '422':
      description: Invalid body
      content:
        application/json:
          schema:
            type: object
            title: Errors
            properties:
              errors:
                $ref: '#/components/schemas/Error'
  schemas:
    BinaryFile:
      type: string
      format: binary
    Error:
      type: array
      items:
        type: object
        title: Error
        properties:
          message:
            type: string
            example: Error message
        description: Error message
      description: List of errors
    MapChange:
      type: object
      title: MapChange
      properties:
        format:
          description: New format
          example: jpeg
          enum:
            - jpeg
            - png
            - webp
          type: string
        quality:
          description: New quality in percent
          example: 92
          minimum: 0
          maximum: 100
          type: integer
        published:
          description: New state of the map serving
          example: true
          type: boolean
    MapItem:
      type: object
      title: MapItem
      properties:
        id:
          description: Identifier of the map
          example: streets
          type: string
        name:
          description: Name of the map
          example: streets
          type: string
        title:
          description: Title of the map
          example: Streets
          type: string
        published:
          description: Says whether the map is published
          example: true
          type: boolean
        format:
          description: Selected format of the map rasterization
          example: jpeg
          enum:
            - jpeg
            - png
            - webp
          type: string
      required:
        - id
        - name
        - title
        - published
        - format
      description: Map item
    MapItemDetail:
      type: object
      title: MapItemDetail
      properties:
        id:
          description: Identifier of the map
          example: streets
          type: string
        name:
          description: Name of the map
          example: streets
          type: string
        title:
          description: Title of the map
          example: Streets
          type: string
        published:
          description: Says whether the map is published
          example: true
          type: boolean
        format:
          description: Selected format of the map rasterization
          example: jpeg
          enum:
            - jpeg
            - png
            - webp
          type: string
        quality:
          description: Format quality of the map rasterization
          example: 92
          minimum: 0
          maximum: 100
          type: integer
        urls:
          $ref: '#/components/schemas/MapItemDetailUrls'
      required:
        - id
        - name
        - title
        - published
        - format
      description: Map detail
    MapItemDetailUrls:
      type: object
      title: MapItemDetailUrls
      description: Accessible URLs for the map
      properties:
        embeddable:
          description: URL for the embeddable viewer
          example: http://localhost:3650/api/maps/streets
          type: string
        ogcTiles:
          description: URL for OGC API - Tiles
          example: http://localhost:3650/api/maps/streets/tiles
          type: string
        stylejson:
          description: URL for styleJSON
          example: http://localhost:3650/api/maps/streets/style.json
          type: string
        tilejson:
          description: URL for tileJSON 516px
          example: http://localhost:3650/api/maps/streets/tiles.json
          type: string
        tilejson256:
          description: URL for tileJSON 256px
          example: http://localhost:3650/api/maps/streets/256/tiles.json
          type: string
        wms:
          description: URL for WMS, available only with valid license, must be enabled in settings
          example: http://localhost:3650/api/maps/streets/wms?service=WMS&request=GetCapabilities
          type: string
        wmts:
          description: URL for WMTS
          example: http://localhost:3650/api/maps/streets/WMTSCapabilities.xml
          type: string
        xyz:
          description: URL for XYZ 512px
          example: http://localhost:3650/api/maps/streets/{z}/{x}/{y}.jpg
          type: string
        xyz256:
          description: URL for XYZ 256px
          example: http://localhost:3650/api/maps/streets/256/{z}/{x}/{y}.jpg
          type: string
    MapList:
      type: object
      title: MapList
      required:
        - items
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/MapItem'
    MapRemove:
      type: object
      title: MapRemove
      required:
        - removed
      properties:
        removed:
          type: array
          items:
            type: string
            example: streets
          description: The names of removed maps
    TileAdd:
      type: object
      title: TileAdd
      properties:
        storage:
          description: Storage type of remote server
          enum:
            - http
            - s3
          example: http
          type: string
        url:
          description: URL of remote file
          example: https://data.maptiler.com/downloads/tileset/europe/switzerland/zurich.mtpkg
          type: string
    TileIngestCreate:
      type: object
      title: TileIngestCreate
      properties:
        filename:
          description: Tileset file name
          example: maptiler-osm.mbtiles
          type: string
        size:
          description: Size of the uploading file
          example: 6930432
          type: integer
    TileIngestDetail:
      type: object
      title: TileIngestDetail
      properties:
        id:
          description: Identifier of the tile ingest
          example: b4362feb-6573-451e-b707-cada462c37f7
          type: string
        document_id:
          description: Identifier of the ingesting tileset
          example: 86e2836d-d30e-4767-85f0-12a33bed2393
          type: string
        filename:
          description: Filename of the ingesting tileset
          example: maptiler-osm.mbtiles
          type: string
        size:
          description: Size of the ingesting tileset
          example: 6930432
          type: integer
        state:
          description: Current state of the ingest
          example: upload
          enum:
            - upload
            - uploading
            - completed
            - failed
          type: string
        upload_url:
          description: URL for uploading data
          example: http://localhost:3650/api/v1/admin/tiles/ingest/b4362feb-6573-451e-b707-cada462c37f7/upload
          type: string
        errors:
          $ref: '#/components/schemas/Error'
      required:
        - id
        - document_id
        - filename
        - size
        - state
      description: Tile ingest item
    TileChange:
      type: object
      title: TileChange
      properties:
        name:
          description: New name
          example: maptiler-osm
          type: string
        published:
          description: New state of the tile serving
          example: true
          type: boolean
    TileItem:
      type: object
      title: TileItem
      properties:
        id:
          description: Identifier of the tileset
          example: b142543e-ffa2-4994-acbc-825012e75a97
          type: string
        name:
          description: Name of the tileset
          example: maptiler-osm
          type: string
        title:
          description: Title of the tileset
          example: Maptiler OSM Data
          type: string
        fileName:
          description: File name
          example: maptiler-osm.mbtiles
          type: string
        published:
          description: Says whether the tileset is published
          example: true
          type: boolean
        type:
          description: Type of the data
          example: mbtiles
          enum:
            - geopackage
            - mbtiles
            - mtpkg
            - postgis
            - virtual
          type: string
        tileType:
          description: File type of the data
          example: vector
          enum:
            - raster
            - terrain
            - vector
          type: string
      required:
        - id
        - name
        - title
        - fileName
        - published
        - type
      description: Tile item
    TileItemDetail:
      type: object
      title: TileItemDetail
      properties:
        id:
          description: Identifier of the tileset
          example: b142543e-ffa2-4994-acbc-825012e75a97
          type: string
        name:
          description: Name of the tileset
          example: maptiler-osm
          type: string
        title:
          description: Title of the tileset
          example: Maptiler OSM Data
          type: string
        fileName:
          description: File name
          example: maptiler-osm.mbtiles
          type: string
        published:
          description: Says whether the tileset is published
          example: true
          type: boolean
        type:
          description: Type of the data
          example: mbtiles
          enum:
            - geopackage
            - mbtiles
            - mtpkg
            - postgis
            - virtual
          type: string
        tileType:
          description: File type of the data
          example: vector
          enum:
            - raster
            - terrain
            - vector
          type: string
        urls:
          $ref: '#/components/schemas/TileItemDetailUrls'
      required:
        - id
        - name
        - title
        - fileName
        - published
        - type
      description: Tile details
    TileItemDetailUrls:
      type: object
      title: TileItemDetailUrls
      description: Accessible URLs for the tileset
      properties:
        embeddable:
          description: URL for embeddable viewer
          example: http://localhost:3650/api/tiles/maptiler-osm
          type: string
        ogcTiles:
          description: URL for OGC API - Tiles
          example: http://localhost:3650/api/tiles/maptiler-osm/tiles
          type: string
        tilejson:
          description: URL for tileJSON / layerJSON
          example: http://localhost:3650/api/tiles/maptiler-osm/tiles.json
          type: string
        wmts:
          description: URL for WMTS
          example: http://localhost:3650/api/tiles/maptiler-osm/WMTSCapabilities.xml
          type: string
        xyz:
          description: URL for XYZ
          example: http://localhost:3650/api/tiles/maptiler-osm/{z}/{x}/{y}
          type: string
    TileList:
      type: object
      title: TileList
      required:
        - items
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/TileItem'
    TileRemove:
      type: object
      title: TileRemove
      required:
        - removed
      properties:
        removed:
          type: array
          items:
            type: string
            example: maptiler-osm
          description: The names of removed tilesets
  securitySchemes:
    Token:
      description: |-
        Your own token can be acquired from http://localhost:3650/admin/settings/credentials. 

        Example: "Token cd43cX91d84044cad11e2fre48afedc9_f80f4be2adfa6dfb6bc489229cad877d6cfcad293f48fae6e77898f2aab65607"
      type: http
      scheme: Token