RPC naming convention

Every Unkey API endpoint is a POST to a path that names a service and a procedure, like /v2/keys.verifyKey or /v2/deployments.promoteDeployment. It isn’t REST: the path doesn’t name a resource, and the HTTP method doesn’t say what the call does. All parameters go in the JSON body.

The shape

POST https://api.unkey.com/v2/{service}.{procedure}
Content-Type: application/json
Authorization: Bearer <root key>

The service is a camelCase noun for a group of resources, and the procedure is a camelCase verb phrase that usually ends in the resource name. IDs go in the body, not the path. For example, to fetch a key you send {"keyId": "key_..."} to keys.getKey. There are no query strings. There are three GET exceptions: /v2/liveness, a health check that needs no root key, and /openapi.yaml and /reference, which serve the OpenAPI document and a browsable reference.

Services

Almost every procedure is under /v2. A procedure gets a new version prefix when its request or response changes in a breaking way. So far that’s happened once, for /v3/deployments.createDeployment. Each service belongs to one product, and its endpoints are documented there.

Service	Product	What its procedures manage
`apis`	API Management	Keyspaces (called APIs in the endpoint names) and listing their keys.
`keys`	API Management	Creating, verifying, updating, rerolling, and deleting API keys, and their permissions and roles.
`identities`	API Management	Identities shared by several keys.
`permissions`	API Management	Permissions and roles you define for your keys.
`ratelimit`	API Management	The standalone service and its overrides. Singular, not `ratelimits`.
`portal`	API Management	Developer portals and the end-user sessions they mint.
`analytics`	Both	SQL queries over verifications, rate limits, gateway requests, and runtime logs.
`projects`	Compute	.
`apps`	Compute	Apps within a project, including the git connection.
`environments`	Compute	Environment settings and variables.
`deployments`	Compute	Creating, starting, stopping, promoting, and rolling back deployments.
`domains`	Compute	Custom domains and their .
`gateway`	Compute	Gateway policies on an environment.
`github`	Compute	Installing the Unkey GitHub App for the workspace.

Verbs

Procedures use a small set of verbs, so you can often guess a name:

create, get, list, update, and delete for the basics.
Action verbs where a resource does something, such as verifyKey, rerollKey, migrateKeys, limit, multiLimit, setOverride, promoteDeployment, rollbackDeployment, setPolicies, and installApp.

set procedures (setPermissions, setRoles, setPolicies, setEnvironmentVariables) replace the whole list. add and remove procedures change one part of it.

Deprecated procedures

When a procedure is replaced, the old path keeps working for a while and shows a deprecation badge in the reference. Use the newest path in new code. Three paths are deprecated today:

/v2/deploy.createDeployment and /v2/deploy.getDeployment are replaced by the deployments service.
/v2/deployments.createDeployment is replaced by /v3/deployments.createDeployment, which takes an oci source instead of image and lets you leave out the source to use the app’s default.

Get started

Workspace

Audit logs

Billing

Root keys

API

CLI

AI coding

Security

Errors

RPC naming convention

The shape

Services

Verbs

Deprecated procedures