GET /api/job_invocations
List job invocations

參數

參數名字 描述
search
選填

篩選結果


Value:

Must be String

order
選填

排序結果


Value:

Must be String

page
選填

編頁結果


Value:

Must be String

per_page
選填

每個請求的項目數量


Value:

Must be String


GET /api/job_invocations/:id
Show job invocation

參數

參數名字 描述
id
必填

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

參數

參數名字 描述
job_invocation
必填

Value:

Must be a Hash

job_invocation[job_template_id]
必填

The job template to use


Value:

Must be String

job_invocation[targeting_type]
必填

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


Value:

Must be String

job_invocation[inputs]
選填 , 允許空值

Inputs to use


Value:

Must be Hash

job_invocation[ssh]
選填 , 允許空值

SSH provider specific options


Value:

Must be a Hash

job_invocation[ssh][effective_user]
選填 , 允許空值

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]
選填 , 允許空值

Create a recurring job


Value:

Must be a Hash

job_invocation[recurrence][cron_line]
選填 , 允許空值

How often the job should occur, in the cron format


Value:

Must be String

job_invocation[recurrence][max_iteration]
選填 , 允許空值

Repeat a maximum of N times


Value:

Must be a number.

job_invocation[recurrence][end_time]
選填 , 允許空值

Perform no more executions after this time


Value:

Must be DateTime

job_invocation[scheduling]
選填 , 允許空值

Schedule the job to start at a later time


Value:

Must be a Hash

job_invocation[scheduling][start_at]
選填 , 允許空值

Schedule the job for a future time


Value:

Must be DateTime

job_invocation[scheduling][start_before]
選填 , 允許空值

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


Value:

Must be DateTime

job_invocation[concurrency_control]
選填 , 允許空值

Control concurrency level and distribution over time


Value:

Must be a Hash

job_invocation[concurrency_control][time_span]
選填 , 允許空值

Distribute tasks over N seconds


Value:

Must be Integer

job_invocation[concurrency_control][concurrency_level]
選填 , 允許空值

Run at most N tasks at a time


Value:

Must be Integer

job_invocation[bookmark_id]
選填 , 允許空值

Value:

Must be Integer

job_invocation[search_query]
選填 , 允許空值

Value:

Must be Integer

job_invocation[description_format]
選填 , 允許空值

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

參數

參數名字 描述
id
必填

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
必填

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
選填

Value:

Must be String