Stay organized with collections
Save and categorize content based on your preferences.
This page
applies to Apigee and Apigee hybrid.
A deployment is an API hub entity that describes where an API is hosted. For example,
a deployment could represent an Apigee API proxy, an API deployed to Google Cloud API
Gateway, or APIs deployed to other Google Cloud services or non-Google Cloud services.
You can associate an API version with multiple deployments to model scenarios such as dev,
staging, user acceptance testing (UAT), and production deployments corresponding to a
given version.
You can also associate multiple versions with a deployment in cases where multiple
versions of an API (or potentially different APIs) are deployed together.
A deployment entity includes metadata such as name, display name, description, associated
versions, and so on. The following three attributes specify details about the deployed API and
are required to create a deployment in API hub:
Figure 1. A deployment entity includes a deployment type, a resource URI, and endpoint URLs.
Deployment type: Specifies the type of deployment, such as Apigee, Apigee Hybrid, Apigee Edge Private Cloud, and others.
Resource URI: A URI to the deployment resource. For example, if the deployment resource is an Apigee API proxy, then this
field must specify the URI to the management user interface of the proxy.
Endpoints: The endpoints on which the actual deployment of the API is listening to
requests. For example, this field could be a list of IP addresses or hostnames.
For details on creating and managing deployments, see Manage deployments.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-10 UTC."],[[["This content is applicable to both Apigee and Apigee hybrid platforms."],["A deployment, within the context of API Hub, defines where an API is hosted, and may represent various environments like dev, staging, or production."],["Multiple API versions can be associated with a single deployment, and a single version may have multiple deployments."],["Creating a deployment requires specifying its type, resource URI, and the endpoints it's listening on."]]],[]]
