API Connect REST APIs
The API Connect platform REST APIs provide complete access to the capability of the platform.
The API Connect
platform REST APIs can be used for the following actions:
- Automate the administration of the platform.
- Implement scripts and tools to support a continuous integration environment for API development and publishing.
- Manage catalogs of APIs, and their subscribers.
Note: To authenticate with the API Connect Platform REST APIs, generate an API
Key and then exchange it for an access token to use when calling the APIs. You can exchange
it for an access token with the following
example:
curl -v -k -X POST -d '{"api_key": "****", "client_id": "client-id", "client_secret": "client-secret", "grant_type": "api_key"}' -H 'Content-Type: application/json' -H 'Accept: application/json' https://platform-api.{{region}}.apiconnect.automation.ibm.com/api/token
The operations provided in the REST APIs also correspond directly with the commands in the toolkit CLI.
You can use the URL to navigate directly to specific APIs and operations in the OpenAPI Explorer Documentation for the API Connect REST APIs. You can also select the APIs for a specific version by using the drop-down menu in the header bar.
For descriptions of the platform APIs, see the API Connect REST API documentation.