GET /api/foreman_datacenter/devices
List all Devices

Params

Param name Description
search
optional

filter results

Validations:

  • Must be a String

order
optional

Sort field and order, eg. ‘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
comments
name
platform
rack
role
site
status active, offline
type

GET /api/foreman_datacenter/devices/:id
Show a Device

Params

Param name Description
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/foreman_datacenter/devices
Create a rack group

Params

Param name Description
device
required

Validations:

  • Must be a Hash

device[device_type_id]
optional , nil allowed

DeviceType ID

Validations:

  • Must be a number.

device[device_role_id]
optional , nil allowed

DeviceRole ID

Validations:

  • Must be a number.

device[platform_id]
optional , nil allowed

Platform ID

Validations:

  • Must be a number.

device[name]
required

Validations:

  • Must be a String

device[serial]
required

Validations:

  • Must be a String

device[rack_id]
optional , nil allowed

Rack ID

Validations:

  • Must be a number.

device[position]
required

Validations:

  • Must be a number.

device[face]
required

Validations:

  • Must be a number.

device[status]
required

Validations:

  • Must be a number.

device[primary_ip4]
required

Validations:

  • Must be a String

device[primary_ip6]
required

Validations:

  • Must be a String

device[host_id]
required

Validations:

  • Must be a number.

device[side]
required

Validations:

  • Must be a number.

device[size]
required

Validations:

  • Must be a number.

device[organization_id]
required

Validations:

  • Must be a number.

device[location_id]
required

Validations:

  • Must be a number.


PUT /api/foreman_datacenter/devices/:id
Update a rack group

Params

Param name Description
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.

device
required

Validations:

  • Must be a Hash

device[device_type_id]
optional , nil allowed

DeviceType ID

Validations:

  • Must be a number.

device[device_role_id]
optional , nil allowed

DeviceRole ID

Validations:

  • Must be a number.

device[platform_id]
optional , nil allowed

Platform ID

Validations:

  • Must be a number.

device[name]
optional

Validations:

  • Must be a String

device[serial]
optional

Validations:

  • Must be a String

device[rack_id]
optional , nil allowed

Rack ID

Validations:

  • Must be a number.

device[position]
optional

Validations:

  • Must be a number.

device[face]
optional

Validations:

  • Must be a number.

device[status]
optional

Validations:

  • Must be a number.

device[primary_ip4]
optional

Validations:

  • Must be a String

device[primary_ip6]
optional

Validations:

  • Must be a String

device[host_id]
optional

Validations:

  • Must be a number.

device[side]
optional

Validations:

  • Must be a number.

device[size]
optional

Validations:

  • Must be a number.

device[organization_id]
optional

Validations:

  • Must be a number.

device[location_id]
optional

Validations:

  • Must be a number.


DELETE /api/foreman_datacenter/devices/:id
Delete a rack group

Params

Param name Description
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.


DELETE /api/foreman_datacenter/devices/:id/destroy_interfaces
Destroy interfaces

Params

Param name Description
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.


GET /api/foreman_datacenter/devices/:id/sync_interfaces_with_host
Sync interfaces with host

Params

Param name Description
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.