GET /api/job_invocations
List job invocations

Parâmentros

Nome parâmetro Descrição
search
opcional

filtrar resultados


Value:

Must be String

order
opcional

ordenar resultados


Value:

Must be String

page
opcional

paginar resultados


Value:

Must be String

per_page
opcional

número de entradas por requisições


Value:

Must be String


GET /api/job_invocations/:id
Show job invocation

Parâmentros

Nome parâmetro Descrição
id
requerido

Value:

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

Parâmentros

Nome parâmetro Descrição
job_invocation
requerido

Value:

Must be a Hash

job_invocation[job_template_id]
requerido

The job template to use


Value:

Must be String

job_invocation[targeting_type]
requerido

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


Value:

Must be String

job_invocation[inputs]
opcional , nulo permitido

Inputs to use


Value:

Must be Hash

job_invocation[ssh]
opcional , nulo permitido

SSH provider specific options


Value:

Must be a Hash

job_invocation[ssh][effective_user]
opcional , nulo permitido

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


Value:

Must be String

job_invocation[recurrence]
opcional , nulo permitido

Create a recurring job


Value:

Must be a Hash

job_invocation[recurrence][cron_line]
opcional , nulo permitido

How often the job should occur, in the cron format


Value:

Must be String

job_invocation[recurrence][max_iteration]
opcional , nulo permitido

Repeat a maximum of N times


Value:

Must be a number.

job_invocation[recurrence][end_time]
opcional , nulo permitido

Perform no more executions after this time


Value:

Must be DateTime

job_invocation[scheduling]
opcional , nulo permitido

Schedule the job to start at a later time


Value:

Must be a Hash

job_invocation[scheduling][start_at]
opcional , nulo permitido

Schedule the job for a future time


Value:

Must be DateTime

job_invocation[scheduling][start_before]
opcional , nulo permitido

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


Value:

Must be DateTime

job_invocation[concurrency_control]
opcional , nulo permitido

Control concurrency level and distribution over time


Value:

Must be a Hash

job_invocation[concurrency_control][time_span]
opcional , nulo permitido

Distribute tasks over N seconds


Value:

Must be Integer

job_invocation[concurrency_control][concurrency_level]
opcional , nulo permitido

Run at most N tasks at a time


Value:

Must be Integer

job_invocation[bookmark_id]
opcional , nulo permitido

Value:

Must be Integer

job_invocation[search_query]
opcional , nulo permitido

Value:

Must be Integer

job_invocation[description_format]
opcional , nulo permitido

Override the description format from the template for this invocation only


Value:

Must be String


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

Parâmentros

Nome parâmetro Descrição
id
requerido

Value:

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
requerido

Value:

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

since
opcional

Value:

Must be String