Skip to main content
Loading...

API docs by

Create Network

Request

This API provides capability to create user's Fabric Network

Security
BearerAuth
Query
dryRunboolean

option to verify that API calls will succeed

Default:false
Bodyapplication/jsonrequired
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

Payload
{
  "type": "EVPLAN",
  "name": "My-Network-1",
  "scope": "GLOBAL",
  "project": {
    "projectId": "d64fa54a-cfcb-4fb0-82ee-86cf47007fa2"
  },
  "notifications": [
    { … }
  ]
}

Responses

Successful operation

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

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": "http://api.corp.equinix.com/fabric/v4/networks/0633e83f-116f-481d-b86f-c472271d1a8c",
  "uuid": "0633e83f-116f-481d-b86f-c472271d1a8c",
  "type": "EVPLAN",
  "name": "My-evplan-network-1",
  "scope": "GLOBAL",
  "state": "INACTIVE",
  "connectionsCount": 0,
  "account": {
    "orgId": 14510,
    "organizationName": "fabric",
    "globalCustId": "0026u00000595sBAAM"
  },
  "change": {
    "href": "http://api.corp.equinix.com/fabric/v4/networks/0633e83f-116f-481d-b86f-c472271d1a8c/changes/ce7c0bbc-7bd2-431f-903f-de796ea9e858",
    "uuid": "ce7c0bbc-7bd2-431f-903f-de796ea9e858",
    "type": "NETWORK_CREATION"
  },
  "operation": {
    "equinixStatus": "PROVISIONING"
  },
  "changeLog": {
    "createdBy": "fabric",
    "createdDateTime": "2025-03-03T19:37:29.326Z"
  },
  "links": [
    { … }
  ],
  "project": {
    "projectId": "d64fa54a-cfcb-4fb0-82ee-86cf47007fa2"
  },
  "notifications": [
    { … }
  ]
}
Was this page helpful?