Deploy Keys

Create deploy key

Changed on

Create a deploy key like "dev:happy-animal-123|ey..." which can be used with the Convex CLI to develop against or deploy code.

When access to the deployment is granted through an OAuth token this deploy key will use the same OAuth-granted token.

When access to the deployment is granted any other way a new token will be created which grants access only to this deployment.

post/deployments/{deployment_name}/create_deploy_key

Request

  • Base URL: https://api.convex.dev/v1
  • URL: https://api.convex.dev/v1/deployments/{deployment_name}/create_deploy_key
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

Deployment name

Request body

namestring required

Name for the deploy key.

allowedActionsstring[]
expiresAtinteger nullable

Timestamp in milliseconds when this deploy key will expire. Must be at least 30 minutes in the future.

Response

deployKeystring required

Encrypted admin key

Changes