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, hybrid attempts to deploy the new revision fully before undeploying the existing revision.

You cannot invoke an API proxy 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

POST https://apigee.googleapis.com/v1/{name=organizations/*/environments/*/apis/*/revisions/*}/deployments

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

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

Query parameters

Parameters
override

boolean

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 no downtime, set this parameter to true. In this case, Apigee attempts to deploy the new revision fully before undeploying the existing revision. If set to false, you must undeploy the existing revision before deploying the new revision.
basepath

string

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:

  • https://www.googleapis.com/auth/cloud-platform

Try it!

See Deploying API proxies using the API