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 , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Inputs to use Value: Must be Hash |
job_invocation[ssh] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
SSH provider specific options Value: Must be a Hash |
job_invocation[ssh][effective_user] Optional , <span class="translation_missing" title="translation missing: gl.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. Value: Must be String |
job_invocation[recurrence] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Create a recurring job Value: Must be a Hash |
job_invocation[recurrence][cron_line] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
How often the job should occur, in the cron format Value: Must be String |
job_invocation[recurrence][max_iteration] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Repeat a maximum of N times Value: Must be a number. |
job_invocation[recurrence][end_time] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Perform no more executions after this time Value: Must be DateTime |
job_invocation[scheduling] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Schedule the job to start at a later time Value: Must be a Hash |
job_invocation[scheduling][start_at] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Schedule the job for a future time Value: Must be DateTime |
job_invocation[scheduling][start_before] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Indicates that the action should be cancelled if it cannot be started before this time. Value: Must be DateTime |
job_invocation[concurrency_control] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Control concurrency level and distribution over time Value: Must be a Hash |
job_invocation[concurrency_control][time_span] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Distribute tasks over N seconds Value: Must be Integer |
job_invocation[concurrency_control][concurrency_level] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Run at most N tasks at a time Value: Must be Integer |
job_invocation[bookmark_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Value: Must be Integer |
job_invocation[search_query] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Value: Must be Integer |
job_invocation[description_format] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
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 |