Skip to main content

 Services

Web services from /about to /webhooks

about_get.psml

/about [GET]

Description

This service returns information about the system, including the database table version and libraries in use.

To know the PageSeeder version, use the /version [GET] service.

Parameters

No parameters required.

Permission

This service requires administrator.

Response

Returns HTTP 200.

Response structure

The response contains nested objects for:

  • database – database table version
  • jvm – Java Virtual Machine name, vendor, info and version as reported by the java.vm.* Java system properties.
  • os – operating system name, version and architecture as reported by the os.* Java system properties or /etc/os-release information on Linux
  • server – servlet container information
  • libraries – list of installed library extensions and versions
<about>
  <database tables-version="[table version]"/>
  <jvm name="[java.vm.name]"
       vendor="[java.vm.vendor]"
       info="[java.vm.info]"
       version="[java.vm.version]"/>
  <os name="[os.name]"
      version="[os.version]"
      arch="[os.arch]"/>
  <server info="[server version]"/>
  <libraries>
    <library version="[version]" extension="jar">[name]</library>
    ...
  </libraries>
</about>

Example response

<about>
  <database tables-version="6.30"/>
  <jvm name="OpenJDK 64-Bit Server VM" 
     vendor="Red Hat, Inc." 
       info="mixed mode, sharing" 
    version="21.0.12.1+1-LTS"/>
  <os name="Rocky Linux" version="9.8 (Blue Onyx)" arch="amd64"/>
  <server info="Apache Tomcat/9.0.120"/>
  <libraries>
    <library version="6.3002" extension="jar">pageseeder-base</library>
    <library version="6.3002" extension="jar">pageseeder-common</library>
    <library version="6.3002" extension="jar">pageseeder-db</library>
    ...
  </libraries>
</about>

Error Handling

No specific errors expected for this service.

Created on , last edited on