GET /api/omaha_reports
List all omaha reports

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organisations

Validations:

  • Must be a Integer

search
optional

filter results

Validations:

  • Must be a String

order
optional

sort results

Validations:

  • Must be a String

page
optional

paginate results

Validations:

  • Must be a String

per_page
optional

number of entries per request

Validations:

  • Must be a String


GET /api/omaha_reports/:id
Show a omaha report

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organisations

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.


POST /api/omaha_reports
Create a omaha report

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organisations

Validations:

  • Must be a Integer

report
required

Validations:

  • Must be a Hash

report[host]
required

Hostname or certname

Validations:

  • Must be a String

report[status]
required

Omaha update status

Validations:

  • Must be one of: unknown, complete, downloading, downloaded, installed, instance_hold, error.

report[omaha_version]
required

Omaha OS version using semantic versioning, e.g. 1590.0.0

Validations:

  • Must be a String

report[machineid]
required

Unique machine id of the host

Validations:

  • Must be a String

report[omaha_group]
required

The uuid if the channel that the host is attached to. Use alpha, beta or stable for built-in channels.

Validations:

  • Must be a String

report[oem]
optional , nil allowed

OEM identifier

Validations:

  • Must be a String


DELETE /api/omaha_reports/:id
Delete a omaha report

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organisations

Validations:

  • Must be a Integer

id
required

Validations:

  • Must be a String


GET /api/hosts/:host_id/omaha_reports/last
Show the last report for a host

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organisations

Validations:

  • Must be a Integer

host_id
required

ID of host

Validations:

  • Must be a String

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.