Managing API Deployment Zones
Add or modify one or more deployment zones for your API.
Table of Contents
- What is a deployment zone?
- How do I see which deployment zones my API is deployed to?
- How do I add an API deployment zone?
- How many API deployment zones can I have?
- How do I edit an API deployment zone?
- How do I delete an API deployment zone?
What is a deployment zone?
A deployment zone is one or more physical locations, such as a geographical area or a specific data center, that the API endpoint will be proxied in, if the API is hosted on the platform and is using the proxy capability.
One or more deployment zones are configured as part of the platform setup. When the API Admin creates the API, either from scratch or by uploading an API description document, the platform matches the API against the deployment zones that are defined. The API is deployed in all matching deployment zones.
For example, a deployment zone might be defined as being for live implementations only. An API sandbox implementation would not be deployed to this deployment zone.
How do I see which deployment zones my API is deployed to?
Once you've added your API, it is automatically deployed to any of the API Platform deployment zones with criteria that match your API definition.
The deployment zones for your API are displayed in a visual, map-like chart, as shown below:
Deployment zones are unique to each API implementation.
To view the deployment zones for a specific implementation
- Log in to the API Platform.
- Choose the API.
- On the left menu, click Impls.
- Click the link for the implementation you want to view.
Note: If your API implementation meets the criteria for multiple deployment zones, it has a unique endpoint for each deployment zone.
How do I add an API deployment zone?
The platform automatically matches up your API definition against the existing deployment zones, and deploys the API to all deployment zones for which it matches the criteria.
Note that Live and Sandbox implementations are likely to be deployed to different deployment zones.
How many API deployment zones can I have?
An API can have many deployment zones.
The number of deployment zones for an API is determined by these factors:
- The number of deployment zones defined on the platform.
- The eligibility requirements for each deployment zone; for example, a specific deployment zone might be limited to Live implementations.
- The API definition.
How do I edit an API deployment zone?
Currently, you cannot edit a deployment zone assignment. However, you can add a new protocol for a deployment zone, for your API implementation.
From the implementation details page where you see the Deployment Zones map, click the Edit button to manage deployment zones.
To add a new protocol for a deployment zone
- Follow the steps in To view the deployment zones for a specific implementation to get to the Deployment Zones page.
- In the Deployments section, on the right, click Edit.
- On the right, click the tab to add a protocol.
- Choose from the list, and then click Add. The new protocol is added.
How do I delete an API deployment zone?
This feature will be coming later.
Deployment zones are assigned to your API automatically based on the deployment zone criteria and the API definition. However, you can delete a specific deployment zone for your API.
To delete a deployment zone
- Follow the steps in To view the deployment zones for a specific implementation to get to the Deployment Zones page.
- In the Deployments section, on the right, click Edit.
- On the right, click the tab to add a protocol.
- Choose from the list, and then click Add. The new protocol is added.