GeoServer CoverageStores

A coverage store describes how access a raster data source.
More information: http://geoserver.org/comm/
Contact Info: geoserver-users@sourceforge.net
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

CoverageStores

CoverageStores

Up
delete /workspaces/{workspace}/coveragestores/{store}
Delete coverage store (deleteCoverageStore)
Deletes a coverage store

Path parameters

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

Query parameters

purge (optional)
Query Parameter — The purge parameter specifies if and how the underlying raster data source is deleted. Allowable values for this parameter are "none", "metadata", "all". When set to "none" data and auxiliary files are preserved. When set to "metadata" delete only auxiliary files and metadata. It’s recommended when data files (such as granules) should not be deleted from disk. Finally, when set to "all" both data and auxiliary files are removed.
recurse (optional)
Query Parameter — The recurse controls recursive deletion. When set to true all resources contained in the store are also removed. The default value is "false".

Responses

200

OK

401

Unauthorized

Up
delete /workspaces/{workspace}/coveragestores/{store}/{method}.{format}
(deleteCoverageStoreUpload)
Invalid, only used for uploads

Responses

401

Unauthorized

405

Method Not Allowed

Up
delete /workspaces/{workspace}/coveragestores
(deleteCoverageStores)
Invalid. Use /coverage/{style} instead.

Responses

401

Unauthorized

405

Method Not Allowed

Up
get /workspaces/{workspace}/coveragestores/{store}
Get a coverage store named {store} in the {workspace} workspace (getCoverageStore)
Displays a representation of the coverage store. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/{store}.xml" for XML). Defaults to HTML representation.

Path parameters

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

Query parameters

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

Return type

CoverageStoreInfo

Example data

Content-Type: application/json
"{\n  \"coverageStore\": {\n    \"name\": \"arcGridSample\",\n    \"description\": \"Sample ASCII GRID coverage of Global rainfall.\",\n    \"type\": \"ArcGrid\",\n    \"enabled\": true,\n    \"workspace\": {\n      \"name\": \"nurc\",\n      \"href\": \"http://localhost:8080/geoserver/restng/workspaces/nurc.json\"\n    },\n    \"_default\": false,\n    \"url\": \"file:coverages/arc_sample/precip30min.asc\",\n    \"coverages\": \"http://localhost:8080/geoserver/restng/workspaces/nurc/coveragestores/arcGridSample/coverages.json\"\n  }\n}\n"

Example data

Content-Type: application/xml
"\n  arcGridSample\n  Sample ASCII GRID coverage of Global rainfall.\n  ArcGrid\n  true\n  \n    nurc\n    \n  \n  <__default>false\n  file:coverages/arc_sample/precip30min.asc\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 CoverageStoreInfo

Example data

Content-Type: application/json
{
  "coverageStore": {
    "name": "arcGridSample",
    "description": "Sample ASCII GRID coverage of Global rainfall.",
    "type": "ArcGrid",
    "enabled": true,
    "workspace": {
      "name": "nurc",
      "href": "http://localhost:8080/geoserver/restng/workspaces/nurc.json"
    },
    "_default": false,
    "url": "file:coverages/arc_sample/precip30min.asc",
    "coverages": "http://localhost:8080/geoserver/restng/workspaces/nurc/coveragestores/arcGridSample/coverages.json"
  }
}

Example data

Content-Type: application/xml

  arcGridSample
  Sample ASCII GRID coverage of Global rainfall.
  ArcGrid
  true
  
    nurc
    
  
  <__default>false
  file:coverages/arc_sample/precip30min.asc
  
    
  

401

Unauthorized

Up
get /workspaces/{workspace}/coveragestores/{store}/{method}.{format}
(getCoverageStoreUpload)
Invalid, only used for uploads

Responses

401

Unauthorized

405

Method Not Allowed

Up
get /workspaces/{workspace}/coveragestores
Get a list of all coverage stores in {workspace} (getCoverageStores)
Displays a list of all styles on the server. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/coveragestores.xml" for XML). Defaults to HTML representation.

Path parameters

workspace (required)
Path Parameter — The name of the workspace containing the coverage stores.

Return type

CoverageStoreList

Example data

Content-Type: application/json
"{\n  \"coverageStores\": {\n    \"coverageStore\": [\n      {\n        \"name\": \"arcGridSample\",\n        \"href\": \"http://localhost:8080/geoserver/restng/workspaces/nurc/coveragestores/arcGridSample.json\"\n      },\n      {\n        \"name\": \"worldImageSample\",\n        \"href\": \"http://localhost:8080/geoserver/restng/workspaces/nurc/coveragestores/worldImageSample.json\"\n      }\n    ]\n  }\n}\n"

Example data

Content-Type: application/xml
"\n  \n    arcGridSample\n    \n  \n  \n    worldImageSample\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 CoverageStoreList

Example data

Content-Type: application/json
{
  "coverageStores": {
    "coverageStore": [
      {
        "name": "arcGridSample",
        "href": "http://localhost:8080/geoserver/restng/workspaces/nurc/coveragestores/arcGridSample.json"
      },
      {
        "name": "worldImageSample",
        "href": "http://localhost:8080/geoserver/restng/workspaces/nurc/coveragestores/worldImageSample.json"
      }
    ]
  }
}

Example data

Content-Type: application/xml

  
    arcGridSample
    
  
  
    worldImageSample
    
  

401

Unauthorized

Up
post /workspaces/{workspace}/coveragestores/{store}
(postCoverageStore)
Invalid. Use POST on /workspaces/{workspace}/coveragestores for adding a new coverage store, or PUT on /workspaces/{workspace}/coveragestores/{store} to edit/upload an existing coverage store.

Responses

401

Unauthorized

405

Method Not Allowed

Up
post /workspaces/{workspace}/coveragestores/{store}/{method}.{format}
(postCoverageStoreUpload)
Used to harvest new granules in a writable structured grid coverage reader (e.g., image mosaic). Attempting to harvest a file into any other reader will result in a HTTP 405, method not allowed. Multiple granules can be uploaded by wrapping them in a ZIP file.

Path parameters

workspace (required)
Path Parameter — The name of the workspace containing the coverage stores.
store (required)
Path Parameter — The name of the store to be retrieved
method (required)
Path Parameter — The upload method. Can be "url", "file", "external", "remote". "file" uploads a file from a local source. The body of the request is the file itself. "url" uploads a file from a remote source. The body of the request is a URL pointing to the file to upload. This URL must be visible from the server. "external" uses an existing file on the server. The body of the request is the absolute path to the existing file. "remote" uses a direct reference to a remote url, i.e. a file on a cloud storage. No data copy will occur. The body of the request is a URL pointing to the remote dataset.
format (required)
Path Parameter — The type of target coverage store (e.g., "imagemosaic")

Query parameters

filename (optional)
Query Parameter — The filename parameter specifies the target file name for a file that needs to be harvested as part of a mosaic. This is important to avoid clashes and to make sure the right dimension values are available in the name for multidimensional mosaics to work. Only used if method="file".
updateBBox (optional)
Query Parameter — When set to "true", triggers re-calculation of the layer native bbox. Defaults to "false".

Responses

200

The coverage store was successfully updated.

401

Unauthorized

Up
post /workspaces/{workspace}/coveragestores
Add a new coverage store (postCoverageStores)
Adds a new coverage store entry to the server.

Path parameters

workspace (required)
Path Parameter — The name of the workspace containing the coverage stores.

Consumes

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

Request body

coverageStoreBody CoverageStoreInfo (required)
Body Parameter

The coverage store body information to upload.

Examples:

  • application/xml:

    <coverageStore>
      <name>nyc</name>
      <url>file:/path/to/file.tiff</url>
    </coverageStore>
    
  • application/json:

    {
      "coverageStore": {
        "name": "nyc",
        "url": "file:/path/to/file.tiff"
      }
    }
    

Return type

String

Example data

Content-Type: application/json
""

Responses

201

Created String

401

Unauthorized

Up
put /workspaces/{workspace}/coveragestores/{store}
Modify a single coverage store. (putCoverageStore)
Modifies a single coverage 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 coverage 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

coverageStoreBody CoverageStoreInfo (required)
Body Parameter

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

Examples:

  • application/xml:

    <coverageStore>
      <description>A coverage store</description>
      <enabled>true</enabled>
      <__default>true</__default>
      <url>file:/path/to/file.tiff</url>
    </coverageStore>
    
  • application/json:

    {
      "coverageStore": {
        "description": "A coverage store",
        "enabled": "true",
        "_default": "true",
        "url": "file:/path/to/file.tiff"
      }
    }
    

Responses

200

The coverage store was successfully updated.

401

Unauthorized

Up
put /workspaces/{workspace}/coveragestores/{store}/{method}.{format}
Creates or overwrites the files for a coverage store (putCoverageStoreUpload)
Creates or modified a single coverage store by uploading its raster data files. Multi-file stores like mosaic can be created by uploading a zip file and setting the content type to "application/zip"

Path parameters

workspace (required)
Path Parameter — The name of the workspace containing the coverage stores.
store (required)
Path Parameter — The name of the store to be retrieved
method (required)
Path Parameter — The upload method. Can be "url", "file", "external", "remote". "file" uploads a file from a local source. The body of the request is the file itself. "url" uploads a file from a remote source. The body of the request is a URL pointing to the file to upload. This URL must be visible from the server. "external" uses an existing file on the server. The body of the request is the absolute path to the existing file. "remote" uses a direct reference to a remote url, i.e. a file on a cloud storage. No data copy will occur. The body of the request is a URL pointing to the remote dataset.
format (required)
Path Parameter — The type of target coverage store (e.g., "imagemosaic")

Query parameters

configure (optional)
Query Parameter — The configure parameter controls if a coverage/layer are configured upon file upload, in addition to creating the store. It can have a value of "none" to avoid configuring coverages.
USE_JAI_IMAGEREAD (optional)
Query Parameter — Whether to use deferred loading while configuring the coverage/layer.
coverageName (optional)
Query Parameter — Name of the newly created coverage/layer.
filename (optional)
Query Parameter — The filename parameter specifies the target file name for a file that needs to be harvested as part of a mosaic. This is important to avoid clashes and to make sure the right dimension values are available in the name for multidimensional mosaics to work. Only used if method="file".

Responses

200

The coverage store was successfully updated.

401

Unauthorized

Up
put /workspaces/{workspace}/coveragestores
(putCoverageStores)
Invalid. Use POST for adding a new coverage store, or PUT on /coveragestores/{store} to edit/upload an existing coverage store.

Responses

401

Unauthorized

405

Method Not Allowed

Models

[ Jump to Methods ]

Table of Contents

  1. CoverageStoreInfo -
  2. CoverageStoreInfo_coverages -
  3. CoverageStoreInfo_workspace -
  4. CoverageStoreList -
  5. CoverageStoreListItem -

CoverageStoreInfo - Up

name
String Name of the coverage store
description (optional)
String Description of the coverage store
type
String Type of coverage store
enabled (optional)
Boolean Whether the store is enabled, or not
workspace (optional)
__default__ (optional)
Boolean Whether the store is the default store of the workspace
url (optional)
String Location of the raster data source (often, but not necessarily, a file). Can be relative to the data directory.
coverages (optional)

CoverageStoreInfo_coverages - Up

link (optional)
String A link to the list of coverages contained in this store

CoverageStoreInfo_workspace - Up

The workspace containing the store
name
String Name of the workspace
link (optional)
String A link to the workspace representation

CoverageStoreList - Up

CoverageStoreListItem - Up

name (optional)
String Name of coverage store
href (optional)
String URL to coverage store definition