Manage deployments

You're viewing Apigee X documentation.
View Apigee Edge documentation.

An API can have multiple deployments. For example: different staging environments or regions. A deployment is a location (an address) where users can access an API. One of these deployments can be indicated as the recommended deployment.

The Deployments tab displays all deployments for the API configured by a user with edit permissions. Deployments are listed alphabetically by environment.

Deployments tab
View API Registry schema

The following illustrates the relationships between API hub APIs, versions, deployments, and specifications.

alt_text
Reference Item Description
Registry A registry is a collection of APIs that serves as an API catalog.
Version An API can have multiple versions. A version should correspond to a stable interface that clients can use to call an API. One of these versions may be designated as the recommended version. In semver terminology, it is a best practice for versions to be major versions.
Deployment An API may have multiple deployments, e.g., different staging environments or regions. A deployment is a location (an address) where users can access an API. One of these deployments can be the recommended deployment.
Specification It is recommended, but not required that an API version is described by formal specifications, often using different API specification formats. One of these specification formats can be primary, which indicates that other specs for this version are derived from it.
Revisions
  • Deployments have a revision history. Deployment revisions represent particular instances of a deployment in time and can refer to one or more spec revisions if the API implementation being served by the deployment changed.
  • Specs have a revision history. Spec revisions represent subsequent instances of a spec and typically represent non-breaking changes to spec contents. In semver terminology, revisions might correspond to minor or point versions.

Add deployment

To add a deployment:

  1. In the Cloud console, go to the Apigee API hub page.

    Go to API hub

    The APIs list page is displayed by default.

  2. From APIs list, click an API row. The Overview tab is displayed by default.
  3. Select the Deployments tab.
  4. Click Add deployment
  5. Enter or select the following:
    • ID: An identifier for an API resource. The ID can contain only lowercase letters, numbers, and hyphens. The ID must be unique in the project. IDs must be between 4 and 63 characters long. IDs cannot be changed once a deployment has been created.
    • Environment: The location where an instance of an API is available. For example: Production, Staging, Test, etc.
    • Gateway: The gateway type. The proxy used to serve and protect the API. Defined as a system taxonomy.
    • API version: The version of the API that is provided by this deployment. If a version has no revisions, it is marked as such in the list and cannot be selected.

      Version, no revision
    • External channel name and URL: A label and URL for a link to an external channel for the API, such as a Developer Portal
    • Access information
      • Usage guidance: Guidance specifying the audience for the deployment. For example, public consumption, internal testing, etc.
      • Server endpoint: The server endpoint for the API
      • Access guidance: Free-form markdown content describing how API consumers can get access to the deployment
  6. Click Save (or Cancel).

Edit deployment

To edit a deployment:

  1. In the Cloud console, go to the Apigee API hub page.

    Go to API hub

    The APIs list page is displayed by default.

  2. From APIs list, click an API row. The Overview tab is displayed by default.
  3. Select the Deployments tab.
  4. Click More > Edit next to the desired deployment.
  5. Make modifications as necessary.
  6. Update revision: This check box is displayed when the currently selected version has a spec revision that is newer than the one that is already assigned to the deployment. Select this box to update the deployed spec revision.

    Deployment update revision box
  7. Click Save (or Cancel).

Delete deployment

To delete a deployment:

  1. In the Cloud console, go to the Apigee API hub page.

    Go to API hub

    The APIs list page is displayed by default.

  2. From APIs list, click an API row. The Overview tab is displayed by default.
  3. Select the Deployments tab.
  4. Click More > Delete next to the desired deployment.
  5. Click Delete (or Cancel) at the prompt.

To set or clear a recommended deployment:

  1. In the Cloud console, go to the Apigee API hub page.

    Go to API hub

    The APIs list page is displayed by default.

  2. From APIs list, click an API row. The Overview tab is displayed by default.
  3. Select the Deployments tab.
  4. On the desired deployment row, click More > Set as recommended. You cannot clear a recommended deployment; you can only specify a different deployment as the recommended deployment.

Get access

To view information on how to get access to an API:

  1. In the Cloud console, go to the Apigee API hub page.

    Go to API hub

    The APIs list page is displayed by default.

  2. From APIs list, click an API row. The Overview tab is displayed by default.
  3. From the General pane or the Deployments tab, click Get access to open the Access API panel. If there is no Get access button, no information has been provided. See Add deployment for instructions on adding access information.
  4. Select a Deployment from the list. If a deployment has no access information, it is marked as such in the list and cannot be selected.

    Deployment no access information

Go to external channel

To navigate to an external channel:

  1. In the Cloud console, go to the Apigee API hub page.

    Go to API hub

    The APIs list page is displayed by default.

  2. From APIs list, click an API row. The Overview tab is displayed by default.
  3. Select the Deployments tab.
  4. Click an External channel link to navigate to an external channel, such as a portal, if one has been defined.