GET /api/job_invocations
List job invocations

Params

Param Name Description
search
Optional

filter results

Validations:

  • Must be String

order
Optional

sort results

Validations:

  • Must be String

page
Optional

paginate results

Validations:

  • Must be String

per_page
Optional

number of entries per request

Validations:

  • Must be String


GET /api/job_invocations/:id
Show job invocation

Params

Param Name Description
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/job_invocations
Create a job invocation

Params

Param Name Description
job_invocation
Required

Validations:

  • Must be a Hash

job_invocation[job_template_id]
Required

The job template to use

Validations:

  • Must be String

job_invocation[targeting_type]
Required

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

Validations:

  • Must be String

job_invocation[inputs]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

Inputs to use

Validations:

  • Must be Hash

job_invocation[ssh]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

SSH provider specific options

Validations:

  • Must be a Hash

job_invocation[ssh][effective_user]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be String

job_invocation[recurrence]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

Create a recurring job

Validations:

  • Must be a Hash

job_invocation[recurrence][cron_line]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

How often the job should occur, in the cron format

Validations:

  • Must be String

job_invocation[recurrence][max_iteration]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

Repeat a maximum of N times

Validations:

  • Must be a number.

job_invocation[recurrence][end_time]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

Perform no more executions after this time

Validations:

  • Must be DateTime

job_invocation[scheduling]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

Schedule the job to start at a later time

Validations:

  • Must be a Hash

job_invocation[scheduling][start_at]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

Schedule the job for a future time

Validations:

  • Must be DateTime

job_invocation[scheduling][start_before]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be DateTime

job_invocation[concurrency_control]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

Control concurrency level and distribution over time

Validations:

  • Must be a Hash

job_invocation[concurrency_control][time_span]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

Distribute tasks over N seconds

Validations:

  • Must be Integer

job_invocation[concurrency_control][concurrency_level]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

Run at most N tasks at a time

Validations:

  • Must be Integer

job_invocation[bookmark_id]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be Integer

job_invocation[search_query]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be Integer

job_invocation[description_format]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

Override the description format from the template for this invocation only

Validations:

  • Must be String


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

Params

Param Name Description
id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

host_id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

since
Optional

Validations:

  • Must be String