Data API базы: ключи
data_api_keysDestructive
The database's Data API keys: list, issue, revoke.
The list never contains key values. Issuing and revoking need the
person's consent: a client with forms asks by itself; without forms ask
in the chat and pass confirmed=true. The value of an issued key is
returned once: the platform does not store secret keys. Hand it to the
person for their server and do not repeat it afterwards.
Revoking breaks everyone who uses the key — including the site, if the
key is baked into its build (`in_build`). Issuing and revoking need a
token with the admin scope.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | No | For revoke: id or prefix of the key from the list. | |
| kind | No | For issue: public — for the site (lives in the browser), secret — for a server only. | public |
| label | No | For issue: a label to recognise the key by in the list. | |
| action | No | `list` — keys with prefixes, no values; `issue` — issue a key, its value is returned ONCE; `revoke` — revoke the key named in `key`. | list |
| database | No | The database: name, slug or id. Without it — the organization's only database with the Data API enabled. | |
| confirmed | No | true — the person has already agreed in the chat after seeing what will change. A client with forms does not need it: the server asks the person itself. Never set it without the person's explicit consent. | |
| organization | No | Organization slug. Without it — the only one, or the personal one. | |
| expires_in_days | No | For issue: lifetime in days; without it the key never expires. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| keys | No | ||
| action | Yes | ||
| issued | No | ||
| revoked | No | ||
| database | Yes | ||
| next_action | Yes | ||
| organization | Yes |