.. _rest_about: About ===== The REST API allows you to set and retrieve information about the server itself. .. note:: Read the `API reference for /about/manifests __`. Retrieving component versions ----------------------------- **Retrieve the versions of the main components: GeoServer, GeoTools, and GeoWebCache** *Request* .. admonition:: curl :: curl -v -u admin:geoserver -XGET -H "Accept: text/xml" http://localhost:8080/geoserver/rest/about/version.xml *Response* .. code-block:: xml 11-Dec-2012 17:55 e66f8da85521f73d0fd00b71331069a5f49f7865 2.3-SNAPSHOT 04-Dec-2012 02:31 380a2b8545ee9221f1f2d38a4f10ef77a23bccae 9-SNAPSHOT 2a534f91f6b99e5120a9eaa5db62df771dd01688 1.3-SNAPSHOT Retrieving manifests -------------------- **Retrieve the full manifest and subsets of the manifest as known to the ClassLoader** *Request* .. admonition:: curl :: curl -v -u admin:geoserver -XGET -H "Accept: text/xml" http://localhost:8080/geoserver/rest/about/manifest.xml .. note:: The result will be a very long list of manifest information. While this can be useful, it is often desirable to filter this list. **Retrieve manifests, filtered by resource name** .. note:: This example will retrieve only resources where the ``name`` attribute matches ``gwc-.*``. *Request* .. admonition:: curl :: curl -v -u admin:geoserver -XGET -H "Accept: text/xml" http://localhost:8080/geoserver/rest/about/manifest.xml?manifest=gwc-.* *Response* .. code-block:: xml ... ... ... ... ... ... ... ... ... ... ... ... **Retrieve manifests, filtered by resource property** .. note:: This example will retrieve only resources with a property equal to ``GeoServerModule``. *Request* .. admonition:: curl :: curl -u admin:geoserver -XGET -H "Accept: text/xml" http://localhost:8080/geoserver/rest/about/manifest.xml?key=GeoServerModule *Response* .. code-block:: xml extension ... ... core ... **Retrieve manifests, filtered by both resource name and property** .. note:: This example will retrieve only resources where a property with named ``GeoServerModule`` has a value equal to ``extension``.\ *Request* .. admonition:: curl :: curl -u admin:geoserver -XGET -H "Accept: text/xml" http://localhost:8080/geoserver/rest/about/manifest.xml?key=GeoServerModule&value=extension System Status ------------- It is possible to request the available system information (monitoring data) through the GeoServer REST API. The supported formats are XML, JSON and HTML. The available REST endpoints are: :: /geoserver/rest/about/system-status /geoserver/rest/about/system-status.json /geoserver/rest/about/system-status.xml /geoserver/rest/about/system-status.html The HTML representation of the system data is equal to the ``System status`` tab representation: .. figure:: img/resthtml.png System status The XML and JSON representations are quite similar. For each system information metric, the following attributes will be available: .. list-table:: :widths: 40 60 * - **Name** - **Description** * - name - name of the metric * - available - TRUE if the system information value is available * - description - description of this system information * - unit - unit of the system information, can be empty * - category - category of this system information * - priority - this value can be used to render the metrics in a predefined order * - identifier - identifies the resource associated with the metric, e.g. file partition name Example of XML representation: .. code-block:: xml 99614720 true Partition [/dev/nvme0n1p2] total space PARTITION_TOTAL bytes FILE_SYSTEM /dev/nvme0n1p2 507 (...) Example of JSON representation: .. code-block:: json { "metrics": { "metric": [ { "available": true, "category": "FILE_SYSTEM", "description": "Partition [/dev/nvme0n1p2] total space", "identifier": "/dev/nvme0n1p2", "name": "PARTITION_TOTAL", "priority": 507, "unit": "bytes", "value": 99614720 },