Deployments

Get deployment in project by id

Changed on

Get a deployment within a project by reference, default production deployment, or default dev deployment for the calling user.

get/projects/{project_id}/deployment

Request

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

Path parameters

project_idinteger required

Project ID

Query parameters

referencestring

An identifier that uniquely identifies this deployment within the project.

The reference of the deployment to retrieve.

defaultProdboolean nullable

If true, retrieve the default production deployment.

defaultDevboolean nullable

If true, retrieve the default dev deployment for the calling user.

Response

OR

Changes

  • f687660da499Revision changes
    • warning

      added the new aws-ap-southeast-2 enum value to the / response property for the response status

    • warning

      added the new aws-ca-central-1 enum value to the / response property for the response status