Chelabase
ManagementKeys

Create a secret key

POST
/v1/databases/{id}/branches/{branch_id}/keys

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Database id

Formatuuid
branch_id*string

Branch id

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

databases?array<string>|

The Postgres databases the key may reach: 1 to 20 databases of the branch, disabled ones included. Absent or null is every served database.

name*string
role?string|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/databases/497f6eca-6276-4993-bfeb-53cbbbba6f08/branches/497f6eca-6276-4993-bfeb-53cbbbba6f08/keys" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "databases": [    "string"  ],  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "key": "string",  "kind": "public",  "name": "string",  "prefix": "string",  "role": "string"}

List a branch's data API keys GET

Previous Page

Change which databases a key may reach PATCH

Replaces the key's database list on a secret or the public key. `databases` is required: a list of 1 to 20 databases of the branch (a disabled one is allowed; it is just not served), or null for every served database. Rest forgets the branch's cached state when the list changes. The gateway caches a key for up to 30 seconds, so a narrowed list applies to new requests within 30 seconds of the answer, not at once.