Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-174040133.9 KB
Ports

Get port detail by port ID.

get/v1/ports/{id}

Path parameters

idstring required

Database ID created for a port.

Response

OK

idstring required
created_atstring date-time
updated_atstring date-time
namestring required
storage_idstring
native_port_idstring
native_parent_idstring
speedinteger
max_speedinteger
locationstring
connection_status'connected' | 'disconnected' | 'unknown'
health_status'normal' | 'abnormal' | 'unknown'
type'fc' | 'iscsi' | 'ficon' | 'fcoe' | 'eth' | 'sas' | 'ib' | 'other'
logical_type'frontend' | 'backend' | 'service' | 'management' | 'internal' | 'maintenance' | 'interconnect' | 'other'
wwnstring
mac_addressstring
ipv4string
ipv4_maskstring
ipv6string
ipv6_maskstring

Example response

{
  "id": "084bf71e-a102-11e7-88a8-e31fe6d52248",
  "created_at": "2017-07-10T14:36:58.014Z",
  "updated_at": "2017-07-10T14:36:58.014Z",
  "storage_id": "084bf71e-a102-11e7-88a8-e31fe6d52248",
  "native_port_id": "Port_A",
  "native_parent_id": "Controller_A"
}