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

Deploys a revision of an existing API proxy to an environment in an organization. API proxies cannot be invoked until they have been deployed to an environment. No body is required for this API call, because this simply executes a deploy command for an undeployed API proxy revision that already exists in your Edge organization.

If you experience HTTP 500 errors during API proxy deployment, see Seamless deployment (zero downtime) for information on using the override and delay parameters. That topic also has more details on API proxy deployment.

About API proxies that use shared flows

Edge does not validate the dependencies between shared flows and API proxies at deploy time. For example, if the Flow Callout policy in an API proxy references a shared flow that either doesn't exist or isn't deployed, API proxy deployment still succeeds. When Edge checks the dependency at runtime and validation fails, Edge throws an API proxy error with a 500 HTTP status code.

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. The name of the API proxy revision deployment. Must be of the form: organizations/{organizationId}/environments/{environmentId}/apis/{api_id}/revisions/{revision_id}

Query parameters

Parameters
override

boolean

When set to true, forces deployment of the new revision by overriding conflict checks between revisions.

basepath

boolean

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