NetworksInDeviceResource


List networks defined for a device


Get the networks defined for a given device. Cannot include private networks

GET https://example.com/api/cloud/locations/{location}/devices/{device}/networks

Roles : [ROLE_PHYS_DC_RETRIEVE_DETAILS, ROLE_VDC_ENUMERATE]

Parameter Type Default Value Description
startwith Integer 0 The first element to be retrieved of the filtered search
limit Integer 25 The number of entities to retrieve
has String If present filter to apply in the search.
by String Order by
asc boolean true If the value of the 'by' parameter must be sorted in ascending order (true) or descending order (false)
type String Comma separated values of network types {@link NetworkType} to include in the response. (Cannot specify INTERNAL (private networks))

Accept : vlans

Example

Get a network defined for a device


Return a network defined for a device. Cannot return private network

GET https://example.com/api/cloud/locations/{location}/devices/{device}/networks/{network}

Roles : [ROLE_PHYS_DC_RETRIEVE_DETAILS, ROLE_VDC_ENUMERATE]

Accept : vlan

Error Codes

  • NETDEVICE-1 - The device does not exist

Example

Get the configuration of a network defined for a device


Return the configuration of a network defined for a device.

GET https://example.com/api/cloud/locations/{location}/devices/{device}/networks/{network}/configuration

Roles : [ROLE_PHYS_DC_RETRIEVE_DETAILS, ROLE_VDC_ENUMERATE]

Example

Get a network configuration definded for a device


Return the configuration of a network defined for a device.

GET https://example.com/api/cloud/locations/{location}/devices/{device}/networks/{network}/configuration/{configuration}

Roles : [ROLE_PHYS_DC_RETRIEVE_DETAILS, ROLE_VDC_ENUMERATE]

Example