Deployments

List deployments

Changed on

List deployments for a projects.

get/projects/{project_id}/list_deployments

Request

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

Path parameters

project_idinteger required

Project ID

Query parameters

includeLocalboolean

If true, include local deployments in the response (filtered to only show local deployments created by the requesting team member).

isDefaultboolean nullable

If true, only include default deployments. If false, only include non-default deployments.

deploymentType'dev' | 'prod' | 'preview' | 'custom'

Only include deployments of the given deployment type.

Response

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