API for IBM App Connect Enterprise as a Service
To access the API for IBM® App Connect Enterprise as a Service, identify the API endpoint, generate authentication credentials, and be aware of rate limits.
Overview
The IBM App Connect Enterprise as a Service API provides access to the resources in your service instance. This API is typically used by developers to manage the flow deployment lifecycle from their integration and delivery pipelines. This API supports create, read, update, and delete functions for App Connect Enterprise as a Service resources. For example, to deploy an integration, you can use the API to create an integration runtime by providing a BAR file and configurations. You can download an OpenAPI file that describes the API specification from the Public API credentials tab of the Settings page of your App Connect Enterprise as a Service instance.
Endpoint URLs
To form the complete URL of an API endpoint, identify the base URL for your service instance, then add the method.
p-vir-c1
) in the URL for your instance. You can also generate this URL in the OpenAPI file by selecting your region.
- North Virginia, US East
https://api.p-vir-c1.appconnect.automation.ibm.com
- London, Europe
https://api.p-lon-c1.appconnect.automation.ibm.com
- Frankfurt, Europe
https://api.p-fra-c1.appconnect.automation.ibm.com
- Sydney, Asia Pacific
https://api.p-syd-c1.appconnect.automation.ibm.com
p-vir-c1
.https://api.p-vir-c1.appconnect.automation.ibm.com/api/v1/integration-runtimes
Authentication
X-IBM-Client-Id
header to provide your client ID, and the Authorization: Bearer
header to provide
this access token. Authorization: Bearer
is case-sensitive and must be
referred to in calls with the correct capitalization.For more information, see Accessing the API for IBM App Connect Enterprise as a Service.
Response codes and error handling
This API uses standard HTTP response codes to indicate whether a method completed successfully. A
200
-type response indicates success; a 400
-type response indicates
a failure; and a 500
-type response indicates an internal system error.
Rate limits
The rate limit is the maximum number of calls that you can make to the API in a particular time interval. You can send 100 requests per hour to the API for your instance. This limit applies to all client IDs on your instance.
If you reach 100 requests in an hour, HTTP response code 429 is returned, and no further requests are accepted until the timer expires. After the timer expires, a new time window begins with the next accepted request.
X-RateLimit-Reset
indicates the time when the current timer expires (in UNIX epoch time).X-RateLimit-Remaining
indicates the number of requests that remain in the current time window.X-RateLimit-Limit
indicates the total number of requests that are allowed within the time window.