Release Snapshot¶
Overview¶
Release Snapshot captures a immutable versioned configuration state of an API so you can review changes and deploy that state to a gateway environment later.
With this feature, you can:
- Create a snapshot for a selected API from the current configuration.
- Compare changes since the previous release snapshot (policy attach, detach, update, or API published).
- Preview snapshot JSON before or after creation.
- Search existing snapshots and open a snapshot in view mode.
Path: API Manager → Gateway Control → Release Snapshot
Why This Matters¶
- Capture a deployable revision after policy changes or API publish.
- Review changes since the last snapshot before you deploy configuration.
- Hand off a stable snapshot ID to Deployment Environment.
- Do not use this page to define gateway domains or dataplanes — that belongs in Environments.
- Do not deploy from this page — create the snapshot here, then deploy from Deployment Environment.
Prerequisites¶
Required Access and Permissions¶
- API Manager access.
- Permission to manage gateway policies / Gateway Control features.
- At least one API available under your organization.
System / Technical Requirements¶
- Valid organization context in the API Manager.
- An API that has configuration worth capturing (for example after policy or publish changes).
Release Snapshot List¶
Search: Matches API name or Release Snapshot ID.
Click Create Release Snapshot to open create mode.
| Column | Description |
|---|---|
Release Snapshot ID |
Identifier of the release snapshot |
API Name |
API the snapshot belongs to |
Snapshot Version |
Version label for the snapshot |
Last updated |
When the snapshot was submitted |
Use the chevron on a row to open Release Snapshot / View Snapshot. There is no separate View column label.
Step-by-Step Implementation¶
Creating a Release Snapshot¶
Step 1: Navigate to Release Snapshot¶
- From the left navigation panel, open
Gateway Control → Release Snapshot.
Step 2: Open Create¶
- Click
Create Release Snapshot.
Step 3: Select the API¶
- Under Basic Information, choose Select API.
- The Current Changes from Previous Release Snapshot section loads for that API.
Step 4: Review changes (optional)¶
- Read the changes grid.
- Use Preview on a row or the page Preview action to inspect JSON.
Step 5: Create¶
- Click Create Release Snapshot.
- On success, you return to the Release Snapshot list.
Tip
If the API has no prior release history, the changes section may show that no release history is available. You can still create the first snapshot.
Viewing a Release Snapshot¶
Step 1: Open the list¶
- Go to
Gateway Control → Release Snapshot.
Step 2: Open View Snapshot¶
- Select the chevron on the snapshot row to open Release Snapshot / View Snapshot.
- Review Select API and Release Snapshot ID (read-only).
- Review Changes in this Release Snapshot and use Preview as needed.
Best Practices¶
| Practice | Reason |
|---|---|
| Create a snapshot after policy or publish changes | Ensures Deployment Environment deploys a known revision |
| Review the changes grid before create | Confirms what is included relative to the previous snapshot |
| Accept an empty changes grid for the first snapshot | First snapshot establishes the baseline revision |
| Deploy from Deployment Environment, not this page | Snapshots are artifacts; deployment is a separate step |
Troubleshooting¶
| Issue | Possible Cause | Resolution |
|---|---|---|
| Create Release Snapshot disabled | No API selected | Choose an API under Select API |
| No APIs in the selector | No APIs in the organization | Onboard or publish an API under My APIs first |
| Empty changes grid | First snapshot, or no recorded deltas | Create the snapshot anyway if you need a baseline revision |
| Preview failed | Request error or missing organization context | Re-login and retry; confirm organization context |
| Organization not found | Session or org context missing | Re-login and try again (Organization not found. Please re-login and try again.) |
| No Release Snapshots match your search | Search filter has no hits | Clear search or adjust the API name / snapshot ID query |
Frequently Asked Questions¶
What does a release snapshot contain?
A snapshot captures the complete configuration state of the selected API at create time, including the changes listed relative to the previous snapshot when available.
Do I deploy from this page?
No. Create the snapshot here, then use Deployment Environment to deploy it to a target environment.
Tip
Create and validate gateway Environments first, create a release snapshot here, then deploy from Deployment Environment.