Deploy Keys

List preview deploy keys

Changed on

Lists all preview deploy keys for the specified project.

get/projects/{project_id}/list_preview_deploy_keys

Request

  • Base URL: https://api.convex.dev/v1
  • URL: https://api.convex.dev/v1/projects/{project_id}/list_preview_deploy_keys
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

project_idinteger required

Project ID

Query parameters

includeManagedboolean

If true, include managed preview deploy keys (e.g., created by external integrations like Vercel) in the response. Defaults to false.

Response

Changes

  • 8107cc743e0bRevision changes
    • warning

      added the new deployment:aiGateway:use enum value to the /// response property for the response status

  • cfe35d359fbaRevision changes
    • warning

      added the new deployment:usage:view enum value to the /// response property for the response status