GET /api/audits
List all audits

GET /api/hosts/:host_id/audits
List all audits for a given host

Examples

GET /api/audits?search=host%3Dhost761.example395.com&per_page=3
200
{
  "total": 2,
  "subtotal": 0,
  "page": 1,
  "per_page": 3,
  "search": "host=host761.example395.com",
  "sort": {
    "by": null,
    "order": null
  },
  "results": []
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
search
optional

filter results

Validations:

  • Must be a String
order
optional

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

Validations:

  • Must be a 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$/.

Search fields

Field name Type Possible values
action string
auditable_id integer
authored_by_user string
authored_by_user.id integer
changes text
comment string
host string
hostgroup string
hostgroup_title string
id integer
interface_fqdn string
interface_ip string
interface_mac string
location string
location_id integer
organization string
organization_id integer
os string
os_title string
parameter string
partition_table string
provisioning_template string
puppetclass
remote_address string
request_uuid string
setting string
time datetime
type setting, user, auth_source, compute_resource, host, interface, location, organization, os, override_value, parameter, partition_table, smart_class_parameter, subnet, provisioning_template
user string
username string