Database

URL:
https://<root>/system/database
Methods:
GET
Operations:
Update Database Account
Child Resources:
Database Settings
Required Capability:
Access allowed with the "Security and Infrastructure" privilege
Version Introduced:
10.2.1

Description

The database resource represents the database management system (DBMS) that contains all of the portal's configuration and relationship rules. This resource also returns the name and version of the database server currently running in the portal.

You can use the Update Database Account operation to edit the administrative database account that is used by components within the portal to communicate with the database server.

Request parameters

ParameterDetails

f

The response format. The default response is html.

Values: html | json | pjson

Example usage

The following is a sample request URL used to access the database resource:

Use dark colors for code blocksCopy
1
https://machine.domain.com/webadaptor/portaladmin/system/database?f=json

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
5
{
  "name": "<instance_name>",
  "version": "<version>",
  "adminAccount": "<account_name>"
}

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
{
  "name": "gwdb",
  "version": "psql (PostgreSQL) 9.2.4",
  "adminAccount": "dbadmin"
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.