GET /api/job_invocations
List job invocations

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

search
opcjonalny

rezultat filtrowania

Validations:

  • Must be a String

order
opcjonalny

rezultat sortowania

Validations:

  • Must be a String

page
opcjonalny

rezultat paginacji

Validations:

  • Must be a String

per_page
opcjonalny

Liczba wpisów na jedno żądanie

Validations:

  • Must be a String


GET /api/job_invocations/:id
Show job invocation

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

id
wymagany

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

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

job_invocation
wymagany

Validations:

  • Must be a Hash

job_invocation[job_template_id]
opcjonalny , nil dopuszczalny

The job template to use, parameter is required unless feature was specified

Validations:

  • Must be a String

job_invocation[targeting_type]
wymagany

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

Validations:

  • Must be a String

job_invocation[inputs]
opcjonalny , nil dopuszczalny

Inputs to use

Validations:

  • Must be a Hash

job_invocation[ssh]
opcjonalny , nil dopuszczalny

SSH provider specific options

Validations:

  • Must be a Hash

job_invocation[ssh][effective_user]
opcjonalny , nil dopuszczalny

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

Validations:

  • Must be a String

job_invocation[recurrence]
opcjonalny , nil dopuszczalny

Create a recurring job

Validations:

  • Must be a Hash

job_invocation[recurrence][cron_line]
opcjonalny , nil dopuszczalny

How often the job should occur, in the cron format

Validations:

  • Must be a String

job_invocation[recurrence][max_iteration]
opcjonalny , nil dopuszczalny

Repeat a maximum of N times

Validations:

  • Must be a number.

job_invocation[recurrence][end_time]
opcjonalny , nil dopuszczalny

Perform no more executions after this time

Validations:

  • Must be a DateTime

job_invocation[scheduling]
opcjonalny , nil dopuszczalny

Schedule the job to start at a later time

Validations:

  • Must be a Hash

job_invocation[scheduling][start_at]
opcjonalny , nil dopuszczalny

Schedule the job for a future time

Validations:

  • Must be a DateTime

job_invocation[scheduling][start_before]
opcjonalny , nil dopuszczalny

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

Validations:

  • Must be a DateTime

job_invocation[concurrency_control]
opcjonalny , nil dopuszczalny

Control concurrency level and distribution over time

Validations:

  • Must be a Hash

job_invocation[concurrency_control][time_span]
opcjonalny , nil dopuszczalny

Distribute tasks over N seconds

Validations:

  • Must be a Integer

job_invocation[concurrency_control][concurrency_level]
opcjonalny , nil dopuszczalny

Run at most N tasks at a time

Validations:

  • Must be a Integer

job_invocation[bookmark_id]
opcjonalny , nil dopuszczalny

Validations:

  • Must be a Integer

job_invocation[search_query]
opcjonalny , nil dopuszczalny

Validations:

  • Must be a String

job_invocation[description_format]
opcjonalny , nil dopuszczalny

Override the description format from the template for this invocation only

Validations:

  • Must be a String

job_invocation[execution_timeout_interval]
opcjonalny , nil dopuszczalny

Override the timeout interval from the template for this invocation only

Validations:

  • Must be a Integer

job_invocation[feature]
opcjonalny , nil dopuszczalny

Remote execution feature label that should be triggered, job template assigned to this feature will be used

Validations:

  • Must be a String


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

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

id
wymagany

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
wymagany

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
opcjonalny

Validations:

  • Must be a String


POST /api/job_invocations/:id/cancel
Cancel job invocation

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

id
wymagany

Validations:

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

force
opcjonalny

Validations:

  • Must be one of: true, false, 1, 0


POST /api/job_invocations/:id/rerun
Rerun job on failed hosts

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

id
wymagany

Validations:

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

failed_only
opcjonalny

Validations:

  • Must be one of: true, false, 1, 0