Promotion Management
API Gateway provides supports staging and promotion of assets. Staging and promotion allows you to promote all the assets across different stages.
API Gateway provides the following REST API and the resources to manage staging and promotion:
GET/rest/apigateway/promotion: Retrieves the promotions history with each promotion entry providing the details such as promotion name, promoted by whom, when it is promoted, and the promoted assets status.
POST/rest/apigateway/promotion: Promote the
API Gateway assets from the source machine to destination machine where the destination machine is configured as a stage.
GET/rest/apigateway/promotion/{promotionId}: Retrieves a promotion based on the promotion Id.
DELETE/rest/apigateway/promotion/{promotionId}: Deletes a promotion based on the promotion Id.
GET/rest/apigateway/stages: Retrieves all the configured stages.
POST/rest/apigateway/stages: Configures a stage in the source
API Gateway where promotion is initiated.
GET/rest/apigateway/stages/{stageId}: Retrieves a particular stage object based on a stage Id.
PUT/rest/apigateway/stages/{stageId}: Updates a particular stage in the source
API Gateway where the promotion is initiated.
DELETE/rest/apigateway/stages/{stageId}: Deletes a particular stage.
GET/rest/apigateway/rollback: Retrieves the list of possible rollbacks from the local (target)
API Gateway instance.
GET/rest/apigateway/rollback/{rolbackId}: Retrieves a rollback based on the rollback Id.
PUT/rest/apigateway/rollback/{rolbackId}: Rolls back the assets to the previous state, That is, the state prior to promotion. Rollback should be initiated from the local
API Gateway instance.
DELETE/rest/apigateway/rollback/{rolbackId}: Deletes the rollback.
For details on the REST API see the swagger file APIGatewayPromotionManagement.json, located at Install directory/IntegrationServer/instances/default/packages/WmAPIGateway/resources/apigatewayservices.