POST /api/job_invocations
Create a job invocation

Examples

POST /api/job_invocations
{
  "job_invocation": {
    "job_category": "Job name 14",
    "name": "RandomName",
    "job_template_id": 1007981748,
    "targeting_type": "static_query",
    "search_query": "foobar",
    "recurrence": {
      "cron_line": "5 * * * *"
    }
  }
}
201
{
  "id": 21,
  "description": "Job template 16 with inputs Template input 8=\"''\"",
  "job_category": "Job name 14",
  "targeting_id": 23,
  "status": 2,
  "start_at": "2025-02-24 15:05:00 UTC",
  "status_label": "queued",
  "ssh_user": null,
  "time_to_pickup": null,
  "concurrency_level": null,
  "execution_timeout_interval": null,
  "dynflow_task": {
    "id": "041b3496-ec53-4f9e-92ba-e285153c8c21",
    "state": "scheduled"
  },
  "template_id": 1007981748,
  "template_name": "Job template 16",
  "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": "041b3496-ec53-4f9e-92ba-e285153c8c21",
    "state": "scheduled"
  },
  "mode": "recurring",
  "recurrence": {
    "id": 1,
    "cron_line": "5 * * * *",
    "end_time": null,
    "iteration": 1,
    "task_group_id": 8,
    "state": "active",
    "max_iteration": null,
    "purpose": null,
    "task_count": 1,
    "action": "Run hosts job:",
    "last_occurence": null,
    "next_occurence": "2025-02-24 15: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
job_invocation[ansible]
optional , nil allowed

Ansible provider specific inputs

Validations:

  • Hash
job_invocation[ansible][tags]
optional , nil allowed

A comma separated list of tags to use for Ansible run

Validations:

  • String
job_invocation[ansible][tags_flag]
optional , nil allowed

IncludeExclude tags for Ansible run

Validations:

  • Must be one of: include, exclude.