POST /api/job_invocations/:id/cancel
Cancel job invocation or matching tasks only

Examples

POST /api/job_invocations/82/cancel
{
  "job_invocation": {}
}
422
{
  "message": "The job could not be cancelled."
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
force
optional

Validations:

  • Must be one of: true, false, 1, 0.
search
optional

Search query to cancel tasks only on matching hosts. If not provided, the whole job invocation will be cancelled.

Validations:

  • String