Google is committed to advancing racial equity for Black communities. See how.

Method: organizations.environments.apis.revisions.deployments.deploy

Deploys a revision of an API proxy.

If an API proxy revision is currently deployed, to ensure seamless deployment with zero downtime set the override parameter to true. In this case, hydbrid attempts to deploy the new revision fully before undeploying the existing revision.

You cannot invoke an API proxy revision until it has been deployed to an environment. After you deploy an API proxy revision, you cannot edit it. To edit the API proxy, you must create and deploy a new revision.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. Name of the API proxy revision deployment in the following format: organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}

Query parameters



Flag that specifies whether to force the deployment of the new revision over the currently deployed revision by overriding conflict checks.

If an existing API proxy revision is deployed, to ensure seamless deployment with zero downtime set this parameter to true. In this case, the existing revision remains deployed until the new revision is fully deployed. If set to false, you must undeploy the currently deployed revision before deploying the new revision.



Base path where the API proxy revision should be deployed. Defaults to / if not provided.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Deployment.

Authorization Scopes

Requires the following OAuth scope:


Try it!

See Manage deployments using the API.