GeoServer WMTS Stores

A WMTS store is a store whose source is a remote WMTS. Also known as "Cascading WMTS".
More information: https://geoserver.org/comm/
Contact Info: geoserver-users@osgeo.org
Version: 1.0.0
BasePath:/geoserver/rest
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

WMTSStores

WMTSStores

Up 
delete /workspaces/{workspace}/wmtsstores/{store}
Delete WMTS store (deleteWMTSStore)
Deletes a WMTS store

Path parameters

workspace (required)
Path Parameter — Name of the workspace containing the WMTS store.
store (required)
Path Parameter — Name of the WMTS store

Query parameters

recurse (optional)
Query Parameter — When set to true all resources contained in the store are also removed. default: false

Responses

200

OK

401

Unauthorized
Up 
delete /workspaces/{workspace}/wmtsstores
(deleteWMTSStores)
Invalid. Use /workspaces/{workspace}/wmtsstores/{wmtsstore} instead.

Responses

401

Unauthorized

405

Method Not Allowed
Up 
get /workspaces/{workspace}/wmtsstores/{store}
Retrieve a WMTS store in a given workspace (getWMTSStore)
Displays a representation of the WMTS store. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/workspaces/{workspace}/wmtsstores/{store}.xml" for XML). Defaults to HTML representation.

Path parameters

workspace (required)
Path Parameter — The name of the workspace containing the WMTS store.
store (required)
Path Parameter — The name of the store to be retrieved

Query parameters

quietOnNotFound (optional)
Query Parameter — When set to true, avoids to log an Exception when the WMTS store is not present. Note that 404 status code will be returned anyway.

Return type

WMTSStoreInfo

Example data

Content-Type: application/json
"{\"wmtsStore\": {\n  \"name\":\"altgs\",\n  \"type\":\"WMTS\",\n  \"enabled\":true,\n  \"workspace\": {\"name\":\"cite\", \"href\":\"http://localhost:8080/geoserver/rest/workspaces/cite.json\"},\n  \"metadata\": {\"entry\":{\"@key\":\"useConnectionPooling\",\"$\":\"true\"}},\n  \"_default\":false,\n  \"capabilitiesURL\":\"http://localhost:8081/geoserver/gwc?request=GetCapabilities\",\n  \"maxConnections\":6,\n  \"readTimeout\":60,\n  \"connectTimeout\":30,\n  \"wmtsLayers\":\"http://localhost:8080/geoserver/rest/workspaces/cite/wmtsstores/altgs/wmtslayers.json\"}}\n"

Example data

Content-Type: application/xml
"\n  altgs\n  WMTS\n  true\n  \n    cite\n    \n  \n  \n    true\n  \n  <__default>false\n  http://localhost:8081/geoserver/gwc?request=GetCapabilities\n  6\n  60\n  30\n  \n    \n  \n\n"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK WMTSStoreInfo

Example data

Content-Type: application/json
{"wmtsStore": {
  "name":"altgs",
  "type":"WMTS",
  "enabled":true,
  "workspace": {"name":"cite", "href":"http://localhost:8080/geoserver/rest/workspaces/cite.json"},
  "metadata": {"entry":{"@key":"useConnectionPooling","$":"true"}},
  "_default":false,
  "capabilitiesURL":"http://localhost:8081/geoserver/gwc?request=GetCapabilities",
  "maxConnections":6,
  "readTimeout":60,
  "connectTimeout":30,
  "wmtsLayers":"http://localhost:8080/geoserver/rest/workspaces/cite/wmtsstores/altgs/wmtslayers.json"}}

Example data

Content-Type: application/xml

  altgs
  WMTS
  true
  
    cite
    
  
  
    true
  
  <__default>false
  http://localhost:8081/geoserver/gwc?request=GetCapabilities
  6
  60
  30

401

Unauthorized
Up 
get /workspaces/{workspace}/wmtsstores
Get a list of WMTS stores (getWMTSStores)
Displays a list of all WMTS stores on the server. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/rest/workspaces/{workspace}/wmtsstores.xml" for XML).

Return type

WMTSStoresList

Example data

Content-Type: application/xml
"\n  \n    altgs\n    \n  \n\n"

Example data

Content-Type: application/json
"{\"wmtsStores\":\n  {\"wmtsStore\": [\n    {\"name\":\"altgs\",\n     \"href\":\"http://localhost:8080/geoserver/rest/workspaces/cite/wmtsstores/altgs.json\"}]}}\n"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK WMTSStoresList

Example data

Content-Type: application/xml

  
    altgs

Example data

Content-Type: application/json
{"wmtsStores":
  {"wmtsStore": [
    {"name":"altgs",
     "href":"http://localhost:8080/geoserver/rest/workspaces/cite/wmtsstores/altgs.json"}]}}
Up 
post /workspaces/{workspace}/wmtsstores/{store}
(postWMTSStore)
Invalid. Use POST on /workspaces/{workspace}/WMTSstores for adding a new WMTS store, or PUT on /workspaces/{workspace}/wmtsstores/{store} to edit/upload an existing WMTS store.

Responses

401

Unauthorized

405

Method Not Allowed
Up 
post /workspaces/{workspace}/wmtsstores
Add a new WMTS store (postWMTSStores)
Adds a new WMTS store entry to the server.

Path parameters

workspace (required)
Path Parameter — Name of the worskpace containing the WMTS store.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

WMTSStoreBody WMTSStoreInfo (required)
Body Parameter —

WMTS store body information to upload.

Examples:

  • application/xml:

    <wmtsStore>
  <name>remote</name>
  <capabilitiesUrl>http://demo.geoserver.org/geoserver/gwc/service/wmts?SERVICE=WMTS&VERSION=1.0.0&REQUEST=GetCapabilities</capabilitiesUrl>
</wmtsStore>

  • application/json:

    {
  "wmtsStore": {
    "name": "remote",
    "capabilitiesUrl": "http://demo.geoserver.org/geoserver/gwc/service/wmts?SERVICE=WMTS&VERSION=1.0.0&REQUEST=GetCapabilities"
  }
}

Responses

201

Created

401

Unauthorized
Up 
put /workspaces/{workspace}/wmtsstores/{store}
Modify a single WMTS store. (putWMTSStore)
Modifies a single WMTS store. Use the "Accept:" header to specify format or append an extension to the endpoint (example "{store}.xml" for XML).

Path parameters

workspace (required)
Path Parameter — The name of the workspace containing the WMTS stores.
store (required)
Path Parameter — The name of the store to be retrieved

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

WMTSStoreBody WMTSStoreInfo (required)
Body Parameter —

WMTS store body information to upload. For a PUT, only values which should be changed need to be included.

Examples:

  • application/xml:

    <wmtsStore>
  <description>A wmts store</description>
  <enabled>true</enabled>
  <__default>true</__default>
  <capabilitiesUrl>http://demo.geoserver.org/geoserver/gwc/service/wmts?SERVICE=WMTS&VERSION=1.0.0&REQUEST=GetCapabilities</capabilitiesUrl>
  <user>admin</user>
  <password>geoserver</password>
  <maxConnections>6</maxConnections>
  <readTimeout>60</readTimeout>
  <connectTimeout>30</connectTimeout>
</wmtsStore>

  • application/json:

    {
  "wmtsStore": {
    "description": "A wmts store",
    "enabled": "true",
    "_default": "true",
    "capabilitiesUrl": "http://demo.geoserver.org/geoserver/gwc/service/wmts?SERVICE=WMTS&VERSION=1.0.0&REQUEST=GetCapabilities",
    "user": "admin",
    "password": "geoserver",
    "maxConnections": "6",
    "readTimeout": "60",
    "connectTimeout": "30"
  }
}

Responses

200

The WMTS store was successfully updated.

401

Unauthorized
Up 
put /workspaces/{workspace}/wmtsstores
(putWMTSStores)
Invalid. Use POST for adding a new WMTS store, or PUT on /workspaces/{workspace}/wmtsstores/{wmtsstore} to edit an existing WMTS store.

Responses

401

Unauthorized

405

Method Not Allowed

Models

[ Jump to Methods ]

Table of Contents

  1. WMTSStoreInfo - wmtsStore
  2. WMTSStoreInfo_metadata -
  3. WMTSStoreInfo_metadata_entry -
  4. WMTSStoreInfo_wmtsLayers -
  5. WMTSStoreInfo_workspace -
  6. WMTSStoresList - wmtsStores
  7. WMTSStoresListItem - wmtsStore

WMTSStoreInfo - wmtsStore Up

name (optional)
String Name of the WMTS store
description (optional)
String Description of the WMTS store
type (optional)
String Type of store. Set to WMTS.
enabled (optional)
Boolean Whether the store is enabled
workspace (optional)
WMTSStoreInfo_workspace
metadata (optional)
WMTSStoreInfo_metadata
__default__ (optional)
Boolean Whether the store is the default store of the workspace
capabilitiesURL (optional)
String Location of the WMTS capabilities URL where the store originates
user (optional)
String User name to use when connecting to the remote WMTS
password (optional)
String Password or hash to use when connecting to the remote WMTS
maxConnections (optional)
BigDecimal Maximum number of simultaneous connections to use
readTimeout (optional)
String Time in seconds before read time out
connectTimeout (optional)
String Time in seconds before connection time out
wmtsLayers (optional)
array[WMTSStoreInfo_wmtsLayers]

WMTSStoreInfo_metadata - Up

Miscellaneous configuration details about the WMTS store
entry (optional)
WMTSStoreInfo_metadata_entry

WMTSStoreInfo_metadata_entry - Up

@key (optional)
String Set to useConnectionPooling
Enum:
useConnectionPooling
text (optional)
Boolean Whether connection pooling is enabled

WMTSStoreInfo_wmtsLayers - Up

link (optional)
String Link to the WMTS layers representation

WMTSStoreInfo_workspace - Up

Workspace containing the store
name
String Name of the workspace
link (optional)
String Link to the workspace representation

WMTSStoresList - wmtsStores Up

WMTSStoresListItem - wmtsStore Up

name (optional)
String Name of WMTS Store
link (optional)
String URL to WMTS store representation