automation-cancel
  • 18 Oct 2024
  • Dark
    Light
  • PDF

automation-cancel

  • Dark
    Light
  • PDF

Article summary

Purpose

This automation cancels one automation based on the provided automation ID.

automation-cancel

API used:

/operations-manager/jobs/cancel/

Input

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

Output Data Type Sample Output Description
Message String Successfully canceled job 24fe09ed634a461b987*** Success Message

Error Output

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?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.