GeoServer Manifests API

GeoServer provides a REST service to expose a listing of all loaded JARs and resources on the running instance. This is useful for bug reports and to keep track of extensions deployed into the application.
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

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

Default

Default

Up
get /about/status
(aboutStatusGet)

This endpoint shows the status details of all installed and configured modules. Status details always include human readable name, and module name. Optional details include version, availability, status message, and links to documentation.

Use the "Accept:" header to specify format or append an extension to the endpoint (example "/about/manifest.xml" for XML).

Query parameters

manifest (optional)
Query Parameter — The manifest parameter is used to filter over resulting resource (manifest) names attribute using Java regular expressions.
key (optional)
Query Parameter — Only return manifest entries with this key in their properties. It can be optionally combined with the value parameter.
value (optional)
Query Parameter — Only return manifest entries that have this value for the provided key parameter.

Return type

Status

Example data

Content-Type: application/json
"{\"about\": {\n    \"status\": [\n      {\n        \"module\": \"gs-web-core\",\n        \"name\": \"GeoServer Web UI Core\",\n        \"isEnabled\": true,\n        \"isAvailable\": true\n      },\n      {\n        \"module\": \"gs-main\",\n        \"name\": \"GeoServer Main\",\n        \"isEnabled\": true,\n        \"isAvailable\": true\n      },\n      {\n        \"module\": \"jvm\",\n        \"name\": \"Rendering Engine\",\n        \"component\": \"java2d\",\n        \"version\": \"1.8.0_121\",\n        \"message\": \"Java 2D configured with DuctusRenderingEngine.\\nProvider: OracleJDK\\n\",\n        \"isEnabled\": true,\n        \"isAvailable\": true\n      },\n      {\n        \"module\": \"system-properties\",\n        \"name\": \"system-properties\",\n        \"component\": \"system-properties\",\n        \"message\": \"java.runtime.name=Java(TM) SE Runtime Environment\\nsun.boot.library.path=/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib\\n\",\n        \"isEnabled\": true,\n        \"isAvailable\": true\n      },\n      {\n        \"module\": \"system-environment\",\n        \"name\": \"system-environment\",\n        \"component\": \"system-environment\",\n        \"message\": \"PATH=/usr/bin:/bin:/usr/sbin:/sbin\\nSHELL=/usr/local/bin/bash\\n\",\n        \"isEnabled\": true,\n        \"isAvailable\": true\n      },\n      {\n        \"module\": \"gs-web-wms\",\n        \"name\": \"GeoServer Web UI Web Map Service\",\n        \"isEnabled\": true,\n        \"isAvailable\": true\n      },\n      {\n        \"module\": \"gs-wms\",\n        \"name\": \"GeoServer Web Map Service\",\n        \"isEnabled\": true,\n        \"isAvailable\": true\n      }\n    ]\n  }\n}\n"

Example data

Content-Type: application/xml
"\n  \n    gs-web-core\n    GeoServer Web UI Core\n    true\n    true\n  \n  \n    gs-main\n    GeoServer Main\n    true\n    true\n  \n  \n    jvm\n    Rendering Engine\n    java2d\n    1.8.0_121\n    Java 2D configured with DuctusRenderingEngine.\n    Provider: OracleJDK\n    \n    true\n    true\n  \n  \n    system-properties\n    system-properties\n    system-properties\n    java.runtime.name=Java(TM) SE Runtime Environment\n    sun.boot.library.path=/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib\n    java.vm.version=25.121-b13\n    java.util.prefs.syncInterval=5000000\n    \n    true\n    true\n  \n  \n    system-environment\n    system-environment\n    system-environment\n    PATH=/usr/bin:/bin:/usr/sbin:/sbin\n    SHELL=/usr/local/bin/bash\n    \n    true\n    true\n  \n  \n    gs-web-wms\n    GeoServer Web UI Web Map Service\n    true\n    true\n  \n  \n    gs-wms\n    GeoServer Web Map Service\n    true\n    true\n  \n\n"

Responses

200

Successfully retrieved status details. Status

Example data

Content-Type: application/json
{"about": {
    "status": [
      {
        "module": "gs-web-core",
        "name": "GeoServer Web UI Core",
        "isEnabled": true,
        "isAvailable": true
      },
      {
        "module": "gs-main",
        "name": "GeoServer Main",
        "isEnabled": true,
        "isAvailable": true
      },
      {
        "module": "jvm",
        "name": "Rendering Engine",
        "component": "java2d",
        "version": "1.8.0_121",
        "message": "Java 2D configured with DuctusRenderingEngine.\nProvider: OracleJDK\n",
        "isEnabled": true,
        "isAvailable": true
      },
      {
        "module": "system-properties",
        "name": "system-properties",
        "component": "system-properties",
        "message": "java.runtime.name=Java(TM) SE Runtime Environment\nsun.boot.library.path=/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib\n",
        "isEnabled": true,
        "isAvailable": true
      },
      {
        "module": "system-environment",
        "name": "system-environment",
        "component": "system-environment",
        "message": "PATH=/usr/bin:/bin:/usr/sbin:/sbin\nSHELL=/usr/local/bin/bash\n",
        "isEnabled": true,
        "isAvailable": true
      },
      {
        "module": "gs-web-wms",
        "name": "GeoServer Web UI Web Map Service",
        "isEnabled": true,
        "isAvailable": true
      },
      {
        "module": "gs-wms",
        "name": "GeoServer Web Map Service",
        "isEnabled": true,
        "isAvailable": true
      }
    ]
  }
}

Example data

Content-Type: application/xml

  
    gs-web-core
    GeoServer Web UI Core
    true
    true
  
  
    gs-main
    GeoServer Main
    true
    true
  
  
    jvm
    Rendering Engine
    java2d
    1.8.0_121
    Java 2D configured with DuctusRenderingEngine.
    Provider: OracleJDK
    
    true
    true
  
  
    system-properties
    system-properties
    system-properties
    java.runtime.name=Java(TM) SE Runtime Environment
    sun.boot.library.path=/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/jre/lib
    java.vm.version=25.121-b13
    java.util.prefs.syncInterval=5000000
    
    true
    true
  
  
    system-environment
    system-environment
    system-environment
    PATH=/usr/bin:/bin:/usr/sbin:/sbin
    SHELL=/usr/local/bin/bash
    
    true
    true
  
  
    gs-web-wms
    GeoServer Web UI Web Map Service
    true
    true
  
  
    gs-wms
    GeoServer Web Map Service
    true
    true
  


Up
get /about/version
(aboutVersionGet)

'This endpoint shows only the details for the high-level components: GeoServer, GeoTools, and GeoWebCache.'

Use the "Accept:" header to specify format or append an extension to the endpoint (example "/about/manifest.xml" for XML).'

Query parameters

manifest (optional)
Query Parameter — The manifest parameter is used to filter over resulting resource (manifest) names attribute using Java regular expressions.
key (optional)
Query Parameter — Only return manifest entries with this key in their properties. It can be optionally combined with the value parameter.
value (optional)
Query Parameter — Only return manifest entries that have this value for the provided key parameter.

Responses

200

Returns the manifest

Example data

Content-Type: application/xml

    
        28-Mar-2017 15:44
        18-SNAPSHOT
        a96cee38ad6c8e87cb8ccdf75e1fb837bff35ef0
    
    
        1.12-SNAPSHOT
        e9cdf1ecfcd97afc804ba43e04b2e1dedd4b5990/e9cdf1ecfcd97afc804ba43e04b2e1dedd4b5990
    
 

Example data

Content-Type: application/json
{ "about": {
    "resource": [
      {
        "@name": "GeoTools",
        "Build-Timestamp": "28-Mar-2017 15:44",
        "Version": "18-SNAPSHOT",
        "Git-Revision": "a96cee38ad6c8e87cb8ccdf75e1fb837bff35ef0"
      },
      {
        "@name": "GeoWebCache",
        "Version": "1.12-SNAPSHOT",
        "Git-Revision": "e9cdf1ecfcd97afc804ba43e04b2e1dedd4b5990/e9cdf1ecfcd97afc804ba43e04b2e1dedd4b5990"
      }
    ]
  }
}                            

Up
get /about/manifest
(getManifest)

This endpoint retrieves details on all loaded JARs. All the GeoServer manifest JARs are marked with the property GeoServerModule and classified by type, so you can use filtering capabilities to search for a set of manifests using regular expressions (see the manifest parameter) or a type category (see the key and value parameter).

The available types are core, extension, or community. To filter modules by a particular type, append a request with key=GeoServerModule&value={type}

Use the "Accept:" header to specify format or append an extension to the endpoint (example "/about/manifest.xml" for XML).

The model is very simple and is shared between the version and the resource requests to parse both requests. You can customize the results adding a properties file called manifest.properties into the root of the data directory.

Query parameters

manifest (optional)
Query Parameter — The manifest parameter is used to filter over resulting resource (manifest) names attribute using Java regular expressions.
key (optional)
Query Parameter — Only return manifest entries with this key in their properties. It can be optionally combined with the value parameter.
value (optional)
Query Parameter — Only return manifest entries that have this value for the provided key parameter.

Return type

Manifest

Example data

Content-Type: application/json
"{ \"about\": {\n    \"resource\": [      \n      {\n        \"@name\": \"postgresql-9.4.1211\",\n        \"Bundle-License\": \"http://www.postgresql.org/about/licence/\",\n        \"Specification-Version\": 4.2,\n        \"Bnd-LastModified\": 1474207285788,\n        \"Bundle-Name\": \"PostgreSQL JDBC Driver JDBC42\",\n        \"Bundle-Description\": \"Java JDBC 4.2 (JRE 8+) driver for PostgreSQL database\",\n        \"Build-Jdk\": \"1.8.0_60\",\n        \"Specification-Vendor\": \"Oracle Corporation\",\n        \"Bundle-SymbolicName\": \"org.postgresql.jdbc42\",\n        \"Bundle-Copyright\": \"Copyright (c) 2003-2015, PostgreSQL Global Development Group\",\n        \"Built-By\": \"vladimirsitnikov\",\n        \"Main-Class\": \"org.postgresql.util.PGJDBCMain\",\n        \"Bundle-Activator\": \"org.postgresql.osgi.PGBundleActivator\",\n        \"Require-Capability\": \"osgi.ee;filter:=\\\"(&(|(osgi.ee=J2SE)(osgi.ee=JavaSE))(version>=1.8))\\\"\",\n        \"Tool\": \"Bnd-2.4.0.201411031534\",\n        \"Implementation-Title\": \"PostgreSQL JDBC Driver - JDBC 4.2\",\n        \"Implementation-Version\": \"9.4.1211\",\n        \"Manifest-Version\": 1,\n        \"Created-By\": \"Apache Maven Bundle Plugin\",\n        \"Implementation-Vendor-Id\": \"org.postgresql\",\n        \"Bundle-DocURL\": \"http://jdbc.postgresql.org/\",\n        \"Bundle-Vendor\": \"PostgreSQL Global Development Group\",\n        \"Implementation-Vendor\": \"PostgreSQL Global Development Group\",\n        \"Bundle-ManifestVersion\": 2,\n        \"Bundle-Version\": \"9.4.1211\",\n        \"Specification-Title\": \"JDBC\"\n      },\n      {\n        \"@name\": \"wicket-core-7.6.0\",\n        \"Archiver-Version\": \"Plexus Archiver\",\n        \"Bundle-License\": \"http://www.apache.org/licenses/LICENSE-2.0.txt\",\n        \"Specification-Version\": \"7.6.0\",\n        \"Bnd-LastModified\": 1482777231886,\n        \"Bundle-Name\": \"Wicket Core\",\n        \"DynamicImport-Package\": \"*\",\n        \"Bundle-Description\": \"Wicket is a Java web application framework that takes simplicity, \\t\\tseparation of concerns and ease of development to a whole new level. \\t\\tWicket pages can be mocked up, previewed and later revised using \\t\\tstandard WYSIWYG HTML design tools. Dynamic content processing and \\t\\tform handling is all handled in Java code using a first-class \\t\\tcomponent model backed by POJO data beans that can easily be \\t\\tpersisted using your favorite technology.\",\n        \"Build-Jdk\": \"1.8.0_111\",\n        \"Specification-Vendor\": \"Apache Software Foundation\",\n        \"Bundle-SymbolicName\": \"org.apache.wicket.core\",\n        \"Built-By\": \"andrea\",\n        \"Require-Capability\": \"osgi.ee;filter:=\\\"(&(osgi.ee=JavaSE)(version=1.7))\\\"\",\n        \"Tool\": \"Bnd-2.3.0.201405100607\",\n        \"Implementation-Title\": \"Wicket Core\",\n        \"Implementation-Version\": \"7.6.0\",\n        \"Manifest-Version\": 1,\n        \"Created-By\": \"Apache Maven Bundle Plugin\",\n        \"Implementation-Vendor-Id\": \"org.apache.wicket\",\n        \"Bundle-DocURL\": \"http://apache.org\",\n        \"Bundle-Vendor\": \"Apache Software Foundation\",\n        \"Implementation-Vendor\": \"Apache Software Foundation\",\n        \"Bundle-ManifestVersion\": 2,\n        \"Bundle-Version\": \"7.6.0\",\n        \"Specification-Title\": \"Wicket Core\"\n      }\n    ]\n  }\n}\n"

Example data

Content-Type: application/xml
"\n    \n        http://www.postgresql.org/about/licence/\n        4.2\n        1455913825221\n        PostgreSQL JDBC Driver JDBC42\n        Java JDBC 4.2 (JRE 8+) driver for PostgreSQL database\n        1.8.0_66\n        Oracle Corporation\n        org.postgresql.jdbc42\n        Copyright (c) 2003-2015, PostgreSQL Global Development Group\n        vladimirsitnikov\n        org.postgresql.util.PGJDBCMain\n        org.postgresql.osgi.PGBundleActivator\n        osgi.ee;filter:="(&(|(osgi.ee=J2SE)(osgi.ee=JavaSE))(version>=1.8))"\n        Bnd-2.3.0.201405100607\n        PostgreSQL JDBC Driver - JDBC 4.2\n        9.4.1208\n        1.0\n        Apache Maven Bundle Plugin\n        org.postgresql\n        http://jdbc.postgresql.org/\n        PostgreSQL Global Development Group\n        PostgreSQL Global Development Group\n        2\n        9.4.1208\n        JDBC\n        \n    \n        Plexus Archiver\n        http://www.apache.org/licenses/LICENSE-2.0.txt\n        7.6.0\n        1482777231886\n        Wicket Core\n        *\n        Wicket is a Java web application framework that takes simplicity,       separation of concerns and ease of development to a whole new level.        Wicket pages can be mocked up, previewed and later revised using        standard WYSIWYG HTML design tools. Dynamic content processing and      form handling is all handled in Java code using a first-class       component model backed by POJO data beans that can easily be        persisted using your favorite technology.\n        1.8.0_111\n        Apache Software Foundation\n        org.apache.wicket.core\n        andrea\n        osgi.ee;filter:="(&(osgi.ee=JavaSE)(version=1.7))"\n        Bnd-2.3.0.201405100607\n        Wicket Core\n        7.6.0\n        1.0\n        Apache Maven Bundle Plugin\n        org.apache.wicket\n        http://apache.org\n        Apache Software Foundation\n        Apache Software Foundation\n        2\n        7.6.0\n        Wicket Core\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

Returns the manifest Manifest

Example data

Content-Type: application/json
{ "about": {
    "resource": [      
      {
        "@name": "postgresql-9.4.1211",
        "Bundle-License": "http://www.postgresql.org/about/licence/",
        "Specification-Version": 4.2,
        "Bnd-LastModified": 1474207285788,
        "Bundle-Name": "PostgreSQL JDBC Driver JDBC42",
        "Bundle-Description": "Java JDBC 4.2 (JRE 8+) driver for PostgreSQL database",
        "Build-Jdk": "1.8.0_60",
        "Specification-Vendor": "Oracle Corporation",
        "Bundle-SymbolicName": "org.postgresql.jdbc42",
        "Bundle-Copyright": "Copyright (c) 2003-2015, PostgreSQL Global Development Group",
        "Built-By": "vladimirsitnikov",
        "Main-Class": "org.postgresql.util.PGJDBCMain",
        "Bundle-Activator": "org.postgresql.osgi.PGBundleActivator",
        "Require-Capability": "osgi.ee;filter:=\"(&(|(osgi.ee=J2SE)(osgi.ee=JavaSE))(version>=1.8))\"",
        "Tool": "Bnd-2.4.0.201411031534",
        "Implementation-Title": "PostgreSQL JDBC Driver - JDBC 4.2",
        "Implementation-Version": "9.4.1211",
        "Manifest-Version": 1,
        "Created-By": "Apache Maven Bundle Plugin",
        "Implementation-Vendor-Id": "org.postgresql",
        "Bundle-DocURL": "http://jdbc.postgresql.org/",
        "Bundle-Vendor": "PostgreSQL Global Development Group",
        "Implementation-Vendor": "PostgreSQL Global Development Group",
        "Bundle-ManifestVersion": 2,
        "Bundle-Version": "9.4.1211",
        "Specification-Title": "JDBC"
      },
      {
        "@name": "wicket-core-7.6.0",
        "Archiver-Version": "Plexus Archiver",
        "Bundle-License": "http://www.apache.org/licenses/LICENSE-2.0.txt",
        "Specification-Version": "7.6.0",
        "Bnd-LastModified": 1482777231886,
        "Bundle-Name": "Wicket Core",
        "DynamicImport-Package": "*",
        "Bundle-Description": "Wicket is a Java web application framework that takes simplicity, \t\tseparation of concerns and ease of development to a whole new level. \t\tWicket pages can be mocked up, previewed and later revised using \t\tstandard WYSIWYG HTML design tools. Dynamic content processing and \t\tform handling is all handled in Java code using a first-class \t\tcomponent model backed by POJO data beans that can easily be \t\tpersisted using your favorite technology.",
        "Build-Jdk": "1.8.0_111",
        "Specification-Vendor": "Apache Software Foundation",
        "Bundle-SymbolicName": "org.apache.wicket.core",
        "Built-By": "andrea",
        "Require-Capability": "osgi.ee;filter:=\"(&(osgi.ee=JavaSE)(version=1.7))\"",
        "Tool": "Bnd-2.3.0.201405100607",
        "Implementation-Title": "Wicket Core",
        "Implementation-Version": "7.6.0",
        "Manifest-Version": 1,
        "Created-By": "Apache Maven Bundle Plugin",
        "Implementation-Vendor-Id": "org.apache.wicket",
        "Bundle-DocURL": "http://apache.org",
        "Bundle-Vendor": "Apache Software Foundation",
        "Implementation-Vendor": "Apache Software Foundation",
        "Bundle-ManifestVersion": 2,
        "Bundle-Version": "7.6.0",
        "Specification-Title": "Wicket Core"
      }
    ]
  }
}

Example data

Content-Type: application/xml

    
        http://www.postgresql.org/about/licence/
        4.2
        1455913825221
        PostgreSQL JDBC Driver JDBC42
        Java JDBC 4.2 (JRE 8+) driver for PostgreSQL database
        1.8.0_66
        Oracle Corporation
        org.postgresql.jdbc42
        Copyright (c) 2003-2015, PostgreSQL Global Development Group
        vladimirsitnikov
        org.postgresql.util.PGJDBCMain
        org.postgresql.osgi.PGBundleActivator
        osgi.ee;filter:="(&(|(osgi.ee=J2SE)(osgi.ee=JavaSE))(version>=1.8))"
        Bnd-2.3.0.201405100607
        PostgreSQL JDBC Driver - JDBC 4.2
        9.4.1208
        1.0
        Apache Maven Bundle Plugin
        org.postgresql
        http://jdbc.postgresql.org/
        PostgreSQL Global Development Group
        PostgreSQL Global Development Group
        2
        9.4.1208
        JDBC
        
    
        Plexus Archiver
        http://www.apache.org/licenses/LICENSE-2.0.txt
        7.6.0
        1482777231886
        Wicket Core
        *
        Wicket is a Java web application framework that takes simplicity,       separation of concerns and ease of development to a whole new level.        Wicket pages can be mocked up, previewed and later revised using        standard WYSIWYG HTML design tools. Dynamic content processing and      form handling is all handled in Java code using a first-class       component model backed by POJO data beans that can easily be        persisted using your favorite technology.
        1.8.0_111
        Apache Software Foundation
        org.apache.wicket.core
        andrea
        osgi.ee;filter:="(&(osgi.ee=JavaSE)(version=1.7))"
        Bnd-2.3.0.201405100607
        Wicket Core
        7.6.0
        1.0
        Apache Maven Bundle Plugin
        org.apache.wicket
        http://apache.org
        Apache Software Foundation
        Apache Software Foundation
        2
        7.6.0
        Wicket Core
        


Models

[ Jump to Methods ]

Table of Contents

  1. Manifest -
  2. Manifest_about -
  3. Manifest_about_resource -
  4. Status -
  5. Status_about -
  6. Status_about_status -

Manifest - Up

Details on loaded JARs.
about (optional)

Manifest_about - Up

resource (optional)
array[Manifest_about_resource] Contains key/value pairs for the resource (the resource name is found in the name XML attribute and @name JSON property).

Manifest_about_resource - Up

@name (optional)
String The name of the resource.

Status - Up

Details of installed and configured modules. Status details always include human readable name, and module name. Optional details include version, availability, status message, and links to documentation.
about (optional)

Status_about - Up

status (optional)

Status_about_status - Up

module (optional)
String Module identifier based on artifact bundle. For example, gs-main, gs-oracle.
name (optional)
String Human readable name (from GeoServer documentation), or as defined in the extension pom.xml, ie. ArcSDE DataStore Extensions
component (optional)
String Optional component identifier within module. For example, rendering-engine.
version (optional)
String Human readable version, ie. for geotools it would be 15-SNAPSHOT
message (optional)
String Optional status message such as what Java rendering engine is in use, or the library path if the module/driver is unavailable
isEnabled (optional)
Boolean Returns whether the module is enabled in the current GeoServer configuration.
isAvailable (optional)
Boolean Returns whether the module is available to GeoServer