GET /api/job_invocations
List job invocations

Parameter

Parametername Beschreibung
search
optional

Ergebnisse filtern

Validations:

  • Must be String

order
optional

Ergebnisse sortieren

Validations:

  • Must be String

page
optional

Ergebnisse nummerieren

Validations:

  • Must be String

per_page
optional

Anzahl der Einträge pro Anfrage

Validations:

  • Must be String


GET /api/job_invocations/:id
Show job invocation

Parameter

Parametername Beschreibung
id
verpflichtend

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

Parameter

Parametername Beschreibung
job_invocation
verpflichtend

Validations:

  • Must be a Hash

job_invocation[job_template_id]
verpflichtend

The job template to use

Validations:

  • Must be String

job_invocation[targeting_type]
verpflichtend

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

Validations:

  • Must be String

job_invocation[inputs]
optional , nil erlaubt

Inputs to use

Validations:

  • Must be Hash

job_invocation[ssh]
optional , nil erlaubt

SSH provider specific options

Validations:

  • Must be a Hash

job_invocation[ssh][effective_user]
optional , nil erlaubt

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 , nil erlaubt

Create a recurring job

Validations:

  • Must be a Hash

job_invocation[recurrence][cron_line]
optional , nil erlaubt

How often the job should occur, in the cron format

Validations:

  • Must be String

job_invocation[recurrence][max_iteration]
optional , nil erlaubt

Repeat a maximum of N times

Validations:

  • Must be a number.

job_invocation[recurrence][end_time]
optional , nil erlaubt

Perform no more executions after this time

Validations:

  • Must be DateTime

job_invocation[scheduling]
optional , nil erlaubt

Schedule the job to start at a later time

Validations:

  • Must be a Hash

job_invocation[scheduling][start_at]
optional , nil erlaubt

Schedule the job for a future time

Validations:

  • Must be DateTime

job_invocation[scheduling][start_before]
optional , nil erlaubt

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

Validations:

  • Must be DateTime

job_invocation[concurrency_control]
optional , nil erlaubt

Control concurrency level and distribution over time

Validations:

  • Must be a Hash

job_invocation[concurrency_control][time_span]
optional , nil erlaubt

Distribute tasks over N seconds

Validations:

  • Must be Integer

job_invocation[concurrency_control][concurrency_level]
optional , nil erlaubt

Run at most N tasks at a time

Validations:

  • Must be Integer

job_invocation[bookmark_id]
optional , nil erlaubt

Validations:

  • Must be Integer

job_invocation[search_query]
optional , nil erlaubt

Validations:

  • Must be Integer

job_invocation[description_format]
optional , nil erlaubt

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

Parameter

Parametername Beschreibung
id
verpflichtend

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
verpflichtend

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