Param name | Description |
---|---|
search optional |
filter results Value: Must be String |
order optional |
sort results Value: Must be String |
page optional |
paginate results Value: Must be String |
per_page optional |
number of entries per request Value: Must be String |
Param name | Description |
---|---|
id required |
Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space. |
Param name | Description |
---|---|
job_invocation required |
Value: Must be a Hash |
job_invocation[job_template_id] required |
The job template to use Value: Must be String |
job_invocation[targeting_type] required |
Invocation type, one of {“static_query”=>“Static Query”, “dynamic_query”=>“Dynamic Query”} Value: Must be String |
job_invocation[inputs] optional , nil allowed |
Inputs to use Value: Must be Hash |
job_invocation[ssh] optional , nil allowed |
SSH provider specific options Value: Must be a 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. Value: Must be String |
job_invocation[recurrence] optional , nil allowed |
Create a recurring job Value: Must be a Hash |
job_invocation[recurrence][cron_line] optional , nil allowed |
How often the job should occur, in the cron format Value: Must be String |
job_invocation[recurrence][max_iteration] optional , nil allowed |
Repeat a maximum of N times Value: Must be a number. |
job_invocation[recurrence][end_time] optional , nil allowed |
Perform no more executions after this time Value: Must be DateTime |
job_invocation[scheduling] optional , nil allowed |
Schedule the job to start at a later time Value: Must be a Hash |
job_invocation[scheduling][start_at] optional , nil allowed |
Schedule the job for a future time Value: Must be DateTime |
job_invocation[scheduling][start_before] optional , nil allowed |
Indicates that the action should be cancelled if it cannot be started before this time. Value: Must be DateTime |
job_invocation[concurrency_control] optional , nil allowed |
Control concurrency level and distribution over time Value: Must be a Hash |
job_invocation[concurrency_control][time_span] optional , nil allowed |
Distribute tasks over N seconds Value: Must be Integer |
job_invocation[concurrency_control][concurrency_level] optional , nil allowed |
Run at most N tasks at a time Value: Must be Integer |
job_invocation[bookmark_id] optional , nil allowed |
Value: Must be Integer |
job_invocation[search_query] optional , nil allowed |
Value: Must be Integer |
job_invocation[description_format] optional , nil allowed |
Override the description format from the template for this invocation only Value: Must be String |
Param name | Description |
---|---|
id required |
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 required |
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 optional |
Value: Must be String |