List databases

Returns a list of databases. This request returns information about all EDMs, RDMs, and custom databases on the specified server instance.

The response returns information about the database including its status and size:

[
    {
      "name": "myRDM",
      "status": "Ready",
      "error": "string",
      "sizeInMb": 16,
      "createdAt": "2024-04-10T20:45:28.775Z",
      "pinned": true,
      "pinExpiration": "2024-04-10T20:45:28.775Z",
      "databaseSchema": "Rdm",
      "databaseVersion": "24",
      "lastIndexUpdate": "2024-04-10T20:45:28.775Z",
      "registered": true,
      "exposureSetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "owner": "[email protected]",
      "secured": true,
      "groups": [
        {
          "groupId": "ad422c53-d970-4e90-b50e-c14aa18bb2bd",
          "groupName": "Admin"
        },
        {
          "groupId": "a5d11079-4c73-4863-9de1-0790d316b630",
          "groupName": "Engineering Support"
        }
      ]
    },
    { //more database objects }
]

If a database is a secured database and the principal making the request has access to that database, the response returns detailed information about tenant security on that database:

Property	Description
`name`	Name of this database.
`status`	Status of this database. One of `Ready`...
`error`	Any errors relating to this database.
`sizeInMb`	Size of this database in MB.
`createdAt`	Timestamp of database creation date.
`pinned`	If `true`, database is pinned.
`pinExpiration`	Timestamp of pin expiration date. If `pinned` is `true` and no `pinExpiration` is specfied, the database is permanently pinned.
`databaseSchema`	Schema of this database. One of `Edm`, `Rdm`, or `Unknown` (for custom databases)
`databaseVersion`	Schema version of EDM or RDM database. For example, 18, 21, 24
`lastIndexUpdate`	Timestamp of last database update based on query.
`registered`	If `true`, EDM is registered with Risk Modeler. Registered EDMs are accessible via Risk Modeler and Platform APIs.
`exposureSetId`	ID of the exposure set.
`owner`	Name of role or login that owns the database.
`secured`	If `true`, this database is secured and access is restricted to the owner and members assigned groups.
`groups`	Array of assigned groups identified by `groupId` and `groupName`. Members of these groups can access this database.