API Keys

List the accessible streams

Fetch the list of streams available to the specified keyid.

The call returns per-stream access privileges for the specified keyid. The result object contains the stream names as object keys and the associated privileges for the stream as values.

If access level for stream is not set the default("*") access level is used. If default("*") access level is also not set the database access level is used.

Note: Requires administrator permissions.

get/_api/key/{keyid}/database/{dbname}/stream

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/:dbname/stream/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

dbnamestring string required

The name of the database.

keyidstring string required

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

Query parameters

fullboolean

Return the full set of access levels for all streams.

Response

Successfully fetched streams.

codeinteger

HTTP response code.

errorboolean required

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

Example response

{
  "code": 200,
  "result": {
    "c8locals.streamTest": "rw"
  }
}

Changes

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