GeoServer Settings
The Settings area shows global configuration for the server
Version: 1.0.0
BasePath:/geoserver/rest
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
[ Jump to Models ]
Table of Contents
Up
delete /settings/contact
(deleteContactSettings)
Invalid. Use PUT to update contact settings.
Responses
405
Method Not Allowed
(deleteSettings)
Invalid. Use PUT to update settings.
Responses
405
Method Not Allowed
Up
delete /workspaces/{workspace}/settings
(deleteWorkspaceSettings)
Delete the settings for this workspace.
Path parameters
workspace (required)
Path Parameter — The workspace name
Responses
200
OK
Get a list of all global contact settings (getContactSettings)
Displays a list of all global contact settings on the server. This is a subset of what is available at the /settings endpoint. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/settings/contact.xml" for XML).
Return type
Example data
Content-Type: application/xml
"\n Alexandria\n Egypt\n Work\n claudius.ptolomaeus@gmail.com\n The Ancient Geographers\n Claudius Ptolomaeus\n Chief Geographer\n\n"
Example data
Content-Type: application/json
"{\n \"contact\": {\n \"addressCity\": \"Alexandria\",\n \"addressCountry\": \"Egypt\",\n \"addressType\": \"Work\",\n \"contactEmail\": \"claudius.ptolomaeus@gmail.com\",\n \"contactOrganization\": \"The Ancient Geographers\",\n \"contactPerson\": \"Claudius Ptolomaeus\",\n \"contactPosition\": \"Chief Geographer\"\n }\n}\n"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/xml
application/json
text/html
Responses
200
OK
Contact
Example data
Content-Type: application/xml
Alexandria
Egypt
Work
claudius.ptolomaeus@gmail.com
The Ancient Geographers
Claudius Ptolomaeus
Chief Geographer
Example data
Content-Type: application/json
{
"contact": {
"addressCity": "Alexandria",
"addressCountry": "Egypt",
"addressType": "Work",
"contactEmail": "claudius.ptolomaeus@gmail.com",
"contactOrganization": "The Ancient Geographers",
"contactPerson": "Claudius Ptolomaeus",
"contactPosition": "Chief Geographer"
}
}
Get a list of all global settings (getSettings)
Displays a list of all global settings on the server. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/settings.xml" for XML).
Return type
Example data
Content-Type: application/xml
"\n \n SettingsInfoImpl-68f6c583:154ca420c47:-8000\n \n Alexandria\n Egypt\n Work\n claudius.ptolomaeus@gmail.com\n The Ancient Geographers\n Claudius Ptolomaeus\n Chief Geographer\n \n UTF-8\n 8\n http://geoserver.org\n false\n false\n false\n \n \n false\n false\n 5\n 7\n 0.5\n 0.75\n false\n true\n true\n false\n false\n \n \n 10\n 5\n 30000\n UNBOUNDED\n 10240\n \n 180\n 0\n true\n 1024\n\n"
Example data
Content-Type: application/json
"{\n \"global\": {\n \"settings\": {\n \"id\": \"SettingsInfoImpl-68f6c583:154ca420c47:-8000\",\n \"contact\": {\n \"addressCity\": \"Alexandria\",\n \"addressCountry\": \"Egypt\",\n \"addressType\": \"Work\",\n \"contactEmail\": \"claudius.ptolomaeus@gmail.com\",\n \"contactOrganization\": \"The Ancient Geographers\",\n \"contactPerson\": \"Claudius Ptolomaeus\",\n \"contactPosition\": \"Chief Geographer\"\n },\n \"charset\": \"UTF-8\",\n \"numDecimals\": 8,\n \"onlineResource\": \"http://geoserver.org\",\n \"verbose\": false,\n \"verboseExceptions\": false,\n \"localWorkspaceIncludesPrefix\": false\n },\n \"jai\": {\n \"allowInterpolation\": false,\n \"recycling\": false,\n \"tilePriority\": 5,\n \"tileThreads\": 7,\n \"memoryCapacity\": 0.5,\n \"memoryThreshold\": 0.75,\n \"imageIOCache\": false,\n \"pngAcceleration\": true,\n \"jpegAcceleration\": true,\n \"allowNativeMosaic\": false,\n \"allowNativeWarp\": false\n },\n \"coverageAccess\": {\n \"maxPoolSize\": 10,\n \"corePoolSize\": 5,\n \"keepAliveTime\": 30000,\n \"queueType\": \"UNBOUNDED\",\n \"imageIOCacheThreshold\": 10240\n },\n \"updateSequence\": 180,\n \"featureTypeCacheSize\": 0,\n \"globalServices\": true,\n \"xmlPostRequestLogBufferSize\": 1024\n }\n}\n"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/xml
application/json
text/html
Responses
200
OK
Global
Example data
Content-Type: application/xml
SettingsInfoImpl-68f6c583:154ca420c47:-8000
Alexandria
Egypt
Work
claudius.ptolomaeus@gmail.com
The Ancient Geographers
Claudius Ptolomaeus
Chief Geographer
UTF-8
8
http://geoserver.org
false
false
false
false
false
5
7
0.5
0.75
false
true
true
false
false
10
5
30000
UNBOUNDED
10240
180
0
true
1024
Example data
Content-Type: application/json
{
"global": {
"settings": {
"id": "SettingsInfoImpl-68f6c583:154ca420c47:-8000",
"contact": {
"addressCity": "Alexandria",
"addressCountry": "Egypt",
"addressType": "Work",
"contactEmail": "claudius.ptolomaeus@gmail.com",
"contactOrganization": "The Ancient Geographers",
"contactPerson": "Claudius Ptolomaeus",
"contactPosition": "Chief Geographer"
},
"charset": "UTF-8",
"numDecimals": 8,
"onlineResource": "http://geoserver.org",
"verbose": false,
"verboseExceptions": false,
"localWorkspaceIncludesPrefix": false
},
"jai": {
"allowInterpolation": false,
"recycling": false,
"tilePriority": 5,
"tileThreads": 7,
"memoryCapacity": 0.5,
"memoryThreshold": 0.75,
"imageIOCache": false,
"pngAcceleration": true,
"jpegAcceleration": true,
"allowNativeMosaic": false,
"allowNativeWarp": false
},
"coverageAccess": {
"maxPoolSize": 10,
"corePoolSize": 5,
"keepAliveTime": 30000,
"queueType": "UNBOUNDED",
"imageIOCacheThreshold": 10240
},
"updateSequence": 180,
"featureTypeCacheSize": 0,
"globalServices": true,
"xmlPostRequestLogBufferSize": 1024
}
}
Up
get /workspaces/{workspace}/settings
Get a list of all workspace-specific settings (getWorkspaceSettings)
Displays a list of all workspace-specific settings. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/settings.xml" for XML).
Path parameters
workspace (required)
Path Parameter — The workspace name
Return type
Example data
Content-Type: application/xml
"\n \n contact\n \n UTF-8\n 4\n false\n false\n false\n\n"
Example data
Content-Type: application/json
"{\n \"settings\": {\n \"contact\": {\n \"id\": \"contact\"\n },\n \"charset\": \"UTF-8\",\n \"numDecimals\": 4,\n \"verbose\": false,\n \"verboseExceptions\": false,\n \"localWorkspaceIncludesPrefix\": false\n }\n}\n"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/xml
application/json
text/html
Responses
200
OK
WorkspaceSettings
Example data
Content-Type: application/xml
contact
UTF-8
4
false
false
false
Example data
Content-Type: application/json
{
"settings": {
"contact": {
"id": "contact"
},
"charset": "UTF-8",
"numDecimals": 4,
"verbose": false,
"verboseExceptions": false,
"localWorkspaceIncludesPrefix": false
}
}
Up
post /settings/contact
(postContactSettings)
Invalid. Use PUT to update contact settings.
Responses
405
Method Not Allowed
(postSettings)
Invalid. Use PUT to update settings.
Responses
405
Method Not Allowed
Up
post /workspaces/{workspace}/settings
Create workspace-specific settings (postWorkspaceSettings)
Create new workspace-specific settings on the server.
Path parameters
workspace (required)
Path Parameter — The workspace name
Consumes
This API call consumes the following media types via the request header:
application/xml
application/json
Request body
Body Parameter — The settings information to upload.
Responses
201
Created
500
Internal Server Error: Settings already exist for workspace
Update contact settings (putContactSettings)
Updates global contact settings on the server.
Consumes
This API call consumes the following media types via the request header:
application/xml
application/json
Request body
settingscontactBody
Contact (required)
Body Parameter — The contact settings information to upload.
Responses
200
OK
Update settings (putSettings*)
Updates global settings on the server.
Consumes
This API call consumes the following media types via the request header:
application/xml
application/json
Request body
settingsBody
Global (required)
Body Parameter — The settings information to upload.
Responses
200
OK
Up
put /workspaces/{workspace}/settings
Update workspace-specific settings (putWorkspaceSettings)
Updates workspace-specific settings on the server.
Path parameters
workspace (required)
Path Parameter — The workspace name
Consumes
This API call consumes the following media types via the request header:
application/xml
application/json
Request body
Body Parameter — The settings information to upload.
Responses
200
OK
[ Jump to Methods ]
Table of Contents
Contact
-
CoverageAccess
-
Global
-
JAI
-
Settings
-
WorkspaceContact
-
WorkspaceSettings
- settings
addressCity (optional)
addressCountry (optional)
addressType (optional)
contactEmail (optional)
contactOrganization (optional)
String Server admin organization
contactPerson (optional)
String Server admin point of contact
contactPosition (optional)
String Server admin point of contact job title
maxPoolSize (optional)
BigDecimal Maximum number of threads that the Java ThreadPoolExecutor will create
corePoolSize (optional)
BigDecimal Number of threads that the Java ThreadPoolExecutor will create
keepAlilveTime (optional)
BigDecimal Timeout for threads to be terminated if they are idle and more than the core pool number exist.
queueType (optional)
String Type of Blocking Queue to managed submitted tasks. Can be either UNBOUNDED or DIRECT.
imageIOCacheThreshold (optional)
BigDecimal Threshold size to choose between file-based cache and memory-based cach
settings (optional)
jai (optional)
coverageAccess (optional)
updateSequence (optional)
BigDecimal Number of times the server configuration has been modified
featureTypeCacheSize (optional)
BigDecimal Maximum number of datastore connections and schemas that can be kept in memory
globalServices (optional)
Boolean Allow access to both global services and virtual services
xmlPostRequestLogBufferSize (optional)
BigDecimal With more verbose logging levels, sets the size of the buffer GeoServer will use to log the body of POST requests
allowInterpolation (optional)
recycling (optional)
tilePriority (optional)
tileThreads (optional)
memoryCapacity (optional)
memoryThreshold (optional)
imageIOCache (optional)
pngAcceleration (optional)
Boolean Enable JAI PNG native acceleration
jpegAcceleration (optional)
Boolean Enable JAI JPEG native acceleration
allowNativeMosaic (optional)
Boolean Enable JAI mosaic native acceleration
allowNativeWarp (optional)
Boolean Enable JAI native warp acceleration
id (optional)
String For internal use only. Do not modify.
contact (optional)
charset (optional)
String Character set to use for encoding (such as UTF-8)
numDecimals (optional)
BigDecimal Maximum nuber of decimal places to use (GML and GeoJSON output)
onlineResource (optional)
verbose (optional)
Boolean Return XML with newlines and indents
verboseExceptions (optional)
Boolean Return service exceptions with full Java stack traces
localWorkspaceIncludesPrefix (optional)
Boolean Show namespace prefix when using virtual service
contact (optional)
charset (optional)
String Character set to use for encoding (such as UTF-8)
numDecimals (optional)
BigDecimal Maximum nuber of decimal places to use (GML and GeoJSON output)
onlineResource (optional)
verbose (optional)
Boolean Return XML with newlines and indents
verboseExceptions (optional)
Boolean Return service exceptions with full Java stack traces
localWorkspaceIncludesPrefix (optional)
Boolean Show namespace prefix when using virtual service