Deployments

Get details about a cloud deployment.

get/deployments/{deployment_name}

Request

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

Path parameters

deployment_namestring required

Deployment Name

Response

OR

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

    • info

      the endpoint scheme security Preview Deploy Key was added to the API