.png?sv=2022-11-02&spr=https&st=2024-11-05T09%3A33%3A16Z&se=2024-11-05T09%3A43%3A16Z&sr=c&sp=r&sig=5AZt2IhMdEtIU7XTWexKeI1Ic7WnnZ7kSp5umBMuLaQ%3D){kind=logo}
API Documentation
- 01 Nov 2024
-
DarkLight
-
PDF
API Documentation
- Updated on 01 Nov 2024
-
DarkLight
-
PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
The Itential Automation Service API is a RESTful interface that lets you find, run, and monitor automations.
The Automation Service API allows you to:
- Search for configured gateways and get their status.
- Search for automations that can be run.
- Start an automation run.
- Check on the status of an automation run.
- Get and delete the details of a completed run.
Terminology
The following is a list of commonly used terms in the Automation Service API.
| Term | Definition |
|---|---|
| Gateway | A Gateway is the Automation Service representation of an IAG5 cluster. Access to Gateways is controlled through GBAC and RBAC rules set up by your administrator, and by Gateway GBAC configuration set up by the person responsible for managing the Gateway in the Automation Service. |
| Automation | An Automation is the Automation Service representation of a service that has been created on a specific IAG5 cluster. Automations can be run or scheduled. Note: At this time, you an Automation can only be scheduled through the UI. |
| Job | A Job represents any Automation that is either currently running, or that has completed running. You can find these in the UI, under different workspaces by looking for headings like Completed Automations and Running Automations. |
| Certificate | Certificates are used to secure the connection between the cloud component of the Automation Service and the IAG5 cluster component. While you may encounter them when you're getting detailed information about a Gateway, you will not use them in the current APIs. |
Automation Service OpenAPI 3.1 Document
Documenting the Automation Service API with an OpenAPI definition allows you to generate API documentation quickly, automatically giving you a comprehensive view of every API endpoint, including parameters, headers, and request/response bodies.
Download the REST OpenAPI specification:
Was this article helpful?
