Alias Management

Edit online

API Gateway provides the capability to create aliases, retrieve alias information, update alias properties as required, and delete the existing aliases using a REST API.

API Gateway provides the following REST API and the resources to manage aliases:

  • GET/rest/apigateway/alias: Retrieves the list of all aliases in API Gateway. You can also use this to retrieve details for a particular alias by providing the aliasName.
  • POST/rest/apigateway/alias: Creates an alias in API Gateway.
  • GET/rest/apigateway/alias/{aliasId}: Retrieves the details of the specified alias in API Gateway.
  • PUT/rest/apigateway/alias/{aliasId}: Updates the details of the specified alias in API Gateway.
  • DELETE/rest/apigateway/alias/{aliasId}: Deletes the specified alias in API Gateway.

For details about the REST API, see https://github.com/SoftwareAG/webmethods-api-gateway/blob/10.15/apigatewayservices/APIGatewayAlias.json.

For details about sample payloads, import Postman collection from the following link in Postman client: https://github.com/SoftwareAG/webmethods-api-gateway/blob/10.15/apigatewayservices/postmancollections/apis/alias-management/AliasManagement.json.