About this task
To deploy APIs to API Gateway, configure the gateway beforehand. API Studio supports multiple
gateway configurations, allowing selection of a specific gateway for API deployment.
-
From the home page, click the settings icon
.
-
Click .
-
Provide the following gateway details:
- Gateway name. Name of the API Gateway instance where you want to deploy
the API.
- Description. A brief summary of the gateway.
- Provider. This field is auto-populated. It is by default webMethods.
- Gateway URL. The URI of the API Gateway instance you want to configure.
Use the following format:
For a self-hosted instance of webMethods API Gateway:
http://host:port where the port number you provide must be that of the IS
port. For example, http://apigw01:5555. Use https if
you are using a secure connection.
For a cloud deployed instance:
https://domain_name. For example,
https://test.apigw-aw-eu.webmethods.io
- Username. The username credential to access the API Gateway. Make sure
that the user has Manage APIs functional privilege.
- Password. The password credential to access the API Gateway.
- Tags. The tags that you want to specify for the API
Gateway that is being deployed.
- Choose one of the following authentication methods:
- Managed Cloud Service Provider (MCSP). Use an MCSP token for
authentication.
- Username and Password. Provide the credentials for accessing the API
Gateway. The user must have the Manage APIs functional privilege.
-
Click Create.
The configured API Gateway appears in the list of the configured gateways. If the gateway URL
or authentication details are invalid, the configuration fails with an appropriate error
message.