Platform & SaaS

API keys

Issue least-privilege credentials for servers, isolate customers with group binding, and rotate without downtime.

Endpoint summary

All operations in this resource, with the minimum accepted key scope.

Method & endpointPurposeScope

GET/api/api-keys

List non-secret key metadata

full

POST/api/api-keys

Create a key; raw value is shown once

full

DELETE/api/api-keys/{id}

Revoke a key

full

Create a scoped key

Only an organization-level key with full scope can manage credentials. Choose test or live mode and optionally bind the new key to a profile group.

Group-bound publish keyPostGate API

curl -X POST https://postgate.studio/api/api-keys \
  -H "Authorization: Bearer $POSTGATE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme production publisher",
    "scopes": ["publish", "read"],
    "mode": "live",
    "group_id": "grp_acme123"
  }'

Store the secret immediately

The raw key appears only in the create response. Later list calls return ID, name, prefix, scopes, mode, group, last-used time, and creation time — never the secret.

Rotate without downtime

Create a replacement, deploy it, confirm last_used_at on the new key, then revoke the old ID. Never reuse a live key in development or CI.

Endpoint summary

Create a scoped key

Store the secret immediately

Rotate without downtime

Continue building