GeoWebCache Global

Global configuration for the GeoWebCache server
More information: http://geoserver.org/comm/
Contact Info: geoserver-users@sourceforge.net
Version: 1.0.0
BasePath:/geoserver/gwc/rest
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

Default

Default

Up
get /global
Retrieve the global server configuration (globalGet)
Retrieves configuration details about the GeoWebCache server as a whole.

Return type

Global

Example data

Content-Type: application/xml
"\n  \n    GeoWebCache\n    GeoWebCache is an advanced tile cache for WMS servers. It supports a large variety of protocols and\n      formats, including WMS-C, WMTS, KML, Google Maps and Virtual Earth.\n    \n      WFS\n      WMS\n      WMTS\n      GEOWEBCACHE\n    \n    \n      John Smith inc.\n      http://www.example.com/\n      \n        John Smith\n        Geospatial Expert\n        Work\n        1 Bumpy St.\n        Hobart\n        TAS\n        7005\n        Australia\n        +61 3 0000 0000\n        +61 3 0000 0001\n        john.smith@example.com\n      \n    \n    NONE\n    NONE\n  \n  true\n  false\n  120\n  1.13.0\n  /var/opt/gwc/config\n  /var/opt/gwc/config/geowebcache.xml\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 Global

Example data

Content-Type: application/xml

  
    GeoWebCache
    GeoWebCache is an advanced tile cache for WMS servers. It supports a large variety of protocols and
      formats, including WMS-C, WMTS, KML, Google Maps and Virtual Earth.
    
      WFS
      WMS
      WMTS
      GEOWEBCACHE
    
    
      John Smith inc.
      http://www.example.com/
      
        John Smith
        Geospatial Expert
        Work
        1 Bumpy St.
        Hobart
        TAS
        7005
        Australia
        +61 3 0000 0000
        +61 3 0000 0001
        john.smith@example.com
      
    
    NONE
    NONE
  
  true
  false
  120
  1.13.0
  /var/opt/gwc/config
  /var/opt/gwc/config/geowebcache.xml


Up
put /global
Modifies the global configuration. (globalPut)
Update one or more global configuration values

Consumes

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

Request body

body Global (required)
Body Parameter — The modified global configuration.

Responses

200

The configuration was successfully updated.

400

Cannot modify a read-only value.

Models

[ Jump to Methods ]

Table of Contents

  1. Global - global
  2. serviceContact -
  3. serviceInformation -
  4. serviceProvider -

Global - global Up

The global configuration
serviceInformation (optional)
runtimeStatsEnabled (optional)
Boolean Whether runtime statistics are being gathered. Runtime statistics run, by default, every three second and provide data about how many requests the system has been serving in the past 3, 15 and 60 seconds, as well as aggregate numbers.
wmtsCiteCompliant (optional)
Boolean Whether the server is running in WMTS strict compliance mode.
backendTimeout (optional)
Integer The number of seconds GWC will wait for a backend server to return something before closing the connection.
version (optional)
String The GeoWebCache version. Read-only.
identifier (optional)
String The unique identifier for this global server configuration. Read-only.
location (optional)
String The location of this configuration. Read-only.

serviceContact - Up

Contact information for the entity providing the service.
individualName (optional)
String The name of the contact.
positionName (optional)
String The position of the contact.
addressType (optional)
String The type of address, e.g. "Work" or "Home".
addressStreet (optional)
String The street portion of the address.
addressCity (optional)
String The city portion of the address.
addressAdministrativeArea (optional)
String The administrative area portion of the address.
addressPostalCode (optional)
String The postal code portion of the address.
addressCountry (optional)
String The country portion of the address.
phoneNumber (optional)
String The phone number of the contact.
faxNumber (optional)
String The fax number of the contact.
addressEmail (optional)
String The email of the contact.

serviceInformation - Up

Service information such as you or your company's details that you want provided in capabilities documents.
title (optional)
String The title of the server.
description (optional)
String The description of the server.
keywords (optional)
array[String] List of keywords for the server
serviceProvider (optional)
fees (optional)
String Any fees associated with the server.
accessConstraints (optional)
String Any access constraints associated with the server.

serviceProvider - Up

Information about the entity which provides this GeoWebCache service.
providerName (optional)
String The name of the entity providing the service.
providerSite (optional)
String The website of the entity providing the service.
serviceContact (optional)