Equinix Fabric API v4 | Equinix Product Documentation

Attach Network Edge Device Interfaces

Request

This API provides capability to attach a Network Edge Device and its interfaces to a stream. The provided interfaces list is the complete desired set: interfaces not in the list are detached, new interfaces are attached. An empty or absent interfaces list detaches all currently attached interfaces. metricsEnabled must be true when interfaces are provided.

Security

BearerAuth

Path

streamIdstring, (uuid)required

Stream UUID

Example:657400f8-d360-11e9-bb65-2a2ae2dbcce5

deviceIdstring, (uuid)required

Network Edge Device UUID

Example:8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d

Bodyapplication/jsonrequired

metricsEnabledboolean

enable metric. Must be true when interfaces are provided

Default:false

Example:true

interfacesArray of objects(StreamDeviceInterfaceRequest)

Complete desired set of Network Edge Device interfaces attached to the stream. Interfaces not in the list are detached; an empty or absent list detaches all interfaces.

Payload

{
  "metricsEnabled": true,
  "interfaces": [
    { … },
    { … }
  ]
}

Responses

Stream Network Edge Device asset object

Bodyapplication/json

hrefstring, (uri)read-only

Stream Asset URI

uuidstring, (uuid)

Equinix-assigned access point identifier

Example:"c9b8e7a2-f3b1-4576-a4a9-1366a63df170"

typestring

Asset types

Enum:"XF_PORT""IP_VC""EVPLAN_VC""EVPL_VC""XF_METRO""XF_ROUTER""ORGANIZATION""PROJECT""VIRTUAL_DEVICE""DATA"

metricsEnabledboolean

enable metric

Example:false

attachmentStatusstring

asset status

Enum:"ATTACHING""ATTACHED""DETACHED""DETACHING""FAILED"

Response

{
  "href": "https://api.equinix.com/fabric/v4/streams/e684aa26-8276-48b7-bb42-a6d9def0a419/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d",
  "uuid": "8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d",
  "type": "VIRTUAL_DEVICE",
  "metricsEnabled": true,
  "attachmentStatus": "ATTACHING",
  "interfaces": [
    { … },
    { … }
  ]
}