Issue a key

POST

/provision/databases/{id}/keys

The only moment the secret exists anywhere but in the caller's hands.

Capability: key:write (area resource, on the database).

Request

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Issued

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.prod-orm.io/provision/databases//keys' \
--header 'Idempotency-Key;' \
--header 'Content-Type: application/json' \
--data '{
    "name": "string",
    "privilege": "owner",
    "expiresInDays": 1
}'

Response Example

{
    "key": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "name": "string",
        "prefix": "prk_99cbd6a2",
        "privilege": "owner",
        "databaseId": 0,
        "lastUsedAt": "2019-08-24T14:15:22.123Z",
        "expiresAt": "2019-08-24T14:15:22.123Z",
        "revokedAt": "2019-08-24T14:15:22.123Z"
    },
    "secret": "prk_99cbd6a2.sGCbE…",
    "warning": "string"
}

Modified at 2026-10-05 14:01:12

The api keys on a database

Revoke a key