Promotion Management

Edit online

webMethods API Gateway provides supports staging and promotion of assets. Staging and promotion allow you to promote all the assets across different stages.

webMethods 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. The details that are provided include the promotion name, the person who promoted it, the promotion date, and the status of the promoted assets.

  • POST/rest/apigateway/promotion

    Promote the webMethods API Gateway assets from the source machine to the 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 webMethods 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 webMethods 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\) webMethods 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 before promotion. Rollback is initiated from the local webMethods API Gateway instance.

  • DELETE/rest/apigateway/rollback/{rolbackId}

    Deletes the rollback.