Audits

>>>

GET /api/audits
List all audits

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

Examples

GET /api/hosts/8/audits
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "user_id": 135138680,
      "user_type": null,
      "user_name": "secret_admin",
      "version": 1,
      "comment": null,
      "associated_id": null,
      "associated_type": null,
      "remote_address": null,
      "associated_name": null,
      "created_at": "2021-11-26 08:13:32 UTC",
      "request_uuid": "a521f8ce-1ec4-4546-9155-3390eb3058a1",
      "id": 980191011,
      "auditable_id": 8,
      "auditable_name": "host711.example449.com",
      "auditable_type": "Host::Base",
      "action": "update",
      "audited_changes": {
        "model_id": [
          null,
          980190962
        ],
        "grub_pass": [
          "$6$RefECqJTP79kSTcK$3fAywCR0YgxTuQ0jcZ/bQru2iOvUDehUxFlNKdwWDniw8IJbien5vLo5OebC4yEfN3hp7YhP62BK250VL1.Jp/",
          "$5$KObDE3nxfQhutV5p$MC0tKXveGTU7huuc8Yaz/bGZmWz9mftObl5pm6HMCJB"
        ]
      },
      "locations": [
        {
          "id": 255093256,
          "name": "Location 1",
          "title": "Location 1",
          "description": null
        }
      ],
      "organizations": [
        {
          "id": 447626438,
          "name": "Organization 1",
          "title": "Organization 1",
          "description": null
        }
      ]
    }
  ]
}

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. ‘id 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 operatingsystem, role, setting, ptable, provisioning_template, user, auth_source, compute_resource, host, interface, location, organization, os, override_value, parameter, partition_table, smart_class_parameter, subnet
user string
username string
>>>

GET /api/audits/:id
Show an audit

Examples

GET /api/audits/980190962
200
{
  "user_id": null,
  "user_type": null,
  "user_name": null,
  "version": 1,
  "comment": null,
  "associated_id": 272,
  "associated_type": "Host",
  "remote_address": null,
  "associated_name": null,
  "created_at": "2009-12-14 08:01:17 UTC",
  "request_uuid": null,
  "id": 980190962,
  "auditable_id": 980190962,
  "auditable_name": null,
  "auditable_type": "Host",
  "action": "update",
  "audited_changes": {
    "architecture_id": [
      10463,
      10466
    ]
  },
  "locations": [],
  "organizations": []
}

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
id
required

Validations:

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