v2

latestOpenAPI 3.1.0LicenseRef-Convex2026-07-264790136.4 KB
Deploy Keys

Create preview deploy key

Create a preview deploy key like "preview:team-slug:project-slug|ey..." which can be used with the Convex CLI to create and manage preview deployments within the project.

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

When access to the project is granted any other way a new token scoped to preview deployments in this project will be created.

post/projects/{project_id}/create_preview_deploy_key

Path parameters

project_idinteger required

Project ID

Request body

namestring required

Name for the preview deploy key.

expiresAtinteger nullable

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

Response

previewDeployKeystring required

Encrypted admin key