Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Integer

search
optional

filter results

Validations:

  • String

order
optional

Sort and order by a searchable field, e.g. '<field> DESC'

Validations:

  • String

page
optional

Page number, starting at 1

Validations:

  • Must be a number.

per_page
optional

Number of results per page to return, 'all' to return all results

Validations:

  • Must match regular expression /\A([1-9]\d*|all)\Z$/.

id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

Search fields

Field name Type Possible values
description string
ended_at datetime
host string
id integer
job_category string
owner string
pattern_template_name string
recurring true, false
recurring_logic.id integer
recurring_logic.purpose string
start_at datetime
started_at datetime
status succeeded, failed, queued, running, cancelled
targeted_host_id string
user string