Administration APIs for webMethods API Gateway

Edit online

webMethods API Gateway provides the capability to administer and manage various functions of webMethods API Gateway using REST APIs.

If you are a new user, you can log in to webMethods API Gateway before you run a REST API for the first time.

Do not provide values that start with a dot (.) in any of the fields when you make API calls from a REST client as Elasticsearch does not support saving those values.

Authentication to use webMethods API Gateway REST APIs

Users can provide their webMethods API Gateway credentials through the HTTP basic authentication method to access the REST APIs.

The users with the API management admin and user roles require an API key and a MCSP token (to be provided as bearer token during invocation) to access the webMethods API Gateway REST APIs. Perform the following steps to generate the required inputs.

Create API keys from IBM SaaS Console. API keys are mapped with the user roles and thus you should generate an API key for the role by using which you want to invoke APIs.
- To invoke APIs as an administrator, generate API key for the API management admin, Service admin, or Service owner role.
- To invoke APIs as a provider, generate API key for the API management user or Service user role.
For information about creating API keys, see Granting access through service IDs and API keys from the IBM SaaS Console.
Using the API key generated from the previous step, make a REST call to the following endpoint with the API key in a request body.
```
POST  https://account-iam.platform.saas.ibm.com/api/2.0/services/instanceID/apikeys/token
{
  "apikey”:”api_key”
}
```
A token is generated and is valid for two hours.
Use the generated token value as the bearer token in the request header during API invocation.

The availability of API resources is based on the user privilege. Typically, users who have the API management admin privilege have access to all APIs, whereas the users the other privileges have limited access of API resources.