.png?sv=2022-11-02&spr=https&st=2024-09-08T03%3A11%3A54Z&se=2024-09-08T03%3A21%3A54Z&sr=c&sp=r&sig=gCCGO2oZxKch6aRpm9uwTEKta3fIKB5y%2B9%2B01co0B68%3D){kind=logo}
automation-cancel
- 09 Jan 2024
-
DarkLight
-
PDF
automation-cancel
- Updated on 09 Jan 2024
-
DarkLight
-
PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Purpose
This automation cancels one automation based on the provided automation ID.
automation-cancel
APIs used:
/operations-manager/jobs/cancel/
| Inputs | Data Type | Sample Input | Description |
|---|---|---|---|
| instance_name | Dropdown (String) | SE Lab Prod 2023.1 | The IAP instance name |
| automation_id | String | 4278c701b83943b08a98*** | The Automation ID of the Automation that needs to be cancelled. |
| token (optional) | String | 9f0999c2-7054-4820-8eeb-c3052d30acaa | Authentication token or empty if an API key is used |
| Output | Data Type | Sample Output | Description |
|---|---|---|---|
| Message | String | Successfully canceled job 24fe09ed634a461b987*** | Success Message |
| Error Output | Data Type | Sample Output | Description |
|---|---|---|---|
| error_message | String | {"metadata":{},"data":{"4f874bd834174ae78a56f3**":"Cannot cancel job 4f874bd834174ae78a56f** that is canceled"},"message":"Failed to cancel all jobs"} | Error Message |
Was this article helpful?
