Equinix Fabric API v4 | Equinix Product Documentation

Get Network By ID

Request

This API provides capability to retrieve user's Fabric Network

Security

BearerAuth

Path

networkIdstring, (uuid)required

Network UUID

Example:557400f8-d360-11e9-bb65-2a2ae2dbcce4

Payload

// No request payload

Responses

Fabric Network Access point object

Bodyapplication/json

hrefstring, (uri)read-onlyrequired

Network URI

Example:"https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784"

uuidstring, (uuid)required

Equinix-assigned network identifier

Example:"92dc376a-a932-43aa-a6a2-c806dedbd784"

statestring(NetworkState)required

Network status

Enum:"ACTIVE""INACTIVE""DELETED"

Example:"ACTIVE"

connectionsCountnumber

number of connections created on the network

accountobject(SimplifiedAccount)

changeobject(SimplifiedNetworkChange)

Current state of latest network change

operationobject(NetworkOperation)

Network operational data

changeLogobject(Changelog)required

Change log

linksArray of objects(Link)read-only

Network sub-resources links

typestring(NetworkType)required

Network type

Enum:"EVPLAN""EPLAN""IPWAN""EVPTREE""EPTREE"

namestringrequired

Customer-provided network name

scopestring(NetworkScope)required

Network scope

Enum:"REGIONAL""GLOBAL""LOCAL"

locationobject(SimplifiedLocation)

projectobject(Project)

notificationsArray of objects(SimplifiedNotification)required

Preferences for notifications on network configuration or status changes

Response

{
  "href": "https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784",
  "type": "EVPLAN",
  "uuid": "92dc376a-a932-43aa-a6a2-c806dedbd784",
  "name": "My-EVPLAN-1",
  "state": "ACTIVE",
  "location": {
    "region": "EMEA"
  },
  "scope": "REGIONAL",
  "connectionsCount": 0,
  "project": {
    "projectId": "123456"
  },
  "notifications": [
    { … }
  ],
  "operation": {
    "equinixStatus": "PROVISIONED"
  },
  "changeLog": {
    "createdBy": "testuser",
    "createdDateTime": "2020-05-21T10:30:00Z",
    "updatedBy": "testuser",
    "updatedDateTime": "2020-05-21T10:30:00Z"
  },
  "links": [
    { … }
  ]
}