Job_invocations

>>>

GET /api/job_invocations
List job invocations

Examples

GET /api/job_invocations
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "id": 213,
      "description": null,
      "job_category": "Job name 211",
      "targeting_id": 241,
      "status": 0,
      "start_at": null,
      "status_label": "succeeded",
      "ssh_user": null,
      "time_to_pickup": null,
      "concurrency_level": null,
      "execution_timeout_interval": null,
      "dynflow_task": {
        "id": "d03cb4e6-0e43-43bf-bdee-2b6203db7a72",
        "state": "stopped"
      },
      "template_id": 1007982148,
      "template_name": "Job template 232",
      "effective_user": "root",
      "succeeded": 0,
      "failed": 0,
      "pending": 0,
      "cancelled": 0,
      "total": "N/A",
      "missing": 0,
      "total_hosts": "N/A"
    }
  ]
}

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
search
optional

filter results

Validations:

  • String
order
optional

Sort and order by a searchable field, e.g. '<field> DESC'

Validations:

  • String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, 'all' to return all results

Validations:

  • Must match regular expression /\A([1-9]\d*|all)\Z$/.
>>>

GET /api/job_invocations/:id
Show job invocation

Examples

GET /api/job_invocations/228
404
{
  "error": {
    "message": "Resource job_invocation not found by id '228'"
  }
}

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..
host_status
optional

Show Job status for the hosts

Validations:

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

POST /api/job_invocations
Create a job invocation

Examples

POST /api/job_invocations
{
  "job_invocation": {
    "job_category": "Job name 10",
    "name": "RandomName",
    "job_template_id": 1007981719,
    "targeting_type": "static_query",
    "search_query": "foobar",
    "recurrence": {
      "cron_line": "5 * * * *"
    }
  }
}
201
{
  "id": 9,
  "description": "Job template 12 with inputs Template input 7=\"''\"",
  "job_category": "Job name 10",
  "targeting_id": 9,
  "status": 2,
  "start_at": "2025-05-15 16:05:00 UTC",
  "status_label": "queued",
  "ssh_user": null,
  "time_to_pickup": null,
  "concurrency_level": null,
  "execution_timeout_interval": null,
  "dynflow_task": {
    "id": "5321336b-9ba2-4403-9f5d-7554ec65f5d1",
    "state": "scheduled"
  },
  "template_id": 1007981719,
  "template_name": "Job template 12",
  "effective_user": "root",
  "succeeded": 0,
  "failed": 0,
  "pending": 0,
  "cancelled": 0,
  "total": "N/A",
  "missing": 0,
  "total_hosts": 0,
  "targeting": {
    "bookmark_id": null,
    "bookmark_name": null,
    "search_query": "foobar",
    "targeting_type": "static_query",
    "user_id": 135138680,
    "randomized_ordering": null,
    "hosts": []
  },
  "task": {
    "id": "5321336b-9ba2-4403-9f5d-7554ec65f5d1",
    "state": "scheduled",
    "started_at": null
  },
  "mode": "recurring",
  "recurrence": {
    "id": 1,
    "cron_line": "5 * * * *",
    "end_time": null,
    "iteration": 1,
    "task_group_id": 5,
    "state": "active",
    "max_iteration": null,
    "purpose": null,
    "task_count": 1,
    "action": "Run hosts job:",
    "last_occurence": null,
    "next_occurence": "2025-05-15 16:05:00 UTC"
  },
  "pattern_template_invocations": null,
  "job_organization": null,
  "job_location": null
}

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
job_invocation
required

Validations:

  • Hash
job_invocation[job_template_id]
optional , nil allowed

The job template to use, parameter is required unless feature was specified

Validations:

  • String
job_invocation[targeting_type]
required

Invocation type, one of {“static_query”=>“Static Query”, “dynamic_query”=>“Dynamic Query”}

Validations:

  • String
job_invocation[randomized_ordering]
optional , nil allowed

Execute the jobs on hosts in randomized order

Validations:

  • Must be one of: true, false, 1, 0.
job_invocation[inputs]
optional , nil allowed

Inputs to use

Validations:

  • Hash
job_invocation[ssh]
optional , nil allowed

SSH provider specific options

Validations:

  • Hash
job_invocation[ssh][effective_user]
optional , nil allowed

What user should be used to run the script (using sudo-like mechanisms). Defaults to a template parameter or global setting.

Validations:

  • String
job_invocation[ssh][effective_user_password]
optional , nil allowed

Set password for effective user (using sudo-like mechanisms)

Validations:

  • String
job_invocation[ssh_user]
optional , nil allowed

Set SSH user

Validations:

  • String
job_invocation[password]
optional , nil allowed

Set SSH password

Validations:

  • String
job_invocation[key_passphrase]
optional , nil allowed

Set SSH key passphrase

Validations:

  • String
job_invocation[recurrence]
optional , nil allowed

Create a recurring job

Validations:

  • Hash
job_invocation[recurrence][cron_line]
optional , nil allowed

How often the job should occur, in the cron format

Validations:

  • String
job_invocation[recurrence][max_iteration]
optional , nil allowed

Repeat a maximum of N times

Validations:

  • Must be a number.
job_invocation[recurrence][end_time]
optional , nil allowed

Perform no more executions after this time

Validations:

  • DateTime
job_invocation[recurrence][purpose]
optional , nil allowed

Designation of a special purpose

Validations:

  • String
job_invocation[scheduling]
optional , nil allowed

Schedule the job to start at a later time

Validations:

  • Hash
job_invocation[scheduling][start_at]
optional , nil allowed

Schedule the job for a future time

Validations:

  • DateTime
job_invocation[scheduling][start_before]
optional , nil allowed

Indicates that the action should be cancelled if it cannot be started before this time.

Validations:

  • DateTime
job_invocation[concurrency_control]
optional , nil allowed

Control concurrency level and distribution over time

Validations:

  • Hash
job_invocation[concurrency_control][concurrency_level]
optional , nil allowed

Run at most N tasks at a time

Validations:

  • Integer
job_invocation[bookmark_id]
optional , nil allowed

Validations:

  • Integer
job_invocation[search_query]
optional , nil allowed

Validations:

  • String
job_invocation[description_format]
optional , nil allowed

Override the description format from the template for this invocation only

Validations:

  • String
job_invocation[execution_timeout_interval]
optional , nil allowed

Override the timeout interval from the template for this invocation only

Validations:

  • Integer
job_invocation[feature]
optional , nil allowed

Remote execution feature label that should be triggered, job template assigned to this feature will be used

Validations:

  • String
job_invocation[time_to_pickup]
optional , nil allowed

Override the global time to pickup interval for this invocation only

Validations:

  • Integer
>>>

GET /api/job_invocations/:id/hosts/:host_id
Get output for a host

Examples

GET /api/job_invocations/34/hosts/19
200
{
  "complete": true,
  "refresh": false,
  "output": []
}

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..
host_id
required

Validations:

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

Validations:

  • String
>>>

GET /api/job_invocations/:id/hosts
List hosts belonging to job invocation

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
search
optional

filter results

Validations:

  • String
order
optional

Sort and order by a searchable field, e.g. '<field> DESC'

Validations:

  • String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, 'all' to return all results

Validations:

  • Must match regular expression /\A([1-9]\d*|all)\Z$/.
id
required

Validations:

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

Search fields

Field name Type Possible values
description string
ended_at datetime
host string
id integer
job_category string
owner string
pattern_template_name string
recurring true, false
recurring_logic.id integer
recurring_logic.purpose string
start_at datetime
started_at datetime
status succeeded, failed, queued, running, cancelled
targeted_host_id string
user string
>>>

GET /api/job_invocations/:id/hosts/:host_id/raw
Get raw output for a host

Examples

GET /api/job_invocations/281/hosts/183/raw
200
{
  "complete": false,
  "refresh": true,
  "output": null,
  "delayed": true,
  "start_at": "2025-05-15T15:26:31.428+00:00"
}

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..
host_id
required

Validations:

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

POST /api/job_invocations/:id/cancel
Cancel job invocation

Examples

POST /api/job_invocations/354/cancel
{
  "force": true,
  "job_invocation": {}
}
200
{
  "cancelled": true,
  "id": 354
}

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.
>>>

POST /api/job_invocations/:id/rerun
Rerun job on failed hosts

Examples

POST /api/job_invocations/360/rerun
{
  "job_invocation": {}
}
404
{
  "error": "Could not rerun job 360 because its template could not be found"
}

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..
failed_only
optional

Validations:

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

Validations:

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

GET /api/job_invocations/:id/outputs
Get outputs of hosts in a job

Examples

GET /api/job_invocations/123/outputs
200
{
  "outputs": [
    {
      "complete": true,
      "refresh": false,
      "output": [],
      "host_id": 84
    }
  ]
}

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..
search_query
optional

Validations:

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

Validations:

  • String
raw
optional

Validations:

  • String