API Keys

List the accessible databases for a keyid

Fetch the list of databases available to the specified keyid.

Returns a JSON object with the per-database access privileges for the specified keyid. The result object contains databases names as object keys, and associated privileges for the database as values.

If you specified full, the result contains permissions for the databases as well as permissions for the collections and streams.

Note: Requires administrator permissions.

get/_api/key/{keyid}/database

Request

The document declares no server URL.
Auth
- API key in header Authorization
- or HTTP bearer
TypeScript
https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_api/key/:keyid/database/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

keyidstring string required

The id of the API key for which you want to query the databases.

Query parameters

fullboolean

Return the full set of access levels for all databases and all collections.

Response

Successfully fetched database list.

codeinteger

HTTP response code.

errorboolean required

Flag if there is an error in response. False for this response.

Example response

{
  "code": 200,
  "result": [
    {
      "_system": "rw"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.