Application and topology APIs
IBM Cloud Pak® for AIOps offers a set of tools and APIs that you can use to predict, communicate, and resolve events before they become serious problems for your organization.
To learn more about how topologies are displayed in the UI, review the topology viewer documentation. For more information, see Topology viewer.
API authentication
For more information on how to authenticate to use APIs, see Accessing APIs.
Access to URL routes
For more information on how to access the URL routes for the topology Swagger documentation, see Enabling access to URL routes.
Access the topology service Swagger through port forwarding
Swagger documentation
Review the following Swagger documentation to use Topology APIs for configure File Observer and Rest Observer jobs.
To learn more about how to use these jobs, such as for including custom data in topologies, see:
Troubleshooting: Swagger UI not responding during high-volume query
When querying for resources using GET /resources, the Swagger UI may become unresponsive if there are in excess of a thousand results.
- Cause: This is a Swagger limitation.
- Workaround: None. Avoid high-volume Swagger queries.
API reference documentation
To learn more about using the topology APIs, including terminology and properties, see Topology API reference.