GET /api/foreman_datacenter/connections
List all InterfaceConnections

GET /api/foreman_datacenter/device_intervace_connections
List all InterfaceConnections

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$/.


GET /api/foreman_datacenter/device_interface_connections/:id
Show a DeviceInterfaceConnecion

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/device_interfaces/:device_interface_id/device_interface_connections
Create a DeviceInterfaceConnection

Params

Param name Description
device_interface_connection
required

Validations:

  • Must be a Hash

device_interface_connection[name]
required

Validations:

  • Must be a String

device_interface_connection[interface_a]
optional , nil allowed

Interface A

Validations:

  • Must be a number.

device_interface_connection[interface_b]
optional , nil allowed

Interface B

Validations:

  • Must be a number.

device_interface_connection[connection_status]
optional , nil allowed

Connectin status

Validations:

  • Must be a number.


DELETE /api/foreman_datacenter/device_interface_connections/:id
Delete a DeviceInterfaceConnection

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.


PATCH /api/foreman_datacenter/device_interface_connections/:id/planned
Planned

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

Validations:

  • Must be a Hash

device_interface_connection[name]
optional

Validations:

  • Must be a String

device_interface_connection[interface_a]
optional , nil allowed

Interface A

Validations:

  • Must be a number.

device_interface_connection[interface_b]
optional , nil allowed

Interface B

Validations:

  • Must be a number.

device_interface_connection[connection_status]
optional , nil allowed

Connectin status

Validations:

  • Must be a number.


PATCH /api/foreman_datacenter/device_interface_connections/:id/connected
Connected

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

Validations:

  • Must be a Hash

device_interface_connection[name]
optional

Validations:

  • Must be a String

device_interface_connection[interface_a]
optional , nil allowed

Interface A

Validations:

  • Must be a number.

device_interface_connection[interface_b]
optional , nil allowed

Interface B

Validations:

  • Must be a number.

device_interface_connection[connection_status]
optional , nil allowed

Connectin status

Validations:

  • Must be a number.