API Keys

Set the stream access level

Sets the stream access levels for the stream of API key with keyid.

Requires a JSON object with these properties:

grant: Use "ro" to set the stream access level to Subscribe. Use "wo" to set the stream access level to Publish. Use "rw" to set the stream access level to Publish and Subscribe. Use "none" to set the stream access level to No access.
stream: Use "*" to set default access level for all streams.

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

Note: Requires administrator permissions.

put/_api/key/{keyid}/database/{dbname}/stream/{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/:stream/put.ts
A function with typed inputs. Its response is checked against the schema.

keyidstring string required

The id of the API key.

dbnamestring string required

The name of the database.

streamstring string required

The name of the stream.

grantstring required

{
  "grant": "rw"
}

Successfully changed access level.

codeinteger

HTTP response code.

errorboolean

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

resultstring

{
  "code": 200,
  "result": "rw"
}

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