Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

host_id
optional

ID of host

Validations:

  • String

hostgroup_id
optional

ID of host group

Validations:

  • String

environment_id
optional

ID of environment

Validations:

  • String

search
optional

filter results

Validations:

  • String

order
optional

Sort field and order, eg. ‘id 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

Validations:

  • Must be a number.

Search fields

Field name Type Possible values
config_group string
environment string
host string
hostgroup string
key string
location string
name string
organization string