Introduction
Runbook Automation is responsible for the management of runbooks and runbook instances. Runbooks are structured operational procedures which can be created, changed, and executed. They might include several types of automation and run manual, semi-automated, or fully-automated. Runbook instances are the execution records of Runbooks. They contain the status and details of one specific execution and can be changed to step through an execution and finish it. Additionally other administrative functions are presented in the API, including configuration management. To send API calls, create an API key in the application and find detailed API documentation inside the Swagger document.
Endpoint URLs
Runbook API
It is used to manage runbooks.
$ROUTE/aiops/api/story-manager/rba/v1/runbooks
Runbook instance API
It is used to manage runbook executions.
$ROUTE/aiops/api/story-manager/rba/v1/runbookinstances
Configuration API
It is used to manage Runbook Automation configuration.
$ROUTE/aiops/api/story-manager/rba/v1/configuration
Tag API
It is used to retrieve runbook tags.
$ROUTE/aiops/api/story-manager/rba/v1/tags
Usage Statistics API
It is used to retrieve Runbook Automation usage statistics.
$ROUTE/aiops/api/story-manager/rba/v1/statistics/runbookinstances
Status API
It is used to retrieve the status of the Runbook Automation deployment.
$ROUTE/aiops/api/story-manager/rba/v1/status
User API
It is used to retrieve a list of all users who have a given role.
$ROUTE/aiops/api/story-manager/rba/v1/users
Authentication
The API uses Zen authentication which requires a JWT token to be authenticated. The token is used to determine whether a user or service ID has access when they use the API.
Error handling
The Runbook Automation API returns one of the following HTTP responses for every API call.
| HTTP Error Code | Description | Recovery |
|---|---|---|
200 |
Success | The call was successful. See the output for the requested data. |
204 |
No Content | Action completed successfully, no data is returned by the server. |
400 |
Bad Request | The input was invalid. Read the error message and adjust your input before trying again. |
401 |
Unauthorized | The request was not authorized. Make sure your API key is valid and the user and password are entered correctly. |
403 |
Forbidden | The supplied authentication is not authorized to access the given API. |
500 |
Internal Server Error | An internal error happened. A correlationId is provided. Include this ID in any request towards IBM support. |