Skip to content

Deployment Environment

Overview

Deployment Environment deploys one or more Release Snapshots to a target gateway environment. Use it to deploy API configuration to domains managed under Environments.

With this feature, you can:

  • Select one or more APIs and a target environment.
  • Choose a release snapshot per API.
  • Review existing and selected snapshot configurations before you deploy.
  • Deploy (or submit for approval when a Deployment environment workflow is attached).
  • Confirm rollback when the selected snapshot is older than the currently deployed one.
  • Search and view past deployments by deployment ID, target environment, status, and deployed date.

Path: API Manager → Gateway Control → Deployment Environment

Why This Matters

  • Deploy release snapshots onto gateway environments after you create them in Release Snapshot.
  • Deploy several APIs to the same target environment in one action.
  • Selecting an older snapshot replaces the live version on that environment after you confirm the deploy dialog.
  • Do not use this page to define domains or dataplanes — that belongs in Environments.
  • Do not create snapshots here — create them in Release Snapshot first.
  • Optional approvals: configure a Deployment environment module workflow under Workflows.

Prerequisites

Required Access and Permissions

System / Technical Requirements

  • Valid organization context in the API Manager.
  • Optional: a Deployment environment approval workflow under Approval Workflow → Workflows if deployments must be approved before they run.

Deployment Environment List

Search: Matches deployment ID, target environment name, or environment ID.

Click Deployment Environment to open create mode.

Column Description
Deployment ID Identifier of the deployment
Target Environment Gateway environment that received the snapshots
Status Successful, Approved, Pending, or Failed
Deployed Date When the deployment was submitted

Use the forward arrow on a row to open Deployment Environment / View Deployment ID. There is no separate View or APIs column.

Status values

Status Meaning
Successful Deployment completed and the selected snapshots are live on the target environment
Approved Deployment was approved through an approval workflow
Pending Deployment is waiting for approval or has not finished yet
Failed Deployment failed; view shows Please Note! with the error message when available

Step-by-Step Implementation

Creating a Deployment

Step 1: Navigate to Deployment Environment

  • From the left navigation panel, open Gateway Control → Deployment Environment.

Step 2: Open Create

  • Click Deployment Environment to open Deployment Environment List / Deployment Environment.

Step 3: Fill Basic Information

  1. Under Select API, choose one or more APIs.
  2. Under Target Environment (Promote to), choose the gateway environment.
  3. For each API, choose a release snapshot under (Select the release snapshot).

Step 4: Review Configurations

  1. Open Configurations for the selected APIs.
  2. Review Existing Snapshot Versions in The Selected Environment.
  3. Review Selected Snapshot Versions and use Preview as needed.

Step 5: Deploy

  1. Click Deploy.
  2. If the selected snapshot is older than the one currently live on the target environment, this confirmation appears (title is the API name):

The target environment is currently running the API's Current Snapshot version. Deploying the selected snapshot will roll back the API to an Older Snapshot version. Do you want to continue?

  1. Choose Continue to proceed with the deploy, or Cancel to return and pick another snapshot.

Success

On success, you return to the list. If a Deployment environment workflow is attached, the request may be submitted for approval instead of deploying immediately.

Viewing a Deployment

Step 1: Open the list

  • Go to Gateway Control → Deployment Environment.

Step 2: Open view

  • Select the forward arrow on a deployment row.
  • Review Status, Basic Information, and Configurations in read-only mode.
  • If status is Failed, check the Please Note! error banner when shown.
  • Use Back to return to the list.

Best Practices

Practice Reason
Create release snapshots before deploying Each API needs a snapshot to select
Deploy multiple APIs only when they share one target environment One target environment per deployment action
Review Configurations and Preview before Deploy Confirms existing vs selected snapshot content
Continue on the older-snapshot dialog only when intentional Choosing an older snapshot replaces the live version after you continue
Check Failed status and the Please Note banner on view Surfaces deployment errors for follow-up

Troubleshooting

Issue Possible Cause Resolution
Deploy disabled / Configurations not ready Missing target environment or snapshot for an API Select Target Environment and a snapshot for every selected API
No snapshots for an API No release snapshot created yet Create a snapshot in Release Snapshot
No environments in the selector No gateway environments Create one in Environments
Submitted for approval Deployment environment workflow attached Approve or reject in Pending Approvals
Older-snapshot confirmation unexpected Selected snapshot is older than the current deploy Continue only if you meant to deploy that older snapshot; otherwise choose a newer one
Status Failed Deployment did not complete Open view and read the Please Note! error banner
Search finds no rows Query does not match ID or environment Clear search or adjust deployment ID / environment name

Frequently Asked Questions

How is this different from Environments?

Environments defines gateway domains and dataplanes. Deployment Environment pushes selected Release Snapshots onto those environments.

Can I deploy multiple APIs at once?

Yes. Select multiple APIs, pick a snapshot for each, choose one target environment, then Deploy.

Do I create snapshots on this page?

No. Create them in Release Snapshot, then deploy from here.

Tip

Create Environments and Release Snapshot first, then deploy from Deployment Environment. For approvals, configure Workflows with module Deployment environment.