Manage API Deployments

aan provides targeted API deployments for deploying published APIs to specific proxies which represent a specific customer environment. You can manage multiple environments across functional and geographic locations using a single aan to reduce the total cost of API ownership.
apip43
API Portal
 provides targeted API deployments for deploying published APIs to specific proxies which represent a specific customer environment. You can manage multiple environments across functional and geographic locations using a single 
API Portal
to reduce the total cost of API ownership.
You can also manage your API deployments by way of the Portal API or use this API in your scripts for managing API deployments.
For more information about the Portal API, see Portal API (PAPI).
In this article:
Deployment Types
Deployment types allow administrators and API owners to control how APIs are deployed to a proxy. You select the deployment type for APIs when adding proxies.
For more information about how to add a proxy, see Integrate On-Premise API Proxies.
You cannot edit the deployment type once the APIs are deployed to the proxy.
The Details page displays the deployment information for an API on the Deployments tab. The following graphic displays the Details page of API deployment information for different deployment types and proxies:
Screen capture of API Details page
The Details page shows that the API was deployed to the Dev and UAT proxy. This API was not deployed to the Prod proxy. The deployment types are automatic, scripted, and on-demand. The date and timestamp display when the API was last deployed for each proxy.
You select the deployment type during the configuration of proxies. For on-demand and scripted deployment types, APIs are deployed using API calls.
Prerequisites
The following prerequisites must be met to support on-demand and scripted deployment types for a proxy:
For a hybrid
 
solution:
For the SaaS solution, restman is installed for you.
A proxy supports the following deployment types:
  • Automatic
    For automatic deployments, published APIs are immediately deployed to proxies automatically.
  • On-demand
    Event-driven deployments which are triggered when a user with deployment permissions makes calls to Apideployments resources in the Portal API. For example, this deployment type is useful when you want to stagger the deployment of an API across all or your geographic regions to avoid impacting production instances during peak hours.
    The Portal Deployer modular assertion 
    must
     be installed and enabled on the proxy during the enrollment or upgrade process.
  • Scripted
    Scripted deployments are triggered by a custom script that you create, which invokes deployment APIs. Deployment APIs retrieve API deployment data and update the API deployment status for a proxy to keep the 
    API Portal
    updated.
    The Portal Deployer modular assertion 
    must
     be installed and enabled on the proxy during the enrollment or upgrade process.
On-demand and scripted deployments only apply to
API Portal
-published APIs.
The following table displays more information about deployment types:
Deployment Type
Effect on API Deployments
Use Case
Execution Method Used
Note
Automatic
Any changes to APIs are automatically deployed to the proxy. For example, whenever and API is created, edited, or deleted.
Backwards compatibility for retaining current deployment model and Gateway-published APIs.
Automatic is recommended for the following use cases:
  • Rapid iteration of API development
  • Convenience and low maintenance
  • Development environments
UI and API call to select the deployment type.
The API count displays for the Portal and the proxy on the API Proxy Details page because the APIs are automatically deployed to the proxy.
If automatic deployment is not used as the deployment type for a proxy, APIs are not synched to and from that proxy regardless of where they were created.
Gateway-published APIs
must
use the automatic deployment type because they rely on the synchronized scheduled task to synchronize them from the proxy to the Portal.
To enable automatic deployment of Gateway-published APIs, you must enable migration between environments or clusters using Gateway Migration Utility (GMU). For more information, see the following links:
On-Demand
You can trigger API deployments on-demand by calling the deployment APIs. You can access these APIs from the Portal APIs link in the navigation menu.
Deployments are triggered when a user with deployment permissions makes calls to the Apideployments resource in the Portal API.
On-demand deployments only apply to Portal-published APIs.
On-demand is recommended for the following use cases:
  • Deployments that are triggered as needed
  • Geographically distributed environments
  • UAT environments
For example, you want to stagger the deployment of an API across all or your geographic regions to avoid impacting production instances during peak hours.
UI and API call to select the deployment type.
Deployment APIs to orchestrate and trigger the deployment process.
API Proxy Details page displays only the APIs created on the Portal and not the APIs deployed to a proxy.
Scripted
API deployments can be integrated into your existing Continuous Integration/Continuous Deployment (CI/CD) process by using the deployment APIs and invoking them from your deployment script.
Deployments are triggered by the script in conjunction with the deployment APIs which are used to retrieve the API deployment data and update the API deployment status for a proxy.
Scripted deployments only apply to Portal-published APIs.
Scripted is recommended for the following use cases:
  • Integrations with existing CI/CD pipeline
  • Environments that are tightly controlled
  • Production environments
For example, you want control over when an API is deployed using a custom script in conjunction with the Deployment APIs.
UI and API call to select the deployment type.
Restman used to deploy to proxy.
Deployment APIs and custom script to orchestrate and trigger the deployment process.
API Proxy Details page displays only the APIs created on the Portal and not the APIs deployed to a proxy.
APIs for On-Demand and Scripted Deployments
On-demand and scripted API deployments are deployed using the Portal API. Proxy management is accomplished within the Portal through Portal API calls using the Proxies resource.
API deployments are triggered, viewed, and updated using the Apiddeployments resource in the Portal API. You can retrieve the RESTman bundle for an API using API calls. For more information about how to deploy APIs using Deployment APIs, see Deployment API.