Equinix Fabric API v4 (4.34.0)

Download OpenAPI specification:Download

URL: https://docs.equinix.com/api-support.htm License: Equinix Inc Terms of Service

Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1. Cloud Service Providers - Clouds, network and other service providers.
2. Enterprises - Other Equinix customers, vendors and partners.
3. Myself - Another customer instance deployed at Equinix.

Integrations (SDKs, Tools) links:
Fabric Java SDK
Fabric Go SDK
Fabric Python SDK
Equinix Terraform Provider
Fabric Terraform Modules
Equinix Pulumi Provider

Find more information on Equinix Developer Portal

Ports

Get All Ports

Get All Ports returns details of all assigned and available ports for the specified user credentials. The metro attribute in the response shows the origin of the proposed connection

Authorizations:

BearerAuth

query Parameters

name	string port name to be provided if specific port(s) to be retrieved

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (Port)

GET All User Port Across Fabric Metros

Array

href	string <uri> Equinix assigned response attribute for an absolute URL that is the subject of the link's context.
type	string (PortType) Value: "XF_PORT" Type of Port
uuid	string <uuid> Equinix assigned response attribute for port identifier
name	string Equinix assigned response attribute for Port name
description	string Equinix assigned response attribute for Port description
physicalPortsSpeed	integer >= 0 Physical Ports Speed in Mbps
connectionsCount	integer >= 0 Equinix assigned response attribute for Connection count
physicalPortsType	string Enum: "1000BASE_LX" "10GBASE_LR" "100GBASE_LR4" "10GBASE_ER" "1000BASE_SX" "10GBASE_SMF" "400GBASE_LR4" Physical Ports Type. 10GBASE_SMF and 400GBASE_LR4 are only used for IX ports
physicalPortsCount	integer
connectivitySourceType	string Enum: "COLO" "BMMR" "REMOTE" Port connectivity type
bmmrType	string Enum: "SELF" "EQUINIX"
	object (Project)
state	string (PortState) Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PENDING_CROSS_CONNECT" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED" Port lifecycle state
	object (PortOrder)
	object Operational specifications for ports.
	object (SimplifiedAccount)
	object (PortChange) Current state of latest port change
	object (Changelog) Change log
serviceType	string Deprecated Enum: "EPL" "MSP" Port service Type
serviceCode	string (PortServiceCode) Enum: "CX" "IX" "IA" "MC" Identifies the service type associated with this port
bandwidth	integer >= 0 Deprecated Equinix assigned response attribute for Port bandwidth in Mbps
availableBandwidth	integer >= 0 Equinix assigned response attribute for Port available bandwidth in Mbps
usedBandwidth	integer >= 0 Equinix assigned response attribute for Port used bandwidth in Mbps
	object (SimplifiedLocation)
	object (PortDevice) Port device
	object (PortInterface) Port interface
demarcationPointIbx	string A-side/Equinix ibx
tetherIbx	string z-side/Equinix ibx
	object (PortDemarcationPoint) Customer physical Port
	object (PortRedundancy) Port redundancy configuration
	object (PortEncapsulation) Port encapsulation configuration
lagEnabled	boolean If LAG enabled
	object Deprecated Port Lag
asn	integer Port ASN
	object (Package) Package settings for port
	object (PortSettings) Port configuration settings
physicalPortQuantity	integer Number of physical ports
	Array of objects (PortNotification) Notification preferences
	Array of objects (PortAdditionalInfo) Port additional information
	Array of objects (PhysicalPort) Physical ports that implement this port
	Array of objects (PortLoa) Port Loas
	object (marketplaceSubscription) Equinix Fabric Entity for Marketplace Subscription

Response samples

200
400
401
403
500

Content type

application/json

{"pagination": {"offset": 0,
"limit": 1000,
"total": 2
},
"data": [{"href": "https://api.equinix.com/fabric/v4/ports/c4d93b39-02db-2dbc-ace0-30fa5c00ad04",
"type": "XF_PORT",
"uuid": "c4d93b39-02db-2dbc-ace0-30fa5c00ad04",
"name": "gen-l2-qa-01-auto-TY4-L-Qinq-STD-SEC-10G-JUN-598",
"physicalPortsSpeed": 10000,
"physicalPortsType": "10GBASE_LR",
"connectivitySourceType": "COLO",
"project": {"projectId": "333cd592-1709-4238-bb0d-2c2b41896aa1"
},
"package": {"code": "STANDARD"
},
"state": "REPROVISIONING",
"cvpId": "1616554",
"operation": {"connectionCount": 0,
"evplVCCount": 0,
"accessVCCount": 0
},
"account": {"accountNumber": 200559,
"accountName": "gen-l2-qa-01-auto-200559",
"orgId": 90946,
"organizationName": "gen-l2-qa-01-auto-200551.",
"ucmId": "500DFED2-EBDB-480d-896C-C7870E52D0D8",
"globalCustId": "0017i000011X242AAC"
},
"changeLog": {"createdBy": "vvyugovskiy-IMPORT_JOB",
"createdDateTime": "2021-06-16T01:46:52Z",
"updatedBy": "Order-to-activation",
"updatedDateTime": "2025-04-07T23:03:08.900Z"
},
"bandwidth": 10000,
"availableBandwidth": 10000,
"usedBandwidth": 0,
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/TY",
"region": "APAC",
"metroName": "Tokyo",
"metroCode": "TY",
"ibx": "TY4"
},
"device": {"name": "sit-tb1-ty-a2.lab",
"redundancy": {"priority": "SECONDARY"
}
},
"demarcationPointIbx": "TY4",
"tetherIbx": "TY4",
"redundancy": {"priority": "SECONDARY"
},
"encapsulation": {"type": "QINQ",
"tagProtocolId": "0x9100"
},
"lagEnabled": false,
"settings": {"buyout": false
},
"physicalPorts": [{"type": "XF_PHYSICAL_PORT",
"id": 1362185,
"state": "TO_BE_ADDED",
"uuid": "01892489-ce9b-7f25-b1f5-d32a5ac6a423",
"tether": {"crossConnectId": "ECX.05.00001836",
"cabinetNumber": "Demarc",
"systemName": "TY4:01:002181",
"patchPanel": "PP:1240:1089399",
"patchPanelPortA": "7",
"patchPanelPortB": "8",
"ibx": "TY4"
},
"demarcationPoint": {"patchPanel": "PP:Demarc:00002181",
"patchPanelName": "PP:Demarc:00002181",
"patchPanelPortA": "5",
"patchPanelPortB": "6",
"ibx": "TY4"
},
"operation": {"operationalStatus": "UP"
}
}
]
},
{"href": "https://api.equinix.com/fabric/v4/ports/6f0f3015-2d51-4b6e-a98c-1defb4fe88f1",
"type": "XF_PORT",
"uuid": "6f0f3015-2d51-4b6e-a98c-1defb4fe88f1",
"name": "200558-SY4-CX-PRI-02",
"physicalPortsSpeed": 10000,
"physicalPortsType": "10GBASE_LR",
"project": {"projectId": "333cd592-1709-4238-bb0d-2c2b41896aa1"
},
"package": {"code": "STANDARD"
},
"state": "ACTIVE",
"cvpId": "2000348",
"operation": {"connectionCount": 1,
"evplVCCount": 1,
"accessVCCount": 0,
"maintenanceStatus": "SCHEDULED",
"lockEnabled": true
},
"account": {"accountNumber": 200558,
"accountName": "Gen-L2-Qa-01-Auto-200558",
"orgId": 90946,
"organizationName": "gen-l2-qa-01-auto-200551.",
"ucmId": "2D26D682-B62E-495d-AFDF-698EC3B353F8",
"globalCustId": "0017i000011X242AAC"
},
"changeLog": {"createdDateTime": "2025-05-06T17:29:30.800Z",
"updatedBy": "API",
"updatedDateTime": "2025-05-06T17:29:40.300Z"
},
"bandwidth": 10000,
"availableBandwidth": 9500,
"usedBandwidth": 500,
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/SY",
"region": "APAC",
"metroName": "Sydney",
"metroCode": "SY",
"ibx": "SY4"
},
"device": {"name": "sit-tb1-sy-e1.lab",
"redundancy": {"group": "1",
"priority": "PRIMARY"
}
},
"demarcationPointIbx": "SY4",
"tetherIbx": "SY4",
"redundancy": {"priority": "PRIMARY"
},
"encapsulation": {"type": "DOT1Q",
"tagProtocolId": "0x8100"
},
"lagEnabled": true,
"settings": {"buyout": false
},
"physicalPorts": [{"type": "XF_PHYSICAL_PORT",
"id": 1362737,
"state": "ACTIVE",
"uuid": "01892489-ce07-7962-b676-b1a4d8091515",
"tether": {"crossConnectId": "22035616",
"cabinetNumber": "Demarc",
"systemName": "SY4:01:002204",
"patchPanel": "PP:1240:1089399",
"patchPanelPortA": "12",
"patchPanelPortB": "14",
"ibx": "SY4"
},
"demarcationPoint": {"patchPanel": "PP:Demarc:00002204",
"patchPanelName": "PP:Demarc:00002204",
"patchPanelPortA": "17",
"patchPanelPortB": "18",
"ibx": "SY4"
},
"operation": {"operationalStatus": "UP"
}
}
]
}
]
}

Create Port

Creates Equinix Fabric™ Port

Authorizations:

BearerAuth

query Parameters

dryRun

boolean

Default: false

option to verify that API calls will succeed

Request Body schema: application/json
required

type

required

string (PortType)

Value: "XF_PORT"

Type of Port

physicalPortsSpeed

required

integer >= 0

Physical Ports Speed in Mbps

physicalPortsType

required

string

Enum: "1000BASE_LX" "10GBASE_LR" "100GBASE_LR4" "10GBASE_ER" "1000BASE_SX" "10GBASE_SMF" "400GBASE_LR4"

Physical Ports Type. 10GBASE_SMF is only applicable for IX ports

physicalPortsCount

integer

connectivitySourceType

required

string

Enum: "COLO" "BMMR" "REMOTE"

Port connectivity type

bmmrType

string

Enum: "SELF" "EQUINIX"

BMMR Type is mandatory when connectivitySourceType is BMMR

required

object (Project)

projectId

required

string

Subscriber-assigned project ID

object (PortOrder)

object (PortOrderPurchaseOrder)

Purchase Order information associate to the account

number	string purchase order number
amount	string purchase order amount
startDate	string
endDate	string
attachmentId	string <uuid>
selectionType	string Deprecated Enum: "EXEMPTION" "EXISTING" "NEW" "BLANKET"
type	string Enum: "EXEMPTION" "EXISTING" "NEW" "BLANKET"

customerReferenceId

string

Customer order reference Id

object (PortOrderSignature)

Port signature details

signatory	string Enum: "DELEGATE" "SELF" "ACCOUNT_SUPPORT" Port signature Type
	object (PortOrderSignatureDelegate) order delegate details

required

object (SimplifiedAccountRequest)

accountNumber

required

integer <int64>

Account number

serviceType

string

Deprecated

Enum: "EPL" "MSP"

Port service Type

serviceCode

string (PortServiceCode)

Enum: "CX" "IX" "IA" "MC"

Identifies the service type associated with this port

bandwidth

integer >= 0

Deprecated

Equinix assigned response attribute for Port bandwidth in Mbps

required

object (SimplifiedLocationRequest)

metroCode

required

string

demarcationPointIbx

string

A-side/Equinix ibx

tetherIbx

string

z-side/Equinix ibx

object (PortDemarcationPoint)

Customer physical Port

cabinetUniqueSpaceId	string Port cabinet unique space id
cageUniqueSpaceId	string Port cage unique space id
patchPanel	string Port patch panel
patchPanelName	string Deprecated Port patch panel
patchPanelPortA	string Port patch panel port A
patchPanelPortB	string Port patch panel port B
connectorType	string Port connector type
ibx	string Port ibx identifier

object (PortRedundancy)

Port redundancy configuration

enabled	boolean Access point redundancy
group	string Deprecated Port UUID of respective primary port
priority	string (PortPriority) Enum: "PRIMARY" "SECONDARY" Port priority in redundancy group

required

object (PortEncapsulation)

Port encapsulation configuration

type	string Enum: "DOT1Q" "QINQ" "UNTAGGED" Port encapsulation protocol type
tagProtocolId	string Port encapsulation tag protocol identifier

lagEnabled

boolean

Indicates whether Link Aggregation Group (LAG) is enabled on this port

object (Package)

Package settings for port

code	string Enum: "STANDARD" "UNLIMITED" "UNLIMITED_PLUS" Type of Port Package

Array of objects (PortNotification)

Notification preferences

Array

type required	string Enum: "NOTIFICATION" "TECHNICAL" "PEERING" "ESCALATION" Notification Type
registeredUsers required	Array of strings Array of registered users

Array of objects (PhysicalPort)

Physical ports that implement this port

Array

type	string (PhysicalPortType) Value: "XF_PHYSICAL_PORT" Type of Port
id	integer Deprecated Equinix assigned response attribute for Physical Port Id
state	string (PortState) Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PENDING_CROSS_CONNECT" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED" Port lifecycle state
	object (SimplifiedAccount)
interfaceSpeed	integer >= 0 Physical Port Speed in Mbps
interfaceType	string Physical Port Interface Type
uuid	string <uuid> Equinix assigned response attribute for physical port identifier
	object (PortTether) Port physical connection
	object (PortDemarcationPoint) Customer physical Port
	Array of objects (PortNotification) Notification preferences
	Array of objects (PortAdditionalInfo) Physical Port additional information
	object (PortOrder)
	object (PortOperation) Operational specifications for ports.
	Array of objects (PortLoa) Port Loas

Array of objects (PortLoa)

Port Loas

Array

uuid	string uuid
type	string Loa type

Responses

Response Schema: application/json

href

string <uri>

Equinix assigned response attribute for an absolute URL that is the subject of the link's context.

type

string (PortType)

Value: "XF_PORT"

Type of Port

uuid

string <uuid>

Equinix assigned response attribute for port identifier

name

string

Equinix assigned response attribute for Port name

description

string

Equinix assigned response attribute for Port description

physicalPortsSpeed

integer >= 0

Physical Ports Speed in Mbps

connectionsCount

integer >= 0

Equinix assigned response attribute for Connection count

physicalPortsType

string

Enum: "1000BASE_LX" "10GBASE_LR" "100GBASE_LR4" "10GBASE_ER" "1000BASE_SX" "10GBASE_SMF" "400GBASE_LR4"

Physical Ports Type. 10GBASE_SMF and 400GBASE_LR4 are only used for IX ports

physicalPortsCount

integer

connectivitySourceType

string

Enum: "COLO" "BMMR" "REMOTE"

Port connectivity type

bmmrType

string

Enum: "SELF" "EQUINIX"

object (Project)

projectId

required

string

Subscriber-assigned project ID

state

string (PortState)

Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PENDING_CROSS_CONNECT" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED"

Port lifecycle state

object (PortOrder)

object (PortOrderPurchaseOrder)

Purchase Order information associate to the account

number	string purchase order number
amount	string purchase order amount
startDate	string
endDate	string
attachmentId	string <uuid>
selectionType	string Deprecated Enum: "EXEMPTION" "EXISTING" "NEW" "BLANKET"
type	string Enum: "EXEMPTION" "EXISTING" "NEW" "BLANKET"

customerReferenceId

string

Customer order reference Id

object (PortOrderSignature)

Port signature details

signatory	string Enum: "DELEGATE" "SELF" "ACCOUNT_SUPPORT" Port signature Type
	object (PortOrderSignatureDelegate) order delegate details

object

Operational specifications for ports.

operationalStatus	string Enum: "UP" "DOWN" "PARTIAL" Availability of a given physical port.
connectionCount	integer <int64> Total number of connections.
evplVCCount	integer <int64> Total number of connections.
fgVCCount	integer <int64> Total number of connections.
accessVCCount	integer <int64> Total number of connections.
opStatusChangedAt	string <date-time> Date and time at which port availability changed.
maintenanceStatus	string Enum: "SCHEDULED" "IN_PROGRESS" "COMPLETED" "CANCELLED" "POSTPONED" Maintenance lifecycle state
lockEnabled	boolean Indicates whether the port configuration is locked due to an ongoing or scheduled maintenance.

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

object (PortChange)

Current state of latest port change

uuid

string

Uniquely identifies a change

type

string

Enum: "PORT_CREATION" "PORT_UPDATE" "PORT_DELETION"

Type of change

status

string

Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

information

string

Additional information

object (PortChangeOperation)

Port change operation data

op required	string Handy shortcut for operation name
path required	string path inside document leading to updated parameter
value required	any new value for updated parameter

createdDateTime

string <date-time>

Set when change flow starts

updatedDateTime

string <date-time>

Set when change object is updated

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

serviceType

string

Deprecated

Enum: "EPL" "MSP"

Port service Type

serviceCode

string (PortServiceCode)

Enum: "CX" "IX" "IA" "MC"

Identifies the service type associated with this port

bandwidth

integer >= 0

Deprecated

Equinix assigned response attribute for Port bandwidth in Mbps

availableBandwidth

integer >= 0

Equinix assigned response attribute for Port available bandwidth in Mbps

usedBandwidth

integer >= 0

Equinix assigned response attribute for Port used bandwidth in Mbps

object (SimplifiedLocation)

metroHref	string
region	string
metroName	string
metroCode	string
ibx	string Deprecated

object (PortDevice)

Port device

name

string

Deprecated

Device name

object (PortDeviceRedundancy)

Device redundancy

group	string Device redundancy group
priority	string Enum: "PRIMARY" "SECONDARY" Device redundancy priority

vcBandwidthMax

integer <int64>

Maximum bandwidth allowed for connection.

object (PortInterface)

Port interface

type	string Port interface type

demarcationPointIbx

string

A-side/Equinix ibx

tetherIbx

string

z-side/Equinix ibx

object (PortDemarcationPoint)

Customer physical Port

cabinetUniqueSpaceId	string Port cabinet unique space id
cageUniqueSpaceId	string Port cage unique space id
patchPanel	string Port patch panel
patchPanelName	string Deprecated Port patch panel
patchPanelPortA	string Port patch panel port A
patchPanelPortB	string Port patch panel port B
connectorType	string Port connector type
ibx	string Port ibx identifier

object (PortRedundancy)

Port redundancy configuration

enabled	boolean Access point redundancy
group	string Deprecated Port UUID of respective primary port
priority	string (PortPriority) Enum: "PRIMARY" "SECONDARY" Port priority in redundancy group

object (PortEncapsulation)

Port encapsulation configuration

type	string Enum: "DOT1Q" "QINQ" "UNTAGGED" Port encapsulation protocol type
tagProtocolId	string Port encapsulation tag protocol identifier

lagEnabled

boolean

If LAG enabled

object

Deprecated

Port Lag

id	string id
enabled	boolean Deprecated enabled
name	string name
memberStatus	string member status

asn

integer

Port ASN

object (Package)

Package settings for port

code	string Enum: "STANDARD" "UNLIMITED" "UNLIMITED_PLUS" Type of Port Package

object (PortSettings)

Port configuration settings

buyout	boolean Deprecated
viewPortPermission	boolean Deprecated
placeVcOrderPermission	boolean Deprecated
layer3Enabled	boolean Deprecated
packageType	string Deprecated Enum: "STANDARD" "UNLIMITED" "UNLIMITED_PLUS" Type of Port Package

physicalPortQuantity

integer

Number of physical ports

Array of objects (PortNotification)

Notification preferences

Array

type required	string Enum: "NOTIFICATION" "TECHNICAL" "PEERING" "ESCALATION" Notification Type
registeredUsers required	Array of strings Array of registered users

Array of objects (PortAdditionalInfo)

Port additional information

Array

key	string Key
value	string Value

Array of objects (PhysicalPort)

Physical ports that implement this port

Array

href	string <uri> Equinix assigned response attribute for an absolute URL that is the subject of the link's context.
type	string (PhysicalPortType) Value: "XF_PHYSICAL_PORT" Type of Port
id	integer Deprecated Equinix assigned response attribute for Physical Port Id
state	string (PortState) Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PENDING_CROSS_CONNECT" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED" Port lifecycle state
	object (SimplifiedAccount)
interfaceSpeed	integer >= 0 Physical Port Speed in Mbps
interfaceType	string Physical Port Interface Type
uuid	string <uuid> Equinix assigned response attribute for physical port identifier
	object (PortTether) Port physical connection
	object (PortDemarcationPoint) Customer physical Port
	Array of objects (PortNotification) Notification preferences
	Array of objects (PortAdditionalInfo) Physical Port additional information
	object (PortOrder)
	object (PortOperation) Operational specifications for ports.
	Array of objects (PortLoa) Port Loas

Array of objects (PortLoa)

Port Loas

Array

uuid	string uuid
type	string Loa type

object (marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

href	string <uri> Marketplace Subscription URI
type	string Enum: "AWS_MARKETPLACE_SUBSCRIPTION" "GCP_MARKETPLACE_SUBSCRIPTION" "AZURE_MARKETPLACE_SUBSCRIPTION" Marketplace Subscription type
uuid	string Equinix-assigned Marketplace Subscription identifier

Request samples

Payload

Content type

application/json

Example

COLOSinglePortNonLag

{"type": "XF_PORT",
"physicalPortsSpeed": 1000,
"physicalPortsType": "1000BASE_LX",
"connectivitySourceType": "COLO",
"location": {"metroCode": "GV"
},
"demarcationPointIbx": "GV1",
"package": {"code": "STANDARD"
},
"lagEnabled": false,
"encapsulation": {"type": "DOT1Q",
"tagProtocolId": "0x8100"
},
"project": {"projectId": "8f23b36f-db8f-44c8-a6e5-606e1b485931'"
},
"account": {"accountNumber": 270848
},
"notifications": [{"registeredUsers": ["jaguarsuser-port-order"
],
"type": "TECHNICAL"
}
],
"order": {"purchaseOrder": {"number": "156576",
"amount": "10",
"startDate": "2018-06-11T22:25:52.206Z",
"endDate": "2018-07-11T22:25:52.206Z",
"type": "NEW"
},
"signature": {"signatory": "DELEGATE",
"delegate": {"firstName": "John",
"lastName": "Doe",
"email": "john.doe@company.com"
}
}
},
"physicalPorts": [{"demarcationPoint": {"ibx": "GV1",
"cabinetUniqueSpaceId": "Demarc",
"cageUniqueSpaceId": "GV1:01:002174",
"patchPanel": "CP:Demarc:1259684",
"connectorType": "SC"
}
}
]
}

Response samples

200
202
400
401
500

Content type

application/json

Example

portDryRunExample

{"type": "XF_PORT",
"physicalPortsType": "10GBASE_LR",
"physicalPortsSpeed": 10000,
"physicalPortsCount": 1,
"location": {"metroCode": "AM"
},
"demarcationPointIbx": "AM1",
"redundancy": {"group": "1",
"priority": "PRIMARY"
},
"lagEnabled": true,
"encapsulation": {"type": "DOT1Q",
"tagProtocolId": "0x8100"
},
"package": {"code": "STANDARD"
},
"settings": {"sharedPortType": false
},
"project": {"projectId": "567"
},
"account": {"accountNumber": 1000
},
"order": {"orderNumber": "1-207799950758",
"signature": {"signatory": "DELEGATE",
"delegate": {"email": "testEmail1@equinix.com"
}
}
},
"notifications": [{"type": "TECHNICAL",
"registeredUsers": ["jaguarsuser-port-order"
]
},
{"type": "NOTIFICATION",
"registeredUsers": ["jaguarsuser-port-order"
]
},
{"type": "PEERING",
"registeredUsers": ["jaguarsuser-port-order"
]
},
{"type": "ESCALATION",
"registeredUsers": ["jaguarsuser-port-order"
]
}
]
}

Add to Lag

Add Physical Ports to Virtual Port. ^Preview

Authorizations:

BearerAuth

path Parameters

portId

required

string <uuid>

Port UUID

Request Body schema: application/json
required

Array of objects (PhysicalPort)

add physical ports to virtual port

Array

type	string (PhysicalPortType) Value: "XF_PHYSICAL_PORT" Type of Port
id	integer Deprecated Equinix assigned response attribute for Physical Port Id
state	string (PortState) Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PENDING_CROSS_CONNECT" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED" Port lifecycle state
	object (SimplifiedAccount)
interfaceSpeed	integer >= 0 Physical Port Speed in Mbps
interfaceType	string Physical Port Interface Type
uuid	string <uuid> Equinix assigned response attribute for physical port identifier
	object (PortTether) Port physical connection
	object (PortDemarcationPoint) Customer physical Port
	Array of objects (PortNotification) Notification preferences
	Array of objects (PortAdditionalInfo) Physical Port additional information
	object (PortOrder)
	object (PortOperation) Operational specifications for ports.
	Array of objects (PortLoa) Port Loas

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (PhysicalPort)

GET All Physical Ports

Array

href	string <uri> Equinix assigned response attribute for an absolute URL that is the subject of the link's context.
type	string (PhysicalPortType) Value: "XF_PHYSICAL_PORT" Type of Port
id	integer Deprecated Equinix assigned response attribute for Physical Port Id
state	string (PortState) Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PENDING_CROSS_CONNECT" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED" Port lifecycle state
	object (SimplifiedAccount)
interfaceSpeed	integer >= 0 Physical Port Speed in Mbps
interfaceType	string Physical Port Interface Type
uuid	string <uuid> Equinix assigned response attribute for physical port identifier
	object (PortTether) Port physical connection
	object (PortDemarcationPoint) Customer physical Port
	Array of objects (PortNotification) Notification preferences
	Array of objects (PortAdditionalInfo) Physical Port additional information
	object (PortOrder)
	object (PortOperation) Operational specifications for ports.
	Array of objects (PortLoa) Port Loas

Request samples

Payload

Content type

application/json

Example

COLOAddToLag

{"data": [{"type": "XF_PHYSICAL_PORT",
"demarcationPoint": {"ibx": "AM1",
"cabinetUniqueSpaceId": "AM1:02:032575:0105",
"cageUniqueSpaceId": "AM1:02:032575",
"patchPanel": "PP:0105:1260379",
"patchPanelPortA": "14",
"patchPanelPortB": "15",
"connectorType": "LC"
},
"account": {"accountNumber": 17829
},
"order": {"purchaseOrder": {"number": "156576",
"amount": "10",
"startDate": "2018-06-11T22:25:52.206Z",
"endDate": "2018-07-11T22:25:52.206Z",
"type": "NEW"
},
"signature": {"signatory": "DELEGATE",
"delegate": {"firstName": "John",
"lastName": "Doe",
"email": "john.doe@company.com"
}
}
},
"notifications": [{"registeredUsers": ["jaguarsuser-port-order"
],
"type": "NOTIFICATION"
}
]
},
{"type": "XF_PHYSICAL_PORT",
"account": {"accountNumber": 17829
},
"demarcationPoint": {"ibx": "AM1",
"cabinetUniqueSpaceId": "AM1:02:032575:0105",
"cageUniqueSpaceId": "AM1:02:032575",
"patchPanel": "PP:0105:1260379",
"patchPanelPortA": "16",
"patchPanelPortB": "17",
"connectorType": "LC"
},
"order": {"purchaseOrder": {"number": "156576",
"amount": "10",
"startDate": "2018-06-11T22:25:52.206Z",
"endDate": "2018-07-11T22:25:52.206Z",
"type": "NEW"
},
"signature": {"signatory": "DELEGATE",
"delegate": {"firstName": "John",
"lastName": "Doe",
"email": "john.doe@company.com"
}
}
},
"notifications": [{"registeredUsers": ["jaguarsuser-port-order"
],
"type": "NOTIFICATION"
}
]
}
]
}

Response samples

200
400
401
404
500

Content type

application/json

{"data": [{"type": "XF_PHYSICAL_PORT",
"demarcationPoint": {"cabinetUniqueSpaceId": "Demarc",
"cageUniqueSpaceId": "GV1:01:002174",
"patchPanel": "CP:Demarc:1259684",
"patchPanelPortA": "39",
"patchPanelPortB": "40",
"connectorType": "SC",
"ibx": "GV1"
},
"order": {"orderNumber": "1-210210611904",
"uuid": "bdfa360d-8ffb-4394-8905-56ea6ae3e87d"
},
"notifications": [{"type": "NOTIFICATION",
"registeredUsers": ["jaguarsuser-port-order"
]
}
]
},
{"type": "XF_PHYSICAL_PORT",
"demarcationPoint": {"cabinetUniqueSpaceId": "Demarc",
"cageUniqueSpaceId": "GV1:01:002174",
"patchPanel": "CP:Demarc:1259684",
"patchPanelPortA": "41",
"patchPanelPortB": "42",
"connectorType": "SC",
"ibx": "GV1"
},
"order": {"orderNumber": "1-210210611904",
"uuid": "bdfa360d-8ffb-4394-8905-56ea6ae3e87d"
},
"notifications": [{"type": "NOTIFICATION",
"registeredUsers": ["jaguarsuser-port-order"
]
}
]
}
]
}

Get Port by ID

Get Port by ID returns details of assigned and available Equinix Fabric port for the specified user credentials. The metro code attribute in the response shows the origin of the proposed connection

Authorizations:

BearerAuth

path Parameters

portId

required

string <uuid>

Port UUID

Responses

Response Schema: application/json

href

string <uri>

Equinix assigned response attribute for an absolute URL that is the subject of the link's context.

type

string (PortType)

Value: "XF_PORT"

Type of Port

uuid

string <uuid>

Equinix assigned response attribute for port identifier

name

string

Equinix assigned response attribute for Port name

description

string

Equinix assigned response attribute for Port description

physicalPortsSpeed

integer >= 0

Physical Ports Speed in Mbps

connectionsCount

integer >= 0

Equinix assigned response attribute for Connection count

physicalPortsType

string

Enum: "1000BASE_LX" "10GBASE_LR" "100GBASE_LR4" "10GBASE_ER" "1000BASE_SX" "10GBASE_SMF" "400GBASE_LR4"

Physical Ports Type. 10GBASE_SMF and 400GBASE_LR4 are only used for IX ports

physicalPortsCount

integer

connectivitySourceType

string

Enum: "COLO" "BMMR" "REMOTE"

Port connectivity type

bmmrType

string

Enum: "SELF" "EQUINIX"

object (Project)

projectId

required

string

Subscriber-assigned project ID

state

string (PortState)

Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PENDING_CROSS_CONNECT" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED"

Port lifecycle state

object (PortOrder)

object (PortOrderPurchaseOrder)

Purchase Order information associate to the account

number	string purchase order number
amount	string purchase order amount
startDate	string
endDate	string
attachmentId	string <uuid>
selectionType	string Deprecated Enum: "EXEMPTION" "EXISTING" "NEW" "BLANKET"
type	string Enum: "EXEMPTION" "EXISTING" "NEW" "BLANKET"

customerReferenceId

string

Customer order reference Id

object (PortOrderSignature)

Port signature details

signatory	string Enum: "DELEGATE" "SELF" "ACCOUNT_SUPPORT" Port signature Type
	object (PortOrderSignatureDelegate) order delegate details

object

Operational specifications for ports.

operationalStatus	string Enum: "UP" "DOWN" "PARTIAL" Availability of a given physical port.
connectionCount	integer <int64> Total number of connections.
evplVCCount	integer <int64> Total number of connections.
fgVCCount	integer <int64> Total number of connections.
accessVCCount	integer <int64> Total number of connections.
opStatusChangedAt	string <date-time> Date and time at which port availability changed.
maintenanceStatus	string Enum: "SCHEDULED" "IN_PROGRESS" "COMPLETED" "CANCELLED" "POSTPONED" Maintenance lifecycle state
lockEnabled	boolean Indicates whether the port configuration is locked due to an ongoing or scheduled maintenance.

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

object (PortChange)

Current state of latest port change

uuid

string

Uniquely identifies a change

type

string

Enum: "PORT_CREATION" "PORT_UPDATE" "PORT_DELETION"

Type of change

status

string

Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

information

string

Additional information

object (PortChangeOperation)

Port change operation data

op required	string Handy shortcut for operation name
path required	string path inside document leading to updated parameter
value required	any new value for updated parameter

createdDateTime

string <date-time>

Set when change flow starts

updatedDateTime

string <date-time>

Set when change object is updated

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

serviceType

string

Deprecated

Enum: "EPL" "MSP"

Port service Type

serviceCode

string (PortServiceCode)

Enum: "CX" "IX" "IA" "MC"

Identifies the service type associated with this port

bandwidth

integer >= 0

Deprecated

Equinix assigned response attribute for Port bandwidth in Mbps

availableBandwidth

integer >= 0

Equinix assigned response attribute for Port available bandwidth in Mbps

usedBandwidth

integer >= 0

Equinix assigned response attribute for Port used bandwidth in Mbps

object (SimplifiedLocation)

metroHref	string
region	string
metroName	string
metroCode	string
ibx	string Deprecated

object (PortDevice)

Port device

name

string

Deprecated

Device name

object (PortDeviceRedundancy)

Device redundancy

group	string Device redundancy group
priority	string Enum: "PRIMARY" "SECONDARY" Device redundancy priority

vcBandwidthMax

integer <int64>

Maximum bandwidth allowed for connection.

object (PortInterface)

Port interface

type	string Port interface type

demarcationPointIbx

string

A-side/Equinix ibx

tetherIbx

string

z-side/Equinix ibx

object (PortDemarcationPoint)

Customer physical Port

cabinetUniqueSpaceId	string Port cabinet unique space id
cageUniqueSpaceId	string Port cage unique space id
patchPanel	string Port patch panel
patchPanelName	string Deprecated Port patch panel
patchPanelPortA	string Port patch panel port A
patchPanelPortB	string Port patch panel port B
connectorType	string Port connector type
ibx	string Port ibx identifier

object (PortRedundancy)

Port redundancy configuration

enabled	boolean Access point redundancy
group	string Deprecated Port UUID of respective primary port
priority	string (PortPriority) Enum: "PRIMARY" "SECONDARY" Port priority in redundancy group

object (PortEncapsulation)

Port encapsulation configuration

type	string Enum: "DOT1Q" "QINQ" "UNTAGGED" Port encapsulation protocol type
tagProtocolId	string Port encapsulation tag protocol identifier

lagEnabled

boolean

If LAG enabled

object

Deprecated

Port Lag

id	string id
enabled	boolean Deprecated enabled
name	string name
memberStatus	string member status

asn

integer

Port ASN

object (Package)

Package settings for port

code	string Enum: "STANDARD" "UNLIMITED" "UNLIMITED_PLUS" Type of Port Package

object (PortSettings)

Port configuration settings

buyout	boolean Deprecated
viewPortPermission	boolean Deprecated
placeVcOrderPermission	boolean Deprecated
layer3Enabled	boolean Deprecated
packageType	string Deprecated Enum: "STANDARD" "UNLIMITED" "UNLIMITED_PLUS" Type of Port Package

physicalPortQuantity

integer

Number of physical ports

Array of objects (PortNotification)

Notification preferences

Array

type required	string Enum: "NOTIFICATION" "TECHNICAL" "PEERING" "ESCALATION" Notification Type
registeredUsers required	Array of strings Array of registered users

Array of objects (PortAdditionalInfo)

Port additional information

Array

key	string Key
value	string Value

Array of objects (PhysicalPort)

Physical ports that implement this port

Array

href	string <uri> Equinix assigned response attribute for an absolute URL that is the subject of the link's context.
type	string (PhysicalPortType) Value: "XF_PHYSICAL_PORT" Type of Port
id	integer Deprecated Equinix assigned response attribute for Physical Port Id
state	string (PortState) Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PENDING_CROSS_CONNECT" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED" Port lifecycle state
	object (SimplifiedAccount)
interfaceSpeed	integer >= 0 Physical Port Speed in Mbps
interfaceType	string Physical Port Interface Type
uuid	string <uuid> Equinix assigned response attribute for physical port identifier
	object (PortTether) Port physical connection
	object (PortDemarcationPoint) Customer physical Port
	Array of objects (PortNotification) Notification preferences
	Array of objects (PortAdditionalInfo) Physical Port additional information
	object (PortOrder)
	object (PortOperation) Operational specifications for ports.
	Array of objects (PortLoa) Port Loas

Array of objects (PortLoa)

Port Loas

Array

uuid	string uuid
type	string Loa type

object (marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

href	string <uri> Marketplace Subscription URI
type	string Enum: "AWS_MARKETPLACE_SUBSCRIPTION" "GCP_MARKETPLACE_SUBSCRIPTION" "AZURE_MARKETPLACE_SUBSCRIPTION" Marketplace Subscription type
uuid	string Equinix-assigned Marketplace Subscription identifier

Response samples

200
400
403
500

Content type

application/json

Example

portExample

{"href": "https://api.equinix.com/fabric/v4/ports/44c5712b-d704-4ca5-9b42-ee6be32ee06a",
"type": "XF_PORT",
"uuid": "44c5712b-d704-4ca5-9b42-ee6be32ee06a",
"name": "270843-DA1-CX-PRI-33",
"physicalPortsSpeed": 1000,
"physicalPortsType": "1000BASE_LX",
"project": {"projectId": "66a2d2f7-b79b-49bc-8642-d2b3c1c138b4"
},
"package": {"code": "UNLIMITED"
},
"state": "ACTIVE",
"cvpId": "2000833",
"connectivitySourceType": "COLO",
"operation": {"operationalStatus": "UP",
"connectionCount": 10,
"evplVCCount": 10,
"accessVCCount": 0
},
"account": {"accountNumber": 270843,
"accountName": "ctr-sit-account1",
"orgId": 93055,
"organizationName": "ctr-sit-account1-270843",
"ucmId": "64726950-A62C-4749-98E2-5AA4CA44284F",
"globalCustId": "0016u000003JZ3XAAW"
},
"change": {"uuid": "ed41e367-e09d-4c2f-b6ab-30506de4437f",
"type": "PORT_UPDATE",
"status": "COMPLETED",
"data": {"op": "REPLACE",
"path": "/encapsulation",
"value": {"type": "QINQ",
"tagProtocolId": "0x88a8"
}
},
"createdDateTime": "2025-05-29T20:38:45.630759Z",
"updatedDateTime": "2025-05-29T20:38:49.330822Z"
},
"changeLog": {"createdBy": "qa-automation",
"createdDateTime": "2025-05-21T18:12:18.300Z",
"updatedBy": "qa-automation",
"updatedDateTime": "2025-05-29T20:38:48.900Z"
},
"bandwidth": 1000,
"availableBandwidth": 500,
"usedBandwidth": 500,
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/DA",
"region": "AMER",
"metroName": "Dallas",
"metroCode": "DA",
"ibx": "DA1"
},
"device": {"name": "qa3-da-a1.lab",
"redundancy": {"priority": "PRIMARY"
}
},
"demarcationPointIbx": "DA1",
"tetherIbx": "DA1",
"redundancy": {"priority": "PRIMARY"
},
"encapsulation": {"type": "QINQ",
"tagProtocolId": "0x88a8"
},
"lagEnabled": false,
"settings": {"buyout": true,
"viewPortPermission": true,
"placeVcOrderPermission": true
},
"physicalPorts": [{"type": "XF_PHYSICAL_PORT",
"id": 1426359,
"state": "ADDED",
"bandwidth": 0,
"uuid": "0189244a-f3ac-7258-a8b4-3167af899305",
"tether": {"crossConnectId": "513213223",
"ibx": "DA1"
},
"demarcationPoint": {"ibx": "DA1"
},
"operation": {"operationalStatus": "UP"
}
}
]
}

Delete Port

The API provides capability to delete a single port

Authorizations:

BearerAuth

path Parameters

portId

required

string <uuid>

Port UUID

query Parameters

dryRun

boolean

Default: false

option to verify that API calls will succeed

Responses

Response Schema: application/json

href

string <uri>

Equinix assigned response attribute for an absolute URL that is the subject of the link's context.

type

string (PortType)

Value: "XF_PORT"

Type of Port

uuid

string <uuid>

Equinix assigned response attribute for port identifier

name

string

Equinix assigned response attribute for Port name

description

string

Equinix assigned response attribute for Port description

physicalPortsSpeed

integer >= 0

Physical Ports Speed in Mbps

connectionsCount

integer >= 0

Equinix assigned response attribute for Connection count

physicalPortsType

string

Enum: "1000BASE_LX" "10GBASE_LR" "100GBASE_LR4" "10GBASE_ER" "1000BASE_SX" "10GBASE_SMF" "400GBASE_LR4"

Physical Ports Type. 10GBASE_SMF and 400GBASE_LR4 are only used for IX ports

physicalPortsCount

integer

connectivitySourceType

string

Enum: "COLO" "BMMR" "REMOTE"

Port connectivity type

bmmrType

string

Enum: "SELF" "EQUINIX"

object (Project)

projectId

required

string

Subscriber-assigned project ID

state

string (PortState)

Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PENDING_CROSS_CONNECT" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED"

Port lifecycle state

object (PortOrder)

object (PortOrderPurchaseOrder)

Purchase Order information associate to the account

number	string purchase order number
amount	string purchase order amount
startDate	string
endDate	string
attachmentId	string <uuid>
selectionType	string Deprecated Enum: "EXEMPTION" "EXISTING" "NEW" "BLANKET"
type	string Enum: "EXEMPTION" "EXISTING" "NEW" "BLANKET"

customerReferenceId

string

Customer order reference Id

object (PortOrderSignature)

Port signature details

signatory	string Enum: "DELEGATE" "SELF" "ACCOUNT_SUPPORT" Port signature Type
	object (PortOrderSignatureDelegate) order delegate details

object

Operational specifications for ports.

operationalStatus	string Enum: "UP" "DOWN" "PARTIAL" Availability of a given physical port.
connectionCount	integer <int64> Total number of connections.
evplVCCount	integer <int64> Total number of connections.
fgVCCount	integer <int64> Total number of connections.
accessVCCount	integer <int64> Total number of connections.
opStatusChangedAt	string <date-time> Date and time at which port availability changed.
maintenanceStatus	string Enum: "SCHEDULED" "IN_PROGRESS" "COMPLETED" "CANCELLED" "POSTPONED" Maintenance lifecycle state
lockEnabled	boolean Indicates whether the port configuration is locked due to an ongoing or scheduled maintenance.

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

object (PortChange)

Current state of latest port change

uuid

string

Uniquely identifies a change

type

string

Enum: "PORT_CREATION" "PORT_UPDATE" "PORT_DELETION"

Type of change

status

string

Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

information

string

Additional information

object (PortChangeOperation)

Port change operation data

op required	string Handy shortcut for operation name
path required	string path inside document leading to updated parameter
value required	any new value for updated parameter

createdDateTime

string <date-time>

Set when change flow starts

updatedDateTime

string <date-time>

Set when change object is updated

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

serviceType

string

Deprecated

Enum: "EPL" "MSP"

Port service Type

serviceCode

string (PortServiceCode)

Enum: "CX" "IX" "IA" "MC"

Identifies the service type associated with this port

bandwidth

integer >= 0

Deprecated

Equinix assigned response attribute for Port bandwidth in Mbps

availableBandwidth

integer >= 0

Equinix assigned response attribute for Port available bandwidth in Mbps

usedBandwidth

integer >= 0

Equinix assigned response attribute for Port used bandwidth in Mbps

object (SimplifiedLocation)

metroHref	string
region	string
metroName	string
metroCode	string
ibx	string Deprecated

object (PortDevice)

Port device

name

string

Deprecated

Device name

object (PortDeviceRedundancy)

Device redundancy

group	string Device redundancy group
priority	string Enum: "PRIMARY" "SECONDARY" Device redundancy priority

vcBandwidthMax

integer <int64>

Maximum bandwidth allowed for connection.

object (PortInterface)

Port interface

type	string Port interface type

demarcationPointIbx

string

A-side/Equinix ibx

tetherIbx

string

z-side/Equinix ibx

object (PortDemarcationPoint)

Customer physical Port

cabinetUniqueSpaceId	string Port cabinet unique space id
cageUniqueSpaceId	string Port cage unique space id
patchPanel	string Port patch panel
patchPanelName	string Deprecated Port patch panel
patchPanelPortA	string Port patch panel port A
patchPanelPortB	string Port patch panel port B
connectorType	string Port connector type
ibx	string Port ibx identifier

object (PortRedundancy)

Port redundancy configuration

enabled	boolean Access point redundancy
group	string Deprecated Port UUID of respective primary port
priority	string (PortPriority) Enum: "PRIMARY" "SECONDARY" Port priority in redundancy group

object (PortEncapsulation)

Port encapsulation configuration

type	string Enum: "DOT1Q" "QINQ" "UNTAGGED" Port encapsulation protocol type
tagProtocolId	string Port encapsulation tag protocol identifier

lagEnabled

boolean

If LAG enabled

object

Deprecated

Port Lag

id	string id
enabled	boolean Deprecated enabled
name	string name
memberStatus	string member status

asn

integer

Port ASN

object (Package)

Package settings for port

code	string Enum: "STANDARD" "UNLIMITED" "UNLIMITED_PLUS" Type of Port Package

object (PortSettings)

Port configuration settings

buyout	boolean Deprecated
viewPortPermission	boolean Deprecated
placeVcOrderPermission	boolean Deprecated
layer3Enabled	boolean Deprecated
packageType	string Deprecated Enum: "STANDARD" "UNLIMITED" "UNLIMITED_PLUS" Type of Port Package

physicalPortQuantity

integer

Number of physical ports

Array of objects (PortNotification)

Notification preferences

Array

type required	string Enum: "NOTIFICATION" "TECHNICAL" "PEERING" "ESCALATION" Notification Type
registeredUsers required	Array of strings Array of registered users

Array of objects (PortAdditionalInfo)

Port additional information

Array

key	string Key
value	string Value

Array of objects (PhysicalPort)

Physical ports that implement this port

Array

href	string <uri> Equinix assigned response attribute for an absolute URL that is the subject of the link's context.
type	string (PhysicalPortType) Value: "XF_PHYSICAL_PORT" Type of Port
id	integer Deprecated Equinix assigned response attribute for Physical Port Id
state	string (PortState) Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PENDING_CROSS_CONNECT" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED" Port lifecycle state
	object (SimplifiedAccount)
interfaceSpeed	integer >= 0 Physical Port Speed in Mbps
interfaceType	string Physical Port Interface Type
uuid	string <uuid> Equinix assigned response attribute for physical port identifier
	object (PortTether) Port physical connection
	object (PortDemarcationPoint) Customer physical Port
	Array of objects (PortNotification) Notification preferences
	Array of objects (PortAdditionalInfo) Physical Port additional information
	object (PortOrder)
	object (PortOperation) Operational specifications for ports.
	Array of objects (PortLoa) Port Loas

Array of objects (PortLoa)

Port Loas

Array

uuid	string uuid
type	string Loa type

object (marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

href	string <uri> Marketplace Subscription URI
type	string Enum: "AWS_MARKETPLACE_SUBSCRIPTION" "GCP_MARKETPLACE_SUBSCRIPTION" "AZURE_MARKETPLACE_SUBSCRIPTION" Marketplace Subscription type
uuid	string Equinix-assigned Marketplace Subscription identifier

Response samples

200
202
400
401
404

Content type

application/json

{"type": "XF_PORT",
"uuid": "e91484bb-4f65-4ab3-8f77-500dec2f855d",
"name": "test-AT1-Dot1q-L-Secondary-108608",
"physicalPortsType": "10GBASE_LR",
"physicalPortsSpeed": 10000,
"physicalPortsCount": 1,
"location": {"metroCode": "AM"
},
"demarcationPointIbx": "AM1",
"redundancy": {"group": "1",
"priority": "PRIMARY"
},
"lagEnabled": true,
"encapsulation": {"type": "DOT1Q",
"tagProtocolId": "0x8100"
},
"package": {"code": "STANDARD"
},
"settings": {"sharedPortType": false
},
"project": {"projectId": "567"
},
"account": {"accountNumber": 1000
},
"order": {"orderNumber": "1-207799950758",
"signature": {"signatory": "DELEGATE",
"delegate": {"email": "testEmail1@equinix.com"
}
}
},
"notifications": [{"type": "TECHNICAL",
"registeredUsers": ["jaguarsuser-port-order"
]
},
{"type": "NOTIFICATION",
"registeredUsers": ["jaguarsuser-port-order"
]
},
{"type": "PEERING",
"registeredUsers": ["jaguarsuser-port-order"
]
},
{"type": "ESCALATION",
"registeredUsers": ["jaguarsuser-port-order"
]
}
],
"physicalPorts": [{"tether": {"crossConnectId": "100179-A",
"patchPanel": "PP:8118:1586",
"patchPanelPortA": "92",
"patchPanelPortB": "24"
},
"demarcationPoint": {"ibx": "AT1",
"patchPanel": "PP:8118:1586",
"patchPanelName": "PP:8118:1586",
"patchPanelPortA": "92",
"patchPanelPortB": "24"
}
}
]
}

Update Port by ID

Update Port by UUID

Authorizations:

BearerAuth

path Parameters

portId

required

string <uuid>

Port UUID

query Parameters

dryRun

boolean

Default: false

option to verify that API calls will succeed

Request Body schema: application/json-patch+json
required

Array (non-empty)

op required	string Handy shortcut for operation name
path required	string path inside document leading to updated parameter
value required	any new value for updated parameter

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (Port)

GET All User Port Across Fabric Metros

Array

href	string <uri> Equinix assigned response attribute for an absolute URL that is the subject of the link's context.
type	string (PortType) Value: "XF_PORT" Type of Port
uuid	string <uuid> Equinix assigned response attribute for port identifier
name	string Equinix assigned response attribute for Port name
description	string Equinix assigned response attribute for Port description
physicalPortsSpeed	integer >= 0 Physical Ports Speed in Mbps
connectionsCount	integer >= 0 Equinix assigned response attribute for Connection count
physicalPortsType	string Enum: "1000BASE_LX" "10GBASE_LR" "100GBASE_LR4" "10GBASE_ER" "1000BASE_SX" "10GBASE_SMF" "400GBASE_LR4" Physical Ports Type. 10GBASE_SMF and 400GBASE_LR4 are only used for IX ports
physicalPortsCount	integer
connectivitySourceType	string Enum: "COLO" "BMMR" "REMOTE" Port connectivity type
bmmrType	string Enum: "SELF" "EQUINIX"
	object (Project)
state	string (PortState) Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PENDING_CROSS_CONNECT" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED" Port lifecycle state
	object (PortOrder)
	object Operational specifications for ports.
	object (SimplifiedAccount)
	object (PortChange) Current state of latest port change
	object (Changelog) Change log
serviceType	string Deprecated Enum: "EPL" "MSP" Port service Type
serviceCode	string (PortServiceCode) Enum: "CX" "IX" "IA" "MC" Identifies the service type associated with this port
bandwidth	integer >= 0 Deprecated Equinix assigned response attribute for Port bandwidth in Mbps
availableBandwidth	integer >= 0 Equinix assigned response attribute for Port available bandwidth in Mbps
usedBandwidth	integer >= 0 Equinix assigned response attribute for Port used bandwidth in Mbps
	object (SimplifiedLocation)
	object (PortDevice) Port device
	object (PortInterface) Port interface
demarcationPointIbx	string A-side/Equinix ibx
tetherIbx	string z-side/Equinix ibx
	object (PortDemarcationPoint) Customer physical Port
	object (PortRedundancy) Port redundancy configuration
	object (PortEncapsulation) Port encapsulation configuration
lagEnabled	boolean If LAG enabled
	object Deprecated Port Lag
asn	integer Port ASN
	object (Package) Package settings for port
	object (PortSettings) Port configuration settings
physicalPortQuantity	integer Number of physical ports
	Array of objects (PortNotification) Notification preferences
	Array of objects (PortAdditionalInfo) Port additional information
	Array of objects (PhysicalPort) Physical ports that implement this port
	Array of objects (PortLoa) Port Loas
	object (marketplaceSubscription) Equinix Fabric Entity for Marketplace Subscription

Request samples

Payload

Content type

application/json-patch+json

Example

PortUpdateNameRequest

[{"op": "replace",
"path": "/name",
"value": "1234-ibx-port"
}
]

Response samples

200
202
400
403
500

Content type

application/json

{"pagination": {"offset": 0,
"limit": 5,
"total": 1
},
"data": [{"href": "https://api.equinix.com/fabric/v4/ports/e91484bb-4f65-4ab3-8f77-500dec2f855d",
"type": "XF_PORT",
"uuid": "e91484bb-4f65-4ab3-8f77-500dec2f855d",
"name": "test-AT1-Dot1q-L-Secondary-108608",
"state": "ACTIVE",
"bandwidth": 10000,
"usedBandwidth": 0,
"availableBandwidth": 20000,
"physicalPortsSpeed": 10000,
"redundancy": {"priority": "SECONDARY"
},
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/AT",
"ibx": "AT1",
"metroCode": "AT",
"metroName": "Atlanta",
"region": "AMER"
},
"device": {"name": "dev-m7a2.lab",
"redundancy": {"group": "1",
"priority": "SECONDARY"
}
},
"encapsulation": {"type": "DOT1Q",
"tagProtocolId": "0x8100"
},
"lagEnabled": true,
"package": {"code": "STANDARD",
"type": "MSP"
},
"settings": {"buyout": false,
"placeVcOrderPermission": true,
"viewPortPermission": true
},
"physicalPorts": [{"state": "ACTIVE",
"type": "XF_PHYSICAL_PORT",
"id": 6967,
"bandwidth": 10000,
"tether": {"crossConnectId": "100179-A",
"patchPanel": "PP:956:66107",
"patchPanelPortA": "5",
"patchPanelPortB": "42"
},
"operation": {"operationalStatus": "UP"
}
},
{"state": "ACTIVE",
"type": "XF_PHYSICAL_PORT",
"id": 6968,
"bandwidth": 10000,
"tether": {"crossConnectId": "100179-A",
"patchPanel": "PP:8118:1586",
"patchPanelPortA": "92",
"patchPanelPortB": "24"
},
"operation": {"operationalStatus": "UP"
},
"demarcationPoint": {"ibx": "AT1",
"patchPanel": "PP:8118:1586",
"patchPanelName": "PP:8118:1586",
"patchPanelPortA": "92",
"patchPanelPortB": "24"
}
}
],
"operation": {"operationalStatus": "UP",
"opStatusChangedAt": "2021-06-14T17:21:25.586Z",
"connectionCount": 0,
"evplVcCount": 0,
"fgVcCount": 0,
"accessVcCount": 0
},
"account": {"accountNumber": 100179,
"accountName": "L2",
"globalCustId": "007700000090982RG8",
"orgId": 100179,
"organizationName": "Cust_Org_100179"
},
"order": {"purchaseOrder": {"startDate": "2020-06-14T17:21:25.586Z",
"endDate": "2020-06-15T17:21:25.586Z",
"type": "NEW"
},
"orderNumber": "1-222078525611"
},
"changeLog": {"createdDateTime": "2020-06-14T17:21:25.586Z"
},
"project": {"projectId": "8f23b36f-db8f-44c8-a6e5-606e1b485931"
}
}
]
}

Get Vlans

The API provides capability to retrieve Vlans for a Port

Authorizations:

BearerAuth

path Parameters

portUuid

required

string <uuid>

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

Port UUID

query Parameters

offset	integer Example: offset=1 offset
limit	integer Example: limit=10 number of records to fetch

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (LinkProtocolResponse)

Array

href	string <uri> LinkProtocol URI
uuid	string <uuid> Equinix-assigned network identifier
state	string (LinkProtocolState) Enum: "RESERVED" "RELEASED" Network status
type	string (LinkProtocolRequestType) Enum: "UNTAGGED" "DOT1Q" "QINQ" "VXLAN" Type of Link Protocol
vlanTag	integer
vni	integer
vlanTagMin	integer
vlanTagMax	integer
vlanSTag	integer
vlanCTag	integer
vlanCTagMin	integer
vlanCTagMax	integer
	object (SubInterface) Sub Interface information
	object (LinkProtocolConnection) Connection details of Link Protocol
	object (LinkProtocolServiceToken) Service Token details of Link Protocol
	object (Changelog) Change log

Response samples

200
400
403

Content type

application/json

Example

LinkProtocolQ1NQResponse

{"pagination": {"offset": 0,
"limit": 20,
"total": 5
},
"data": [{"type": "QINQ",
"uuid": "52d61263-fb0a-459d-a086-bc7fd6bd7384",
"state": "RESERVED",
"vlanSTag": 1000,
"vlanCTag": 500,
"asset": {"href": "https://api.equinix.com/fabric/v4/connections/cd67f685-41b0-1b07-6de0-320a5c00abee",
"uuid": "cd67f685-41b0-1b07-6de0-320a5c00abee"
},
"changeLog": {"createdDateTime": "2020-05-21T10:30:00Z"
}
},
{"type": "QINQ",
"uuid": "8c589394-b0eb-4057-97dc-3bdb4f8ff6db",
"state": "RESERVED",
"vlanSTag": 1000,
"vlanCTag": 500,
"serviceToken": {"href": "https://api.equinix.com/fabric/v4/serviceTokens/fc4fb78a-6b89-462d-a233-e75ef61a603f",
"uuid": "fc4fb78a-6b89-462d-a233-e75ef61a603f"
},
"changeLog": {"createdDateTime": "2020-05-21T10:30:00Z"
}
},
{"type": "QINQ",
"uuid": "7f1da56d-e1ff-4b25-b542-883c7004e971",
"state": "RESERVED",
"vlanSTag": 1000,
"vlanCTag": 500,
"serviceToken": {"href": "https://api.equinix.com/fabric/v4/serviceTokens/90f1af0e-134b-40d6-a007-e62cd6866373",
"uuid": "90f1af0e-134b-40d6-a007-e62cd6866373",
"bandwidth": 1000
},
"changeLog": {"createdDateTime": "2020-05-21T10:30:00Z"
}
},
{"type": "QINQ",
"uuid": "7c968801-e03b-4530-8424-aa5ecc4339e2",
"state": "RESERVED",
"vlanSTag": 1000,
"vlanCTag": 500,
"asset": {"href": "https://api.equinix.com/fabric/v4/connections/2ac4e14f-6120-4705-886e-d37f1d0c6a65",
"uuid": "2ac4e14f-6120-4705-886e-d37f1d0c6a65"
},
"changeLog": {"createdDateTime": "2020-05-21T10:30:00Z"
}
},
{"type": "QINQ",
"uuid": "db812bba-94b8-43e6-8d9c-850f04350c3d",
"state": "RESERVED",
"vlanSTag": 1001,
"vlanCTag": 1001,
"asset": {"href": "https://api.equinix.com/fabric/v4/connections/3268d105-e57b-4b2b-8a0a-2e3e42312d95",
"uuid": "3268d105-e57b-4b2b-8a0a-2e3e42312d95"
},
"changeLog": {"createdDateTime": "2020-05-21T10:30:00Z",
"updatedDateTime": "2020-05-21T10:30:00Z"
}
}
]
}

Search Ports

The API provides capability to get list of user's virtual ports using search criteria, including optional filtering, pagination and sorting

Authorizations:

BearerAuth

Request Body schema: application/json
required

required

object (PortExpression)

Either use 'and' for AND operations, 'or' for OR operations, or specify 'property', 'operator', and 'values' for field filtering. Only one of these patterns should be used at a time.

and	Array of objects (PortExpressions)
or	Array of objects (PortExpressions)
property	string (PortSearchFieldName) Enum: "/device/name" "/physicalPorts/tether/crossConnectId" "/physicalPorts/interface/name" "/state" "/project/projectId" "/uuid" "/name" "/account/orgId" "/account/accountNumber" "/location/metroCode" "/operation/maintenanceStatus" "/operation/lockEnabled" Possible field names to use on filters
operator	string Enum: "=" "!=" ">" ">=" "<" "<=" "LIKE" "ILIKE" "IN" "NOT IN" "BETWEEN"
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (PortSortCriteria)

Array

direction

string (PortSortDirection)

Default: "DESC"

Enum: "DESC" "ASC"

Sorting direction

property

string (PortSortBy)

Default: "/device/name"

Enum: "/device/name" "/name" "/state" "/location/metroName" "/demarcationPointIbx" "/device/redundancy/priority" "/lagEnabled" "/physicalPortsSpeed" "/encapsulation/type" "/physicalPorts/tether/crossConnectId" "/package/code" "/changeLog/updatedDateTime" "/changeLog/createdDateTime" "/bandwidth" "/serviceCode" "/operation/maintenanceStatus"

Possible field names to use on sorting

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (Port)

GET All User Port Across Fabric Metros

Array

href	string <uri> Equinix assigned response attribute for an absolute URL that is the subject of the link's context.
type	string (PortType) Value: "XF_PORT" Type of Port
uuid	string <uuid> Equinix assigned response attribute for port identifier
name	string Equinix assigned response attribute for Port name
description	string Equinix assigned response attribute for Port description
physicalPortsSpeed	integer >= 0 Physical Ports Speed in Mbps
connectionsCount	integer >= 0 Equinix assigned response attribute for Connection count
physicalPortsType	string Enum: "1000BASE_LX" "10GBASE_LR" "100GBASE_LR4" "10GBASE_ER" "1000BASE_SX" "10GBASE_SMF" "400GBASE_LR4" Physical Ports Type. 10GBASE_SMF and 400GBASE_LR4 are only used for IX ports
physicalPortsCount	integer
connectivitySourceType	string Enum: "COLO" "BMMR" "REMOTE" Port connectivity type
bmmrType	string Enum: "SELF" "EQUINIX"
	object (Project)
state	string (PortState) Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PENDING_CROSS_CONNECT" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED" Port lifecycle state
	object (PortOrder)
	object Operational specifications for ports.
	object (SimplifiedAccount)
	object (PortChange) Current state of latest port change
	object (Changelog) Change log
serviceType	string Deprecated Enum: "EPL" "MSP" Port service Type
serviceCode	string (PortServiceCode) Enum: "CX" "IX" "IA" "MC" Identifies the service type associated with this port
bandwidth	integer >= 0 Deprecated Equinix assigned response attribute for Port bandwidth in Mbps
availableBandwidth	integer >= 0 Equinix assigned response attribute for Port available bandwidth in Mbps
usedBandwidth	integer >= 0 Equinix assigned response attribute for Port used bandwidth in Mbps
	object (SimplifiedLocation)
	object (PortDevice) Port device
	object (PortInterface) Port interface
demarcationPointIbx	string A-side/Equinix ibx
tetherIbx	string z-side/Equinix ibx
	object (PortDemarcationPoint) Customer physical Port
	object (PortRedundancy) Port redundancy configuration
	object (PortEncapsulation) Port encapsulation configuration
lagEnabled	boolean If LAG enabled
	object Deprecated Port Lag
asn	integer Port ASN
	object (Package) Package settings for port
	object (PortSettings) Port configuration settings
physicalPortQuantity	integer Number of physical ports
	Array of objects (PortNotification) Notification preferences
	Array of objects (PortAdditionalInfo) Port additional information
	Array of objects (PhysicalPort) Physical ports that implement this port
	Array of objects (PortLoa) Port Loas
	object (marketplaceSubscription) Equinix Fabric Entity for Marketplace Subscription

Request samples

Payload

Content type

application/json

Example

PortSearchDirection

{"filter": {"or": [{"and": [{"property": "/state",
"operator": "=",
"values": ["ACTIVE",
"REPROVISIONING"
]
},
{"property": "/settings/productCode",
"operator": "=",
"values": ["CX"
]
},
{"property": "/project/projectId",
"operator": "=",
"values": ["66a2d2f7-b79b-49bc-8642-d2b3c1c138b4"
]
}
]
}
]
},
"pagination": {"limit": 1000,
"offset": 0
},
"sort": [{"property": "/device/name",
"direction": "DESC"
}
]
}

Response samples

200
400
401
404
500

Content type

application/json

{"pagination": {"offset": 0,
"limit": 1000,
"total": 2
},
"data": [{"href": "https://api.equinix.com/fabric/v4/ports/c4d93b39-02db-2dbc-ace0-30fa5c00ad04",
"type": "XF_PORT",
"uuid": "c4d93b39-02db-2dbc-ace0-30fa5c00ad04",
"name": "gen-l2-qa-01-auto-TY4-L-Qinq-STD-SEC-10G-JUN-598",
"physicalPortsSpeed": 10000,
"physicalPortsType": "10GBASE_LR",
"connectivitySourceType": "COLO",
"project": {"projectId": "333cd592-1709-4238-bb0d-2c2b41896aa1"
},
"package": {"code": "STANDARD"
},
"state": "REPROVISIONING",
"cvpId": "1616554",
"operation": {"connectionCount": 0,
"evplVCCount": 0,
"accessVCCount": 0
},
"account": {"accountNumber": 200559,
"accountName": "gen-l2-qa-01-auto-200559",
"orgId": 90946,
"organizationName": "gen-l2-qa-01-auto-200551.",
"ucmId": "500DFED2-EBDB-480d-896C-C7870E52D0D8",
"globalCustId": "0017i000011X242AAC"
},
"changeLog": {"createdBy": "vvyugovskiy-IMPORT_JOB",
"createdDateTime": "2021-06-16T01:46:52Z",
"updatedBy": "Order-to-activation",
"updatedDateTime": "2025-04-07T23:03:08.900Z"
},
"bandwidth": 10000,
"availableBandwidth": 10000,
"usedBandwidth": 0,
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/TY",
"region": "APAC",
"metroName": "Tokyo",
"metroCode": "TY",
"ibx": "TY4"
},
"device": {"name": "sit-tb1-ty-a2.lab",
"redundancy": {"priority": "SECONDARY"
}
},
"demarcationPointIbx": "TY4",
"tetherIbx": "TY4",
"redundancy": {"priority": "SECONDARY"
},
"encapsulation": {"type": "QINQ",
"tagProtocolId": "0x9100"
},
"lagEnabled": false,
"settings": {"buyout": false
},
"physicalPorts": [{"type": "XF_PHYSICAL_PORT",
"id": 1362185,
"state": "TO_BE_ADDED",
"uuid": "01892489-ce9b-7f25-b1f5-d32a5ac6a423",
"tether": {"crossConnectId": "ECX.05.00001836",
"cabinetNumber": "Demarc",
"systemName": "TY4:01:002181",
"patchPanel": "PP:1240:1089399",
"patchPanelPortA": "7",
"patchPanelPortB": "8",
"ibx": "TY4"
},
"demarcationPoint": {"patchPanel": "PP:Demarc:00002181",
"patchPanelName": "PP:Demarc:00002181",
"patchPanelPortA": "5",
"patchPanelPortB": "6",
"ibx": "TY4"
},
"operation": {"operationalStatus": "UP"
}
}
]
},
{"href": "https://api.equinix.com/fabric/v4/ports/6f0f3015-2d51-4b6e-a98c-1defb4fe88f1",
"type": "XF_PORT",
"uuid": "6f0f3015-2d51-4b6e-a98c-1defb4fe88f1",
"name": "200558-SY4-CX-PRI-02",
"physicalPortsSpeed": 10000,
"physicalPortsType": "10GBASE_LR",
"project": {"projectId": "333cd592-1709-4238-bb0d-2c2b41896aa1"
},
"package": {"code": "STANDARD"
},
"state": "ACTIVE",
"cvpId": "2000348",
"operation": {"connectionCount": 1,
"evplVCCount": 1,
"accessVCCount": 0,
"maintenanceStatus": "SCHEDULED",
"lockEnabled": true
},
"account": {"accountNumber": 200558,
"accountName": "Gen-L2-Qa-01-Auto-200558",
"orgId": 90946,
"organizationName": "gen-l2-qa-01-auto-200551.",
"ucmId": "2D26D682-B62E-495d-AFDF-698EC3B353F8",
"globalCustId": "0017i000011X242AAC"
},
"changeLog": {"createdDateTime": "2025-05-06T17:29:30.800Z",
"updatedBy": "API",
"updatedDateTime": "2025-05-06T17:29:40.300Z"
},
"bandwidth": 10000,
"availableBandwidth": 9500,
"usedBandwidth": 500,
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/SY",
"region": "APAC",
"metroName": "Sydney",
"metroCode": "SY",
"ibx": "SY4"
},
"device": {"name": "sit-tb1-sy-e1.lab",
"redundancy": {"group": "1",
"priority": "PRIMARY"
}
},
"demarcationPointIbx": "SY4",
"tetherIbx": "SY4",
"redundancy": {"priority": "PRIMARY"
},
"encapsulation": {"type": "DOT1Q",
"tagProtocolId": "0x8100"
},
"lagEnabled": true,
"settings": {"buyout": false
},
"physicalPorts": [{"type": "XF_PHYSICAL_PORT",
"id": 1362737,
"state": "ACTIVE",
"uuid": "01892489-ce07-7962-b676-b1a4d8091515",
"tether": {"crossConnectId": "22035616",
"cabinetNumber": "Demarc",
"systemName": "SY4:01:002204",
"patchPanel": "PP:1240:1089399",
"patchPanelPortA": "12",
"patchPanelPortB": "14",
"ibx": "SY4"
},
"demarcationPoint": {"patchPanel": "PP:Demarc:00002204",
"patchPanelName": "PP:Demarc:00002204",
"patchPanelPortA": "17",
"patchPanelPortB": "18",
"ibx": "SY4"
},
"operation": {"operationalStatus": "UP"
}
}
]
}
]
}

Port Packages

Port Packages ^Beta

List Port Packages

Get All Port Packages returns details of all available port packages for the specified user credentials

Authorizations:

BearerAuth

Responses

Response Schema: application/json

required

Array of objects (PortPackage)

List of Port Packages

Array

href	string Port Package URI
type required	string Value: "PORT_PACKAGE" Port Package Type
code required	string Port Package code
vcBandwidthMax	integer Maximum virtual connection bandwidth in Mbps
vcRemoteSupported	boolean Indicates if remote virtual connections are supported
supportedServiceTypes	Array of strings Items Value: "MSP" List of supported service types
supportedSourceTypes	Array of strings (PortPackageSourceType) Items Enum: "COLO" "REMOTE" "BMMR" List of supported source types
supportedMetros	Array of strings List of supported metros

Response samples

200
401
403
415
500

Content type

application/json

{"data": [{"href": "/fabric/v4/portPackages/XF_UNLIMITED_PLUS",
"type": "PORT_PACKAGE",
"code": "XF_UNLIMITED_PLUS",
"vcBandwidthMax": 100000,
"vcRemoteSupported": true,
"supportedServiceTypes": ["MSP"
],
"supportedSourceTypes": ["COLO"
],
"supportedMetros": ["SV",
"DA"
]
},
{"href": "/fabric/v4/portPackages/XF_UNLIMITED",
"type": "PORT_PACKAGE",
"code": "XF_UNLIMITED",
"vcBandwidthMax": 100000,
"vcRemoteSupported": false,
"supportedServiceTypes": ["MSP"
],
"supportedSourceTypes": ["REMOTE",
"COLO"
]
},
{"href": "/fabric/v4/portPackages/XF_STANDARD",
"type": "PORT_PACKAGE",
"code": "XF_STANDARD",
"vcBandwidthMax": 100000,
"vcRemoteSupported": false,
"supportedServiceTypes": ["MSP"
],
"supportedSourceTypes": ["BMMR",
"REMOTE",
"COLO"
]
}
]
}

Connections

Create Connection

This API provides capability to create user's virtual connection

Authorizations:

BearerAuth

query Parameters

dryRun

boolean

Default: false

option to verify that API calls will succeed

Request Body schema: application/json
required

type

required

string (ConnectionType)

Enum: "EVPL_VC" "EPL_VC" "EC_VC" "IP_VC" "ACCESS_EPL_VC" "EIA_VC" "EVPLAN_VC" "EPLAN_VC" "EVPTREE_VC" "EPTREE_VC" "IPWAN_VC" "IA_VC" "MC_VC" "IX_VC" "GW_VC" "IPX_VC"

Connection type

name

required

string

Customer-provided connection name

object (Order)

purchaseOrderNumber	string Purchase order number
customerReferenceNumber	string Customer reference number
billingTier	string Billing tier for connection bandwidth
orderId	string Order Identification
orderNumber	string Order Reference Number
termLength	integer [ 1 .. 60 ] Default: 1 Term length in months, valid values are 1, 12, 24, 36, 60 where 1 is the default value (for on-demand case).
contractedBandwidth	integer Contracted bandwidth

required

Array of objects (SimplifiedNotification)

Preferences for notifications on connection configuration or status changes

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

bandwidth

required

integer [ 0 .. 100000 ]

Connection bandwidth in Mbps

geoScope

string (GeoScopeType)

Enum: "CANADA" "CONUS" "JAPAN" "UK" "AUSTRALIA" "BRAZIL" "SWITZERLAND" "EU"

Geographic boundary types

object (ConnectionRedundancy)

Connection redundancy configuration

group	string Redundancy group identifier (UUID of primary connection)
priority	string (ConnectionPriority) Enum: "PRIMARY" "SECONDARY" Connection priority in redundancy group
name	string Customer-provided name for the redundancy group
description	string Customer-provided description for the redundancy group

required

object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (ServiceToken)

Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.

type	string (ServiceTokenType) Enum: "VC_TOKEN" "EPL_TOKEN" Type of Service Token
expiry	integer Deprecated
uuid	string <uuid> Equinix-assigned service token identifier
issuerSide	string Deprecated information about token side
name	string Customer-provided service token name
description	string Customer-provided service token description
expirationDateTime	string <date-time> Expiration date and time of the service token.
	object (ServiceTokenConnection) Service Token Connection Type Information
state	string (ServiceTokenState) Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED" Service token state
	Array of objects (SimplifiedNotification) Service token related notifications
	object (SimplifiedAccount)
	object (Changelog) Change log
	object (Project)

object (AccessPoint)

Access point object

type	string (AccessPointType) Enum: "VD" "VG" "SP" "IGW" "COLO" "SUBNET" "CLOUD_ROUTER" "NETWORK" "METAL_NETWORK" "VPIC_INTERFACE" "APP_LINK" "IC" Access point type
	object (SimplifiedAccount)
	object (SimplifiedLocation)
	object (SimplifiedPort) Port specification
	object (SimplifiedServiceProfile) Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.
	object (CloudRouter) Fabric Cloud Router object
	object (SimplifiedLinkProtocol) Connection link protocol Configuration
	object (VirtualDevice) Virtual Device AccessPoint Information
	object (Interface) Interface Information
	object (SimplifiedNetwork) Network specification
	object (ProviderEnvironment) Provider Environment associated with an IC_PROFILE service profile ^Beta
sellerRegion	string Access point seller region
peeringType	string (PeeringType) Enum: "PRIVATE" "MICROSOFT" "PUBLIC" "MANUAL" Access point peering type
authenticationKey	string Access point authentication key
activationKey	string Access point activation key
providerConnectionId	string Provider assigned Connection Id
	object (VirtualNetwork) Virtual Network Information
	object (MetalInterconnection) Metal Interconnection
role	string Enum: "LEAF" "ROOT" E-Tree network connection role
	object (ProductOffering) Product offering for connection. Applicable to zSide only.
bandwidthCommit	integer [ 0 .. 100000 ] Bandwidth commit in Mbps
providerIdentifier	string Provider identifier
	object (Address) Address.

Array of objects (ConnectionSideAdditionalInfo)

Any additional information, which is not part of connection metadata or configuration

Array

key	string Key
value	string Value

required

object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (ServiceToken)

Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.

type	string (ServiceTokenType) Enum: "VC_TOKEN" "EPL_TOKEN" Type of Service Token
expiry	integer Deprecated
uuid	string <uuid> Equinix-assigned service token identifier
issuerSide	string Deprecated information about token side
name	string Customer-provided service token name
description	string Customer-provided service token description
expirationDateTime	string <date-time> Expiration date and time of the service token.
	object (ServiceTokenConnection) Service Token Connection Type Information
state	string (ServiceTokenState) Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED" Service token state
	Array of objects (SimplifiedNotification) Service token related notifications
	object (SimplifiedAccount)
	object (Changelog) Change log
	object (Project)

object (AccessPoint)

Access point object

type	string (AccessPointType) Enum: "VD" "VG" "SP" "IGW" "COLO" "SUBNET" "CLOUD_ROUTER" "NETWORK" "METAL_NETWORK" "VPIC_INTERFACE" "APP_LINK" "IC" Access point type
	object (SimplifiedAccount)
	object (SimplifiedLocation)
	object (SimplifiedPort) Port specification
	object (SimplifiedServiceProfile) Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.
	object (CloudRouter) Fabric Cloud Router object
	object (SimplifiedLinkProtocol) Connection link protocol Configuration
	object (VirtualDevice) Virtual Device AccessPoint Information
	object (Interface) Interface Information
	object (SimplifiedNetwork) Network specification
	object (ProviderEnvironment) Provider Environment associated with an IC_PROFILE service profile ^Beta
sellerRegion	string Access point seller region
peeringType	string (PeeringType) Enum: "PRIVATE" "MICROSOFT" "PUBLIC" "MANUAL" Access point peering type
authenticationKey	string Access point authentication key
activationKey	string Access point activation key
providerConnectionId	string Provider assigned Connection Id
	object (VirtualNetwork) Virtual Network Information
	object (MetalInterconnection) Metal Interconnection
role	string Enum: "LEAF" "ROOT" E-Tree network connection role
	object (ProductOffering) Product offering for connection. Applicable to zSide only.
bandwidthCommit	integer [ 0 .. 100000 ] Bandwidth commit in Mbps
providerIdentifier	string Provider identifier
	object (Address) Address.

Array of objects (ConnectionSideAdditionalInfo)

Any additional information, which is not part of connection metadata or configuration

Array

key	string Key
value	string Value

object (Project)

projectId

required

string

Subscriber-assigned project ID

Array of objects (ConnectionSideAdditionalInfo)

Connection additional information

Array

key	string Key
value	string Value

object (marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

type	string Enum: "AWS_MARKETPLACE_SUBSCRIPTION" "GCP_MARKETPLACE_SUBSCRIPTION" "AZURE_MARKETPLACE_SUBSCRIPTION" Marketplace Subscription type
uuid	string Equinix-assigned Marketplace Subscription identifier

Responses

Response Schema: application/json

href

string <uri>

Connection URI

type

required

string (ConnectionType)

Enum: "EVPL_VC" "EPL_VC" "EC_VC" "IP_VC" "ACCESS_EPL_VC" "EIA_VC" "EVPLAN_VC" "EPLAN_VC" "EVPTREE_VC" "EPTREE_VC" "IPWAN_VC" "IA_VC" "MC_VC" "IX_VC" "GW_VC" "IPX_VC"

Connection type

uuid

string

Equinix-assigned connection identifier

name

required

string

Customer-provided connection name

description

string

Customer-provided connection description

object (Change)

Current state of latest connection change

uuid

string

Uniquely identifies a change

type

required

string

Enum: "CONNECTION_CREATION" "CONNECTION_UPDATE" "CONNECTION_DELETION" "CONNECTION_PROVIDER_STATUS_REQUEST"

Type of change

status

string

Enum: "APPROVED" "COMPLETED" "FAILED" "REJECTED" "REQUESTED" "SUBMITTED_FOR_APPROVAL"

Current outcome of the change flow

createdDateTime

required

string <date-time>

Set when change flow starts

updatedDateTime

string <date-time>

Set when change object is updated

information

string

Additional information

object (ConnectionChangeOperation)

Connection change operation data

op required	string Handy shortcut for operation name
path required	string path inside document leading to updated parameter
value required	any new value for updated parameter

object (ConnectionOperation)

Connection type-specific operational data

providerStatus

string (ProviderStatus)

Enum: "AVAILABLE" "DEPROVISIONED" "DEPROVISIONING" "FAILED" "NOT_AVAILABLE" "PENDING_APPROVAL" "PENDING_CONFIGURATION" "PROVISIONED" "PROVISIONING" "REJECTED" "PENDING_BGP" "ERROR" "ORDERING" "DELETING" "PENDING DELETE" "N/A" "QUOTING"

Connection provider readiness status

equinixStatus

string (EquinixStatus)

Enum: "REJECTED_ACK" "REJECTED" "PENDING_DELETE" "PROVISIONED" "PENDING_APPROVAL" "NOT_PROVISIONED" "DEPROVISIONING" "NOT_DEPROVISIONED" "PENDING_AUTO_APPROVAL" "PROVISIONING" "PENDING_BGP_PEERING" "PENDING_PROVIDER_VLAN" "DEPROVISIONED" "DELETED" "AUTO_APPROVAL_FAILED" "PENDING_PROVIDER_VLAN_ERROR" "DRAFT" "CANCELLED" "PENDING_INTERFACE_CONFIGURATION"

Connection status

operationalStatus

string

Enum: "UP" "DOWN"

Connection operational status

Array of objects (Error)

Array

errorCode required	string^EQ-\d{7}$
errorMessage required	string
correlationId	string
details	string
help	string
	Array of objects

opStatusChangedAt

string <date-time>

When connection transitioned into current operational status

maintenanceStatus

string

Enum: "SCHEDULED" "IN_PROGRESS" "COMPLETED" "CANCELLED" "POSTPONED"

Maintenance lifecycle state

lockEnabled

boolean

Indicates whether the connection configuration is locked due to an ongoing or scheduled maintenance.

object (Order)

purchaseOrderNumber	string Purchase order number
customerReferenceNumber	string Customer reference number
billingTier	string Billing tier for connection bandwidth
orderId	string Order Identification
orderNumber	string Order Reference Number
termLength	integer [ 1 .. 60 ] Default: 1 Term length in months, valid values are 1, 12, 24, 36, 60 where 1 is the default value (for on-demand case).
contractedBandwidth	integer Contracted bandwidth

Array of objects (SimplifiedNotification)

Preferences for notifications on connection configuration or status changes

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

bandwidth

required

integer [ 0 .. 10000 ]

Connection bandwidth in Mbps

geoScope

string (GeoScopeType)

Enum: "CANADA" "CONUS" "JAPAN" "UK" "AUSTRALIA" "BRAZIL" "SWITZERLAND" "EU"

Geographic boundary types

object (ConnectionRedundancy)

Connection redundancy configuration

group	string Redundancy group identifier (UUID of primary connection)
priority	string (ConnectionPriority) Enum: "PRIMARY" "SECONDARY" Connection priority in redundancy group
name	string Customer-provided name for the redundancy group
description	string Customer-provided description for the redundancy group

isRemote

boolean

Connection property derived from access point locations

direction

string (ConnectionDirection)

Enum: "INTERNAL" "INCOMING" "OUTGOING"

Connection directionality from the requester point of view

required

object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (ServiceToken)

Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.

type	string (ServiceTokenType) Enum: "VC_TOKEN" "EPL_TOKEN" Type of Service Token
href	string <uri> An absolute URL that is the subject of the link's context.
expiry	integer Deprecated
uuid	string <uuid> Equinix-assigned service token identifier
issuerSide	string Deprecated information about token side
name	string Customer-provided service token name
description	string Customer-provided service token description
expirationDateTime	string <date-time> Expiration date and time of the service token.
	object (ServiceTokenConnection) Service Token Connection Type Information
state	string (ServiceTokenState) Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED" Service token state
	Array of objects (SimplifiedNotification) Service token related notifications
	object (SimplifiedAccount)
	object (Changelog) Change log
	object (Project)

object (AccessPoint)

Access point object

type	string (AccessPointType) Enum: "VD" "VG" "SP" "IGW" "COLO" "SUBNET" "CLOUD_ROUTER" "NETWORK" "METAL_NETWORK" "VPIC_INTERFACE" "APP_LINK" "IC" Access point type
	object (SimplifiedAccount)
	object (SimplifiedLocation)
	object (SimplifiedPort) Port specification
	object (SimplifiedServiceProfile) Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.
	object (CloudRouter) Fabric Cloud Router object
	object (SimplifiedLinkProtocol) Connection link protocol Configuration
	object (VirtualDevice) Virtual Device AccessPoint Information
	object (Interface) Interface Information
	object (SimplifiedNetwork) Network specification
	object (ProviderEnvironment) Provider Environment associated with an IC_PROFILE service profile ^Beta
sellerRegion	string Access point seller region
peeringType	string (PeeringType) Enum: "PRIVATE" "MICROSOFT" "PUBLIC" "MANUAL" Access point peering type
authenticationKey	string Access point authentication key
activationKey	string Access point activation key
providerConnectionId	string Provider assigned Connection Id
	object (VirtualNetwork) Virtual Network Information
	object (MetalInterconnection) Metal Interconnection
role	string Enum: "LEAF" "ROOT" E-Tree network connection role
	object (ProductOffering) Product offering for connection. Applicable to zSide only.
bandwidthCommit	integer [ 0 .. 100000 ] Bandwidth commit in Mbps
providerIdentifier	string Provider identifier
	object (Address) Address.

Array of objects (ConnectionSideAdditionalInfo)

Any additional information, which is not part of connection metadata or configuration

Array

key	string Key
value	string Value

required

object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (ServiceToken)

Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.

type	string (ServiceTokenType) Enum: "VC_TOKEN" "EPL_TOKEN" Type of Service Token
href	string <uri> An absolute URL that is the subject of the link's context.
expiry	integer Deprecated
uuid	string <uuid> Equinix-assigned service token identifier
issuerSide	string Deprecated information about token side
name	string Customer-provided service token name
description	string Customer-provided service token description
expirationDateTime	string <date-time> Expiration date and time of the service token.
	object (ServiceTokenConnection) Service Token Connection Type Information
state	string (ServiceTokenState) Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED" Service token state
	Array of objects (SimplifiedNotification) Service token related notifications
	object (SimplifiedAccount)
	object (Changelog) Change log
	object (Project)

object (AccessPoint)

Access point object

type	string (AccessPointType) Enum: "VD" "VG" "SP" "IGW" "COLO" "SUBNET" "CLOUD_ROUTER" "NETWORK" "METAL_NETWORK" "VPIC_INTERFACE" "APP_LINK" "IC" Access point type
	object (SimplifiedAccount)
	object (SimplifiedLocation)
	object (SimplifiedPort) Port specification
	object (SimplifiedServiceProfile) Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.
	object (CloudRouter) Fabric Cloud Router object
	object (SimplifiedLinkProtocol) Connection link protocol Configuration
	object (VirtualDevice) Virtual Device AccessPoint Information
	object (Interface) Interface Information
	object (SimplifiedNetwork) Network specification
	object (ProviderEnvironment) Provider Environment associated with an IC_PROFILE service profile ^Beta
sellerRegion	string Access point seller region
peeringType	string (PeeringType) Enum: "PRIVATE" "MICROSOFT" "PUBLIC" "MANUAL" Access point peering type
authenticationKey	string Access point authentication key
activationKey	string Access point activation key
providerConnectionId	string Provider assigned Connection Id
	object (VirtualNetwork) Virtual Network Information
	object (MetalInterconnection) Metal Interconnection
role	string Enum: "LEAF" "ROOT" E-Tree network connection role
	object (ProductOffering) Product offering for connection. Applicable to zSide only.
bandwidthCommit	integer [ 0 .. 100000 ] Bandwidth commit in Mbps
providerIdentifier	string Provider identifier
	object (Address) Address.

Array of objects (ConnectionSideAdditionalInfo)

Any additional information, which is not part of connection metadata or configuration

Array

key	string Key
value	string Value

object (marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

href	string <uri> Marketplace Subscription URI
type	string Enum: "AWS_MARKETPLACE_SUBSCRIPTION" "GCP_MARKETPLACE_SUBSCRIPTION" "AZURE_MARKETPLACE_SUBSCRIPTION" Marketplace Subscription type
uuid	string Equinix-assigned Marketplace Subscription identifier

Array of objects (ConnectionSideAdditionalInfo)

Connection additional information

Array

key	string Key
value	string Value

object (Project)

projectId

required

string

Subscriber-assigned project ID

Response Schema: application/json

href

string <uri>

Connection URI

type

required

string (ConnectionType)

Enum: "EVPL_VC" "EPL_VC" "EC_VC" "IP_VC" "ACCESS_EPL_VC" "EIA_VC" "EVPLAN_VC" "EPLAN_VC" "EVPTREE_VC" "EPTREE_VC" "IPWAN_VC" "IA_VC" "MC_VC" "IX_VC" "GW_VC" "IPX_VC"

Connection type

uuid

string

Equinix-assigned connection identifier

name

required

string

Customer-provided connection name

description

string

Customer-provided connection description

object (Change)

Current state of latest connection change

uuid

string

Uniquely identifies a change

type

required

string

Enum: "CONNECTION_CREATION" "CONNECTION_UPDATE" "CONNECTION_DELETION" "CONNECTION_PROVIDER_STATUS_REQUEST"

Type of change

status

string

Enum: "APPROVED" "COMPLETED" "FAILED" "REJECTED" "REQUESTED" "SUBMITTED_FOR_APPROVAL"

Current outcome of the change flow

createdDateTime

required

string <date-time>

Set when change flow starts

updatedDateTime

string <date-time>

Set when change object is updated

information

string

Additional information

object (ConnectionChangeOperation)

Connection change operation data

op required	string Handy shortcut for operation name
path required	string path inside document leading to updated parameter
value required	any new value for updated parameter

object (ConnectionOperation)

Connection type-specific operational data

providerStatus

string (ProviderStatus)

Enum: "AVAILABLE" "DEPROVISIONED" "DEPROVISIONING" "FAILED" "NOT_AVAILABLE" "PENDING_APPROVAL" "PENDING_CONFIGURATION" "PROVISIONED" "PROVISIONING" "REJECTED" "PENDING_BGP" "ERROR" "ORDERING" "DELETING" "PENDING DELETE" "N/A" "QUOTING"

Connection provider readiness status

equinixStatus

string (EquinixStatus)

Enum: "REJECTED_ACK" "REJECTED" "PENDING_DELETE" "PROVISIONED" "PENDING_APPROVAL" "NOT_PROVISIONED" "DEPROVISIONING" "NOT_DEPROVISIONED" "PENDING_AUTO_APPROVAL" "PROVISIONING" "PENDING_BGP_PEERING" "PENDING_PROVIDER_VLAN" "DEPROVISIONED" "DELETED" "AUTO_APPROVAL_FAILED" "PENDING_PROVIDER_VLAN_ERROR" "DRAFT" "CANCELLED" "PENDING_INTERFACE_CONFIGURATION"

Connection status

operationalStatus

string

Enum: "UP" "DOWN"

Connection operational status

Array of objects (Error)

Array

errorCode required	string^EQ-\d{7}$
errorMessage required	string
correlationId	string
details	string
help	string
	Array of objects

opStatusChangedAt

string <date-time>

When connection transitioned into current operational status

maintenanceStatus

string

Enum: "SCHEDULED" "IN_PROGRESS" "COMPLETED" "CANCELLED" "POSTPONED"

Maintenance lifecycle state

lockEnabled

boolean

Indicates whether the connection configuration is locked due to an ongoing or scheduled maintenance.

object (Order)

purchaseOrderNumber	string Purchase order number
customerReferenceNumber	string Customer reference number
billingTier	string Billing tier for connection bandwidth
orderId	string Order Identification
orderNumber	string Order Reference Number
termLength	integer [ 1 .. 60 ] Default: 1 Term length in months, valid values are 1, 12, 24, 36, 60 where 1 is the default value (for on-demand case).
contractedBandwidth	integer Contracted bandwidth

Array of objects (SimplifiedNotification)

Preferences for notifications on connection configuration or status changes

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

bandwidth

required

integer [ 0 .. 10000 ]

Connection bandwidth in Mbps

geoScope

string (GeoScopeType)

Enum: "CANADA" "CONUS" "JAPAN" "UK" "AUSTRALIA" "BRAZIL" "SWITZERLAND" "EU"

Geographic boundary types

object (ConnectionRedundancy)

Connection redundancy configuration

group	string Redundancy group identifier (UUID of primary connection)
priority	string (ConnectionPriority) Enum: "PRIMARY" "SECONDARY" Connection priority in redundancy group
name	string Customer-provided name for the redundancy group
description	string Customer-provided description for the redundancy group

isRemote

boolean

Connection property derived from access point locations

direction

string (ConnectionDirection)

Enum: "INTERNAL" "INCOMING" "OUTGOING"

Connection directionality from the requester point of view

required

object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (ServiceToken)

Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.

type	string (ServiceTokenType) Enum: "VC_TOKEN" "EPL_TOKEN" Type of Service Token
href	string <uri> An absolute URL that is the subject of the link's context.
expiry	integer Deprecated
uuid	string <uuid> Equinix-assigned service token identifier
issuerSide	string Deprecated information about token side
name	string Customer-provided service token name
description	string Customer-provided service token description
expirationDateTime	string <date-time> Expiration date and time of the service token.
	object (ServiceTokenConnection) Service Token Connection Type Information
state	string (ServiceTokenState) Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED" Service token state
	Array of objects (SimplifiedNotification) Service token related notifications
	object (SimplifiedAccount)
	object (Changelog) Change log
	object (Project)

object (AccessPoint)

Access point object

type	string (AccessPointType) Enum: "VD" "VG" "SP" "IGW" "COLO" "SUBNET" "CLOUD_ROUTER" "NETWORK" "METAL_NETWORK" "VPIC_INTERFACE" "APP_LINK" "IC" Access point type
	object (SimplifiedAccount)
	object (SimplifiedLocation)
	object (SimplifiedPort) Port specification
	object (SimplifiedServiceProfile) Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.
	object (CloudRouter) Fabric Cloud Router object
	object (SimplifiedLinkProtocol) Connection link protocol Configuration
	object (VirtualDevice) Virtual Device AccessPoint Information
	object (Interface) Interface Information
	object (SimplifiedNetwork) Network specification
	object (ProviderEnvironment) Provider Environment associated with an IC_PROFILE service profile ^Beta
sellerRegion	string Access point seller region
peeringType	string (PeeringType) Enum: "PRIVATE" "MICROSOFT" "PUBLIC" "MANUAL" Access point peering type
authenticationKey	string Access point authentication key
activationKey	string Access point activation key
providerConnectionId	string Provider assigned Connection Id
	object (VirtualNetwork) Virtual Network Information
	object (MetalInterconnection) Metal Interconnection
role	string Enum: "LEAF" "ROOT" E-Tree network connection role
	object (ProductOffering) Product offering for connection. Applicable to zSide only.
bandwidthCommit	integer [ 0 .. 100000 ] Bandwidth commit in Mbps
providerIdentifier	string Provider identifier
	object (Address) Address.

Array of objects (ConnectionSideAdditionalInfo)

Any additional information, which is not part of connection metadata or configuration

Array

key	string Key
value	string Value

required

object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (ServiceToken)

Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.

type	string (ServiceTokenType) Enum: "VC_TOKEN" "EPL_TOKEN" Type of Service Token
href	string <uri> An absolute URL that is the subject of the link's context.
expiry	integer Deprecated
uuid	string <uuid> Equinix-assigned service token identifier
issuerSide	string Deprecated information about token side
name	string Customer-provided service token name
description	string Customer-provided service token description
expirationDateTime	string <date-time> Expiration date and time of the service token.
	object (ServiceTokenConnection) Service Token Connection Type Information
state	string (ServiceTokenState) Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED" Service token state
	Array of objects (SimplifiedNotification) Service token related notifications
	object (SimplifiedAccount)
	object (Changelog) Change log
	object (Project)

object (AccessPoint)

Access point object

type	string (AccessPointType) Enum: "VD" "VG" "SP" "IGW" "COLO" "SUBNET" "CLOUD_ROUTER" "NETWORK" "METAL_NETWORK" "VPIC_INTERFACE" "APP_LINK" "IC" Access point type
	object (SimplifiedAccount)
	object (SimplifiedLocation)
	object (SimplifiedPort) Port specification
	object (SimplifiedServiceProfile) Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.
	object (CloudRouter) Fabric Cloud Router object
	object (SimplifiedLinkProtocol) Connection link protocol Configuration
	object (VirtualDevice) Virtual Device AccessPoint Information
	object (Interface) Interface Information
	object (SimplifiedNetwork) Network specification
	object (ProviderEnvironment) Provider Environment associated with an IC_PROFILE service profile ^Beta
sellerRegion	string Access point seller region
peeringType	string (PeeringType) Enum: "PRIVATE" "MICROSOFT" "PUBLIC" "MANUAL" Access point peering type
authenticationKey	string Access point authentication key
activationKey	string Access point activation key
providerConnectionId	string Provider assigned Connection Id
	object (VirtualNetwork) Virtual Network Information
	object (MetalInterconnection) Metal Interconnection
role	string Enum: "LEAF" "ROOT" E-Tree network connection role
	object (ProductOffering) Product offering for connection. Applicable to zSide only.
bandwidthCommit	integer [ 0 .. 100000 ] Bandwidth commit in Mbps
providerIdentifier	string Provider identifier
	object (Address) Address.

Array of objects (ConnectionSideAdditionalInfo)

Any additional information, which is not part of connection metadata or configuration

Array

key	string Key
value	string Value

object (marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

href	string <uri> Marketplace Subscription URI
type	string Enum: "AWS_MARKETPLACE_SUBSCRIPTION" "GCP_MARKETPLACE_SUBSCRIPTION" "AZURE_MARKETPLACE_SUBSCRIPTION" Marketplace Subscription type
uuid	string Equinix-assigned Marketplace Subscription identifier

Array of objects (ConnectionSideAdditionalInfo)

Connection additional information

Array

key	string Key
value	string Value

object (Project)

projectId

required

string

Subscriber-assigned project ID

Request samples

Payload

Content type

application/json

Example

Colo2Colo-Dot1q2Dot1q

{"type": "EVPL_VC",
"name": "My-Port-2-Port-Connection-1",
"bandwidth": 1000,
"order": {"purchaseOrderNumber": "po1234",
"termLength": 1
},
"aSide": {"accessPoint": {"type": "COLO",
"port": {"uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee063"
},
"linkProtocol": {"type": "DOT1Q",
"vlanTag": 1001
}
}
},
"zSide": {"accessPoint": {"type": "COLO",
"port": {"uuid": "a00cef6f-8e35-4794-9ff9-665e084e4e6d"
},
"linkProtocol": {"type": "DOT1Q",
"vlanTag": 1001
}
}
},
"project": {"projectId": "ac4d34ca-0d9c-4bc2-9aab-1234567abcde"
},
"notifications": [{"type": "ALL",
"emails": ["test@test.com"
]
}
]
}

Response samples

Content type

application/json

Example

ConnectionDryRun-Colo2AWS

{"type": "EVPL_VC",
"name": "Colo to AWS Connection",
"bandwidth": 50,
"redundancy": {"priority": "PRIMARY"
},
"aSide": {"accessPoint": {"type": "COLO",
"port": {"href": "https://api.equinix.com/fabric/v4/ports/2a4fb415-5a7f-436f-bae6-02f5e403deec",
"uuid": "2a4fb415-5a7f-436f-bae6-02f5e403deec"
},
"linkProtocol": {"type": "DOT1Q",
"vlanTag": 1137
}
}
},
"zSide": {"accessPoint": {"type": "SP",
"profile": {"href": "https://api.equinix.com/fabric/v4/serviceProfiles/20d32a80-0d61-4333-bc03-707b591ae2f5",
"type": "L2_PROFILE",
"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f5"
},
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/SV",
"metroCode": "SV"
},
"sellerRegion": "us-west-1",
"authenticationKey": "xxx-xxx-xxx"
}
},
"project": {"projectId": "a347a370-39b5-427f-c330-7471a9abd9"
},
"order": {"purchaseOrderNumber": "1-129105284100"
},
"notifications": [{"type": "ALL",
"emails": ["test@test.com"
]
}
]
}

Get Connection by ID

The API provides capability to get user's virtual connection details (Service Tokens, Access Points, Link Protocols, etc) by it's connection ID (UUID)

Authorizations:

BearerAuth

path Parameters

connectionId

required

string

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

Connection Id

query Parameters

direction

string (ConnectionDirection)

Enum: "INTERNAL" "INCOMING" "OUTGOING"

Connection Direction

Responses

Response Schema: application/json

href

string <uri>

Connection URI

type

required

string (ConnectionType)

Enum: "EVPL_VC" "EPL_VC" "EC_VC" "IP_VC" "ACCESS_EPL_VC" "EIA_VC" "EVPLAN_VC" "EPLAN_VC" "EVPTREE_VC" "EPTREE_VC" "IPWAN_VC" "IA_VC" "MC_VC" "IX_VC" "GW_VC" "IPX_VC"

Connection type

uuid

string

Equinix-assigned connection identifier

name

required

string

Customer-provided connection name

description

string

Customer-provided connection description

object (Change)

Current state of latest connection change

uuid

string

Uniquely identifies a change

type

required

string

Enum: "CONNECTION_CREATION" "CONNECTION_UPDATE" "CONNECTION_DELETION" "CONNECTION_PROVIDER_STATUS_REQUEST"

Type of change

status

string

Enum: "APPROVED" "COMPLETED" "FAILED" "REJECTED" "REQUESTED" "SUBMITTED_FOR_APPROVAL"

Current outcome of the change flow

createdDateTime

required

string <date-time>

Set when change flow starts

updatedDateTime

string <date-time>

Set when change object is updated

information

string

Additional information

object (ConnectionChangeOperation)

Connection change operation data

op required	string Handy shortcut for operation name
path required	string path inside document leading to updated parameter
value required	any new value for updated parameter

object (ConnectionOperation)

Connection type-specific operational data

providerStatus

string (ProviderStatus)

Enum: "AVAILABLE" "DEPROVISIONED" "DEPROVISIONING" "FAILED" "NOT_AVAILABLE" "PENDING_APPROVAL" "PENDING_CONFIGURATION" "PROVISIONED" "PROVISIONING" "REJECTED" "PENDING_BGP" "ERROR" "ORDERING" "DELETING" "PENDING DELETE" "N/A" "QUOTING"

Connection provider readiness status

equinixStatus

string (EquinixStatus)

Enum: "REJECTED_ACK" "REJECTED" "PENDING_DELETE" "PROVISIONED" "PENDING_APPROVAL" "NOT_PROVISIONED" "DEPROVISIONING" "NOT_DEPROVISIONED" "PENDING_AUTO_APPROVAL" "PROVISIONING" "PENDING_BGP_PEERING" "PENDING_PROVIDER_VLAN" "DEPROVISIONED" "DELETED" "AUTO_APPROVAL_FAILED" "PENDING_PROVIDER_VLAN_ERROR" "DRAFT" "CANCELLED" "PENDING_INTERFACE_CONFIGURATION"

Connection status

operationalStatus

string

Enum: "UP" "DOWN"

Connection operational status

Array of objects (Error)

Array

errorCode required	string^EQ-\d{7}$
errorMessage required	string
correlationId	string
details	string
help	string
	Array of objects

opStatusChangedAt

string <date-time>

When connection transitioned into current operational status

maintenanceStatus

string

Enum: "SCHEDULED" "IN_PROGRESS" "COMPLETED" "CANCELLED" "POSTPONED"

Maintenance lifecycle state

lockEnabled

boolean

Indicates whether the connection configuration is locked due to an ongoing or scheduled maintenance.

object (Order)

purchaseOrderNumber	string Purchase order number
customerReferenceNumber	string Customer reference number
billingTier	string Billing tier for connection bandwidth
orderId	string Order Identification
orderNumber	string Order Reference Number
termLength	integer [ 1 .. 60 ] Default: 1 Term length in months, valid values are 1, 12, 24, 36, 60 where 1 is the default value (for on-demand case).
contractedBandwidth	integer Contracted bandwidth

Array of objects (SimplifiedNotification)

Preferences for notifications on connection configuration or status changes

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

bandwidth

required

integer [ 0 .. 10000 ]

Connection bandwidth in Mbps

geoScope

string (GeoScopeType)

Enum: "CANADA" "CONUS" "JAPAN" "UK" "AUSTRALIA" "BRAZIL" "SWITZERLAND" "EU"

Geographic boundary types

object (ConnectionRedundancy)

Connection redundancy configuration

group	string Redundancy group identifier (UUID of primary connection)
priority	string (ConnectionPriority) Enum: "PRIMARY" "SECONDARY" Connection priority in redundancy group
name	string Customer-provided name for the redundancy group
description	string Customer-provided description for the redundancy group

isRemote

boolean

Connection property derived from access point locations

direction

string (ConnectionDirection)

Enum: "INTERNAL" "INCOMING" "OUTGOING"

Connection directionality from the requester point of view

required

object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (ServiceToken)

Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.

type	string (ServiceTokenType) Enum: "VC_TOKEN" "EPL_TOKEN" Type of Service Token
href	string <uri> An absolute URL that is the subject of the link's context.
expiry	integer Deprecated
uuid	string <uuid> Equinix-assigned service token identifier
issuerSide	string Deprecated information about token side
name	string Customer-provided service token name
description	string Customer-provided service token description
expirationDateTime	string <date-time> Expiration date and time of the service token.
	object (ServiceTokenConnection) Service Token Connection Type Information
state	string (ServiceTokenState) Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED" Service token state
	Array of objects (SimplifiedNotification) Service token related notifications
	object (SimplifiedAccount)
	object (Changelog) Change log
	object (Project)

object (AccessPoint)

Access point object

type	string (AccessPointType) Enum: "VD" "VG" "SP" "IGW" "COLO" "SUBNET" "CLOUD_ROUTER" "NETWORK" "METAL_NETWORK" "VPIC_INTERFACE" "APP_LINK" "IC" Access point type
	object (SimplifiedAccount)
	object (SimplifiedLocation)
	object (SimplifiedPort) Port specification
	object (SimplifiedServiceProfile) Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.
	object (CloudRouter) Fabric Cloud Router object
	object (SimplifiedLinkProtocol) Connection link protocol Configuration
	object (VirtualDevice) Virtual Device AccessPoint Information
	object (Interface) Interface Information
	object (SimplifiedNetwork) Network specification
	object (ProviderEnvironment) Provider Environment associated with an IC_PROFILE service profile ^Beta
sellerRegion	string Access point seller region
peeringType	string (PeeringType) Enum: "PRIVATE" "MICROSOFT" "PUBLIC" "MANUAL" Access point peering type
authenticationKey	string Access point authentication key
activationKey	string Access point activation key
providerConnectionId	string Provider assigned Connection Id
	object (VirtualNetwork) Virtual Network Information
	object (MetalInterconnection) Metal Interconnection
role	string Enum: "LEAF" "ROOT" E-Tree network connection role
	object (ProductOffering) Product offering for connection. Applicable to zSide only.
bandwidthCommit	integer [ 0 .. 100000 ] Bandwidth commit in Mbps
providerIdentifier	string Provider identifier
	object (Address) Address.

Array of objects (ConnectionSideAdditionalInfo)

Any additional information, which is not part of connection metadata or configuration

Array

key	string Key
value	string Value

required

object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (ServiceToken)

Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.

type	string (ServiceTokenType) Enum: "VC_TOKEN" "EPL_TOKEN" Type of Service Token
href	string <uri> An absolute URL that is the subject of the link's context.
expiry	integer Deprecated
uuid	string <uuid> Equinix-assigned service token identifier
issuerSide	string Deprecated information about token side
name	string Customer-provided service token name
description	string Customer-provided service token description
expirationDateTime	string <date-time> Expiration date and time of the service token.
	object (ServiceTokenConnection) Service Token Connection Type Information
state	string (ServiceTokenState) Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED" Service token state
	Array of objects (SimplifiedNotification) Service token related notifications
	object (SimplifiedAccount)
	object (Changelog) Change log
	object (Project)

object (AccessPoint)

Access point object

type	string (AccessPointType) Enum: "VD" "VG" "SP" "IGW" "COLO" "SUBNET" "CLOUD_ROUTER" "NETWORK" "METAL_NETWORK" "VPIC_INTERFACE" "APP_LINK" "IC" Access point type
	object (SimplifiedAccount)
	object (SimplifiedLocation)
	object (SimplifiedPort) Port specification
	object (SimplifiedServiceProfile) Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.
	object (CloudRouter) Fabric Cloud Router object
	object (SimplifiedLinkProtocol) Connection link protocol Configuration
	object (VirtualDevice) Virtual Device AccessPoint Information
	object (Interface) Interface Information
	object (SimplifiedNetwork) Network specification
	object (ProviderEnvironment) Provider Environment associated with an IC_PROFILE service profile ^Beta
sellerRegion	string Access point seller region
peeringType	string (PeeringType) Enum: "PRIVATE" "MICROSOFT" "PUBLIC" "MANUAL" Access point peering type
authenticationKey	string Access point authentication key
activationKey	string Access point activation key
providerConnectionId	string Provider assigned Connection Id
	object (VirtualNetwork) Virtual Network Information
	object (MetalInterconnection) Metal Interconnection
role	string Enum: "LEAF" "ROOT" E-Tree network connection role
	object (ProductOffering) Product offering for connection. Applicable to zSide only.
bandwidthCommit	integer [ 0 .. 100000 ] Bandwidth commit in Mbps
providerIdentifier	string Provider identifier
	object (Address) Address.

Array of objects (ConnectionSideAdditionalInfo)

Any additional information, which is not part of connection metadata or configuration

Array

key	string Key
value	string Value

object (marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

href	string <uri> Marketplace Subscription URI
type	string Enum: "AWS_MARKETPLACE_SUBSCRIPTION" "GCP_MARKETPLACE_SUBSCRIPTION" "AZURE_MARKETPLACE_SUBSCRIPTION" Marketplace Subscription type
uuid	string Equinix-assigned Marketplace Subscription identifier

Array of objects (ConnectionSideAdditionalInfo)

Connection additional information

Array

key	string Key
value	string Value

object (Project)

projectId

required

string

Subscriber-assigned project ID

Response samples

200
400
403
404

Content type

application/json

Example

nonGenericConnectionResponse

{"href": "https://api.equinix.com/fabric/v4/connections/462ad0bb-7fe2-41b1-8d1a-c62494e0c7e3",
"type": "EVPL_VC",
"uuid": "462ad0bb-7fe2-41b1-8d1a-c62494e0c7e3",
"name": "E2E-CON-280122031843987",
"state": "DEPROVISIONED",
"operation": {"providerStatus": "FAILED",
"equinixStatus": "DEPROVISIONED"
},
"order": {"purchaseOrderNumber": "PO608540135268"
},
"notifications": [{"type": "ALL",
"emails": ["fake@mail.com"
]
}
],
"account": {"accountNumber": 270001,
"orgId": 91997,
"globalOrgId": "0016u000003JZ4sAAG"
},
"changeLog": {"createdBy": "testBuyer",
"createdDateTime": "2022-01-28T03:18:48.908Z"
},
"bandwidth": 50,
"redundancy": {"group": "50ba51bb-085d-4084-ac38-c31860ca5f4d",
"priority": "PRIMARY"
},
"isRemote": false,
"direction": "OUTGOING",
"aSide": {"accessPoint": {"type": "COLO",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/SV",
"metroCode": "SV"
},
"port": {"href": "https://api.equinix.com/fabric/v4/ports/c791f8cb-594b-94b0-8ce0-306a5c00a4ee",
"uuid": "c791f8cb-594b-94b0-8ce0-306a5c00a4ee",
"name": "testBuyer-SV5-NL-Dot1q-BO-PRI-10G-NK-83"
},
"linkProtocol": {"type": "DOT1Q",
"vlanTag": 2628
}
}
},
"zSide": {"accessPoint": {"type": "SP",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/SV",
"metroCode": "SV"
},
"profile": {"href": "https://api.equinix.com/fabric/v4/serviceProfiles/063f4b0f-2d5b-4db7-95da-d9eddfc92602",
"type": "L2_PROFILE",
"name": "Google Cloud Partner Interconnect Zone 1",
"uuid": "063f4b0f-2d5b-4db7-95da-d9eddfc92602"
},
"linkProtocol": {"type": "DOT1Q"
},
"sellerRegion": "us-west1",
"authenticationKey": "xx-xxx-xx-xxxxx/xxx/x"
}
}
}

Update Connection by ID

Authorizations:

BearerAuth

path Parameters

connectionId

required

string

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

Connection Id

query Parameters

dryRun

boolean

Default: false

option to verify that API calls will succeed

Request Body schema: application/json-patch+json
required

Array (non-empty)

op required	string Handy shortcut for operation name
path required	string path inside document leading to updated parameter
value required	any new value for updated parameter

Responses

Response Schema: application/json

href

string <uri>

Connection URI

type

required

string (ConnectionType)

Enum: "EVPL_VC" "EPL_VC" "EC_VC" "IP_VC" "ACCESS_EPL_VC" "EIA_VC" "EVPLAN_VC" "EPLAN_VC" "EVPTREE_VC" "EPTREE_VC" "IPWAN_VC" "IA_VC" "MC_VC" "IX_VC" "GW_VC" "IPX_VC"

Connection type

uuid

string

Equinix-assigned connection identifier

name

required

string

Customer-provided connection name

description

string

Customer-provided connection description

object (Change)

Current state of latest connection change

uuid

string

Uniquely identifies a change

type

required

string

Enum: "CONNECTION_CREATION" "CONNECTION_UPDATE" "CONNECTION_DELETION" "CONNECTION_PROVIDER_STATUS_REQUEST"

Type of change

status

string

Enum: "APPROVED" "COMPLETED" "FAILED" "REJECTED" "REQUESTED" "SUBMITTED_FOR_APPROVAL"

Current outcome of the change flow

createdDateTime

required

string <date-time>

Set when change flow starts

updatedDateTime

string <date-time>

Set when change object is updated

information

string

Additional information

object (ConnectionChangeOperation)

Connection change operation data

op required	string Handy shortcut for operation name
path required	string path inside document leading to updated parameter
value required	any new value for updated parameter

object (ConnectionOperation)

Connection type-specific operational data

providerStatus

string (ProviderStatus)

Enum: "AVAILABLE" "DEPROVISIONED" "DEPROVISIONING" "FAILED" "NOT_AVAILABLE" "PENDING_APPROVAL" "PENDING_CONFIGURATION" "PROVISIONED" "PROVISIONING" "REJECTED" "PENDING_BGP" "ERROR" "ORDERING" "DELETING" "PENDING DELETE" "N/A" "QUOTING"

Connection provider readiness status

equinixStatus

string (EquinixStatus)

Enum: "REJECTED_ACK" "REJECTED" "PENDING_DELETE" "PROVISIONED" "PENDING_APPROVAL" "NOT_PROVISIONED" "DEPROVISIONING" "NOT_DEPROVISIONED" "PENDING_AUTO_APPROVAL" "PROVISIONING" "PENDING_BGP_PEERING" "PENDING_PROVIDER_VLAN" "DEPROVISIONED" "DELETED" "AUTO_APPROVAL_FAILED" "PENDING_PROVIDER_VLAN_ERROR" "DRAFT" "CANCELLED" "PENDING_INTERFACE_CONFIGURATION"

Connection status

operationalStatus

string

Enum: "UP" "DOWN"

Connection operational status

Array of objects (Error)

Array

errorCode required	string^EQ-\d{7}$
errorMessage required	string
correlationId	string
details	string
help	string
	Array of objects

opStatusChangedAt

string <date-time>

When connection transitioned into current operational status

maintenanceStatus

string

Enum: "SCHEDULED" "IN_PROGRESS" "COMPLETED" "CANCELLED" "POSTPONED"

Maintenance lifecycle state

lockEnabled

boolean

Indicates whether the connection configuration is locked due to an ongoing or scheduled maintenance.

object (Order)

purchaseOrderNumber	string Purchase order number
customerReferenceNumber	string Customer reference number
billingTier	string Billing tier for connection bandwidth
orderId	string Order Identification
orderNumber	string Order Reference Number
termLength	integer [ 1 .. 60 ] Default: 1 Term length in months, valid values are 1, 12, 24, 36, 60 where 1 is the default value (for on-demand case).
contractedBandwidth	integer Contracted bandwidth

Array of objects (SimplifiedNotification)

Preferences for notifications on connection configuration or status changes

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

bandwidth

required

integer [ 0 .. 10000 ]

Connection bandwidth in Mbps

geoScope

string (GeoScopeType)

Enum: "CANADA" "CONUS" "JAPAN" "UK" "AUSTRALIA" "BRAZIL" "SWITZERLAND" "EU"

Geographic boundary types

object (ConnectionRedundancy)

Connection redundancy configuration

group	string Redundancy group identifier (UUID of primary connection)
priority	string (ConnectionPriority) Enum: "PRIMARY" "SECONDARY" Connection priority in redundancy group
name	string Customer-provided name for the redundancy group
description	string Customer-provided description for the redundancy group

isRemote

boolean

Connection property derived from access point locations

direction

string (ConnectionDirection)

Enum: "INTERNAL" "INCOMING" "OUTGOING"

Connection directionality from the requester point of view

required

object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (ServiceToken)

Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.

type	string (ServiceTokenType) Enum: "VC_TOKEN" "EPL_TOKEN" Type of Service Token
href	string <uri> An absolute URL that is the subject of the link's context.
expiry	integer Deprecated
uuid	string <uuid> Equinix-assigned service token identifier
issuerSide	string Deprecated information about token side
name	string Customer-provided service token name
description	string Customer-provided service token description
expirationDateTime	string <date-time> Expiration date and time of the service token.
	object (ServiceTokenConnection) Service Token Connection Type Information
state	string (ServiceTokenState) Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED" Service token state
	Array of objects (SimplifiedNotification) Service token related notifications
	object (SimplifiedAccount)
	object (Changelog) Change log
	object (Project)

object (AccessPoint)

Access point object

type	string (AccessPointType) Enum: "VD" "VG" "SP" "IGW" "COLO" "SUBNET" "CLOUD_ROUTER" "NETWORK" "METAL_NETWORK" "VPIC_INTERFACE" "APP_LINK" "IC" Access point type
	object (SimplifiedAccount)
	object (SimplifiedLocation)
	object (SimplifiedPort) Port specification
	object (SimplifiedServiceProfile) Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.
	object (CloudRouter) Fabric Cloud Router object
	object (SimplifiedLinkProtocol) Connection link protocol Configuration
	object (VirtualDevice) Virtual Device AccessPoint Information
	object (Interface) Interface Information
	object (SimplifiedNetwork) Network specification
	object (ProviderEnvironment) Provider Environment associated with an IC_PROFILE service profile ^Beta
sellerRegion	string Access point seller region
peeringType	string (PeeringType) Enum: "PRIVATE" "MICROSOFT" "PUBLIC" "MANUAL" Access point peering type
authenticationKey	string Access point authentication key
activationKey	string Access point activation key
providerConnectionId	string Provider assigned Connection Id
	object (VirtualNetwork) Virtual Network Information
	object (MetalInterconnection) Metal Interconnection
role	string Enum: "LEAF" "ROOT" E-Tree network connection role
	object (ProductOffering) Product offering for connection. Applicable to zSide only.
bandwidthCommit	integer [ 0 .. 100000 ] Bandwidth commit in Mbps
providerIdentifier	string Provider identifier
	object (Address) Address.

Array of objects (ConnectionSideAdditionalInfo)

Any additional information, which is not part of connection metadata or configuration

Array

key	string Key
value	string Value

required

object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (ServiceToken)

Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.

type	string (ServiceTokenType) Enum: "VC_TOKEN" "EPL_TOKEN" Type of Service Token
href	string <uri> An absolute URL that is the subject of the link's context.
expiry	integer Deprecated
uuid	string <uuid> Equinix-assigned service token identifier
issuerSide	string Deprecated information about token side
name	string Customer-provided service token name
description	string Customer-provided service token description
expirationDateTime	string <date-time> Expiration date and time of the service token.
	object (ServiceTokenConnection) Service Token Connection Type Information
state	string (ServiceTokenState) Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED" Service token state
	Array of objects (SimplifiedNotification) Service token related notifications
	object (SimplifiedAccount)
	object (Changelog) Change log
	object (Project)

object (AccessPoint)

Access point object

type	string (AccessPointType) Enum: "VD" "VG" "SP" "IGW" "COLO" "SUBNET" "CLOUD_ROUTER" "NETWORK" "METAL_NETWORK" "VPIC_INTERFACE" "APP_LINK" "IC" Access point type
	object (SimplifiedAccount)
	object (SimplifiedLocation)
	object (SimplifiedPort) Port specification
	object (SimplifiedServiceProfile) Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.
	object (CloudRouter) Fabric Cloud Router object
	object (SimplifiedLinkProtocol) Connection link protocol Configuration
	object (VirtualDevice) Virtual Device AccessPoint Information
	object (Interface) Interface Information
	object (SimplifiedNetwork) Network specification
	object (ProviderEnvironment) Provider Environment associated with an IC_PROFILE service profile ^Beta
sellerRegion	string Access point seller region
peeringType	string (PeeringType) Enum: "PRIVATE" "MICROSOFT" "PUBLIC" "MANUAL" Access point peering type
authenticationKey	string Access point authentication key
activationKey	string Access point activation key
providerConnectionId	string Provider assigned Connection Id
	object (VirtualNetwork) Virtual Network Information
	object (MetalInterconnection) Metal Interconnection
role	string Enum: "LEAF" "ROOT" E-Tree network connection role
	object (ProductOffering) Product offering for connection. Applicable to zSide only.
bandwidthCommit	integer [ 0 .. 100000 ] Bandwidth commit in Mbps
providerIdentifier	string Provider identifier
	object (Address) Address.

Array of objects (ConnectionSideAdditionalInfo)

Any additional information, which is not part of connection metadata or configuration

Array

key	string Key
value	string Value

object (marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

href	string <uri> Marketplace Subscription URI
type	string Enum: "AWS_MARKETPLACE_SUBSCRIPTION" "GCP_MARKETPLACE_SUBSCRIPTION" "AZURE_MARKETPLACE_SUBSCRIPTION" Marketplace Subscription type
uuid	string Equinix-assigned Marketplace Subscription identifier

Array of objects (ConnectionSideAdditionalInfo)

Connection additional information

Array

key	string Key
value	string Value

object (Project)

projectId

required

string

Subscriber-assigned project ID

Request samples

Payload

Content type

application/json-patch+json

Example

ConnectionUpdateNameRequest

[{"op": "replace",
"path": "/name",
"value": "Conn-Name-2"
}
]

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62",
"type": "EVPL_VC",
"uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",
"name": "My-Layer2-Connection-2",
"bandwidth": 1000,
"direction": "OUTGOING",
"isRemote": true,
"redundancy": {"group": "66c10a60-789e-4b25-b85c-7eb225a4c344",
"priority": "PRIMARY"
},
"aSide": {"accessPoint": {"type": "COLO",
"port": {"href": "https://api.equinix.com/fabric/v4/ports/a00cef6f-8e35-4794-9ff9-665e084e4e6d",
"uuid": "a00cef6f-8e35-4794-9ff9-665e084e4e6d"
},
"linkProtocol": {"type": "DOT1Q",
"vlanTag": 1001
}
}
},
"zSide": {"accessPoint": {"type": "SP",
"profile": {"href": "https://api.equinix.com/fabric/v4/serviceProfiles/22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c",
"uuid": "22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c",
"type": "L2_PROFILE"
},
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/MX",
"metroCode": "MX"
},
"linkProtocol": {"type": "DOT1Q",
"vlanTag": 1001
}
}
},
"operation": {"providerStatus": "PROVISIONED",
"equinixStatus": "PROVISIONED"
},
"change": {"type": "CONNECTION_UPDATE",
"status": "APPROVED",
"createdDateTime": "2021-12-12T06:00:01.183Z",
"data": {"op": "replace",
"path": "/aSide/accessPoint/port/uuid",
"value": "c791f8cb-58f9-8f90-8ce0-306a5c00a4ee"
}
},
"changeLog": {"createdDateTime": "2020-04-21T10:30:00Z"
},
"account": {"accountNumber": 270001,
"orgId": 91997,
"globalOrgId": "3453453cccc"
}
}

Delete Connection by ID

Authorizations:

BearerAuth

path Parameters

connectionId

required

string

Connection UUID

Responses

Response Schema: application/json

href

string <uri>

Connection URI

type

required

string (ConnectionType)

Enum: "EVPL_VC" "EPL_VC" "EC_VC" "IP_VC" "ACCESS_EPL_VC" "EIA_VC" "EVPLAN_VC" "EPLAN_VC" "EVPTREE_VC" "EPTREE_VC" "IPWAN_VC" "IA_VC" "MC_VC" "IX_VC" "GW_VC" "IPX_VC"

Connection type

uuid

string

Equinix-assigned connection identifier

name

required

string

Customer-provided connection name

description

string

Customer-provided connection description

object (Change)

Current state of latest connection change

uuid

string

Uniquely identifies a change

type

required

string

Enum: "CONNECTION_CREATION" "CONNECTION_UPDATE" "CONNECTION_DELETION" "CONNECTION_PROVIDER_STATUS_REQUEST"

Type of change

status

string

Enum: "APPROVED" "COMPLETED" "FAILED" "REJECTED" "REQUESTED" "SUBMITTED_FOR_APPROVAL"

Current outcome of the change flow

createdDateTime

required

string <date-time>

Set when change flow starts

updatedDateTime

string <date-time>

Set when change object is updated

information

string

Additional information

object (ConnectionChangeOperation)

Connection change operation data

op required	string Handy shortcut for operation name
path required	string path inside document leading to updated parameter
value required	any new value for updated parameter

object (ConnectionOperation)

Connection type-specific operational data

providerStatus

string (ProviderStatus)

Enum: "AVAILABLE" "DEPROVISIONED" "DEPROVISIONING" "FAILED" "NOT_AVAILABLE" "PENDING_APPROVAL" "PENDING_CONFIGURATION" "PROVISIONED" "PROVISIONING" "REJECTED" "PENDING_BGP" "ERROR" "ORDERING" "DELETING" "PENDING DELETE" "N/A" "QUOTING"

Connection provider readiness status

equinixStatus

string (EquinixStatus)

Enum: "REJECTED_ACK" "REJECTED" "PENDING_DELETE" "PROVISIONED" "PENDING_APPROVAL" "NOT_PROVISIONED" "DEPROVISIONING" "NOT_DEPROVISIONED" "PENDING_AUTO_APPROVAL" "PROVISIONING" "PENDING_BGP_PEERING" "PENDING_PROVIDER_VLAN" "DEPROVISIONED" "DELETED" "AUTO_APPROVAL_FAILED" "PENDING_PROVIDER_VLAN_ERROR" "DRAFT" "CANCELLED" "PENDING_INTERFACE_CONFIGURATION"

Connection status

operationalStatus

string

Enum: "UP" "DOWN"

Connection operational status

Array of objects (Error)

Array

errorCode required	string^EQ-\d{7}$
errorMessage required	string
correlationId	string
details	string
help	string
	Array of objects

opStatusChangedAt

string <date-time>

When connection transitioned into current operational status

maintenanceStatus

string

Enum: "SCHEDULED" "IN_PROGRESS" "COMPLETED" "CANCELLED" "POSTPONED"

Maintenance lifecycle state

lockEnabled

boolean

Indicates whether the connection configuration is locked due to an ongoing or scheduled maintenance.

object (Order)

purchaseOrderNumber	string Purchase order number
customerReferenceNumber	string Customer reference number
billingTier	string Billing tier for connection bandwidth
orderId	string Order Identification
orderNumber	string Order Reference Number
termLength	integer [ 1 .. 60 ] Default: 1 Term length in months, valid values are 1, 12, 24, 36, 60 where 1 is the default value (for on-demand case).
contractedBandwidth	integer Contracted bandwidth

Array of objects (SimplifiedNotification)

Preferences for notifications on connection configuration or status changes

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

bandwidth

required

integer [ 0 .. 10000 ]

Connection bandwidth in Mbps

geoScope

string (GeoScopeType)

Enum: "CANADA" "CONUS" "JAPAN" "UK" "AUSTRALIA" "BRAZIL" "SWITZERLAND" "EU"

Geographic boundary types

object (ConnectionRedundancy)

Connection redundancy configuration

group	string Redundancy group identifier (UUID of primary connection)
priority	string (ConnectionPriority) Enum: "PRIMARY" "SECONDARY" Connection priority in redundancy group
name	string Customer-provided name for the redundancy group
description	string Customer-provided description for the redundancy group

isRemote

boolean

Connection property derived from access point locations

direction

string (ConnectionDirection)

Enum: "INTERNAL" "INCOMING" "OUTGOING"

Connection directionality from the requester point of view

required

object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (ServiceToken)

Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.

type	string (ServiceTokenType) Enum: "VC_TOKEN" "EPL_TOKEN" Type of Service Token
href	string <uri> An absolute URL that is the subject of the link's context.
expiry	integer Deprecated
uuid	string <uuid> Equinix-assigned service token identifier
issuerSide	string Deprecated information about token side
name	string Customer-provided service token name
description	string Customer-provided service token description
expirationDateTime	string <date-time> Expiration date and time of the service token.
	object (ServiceTokenConnection) Service Token Connection Type Information
state	string (ServiceTokenState) Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED" Service token state
	Array of objects (SimplifiedNotification) Service token related notifications
	object (SimplifiedAccount)
	object (Changelog) Change log
	object (Project)

object (AccessPoint)

Access point object

type	string (AccessPointType) Enum: "VD" "VG" "SP" "IGW" "COLO" "SUBNET" "CLOUD_ROUTER" "NETWORK" "METAL_NETWORK" "VPIC_INTERFACE" "APP_LINK" "IC" Access point type
	object (SimplifiedAccount)
	object (SimplifiedLocation)
	object (SimplifiedPort) Port specification
	object (SimplifiedServiceProfile) Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.
	object (CloudRouter) Fabric Cloud Router object
	object (SimplifiedLinkProtocol) Connection link protocol Configuration
	object (VirtualDevice) Virtual Device AccessPoint Information
	object (Interface) Interface Information
	object (SimplifiedNetwork) Network specification
	object (ProviderEnvironment) Provider Environment associated with an IC_PROFILE service profile ^Beta
sellerRegion	string Access point seller region
peeringType	string (PeeringType) Enum: "PRIVATE" "MICROSOFT" "PUBLIC" "MANUAL" Access point peering type
authenticationKey	string Access point authentication key
activationKey	string Access point activation key
providerConnectionId	string Provider assigned Connection Id
	object (VirtualNetwork) Virtual Network Information
	object (MetalInterconnection) Metal Interconnection
role	string Enum: "LEAF" "ROOT" E-Tree network connection role
	object (ProductOffering) Product offering for connection. Applicable to zSide only.
bandwidthCommit	integer [ 0 .. 100000 ] Bandwidth commit in Mbps
providerIdentifier	string Provider identifier
	object (Address) Address.

Array of objects (ConnectionSideAdditionalInfo)

Any additional information, which is not part of connection metadata or configuration

Array

key	string Key
value	string Value

required

object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

object (ServiceToken)

Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.

type	string (ServiceTokenType) Enum: "VC_TOKEN" "EPL_TOKEN" Type of Service Token
href	string <uri> An absolute URL that is the subject of the link's context.
expiry	integer Deprecated
uuid	string <uuid> Equinix-assigned service token identifier
issuerSide	string Deprecated information about token side
name	string Customer-provided service token name
description	string Customer-provided service token description
expirationDateTime	string <date-time> Expiration date and time of the service token.
	object (ServiceTokenConnection) Service Token Connection Type Information
state	string (ServiceTokenState) Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED" Service token state
	Array of objects (SimplifiedNotification) Service token related notifications
	object (SimplifiedAccount)
	object (Changelog) Change log
	object (Project)

object (AccessPoint)

Access point object

type	string (AccessPointType) Enum: "VD" "VG" "SP" "IGW" "COLO" "SUBNET" "CLOUD_ROUTER" "NETWORK" "METAL_NETWORK" "VPIC_INTERFACE" "APP_LINK" "IC" Access point type
	object (SimplifiedAccount)
	object (SimplifiedLocation)
	object (SimplifiedPort) Port specification
	object (SimplifiedServiceProfile) Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service.
	object (CloudRouter) Fabric Cloud Router object
	object (SimplifiedLinkProtocol) Connection link protocol Configuration
	object (VirtualDevice) Virtual Device AccessPoint Information
	object (Interface) Interface Information
	object (SimplifiedNetwork) Network specification
	object (ProviderEnvironment) Provider Environment associated with an IC_PROFILE service profile ^Beta
sellerRegion	string Access point seller region
peeringType	string (PeeringType) Enum: "PRIVATE" "MICROSOFT" "PUBLIC" "MANUAL" Access point peering type
authenticationKey	string Access point authentication key
activationKey	string Access point activation key
providerConnectionId	string Provider assigned Connection Id
	object (VirtualNetwork) Virtual Network Information
	object (MetalInterconnection) Metal Interconnection
role	string Enum: "LEAF" "ROOT" E-Tree network connection role
	object (ProductOffering) Product offering for connection. Applicable to zSide only.
bandwidthCommit	integer [ 0 .. 100000 ] Bandwidth commit in Mbps
providerIdentifier	string Provider identifier
	object (Address) Address.

Array of objects (ConnectionSideAdditionalInfo)

Any additional information, which is not part of connection metadata or configuration

Array

key	string Key
value	string Value

object (marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

href	string <uri> Marketplace Subscription URI
type	string Enum: "AWS_MARKETPLACE_SUBSCRIPTION" "GCP_MARKETPLACE_SUBSCRIPTION" "AZURE_MARKETPLACE_SUBSCRIPTION" Marketplace Subscription type
uuid	string Equinix-assigned Marketplace Subscription identifier

Array of objects (ConnectionSideAdditionalInfo)

Connection additional information

Array

key	string Key
value	string Value

object (Project)

projectId

required

string

Subscriber-assigned project ID

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62",
"type": "EVPL_VC",
"uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",
"name": "My-Layer2-Connection",
"order": {"purchaseOrderNumber": "1-129105284100",
"billingTier": "Up to 200 MB /*Proposal*/"
},
"bandwidth": 100,
"aSide": {"accessPoint": {"type": "COLO",
"port": {"href": "https://api.equinix.com/fabric/v4/ports/a00cef6f-8e35-4794-9ff9-665e084e4e6d",
"type": "XF_PORT",
"uuid": "a00cef6f-8e35-4794-9ff9-665e084e4e6d"
},
"linkProtocol": {"type": "DOT1Q",
"vlanTag": 1001
},
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/SV",
"metroCode": "SV"
}
}
},
"zSide": {"accessPoint": {"type": "SP",
"profile": {"href": "https://api.equinix.com/fabric/v4/serviceProfiles/20d32a80-0d61-4333-bc03-707b591ae2f5",
"type": "L2_PROFILE",
"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f5"
},
"port": {"href": "https://api.equinix.com/fabric/v4/ports/20d32a80-0d61-4333-bc03-707b591ae2f4",
"type": "XF_PORT",
"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
},
"linkProtocol": {"type": "QINQ",
"vlanSTag": 1002,
"vlanCTag": 1001
},
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/SV",
"metroCode": "SV"
}
}
},
"notifications": [{"type": "ALL",
"emails": ["test@equinix.com",
"test1@equinix.com"
]
}
],
"operation": {"equinixStatus": "DEPROVISIONING",
"providerStatus": "DEPROVISIONING"
},
"changeLog": {"createdDateTime": "2020-05-21T10:30:00Z",
"updatedDateTime": "2020-05-21T10:30:00Z",
"deletedDateTime": "2020-05-21T10:30:00Z",
"createdBy": "232216",
"updatedBy": "344339",
"deletedBy": "232216"
}
}

Create Connection Action

This API provides capability to accept/reject user's virtual connection

Authorizations:

BearerAuth

path Parameters

connectionId

required

string

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

Connection Id

Request Body schema: application/json
required

type

required

string (Actions)

Enum: "CONNECTION_CREATION_ACCEPTANCE" "CONNECTION_CREATION_REJECTION" "CONNECTION_UPDATE_ACCEPTANCE" "CONNECTION_UPDATE_REJECTION" "CONNECTION_DELETION_ACCEPTANCE" "CONNECTION_REJECTION_ACCEPTANCE" "CONNECTION_UPDATE_REQUEST" "MIGRATION_EVPL_VC" "CONNECTION_PROVIDER_STATUS_REQUEST" "CONNECTION_PROVIDER_BANDWIDTH_REQUEST" "ACCEPT_HOSTED_CONNECTION" "CANCEL_EVPL_VC_DRAFT_ORDERS" "CONNECTION_CREATION_RETRY" "CONNECTION_DELETION_RETRY" "CONNECTION_PROVIDER_STATUS_UPDATE_REQUEST"

Connection action type

description

string

Connection rejection reason detail

object (ConnectionAcceptanceData)

Connection acceptance data

object (ConnectionSide)

Connection configuration object for each side of multi-segment connection

	object (ServiceToken) Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets.
	object (AccessPoint) Access point object
	Array of objects (ConnectionSideAdditionalInfo) Any additional information, which is not part of connection metadata or configuration

object (ConnectionOperation)

Connection type-specific operational data

providerStatus	string (ProviderStatus) Enum: "AVAILABLE" "DEPROVISIONED" "DEPROVISIONING" "FAILED" "NOT_AVAILABLE" "PENDING_APPROVAL" "PENDING_CONFIGURATION" "PROVISIONED" "PROVISIONING" "REJECTED" "PENDING_BGP" "ERROR" "ORDERING" "DELETING" "PENDING DELETE" "N/A" "QUOTING" Connection provider readiness status
equinixStatus	string (EquinixStatus) Enum: "REJECTED_ACK" "REJECTED" "PENDING_DELETE" "PROVISIONED" "PENDING_APPROVAL" "NOT_PROVISIONED" "DEPROVISIONING" "NOT_DEPROVISIONED" "PENDING_AUTO_APPROVAL" "PROVISIONING" "PENDING_BGP_PEERING" "PENDING_PROVIDER_VLAN" "DEPROVISIONED" "DELETED" "AUTO_APPROVAL_FAILED" "PENDING_PROVIDER_VLAN_ERROR" "DRAFT" "CANCELLED" "PENDING_INTERFACE_CONFIGURATION" Connection status
operationalStatus	string Enum: "UP" "DOWN" Connection operational status
	Array of objects (Error)
opStatusChangedAt	string <date-time> When connection transitioned into current operational status
maintenanceStatus	string Enum: "SCHEDULED" "IN_PROGRESS" "COMPLETED" "CANCELLED" "POSTPONED" Maintenance lifecycle state
lockEnabled	boolean Indicates whether the connection configuration is locked due to an ongoing or scheduled maintenance.

Responses

Request samples

Payload

Content type

application/json

Example

ApproveGenericConnection

{"type": "CONNECTION_CREATION_ACCEPTANCE",
"data": {"zSide": {"accessPoint": {"type": "COLO",
"port": {"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
},
"linkProtocol": {"type": "QINQ",
"vlanSTag": 1002,
"vlanCTag": 1001
}
}
}
}
}

Response samples

202
400
401
403
404

Content type

application/json

Example

connectionActionExample

{"href": "https://api.equinix.com/fabric/v4/connections/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81/actions/37c10edc-ba2e-4240-a850-8a48f9c47d00",
"type": "CONNECTION_CREATION_ACCEPTANCE",
"uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",
"data": {"zSide": {"accessPoint": {"type": "SP",
"profile": {"href": "https://api.equinix.com/fabric/v4/serviceProfiles/22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c",
"uuid": "22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c",
"type": "L2_PROFILE"
},
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/MX",
"metroCode": "MX"
},
"linkProtocol": {"type": "DOT1Q",
"vlanTag": 1001
}
}
}
},
"changeLog": {"createdDateTime": "2020-04-21T10:30:00Z",
"updatedDateTime": "2020-05-21T10:30:00Z"
}
}

Search Connections

The API provides capability to get list of user's virtual connections using search criteria, including optional filtering, pagination and sorting

Authorizations:

BearerAuth

Request Body schema: application/json
required

object (Expression)

and	Array of objects (Expressions)
or	Array of objects (Expressions)
property	string (SearchFieldName) Enum: "/isRemote" "/name" "/uuid" "/type" "/geoScope" "/account/orgId" "/aSide/accessPoint/account/accountName" "/aSide/accessPoint/account/accountNumber" "/aSide/accessPoint/router/uuid" "/aSide/accessPoint/interconnect/uuid" "/aSide/accessPoint/linkProtocol/vlanTagMin" "/aSide/accessPoint/linkProtocol/vlanTagMax" "/aSide/accessPoint/location/metroCode" "/aSide/accessPoint/location/metroName" "/aSide/accessPoint/name" "/aSide/accessPoint/port/uuid" "/aSide/accessPoint/port/name" "/aSide/accessPoint/type" "/aSide/accessPoint/virtualDevice/name" "/aSide/accessPoint/virtualDevice/uuid" "/aSide/serviceToken/uuid" "/bandwidth" "/change/status" "/changeLog/createdBy" "/changeLog/createdDateTime" "/changeLog/deletedBy" "/changeLog/deletedDateTime" "/changeLog/lastUpdatedBy" "/operation/equinixStatus" "/operation/providerStatus" "/operation/maintenanceStatus" "/operation/lockEnabled" "/project/projectId" "/redundancy/group" "/redundancy/priority" "/redundancy/name" "/redundancy/description" "/zSide/accessPoint/account/accountName" "/zSide/accessPoint/authenticationKey" "/zSide/accessPoint/linkProtocol/vlanTagMin" "/zSide/accessPoint/linkProtocol/vlanTagMax" "/zSide/accessPoint/location/metroCode" "/zSide/accessPoint/location/metroName" "/zSide/accessPoint/sellerRegion" "/zSide/accessPoint/name" "/zSide/accessPoint/port/uuid" "/zSide/accessPoint/network/uuid" "/zSide/accessPoint/port/name" "/zSide/accessPoint/profile/uuid" "/zSide/accessPoint/type" "/zSide/accessPoint/role" "/zSide/accessPoint/virtualDevice/name" "/zSide/accessPoint/virtualDevice/uuid" "/zSide/serviceToken/uuid" "/zSide/internetAccess/uuid" "/state" Possible field names to use on filters
operator	string Enum: "=" "!=" ">" ">=" "<" "<=" "LIKE" "ILKE" "IS NOT NULL" "IS NULL" "IN" "BETWEEN"
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (SortCriteria)

Array

direction

string (SortDirection)

Default: "DESC"

Enum: "DESC" "ASC"

Sorting direction

property

string (SortBy)

Default: "/changeLog/updatedDateTime"

Enum: "/name" "/direction" "/aSide/accessPoint/name" "/aSide/accessPoint/type" "/aSide/accessPoint/account/accountName" "/aSide/accessPoint/location/metroName" "/aSide/accessPoint/location/metroCode" "/aSide/accessPoint/linkProtocol/vlanCTag" "/aSide/accessPoint/linkProtocol/vlanSTag" "/zSide/accessPoint/name" "/zSide/accessPoint/type" "/zSide/accessPoint/role" "/zSide/accessPoint/account/accountName" "/zSide/accessPoint/location/metroName" "/zSide/accessPoint/location/metroCode" "/zSide/accessPoint/linkProtocol/vlanCTag" "/zSide/accessPoint/linkProtocol/vlanSTag" "/zSide/accessPoint/authenticationKey" "/bandwidth" "/geoScope" "/uuid" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/operation/equinixStatus" "/operation/providerStatus" "/operation/maintenanceStatus" "/redundancy/priority"

Possible field names to use on sorting

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (SortCriteriaResponse)

Array

direction

string (SortDirection)

Default: "DESC"

Enum: "DESC" "ASC"

Sorting direction

property

string (SortBy)

Default: "/changeLog/updatedDateTime"

Enum: "/name" "/direction" "/aSide/accessPoint/name" "/aSide/accessPoint/type" "/aSide/accessPoint/account/accountName" "/aSide/accessPoint/location/metroName" "/aSide/accessPoint/location/metroCode" "/aSide/accessPoint/linkProtocol/vlanCTag" "/aSide/accessPoint/linkProtocol/vlanSTag" "/zSide/accessPoint/name" "/zSide/accessPoint/type" "/zSide/accessPoint/role" "/zSide/accessPoint/account/accountName" "/zSide/accessPoint/location/metroName" "/zSide/accessPoint/location/metroCode" "/zSide/accessPoint/linkProtocol/vlanCTag" "/zSide/accessPoint/linkProtocol/vlanSTag" "/zSide/accessPoint/authenticationKey" "/bandwidth" "/geoScope" "/uuid" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/operation/equinixStatus" "/operation/providerStatus" "/operation/maintenanceStatus" "/redundancy/priority"

Possible field names to use on sorting

Array of objects (Connection)

Array

href	string <uri> Connection URI
type required	string (ConnectionType) Enum: "EVPL_VC" "EPL_VC" "EC_VC" "IP_VC" "ACCESS_EPL_VC" "EIA_VC" "EVPLAN_VC" "EPLAN_VC" "EVPTREE_VC" "EPTREE_VC" "IPWAN_VC" "IA_VC" "MC_VC" "IX_VC" "GW_VC" "IPX_VC" Connection type
uuid	string Equinix-assigned connection identifier
name required	string Customer-provided connection name
description	string Customer-provided connection description
	object (Change) Current state of latest connection change
	object (ConnectionOperation) Connection type-specific operational data
	object (Order)
	Array of objects (SimplifiedNotification) Preferences for notifications on connection configuration or status changes
	object (SimplifiedAccount)
	object (Changelog) Change log
bandwidth required	integer [ 0 .. 10000 ] Connection bandwidth in Mbps
geoScope	string (GeoScopeType) Enum: "CANADA" "CONUS" "JAPAN" "UK" "AUSTRALIA" "BRAZIL" "SWITZERLAND" "EU" Geographic boundary types
	object (ConnectionRedundancy) Connection redundancy configuration
isRemote	boolean Connection property derived from access point locations
direction	string (ConnectionDirection) Enum: "INTERNAL" "INCOMING" "OUTGOING" Connection directionality from the requester point of view
required	object (ConnectionSide) Connection configuration object for each side of multi-segment connection
required	object (ConnectionSide) Connection configuration object for each side of multi-segment connection
	object (marketplaceSubscription) Equinix Fabric Entity for Marketplace Subscription
	Array of objects (ConnectionSideAdditionalInfo) Connection additional information
	object (Project)

Request samples

Payload

Content type

application/json

Example

ConnectionSearchDirection

{"filter": {"and": [{"property": "/direction",
"operator": "=",
"values": ["OUTGOING"
]
}
]
},
"pagination": {"limit": 25,
"offset": 0
},
"sort": [{"property": "/changeLog/updatedDateTime",
"direction": "DESC"
}
]
}

Response samples

200
400
401
403
404

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 1
},
"data": [{"href": "https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62",
"type": "EVPL_VC",
"uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",
"name": "My-Layer2-Connection",
"bandwidth": 1000,
"direction": "OUTGOING",
"isRemote": true,
"redundancy": {"priority": "PRIMARY",
"group": "7cf39156-9dec-40f7-a254-9bb401342e83"
},
"aSide": {"accessPoint": {"type": "COLO",
"uuid": "b840a1db-5639-639f-97e0-328a5c00a874",
"name": "exmapple-access-point-name-aside",
"port": {"href": "https://api.equinix.com/fabric/v4/ports/a00cef6f-8e35-4794-9ff9-665e084e4e6d",
"uuid": "a00cef6f-8e35-4794-9ff9-665e084e4e6d"
}
},
"linkProtocol": {"type": "DOT1Q",
"vlanTag": 1001
}
},
"zSide": {"accessPoint": {"type": "SP",
"uuid": "b840a1db-5639-639f-97e0-328a5c00a875",
"name": "exmapple-access-point-name-zside",
"profile": {"href": "https://api.equinix.com/fabric/v4/serviceProfiles/22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c",
"uuid": "22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c"
},
"location": {"metroCode": "MX",
"metroName": "Mexico City",
"sellerRegion": "us-west-1"
}
}
},
"routingProtocols": [{"type": "EBGP",
"seqId": "03f7294b-42ce-42b6-9cc8-1e1b46d8183a",
"state": "ACTIVE",
"customerAsn": 65500,
"providerAsn": 65000,
"bgpAuthKey": "testAuthKey",
"ipv4": {"customerPeerIp": "169.254.255.2/30",
"providerPeerIp": "169.254.255.1/30"
}
}
],
"operation": {"providerStatus": "PROVISIONING",
"equinixStatus": "PROVISIONED",
"maintenanceStatus": "SCHEDULED",
"lockEnabled": true
},
"changeLog": {"createdDateTime": "2020-05-21T10:30:00Z",
"updatedDateTime": "2020-05-21T10:30:00Z"
},
"project": {"projectId": "2c10d60e-29c1-4721-ad1a-b531f4e04717"
}
}
]
}

Validate Connection

This API provides capability to validate by auth key

Authorizations:

BearerAuth

Request Body schema: application/json
required

object

Filters

Array of objects

Array

property	string Path to property
operator	string Type of operation
values	Array of strings Values for the given property

Responses

Response Schema: application/json

Array of objects (ConnectionSideAdditionalInfo)

Additional information

Array

key	string Key
value	string Value

Array of objects (ValidateConnectionResponse)

Connection response data

Array

uuid	string Equinix-assigned connection identifier
bandwidth	integer [ 0 .. 100000 ] Connection bandwidth in Mbps
	object (ConnectionRedundancy) Connection redundancy configuration
	object (ConnectionSide) Connection configuration object for each side of multi-segment connection
	object (ConnectionSide) Connection configuration object for each side of multi-segment connection

Request samples

Payload

Content type

application/json

Example

Alibaba-ValidateAuthKey

{"filter": {"and": [{"property": "/zSide/accessPoint/authenticationKey",
"operator": "=",
"values": ["xxx-xxx-xxx"
]
},
{"property": "/zSide/accessPoint/profile/uuid",
"operator": "=",
"values": ["xxx-xxx-xxx"
]
},
{"property": "/zSide/accessPoint/sellerRegion",
"operator": "=",
"values": ["San Jose 2"
]
}
]
}
}

Response samples

200
400

Content type

application/json

Example

Alibaba-ValidateAuthKey

{"additionalInfo": [{"key": "message",
"value": "Authorization key provided is valid"
}
]
}

Networks

Create Network

This API provides capability to create user's Fabric Network

Authorizations:

BearerAuth

query Parameters

dryRun

boolean

Default: false

option to verify that API calls will succeed

Request Body schema: application/json
required

type

required

string (NetworkType)

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

Network type

name

required

string

Customer-provided network name

scope

required

string (NetworkScope)

Enum: "REGIONAL" "GLOBAL" "LOCAL"

Network scope

object (SimplifiedLocation)

metroHref	string
region	string
metroName	string
metroCode	string
ibx	string Deprecated

object (Project)

projectId

required

string

Subscriber-assigned project ID

required

Array of objects (SimplifiedNotification)

Preferences for notifications on network configuration or status changes

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

Responses

Response Schema: application/json

href

required

string <uri>

Network URI

uuid

required

string <uuid>

Equinix-assigned network identifier

state

required

string (NetworkState)

Enum: "ACTIVE" "INACTIVE" "DELETED"

Network status

connectionsCount

number

number of connections created on the network

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

object (SimplifiedNetworkChange)

Current state of latest network change

href	string <uri> Network URI
uuid	string <uuid> Uniquely identifies a change
type	string (NetworkChangeType) Enum: "NETWORK_CREATION" "NETWORK_UPDATE" "NETWORK_DELETION" Type of change

object (NetworkOperation)

Network operational data

equinixStatus

string (NetworkEquinixStatus)

Enum: "PROVISIONING" "PROVISIONED" "NOT_PROVISIONED" "DEPROVISIONING" "DEPROVISIONED" "NOT_DEPROVISIONED"

Network status

required

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

Array of objects (Link)

Network sub-resources links

Array

href	string <uri> Resource URI
rel	string OperationId from Swagger hub spec
method	string Http method type
contentType	string Content type for the response
authenticate	boolean Authentication required or not

type

required

string (NetworkType)

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

Network type

name

required

string

Customer-provided network name

scope

required

string (NetworkScope)

Enum: "REGIONAL" "GLOBAL" "LOCAL"

Network scope

object (SimplifiedLocation)

metroHref	string
region	string
metroName	string
metroCode	string
ibx	string Deprecated

object (Project)

projectId

required

string

Subscriber-assigned project ID

required

Array of objects (SimplifiedNotification)

Preferences for notifications on network configuration or status changes

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

Request samples

Payload

Content type

application/json

Example

Create-Global-EVPLAN-Network

{"type": "EVPLAN",
"name": "My-Network-1",
"scope": "GLOBAL",
"project": {"projectId": "d64fa54a-cfcb-4fb0-82ee-86cf47007fa2"
},
"notifications": [{"type": "ALL",
"emails": ["test@equinix.com"
]
}
]
}

Response samples

Content type

application/json

Example

EVPLAN-Global-Network

{"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": [{"href": "http://api.corp.equinix.com/fabric/v4/networks/0633e83f-116f-481d-b86f-c472271d1a8c/connections",
"rel": "getConnectionsByNetworkUuid",
"method": "GET",
"contentType": "application/json",
"authenticate": true
}
],
"project": {"projectId": "d64fa54a-cfcb-4fb0-82ee-86cf47007fa2"
},
"notifications": [{"type": "ALL",
"emails": ["fabric@gmail.com"
]
}
]
}

Get Network By ID

This API provides capability to retrieve user's Fabric Network

Authorizations:

BearerAuth

path Parameters

networkId

required

string <uuid>

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

Network UUID

Responses

Response Schema: application/json

href

required

string <uri>

Network URI

uuid

required

string <uuid>

Equinix-assigned network identifier

state

required

string (NetworkState)

Enum: "ACTIVE" "INACTIVE" "DELETED"

Network status

connectionsCount

number

number of connections created on the network

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

object (SimplifiedNetworkChange)

Current state of latest network change

href	string <uri> Network URI
uuid	string <uuid> Uniquely identifies a change
type	string (NetworkChangeType) Enum: "NETWORK_CREATION" "NETWORK_UPDATE" "NETWORK_DELETION" Type of change

object (NetworkOperation)

Network operational data

equinixStatus

string (NetworkEquinixStatus)

Enum: "PROVISIONING" "PROVISIONED" "NOT_PROVISIONED" "DEPROVISIONING" "DEPROVISIONED" "NOT_DEPROVISIONED"

Network status

required

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

Array of objects (Link)

Network sub-resources links

Array

href	string <uri> Resource URI
rel	string OperationId from Swagger hub spec
method	string Http method type
contentType	string Content type for the response
authenticate	boolean Authentication required or not

type

required

string (NetworkType)

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

Network type

name

required

string

Customer-provided network name

scope

required

string (NetworkScope)

Enum: "REGIONAL" "GLOBAL" "LOCAL"

Network scope

object (SimplifiedLocation)

metroHref	string
region	string
metroName	string
metroCode	string
ibx	string Deprecated

object (Project)

projectId

required

string

Subscriber-assigned project ID

required

Array of objects (SimplifiedNotification)

Preferences for notifications on network configuration or status changes

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

Response samples

200
401
403
404

Content type

application/json

{"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": [{"type": "ALL",
"emails": ["test@equinix.com"
]
}
],
"operation": {"equinixStatus": "PROVISIONED"
},
"changeLog": {"createdBy": "testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "testuser",
"updatedDateTime": "2020-05-21T10:30:00Z"
},
"links": [{"href": "https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784/connections",
"rel": "getConnectionsByNetworkUuid",
"method": "GET",
"contentType": "application/json",
"authenticate": true
}
]
}

Delete Network By ID

This API provides capability to delete user's Fabric Network

Authorizations:

BearerAuth

path Parameters

networkId

required

string <uuid>

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

Network UUID

Responses

Response samples

202
400
401
403
404

Content type

application/json

{"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": "INACTIVE",
"change": {"href": "https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784/changes/6d500177-9404-41f2-99e8-2bf1a84d8db5",
"uuid": "6d500177-9404-41f2-99e8-2bf1a84d8db5",
"type": "NETWORK_DELETION"
},
"location": {"region": "EMEA"
},
"scope": "REGIONAL",
"project": {"projectId": "123456"
},
"notifications": [{"type": "ALL",
"emails": ["test@equinix.com"
]
}
],
"operation": {"equinixStatus": "DEPROVISIONING"
},
"changeLog": {"createdBy": "testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "testuser1",
"updatedDateTime": "2020-05-21T10:30:00Z",
"deletedBy": "testuser1",
"deletedDateTime": "2020-05-21T10:30:00Z"
}
}

Update Network By ID

This API provides capability to update user's Fabric Network

Authorizations:

BearerAuth

path Parameters

networkId

required

string <uuid>

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

Network UUID

Request Body schema: application/json-patch+json
required

Array (non-empty)

op required	string Enum: "replace" "add" "remove" Handy shortcut for operation name
path required	string path inside document leading to updated parameter
value required	any new value for updated parameter

Responses

Response Schema: application/json

href

required

string <uri>

Network URI

uuid

required

string <uuid>

Equinix-assigned network identifier

state

required

string (NetworkState)

Enum: "ACTIVE" "INACTIVE" "DELETED"

Network status

connectionsCount

number

number of connections created on the network

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

object (SimplifiedNetworkChange)

Current state of latest network change

href	string <uri> Network URI
uuid	string <uuid> Uniquely identifies a change
type	string (NetworkChangeType) Enum: "NETWORK_CREATION" "NETWORK_UPDATE" "NETWORK_DELETION" Type of change

object (NetworkOperation)

Network operational data

equinixStatus

string (NetworkEquinixStatus)

Enum: "PROVISIONING" "PROVISIONED" "NOT_PROVISIONED" "DEPROVISIONING" "DEPROVISIONED" "NOT_DEPROVISIONED"

Network status

required

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

Array of objects (Link)

Network sub-resources links

Array

href	string <uri> Resource URI
rel	string OperationId from Swagger hub spec
method	string Http method type
contentType	string Content type for the response
authenticate	boolean Authentication required or not

type

required

string (NetworkType)

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

Network type

name

required

string

Customer-provided network name

scope

required

string (NetworkScope)

Enum: "REGIONAL" "GLOBAL" "LOCAL"

Network scope

object (SimplifiedLocation)

metroHref	string
region	string
metroName	string
metroCode	string
ibx	string Deprecated

object (Project)

projectId

required

string

Subscriber-assigned project ID

required

Array of objects (SimplifiedNotification)

Preferences for notifications on network configuration or status changes

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

Request samples

Payload

Content type

application/json-patch+json

Example

UpdateName

[{"op": "replace",
"path": "/name",
"value": "NewName"
}
]

Response samples

Content type

application/json

{"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",
"change": {"href": "https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784/changes/6d500177-9404-41f2-99e8-2bf1a84d8db5",
"uuid": "6d500177-9404-41f2-99e8-2bf1a84d8db5",
"type": "NETWORK_UPDATE"
},
"location": {"region": "EMEA"
},
"scope": "REGIONAL",
"connectionsCount": 0,
"project": {"projectId": "123456"
},
"notifications": [{"type": "ALL",
"emails": ["test@equinix.com"
]
}
],
"operation": {"equinixStatus": "PROVISIONED"
},
"changeLog": {"createdBy": "testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "testuser",
"updatedDateTime": "2020-05-21T10:30:00Z"
},
"links": [{"href": "https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784/connections",
"rel": "getConnectionsByNetworkUuid",
"method": "GET",
"contentType": "application/json",
"authenticate": true
}
]
}

Search Networks

The API provides capability to search user's Fabric Network using search criteria, including optional filtering, pagination and sorting

Authorizations:

BearerAuth

Request Body schema: application/json
required

object (NetworkFilter)

and	Array of objects (NetworkSimpleExpression)
or	Array of objects (NetworkSimpleExpression)
property	string (NetworkSearchFieldName) Enum: "/name" "/uuid" "/scope" "/type" "/state" "/operation/equinixStatus" "/location/region" "/location/metroCode" "/connectionsCount" "/project/projectId" "/account/globalCustId" "/account/orgId" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/changeLog/deletedDateTime" "/*" Possible field names to use on filters
operator	string Enum: "=" "!=" ">" ">=" "<" "<=" "BETWEEN" "NOT BETWEEN" "LIKE" "NOT LIKE" "ILIKE" "NOT ILIKE" "IN" "NOT IN"
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (NetworkSortCriteria)

Array

direction	string (NetworkSortDirection) Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string (NetworkSortBy) Default: "/changeLog/updatedDateTime" Enum: "/name" "/uuid" "/scope" "/operation/equinixStatus" "/location/region" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" Possible field names to use on sorting

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (NetworkSortCriteriaResponse)

Array

direction	string (NetworkSortDirectionResponse) Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string (NetworkSortByResponse) Default: "/changeLog/updatedDateTime" Enum: "/name" "/type" "/uuid" "/state" "/scope" "/location/region" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" Possible field names to use on sorting

Array of objects (Network)

Array

href required	string <uri> Network URI
uuid required	string <uuid> Equinix-assigned network identifier
state required	string (NetworkState) Enum: "ACTIVE" "INACTIVE" "DELETED" Network status
connectionsCount	number number of connections created on the network
	object (SimplifiedAccount)
	object (SimplifiedNetworkChange) Current state of latest network change
	object (NetworkOperation) Network operational data
required	object (Changelog) Change log
	Array of objects (Link) Network sub-resources links
type required	string (NetworkType) Enum: "EVPLAN" "EPLAN" "IPWAN" "EVPTREE" "EPTREE" Network type
name required	string Customer-provided network name
scope required	string (NetworkScope) Enum: "REGIONAL" "GLOBAL" "LOCAL" Network scope
	object (SimplifiedLocation)
	object (Project)
required	Array of objects (SimplifiedNotification) Preferences for notifications on network configuration or status changes

Request samples

Payload

Content type

application/json

Example

SearchFilterByStatus

{"filter": {"and": [{"property": "/operation/equinixStatus",
"operator": "=",
"values": ["PROVISIONED"
]
},
{"property": "/project/projectId",
"operator": "=",
"values": ["1234567"
]
}
]
},
"pagination": {"offset": 0,
"limit": 20
},
"sort": [{"direction": "DESC",
"property": "/changeLog/createdDateTime"
}
]
}

Response samples

200
400
401
403
415

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 1
},
"data": [{"href": "https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784",
"type": "EVPLAN",
"uuid": "92dc376a-a932-43aa-a6a2-c806dedbd784",
"platformUuid": "19dc376a-a932-43aa-a6a2-c806dedbd730",
"name": "My-EVPLAN-1",
"state": "ACTIVE",
"location": {"region": "EMEA"
},
"scope": "REGIONAL",
"connectionsCount": 0,
"project": {"projectId": "567"
},
"notifications": [{"type": "ALL",
"emails": ["test@equinix.com"
]
}
],
"operation": {"equinixStatus": "PROVISIONED"
},
"changeLog": {"createdBy": "testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "testuser1",
"updatedDateTime": "2020-05-21T10:30:00Z"
},
"links": [{"href": "https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784/connections",
"rel": "getConnectionsByNetworkUuid",
"method": "GET",
"contentType": "application/json",
"authenticate": true
}
]
}
],
"sort": [{"property": "/changeLog/updatedDateTime",
"direction": "DESC"
}
]
}

Get Connections

The API provides capability to get list of user's Fabric Network connections

Authorizations:

BearerAuth

path Parameters

networkId

required

string <uuid>

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

Network UUID

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (Connection)

Array

href	string <uri> Connection URI
type required	string (ConnectionType) Enum: "EVPL_VC" "EPL_VC" "EC_VC" "IP_VC" "ACCESS_EPL_VC" "EIA_VC" "EVPLAN_VC" "EPLAN_VC" "EVPTREE_VC" "EPTREE_VC" "IPWAN_VC" "IA_VC" "MC_VC" "IX_VC" "GW_VC" "IPX_VC" Connection type
uuid	string Equinix-assigned connection identifier
name required	string Customer-provided connection name
description	string Customer-provided connection description
	object (Change) Current state of latest connection change
	object (ConnectionOperation) Connection type-specific operational data
	object (Order)
	Array of objects (SimplifiedNotification) Preferences for notifications on connection configuration or status changes
	object (SimplifiedAccount)
	object (Changelog) Change log
bandwidth required	integer [ 0 .. 10000 ] Connection bandwidth in Mbps
geoScope	string (GeoScopeType) Enum: "CANADA" "CONUS" "JAPAN" "UK" "AUSTRALIA" "BRAZIL" "SWITZERLAND" "EU" Geographic boundary types
	object (ConnectionRedundancy) Connection redundancy configuration
isRemote	boolean Connection property derived from access point locations
direction	string (ConnectionDirection) Enum: "INTERNAL" "INCOMING" "OUTGOING" Connection directionality from the requester point of view
required	object (ConnectionSide) Connection configuration object for each side of multi-segment connection
required	object (ConnectionSide) Connection configuration object for each side of multi-segment connection
	object (marketplaceSubscription) Equinix Fabric Entity for Marketplace Subscription
	Array of objects (ConnectionSideAdditionalInfo) Connection additional information
	object (Project)

Response samples

200
400
401
403
415

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 2
},
"data": [{"href": "https://api.equinix.com/fabric/v4/connections/92dc376a-a932-43aa-a6a2-c806dedbd784",
"type": "IP_VC",
"uuid": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81"
},
{"href": "https://api.equinix.com/fabric/v4/connections/38a1eb68-4daf-4ef0-bd7f-6970727b6fc1",
"type": "IP_VC",
"uuid": "38a1eb68-4daf-4ef0-bd7f-6970727b6fc1"
}
]
}

Get Network Changes

The API provides capability to get list of user's Fabric Network changes

Authorizations:

BearerAuth

path Parameters

networkId

required

string <uuid>

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

Network UUID

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (NetworkChange)

Array

href	string <uri> Network URI
uuid	string <uuid> Uniquely identifies a change
type	string (NetworkChangeType) Enum: "NETWORK_CREATION" "NETWORK_UPDATE" "NETWORK_DELETION" Type of change
status	string (NetworkChangeStatus) Enum: "APPROVED" "COMPLETED" "FAILED" "REJECTED" "REQUESTED" "SUBMITTED_FOR_APPROVAL" Current outcome of the change flow
createdDateTime	string <date-time> Set when change flow starts
updatedDateTime	string <date-time> Set when change object is updated
	Array of objects (NetworkChangeOperation)

Response samples

200
400
401
403
415

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 1
},
"data": [{"href": "https://api.equinix.com/fabric/v4/networks/2a4fb415-5a7f-436f-bae6-02f5e403deec/changes/4b17da68-3d6b-436d-9c8f-2105f3b950d9",
"type": "NETWORK_CREATION",
"uuid": "4b17da68-3d6b-436d-9c8f-2105f3b950d9",
"status": "COMPLETED",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedDateTime": "2020-05-21T10:30:50Z"
},
{"href": "https://api.equinix.com/fabric/v4/networks/2a4fb415-5a7f-436f-bae6-02f5e403deec/changes/da2a2f1b-9ba0-415b-85d6-234bd4c737ec",
"type": "NETWORK_DELETION",
"uuid": "da2a2f1b-9ba0-415b-85d6-234bd4c737ec",
"status": "REQUESTED",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedDateTime": "2020-05-21T10:30:00Z"
}
]
}

Get Change By ID

This API provides capability to retrieve user's Fabric Network Change

Authorizations:

BearerAuth

path Parameters

networkId required	string <uuid> Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Network UUID
changeId required	string <uuid> Example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 Network Change UUID

Responses

Response Schema: application/json

href

string <uri>

Network URI

uuid

string <uuid>

Uniquely identifies a change

type

string (NetworkChangeType)

Enum: "NETWORK_CREATION" "NETWORK_UPDATE" "NETWORK_DELETION"

Type of change

status

string (NetworkChangeStatus)

Enum: "APPROVED" "COMPLETED" "FAILED" "REJECTED" "REQUESTED" "SUBMITTED_FOR_APPROVAL"

Current outcome of the change flow

createdDateTime

string <date-time>

Set when change flow starts

updatedDateTime

string <date-time>

Set when change object is updated

Array of objects (NetworkChangeOperation)

Array

op required	string Enum: "replace" "add" "remove" Handy shortcut for operation name
path required	string path inside document leading to updated parameter
value required	any new value for updated parameter

Response samples

200
400
401
403
404

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/networks/2a4fb415-5a7f-436f-bae6-02f5e403deec/changes/4b17da68-3d6b-436d-9c8f-2105f3b950d9",
"type": "NETWORK_CREATION",
"uuid": "4b17da68-3d6b-436d-9c8f-2105f3b950d9",
"status": "COMPLETED",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedDateTime": "2020-05-21T10:30:50Z"
}

Service Tokens

Get Service Token by ID

Get Specified Service Tokens uses the uuid of an Equinix Fabric service token to return details about the token's type, state, location, bandwidth, and other key properties.

Authorizations:

BearerAuth

path Parameters

serviceTokenId

required

string <uuid>

Service Token UUID

Responses

Response Schema: application/json

type

string (ServiceTokenType)

Enum: "VC_TOKEN" "EPL_TOKEN"

Type of Service Token

href

string <uri>

An absolute URL that is the subject of the link's context.

expiry

integer

Deprecated

uuid

string <uuid>

Equinix-assigned service token identifier

issuerSide

string

Deprecated

information about token side

name

string

Customer-provided service token name

description

string

Customer-provided service token description

expirationDateTime

string <date-time>

Expiration date and time of the service token.

object (ServiceTokenConnection)

Service Token Connection Type Information

type

string

Enum: "EVPL_VC" "EPL_VC" "EVPLAN_VC" "EPLAN_VC" "IPWAN_VC" "IP_VC" "EVPTREE_VC" "EPTREE_VC"

Type of Connection

href

string <uri>

An absolute URL that is the subject of the link's context.

uuid

string <uuid>

Equinix-assigned connection identifier

allowRemoteConnection

boolean

Default: false

Authorization to connect remotely

allowCustomBandwidth

boolean

Default: false

Allow custom bandwidth value

bandwidthLimit

integer [ 0 .. 100000 ]

Connection bandwidth limit in Mbps

supportedBandwidths

Array of integers

List of permitted bandwidths.

object (ServiceTokenSide)

Connection link protocol,virtual device or network configuration

Array of objects (AccessPointSelector)

List of AccessPointSelectors

Array

type	string Enum: "COLO" "VD" "NETWORK" Type of Access point
hideAssetInfo	boolean Deprecated
	object (SimplifiedMetadataEntity) Configuration details for port used at the access point.
	object (SimplifiedLinkProtocol) Connection link protocol Configuration
	object (SimplifiedVirtualDevice)
	object (VirtualDeviceInterface) Virtual Device Interface Information
	object (SimplifiedTokenNetwork)

object (ServiceTokenSide)

Connection link protocol,virtual device or network configuration

Array of objects (AccessPointSelector)

List of AccessPointSelectors

Array

type	string Enum: "COLO" "VD" "NETWORK" Type of Access point
hideAssetInfo	boolean Deprecated
	object (SimplifiedMetadataEntity) Configuration details for port used at the access point.
	object (SimplifiedLinkProtocol) Connection link protocol Configuration
	object (SimplifiedVirtualDevice)
	object (VirtualDeviceInterface) Virtual Device Interface Information
	object (SimplifiedTokenNetwork)

state

string (ServiceTokenState)

Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED"

Service token state

Array of objects (SimplifiedNotification)

Service token related notifications

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

object (Project)

projectId

required

string

Subscriber-assigned project ID

Response samples

200
400
403
500

Content type

application/json

Example

tokenExample

{"href": "http://api.equinix.com/fabric/v4/serviceTokens/13ab7dc7-c18e-4f73-aa35-fc3a83966e79",
"type": "VC_TOKEN",
"uuid": "13ab7dc7-c18e-4f73-aa35-fc3a83966e79",
"name": "Az_Aside_Dot1Q_Pri_SV",
"description": "Az_Aside_Dot1Q_Pri_SV_Description",
"state": "INACTIVE",
"expirationDateTime": "2021-03-18T06:43:49.980Z",
"connection": {"type": "EVPL_VC",
"allowRemoteConnection": false,
"bandwidthLimit": 50,
"allowCustomBandwidth": false,
"aSide": {"accessPointSelectors": [{"type": "COLO",
"port": {"href": "http://api.equinix.com/fabric/v4/ports/b840a1db-5758-758f-97e0-328a5c00a874",
"type": "XF_PORT",
"uuid": "b840a1db-5758-758f-97e0-328a5c00a874"
},
"linkProtocol": {"type": "QINQ",
"vlanCTag": 1399,
"vlanSTag": 1388
}
}
]
}
},
"notifications": [{"type": "NOTIFICATION",
"emails": ["abc@company.com",
"provider@company.com"
]
}
],
"account": {"orgId": 111437
},
"changelog": {"createdBy": "843577",
"createdDateTime": "2021-03-18T06:43:49.980Z",
"updatedBy": "843577",
"updatedDateTime": "2021-03-18T06:44:14.206Z"
},
"project": {"projectId": "995072000433550"
}
}

Delete Service Token by ID

Delete Service Tokens removes an Equinix Fabric service token corresponding to the specified uuid which are in INACTIVE state

Authorizations:

BearerAuth

path Parameters

serviceTokenId

required

string <uuid>

Service Token UUID

Responses

Response Schema: application/json

type

string (ServiceTokenType)

Enum: "VC_TOKEN" "EPL_TOKEN"

Type of Service Token

href

string <uri>

An absolute URL that is the subject of the link's context.

expiry

integer

Deprecated

uuid

string <uuid>

Equinix-assigned service token identifier

issuerSide

string

Deprecated

information about token side

name

string

Customer-provided service token name

description

string

Customer-provided service token description

expirationDateTime

string <date-time>

Expiration date and time of the service token.

object (ServiceTokenConnection)

Service Token Connection Type Information

type

string

Enum: "EVPL_VC" "EPL_VC" "EVPLAN_VC" "EPLAN_VC" "IPWAN_VC" "IP_VC" "EVPTREE_VC" "EPTREE_VC"

Type of Connection

href

string <uri>

An absolute URL that is the subject of the link's context.

uuid

string <uuid>

Equinix-assigned connection identifier

allowRemoteConnection

boolean

Default: false

Authorization to connect remotely

allowCustomBandwidth

boolean

Default: false

Allow custom bandwidth value

bandwidthLimit

integer [ 0 .. 100000 ]

Connection bandwidth limit in Mbps

supportedBandwidths

Array of integers

List of permitted bandwidths.

object (ServiceTokenSide)

Connection link protocol,virtual device or network configuration

Array of objects (AccessPointSelector)

List of AccessPointSelectors

Array

type	string Enum: "COLO" "VD" "NETWORK" Type of Access point
hideAssetInfo	boolean Deprecated
	object (SimplifiedMetadataEntity) Configuration details for port used at the access point.
	object (SimplifiedLinkProtocol) Connection link protocol Configuration
	object (SimplifiedVirtualDevice)
	object (VirtualDeviceInterface) Virtual Device Interface Information
	object (SimplifiedTokenNetwork)

object (ServiceTokenSide)

Connection link protocol,virtual device or network configuration

Array of objects (AccessPointSelector)

List of AccessPointSelectors

Array

type	string Enum: "COLO" "VD" "NETWORK" Type of Access point
hideAssetInfo	boolean Deprecated
	object (SimplifiedMetadataEntity) Configuration details for port used at the access point.
	object (SimplifiedLinkProtocol) Connection link protocol Configuration
	object (SimplifiedVirtualDevice)
	object (VirtualDeviceInterface) Virtual Device Interface Information
	object (SimplifiedTokenNetwork)

state

string (ServiceTokenState)

Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED"

Service token state

Array of objects (SimplifiedNotification)

Service token related notifications

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

object (Project)

projectId

required

string

Subscriber-assigned project ID

Response samples

200
400
403
500

Content type

application/json

Example

tokenExample

{"href": "http://api.equinix.com/fabric/v4/serviceTokens/13ab7dc7-c18e-4f73-aa35-fc3a83966e79",
"type": "VC_TOKEN",
"uuid": "13ab7dc7-c18e-4f73-aa35-fc3a83966e79",
"name": "Az_Aside_Dot1Q_Pri_SV",
"description": "Az_Aside_Dot1Q_Pri_SV_Description",
"state": "INACTIVE",
"expirationDateTime": "2021-03-18T06:43:49.980Z",
"connection": {"type": "EVPL_VC",
"allowRemoteConnection": false,
"bandwidthLimit": 50,
"allowCustomBandwidth": false,
"aSide": {"accessPointSelectors": [{"type": "COLO",
"port": {"href": "http://api.equinix.com/fabric/v4/ports/b840a1db-5758-758f-97e0-328a5c00a874",
"type": "XF_PORT",
"uuid": "b840a1db-5758-758f-97e0-328a5c00a874"
},
"linkProtocol": {"type": "QINQ",
"vlanCTag": 1399,
"vlanSTag": 1388
}
}
]
}
},
"notifications": [{"type": "NOTIFICATION",
"emails": ["abc@company.com",
"provider@company.com"
]
}
],
"account": {"orgId": 111437
},
"changelog": {"createdBy": "843577",
"createdDateTime": "2021-03-18T06:43:49.980Z",
"updatedBy": "843577",
"updatedDateTime": "2021-03-18T06:44:14.206Z"
},
"project": {"projectId": "995072000433550"
}
}

Update Token By ID

This API provides capability to update user's Service Token

Authorizations:

BearerAuth

path Parameters

serviceTokenId

required

string <uuid>

Service Token UUID

query Parameters

dryRun

boolean

Default: false

option to verify that API calls will succeed

Request Body schema: application/json-patch+json
required

Array (non-empty)

op required	string Enum: "replace" "add" "remove" Handy shortcut for operation name
path required	string path inside document leading to updated parameter
value required	any new value for updated parameter

Responses

Response Schema: application/json

type

string (ServiceTokenType)

Enum: "VC_TOKEN" "EPL_TOKEN"

Type of Service Token

href

string <uri>

An absolute URL that is the subject of the link's context.

expiry

integer

Deprecated

uuid

string <uuid>

Equinix-assigned service token identifier

issuerSide

string

Deprecated

information about token side

name

string

Customer-provided service token name

description

string

Customer-provided service token description

expirationDateTime

string <date-time>

Expiration date and time of the service token.

object (ServiceTokenConnection)

Service Token Connection Type Information

type

string

Enum: "EVPL_VC" "EPL_VC" "EVPLAN_VC" "EPLAN_VC" "IPWAN_VC" "IP_VC" "EVPTREE_VC" "EPTREE_VC"

Type of Connection

href

string <uri>

An absolute URL that is the subject of the link's context.

uuid

string <uuid>

Equinix-assigned connection identifier

allowRemoteConnection

boolean

Default: false

Authorization to connect remotely

allowCustomBandwidth

boolean

Default: false

Allow custom bandwidth value

bandwidthLimit

integer [ 0 .. 100000 ]

Connection bandwidth limit in Mbps

supportedBandwidths

Array of integers

List of permitted bandwidths.

object (ServiceTokenSide)

Connection link protocol,virtual device or network configuration

Array of objects (AccessPointSelector)

List of AccessPointSelectors

Array

type	string Enum: "COLO" "VD" "NETWORK" Type of Access point
hideAssetInfo	boolean Deprecated
	object (SimplifiedMetadataEntity) Configuration details for port used at the access point.
	object (SimplifiedLinkProtocol) Connection link protocol Configuration
	object (SimplifiedVirtualDevice)
	object (VirtualDeviceInterface) Virtual Device Interface Information
	object (SimplifiedTokenNetwork)

object (ServiceTokenSide)

Connection link protocol,virtual device or network configuration

Array of objects (AccessPointSelector)

List of AccessPointSelectors

Array

type	string Enum: "COLO" "VD" "NETWORK" Type of Access point
hideAssetInfo	boolean Deprecated
	object (SimplifiedMetadataEntity) Configuration details for port used at the access point.
	object (SimplifiedLinkProtocol) Connection link protocol Configuration
	object (SimplifiedVirtualDevice)
	object (VirtualDeviceInterface) Virtual Device Interface Information
	object (SimplifiedTokenNetwork)

state

string (ServiceTokenState)

Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED"

Service token state

Array of objects (SimplifiedNotification)

Service token related notifications

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

object (Project)

projectId

required

string

Subscriber-assigned project ID

Request samples

Payload

Content type

application/json-patch+json

Example

UpdateExpirationDate

[{"op": "replace",
"path": "/expirationDateTime",
"value": "2023-01-20T18:50:34.696Z"
}
]

Response samples

200
400
403
500

Content type

application/json

Example

tokenExample

{"href": "http://api.equinix.com/fabric/v4/serviceTokens/13ab7dc7-c18e-4f73-aa35-fc3a83966e79",
"type": "VC_TOKEN",
"uuid": "13ab7dc7-c18e-4f73-aa35-fc3a83966e79",
"name": "Az_Aside_Dot1Q_Pri_SV",
"description": "Az_Aside_Dot1Q_Pri_SV_Description",
"state": "INACTIVE",
"expirationDateTime": "2021-03-18T06:43:49.980Z",
"connection": {"type": "EVPL_VC",
"allowRemoteConnection": false,
"bandwidthLimit": 50,
"allowCustomBandwidth": false,
"aSide": {"accessPointSelectors": [{"type": "COLO",
"port": {"href": "http://api.equinix.com/fabric/v4/ports/b840a1db-5758-758f-97e0-328a5c00a874",
"type": "XF_PORT",
"uuid": "b840a1db-5758-758f-97e0-328a5c00a874"
},
"linkProtocol": {"type": "QINQ",
"vlanCTag": 1399,
"vlanSTag": 1388
}
}
]
}
},
"notifications": [{"type": "NOTIFICATION",
"emails": ["abc@company.com",
"provider@company.com"
]
}
],
"account": {"orgId": 111437
},
"changelog": {"createdBy": "843577",
"createdDateTime": "2021-03-18T06:43:49.980Z",
"updatedBy": "843577",
"updatedDateTime": "2021-03-18T06:44:14.206Z"
},
"project": {"projectId": "995072000433550"
}
}

Create Service Token

Create Service Tokens generates Equinix Fabric™ service tokens. These tokens authorize users to access protected resources and services.

Authorizations:

BearerAuth

query Parameters

dryRun

boolean

Default: false

option to verify that API calls will succeed

Request Body schema: application/json
required

type

string (ServiceTokenType)

Enum: "VC_TOKEN" "EPL_TOKEN"

Type of Service Token

expiry

integer

Deprecated

uuid

string <uuid>

Equinix-assigned service token identifier

issuerSide

string

Deprecated

information about token side

name

string

Customer-provided service token name

description

string

Customer-provided service token description

expirationDateTime

string <date-time>

Expiration date and time of the service token.

object (ServiceTokenConnection)

Service Token Connection Type Information

type

string

Enum: "EVPL_VC" "EPL_VC" "EVPLAN_VC" "EPLAN_VC" "IPWAN_VC" "IP_VC" "EVPTREE_VC" "EPTREE_VC"

Type of Connection

uuid

string <uuid>

Equinix-assigned connection identifier

allowRemoteConnection

boolean

Default: false

Authorization to connect remotely

allowCustomBandwidth

boolean

Default: false

Allow custom bandwidth value

bandwidthLimit

integer [ 0 .. 100000 ]

Connection bandwidth limit in Mbps

supportedBandwidths

Array of integers

List of permitted bandwidths.

object (ServiceTokenSide)

Connection link protocol,virtual device or network configuration

Array of objects (AccessPointSelector)

List of AccessPointSelectors

Array

type	string Enum: "COLO" "VD" "NETWORK" Type of Access point
hideAssetInfo	boolean Deprecated
	object (SimplifiedMetadataEntity) Configuration details for port used at the access point.
	object (SimplifiedLinkProtocol) Connection link protocol Configuration
	object (SimplifiedVirtualDevice)
	object (VirtualDeviceInterface) Virtual Device Interface Information
	object (SimplifiedTokenNetwork)

object (ServiceTokenSide)

Connection link protocol,virtual device or network configuration

Array of objects (AccessPointSelector)

List of AccessPointSelectors

Array

type	string Enum: "COLO" "VD" "NETWORK" Type of Access point
hideAssetInfo	boolean Deprecated
	object (SimplifiedMetadataEntity) Configuration details for port used at the access point.
	object (SimplifiedLinkProtocol) Connection link protocol Configuration
	object (SimplifiedVirtualDevice)
	object (VirtualDeviceInterface) Virtual Device Interface Information
	object (SimplifiedTokenNetwork)

state

string (ServiceTokenState)

Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED"

Service token state

Array of objects (SimplifiedNotification)

Service token related notifications

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

object (Project)

projectId

required

string

Subscriber-assigned project ID

Responses

Response Schema: application/json

type

string (ServiceTokenType)

Enum: "VC_TOKEN" "EPL_TOKEN"

Type of Service Token

href

string <uri>

An absolute URL that is the subject of the link's context.

expiry

integer

Deprecated

uuid

string <uuid>

Equinix-assigned service token identifier

issuerSide

string

Deprecated

information about token side

name

string

Customer-provided service token name

description

string

Customer-provided service token description

expirationDateTime

string <date-time>

Expiration date and time of the service token.

object (ServiceTokenConnection)

Service Token Connection Type Information

type

string

Enum: "EVPL_VC" "EPL_VC" "EVPLAN_VC" "EPLAN_VC" "IPWAN_VC" "IP_VC" "EVPTREE_VC" "EPTREE_VC"

Type of Connection

href

string <uri>

An absolute URL that is the subject of the link's context.

uuid

string <uuid>

Equinix-assigned connection identifier

allowRemoteConnection

boolean

Default: false

Authorization to connect remotely

allowCustomBandwidth

boolean

Default: false

Allow custom bandwidth value

bandwidthLimit

integer [ 0 .. 100000 ]

Connection bandwidth limit in Mbps

supportedBandwidths

Array of integers

List of permitted bandwidths.

object (ServiceTokenSide)

Connection link protocol,virtual device or network configuration

Array of objects (AccessPointSelector)

List of AccessPointSelectors

Array

type	string Enum: "COLO" "VD" "NETWORK" Type of Access point
hideAssetInfo	boolean Deprecated
	object (SimplifiedMetadataEntity) Configuration details for port used at the access point.
	object (SimplifiedLinkProtocol) Connection link protocol Configuration
	object (SimplifiedVirtualDevice)
	object (VirtualDeviceInterface) Virtual Device Interface Information
	object (SimplifiedTokenNetwork)

object (ServiceTokenSide)

Connection link protocol,virtual device or network configuration

Array of objects (AccessPointSelector)

List of AccessPointSelectors

Array

type	string Enum: "COLO" "VD" "NETWORK" Type of Access point
hideAssetInfo	boolean Deprecated
	object (SimplifiedMetadataEntity) Configuration details for port used at the access point.
	object (SimplifiedLinkProtocol) Connection link protocol Configuration
	object (SimplifiedVirtualDevice)
	object (VirtualDeviceInterface) Virtual Device Interface Information
	object (SimplifiedTokenNetwork)

state

string (ServiceTokenState)

Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED"

Service token state

Array of objects (SimplifiedNotification)

Service token related notifications

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

object (Project)

projectId

required

string

Subscriber-assigned project ID

Response Schema: application/json

type

string (ServiceTokenType)

Enum: "VC_TOKEN" "EPL_TOKEN"

Type of Service Token

href

string <uri>

An absolute URL that is the subject of the link's context.

expiry

integer

Deprecated

uuid

string <uuid>

Equinix-assigned service token identifier

issuerSide

string

Deprecated

information about token side

name

string

Customer-provided service token name

description

string

Customer-provided service token description

expirationDateTime

string <date-time>

Expiration date and time of the service token.

object (ServiceTokenConnection)

Service Token Connection Type Information

type

string

Enum: "EVPL_VC" "EPL_VC" "EVPLAN_VC" "EPLAN_VC" "IPWAN_VC" "IP_VC" "EVPTREE_VC" "EPTREE_VC"

Type of Connection

href

string <uri>

An absolute URL that is the subject of the link's context.

uuid

string <uuid>

Equinix-assigned connection identifier

allowRemoteConnection

boolean

Default: false

Authorization to connect remotely

allowCustomBandwidth

boolean

Default: false

Allow custom bandwidth value

bandwidthLimit

integer [ 0 .. 100000 ]

Connection bandwidth limit in Mbps

supportedBandwidths

Array of integers

List of permitted bandwidths.

object (ServiceTokenSide)

Connection link protocol,virtual device or network configuration

Array of objects (AccessPointSelector)

List of AccessPointSelectors

Array

type	string Enum: "COLO" "VD" "NETWORK" Type of Access point
hideAssetInfo	boolean Deprecated
	object (SimplifiedMetadataEntity) Configuration details for port used at the access point.
	object (SimplifiedLinkProtocol) Connection link protocol Configuration
	object (SimplifiedVirtualDevice)
	object (VirtualDeviceInterface) Virtual Device Interface Information
	object (SimplifiedTokenNetwork)

object (ServiceTokenSide)

Connection link protocol,virtual device or network configuration

Array of objects (AccessPointSelector)

List of AccessPointSelectors

Array

type	string Enum: "COLO" "VD" "NETWORK" Type of Access point
hideAssetInfo	boolean Deprecated
	object (SimplifiedMetadataEntity) Configuration details for port used at the access point.
	object (SimplifiedLinkProtocol) Connection link protocol Configuration
	object (SimplifiedVirtualDevice)
	object (VirtualDeviceInterface) Virtual Device Interface Information
	object (SimplifiedTokenNetwork)

state

string (ServiceTokenState)

Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED"

Service token state

Array of objects (SimplifiedNotification)

Service token related notifications

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

object (Project)

projectId

required

string

Subscriber-assigned project ID

Request samples

Payload

Content type

application/json

Example

AsideTokenWithQnQ

{"type": "VC_TOKEN",
"name": "Az_Aside_Dot1Q_Pri_SV",
"description": "Az_Aside_Dot1Q_Pri_SV_Description",
"expirationDateTime": "2021-03-18T06:43:49.980Z",
"connection": {"type": "EVPL_VC",
"allowRemoteConnection": false,
"bandwidthLimit": 50,
"allowCustomBandwidth": false,
"aSide": {"accessPointSelectors": [{"type": "COLO",
"port": {"uuid": "b840a1db-5758-758f-97e0-328a5c00a874"
},
"linkProtocol": {"type": "QINQ",
"vlanCTag": 1399,
"vlanSTag": 1388
}
}
]
}
},
"notifications": [{"type": "NOTIFICATION",
"emails": ["abc@company.com",
"provider@company.com"
]
}
]
}

Response samples

200
201
400
401
403

Content type

application/json

{"type": "VC_TOKEN",
"name": "Aside_Dot1Q_Service_Token",
"description": "Az_Aside_Dot1Q_DryRun_Description",
"expirationDateTime": "2024-12-18T06:43:49.980Z",
"connection": {"type": "EVPL_VC",
"allowRemoteConnection": false,
"bandwidthLimit": 50,
"allowCustomBandwidth": false,
"aSide": {"accessPointSelectors": [{"type": "COLO",
"port": {"href": "http://api.equinix.com/fabric/v4/ports/b840a1db-5758-758f-97e0-328a5c00a874",
"uuid": "b840a1db-5758-758f-97e0-328a5c00a874"
},
"linkProtocol": {"type": "DOT1Q",
"vlanTag": 1399
}
}
]
}
},
"notifications": [{"type": "NOTIFICATION",
"emails": ["abc@company.com",
"provider@company.com"
]
}
]
}

Get Service Tokens

Get All ServiceTokens creates a list of all Equinix Fabric service tokens associated with the subscriber's account.

Authorizations:

BearerAuth

query Parameters

offset	number offset
limit	number number of records to fetch

Responses

Response Schema: application/json

Array of objects (ServiceToken)

List of Service Tokens

Array

type	string (ServiceTokenType) Enum: "VC_TOKEN" "EPL_TOKEN" Type of Service Token
href	string <uri> An absolute URL that is the subject of the link's context.
expiry	integer Deprecated
uuid	string <uuid> Equinix-assigned service token identifier
issuerSide	string Deprecated information about token side
name	string Customer-provided service token name
description	string Customer-provided service token description
expirationDateTime	string <date-time> Expiration date and time of the service token.
	object (ServiceTokenConnection) Service Token Connection Type Information
state	string (ServiceTokenState) Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED" Service token state
	Array of objects (SimplifiedNotification) Service token related notifications
	object (SimplifiedAccount)
	object (Changelog) Change log
	object (Project)

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Response samples

200
403

Content type

application/json

{"pagination": {"offset": 0,
"limit": 75,
"total": 2
},
"data": [{"href": "https://api.equinix.com/fabric/v4/serviceTokens/ea40918e-9b39-4045-8be8-0beaa7eb5ce1",
"type": "VC_TOKEN",
"name": "zside_network_token",
"uuid": "ea40918e-9b39-4045-8be8-0beaa7eb5ce1",
"description": "zside_Network_token",
"connection": {"type": "EVPLAN_VC",
"allowRemoteConnection": true,
"allowCustomBandwidth": false,
"bandwidthLimit": 20000,
"zSide": {"accessPointSelectors": [{"type": "NETWORK",
"network": {"href": "https://api.equinix.com/fabric/v4/networks/20d32a80-0d61-4333-bc03-707b591ae2f4",
"type": "EVPLAN",
"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4",
"scope": "REGIONAL"
}
}
]
}
},
"project": {"projectId": "30ad25e2-53dc-11ed-bdc3-0242ac120002"
},
"expirationDateTime": "2021-03-18T06:43:49.980Z",
"notifications": [{"type": "NOTIFICATION",
"emails": ["abc@company.com"
]
}
]
},
{"href": "https://api.equinix.com/fabric/v4/serviceTokens/ea40918e-9b39-4045-8be8-0beaa7eb5ce1",
"type": "VC_TOKEN",
"name": "zside_vd_token",
"uuid": "ea40918e-9b39-4045-8be8-0beaa7eb5ce1",
"description": "zside vd token",
"connection": {"type": "EVPL_VC",
"allowRemoteConnection": true,
"allowCustomBandwidth": false,
"supportedBandwidths": [10,
50,
200
],
"zSide": {"accessPointSelectors": [{"type": "VD",
"virtualDevice": {"type": "EDGE",
"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
},
"interface": {"type": "NETWORK",
"id": 45645
}
}
]
}
},
"project": {"projectId": "30ad25e2-53dc-11ed-bdc3-0242ac120002"
},
"expirationDateTime": "2021-03-18T06:43:49.980Z",
"notifications": [{"type": "NOTIFICATION",
"emails": ["abc@company.com"
]
}
]
},
{"href": "http://api.equinix.com/fabric/v4/serviceTokens/13ab7dc7-c18e-4f73-aa35-fc3a83966e79",
"type": "VC_TOKEN",
"uuid": "13ab7dc7-c18e-4f73-aa35-fc3a83966e79",
"name": "Az_Aside_Dot1Q_Pri_SV",
"description": "Az_Aside_Dot1Q_Pri_SV_Description",
"state": "INACTIVE",
"expirationDateTime": "2021-03-18T06:43:49.980Z",
"project": {"projectId": "30ad25e2-53dc-11ed-bdc3-0242ac120002"
},
"connection": {"type": "EVPL_VC",
"allowRemoteConnection": false,
"bandwidthLimit": 50,
"allowCustomBandwidth": false,
"aSide": {"accessPointSelectors": [{"type": "COLO",
"port": {"href": "http://api.equinix.com/fabric/v4/ports/b840a1db-5758-758f-97e0-328a5c00a874",
"type": "XF_PORT",
"uuid": "b840a1db-5758-758f-97e0-328a5c00a874"
},
"linkProtocol": {"type": "QINQ",
"vlanCTag": 1399,
"vlanSTag": 1388
}
}
]
}
},
"notifications": [{"type": "NOTIFICATION",
"emails": ["abc@company.com",
"provider@company.com"
]
}
],
"account": {"orgId": 111437
},
"changelog": {"createdBy": "843577",
"createdDateTime": "2021-03-18T06:43:49.980Z",
"updatedBy": "843577",
"updatedDateTime": "2021-03-18T06:44:14.206Z"
}
}
]
}

Create Service Token Action

This API provides capability to accept/reject user's servicetokens

Authorizations:

BearerAuth

path Parameters

serviceTokenId

required

string <uuid>

Service Token UUID

Request Body schema: application/json
required

type

required

string (ServiceTokenActions)

Value: "RESEND_EMAIL_NOTIFICATION"

Service Token action type

Responses

Request samples

Payload

Content type

application/json

{"type": "RESEND_EMAIL_NOTIFICATION"
}

Response samples

202
400
401
403
404

Content type

application/json

{"href": "http://api.equinix.com/fabric/v4/serviceTokens/13ab7dc7-c18e-4f73-aa35-fc3a83966e79",
"type": "VC_TOKEN",
"uuid": "13ab7dc7-c18e-4f73-aa35-fc3a83966e79",
"name": "Az_Aside_Dot1Q_Pri_SV",
"description": "Az_Aside_Dot1Q_Pri_SV_Description",
"state": "INACTIVE",
"expiry": 0,
"expirationDateTime": "2021-03-18T06:43:49.980Z",
"connection": {"type": "EVPL_VC",
"allowRemoteConnection": false,
"bandwidthLimit": 50,
"allowCustomBandwidth": false,
"aSide": {"accessPointSelectors": [{"type": "COLO",
"port": {"href": "http://api.equinix.com/fabric/v4/ports/b840a1db-5758-758f-97e0-328a5c00a874",
"type": "XF_PORT",
"uuid": "b840a1db-5758-758f-97e0-328a5c00a874"
},
"linkProtocol": {"type": "QINQ",
"vlanCTag": 1399,
"vlanSTag": 1388
}
}
]
}
},
"notifications": [{"type": "NOTIFICATION",
"emails": ["abc@company.com",
"provider@company.com"
]
}
],
"account": {"orgId": 111437
},
"changelog": {"createdBy": "843577",
"createdDateTime": "2021-03-18T06:43:49.980Z",
"updatedBy": "843577",
"updatedDateTime": "2021-03-18T06:44:14.206Z"
},
"project": {"projectId": "995072000433550"
}
}

Search Service Tokens

The API provides capability to get list of user's servicetokens using search criteria, including optional filtering, pagination and sorting

Authorizations:

BearerAuth

query Parameters

offset	number offset
limit	number number of records to fetch

Request Body schema: application/json
required

object (ServiceTokenSearchExpression)

and	Array of objects (ServiceTokenSearchExpressions)
or	Array of objects (ServiceTokenSearchExpressions)
property	string (ServiceTokenSearchFieldName) Enum: "/uuid" "/state" "/name" "/project/projectId" "/type" "/expirationDateTime" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/connection/aSide/accessPointSelectors/port/uuid" "/connection/zSide/accessPointSelectors/port/uuid" Possible field names to use on filters
operator	string Enum: "=" "!=" "LIKE" "ILIKE" "<" ">" "<=" ">=" "IN" "NOT IN" "BETWEEN" "NOT BETWEEN"
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Responses

Response Schema: application/json

Array of objects (ServiceToken)

List of Service Tokens

Array

type	string (ServiceTokenType) Enum: "VC_TOKEN" "EPL_TOKEN" Type of Service Token
href	string <uri> An absolute URL that is the subject of the link's context.
expiry	integer Deprecated
uuid	string <uuid> Equinix-assigned service token identifier
issuerSide	string Deprecated information about token side
name	string Customer-provided service token name
description	string Customer-provided service token description
expirationDateTime	string <date-time> Expiration date and time of the service token.
	object (ServiceTokenConnection) Service Token Connection Type Information
state	string (ServiceTokenState) Enum: "ACTIVE" "INACTIVE" "EXPIRED" "DELETED" Service token state
	Array of objects (SimplifiedNotification) Service token related notifications
	object (SimplifiedAccount)
	object (Changelog) Change log
	object (Project)

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Request samples

Payload

Content type

application/json

{"filter": {"and": [{"property": "/uuid",
"operator": "=",
"values": ["407f8239-254c-4fe2-a378-458f197e17c4"
]
}
]
}
}

Response samples

200
400
403
404
500

Content type

application/json

{"pagination": {"offset": 0,
"limit": 75,
"total": 2
},
"data": [{"href": "https://api.equinix.com/fabric/v4/serviceTokens/ea40918e-9b39-4045-8be8-0beaa7eb5ce1",
"type": "VC_TOKEN",
"name": "zside_network_token",
"uuid": "ea40918e-9b39-4045-8be8-0beaa7eb5ce1",
"description": "zside_Network_token",
"connection": {"type": "EVPLAN_VC",
"allowRemoteConnection": true,
"allowCustomBandwidth": false,
"bandwidthLimit": 20000,
"zSide": {"accessPointSelectors": [{"type": "NETWORK",
"network": {"href": "https://api.equinix.com/fabric/v4/networks/20d32a80-0d61-4333-bc03-707b591ae2f4",
"type": "EVPLAN",
"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4",
"scope": "REGIONAL"
}
}
]
}
},
"project": {"projectId": "30ad25e2-53dc-11ed-bdc3-0242ac120002"
},
"expirationDateTime": "2021-03-18T06:43:49.980Z",
"notifications": [{"type": "NOTIFICATION",
"emails": ["abc@company.com"
]
}
]
},
{"href": "https://api.equinix.com/fabric/v4/serviceTokens/ea40918e-9b39-4045-8be8-0beaa7eb5ce1",
"type": "VC_TOKEN",
"name": "zside_vd_token",
"uuid": "ea40918e-9b39-4045-8be8-0beaa7eb5ce1",
"description": "zside vd token",
"connection": {"type": "EVPL_VC",
"allowRemoteConnection": true,
"allowCustomBandwidth": false,
"supportedBandwidths": [10,
50,
200
],
"zSide": {"accessPointSelectors": [{"type": "VD",
"virtualDevice": {"type": "EDGE",
"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
},
"interface": {"type": "NETWORK",
"id": 45645
}
}
]
}
},
"project": {"projectId": "30ad25e2-53dc-11ed-bdc3-0242ac120002"
},
"expirationDateTime": "2021-03-18T06:43:49.980Z",
"notifications": [{"type": "NOTIFICATION",
"emails": ["abc@company.com"
]
}
]
},
{"href": "http://api.equinix.com/fabric/v4/serviceTokens/13ab7dc7-c18e-4f73-aa35-fc3a83966e79",
"type": "VC_TOKEN",
"uuid": "13ab7dc7-c18e-4f73-aa35-fc3a83966e79",
"name": "Az_Aside_Dot1Q_Pri_SV",
"description": "Az_Aside_Dot1Q_Pri_SV_Description",
"state": "INACTIVE",
"expirationDateTime": "2021-03-18T06:43:49.980Z",
"project": {"projectId": "30ad25e2-53dc-11ed-bdc3-0242ac120002"
},
"connection": {"type": "EVPL_VC",
"allowRemoteConnection": false,
"bandwidthLimit": 50,
"allowCustomBandwidth": false,
"aSide": {"accessPointSelectors": [{"type": "COLO",
"port": {"href": "http://api.equinix.com/fabric/v4/ports/b840a1db-5758-758f-97e0-328a5c00a874",
"type": "XF_PORT",
"uuid": "b840a1db-5758-758f-97e0-328a5c00a874"
},
"linkProtocol": {"type": "QINQ",
"vlanCTag": 1399,
"vlanSTag": 1388
}
}
]
}
},
"notifications": [{"type": "NOTIFICATION",
"emails": ["abc@company.com",
"provider@company.com"
]
}
],
"account": {"orgId": 111437
},
"changelog": {"createdBy": "843577",
"createdDateTime": "2021-03-18T06:43:49.980Z",
"updatedBy": "843577",
"updatedDateTime": "2021-03-18T06:44:14.206Z"
}
}
]
}

Cloud Routers

Search Advertised Routes

The API provides capability to get list of user's advertised routes using search criteria, including optional filtering, pagination and sorting

Authorizations:

BearerAuth

path Parameters

connectionId

required

string

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

Connection Id

Request Body schema: application/json
required

object (ConnectionRouteEntryFilters)

Array of ConnectionRouteEntrySimpleExpression (object) or ConnectionRouteEntryOrFilter (object) (ConnectionRouteEntryFilter) <= 8 items

Array (<= 8 items)

Any of

property	string Possible field names to use on filters: `/type` - Route table entry type `/state` - Route table entry state `/prefix` - Route table entry prefix `/nextHop` - Route table entry nextHop `/*` - all-category search
operator	string Possible operators to use on filters: `=` - equal `!=` - not equal `>` - greater than `>=` - greater than or equal to `<` - less than `<=` - less than or equal to `[NOT] BETWEEN` - (not) between `[NOT] LIKE` - (not) like `[NOT] IN` - (not) in `~*` - case-insensitive like
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (ConnectionRouteSortCriteria)

Array

direction	string (ConnectionRouteEntrySortDirection) Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string (ConnectionRouteEntrySortBy) Default: "/changeLog/updatedDateTime" Enum: "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/med" "/connection/name" "/type" "/prefix" "/nextHop" Possible field names to use on sorting

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (ConnectionRouteTableEntry)

Data returned from the API call.

Array

type required	string (RouteTableEntryType) Enum: "IPv4_BGP_ROUTE" "IPv4_STATIC_ROUTE" "IPv4_DIRECT_ROUTE" "IPv6_BGP_ROUTE" "IPv6_STATIC_ROUTE" "IPv6_DIRECT_ROUTE" Route table entry type
protocolType	string (RouteTableEntryProtocolType) Enum: "BGP" "STATIC" "DIRECT" Route table entry protocol type
state	string Enum: "ACTIVE" "INACTIVE"
prefix	string
nextHop	string
MED	integer
localPreference	integer
asPath	Array of strings
	object
required	object (Changelog) Change log

Request samples

Payload

Content type

application/json

Example

ConnectionRoutesSearchType

{"filter": {"and": [{"property": "/type",
"operator": "=",
"values": ["IPv4_BGP_ROUTE"
]
}
]
},
"pagination": {"offset": 0,
"limit": 20
},
"sort": [{"direction": "DESC",
"property": "/changeLog/createdDateTime"
}
]
}

Response samples

200
400
401
403
404

Content type

application/json

Example

advertisedRoutes

{"pagination": {"offset": 0,
"limit": 20,
"total": 1
},
"data": [{"type": "IPv4_BGP_ROUTE",
"protocolType": "BGP",
"state": "ACTIVE",
"prefix": "192.168.10.0/24",
"nextHop": "10.10.10.5",
"MED": 5,
"asPath": ["20001"
],
"connection": {"href": "https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809",
"uuid": "81331c52-04c0-4656-a4a7-18c52669348f",
"name": "connection_1"
},
"changeLog": {"createdBy": "johnsmith",
"createdByFullName": "John Smith",
"createdByEmail": "john.smith@example.com",
"createdDateTime": "2020-11-06T07:00:00Z",
"updatedBy": "johnsmith",
"updatedByFullName": "John Smith",
"updatedByEmail": "john.smith@example.com",
"updatedDateTime": "2020-11-06T07:00:00Z",
"deletedBy": "johnsmith",
"deletedByFullName": "John Smith",
"deletedByEmail": "john.smith@example.com",
"deletedDateTime": "2020-11-06T07:00:00Z"
}
}
]
}

Search Received Routes

The API provides capability to get list of received routes using search criteria, including optional filtering, pagination and sorting

Authorizations:

BearerAuth

path Parameters

connectionId

required

string

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

Connection Id

Request Body schema: application/json
required

object (ConnectionRouteEntryFilters)

Array of ConnectionRouteEntrySimpleExpression (object) or ConnectionRouteEntryOrFilter (object) (ConnectionRouteEntryFilter) <= 8 items

Array (<= 8 items)

Any of

property	string Possible field names to use on filters: `/type` - Route table entry type `/state` - Route table entry state `/prefix` - Route table entry prefix `/nextHop` - Route table entry nextHop `/*` - all-category search
operator	string Possible operators to use on filters: `=` - equal `!=` - not equal `>` - greater than `>=` - greater than or equal to `<` - less than `<=` - less than or equal to `[NOT] BETWEEN` - (not) between `[NOT] LIKE` - (not) like `[NOT] IN` - (not) in `~*` - case-insensitive like
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (ConnectionRouteSortCriteria)

Array

direction	string (ConnectionRouteEntrySortDirection) Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string (ConnectionRouteEntrySortBy) Default: "/changeLog/updatedDateTime" Enum: "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/med" "/connection/name" "/type" "/prefix" "/nextHop" Possible field names to use on sorting

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (ConnectionRouteTableEntry)

Data returned from the API call.

Array

type required	string (RouteTableEntryType) Enum: "IPv4_BGP_ROUTE" "IPv4_STATIC_ROUTE" "IPv4_DIRECT_ROUTE" "IPv6_BGP_ROUTE" "IPv6_STATIC_ROUTE" "IPv6_DIRECT_ROUTE" Route table entry type
protocolType	string (RouteTableEntryProtocolType) Enum: "BGP" "STATIC" "DIRECT" Route table entry protocol type
state	string Enum: "ACTIVE" "INACTIVE"
prefix	string
nextHop	string
MED	integer
localPreference	integer
asPath	Array of strings
	object
required	object (Changelog) Change log

Request samples

Payload

Content type

application/json

Example

ConnectionRoutesSearchType

{"filter": {"and": [{"property": "/type",
"operator": "=",
"values": ["IPv4_BGP_ROUTE"
]
}
]
},
"pagination": {"offset": 0,
"limit": 20
},
"sort": [{"direction": "DESC",
"property": "/changeLog/createdDateTime"
}
]
}

Response samples

200
400
401
403
404

Content type

application/json

Example

advertisedRoutes

{"pagination": {"offset": 0,
"limit": 20,
"total": 1
},
"data": [{"type": "IPv4_BGP_ROUTE",
"protocolType": "BGP",
"state": "ACTIVE",
"prefix": "192.168.10.0/24",
"nextHop": "10.10.10.5",
"MED": 5,
"asPath": ["20001"
],
"connection": {"href": "https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809",
"uuid": "81331c52-04c0-4656-a4a7-18c52669348f",
"name": "connection_1"
},
"changeLog": {"createdBy": "johnsmith",
"createdByFullName": "John Smith",
"createdByEmail": "john.smith@example.com",
"createdDateTime": "2020-11-06T07:00:00Z",
"updatedBy": "johnsmith",
"updatedByFullName": "John Smith",
"updatedByEmail": "john.smith@example.com",
"updatedDateTime": "2020-11-06T07:00:00Z",
"deletedBy": "johnsmith",
"deletedByFullName": "John Smith",
"deletedByEmail": "john.smith@example.com",
"deletedDateTime": "2020-11-06T07:00:00Z"
}
}
]
}

Create Router

This API provides capability to create user's Cloud Router

Authorizations:

BearerAuth

query Parameters

dryRun

boolean

Default: false

option to verify that API calls will succeed

Request Body schema: application/json
required

type

required

string

Value: "XF_ROUTER"

name

required

string

Customer-provided Cloud Router name

required

object (SimplifiedLocationWithoutIBX)

metroHref	string The Canonical URL at which the resource resides.
region	string
metroName	string
metroCode required	string

required

object (CloudRouterPostRequestPackage)

Fabric Cloud Router Package Type

href	string <uri> Fabric Cloud Router URI
type	string Value: "ROUTER_PACKAGE" Cloud Router package type
code required	string Enum: "LAB" "BASIC" "STANDARD" "ADVANCED" "PREMIUM" Cloud Router package code

object (Order)

purchaseOrderNumber	string Purchase order number
customerReferenceNumber	string Customer reference number
billingTier	string Billing tier for connection bandwidth
orderId	string Order Identification
orderNumber	string Order Reference Number
termLength	integer [ 1 .. 60 ] Default: 1 Term length in months, valid values are 1, 12, 24, 36, 60 where 1 is the default value (for on-demand case).
contractedBandwidth	integer Contracted bandwidth

object (Project)

projectId

required

string

Subscriber-assigned project ID

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

required

Array of objects (SimplifiedNotification)

Preferences for notifications on connection configuration or status changes

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

object (marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

type	string Enum: "AWS_MARKETPLACE_SUBSCRIPTION" "GCP_MARKETPLACE_SUBSCRIPTION" "AZURE_MARKETPLACE_SUBSCRIPTION" Marketplace Subscription type
uuid	string Equinix-assigned Marketplace Subscription identifier

Responses

Response Schema: application/json

href

string <uri>

Cloud Routers URI

uuid

string <uuid>

Equinix-assigned access point identifier

name

string <string>

Customer-provided Cloud Router name

state

string (CloudRouterAccessPointState)

Enum: "PROVISIONED" "PROVISIONING" "DEPROVISIONING" "DEPROVISIONED" "REPROVISIONING" "NOT_PROVISIONED" "NOT_DEPROVISIONED"

Access point lifecycle state

equinixAsn

integer <int64>

Equinix ASN

connectionsCount

integer >= 0

Number of connections associated with this Access point

object

Equinix Fabric Entity for Marketplace Subscription

href	string <uri> Marketplace Subscription URI
type	string Enum: "AWS_MARKETPLACE_SUBSCRIPTION" "GCP_MARKETPLACE_SUBSCRIPTION" "AZURE_MARKETPLACE_SUBSCRIPTION" Marketplace Subscription type
uuid	string Equinix-assigned Marketplace Subscription identifier

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

object (CloudRouterChange)

Current state of latest CloudRouter change

uuid

string

Uniquely identifies a change

type

required

string

Value: "ROUTER_UPDATE"

Type of change

status

string

Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdDateTime

string <date-time>

Set when change flow starts

updatedDateTime

required

string <date-time>

Set when change object is updated

information

string

Additional information

Array of objects (CloudRouterChangeOperation)

Array

op required	string Enum: "replace" "add" "remove" Handy shortcut for operation name
path required	string path inside document leading to updated parameter
value required	any new value for updated parameter

type

string

Value: "XF_ROUTER"

object (SimplifiedLocationWithoutIBX)

metroHref	string The Canonical URL at which the resource resides.
region	string
metroName	string
metroCode required	string

object (CloudRouterPostRequestPackage)

Fabric Cloud Router Package Type

href	string <uri> Fabric Cloud Router URI
type	string Value: "ROUTER_PACKAGE" Cloud Router package type
code required	string Enum: "LAB" "BASIC" "STANDARD" "ADVANCED" "PREMIUM" Cloud Router package code

object (Order)

purchaseOrderNumber	string Purchase order number
customerReferenceNumber	string Customer reference number
billingTier	string Billing tier for connection bandwidth
orderId	string Order Identification
orderNumber	string Order Reference Number
termLength	integer [ 1 .. 60 ] Default: 1 Term length in months, valid values are 1, 12, 24, 36, 60 where 1 is the default value (for on-demand case).
contractedBandwidth	integer Contracted bandwidth

object (Project)

projectId

required

string

Subscriber-assigned project ID

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

Array of objects (SimplifiedNotification)

Preferences for notifications on connection configuration or status changes

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

Request samples

Payload

Content type

application/json

Example

CreateLabPackage

{"type": "XF_ROUTER",
"name": "My-Cloud-Router",
"location": {"metroCode": "SV"
},
"package": {"code": "LAB"
},
"notifications": [{"type": "ALL",
"emails": ["test@test.com"
]
}
],
"account": {"accountNumber": 272010
},
"project": {"projectId": "995072000433550"
}
}

Response samples

Content type

application/json

Example

cloudRouterResponse

{"href": "https://api.equinix.com/fabric/v4/routers/201b7346-a9eb-42fe-ae7a-08148c71928d",
"uuid": "201b7346-a9eb-42fe-ae7a-08148c71928d",
"state": "PROVISIONED",
"type": "XF_ROUTER",
"name": "My-Cloud-Router",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/HH",
"metroCode": "HH"
},
"equinixAsn": 30000,
"package": {"href": "https://api.equinix.com/fabric/v4/routerPackages/STANDARD",
"code": "STANDARD"
},
"order": {"purchaseOrderNumber": "1-129105284100"
},
"project": {"projectId": "12345"
},
"notifications": [{"type": "ALL",
"emails": ["abc@abc.com"
]
}
],
"account": {"accountNumber": 123
},
"connectionsCount": 0,
"changeLog": {"createdBy": "abc@xyz.com",
"createdByFullName": "abc",
"createdByEmail": "abc@xyz.com",
"createdDateTime": "2021-09-24T06:59:46Z"
}
}

Get Router

This API provides capability to retrieve user's Cloud Router

Authorizations:

BearerAuth

path Parameters

routerId

required

string <uuid>

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

Cloud Router UUID

Responses

Response Schema: application/json

type

string

Enum: "IC_ROUTER" "XF_ROUTER"

name

string

Customer-provided Cloud Router name

object (SimplifiedLocationWithoutIBX)

metroHref	string The Canonical URL at which the resource resides.
region	string
metroName	string
metroCode required	string

object (CloudRouterPostRequestPackage)

Fabric Cloud Router Package Type

href	string <uri> Fabric Cloud Router URI
type	string Value: "ROUTER_PACKAGE" Cloud Router package type
code required	string Enum: "LAB" "BASIC" "STANDARD" "ADVANCED" "PREMIUM" Cloud Router package code

object (Order)

purchaseOrderNumber	string Purchase order number
customerReferenceNumber	string Customer reference number
billingTier	string Billing tier for connection bandwidth
orderId	string Order Identification
orderNumber	string Order Reference Number
termLength	integer [ 1 .. 60 ] Default: 1 Term length in months, valid values are 1, 12, 24, 36, 60 where 1 is the default value (for on-demand case).
contractedBandwidth	integer Contracted bandwidth

object (Project)

projectId

required

string

Subscriber-assigned project ID

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

Array of objects (SimplifiedNotification)

Preferences for notifications on connection configuration or status changes

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

href

string <uri>

Cloud Routers URI

uuid

string <uuid>

Equinix-assigned access point identifier

state

string (CloudRouterAccessPointState)

Enum: "PROVISIONED" "PROVISIONING" "DEPROVISIONING" "DEPROVISIONED" "REPROVISIONING" "NOT_PROVISIONED" "NOT_DEPROVISIONED"

Access point lifecycle state

equinixAsn

integer <int64>

Equinix ASN

connectionsCount

integer >= 0

Number of connections associated with this Access point

object (marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

href	string <uri> Marketplace Subscription URI
type	string Enum: "AWS_MARKETPLACE_SUBSCRIPTION" "GCP_MARKETPLACE_SUBSCRIPTION" "AZURE_MARKETPLACE_SUBSCRIPTION" Marketplace Subscription type
uuid	string Equinix-assigned Marketplace Subscription identifier

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

object (CloudRouterChange)

Current state of latest CloudRouter change

uuid

string

Uniquely identifies a change

type

required

string

Value: "ROUTER_UPDATE"

Type of change

status

string

Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdDateTime

string <date-time>

Set when change flow starts

updatedDateTime

required

string <date-time>

Set when change object is updated

information

string

Additional information

Array of objects (CloudRouterChangeOperation)

Array

op required	string Enum: "replace" "add" "remove" Handy shortcut for operation name
path required	string path inside document leading to updated parameter
value required	any new value for updated parameter

Response samples

200
401
403
404
500

Content type

application/json

Example

cloudRouterResponse

{"href": "https://api.equinix.com/fabric/v4/routers/201b7346-a9eb-42fe-ae7a-08148c71928d",
"uuid": "201b7346-a9eb-42fe-ae7a-08148c71928d",
"state": "PROVISIONED",
"type": "XF_ROUTER",
"name": "My-Cloud-Router",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/HH",
"metroCode": "HH"
},
"equinixAsn": 30000,
"package": {"href": "https://api.equinix.com/fabric/v4/routerPackages/STANDARD",
"code": "STANDARD"
},
"order": {"purchaseOrderNumber": "1-129105284100"
},
"project": {"projectId": "ae708bbb-d669-406a-845a-99b39ff65fd0"
},
"notifications": [{"type": "ALL",
"emails": ["abc@abc.com"
]
}
],
"account": {"accountNumber": 123
},
"connectionsCount": 0,
"changeLog": {"createdBy": "abc@xyz.com",
"createdByFullName": "abc",
"createdByEmail": "abc@xyz.com",
"createdDateTime": "2021-09-24T06:59:46Z",
"updatedBy": "abc@xyz.com",
"updatedByFullName": "abc",
"updatedByEmail": "abc@xyz.com",
"updatedDateTime": "2021-09-24T06:59:46Z",
"deletedBy": "abc@xyz.com",
"deletedByFullName": "abc",
"deletedByEmail": "abc@xyz.com",
"deletedDateTime": "2021-09-24T06:59:46Z"
}
}

Delete Router

This API provides capability to delete user's Cloud Router

Authorizations:

BearerAuth

path Parameters

routerId

required

string <uuid>

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

Cloud Router UUID

Responses

Response samples

400
401
403
404
500

Content type

application/json

Example

invalidState

[{"errorCode": "EQ-3040030",
"errorMessage": "Cannot delete Fabric Cloud Router in transient state",
"correlationId": "c82ff3bc-de07-47e5-b3ec-53a009d01515",
"details": "Cannot delete Fabric Cloud Router in transient state."
}
]

Update Router

This API provides capability to update user's Cloud Router

Authorizations:

BearerAuth

path Parameters

routerId

required

string <uuid>

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

Cloud Router UUID

Request Body schema: application/json-patch+json
required

Array (non-empty)

op required	string Enum: "replace" "add" "remove" Handy shortcut for operation name
path required	string path inside document leading to updated parameter
value required	any new value for updated parameter

Responses

Response Schema: application/json

href

string <uri>

Cloud Routers URI

uuid

string <uuid>

Equinix-assigned access point identifier

name

string <string>

Customer-provided Cloud Router name

state

string (CloudRouterAccessPointState)

Enum: "PROVISIONED" "PROVISIONING" "DEPROVISIONING" "DEPROVISIONED" "REPROVISIONING" "NOT_PROVISIONED" "NOT_DEPROVISIONED"

Access point lifecycle state

equinixAsn

integer <int64>

Equinix ASN

connectionsCount

integer >= 0

Number of connections associated with this Access point

object

Equinix Fabric Entity for Marketplace Subscription

href	string <uri> Marketplace Subscription URI
type	string Enum: "AWS_MARKETPLACE_SUBSCRIPTION" "GCP_MARKETPLACE_SUBSCRIPTION" "AZURE_MARKETPLACE_SUBSCRIPTION" Marketplace Subscription type
uuid	string Equinix-assigned Marketplace Subscription identifier

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

object (CloudRouterChange)

Current state of latest CloudRouter change

uuid

string

Uniquely identifies a change

type

required

string

Value: "ROUTER_UPDATE"

Type of change

status

string

Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdDateTime

string <date-time>

Set when change flow starts

updatedDateTime

required

string <date-time>

Set when change object is updated

information

string

Additional information

Array of objects (CloudRouterChangeOperation)

Array

op required	string Enum: "replace" "add" "remove" Handy shortcut for operation name
path required	string path inside document leading to updated parameter
value required	any new value for updated parameter

type

string

Value: "XF_ROUTER"

object (SimplifiedLocationWithoutIBX)

metroHref	string The Canonical URL at which the resource resides.
region	string
metroName	string
metroCode required	string

object (CloudRouterPostRequestPackage)

Fabric Cloud Router Package Type

href	string <uri> Fabric Cloud Router URI
type	string Value: "ROUTER_PACKAGE" Cloud Router package type
code required	string Enum: "LAB" "BASIC" "STANDARD" "ADVANCED" "PREMIUM" Cloud Router package code

object (Order)

purchaseOrderNumber	string Purchase order number
customerReferenceNumber	string Customer reference number
billingTier	string Billing tier for connection bandwidth
orderId	string Order Identification
orderNumber	string Order Reference Number
termLength	integer [ 1 .. 60 ] Default: 1 Term length in months, valid values are 1, 12, 24, 36, 60 where 1 is the default value (for on-demand case).
contractedBandwidth	integer Contracted bandwidth

object (Project)

projectId

required

string

Subscriber-assigned project ID

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

Array of objects (SimplifiedNotification)

Preferences for notifications on connection configuration or status changes

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

Request samples

Payload

Content type

application/json-patch+json

Example

UpdatePackage

[{"op": "replace",
"path": "/package/code",
"value": "PREMIUM"
}
]

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/routers/201b7346-a9eb-42fe-ae7a-08148c71928d",
"uuid": "201b7346-a9eb-42fe-ae7a-08148c71928d",
"state": "PROVISIONED",
"type": "XF_ROUTER",
"name": "My-Cloud-Router",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/HH",
"metroCode": "HH"
},
"equinixAsn": 30000,
"package": {"href": "https://api.equinix.com/fabric/v4/routerPackages/STANDARD",
"code": "STANDARD"
},
"order": {"purchaseOrderNumber": "1-129105284100"
},
"project": {"projectId": "123456"
},
"notifications": [{"type": "ALL",
"emails": ["abc@abc.com"
]
}
],
"account": {"accountNumber": 123
},
"connectionsCount": 0,
"change": {"uuid": "3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
"type": "ROUTER_UPDATE",
"status": "REQUESTED",
"createdDateTime": "2022-04-19T04:20:55.471Z",
"updatedDateTime": "2022-04-19T04:20:55.471Z",
"data": [{"op": "replace",
"path": "/package/code",
"value": "PREMIUM"
},
{"op": "replace",
"path": "/order/termLength",
"value": 12
}
]
},
"changeLog": {"createdBy": "abc@xyz.com",
"createdByFullName": "abc",
"createdByEmail": "abc@xyz.com",
"createdDateTime": "2021-09-24T06:59:46Z",
"updatedBy": "abc@xyz.com",
"updatedByFullName": "abc",
"updatedByEmail": "abc@xyz.com",
"updatedDateTime": "2021-09-24T06:59:46Z",
"deletedBy": "abc@xyz.com",
"deletedByFullName": "abc",
"deletedByEmail": "abc@xyz.com",
"deletedDateTime": "2021-09-24T06:59:46Z"
}
}

Create Route Table Action

This API provides capability to refresh route table and bgp session summary information

Authorizations:

BearerAuth

path Parameters

routerId

required

string <uuid>

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

Router UUID

Request Body schema: application/json
required

type

required

string (CloudRouterActionType)

Enum: "BGP_SESSION_STATUS_UPDATE" "ROUTE_TABLE_ENTRY_UPDATE" "RECEIVED_ROUTE_ENTRY_UPDATE" "ADVERTISED_ROUTE_ENTRY_UPDATE"

Cloud router action type

object (RouterActionsConnection)

Connection object for router actions

uuid

string

Connection UUID

href

string

type

string (ConnectionType)

Enum: "EVPL_VC" "EPL_VC" "EC_VC" "IP_VC" "ACCESS_EPL_VC" "EIA_VC" "EVPLAN_VC" "EPLAN_VC" "EVPTREE_VC" "EPTREE_VC" "IPWAN_VC" "IA_VC" "MC_VC" "IX_VC" "GW_VC" "IPX_VC"

Connection type

object (Operation)

Operation object for router actions

bgpIpv4RoutesCount	integer IPV4 route count
bgpIpv6RoutesCount	integer IPV6 route count
distinctIpv4PrefixesCount	integer distinct IPV4 prefixes count
distinctIpv6PrefixesCount	integer distinct IPV6 prefixes count

Responses

Request samples

Payload

Content type

application/json

Example

RouteEntriesStatusUpdate

{"type": "ROUTE_TABLE_ENTRY_UPDATE"
}

Response samples

Content type

application/json

Example

cloudRouterActionExample

{"type": "ROUTE_TABLE_ENTRY_UPDATE",
"uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
"state": "PENDING",
"changeLog": {"createdDateTime": "2020-05-21T10:30:00Z"
}
}

Get Route Table Actions

This API provides capability to fetch all actions for a given cloud router

Authorizations:

BearerAuth

path Parameters

routerId

required

string <uuid>

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

Router UUID

query Parameters

state

string (CloudRouterActionState)

Enum: "SUCCEEDED" "FAILED" "PENDING"

Action state

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (CloudRouterActionResponse)

Data returned from the API call.

Array

type required	string (CloudRouterActionType) Enum: "BGP_SESSION_STATUS_UPDATE" "ROUTE_TABLE_ENTRY_UPDATE" "RECEIVED_ROUTE_ENTRY_UPDATE" "ADVERTISED_ROUTE_ENTRY_UPDATE" Cloud router action type
uuid required	string <uuid>
description	string
state required	string (CloudRouterActionState) Enum: "SUCCEEDED" "FAILED" "PENDING" Cloud router action state
required	object (Changelog) Change log
href	string
	object (RouterActionsConnection) Connection object for router actions
	object (RouterActionsRouter) Router object for router actions

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 1,
"total": 2,
"prev": null,
"next": null
},
"data": [{"href": "https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/actions/1e9414f1-763e-4c0a-86c6-0bc8336048d9",
"uuid": "1e9414f1-763e-4c0a-86c6-0bc8336048d9",
"type": "RECEIVED_ROUTE_ENTRY_UPDATE",
"state": "SUCCEEDED",
"connection": {"href": "https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809",
"uuid": "3066ab1d-af87-49d7-8a14-c9bdb57ac809",
"type": "IP_VC",
"operation": {"bgpIpv4RoutesCount": 6,
"bgpIpv6RoutesCount": 6,
"distinctIpv4PrefixesCount": 4,
"distinctIpv6PrefixesCount": 4
}
},
"changeLog": {"createdDateTime": "2024-01-01T01:00:00Z",
"updatedDateTime": "2024-01-01T01:01:00Z"
}
},
{"href": "https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/actions/1e9414f1-763e-4c0a-86c6-0bc8336048d9",
"uuid": "1e9414f1-763e-4c0a-86c6-0bc8336048d9",
"type": "ROUTE_TABLE_ENTRY_UPDATE",
"state": "SUCCEEDED",
"router": {"href": "https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809",
"uuid": "3066ab1d-af87-49d7-8a14-c9bdb57ac809",
"type": "XF_ROUTER",
"operation": {"bgpIpv4RoutesCount": 6,
"bgpIpv6RoutesCount": 6,
"distinctIpv4PrefixesCount": 4,
"distinctIpv6PrefixesCount": 4
}
},
"changeLog": {"createdDateTime": "2024-01-01T01:00:00Z",
"updatedDateTime": "2024-01-01T01:01:00Z"
}
}
]
}

Search Route Table Actions

This API provides capability to search route table actions for a given cloud router

Authorizations:

BearerAuth

path Parameters

routerId

required

string <uuid>

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

Router UUID

Request Body schema: application/json
required

object (CloudRouterActionsSearchFilters)

Array of CloudRouterActionsSearchExpression (object) or CloudRouterActionsSearchOrFilter (object) (CloudRouterActionsSearchFilter) <= 8 items

Array (<= 8 items)

Any of

property	string Possible field names to use on filters: `/type` - type of update `/state` - action state `/connection/uuid` - connection uuid associated `/*` - all-category search
operator	string Possible operators to use on filters: `=` - equal `!=` - not equal `>` - greater than `>=` - greater than or equal to `<` - less than `<=` - less than or equal to `[NOT] BETWEEN` - (not) between `[NOT] LIKE` - (not) like `[NOT] IN` - (not) in `~*` - case-insensitive like
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (CloudRouterActionsSearchSortCriteria)

Array

direction	string (CloudRouterActionsSearchSortDirection) Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string (CloudRouterActionsSearchSortBy) Default: "/changeLog/updatedDateTime" Enum: "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/connection/name" "/type" Possible field names to use on sorting

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (CloudRouterActionResponse)

Data returned from the API call.

Array

type required	string (CloudRouterActionType) Enum: "BGP_SESSION_STATUS_UPDATE" "ROUTE_TABLE_ENTRY_UPDATE" "RECEIVED_ROUTE_ENTRY_UPDATE" "ADVERTISED_ROUTE_ENTRY_UPDATE" Cloud router action type
uuid required	string <uuid>
description	string
state required	string (CloudRouterActionState) Enum: "SUCCEEDED" "FAILED" "PENDING" Cloud router action state
required	object (Changelog) Change log
href	string
	object (RouterActionsConnection) Connection object for router actions
	object (RouterActionsRouter) Router object for router actions

Request samples

Payload

Content type

application/json

{"filter": {"and": [{"property": "/type",
"operator": "=",
"values": ["ROUTE_TABLE_ENTRY_UPDATE"
]
}
]
},
"pagination": {"offset": 0,
"limit": 20
},
"sort": [{"direction": "DESC",
"property": "/changeLog/createdDateTime"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 1,
"total": 2,
"prev": null,
"next": null
},
"data": [{"href": "https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/actions/1e9414f1-763e-4c0a-86c6-0bc8336048d9",
"uuid": "1e9414f1-763e-4c0a-86c6-0bc8336048d9",
"type": "RECEIVED_ROUTE_ENTRY_UPDATE",
"state": "SUCCEEDED",
"connection": {"href": "https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809",
"uuid": "3066ab1d-af87-49d7-8a14-c9bdb57ac809",
"type": "IP_VC",
"operation": {"bgpIpv4RoutesCount": 6,
"bgpIpv6RoutesCount": 6,
"distinctIpv4PrefixesCount": 4,
"distinctIpv6PrefixesCount": 4
}
},
"changeLog": {"createdDateTime": "2024-01-01T01:00:00Z",
"updatedDateTime": "2024-01-01T01:01:00Z"
}
},
{"href": "https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/actions/1e9414f1-763e-4c0a-86c6-0bc8336048d9",
"uuid": "1e9414f1-763e-4c0a-86c6-0bc8336048d9",
"type": "ROUTE_TABLE_ENTRY_UPDATE",
"state": "SUCCEEDED",
"router": {"href": "https://api.equinix.com/fabric/v4/connections/3066ab1d-af87-49d7-8a14-c9bdb57ac809",
"uuid": "3066ab1d-af87-49d7-8a14-c9bdb57ac809",
"type": "XF_ROUTER",
"operation": {"bgpIpv4RoutesCount": 6,
"bgpIpv6RoutesCount": 6,
"distinctIpv4PrefixesCount": 4,
"distinctIpv6PrefixesCount": 4
}
},
"changeLog": {"createdDateTime": "2024-01-01T01:00:00Z",
"updatedDateTime": "2024-01-01T01:01:00Z"
}
}
]
}

Get Route Table Action by ID

This API provides capability to fetch action status

Authorizations:

BearerAuth

path Parameters

routerId required	string <uuid> Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Router UUID
actionId required	string <uuid> Example: 457400f8-d360-11e9-bb65-2a2ae2dbcced Action UUID

query Parameters

state

string (CloudRouterActionState)

Enum: "SUCCEEDED" "FAILED" "PENDING"

Action state

Responses

Response Schema: application/json

type

required

string (CloudRouterActionType)

Enum: "BGP_SESSION_STATUS_UPDATE" "ROUTE_TABLE_ENTRY_UPDATE" "RECEIVED_ROUTE_ENTRY_UPDATE" "ADVERTISED_ROUTE_ENTRY_UPDATE"

Cloud router action type

uuid

required

string <uuid>

description

string

state

required

string (CloudRouterActionState)

Enum: "SUCCEEDED" "FAILED" "PENDING"

Cloud router action state

required

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

href

string

object (RouterActionsConnection)

Connection object for router actions

uuid

string

Connection UUID

href

string

type

string (ConnectionType)

Enum: "EVPL_VC" "EPL_VC" "EC_VC" "IP_VC" "ACCESS_EPL_VC" "EIA_VC" "EVPLAN_VC" "EPLAN_VC" "EVPTREE_VC" "EPTREE_VC" "IPWAN_VC" "IA_VC" "MC_VC" "IX_VC" "GW_VC" "IPX_VC"

Connection type

object (Operation)

Operation object for router actions

bgpIpv4RoutesCount	integer IPV4 route count
bgpIpv6RoutesCount	integer IPV6 route count
distinctIpv4PrefixesCount	integer distinct IPV4 prefixes count
distinctIpv6PrefixesCount	integer distinct IPV6 prefixes count

object (RouterActionsRouter)

Router object for router actions

uuid

string

Router UUID

href

string

type

string

Value: "XF_ROUTER"

object (Operation)

Operation object for router actions

bgpIpv4RoutesCount	integer IPV4 route count
bgpIpv6RoutesCount	integer IPV6 route count
distinctIpv4PrefixesCount	integer distinct IPV4 prefixes count
distinctIpv6PrefixesCount	integer distinct IPV6 prefixes count

Response samples

Content type

application/json

{"type": "ROUTE_TABLE_ENTRY_UPDATE",
"uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
"state": "PENDING",
"changeLog": {"createdDateTime": "2020-05-21T10:30:00Z"
}
}

Create Command

This API provides capability to initiate Command

Authorizations:

BearerAuth

path Parameters

routerId

required

string <uuid>

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

Router UUID

Request Body schema: application/json
required

type

required

string (CloudRouterCommandType)

Enum: "PING_COMMAND" "TRACEROUTE_COMMAND"

Fabric Cloud Router Command Type

name

string

Customer-provided Cloud Router Command name

description

string

Customer-provided Cloud Router Command description

required

object (Project)

projectId

required

string

Subscriber-assigned project ID

required

object (CloudRouterCommandRequestPayload)

Fabric Cloud Router Command Request

destination

required

string

Fabric Cloud Router Ping or Traceroute Command Destination

required

object (CloudRouterCommandRequestConnection)

Connection object for Cloud Router Command

uuid

required

string

Connection UUID

timeout

integer

Timeout in seconds for Fabric Cloud Router Command:

For PING_COMMAND: Packet timeout duration. The default value is 5.
For TRACEROUTE_COMMAND: Probe timeout duration. The default value is 2 and it is not configurable.

dataBytes

integer [ 16 .. 9000 ]

Default: 64

Ping Command DataBytes. This field is only applicable for commands of type PING_COMMAND.

probes

integer

Default: 3

Number of probes for Fabric Cloud Router Traceroute Command. This field is only applicable for commands of type TRACEROUTE_COMMAND and is not configurable.

hopsMax

integer <= 30

Default: 20

Maximum number of hops for the traceroute command. This field is only applicable for commands of type TRACEROUTE_COMMAND.

Responses

Request samples

Payload

Content type

application/json

Example

InitiatePingCommand

{"type": "PING_COMMAND",
"name": "ping-test-1",
"description": "Testing FCR-SV-1",
"project": {"projectId": "b11d4cb5-978a-418a-8b13-bf19abb97938"
},
"request": {"destination": "8.8.8.8",
"sourceConnection": {"uuid": "1da3778c-6aa3-4e47-b2fe-83a0773dde18"
},
"timeout": 2,
"dataBytes": 100
}
}

Response samples

Content type

application/json

Example

initiatePingCommandsExample

{"href": "https://api.equinix.com/fabric/v4/routers/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81/commands/37c10edc-ba2e-4240-a850-8a48f9c47d00",
"type": "PING_COMMAND",
"uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
"name": "ping-test-1",
"description": "Testing FCR-SV-1",
"state": "PENDING",
"project": {"projectId": "b11d4cb5-978a-418a-8b13-bf19abb97938"
},
"request": {"destination": "8.8.8.8",
"sourceConnection": {"uuid": "1da3778c-6aa3-4e47-b2fe-83a0773dde18"
},
"timeout": 2,
"dataBytes": 100,
"count": 5,
"interval": 1000
},
"changeLog": {"createdBy": "testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
}

Get Commands

This API provides capability to fetch all commands

Authorizations:

BearerAuth

path Parameters

routerId

required

string <uuid>

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

Router UUID

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (CloudRouterCommand)

Array

href	string
type	string (CloudRouterCommandType) Enum: "PING_COMMAND" "TRACEROUTE_COMMAND" Fabric Cloud Router Command Type
uuid	string <uuid>
name	string <string> Customer-provided Cloud Router name
description	string
state	string (CloudRouterCommandState) Enum: "PENDING" "SUCCEEDED" "FAILED" "DELETED" Fabric Cloud Router Command State
	object (Project)
	object (CloudRouterCommandRequestResponse) Fabric Cloud Router Command Request
	CloudRouterCommandPingResponse (object) or CloudRouterCommandTracerouteResponse (object) (CloudRouterCommandResponse)
	object (Changelog) Change log

Response samples

Content type

application/json

{"pagination": {"offset": 20,
"limit": 20,
"total": 100,
"next": "/search?offset=40&limit=20",
"previous": "/search?offset=0&limit=20"
},
"data": [{"href": "https://api.equinix.com/fabric/v4/routers/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81/commands/37c10edc-ba2e-4240-a850-8a48f9c47d00",
"type": "PING_COMMAND",
"uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
"name": "ping-test-1",
"description": "Testing FCR-SV-1",
"state": "SUCCEEDED",
"project": {"projectId": "b11d4cb5-978a-418a-8b13-bf19abb97938"
},
"request": {"destination": "8.8.8.8",
"sourceConnection": {"uuid": "1da3778c-6aa3-4e47-b2fe-83a0773dde18"
},
"timeout": 5,
"dataBytes": 100,
"count": 5,
"interval": 1000
},
"response": {"output": "PING 8.8.8.8 (8.8.8.8): 100 data bytes\n108 bytes from 8.8.8.8: icmp_seq=0 ttl=117 time=9.839 ms\n108 bytes from 8.8.8.8: icmp_seq=1 ttl=117 time=16.051 ms\n108 bytes from 8.8.8.8: icmp_seq=2 ttl=117 time=9.271 ms\n108 bytes from 8.8.8.8: icmp_seq=3 ttl=117 time=26.771 ms\n--- 8.8.8.8 ping statistics ---\n4 packets transmitted, 4 packets received, 0.0% packet loss\nround-trip min/avg/max/stddev = 9.271/15.483/26.771/7.039 ms",
"outputStructuredPing": {"destinationIp": "8.8.8.8",
"destinationName": "8.8.8.8",
"dataBytes": 100,
"packetsTransmitted": 4,
"packetsReceived": 4,
"packetsLossPercent": 0,
"rttMin": 9.271,
"rttAvg": 15.483,
"rttMax": 26.771,
"rttStdDev": 7.039,
"responses": [{"bytes": 100,
"ip": "8.8.8.8",
"icmpSeq": 0,
"ttl": 117,
"time": 9.839
},
{"bytes": 100,
"ip": "8.8.8.8",
"icmpSeq": 1,
"ttl": 117,
"time": 16.051
},
{"bytes": 100,
"ip": "8.8.8.8",
"icmpSeq": 2,
"ttl": 117,
"time": 9.271
},
{"bytes": 100,
"ip": "8.8.8.8",
"icmpSeq": 3,
"ttl": 117,
"time": 26.771
}
]
}
},
"changeLog": {"createdBy": "testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
}
]
}

Search Commands

This API provides capability to search commands

Authorizations:

BearerAuth

path Parameters

routerId

required

string <uuid>

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

Router UUID

Request Body schema: application/json
required

object (CloudRouterCommandSearchFilters)

Array of CloudRouterCommandSearchExpression (object) or CloudRouterCommandSearchOrFilter (object) (CloudRouterCommandSearchFilter) <= 8 items

Array (<= 8 items)

Any of

property	string Possible field names to use on filters: `/type` - type of command `/name` - name of command `/state` - state of command `/request/destination` - destination of command request `/request/sourceConnection/uuid` - source connection uuid `/*` - all-category search
operator	string Possible operators to use on filters: `=` - equal `!=` - not equal `>` - greater than `>=` - greater than or equal to `<` - less than `<=` - less than or equal to `[NOT] BETWEEN` - (not) between `[NOT] LIKE` - (not) like `[NOT] IN` - (not) in `~*` - case-insensitive like
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (CloudRouterCommandSearchSortCriteria)

Array

direction	string (CloudRouterCommandSearchSortDirection) Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string (CloudRouterCommandSearchSortBy) Default: "/changeLog/updatedDateTime" Enum: "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/name" "/type" Possible field names to use on sorting

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (CloudRouterCommand)

Data returned from the API call.

Array

href	string
type	string (CloudRouterCommandType) Enum: "PING_COMMAND" "TRACEROUTE_COMMAND" Fabric Cloud Router Command Type
uuid	string <uuid>
name	string <string> Customer-provided Cloud Router name
description	string
state	string (CloudRouterCommandState) Enum: "PENDING" "SUCCEEDED" "FAILED" "DELETED" Fabric Cloud Router Command State
	object (Project)
	object (CloudRouterCommandRequestResponse) Fabric Cloud Router Command Request
	CloudRouterCommandPingResponse (object) or CloudRouterCommandTracerouteResponse (object) (CloudRouterCommandResponse)
	object (Changelog) Change log

Request samples

Payload

Content type

application/json

{"filter": {"and": [{"property": "/state",
"operator": "=",
"values": ["SUCCEEDED"
]
}
]
},
"pagination": {"offset": 0,
"limit": 20
},
"sort": [{"direction": "DESC",
"property": "/changeLog/createdDateTime"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 20,
"limit": 20,
"total": 100,
"next": "/search?offset=40&limit=20",
"previous": "/search?offset=0&limit=20"
},
"data": [{"href": "https://api.equinix.com/fabric/v4/routers/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81/commands/37c10edc-ba2e-4240-a850-8a48f9c47d00",
"type": "PING_COMMAND",
"uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
"name": "ping-test-1",
"description": "Testing FCR-SV-1",
"state": "SUCCEEDED",
"project": {"projectId": "b11d4cb5-978a-418a-8b13-bf19abb97938"
},
"request": {"destination": "8.8.8.8",
"sourceConnection": {"uuid": "1da3778c-6aa3-4e47-b2fe-83a0773dde18"
},
"timeout": 2,
"dataBytes": 100,
"count": 5,
"interval": 1000
},
"response": {"output": "PING 8.8.8.8 (8.8.8.8): 100 data bytes\n108 bytes from 8.8.8.8: icmp_seq=0 ttl=117 time=9.839 ms\n108 bytes from 8.8.8.8: icmp_seq=1 ttl=117 time=16.051 ms\n108 bytes from 8.8.8.8: icmp_seq=2 ttl=117 time=9.271 ms\n108 bytes from 8.8.8.8: icmp_seq=3 ttl=117 time=26.771 ms \n--- 8.8.8.8 ping statistics ---\n4 packets transmitted, 4 packets received, 0.0% packet loss\nround-trip min/avg/max/stddev = 9.271/15.483/26.771/7.039 ms",
"outputStructuredPing": {"destinationIp": "8.8.8.8",
"destinationName": "8.8.8.8",
"dataBytes": 100,
"packetsTransmitted": 4,
"packetsReceived": 4,
"packetsLossPercent": 0,
"rttMin": 9.271,
"rttAvg": 15.483,
"rttMax": 26.771,
"rttStdDev": 7.039,
"responses": [{"bytes": 100,
"ip": "8.8.8.8",
"icmpSeq": 0,
"ttl": 117,
"time": 9.839
},
{"bytes": 100,
"ip": "8.8.8.8",
"icmpSeq": 1,
"ttl": 117,
"time": 16.051
},
{"bytes": 100,
"ip": "8.8.8.8",
"icmpSeq": 2,
"ttl": 117,
"time": 9.271
},
{"bytes": 100,
"ip": "8.8.8.8",
"icmpSeq": 3,
"ttl": 117,
"time": 26.771
}
]
}
},
"changeLog": {"createdBy": "testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
}
]
}

Get Command

This API provides capability to fetch command using command Id

Authorizations:

BearerAuth

path Parameters

routerId required	string <uuid> Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Router UUID
commandId required	string <uuid> Example: 37c10edc-ba2e-4240-a850-8a48f9c47d00 Command UUID

Responses

Response Schema: application/json

href

string

type

string (CloudRouterCommandType)

Enum: "PING_COMMAND" "TRACEROUTE_COMMAND"

Fabric Cloud Router Command Type

uuid

string <uuid>

name

string <string>

Customer-provided Cloud Router name

description

string

state

string (CloudRouterCommandState)

Enum: "PENDING" "SUCCEEDED" "FAILED" "DELETED"

Fabric Cloud Router Command State

object (Project)

projectId

required

string

Subscriber-assigned project ID

object (CloudRouterCommandRequestResponse)

Fabric Cloud Router Command Request

destination

string

Fabric Cloud Router Ping or Traceroute Command Destination

object (CloudRouterCommandRequestConnection)

Connection object for Cloud Router Command

uuid

required

string

Connection UUID

timeout

integer

Timeout in seconds for Fabric Cloud Router Command:

For PING_COMMAND: Packet timeout duration. The default value is 5.
For TRACEROUTE_COMMAND: Probe timeout duration. The default value is 2 and it is not configurable.

dataBytes

integer [ 16 .. 9000 ]

Default: 64

Ping Command DataBytes. This field is only applicable for commands of type PING_COMMAND.

interval

integer

Default: 1000

Time in milliseconds between sending each packet. This field is only applicable for commands of type PING_COMMAND.

count

integer

Default: 5

Total number of ping requests. This field is only applicable for commands of type PING_COMMAND.

probes

integer

Default: 3

Number of probes for Fabric Cloud Router Traceroute Command. This field is only applicable for commands of type TRACEROUTE_COMMAND and is not configurable.

hopsMax

integer <= 30

Default: 20

Maximum number of hops for the traceroute command. This field is only applicable for commands of type TRACEROUTE_COMMAND.

CloudRouterCommandPingResponse (object) or CloudRouterCommandTracerouteResponse (object) (CloudRouterCommandResponse)

One of

output

string

object (OutputStructuredPing)

destinationIp	string
destinationName	string
dataBytes	integer
packetsTransmitted	integer
packetsReceived	integer
packetsLossPercent	number <float>
rttMin	number <float>
rttAvg	number <float>
rttMax	number <float>
rttStdDev	number <float>
	Array of objects (OutputStructuredPingResponseItem)

Array of objects (Error)

Array

errorCode required	string^EQ-\d{7}$
errorMessage required	string
correlationId	string
details	string
help	string
	Array of objects

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

Response samples

Content type

application/json

Example

getCommandExample

{"href": "https://api.equinix.com/fabric/v4/routers/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81/commands/37c10edc-ba2e-4240-a850-8a48f9c47d00",
"type": "PING_COMMAND",
"uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
"name": "ping-test-1",
"description": "Testing FCR-SV-1",
"state": "SUCCEEDED",
"project": {"projectId": "b11d4cb5-978a-418a-8b13-bf19abb97938"
},
"request": {"destination": "8.8.8.8",
"sourceConnection": {"uuid": "1da3778c-6aa3-4e47-b2fe-83a0773dde18"
},
"timeout": 2,
"dataBytes": 100,
"count": 5,
"interval": 1000
},
"response": {"output": "PING 8.8.8.8 (8.8.8.8): 100 data bytes\n108 bytes from 8.8.8.8: icmp_seq=0 ttl=117 time=9.839 ms\n108 bytes from 8.8.8.8: icmp_seq=1 ttl=117 time=16.051 ms\n108 bytes from 8.8.8.8: icmp_seq=2 ttl=117 time=9.271 ms\n108 bytes from 8.8.8.8: icmp_seq=3 ttl=117 time=26.771 ms \n--- 8.8.8.8 ping statistics ---\n4 packets transmitted, 4 packets received, 0.0% packet loss\nround-trip min/avg/max/stddev = 9.271/15.483/26.771/7.039 ms",
"outputStructuredPing": {"destinationIp": "8.8.8.8",
"destinationName": "8.8.8.8",
"dataBytes": 100,
"packetsTransmitted": 4,
"packetsReceived": 4,
"packetsLossPercent": 0,
"rttMin": 9.271,
"rttAvg": 15.483,
"rttMax": 26.771,
"rttStdDev": 7.039,
"responses": [{"bytes": 100,
"ip": "8.8.8.8",
"icmpSeq": 0,
"ttl": 117,
"time": 9.839
},
{"bytes": 100,
"ip": "8.8.8.8",
"icmpSeq": 1,
"ttl": 117,
"time": 16.051
},
{"bytes": 100,
"ip": "8.8.8.8",
"icmpSeq": 2,
"ttl": 117,
"time": 9.271
},
{"bytes": 100,
"ip": "8.8.8.8",
"icmpSeq": 3,
"ttl": 117,
"time": 26.771
}
]
}
},
"changeLog": {"createdBy": "testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
}

Delete Command

This API provides capability to delete command based on command Id

Authorizations:

BearerAuth

path Parameters

routerId required	string <uuid> Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Router UUID
commandId required	string <uuid> Example: 37c10edc-ba2e-4240-a850-8a48f9c47d00 Command UUID

Responses

Response samples

400
401
403
404
500

Content type

application/json

[{"errorCode": "EQ-3043023",
"errorMessage": "Cannot delete Command in pending state",
"correlationId": "c82ff3bc-de07-47e5-b3ec-53a009d01515",
"details": "Cannot delete Fabric Cloud Router in transient state."
}
]

Search Route Tables

The API provides capability to get list of user's Fabric Cloud Router route table entries using search criteria, including optional filtering, pagination and sorting

Authorizations:

BearerAuth

path Parameters

routerId

required

string <uuid>

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

Router UUID

Request Body schema: application/json
required

object (RouteTableEntryFilters)

Array of RouteTableEntrySimpleExpression (object) or RouteTableEntryOrFilter (object) (RouteTableEntryFilter) <= 8 items

Array (<= 8 items)

Any of

property	string Possible field names to use on filters: `/type` - Route table entry type `/prefix` - Route table entry prefix `/nextHop` - Route table entry nextHop `/state` - Route table entry state `/MED` - Route table entry med `/*` - all-category search
operator	string Possible operators to use on filters: `=` - equal `!=` - not equal `>` - greater than `>=` - greater than or equal to `<` - less than `<=` - less than or equal to `[NOT] BETWEEN` - (not) between `[NOT] LIKE` - (not) like `[NOT] IN` - (not) in `~*` - case-insensitive like
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (RouteTableEntrySortCriteria)

Array

direction	string (RouteTableEntrySortDirection) Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string (RouteTableEntrySortBy) Default: "/changeLog/updatedDateTime" Enum: "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/prefix" "/nextHop" "/connection/name" "/type" "/MED" Possible field names to use on sorting

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (RouteTableEntry)

Data returned from the API call.

Array

type required	string (RouteTableEntryType) Enum: "IPv4_BGP_ROUTE" "IPv4_STATIC_ROUTE" "IPv4_DIRECT_ROUTE" "IPv6_BGP_ROUTE" "IPv6_STATIC_ROUTE" "IPv6_DIRECT_ROUTE" Route table entry type
protocolType	string (RouteTableEntryProtocolType) Enum: "BGP" "STATIC" "DIRECT" Route table entry protocol type
state required	string (RouteTableEntryState) Value: "ACTIVE" Route table entry state
prefix	string
nextHop	string
MED	integer
localPreference	integer
asPath	Array of strings
	object
required	object (Changelog) Change log

Request samples

Payload

Content type

application/json

Example

SearchFilterByNextHop

{"filter": {"and": [{"property": "/nextHop",
"operator": "=",
"values": ["10.10.10.5"
]
}
]
},
"pagination": {"offset": 0,
"limit": 20
},
"sort": [{"direction": "DESC",
"property": "/changeLog/createdDateTime"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 1
},
"data": [{"type": "IPv4_BGP_ROUTE",
"protocolType": "BGP",
"state": "ACTIVE",
"prefix": "192.168.10.0/24",
"nextHop": "10.10.10.5",
"asPath": ["20001"
],
"changeLog": {"createdBy": "johnsmith",
"createdByFullName": "John Smith",
"createdByEmail": "john.smith@example.com",
"createdDateTime": "2020-11-06T07:00:00Z",
"updatedBy": "johnsmith",
"updatedByFullName": "John Smith",
"updatedByEmail": "john.smith@example.com",
"updatedDateTime": "2020-11-06T07:00:00Z",
"deletedBy": "johnsmith",
"deletedByFullName": "John Smith",
"deletedByEmail": "john.smith@example.com",
"deletedDateTime": "2020-11-06T07:00:00Z"
}
}
]
}

Search Routers

The API provides capability to get list of user's Cloud Routers using search criteria, including optional filtering, pagination and sorting

Authorizations:

BearerAuth

Request Body schema: application/json
required

object (CloudRouterExpression)

and	Array of objects (CloudRouterExpressions)
or	Array of objects (CloudRouterExpressions)
property	string (SearchField) Possible field names to use on filters: `/project/projectId` - project id (mandatory) `/name` - Fabric Cloud Router name `/uuid` - Fabric Cloud Router uuid `/state` - Fabric Cloud Router status `/location/metroCode` - Fabric Cloud Router metro code `/location/metroName` - Fabric Cloud Router metro name `/package/code` - Fabric Cloud Router package `/type` - Fabric Cloud Router type `/connectionsCount` - Fabric Cloud Router attached connections count `/changeLog/createdDateTime` - Fabric Cloud Router creation timestamp `/changeLog/updatedDateTime` - Fabric Cloud Router last updated timestamp `/changeLog/deletedDateTime` - Fabric Cloud Router deletion timestamp `/*` - all-category search
operator	string Possible operators to use on filters: `=` - equal `!=` - not equal `>` - greater than `>=` - greater than or equal to `<` - less than `<=` - less than or equal to `[NOT] BETWEEN` - (not) between `[NOT] LIKE` - (not) like `[NOT] IN` - (not) in `ILIKE` - case-insensitive like
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (CloudRouterSortCriteria)

Array

direction	string (CloudRouterSortDirection) Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string (CloudRouterSortBy) Default: "/changeLog/updatedDateTime" Enum: "/name" "/uuid" "/state" "/location/metroCode" "/location/metroName" "/package/code" "/type" "/connectionsCount" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/changeLog/deletedDateTime" "/order/termLength" Possible field names to use on sorting

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (CloudRouterReadResponse)

Data returned from the API call.

Array

type	string Enum: "IC_ROUTER" "XF_ROUTER"
name	string Customer-provided Cloud Router name
	object (SimplifiedLocationWithoutIBX)
	object (CloudRouterPostRequestPackage) Fabric Cloud Router Package Type
	object (Order)
	object (Project)
	object (SimplifiedAccount)
	Array of objects (SimplifiedNotification) Preferences for notifications on connection configuration or status changes
href	string <uri> Cloud Routers URI
uuid	string <uuid> Equinix-assigned access point identifier
state	string (CloudRouterAccessPointState) Enum: "PROVISIONED" "PROVISIONING" "DEPROVISIONING" "DEPROVISIONED" "REPROVISIONING" "NOT_PROVISIONED" "NOT_DEPROVISIONED" Access point lifecycle state
equinixAsn	integer <int64> Equinix ASN
connectionsCount	integer >= 0 Number of connections associated with this Access point
	object (marketplaceSubscription) Equinix Fabric Entity for Marketplace Subscription
	object (Changelog) Change log
	object (CloudRouterChange) Current state of latest CloudRouter change

Request samples

Payload

Content type

application/json

Example

SearchFilterByStatus

{"filter": {"and": [{"property": "/state",
"operator": "=",
"values": ["PROVISIONED"
]
},
{"property": "/project/projectId",
"operator": "=",
"values": ["995072000433550"
]
}
]
},
"pagination": {"offset": 0,
"limit": 20
},
"sort": [{"direction": "DESC",
"property": "/changeLog/createdDateTime"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 20,
"limit": 20,
"total": 100,
"next": "/search?offset=40&limit=20",
"previous": "/search?offset=0&limit=20"
},
"data": [{"href": "https://api.equinix.com/fabric/v4/routers/201b7346-a9eb-42fe-ae7a-08148c71928d",
"uuid": "201b7346-a9eb-42fe-ae7a-08148c71928d",
"state": "PROVISIONED",
"type": "XF_ROUTER",
"name": "My-Cloud-Router",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/HH",
"metroCode": "HH"
},
"equinixAsn": 30000,
"package": {"href": "https://api.equinix.com/fabric/v4/routerPackages/STANDARD",
"code": "STANDARD"
},
"order": {"purchaseOrderNumber": "1-129105284100"
},
"project": {"projectId": "123456"
},
"notifications": [{"type": "ALL",
"emails": ["abc@abc.com"
]
}
],
"account": {"accountNumber": 123
},
"connectionsCount": 0,
"changeLog": {"createdBy": "abc@xyz.com",
"createdByFullName": "abc",
"createdByEmail": "abc@xyz.com",
"createdDateTime": "2021-09-24T06:59:46Z",
"updatedBy": "abc@xyz.com",
"updatedByFullName": "abc",
"updatedByEmail": "abc@xyz.com",
"updatedDateTime": "2021-09-24T06:59:46Z",
"deletedBy": "abc@xyz.com",
"deletedByFullName": "abc",
"deletedByEmail": "abc@xyz.com",
"deletedDateTime": "2021-09-24T06:59:46Z"
}
}
]
}

Cloud Router Packages

List Packages

This API provides capability to retrieve user's Cloud Routers Packages

Authorizations:

BearerAuth

query Parameters

offset	integer Example: offset=1 offset
limit	integer Example: limit=10 number of records to fetch

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (CloudRouterPackage)

Data returned from the API call.

Array

href	string <uri> Cloud Router package URI
type	string Value: "ROUTER_PACKAGE" Type of Router package
code	string (code) Enum: "LAB" "BASIC" "STANDARD" "ADVANCED" "PREMIUM" Cloud Router package code
description	string Fabric Cloud Router Package description
totalIPv4RoutesMax	integer >= 0 Cloud Router package BGP IPv4 routes limit
totalIPv6RoutesMax	integer >= 0 Cloud Router package BGP IPv6 routes limit
routeFilterSupported	boolean CloudRouter package route filter support
vcCountMax	integer >= 0 CloudRouter package Max Connection limit
crCountMax	integer >= 0 CloudRouter package Max CloudRouter limit
vcBandwidthMax	integer >= 0 CloudRouter package Max Bandwidth limit
	object (PackageChangeLog) Cloud Router package change log

Response samples

200
401
403
415
500

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 4
},
"data": [{"href": "https://api.equinix.com/fabric/v4/routerPackages/LAB",
"type": "ROUTER_PACKAGE",
"code": "LAB",
"description": "string",
"totalIPv4RoutesMax": 50,
"totalIPv6RoutesMax": 50,
"routeFilterSupported": true,
"vcCountMax": 10,
"crCountMax": 3,
"vcBandwidthMax": 50,
"changeLog": {"createdDateTime": "2022-02-10T00:14:47Z",
"updatedDateTime": "2022-02-10T00:14:47Z"
}
},
{"href": "https://api.equinix.com/fabric/v4/routerPackages/STANDARD",
"type": "ROUTER_PACKAGE",
"code": "STANDARD",
"description": "string",
"totalIPv4RoutesMax": 1000,
"totalIPv6RoutesMax": 100,
"routeFilterSupported": true,
"vcCountMax": 10,
"crCountMax": 3,
"vcBandwidthMax": 10000,
"changeLog": {"createdDateTime": "2023-02-10T00:14:47Z",
"updatedDateTime": "2023-02-10T00:14:47Z"
}
},
{"href": "https://api.equinix.com/fabric/v4/routerPackages/ADVANCED",
"type": "ROUTER_PACKAGE",
"code": "ADVANCED",
"description": "string",
"totalIPv4RoutesMax": 4000,
"totalIPv6RoutesMax": 250,
"routeFilterSupported": true,
"vcCountMax": 99999,
"crCountMax": 3,
"vcBandwidthMax": 50000,
"changeLog": {"createdDateTime": "2023-02-10T00:14:47Z",
"updatedDateTime": "2023-02-10T00:14:47Z"
}
},
{"href": "https://api.equinix.com/fabric/v4/routerPackages/PREMIUM",
"type": "ROUTER_PACKAGE",
"code": "PREMIUM",
"description": "string",
"totalIPv4RoutesMax": 10000,
"totalIPv6RoutesMax": 500,
"routeFilterSupported": true,
"vcCountMax": 10,
"crCountMax": 3,
"vcBandwidthMax": 50000,
"changeLog": {"createdDateTime": "2023-02-10T00:14:47Z",
"updatedDateTime": "2023-02-10T00:14:47Z"
}
}
]
}

Get Package Details

This API provides capability to retrieve user's Cloud Routers Package Details

Authorizations:

BearerAuth

path Parameters

routerPackageCode

required

string (RouterPackageCode)

Enum: "LAB" "BASIC" "STANDARD" "ADVANCED" "PREMIUM"

Equinix-assigned Cloud Router package identifier

Responses

Response Schema: application/json

href

string <uri>

Cloud Router package URI

type

string

Value: "ROUTER_PACKAGE"

Type of Router package

code

string (code)

Enum: "LAB" "BASIC" "STANDARD" "ADVANCED" "PREMIUM"

Cloud Router package code

description

string

Fabric Cloud Router Package description

totalIPv4RoutesMax

integer >= 0

Cloud Router package BGP IPv4 routes limit

totalIPv6RoutesMax

integer >= 0

Cloud Router package BGP IPv6 routes limit

routeFilterSupported

boolean

CloudRouter package route filter support

vcCountMax

integer >= 0

CloudRouter package Max Connection limit

crCountMax

integer >= 0

CloudRouter package Max CloudRouter limit

vcBandwidthMax

integer >= 0

CloudRouter package Max Bandwidth limit

object (PackageChangeLog)

Cloud Router package change log

createdDateTime	string <date-time>
updatedDateTime	string <date-time>

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/routerPackages/LAB",
"type": "ROUTER_PACKAGE",
"code": "LAB",
"description": "string",
"totalIPv4RoutesMax": 50,
"totalIPv6RoutesMax": 50,
"routeFilterSupported": true,
"vcCountMax": 10,
"crCountMax": 3,
"vcBandwidthMax": 50,
"changeLog": {"createdDateTime": "2020-11-06T07:00:00Z",
"updatedDateTime": "2020-11-06T07:00:00Z"
}
}

Routing Protocols

Get Routing Protocols

This API provides capability to get Routing Protocols for connections

Authorizations:

BearerAuth

path Parameters

connectionId

required

string

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

Connection Id

query Parameters

offset	integer Example: offset=1 offset
limit	integer Example: limit=10 number of records to fetch

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of RoutingProtocolBGPData (object) or RoutingProtocolDirectData (object) (RoutingProtocolData)

List of Routing Protocols

Array

One of

type	string Enum: "BGP" "DIRECT" Routing protocol type
name	string
	object (BGPConnectionIpv4)
	object (BGPConnectionIpv6)
customerAsn	integer <int64> Customer asn
equinixAsn	integer <int64> Equinix asn
bgpAuthKey	string BGP authorization key
asOverrideEnabled	boolean Enable AS number override
	object (RoutingProtocolBFD)
href	string <uri> Routing Protocol URI
uuid	string <uuid> Routing protocol identifier
state	string Enum: "PROVISIONED" "DEPROVISIONED" "PROVISIONING" "DEPROVISIONING" "REPROVISIONING" "FAILED"
	object (RoutingProtocolOperation)
	object (RoutingProtocolChange) Current state of latest Routing Protocol change
	object (Changelog) Change log
	object (RoutingProtocolProject) The Routing Protocol's project
	object (RoutingProtocolConnection) Connection specification

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 2
},
"data": [{"href": "https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4",
"uuid": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
"state": "PROVISIONING",
"change": {"uuid": "3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
"href": "https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
"type": "ROUTING_PROTOCOL_CREATION"
},
"changelog": {"createdBy": "fabric",
"createdDateTime": "2021-10-30T07:21:39Z",
"updatedBy": "fabric",
"updatedDateTime": "2021-10-30T07:21:39Z"
},
"type": "BGP",
"bgpIpv4": {"customerPeerIp": "192.168.100.2",
"enabled": true,
"outboundASPrependCount": 3,
"inboundMED": 1000,
"outboundMED": 2000,
"routesMax": 40,
"operation": {"operationalStatus": "UNKNOWN"
}
},
"customerAsn": 10000,
"equinixAsn": 10001,
"asOverrideEnabled": true
},
{"href": "https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4",
"uuid": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
"state": "PROVISIONING",
"change": {"uuid": "3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
"href": "https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
"type": "ROUTING_PROTOCOL_CREATION"
},
"changelog": {"createdBy": "fabric",
"createdDateTime": "2021-10-30T07:21:39Z",
"updatedBy": "fabric",
"updatedDateTime": "2021-10-30T07:21:39Z"
},
"type": "DIRECT",
"directIpv4": {"equinixIfaceIp": "192.168.100.1/30"
}
}
]
}

Create Routing Protocol

This API provides capability to create Routing Protocol for connections

Authorizations:

BearerAuth

path Parameters

connectionId

required

string

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

Connection Id

Request Body schema: application/json
required

One of

type

required

string

Enum: "BGP" "DIRECT"

Routing protocol type

name

string

object (BGPConnectionIpv4)

customerPeerIp

required

string

Customer side peering ip

equinixPeerIp

string

Equinix side peering ip

enabled

required

boolean

Admin status for the BGP session

outboundASPrependCount

integer <int64>

AS path prepend count

inboundMED

integer <int64>

Inbound Multi Exit Discriminator attribute

outboundMED

integer <int64>

Outbound Multi Exit Discriminator attribute

routesMax

integer <int64>

Maximum learnt prefixes limit

object (BGPConnectionOperation)

BGP IPv4 or IPv6 Connection State operational data

operationalStatus	string Enum: "UP" "DOWN" "UNKNOWN" BGP IPv4 or IPv6 Connection State operational status
opStatusChangedAt	string <date-time> Last BGP State Update by Date and Time

object (BGPConnectionIpv6)

customerPeerIp

required

string

Customer side peering ip

equinixPeerIp

string

Equinix side peering ip

enabled

required

boolean

Admin status for the BGP session

outboundASPrependCount

integer <int64>

AS path prepend count

inboundMED

integer <int64>

Inbound Multi Exit Discriminator attribute

outboundMED

integer <int64>

Outbound Multi Exit Discriminator attribute

routesMax

integer <int64>

Maximum learnt prefixes limit

object (BGPConnectionOperation)

BGP IPv4 or IPv6 Connection State operational data

operationalStatus	string Enum: "UP" "DOWN" "UNKNOWN" BGP IPv4 or IPv6 Connection State operational status
opStatusChangedAt	string <date-time> Last BGP State Update by Date and Time

customerAsn

integer <int64>

Customer asn

bgpAuthKey

string

BGP authorization key

asOverrideEnabled

boolean

Enable AS number override

object (RoutingProtocolBFD)

enabled required	boolean
interval	string

Responses

Request samples

Payload

Content type

application/json

Example

Fcr2ColoDirectRoutingOnly

{"type": "DIRECT",
"directIpv4": {"equinixIfaceIp": "192.168.100.1/30"
},
"directIpv6": {"equinixIfaceIp": "2001:7a9::34f4:0:f3dd:1/126"
}
}

Response samples

Content type

application/json

Example

bgpCreateResponse

{"href": "https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4",
"uuid": "557400f8-d360-11e9-bb65-2a2ae2dbcce4",
"state": "PROVISIONING",
"change": {"href": "https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
"uuid": "3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
"type": "ROUTING_PROTOCOL_CREATION"
},
"changelog": {"createdBy": "fabric",
"createdDateTime": "2021-10-30T07:21:39Z",
"updatedBy": "fabric",
"updatedDateTime": "2021-10-30T07:21:39Z"
},
"type": "BGP",
"bgpIpv4": {"customerPeerIp": "10.1.1.3",
"enabled": true,
"outboundASPrependCount": 3,
"inboundMED": 1000,
"outboundMED": 2000,
"routesMax": 40,
"operation": {"operationalStatus": "UNKNOWN"
}
},
"customerAsn": 10000,
"equinixAsn": 10001,
"asOverrideEnabled": true
}

Bulk Create Routing Protocols

This API provides capability to create Routing Protocol for connections

Authorizations:

BearerAuth

path Parameters

connectionId

required

string

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

Connection Id

Request Body schema: application/json
required

Array of RoutingProtocolBGPType (object) or RoutingProtocolDirectType (object) (RoutingProtocolBase)

Connection routing protocol configuration

Array

One of

type required	string Enum: "BGP" "DIRECT" Routing protocol type
name	string
	object (BGPConnectionIpv4)
	object (BGPConnectionIpv6)
customerAsn	integer <int64> Customer asn
bgpAuthKey	string BGP authorization key
asOverrideEnabled	boolean Enable AS number override
	object (RoutingProtocolBFD)

Responses

Request samples

Payload

Content type

application/json

Example

DirectRoutingOnly

{"data": [{"type": "DIRECT",
"directIpv4": {"equinixIfaceIp": "192.168.100.1/30"
},
"directIpv6": {"equinixIfaceIp": "2001:7a9::34f4:0:f3dd:1/126"
}
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 2
},
"data": [{"href": "https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4",
"uuid": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
"state": "PROVISIONING",
"change": {"uuid": "3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
"href": "https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
"type": "ROUTING_PROTOCOL_CREATION"
},
"changelog": {"createdBy": "fabric",
"createdDateTime": "2021-10-30T07:21:39Z",
"updatedBy": "fabric",
"updatedDateTime": "2021-10-30T07:21:39Z"
},
"type": "BGP",
"bgpIpv4": {"customerPeerIp": "192.168.100.2",
"enabled": true,
"outboundASPrependCount": 3,
"inboundMED": 1000,
"outboundMED": 2000,
"routesMax": 40,
"operation": {"operationalStatus": "UNKNOWN"
}
},
"customerAsn": 10000,
"equinixAsn": 10001,
"asOverrideEnabled": true
},
{"href": "https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4",
"uuid": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
"state": "PROVISIONING",
"change": {"uuid": "3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
"href": "https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
"type": "ROUTING_PROTOCOL_CREATION"
},
"changelog": {"createdBy": "fabric",
"createdDateTime": "2021-10-30T07:21:39Z",
"updatedBy": "fabric",
"updatedDateTime": "2021-10-30T07:21:39Z"
},
"type": "DIRECT",
"directIpv4": {"equinixIfaceIp": "192.168.100.1/30"
}
}
]
}

Get Protocol

This API provides capability to accept/reject user's virtual connection

Authorizations:

BearerAuth

path Parameters

routingProtocolId required	string <uuid> Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Routing Protocol Id
connectionId required	string Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Connection Id

Responses

Response Schema: application/json

One of

type

string

Enum: "BGP" "DIRECT"

Routing protocol type

name

string

object (BGPConnectionIpv4)

customerPeerIp

required

string

Customer side peering ip

equinixPeerIp

string

Equinix side peering ip

enabled

required

boolean

Admin status for the BGP session

outboundASPrependCount

integer <int64>

AS path prepend count

inboundMED

integer <int64>

Inbound Multi Exit Discriminator attribute

outboundMED

integer <int64>

Outbound Multi Exit Discriminator attribute

routesMax

integer <int64>

Maximum learnt prefixes limit

object (BGPConnectionOperation)

BGP IPv4 or IPv6 Connection State operational data

operationalStatus	string Enum: "UP" "DOWN" "UNKNOWN" BGP IPv4 or IPv6 Connection State operational status
opStatusChangedAt	string <date-time> Last BGP State Update by Date and Time

object (BGPConnectionIpv6)

customerPeerIp

required

string

Customer side peering ip

equinixPeerIp

string

Equinix side peering ip

enabled

required

boolean

Admin status for the BGP session

outboundASPrependCount

integer <int64>

AS path prepend count

inboundMED

integer <int64>

Inbound Multi Exit Discriminator attribute

outboundMED

integer <int64>

Outbound Multi Exit Discriminator attribute

routesMax

integer <int64>

Maximum learnt prefixes limit

object (BGPConnectionOperation)

BGP IPv4 or IPv6 Connection State operational data

operationalStatus	string Enum: "UP" "DOWN" "UNKNOWN" BGP IPv4 or IPv6 Connection State operational status
opStatusChangedAt	string <date-time> Last BGP State Update by Date and Time

customerAsn

integer <int64>

Customer asn

equinixAsn

integer <int64>

Equinix asn

bgpAuthKey

string

BGP authorization key

asOverrideEnabled

boolean

Enable AS number override

object (RoutingProtocolBFD)

enabled required	boolean
interval	string

href

string <uri>

Routing Protocol URI

uuid

string <uuid>

Routing protocol identifier

state

string

Enum: "PROVISIONED" "DEPROVISIONED" "PROVISIONING" "DEPROVISIONING" "REPROVISIONING" "FAILED"

object (RoutingProtocolOperation)

Array of objects (Error)

Array

errorCode required	string^EQ-\d{7}$
errorMessage required	string
correlationId	string
details	string
help	string
	Array of objects

object (RoutingProtocolChange)

Current state of latest Routing Protocol change

uuid required	string Uniquely identifies a change
type required	string Enum: "ROUTING_PROTOCOL_UPDATE" "ROUTING_PROTOCOL_CREATION" "ROUTING_PROTOCOL_DELETION" Type of change
href	string <uri> Routing Protocol Change URI

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

object (RoutingProtocolProject)

The Routing Protocol's project

projectId

required

string

Uniquely identifies a project

object (RoutingProtocolConnection)

Connection specification

uuid	string Equinix-assigned connection identifier
platformUuid	string Equinix-assigned platform connection identifier

Response samples

Content type

application/json

Example

bgpCreateResponse

{"href": "https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4",
"uuid": "557400f8-d360-11e9-bb65-2a2ae2dbcce4",
"state": "PROVISIONING",
"change": {"href": "https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
"uuid": "3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
"type": "ROUTING_PROTOCOL_CREATION"
},
"changelog": {"createdBy": "fabric",
"createdDateTime": "2021-10-30T07:21:39Z",
"updatedBy": "fabric",
"updatedDateTime": "2021-10-30T07:21:39Z"
},
"type": "BGP",
"bgpIpv4": {"customerPeerIp": "10.1.1.3",
"enabled": true,
"outboundASPrependCount": 3,
"inboundMED": 1000,
"outboundMED": 2000,
"routesMax": 40,
"operation": {"operationalStatus": "UNKNOWN"
}
},
"customerAsn": 10000,
"equinixAsn": 10001,
"asOverrideEnabled": true
}

Delete Protocol

This API provides capability to delete Routing Protocols on virtual connection

Authorizations:

BearerAuth

path Parameters

routingProtocolId required	string <uuid> Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Routing Protocol Id
connectionId required	string Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Connection Id

Responses

Response samples

Content type

application/json

Example

directDeleteResponse

{"href": "https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4",
"uuid": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
"state": "DEPROVISIONING",
"change": {"uuid": "3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
"href": "https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
"type": "ROUTING_PROTOCOL_DELETION"
},
"changelog": {"createdBy": "fabric",
"createdDateTime": "2021-10-30T07:21:39Z",
"updatedBy": "fabric",
"updatedDateTime": "2021-10-30T07:21:39Z",
"deletedBy": "fabric",
"deletedDateTime": "2021-10-30T07:21:39Z"
},
"type": "DIRECT",
"directIpv4": {"equinixIfaceIp": "192.168.100.1/30"
}
}

Replace Protocol

This API provides capability to replace complete Routing Protocols on a virtual connection

Authorizations:

BearerAuth

path Parameters

routingProtocolId required	string <uuid> Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Routing Protocol Id
connectionId required	string Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Connection Id

Request Body schema: application/json
required

One of

type

required

string

Enum: "BGP" "DIRECT"

Routing protocol type

name

string

object (BGPConnectionIpv4)

customerPeerIp

required

string

Customer side peering ip

equinixPeerIp

string

Equinix side peering ip

enabled

required

boolean

Admin status for the BGP session

outboundASPrependCount

integer <int64>

AS path prepend count

inboundMED

integer <int64>

Inbound Multi Exit Discriminator attribute

outboundMED

integer <int64>

Outbound Multi Exit Discriminator attribute

routesMax

integer <int64>

Maximum learnt prefixes limit

object (BGPConnectionOperation)

BGP IPv4 or IPv6 Connection State operational data

operationalStatus	string Enum: "UP" "DOWN" "UNKNOWN" BGP IPv4 or IPv6 Connection State operational status
opStatusChangedAt	string <date-time> Last BGP State Update by Date and Time

object (BGPConnectionIpv6)

customerPeerIp

required

string

Customer side peering ip

equinixPeerIp

string

Equinix side peering ip

enabled

required

boolean

Admin status for the BGP session

outboundASPrependCount

integer <int64>

AS path prepend count

inboundMED

integer <int64>

Inbound Multi Exit Discriminator attribute

outboundMED

integer <int64>

Outbound Multi Exit Discriminator attribute

routesMax

integer <int64>

Maximum learnt prefixes limit

object (BGPConnectionOperation)

BGP IPv4 or IPv6 Connection State operational data

operationalStatus	string Enum: "UP" "DOWN" "UNKNOWN" BGP IPv4 or IPv6 Connection State operational status
opStatusChangedAt	string <date-time> Last BGP State Update by Date and Time

customerAsn

integer <int64>

Customer asn

bgpAuthKey

string

BGP authorization key

asOverrideEnabled

boolean

Enable AS number override

object (RoutingProtocolBFD)

enabled required	boolean
interval	string

Responses

Request samples

Payload

Content type

application/json

Example

DirectRoutingReplaceExample

{"type": "DIRECT",
"directIpv4": {"equinixIfaceIp": "192.168.100.1/30"
},
"directIpv6": {"equinixIfaceIp": "2001:7a9::34f4:0:f3dd:1/126"
}
}

Response samples

Content type

application/json

Example

bgpReplaceResponse

{"href": "https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4",
"uuid": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
"state": "REPROVISIONING",
"change": {"uuid": "3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
"href": "https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
"type": "ROUTING_PROTOCOL_UPDATE"
},
"changelog": {"createdBy": "fabric",
"createdDateTime": "2021-10-30T07:21:39Z",
"updatedBy": "fabric",
"updatedDateTime": "2021-10-30T07:21:39Z"
},
"type": "BGP",
"bgpIpv4": {"customerPeerIp": "10.1.1.3",
"enabled": true,
"outboundASPrependCount": 3,
"inboundMED": 1000,
"outboundMED": 2000,
"routesMax": 40,
"operation": {"operationalStatus": "UNKNOWN"
}
},
"customerAsn": 10000,
"equinixAsn": 10001,
"asOverrideEnabled": true
}

Patch Protocol

This API provides capability to partially update Routing Protocols on a virtual connection

Authorizations:

BearerAuth

path Parameters

routingProtocolId required	string <uuid> Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Routing Protocol Id
connectionId required	string Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Connection Id

Request Body schema:
application/json
required

Array (non-empty)

op required	string Handy shortcut for operation name
path required	string path inside document leading to updated parameter
value required	any new value for updated parameter

Responses

Request samples

Payload

Content type

application/json

Example

EnableIPv4PatchExample

[{"op": "replace",
"path": "/bgpIpv4/enabled",
"value": true
}
]

Response samples

Content type

application/json

Example

EnableBGPResponse

{"href": "https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4",
"uuid": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
"state": "REPROVISIONING",
"change": {"uuid": "3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
"href": "https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
"type": "ROUTING_PROTOCOL_UPDATE"
},
"changelog": {"createdBy": "fabric",
"createdDateTime": "2021-10-30T07:21:39Z",
"updatedBy": "fabric",
"updatedDateTime": "2021-10-30T07:21:39Z"
},
"type": "BGP",
"bgpIpv4": {"enabled": true,
"customerPeerIp": "10.1.1.3",
"outboundASPrependCount": 3,
"operation": {"operationalStatus": "UNKNOWN"
}
},
"customerAsn": 10000,
"equinixAsn": 10001
}

Clear/Reset BGP

This API provides capability to clear/reset Routing Protocols BGP session

Authorizations:

BearerAuth

path Parameters

routingProtocolId required	string <uuid> Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Routing Protocol Id
connectionId required	string Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Connection Id

Request Body schema: application/json
required

type

required

string (BGPActions)

Enum: "CLEAR_BGPIPV4" "CLEAR_BGPIPV6" "CLEAR_BGPIPV4_INBOUND" "CLEAR_BGPIPV6_INBOUND" "RESET_BGPIPV4" "RESET_BGPIPV6"

BGP action type

Responses

Request samples

Payload

Content type

application/json

Example

BGPSoftClearInAndOutBoundIPv4

{"type": "CLEAR_BGPIPV4"
}

Response samples

Content type

application/json

Example

BGPActionHardResetIpV4

{"href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/3f5ed98a-8dba-4651-a317-8ad0234dd157/actions/123ed98a-92ba-9951-bb17-17d0234dd096",
"uuid": "123ed98a-92ba-9951-bb17-17d0234dd096",
"type": "RESET_BGPIPV4",
"description": "hard reset bgp ipv4 session",
"state": "PENDING",
"changelog": {"createdBy": "adminuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
}

Get BGP Actions

This API provides capability to get all BGP actions status

Authorizations:

BearerAuth

path Parameters

routingProtocolId required	string <uuid> Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Routing Protocol Id
connectionId required	string Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Connection Id

query Parameters

offset	integer Example: offset=1 offset
limit	integer Example: limit=10 number of records to fetch

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (BGPActionData)

Array

href	string <uri> Routing Protocol URI
uuid	string <uuid> Routing protocol identifier
type	string (BGPActions) Enum: "CLEAR_BGPIPV4" "CLEAR_BGPIPV6" "CLEAR_BGPIPV4_INBOUND" "CLEAR_BGPIPV6_INBOUND" "RESET_BGPIPV4" "RESET_BGPIPV6" BGP action type
description	string BGP action description
state	string (BGPActionStates) Enum: "PENDING" "FAILED" "SUCCEEDED" BGP action state
	object (Changelog) Change log

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 2
},
"data": [{"href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/3f5ed98a-8dba-4651-a317-8ad0234dd157/actions/835ed234-1dbb-5634-c320-25d0234dd117",
"uuid": "835ed234-1dbb-5634-c320-25d0234dd117",
"type": "CLEAR_BGPIPV6_INBOUND",
"description": "soft clear bgp ipv6 inbound session",
"state": "SUCCEEDED",
"changelog": {"createdBy": "testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "testuser",
"updatedDateTime": "2020-05-21T10:35:00Z"
}
},
{"href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/4d5ed98a-8dba-4651-a317-8ad0234dd157/actions/995ed98b-1db9-6653-c323-19d0234dd999",
"uuid": "995ed98b-1db9-6653-c323-19d0234dd999",
"type": "CLEAR_BGPIPV4_INBOUND",
"description": "soft clear bgp ipv4 inbound session",
"state": "FAILED",
"changelog": {"createdBy": "testuser",
"createdDateTime": "2020-05-21T10:20:00Z",
"updatedBy": "testuser",
"updatedDateTime": "2020-05-21T10:25:00Z"
}
}
]
}

Get BGP Action

This API provides capability to retrieve specific BGP action

Authorizations:

BearerAuth

path Parameters

connectionId required	string Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Connection Id
routingProtocolId required	string <uuid> Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Routing Protocol Id
actionId required	string <uuid> Example: 86534014-34b4-53f6-45d6-4b94a92d8623 BGP Action UUID

Responses

Response Schema: application/json

href

string <uri>

Routing Protocol URI

uuid

string <uuid>

Routing protocol identifier

type

string (BGPActions)

Enum: "CLEAR_BGPIPV4" "CLEAR_BGPIPV6" "CLEAR_BGPIPV4_INBOUND" "CLEAR_BGPIPV6_INBOUND" "RESET_BGPIPV4" "RESET_BGPIPV6"

BGP action type

description

string

BGP action description

state

string (BGPActionStates)

Enum: "PENDING" "FAILED" "SUCCEEDED"

BGP action state

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/3f5ed98a-8dba-4651-a317-8ad0234dd157/actions/4e5ed00a-3dca-5652-b319-aad0234dd934",
"uuid": "4e5ed00a-3dca-5652-b319-aad0234dd934",
"type": "CLEAR_BGPIPV6_INBOUND",
"description": "soft clear bgp ipv6 inbound session",
"state": "SUCCEEDED",
"changelog": {"createdBy": "adminuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "adminuser",
"updatedDateTime": "2020-05-21T10:35:00Z"
}
}

Get Change By ID

This API provides capability to retrieve specific Routing Protocol Change

Authorizations:

BearerAuth

path Parameters

connectionId required	string Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Connection Id
routingProtocolId required	string <uuid> Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Routing Protocol Id
changeId required	string <uuid> Example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 Routing Protocol Change UUID

Responses

Response Schema: application/json

status

string

Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdBy

string

Created by User Key

createdDateTime

string <date-time>

Set when change flow starts

updatedBy

string

Updated by User Key

updatedDateTime

string <date-time>

Set when change object is updated

information

string

Additional information

object (RoutingProtocolChangeOperation)

Routing Protocol change operation data

op

required

string

Enum: "add" "replace" "remove"

Handy shortcut for operation name

path

required

string

path inside document leading to updated parameter

required

RoutingProtocolBGPType (object) or RoutingProtocolDirectType (object) (RoutingProtocolBase)

One of

type required	string Enum: "BGP" "DIRECT" Routing protocol type
name	string
	object (BGPConnectionIpv4)
	object (BGPConnectionIpv6)
customerAsn	integer <int64> Customer asn
bgpAuthKey	string BGP authorization key
asOverrideEnabled	boolean Enable AS number override
	object (RoutingProtocolBFD)

uuid

required

string

Uniquely identifies a change

type

required

string

Enum: "ROUTING_PROTOCOL_UPDATE" "ROUTING_PROTOCOL_CREATION" "ROUTING_PROTOCOL_DELETION"

Type of change

href

string <uri>

Routing Protocol Change URI

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/connections/2a4fb415-5a7f-436f-bae6-02f5e403deec/routingProtocols/2a4fb415-5a7f-436f-bae6-02f5e403deec/changes/4b17da68-3d6b-436d-9c8f-2105f3b950d9",
"type": "ROUTING_PROTOCOL_UPDATE",
"uuid": "4b17da68-3d6b-436d-9c8f-2105f3b950d9",
"status": "COMPLETED",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedDateTime": "2020-05-21T10:30:50Z",
"data": {"op": "replace",
"path": "/",
"value": {"type": "BGP",
"name": "My-BGP-route-1",
"bgpIpv4": {"enabled": true,
"customerPeerIp": "10.1.1.2",
"equinixPeerIp": "10.1.1.3",
"outboundASPrependCount": 3,
"inboundMED": 1000,
"outboundMED": 2000,
"routesMax": 40,
"operation": {"operationalStatus": "UP",
"opStatusChangedAt": "2021-10-30T07:21:39Z"
}
},
"bgpIpv6": {"enabled": true,
"customerPeerIp": "2001:db8:c59b::1",
"equinixPeerIp": "2001:db8:c59b::1",
"outboundASPrependCount": 3,
"inboundMED": 1000,
"outboundMED": 2000,
"routesMax": 40,
"operation": {"operationalStatus": "UP",
"opStatusChangedAt": "2021-10-30T07:21:39Z"
}
},
"customerAsn": 0,
"asOverrideEnabled": true,
"bgpAuthKey": "string",
"bfd": {"enabled": true,
"interval": "100"
}
}
}
}

Get Routing Protocol Changes

This API provides capability to retrieve user's Routing Protocol Changes

Authorizations:

BearerAuth

path Parameters

connectionId required	string Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Connection Id
routingProtocolId required	string <uuid> Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Routing Protocol Id

query Parameters

offset	integer Example: offset=1 offset
limit	integer Example: limit=10 number of records to fetch

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (RoutingProtocolChangeData)

Array

status	string Enum: "COMPLETED" "FAILED" "REQUESTED" Current outcome of the change flow
createdBy	string Created by User Key
createdDateTime	string <date-time> Set when change flow starts
updatedBy	string Updated by User Key
updatedDateTime	string <date-time> Set when change object is updated
information	string Additional information
	object (RoutingProtocolChangeOperation) Routing Protocol change operation data
uuid required	string Uniquely identifies a change
type required	string Enum: "ROUTING_PROTOCOL_UPDATE" "ROUTING_PROTOCOL_CREATION" "ROUTING_PROTOCOL_DELETION" Type of change
href	string <uri> Routing Protocol Change URI

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 1
},
"data": [{"href": "https://api.equinix.com/fabric/v4/connections/2a4fb415-5a7f-436f-bae6-02f5e403deec/routingProtocols/2a4fb415-5a7f-436f-bae6-02f5e403deec/changes/4b17da68-3d6b-436d-9c8f-2105f3b950d9",
"type": "ROUTING_PROTOCOL_UPDATE",
"uuid": "4b17da68-3d6b-436d-9c8f-2105f3b950d9",
"status": "COMPLETED",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedDateTime": "2020-05-21T10:30:50Z",
"data": {"op": "replace",
"path": "/",
"value": {"type": "BGP",
"name": "My-BGP-route-1",
"bgpIpv4": {"enabled": true,
"customerPeerIp": "10.1.1.2",
"equinixPeerIp": "10.1.1.3",
"outboundASPrependCount": 3,
"inboundMED": 1000,
"outboundMED": 2000,
"routesMax": 40,
"operation": {"operationalStatus": "UP",
"opStatusChangedAt": "2021-10-30T07:21:39Z"
}
},
"bgpIpv6": {"enabled": true,
"customerPeerIp": "2001:db8:c59b::1",
"equinixPeerIp": "2001:db8:c59b::1",
"outboundASPrependCount": 3,
"inboundMED": 1000,
"outboundMED": 2000,
"routesMax": 40,
"operation": {"operationalStatus": "UP",
"opStatusChangedAt": "2021-10-30T07:21:39Z"
}
},
"customerAsn": 0,
"bgpAuthKey": "string",
"asOverrideEnabled": true,
"bfd": {"enabled": true,
"interval": "100"
}
}
}
},
{"href": "https://api.equinix.com/fabric/v4/connections/2a4fb415-5a7f-436f-bae6-02f5e403deec/routingProtocols/2a4fb415-5a7f-436f-bae6-02f5e403deec/changes/4b17da68-3d6b-436d-9c8f-2105f3b950d9",
"type": "ROUTING_PROTOCOL_CREATION",
"uuid": "4b17da68-3d6b-436d-9c8f-2105f3b950d9",
"status": "COMPLETED",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedDateTime": "2020-05-21T10:30:50Z",
"data": {"op": "add",
"path": "/",
"value": {"type": "BGP",
"name": "My-BGP-route-1",
"bgpIpv4": {"enabled": true,
"customerPeerIp": "10.1.1.3",
"equinixPeerIp": "10.1.1.4",
"operation": {"operationalStatus": "UP",
"opStatusChangedAt": "2021-10-30T07:21:39Z"
}
},
"bgpIpv6": {"enabled": true,
"customerPeerIp": "2001:db8:c59b::1",
"equinixPeerIp": "2001:db8:c59b::1",
"operation": {"operationalStatus": "UP",
"opStatusChangedAt": "2021-10-30T07:21:39Z"
}
},
"customerAsn": 0,
"bgpAuthKey": "string",
"bfd": {"enabled": true,
"interval": "100"
}
}
}
}
]
}

Validate Subnet

This API provides capability to validate all subnets associated with any connection in the given FCR

Authorizations:

BearerAuth

path Parameters

routerId

required

string <uuid>

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

Cloud Router UUID

Request Body schema: application/json
required

object

Filters

Array of objects

Array

property	string Path to property
operator	string Type of operation
values	Array of strings Values for the given property

Responses

Response Schema: application/json

Array of objects (ConnectionSideAdditionalInfo)

Additional information

Array

key	string Key
value	string Value

Request samples

Payload

Content type

application/json

Example

ValidateDirectIpv4

{"filter": {"and": [{"property": "/directIpv4/equinixIfaceIp",
"operator": "=",
"values": ["10.1.1.1/30"
]
},
{"property": "/connection/uuid",
"operator": "=",
"values": ["a96f16d3-e504-44a7-a628-4916b5750008"
]
}
]
}
}

Response samples

200
400

Content type

application/json

{"additionalInfo": [{"key": "message",
"value": "The provided subnet is valid."
}
]
}

Route Filters

Get Connection Route Filters

This API provides capability to view all Route Filters attached to a Connection

Authorizations:

BearerAuth

path Parameters

connectionId

required

string

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

Connection Id

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (ConnectionRouteFilterData)

List of Route Filters attached to a Connection

Array

href	string <uri> Route filter URI
type	string Enum: "BGP_IPv4_PREFIX_FILTER" "BGP_IPv6_PREFIX_FILTER" Route filter type
uuid	string <uuid> Route Filter identifier
attachmentStatus	string Enum: "ATTACHING" "ATTACHED" "DETACHED" "DETACHING" "FAILED" "PENDING_BGP_CONFIGURATION"
direction	string Enum: "INBOUND" "OUTBOUND"
	object (Changelog) Change log

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 4
},
"data": [{"href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"type": "BGP_IPv4_PREFIX_FILTER",
"uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"attachmentStatus": "DETACHING",
"direction": "INBOUND"
},
{"href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeFilters/52f7791a-fe90-49bc-8807-18b3d6eda566",
"type": "BGP_IPv6_PREFIX_FILTER",
"uuid": "52f7791a-fe90-49bc-8807-18b3d6eda566",
"attachmentStatus": "ATTACHED",
"direction": "INBOUND"
},
{"href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeFilters/8b67bf1c-7afa-4a9e-98c3-d5ab17da6652",
"type": "BGP_IPv4_PREFIX_FILTER",
"uuid": "8b67bf1c-7afa-4a9e-98c3-d5ab17da6652",
"attachmentStatus": "ATTACHED",
"direction": "OUTBOUND"
},
{"href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeFilters/65d74639-8f48-4e10-9684-45d364645e97",
"type": "BGP_IPv6_PREFIX_FILTER",
"uuid": "65d74639-8f48-4e10-9684-45d364645e97",
"attachmentStatus": "ATTACHED",
"direction": "OUTBOUND"
}
]
}

Get Route Filter

This API provides capability to view a specific Route Filter attached to a Connection

Authorizations:

BearerAuth

path Parameters

routeFilterId required	string Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Filters Id
connectionId required	string Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Connection Id

Responses

Response Schema: application/json

href

string <uri>

Route filter URI

type

string

Enum: "BGP_IPv4_PREFIX_FILTER" "BGP_IPv6_PREFIX_FILTER"

Route filter type

uuid

string <uuid>

Route Filter identifier

attachmentStatus

string

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

direction

string

Enum: "INBOUND" "OUTBOUND"

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"type": "BGP_IPv4_PREFIX_FILTER",
"uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"attachmentStatus": "ATTACHING",
"direction": "INBOUND"
}

Attach Route Filter

This API provides capability to attach a Route Filter to a Connection

Authorizations:

BearerAuth

path Parameters

routeFilterId required	string Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Filters Id
connectionId required	string Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Connection Id

Request Body schema: application/json
required

direction

required

string

Enum: "INBOUND" "OUTBOUND"

Route Filter direction to attach to a connection

Responses

Request samples

Payload

Content type

application/json

Example

ConnectionRouteFilterAttachInboundExample

{"direction": "INBOUND"
}

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"type": "BGP_IPv4_PREFIX_FILTER",
"uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"attachmentStatus": "ATTACHING",
"direction": "INBOUND"
}

Detach Route Filter

This API provides capability to detach a Route Filter from a Connection

Authorizations:

BearerAuth

path Parameters

routeFilterId required	string Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Filters Id
connectionId required	string Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Connection Id

Responses

Response samples

Content type

application/json

Example

ConnectionRouteFilterDetachInboundResponse

{"href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"type": "BGP_IPv4_PREFIX_FILTER",
"uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"attachmentStatus": "DETACHING",
"direction": "INBOUND"
}

Create Route Filter

This API provides capability to create a Route Filter

Authorizations:

BearerAuth

Request Body schema: application/json
required

type

required

string

Enum: "BGP_IPv4_PREFIX_FILTER" "BGP_IPv6_PREFIX_FILTER"

Route Filter type

name

required

string

description

string

Customer-provided connection description

required

object (Project)

projectId

required

string

Subscriber-assigned project ID

Responses

Request samples

Payload

Content type

application/json

Example

RouteFilterBgpIpv4Prefix

{"type": "BGP_IPv4_PREFIX_FILTER",
"name": "My-route-filter-v4",
"description": "Test filter",
"project": {"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}
}

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"type": "BGP_IPv4_PREFIX_FILTER",
"uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"name": "My-prefix-filter-v4",
"description": "Test filter",
"state": "PROVISIONING",
"change": {"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3",
"type": "BGP_IPv4_PREFIX_FILTER_CREATION",
"uuid": "04af0d37-9160-43d8-97ef-9da9786996a3"
},
"notMatchedRuleAction": "DENY",
"connectionsCount": 0,
"project": {"href": "https://api.equinix.com/resourceManager/v1/projects/567",
"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
},
"changelog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
}

Get Route Filter by ID

This API provides capability to view a Route Filter by UUID

Authorizations:

BearerAuth

path Parameters

routeFilterId

required

string

Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

Responses

Response Schema: application/json

href

string <uri>

Route filter URI

type

string

Enum: "BGP_IPv4_PREFIX_FILTER" "BGP_IPv6_PREFIX_FILTER"

Route Filter type

uuid

string <uuid>

Route filter identifier

name

string

description

string

Customer-provided connection description

object (RouteFiltersChange)

Current state of latest route filter change

uuid required	string Uniquely identifies a change
type required	string Enum: "BGP_IPv4_PREFIX_FILTER_UPDATE" "BGP_IPv4_PREFIX_FILTER_CREATION" "BGP_IPv4_PREFIX_FILTER_DELETION" "BGP_IPv6_PREFIX_FILTER_UPDATE" "BGP_IPv6_PREFIX_FILTER_CREATION" "BGP_IPv6_PREFIX_FILTER_DELETION" Type of change
href	string <uri> Route filter change URI

notMatchedRuleAction

string

Enum: "ALLOW" "DENY"

connectionsCount

integer

rulesCount

integer

object

projectId required	string Subscriber-assigned project ID
href	string <uri> Project URI

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"type": "BGP_IPv4_PREFIX_FILTER",
"uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"name": "My-prefix-filter-v4",
"description": "Test filter",
"state": "PROVISIONING",
"change": {"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3",
"type": "BGP_IPv4_PREFIX_FILTER_CREATION",
"uuid": "04af0d37-9160-43d8-97ef-9da9786996a3"
},
"notMatchedRuleAction": "DENY",
"connectionsCount": 0,
"project": {"href": "https://api.equinix.com/resourceManager/v1/projects/567",
"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
},
"changelog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
}

Delete Route Filter

This API provides capability to delete a Route Filter

Authorizations:

BearerAuth

path Parameters

routeFilterId

required

string

Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

Responses

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"type": "BGP_IPv4_PREFIX_FILTER",
"uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"name": "My-prefix-filter-v4",
"description": "Test filter",
"state": "DEPROVISIONING",
"change": {"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/c2ec84c5-6de6-4f5c-b506-3ce218630c31",
"type": "BGP_IPv4_PREFIX_FILTER_DELETION",
"uuid": "c2ec84c5-6de6-4f5c-b506-3ce218630c31"
},
"notMatchedRuleAction": "DENY",
"connectionsCount": 0,
"project": {"href": "https://api.equinix.com/resourceManager/v1/projects/567",
"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
},
"changelog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "testuser1",
"updatedByEmail": "testuser@equinix.com",
"updatedByFullName": "testuser testuser",
"updatedDateTime": "2020-05-21T10:30:00Z",
"deletedBy": "testuser1",
"deletedByEmail": "testuser@equinix.com",
"deletedByFullName": "testuser testuser",
"deletedDateTime": "2020-05-21T10:30:00Z"
}
}

Update Route Filter

This API provides capability to partially update a Route Filter

Authorizations:

BearerAuth

path Parameters

routeFilterId

required

string

Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

Request Body schema:
application/json
required

Array (non-empty)

op required	string Handy shortcut for operation name
path required	string path to change
value required	any new value for updated parameter

Responses

Request samples

Payload

Content type

application/json

[{"op": "replace",
"path": "/name",
"value": "My-route-filter-v4-updated"
}
]

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"type": "BGP_IPv4_PREFIX_FILTER",
"uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"name": "My-prefix-filter-v4-updated",
"description": "Test filter",
"state": "REPROVISIONING",
"change": {"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3",
"type": "BGP_IPv4_PREFIX_FILTER_UPDATE",
"uuid": "04af0d37-9160-43d8-97ef-9da9786996a3"
},
"notMatchedRuleAction": "DENY",
"connectionsCount": 1,
"project": {"href": "https://api.equinix.com/resourceManager/v1/projects/567",
"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
},
"changelog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
}

Get Route Filter Changes

This API provides capability to retrieve all of a Route Filter's Changes

Authorizations:

BearerAuth

path Parameters

routeFilterId

required

string

Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

query Parameters

offset	integer Example: offset=1 offset
limit	integer Example: limit=10 number of records to fetch

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (RouteFilterChangeData)

Array

status	string Enum: "COMPLETED" "FAILED" "REQUESTED" Current outcome of the change flow
createdBy	string Created by user key
createdDateTime	string <date-time> Set when change flow starts
updatedBy	string Updated by user key
updatedDateTime	string <date-time> Set when change object is updated
information	string Additional information
	object (RouteFiltersChangeOperation) Route filter change operation data
uuid required	string Uniquely identifies a change
type required	string Enum: "BGP_IPv4_PREFIX_FILTER_UPDATE" "BGP_IPv4_PREFIX_FILTER_CREATION" "BGP_IPv4_PREFIX_FILTER_DELETION" "BGP_IPv6_PREFIX_FILTER_UPDATE" "BGP_IPv6_PREFIX_FILTER_CREATION" "BGP_IPv6_PREFIX_FILTER_DELETION" Type of change
href	string <uri> Route filter change URI

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 4,
"next": null,
"previous": null
},
"data": [{"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3",
"type": "BGP_IPv4_PREFIX_FILTER_CREATION",
"uuid": "04af0d37-9160-43d8-97ef-9da9786996a3",
"status": "COMPLETED",
"createdBy": "testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "_system",
"updatedDateTime": "2020-05-21T10:30:00Z",
"data": {"op": "add",
"path": "/",
"value": {"type": "BGP_IPv4_PREFIX_FILTER",
"name": "My-route-filter-v4",
"description": "Test filter",
"project": {"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}
}
}
},
{"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3",
"type": "BGP_IPv4_PREFIX_FILTER_UPDATE",
"uuid": "04af0d37-9160-43d8-97ef-9da9786996a3",
"status": "COMPLETED",
"createdBy": "testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "_system",
"updatedDateTime": "2020-05-21T10:30:00Z",
"data": {"op": "replace",
"path": "/name",
"value": {"type": "BGP_IPv4_PREFIX_FILTER",
"name": "My-route-filter-v4-updated",
"description": "Test filter",
"project": {"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}
}
}
}
]
}

Get Change By ID

This API provides capability to retrieve a specific Route Filter's Changes

Authorizations:

BearerAuth

path Parameters

routeFilterId required	string Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Filters Id
changeId required	string <uuid> Example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 Routing Protocol Change UUID

Responses

Response Schema: application/json

status

string

Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdBy

string

Created by user key

createdDateTime

string <date-time>

Set when change flow starts

updatedBy

string

Updated by user key

updatedDateTime

string <date-time>

Set when change object is updated

information

string

Additional information

object (RouteFiltersChangeOperation)

Route filter change operation data

op

required

string

Enum: "add" "replace" "remove"

Handy shortcut for operation name

path

required

string

path inside document leading to updated parameter

required

object (RouteFiltersBase)

type required	string Enum: "BGP_IPv4_PREFIX_FILTER" "BGP_IPv6_PREFIX_FILTER" Route Filter type
name required	string
description	string Customer-provided connection description
required	object (Project)

uuid

required

string

Uniquely identifies a change

type

required

string

Enum: "BGP_IPv4_PREFIX_FILTER_UPDATE" "BGP_IPv4_PREFIX_FILTER_CREATION" "BGP_IPv4_PREFIX_FILTER_DELETION" "BGP_IPv6_PREFIX_FILTER_UPDATE" "BGP_IPv6_PREFIX_FILTER_CREATION" "BGP_IPv6_PREFIX_FILTER_DELETION"

Type of change

href

string <uri>

Route filter change URI

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3",
"type": "BGP_IPv4_PREFIX_FILTER_CREATION",
"uuid": "04af0d37-9160-43d8-97ef-9da9786996a3",
"status": "COMPLETED",
"createdBy": "testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "_system",
"updatedDateTime": "2020-05-21T10:30:00Z",
"data": {"op": "add",
"path": "/",
"value": {"type": "BGP_IPv4_PREFIX_FILTER",
"name": "My-route-filter-v4",
"description": "Test filter",
"project": {"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}
}
}
}

Get All Connections on Route Filter

This API provides capability to view all Connections using the Route Filter

Authorizations:

BearerAuth

path Parameters

routeFilterId

required

string

Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (RouteFilterConnectionsData)

List of Connections using a Route Filter

Array

href	string <uri> Connection URI
type	string (ConnectionType) Enum: "EVPL_VC" "EPL_VC" "EC_VC" "IP_VC" "ACCESS_EPL_VC" "EIA_VC" "EVPLAN_VC" "EPLAN_VC" "EVPTREE_VC" "EPTREE_VC" "IPWAN_VC" "IA_VC" "MC_VC" "IX_VC" "GW_VC" "IPX_VC" Connection type
uuid	string <uuid> Route filter identifier
name	string

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 1,
"next": null,
"previous": null
},
"data": [{"href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f",
"type": "IP_VC",
"name": "test-connection",
"uuid": "05de355a-6c9d-4636-8d7d-7b7595821c15"
}
]
}

Search Route Filters

This API provides capability to search Route Filters

Authorizations:

BearerAuth

Request Body schema: application/json
required

SearchAndExpression (object) or SearchOrExpression (object) (SearchFilter)

Top-level filter that can be either an AND expression or OR expression

One of

required	Array of SearchAndExpression (object) or SearchOrExpression (object) or SearchSimpleExpression (object) (SearchFilterExpression) [ 1 .. 8 ] items
Array ([ 1 .. 8 ] items) One of object SearchAndExpression Recursive

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (RouteFilterSortCriteria)

Array

direction	string (RouteFilterSortDirection) Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string (RouteFilterSortBy) Default: "/changeLog/updatedDateTime" Enum: "/type" "/uuid" "/name" "/project/projectId" "/state" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/changeLog/deletedDateTime" Possible field names to use on sorting

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (RouteFiltersData)

List of route filters

Array

href	string <uri> Route filter URI
type	string Enum: "BGP_IPv4_PREFIX_FILTER" "BGP_IPv6_PREFIX_FILTER" Route Filter type
uuid	string <uuid> Route filter identifier
name	string
description	string Customer-provided connection description
	object (RouteFiltersChange) Current state of latest route filter change
notMatchedRuleAction	string Enum: "ALLOW" "DENY"
connectionsCount	integer
rulesCount	integer
	object
	object (Changelog) Change log

Request samples

Payload

Content type

application/json

Example

searchRouteFiltersAndRequest

{"filter": {"and": [{"property": "/type",
"operator": "=",
"values": ["BGP_IPv4_PREFIX_FILTER"
]
},
{"property": "/state",
"operator": "IN",
"values": ["PROVISIONED",
"PROVISIONING"
]
}
]
},
"pagination": {"offset": 0,
"limit": 20
},
"sort": [{"property": "/changeLog/updatedDateTime",
"direction": "DESC"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 1,
"limit": 2,
"total": 10,
"next": "/search?offset=3&limit=2",
"previous": "/search?offset=0&limit=2"
},
"data": [{"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"type": "BGP_IPv4_PREFIX_FILTER",
"uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"name": "My_Route_Filter_Demo_1",
"description": "Test filter",
"state": "PROVISIONING",
"notMatchedRuleAction": "DENY",
"connectionsCount": 1,
"project": {"href": "https://api.equinix.com/resourceManager/v1/projects/567",
"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
},
"changelog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
},
{"href": "https://api.equinix.com/fabric/v4/routeFilters/795a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"type": "BGP_IPv4_PREFIX_FILTER",
"uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"name": "My_Route_Filter_Demo_2",
"description": "Test filter",
"state": "PROVISIONING",
"notMatchedRuleAction": "DENY",
"connectionsCount": 0,
"project": {"href": "https://api.equinix.com/resourceManager/v1/projects/567",
"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
},
"changelog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
}
]
}

Search Cloud Router Route Filter Attachments

This API provides capability to search route filter attachments for a given cloud router ^Beta

Authorizations:

BearerAuth

path Parameters

routerId

required

string <uuid>

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

Cloud Router UUID

Request Body schema: application/json
required

CloudRouterRouteFilterAndExpression (object) or CloudRouterRouteFilterOrExpression (object) (CloudRouterRouteFiltersFilter)

Top-level filter that can be either an AND expression or OR expression

Any of

	Array of CloudRouterRouteFilterAndExpression (object) or CloudRouterRouteFilterOrExpression (object) or CloudRouterRouteFilterSimpleExpression (object) (CloudRouterRouteFilterExpression) [ 1 .. 8 ] items
Array ([ 1 .. 8 ] items) Any of object CloudRouterRouteFilterAndExpression Recursive

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (RfAttachmentSortItem) [ 1 .. 3 ] items

Array ([ 1 .. 3 ] items)

property	string Default: "/changeLog/updatedDateTime" Enum: "/type" "/uuid" "/direction" "/attachmentStatus" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" Possible field names to use on sorting
direction	string Default: "DESC" Enum: "DESC" "ASC" Sorting direction

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (ConnectionRouteFilterData)

List of route filter attachments for a given cloud router

Array

href	string <uri> Route filter URI
type	string Enum: "BGP_IPv4_PREFIX_FILTER" "BGP_IPv6_PREFIX_FILTER" Route filter type
uuid	string <uuid> Route Filter identifier
attachmentStatus	string Enum: "ATTACHING" "ATTACHED" "DETACHED" "DETACHING" "FAILED" "PENDING_BGP_CONFIGURATION"
direction	string Enum: "INBOUND" "OUTBOUND"
	object (Changelog) Change log

Request samples

Payload

Content type

application/json

{"filter": {"and": [{"property": "/type",
"operator": "=",
"values": ["BGP_IPv4_PREFIX_FILTER"
]
},
{"property": "/direction",
"operator": "=",
"values": ["INBOUND"
]
},
{"property": "/attachmentStatus",
"operator": "=",
"values": ["ATTACHED"
]
}
]
},
"pagination": {"limit": 25,
"offset": 0
},
"sort": [{"property": "/changeLog/updatedDateTime",
"direction": "DESC"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 2,
"next": "/search?offset=3&limit=2",
"previous": "/search?offset=0&limit=2"
},
"data": [{"href": "https://api.equinix.com/fabric/v4/connections/57f82f8c-d899-4a21-93ae-5cfe33c50556/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"type": "BGP_IPv4_PREFIX_FILTER",
"uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"direction": "INBOUND",
"attachmentStatus": "ATTACHED",
"changeLog": {"createdBy": "testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
},
{"href": "https://api.equinix.com/fabric/v4/connections/500589e0-4196-4839-8d43-a0c073b4d747/routeFilters/4ed45b37-2b26-49de-ab35-4ad039586c7a",
"type": "BGP_IPv4_PREFIX_FILTER",
"uuid": "4ed45b37-2b26-49de-ab35-4ad039586c7a",
"direction": "INBOUND",
"attachmentStatus": "ATTACHED",
"changeLog": {"createdBy": "testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
}
]
}

Route Filter Rules

Get Route Filter Rules

This API provides capability to get all Route Filters Rules for Fabric

Authorizations:

BearerAuth

path Parameters

routeFilterId

required

string

Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

query Parameters

offset	integer Example: offset=1 offset
limit	integer Example: limit=10 number of records to fetch

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (RouteFilterRulesData)

List of Route Filter Rules

Array

href	string <uri> Route Filter Rules URI
type	string Enum: "BGP_IPv4_PREFIX_FILTER_RULE" "BGP_IPv6_PREFIX_FILTER_RULE" Route filter type
uuid	string <uuid> Route Filter Rule identifier
name	string
description	string Customer-provided Route Filter Rule description
state	string (RouteFilterRuleState) Enum: "PROVISIONING" "REPROVISIONING" "DEPROVISIONING" "PROVISIONED" "DEPROVISIONED" "NOT_PROVISIONED" "NOT_DEPROVISIONED" Route filter rule status
prefixMatch	string Default: "orlonger" prefix matching operator
	object (RouteFilterRulesChange) Current state of latest route filter rule change
action	string Enum: "PERMIT" "DENY"
prefix	string
	object (Changelog) Change log

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 32,
"total": 2,
"next": null,
"previous": null
},
"data": [{"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/65b025ef-022b-4180-85cf-82cfc1ab655b",
"type": "BGP_IPv4_PREFIX_FILTER_RULE",
"uuid": "65b025ef-022b-4180-85cf-82cfc1ab655b",
"name": "Private-subnet-filter-2",
"description": "Test rule",
"prefixMatch": "exact",
"action": "PERMIT",
"prefix": "192.168.10.0/24",
"state": "PROVISIONED",
"change": {"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/9397f111-19aa-489c-b3c7-349c86818f2d",
"type": "BGP_IPv4_PREFIX_FILTER_RULE_CREATION",
"uuid": "9397f111-19aa-489c-b3c7-349c86818f2d"
},
"changelog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
},
{"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/ea48337b-fe04-4164-a3f0-48d81abf575b",
"type": "BGP_IPv4_PREFIX_FILTER_RULE",
"uuid": "ea48337b-fe04-4164-a3f0-48d81abf575b",
"name": "Private-subnet-filter-2",
"description": "Test rule",
"prefixMatch": "orlonger",
"action": "PERMIT",
"prefix": "192.168.20.0/24",
"state": "PROVISIONED",
"change": {"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/9397f111-19aa-489c-b3c7-349c86818f2d",
"type": "BGP_IPv4_PREFIX_FILTER_RULE_CREATION",
"uuid": "9397f111-19aa-489c-b3c7-349c86818f2d"
},
"changelog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
}
]
}

Create Route Filter Rule

This API provides capability to create a Route Filter Rule

Authorizations:

BearerAuth

path Parameters

routeFilterId

required

string

Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

Request Body schema: application/json
required

name	string
description	string Customer-provided Route Filter Rule description
prefix required	string
prefixMatch	string Default: "orlonger"

Responses

Request samples

Payload

Content type

application/json

Example

RouteFilterRuleBgpIpv4Prefix

{"name": "Private-subnet-filter",
"description": "Test rule",
"prefix": "192.168.0.0/24",
"prefixMatch": "exact"
}

Response samples

Content type

application/json

Example

GetSpecificRouteFilterRuleIpv4Response

{"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403",
"type": "BGP_IPv4_PREFIX_FILTER_RULE",
"uuid": "9890d520-1579-4489-8003-154b34b8f403",
"name": "Private-subnet-filter",
"state": "PROVISIONING",
"description": "Test rule",
"change": {"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/ff9653dc-88c5-47b5-b552-8a08d2f73f7e",
"type": "BGP_IPv4_PREFIX_FILTER_RULE_CREATION",
"uuid": "ff9653dc-88c5-47b5-b552-8a08d2f73f7e"
},
"action": "PERMIT",
"prefix": "192.168.0.0/24",
"prefixMatch": "exact",
"changelog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "testuser",
"updatedByEmail": "testuser@equinix.com",
"updatedByFullName": "testuser testuser",
"updatedDateTime": "2020-05-21T10:30:00Z"
}
}

Get Route Filter Rule by ID

This API provides capability to view a Route Filter Rule by UUID

Authorizations:

BearerAuth

path Parameters

routeFilterId required	string Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Filters Id
routeFilterRuleId required	string Example: 65b025ef-022b-4180-85cf-82cfc1ab655b Route Filter Rules Id

Responses

Response samples

Content type

application/json

Example

GetSpecificRouteFilterRuleIpv4Response

{"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403",
"type": "BGP_IPv4_PREFIX_FILTER_RULE",
"uuid": "9890d520-1579-4489-8003-154b34b8f403",
"name": "Private-subnet-filter",
"state": "PROVISIONING",
"description": "Test rule",
"change": {"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/ff9653dc-88c5-47b5-b552-8a08d2f73f7e",
"type": "BGP_IPv4_PREFIX_FILTER_RULE_CREATION",
"uuid": "ff9653dc-88c5-47b5-b552-8a08d2f73f7e"
},
"action": "PERMIT",
"prefix": "192.168.0.0/24",
"prefixMatch": "exact",
"changelog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "testuser",
"updatedByEmail": "testuser@equinix.com",
"updatedByFullName": "testuser testuser",
"updatedDateTime": "2020-05-21T10:30:00Z"
}
}

Delete Route Filter Rule

This API provides capability to delete a Route Filter Rule

Authorizations:

BearerAuth

path Parameters

routeFilterId required	string Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Filters Id
routeFilterRuleId required	string Example: 65b025ef-022b-4180-85cf-82cfc1ab655b Route Filter Rules Id

Responses

Response samples

Content type

application/json

Example

RouteFilterDeleteBgpIpv4PrefixResponse

{"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403",
"type": "BGP_IPv4_PREFIX_FILTER_RULE",
"uuid": "9890d520-1579-4489-8003-154b34b8f403",
"name": "Private-subnet-filter",
"description": "Test rule",
"state": "DEPROVISIONING",
"change": {"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/e8528788-14d3-4a7b-a740-99b702067485",
"type": "BGP_IPv4_PREFIX_FILTER_RULE_DELETION",
"uuid": "e8528788-14d3-4a7b-a740-99b702067485"
},
"action": "PERMIT",
"prefix": "192.168.0.0/24",
"prefixMatch": "exact",
"changelog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "testuser1",
"updatedByEmail": "testuser@equinix.com",
"updatedByFullName": "testuser testuser",
"updatedDateTime": "2020-05-21T10:30:00Z",
"deletedBy": "testuser1",
"deletedByEmail": "testuser@equinix.com",
"deletedByFullName": "testuser testuser",
"deletedDateTime": "2020-05-21T10:30:00Z"
}
}

Replace Route Filter Rule

This API provides capability to replace a Route Filter Rule completely

Authorizations:

BearerAuth

path Parameters

routeFilterId required	string Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Filters Id
routeFilterRuleId required	string Example: 65b025ef-022b-4180-85cf-82cfc1ab655b Route Filter Rules Id

Request Body schema: application/json
required

name	string
description	string Customer-provided Route Filter Rule description
prefix required	string
prefixMatch	string Default: "orlonger"

Responses

Request samples

Payload

Content type

application/json

Example

RouteFilterIpv4ReplaceExample

{"name": "Private-subnet-filter-update",
"description": "Test rule",
"prefix": "192.168.0.0/24",
"prefixMatch": "exact"
}

Response samples

Content type

application/json

Example

RouteFilterRuleIpv4ReplaceResponse

{"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403",
"type": "BGP_IPv4_PREFIX_FILTER_RULE",
"uuid": "9890d520-1579-4489-8003-154b34b8f403",
"name": "Private-subnet-filter-update",
"description": "Test rule",
"prefixMatch": "exact",
"state": "REPROVISIONING",
"action": "PERMIT",
"change": {"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/a25ca469-721a-4614-89a9-cdef287aa628",
"type": "BGP_IPv4_PREFIX_FILTER_RULE_UPDATE",
"uuid": "a25ca469-721a-4614-89a9-cdef287aa628"
},
"prefix": "192.168.0.0/24",
"changelog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "testuser1",
"updatedByEmail": "testuser@equinix.com",
"updatedByFullName": "testuser testuser",
"updatedDateTime": "2020-05-21T10:30:00Z"
}
}

Update Route Filter Rule

This API provides capability to partially update a Route Filter Rule

Authorizations:

BearerAuth

path Parameters

routeFilterId required	string Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Filters Id
routeFilterRuleId required	string Example: 65b025ef-022b-4180-85cf-82cfc1ab655b Route Filter Rules Id

Request Body schema:
application/json
required

Array (non-empty)

op required	string Handy shortcut for operation name
path required	string path to change
value required	any new value for updated parameter

Responses

Request samples

Payload

Content type

application/json

Example

RouteFilterRuleName

[{"op": "replace",
"path": "/name",
"value": "test-route-filter-name-patch"
}
]

Response samples

Content type

application/json

Example

RouteFilterRuleIpv4ReplaceResponse

{"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403",
"type": "BGP_IPv4_PREFIX_FILTER_RULE",
"uuid": "9890d520-1579-4489-8003-154b34b8f403",
"name": "Private-subnet-filter-update",
"description": "Test rule",
"prefixMatch": "exact",
"state": "REPROVISIONING",
"action": "PERMIT",
"change": {"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/a25ca469-721a-4614-89a9-cdef287aa628",
"type": "BGP_IPv4_PREFIX_FILTER_RULE_UPDATE",
"uuid": "a25ca469-721a-4614-89a9-cdef287aa628"
},
"prefix": "192.168.0.0/24",
"changelog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "testuser1",
"updatedByEmail": "testuser@equinix.com",
"updatedByFullName": "testuser testuser",
"updatedDateTime": "2020-05-21T10:30:00Z"
}
}

Get Route Filter Rule Changes

This API provides capability to retrieve all of a Route Filter Rule's Changes

Authorizations:

BearerAuth

path Parameters

routeFilterId required	string Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Filters Id
routeFilterRuleId required	string Example: 65b025ef-022b-4180-85cf-82cfc1ab655b Route Filter Rules Id

query Parameters

offset	integer Example: offset=1 offset
limit	integer Example: limit=10 number of records to fetch

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (RouteFilterRulesChangeData)

Array

status	string Enum: "COMPLETED" "FAILED" "REQUESTED" Current outcome of the change flow
createdBy	string Created by User Key
createdDateTime	string <date-time> Set when change flow starts
updatedBy	string Updated by User Key
updatedDateTime	string <date-time> Set when change object is updated
	object (RouteFilterRulesChangeOperation) Route filter rule change operation data
uuid required	string Uniquely identifies a change
type required	string Enum: "BGP_IPv4_PREFIX_FILTER_RULE_UPDATE" "BGP_IPv4_PREFIX_FILTER_RULE_CREATION" "BGP_IPv4_PREFIX_FILTER_RULE_DELETION" "BGP_IPv6_PREFIX_FILTER_RULE_UPDATE" "BGP_IPv6_PREFIX_FILTER_RULE_CREATION" "BGP_IPv6_PREFIX_FILTER_RULE_DELETION" Type of change
href	string <uri> Route Filter Change URI

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 3,
"next": null,
"previous": null
},
"data": [{"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/ff9653dc-88c5-47b5-b552-8a08d2f73f7e",
"type": "BGP_IPv4_PREFIX_FILTER_RULE_CREATION",
"uuid": "ff9653dc-88c5-47b5-b552-8a08d2f73f7e",
"status": "COMPLETED",
"createdBy": "testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "_system",
"updatedDateTime": "2020-05-21T10:30:00Z",
"data": {"op": "add",
"path": "/",
"value": {"name": "Private-subnet-filter",
"description": "Test rule",
"prefix": "192.168.0.0/25",
"prefixMatch": "exact"
}
}
},
{"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/a40085a4-f0cc-416c-af01-286f7f7ec736",
"type": "BGP_IPv4_PREFIX_FILTER_RULE_UPDATE",
"uuid": "a40085a4-f0cc-416c-af01-286f7f7ec736",
"status": "COMPLETED",
"createdBy": "testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "_system",
"updatedDateTime": "2020-05-21T10:30:00Z",
"data": {"op": "replace",
"path": "/prefixMatch",
"value": {"name": "Private-subnet-filter",
"description": "Test rule",
"prefix": "192.168.0.0/25",
"prefixMatch": "orlonger"
}
}
},
{"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/a25ca469-721a-4614-89a9-cdef287aa628",
"type": "BGP_IPv4_PREFIX_FILTER_RULE_UPDATE",
"uuid": "a25ca469-721a-4614-89a9-cdef287aa628",
"status": "COMPLETED",
"createdBy": "testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "_system",
"updatedDateTime": "2020-05-21T10:30:00Z",
"data": {"op": "replace",
"path": "/prefixMatch",
"value": {"name": "Private-subnet-filter",
"description": "Test rule",
"prefix": "192.168.0.0/25",
"prefixMatch": "exact"
}
}
}
]
}

Get Change By ID

This API provides capability to retrieve a specific Route Filter Rule's Changes

Authorizations:

BearerAuth

path Parameters

routeFilterId required	string Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Filters Id
routeFilterRuleId required	string Example: 65b025ef-022b-4180-85cf-82cfc1ab655b Route Filter Rules Id
changeId required	string <uuid> Example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 Route Filter Rule Change UUID

Responses

Response Schema: application/json

status

string

Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdBy

string

Created by User Key

createdDateTime

string <date-time>

Set when change flow starts

updatedBy

string

Updated by User Key

updatedDateTime

string <date-time>

Set when change object is updated

object (RouteFilterRulesChangeOperation)

Route filter rule change operation data

op

required

string

Enum: "add" "replace" "remove"

Handy shortcut for operation name

path

required

string

path inside document leading to updated parameter

required

object (RouteFilterRulesBase)

name	string
description	string Customer-provided Route Filter Rule description
prefix required	string
prefixMatch	string Default: "orlonger"

uuid

required

string

Uniquely identifies a change

type

required

string

Enum: "BGP_IPv4_PREFIX_FILTER_RULE_UPDATE" "BGP_IPv4_PREFIX_FILTER_RULE_CREATION" "BGP_IPv4_PREFIX_FILTER_RULE_DELETION" "BGP_IPv6_PREFIX_FILTER_RULE_UPDATE" "BGP_IPv6_PREFIX_FILTER_RULE_CREATION" "BGP_IPv6_PREFIX_FILTER_RULE_DELETION"

Type of change

href

string <uri>

Route Filter Change URI

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/ff9653dc-88c5-47b5-b552-8a08d2f73f7e",
"type": "BGP_IPv4_PREFIX_FILTER_RULE_CREATION",
"uuid": "ff9653dc-88c5-47b5-b552-8a08d2f73f7e",
"status": "COMPLETED",
"createdBy": "testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "_system",
"updatedDateTime": "2020-05-21T10:30:00Z",
"data": {"op": "add",
"path": "/",
"value": {"name": "Private-subnet-filter",
"description": "Test rule",
"prefix": "192.168.0.0/25",
"prefixMatch": "exact"
}
}
}

Bulk Create Route Filter Rules

This API provides capability to create bulk route filter rules

Authorizations:

BearerAuth

path Parameters

routeFilterId

required

string

Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

Request Body schema: application/json
required

Array of objects (RouteFilterRulesBase)

Route Filter Rule configuration

Array

name	string
description	string Customer-provided Route Filter Rule description
prefix required	string
prefixMatch	string Default: "orlonger"

Responses

Request samples

Payload

Content type

application/json

{"data": [{"name": "Private-subnet-filter",
"description": "string",
"prefix": "192.168.0.0/24",
"prefixMatch": "orlonger, exact"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 32,
"total": 2,
"next": null,
"previous": null
},
"data": [{"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/65b025ef-022b-4180-85cf-82cfc1ab655b",
"type": "BGP_IPv4_PREFIX_FILTER_RULE",
"uuid": "65b025ef-022b-4180-85cf-82cfc1ab655b",
"name": "Private-subnet-filter-2",
"description": "Test rule",
"prefixMatch": "exact",
"action": "PERMIT",
"prefix": "192.168.10.0/24",
"state": "PROVISIONING",
"change": {"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/9397f111-19aa-489c-b3c7-349c86818f2d",
"type": "BGP_IPv4_PREFIX_FILTER_RULE_CREATION",
"uuid": "9397f111-19aa-489c-b3c7-349c86818f2d"
},
"changelog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
},
{"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/ea48337b-fe04-4164-a3f0-48d81abf575b",
"type": "BGP_IPv4_PREFIX_FILTER_RULE",
"uuid": "ea48337b-fe04-4164-a3f0-48d81abf575b",
"name": "Private-subnet-filter-2",
"description": "Test rule",
"prefixMatch": "orlonger",
"action": "PERMIT",
"prefix": "192.168.20.0/24",
"state": "PROVISIONING",
"change": {"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/9397f111-19aa-489c-b3c7-349c86818f2d",
"type": "BGP_IPv4_PREFIX_FILTER_RULE_CREATION",
"uuid": "9397f111-19aa-489c-b3c7-349c86818f2d"
},
"changelog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
}
]
}

Search Route Filter Rules

This API provides capability to search Route Filter Rules

Authorizations:

BearerAuth

path Parameters

routeFilterId

required

string

Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Filters Id

Request Body schema: application/json
required

RouteFilterRuleAndExpression (object) or RouteFilterRuleOrExpression (object) (RouteFilterRulesFilter)

Top-level filter that can be either an AND expression or OR expression

Any of

	Array of RouteFilterRuleAndExpression (object) or RouteFilterRuleOrExpression (object) or RouteFilterRuleSimpleExpression (object) (RouteFilterRuleExpression) [ 1 .. 8 ] items
Array ([ 1 .. 8 ] items) Any of object RouteFilterRuleAndExpression Recursive

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (RouteFilterRuleSortCriteria)

Array

direction	string (RouteFilterRuleSortDirection) Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string (RouteFilterRuleSortBy) Default: "/changeLog/updatedDateTime" Enum: "/type" "/uuid" "/name" "/state" "/prefix" "/prefixMatch" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" Possible field names to use on sorting

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (RouteFilterRulesData)

List of route filter rules

Array

href	string <uri> Route Filter Rules URI
type	string Enum: "BGP_IPv4_PREFIX_FILTER_RULE" "BGP_IPv6_PREFIX_FILTER_RULE" Route filter type
uuid	string <uuid> Route Filter Rule identifier
name	string
description	string Customer-provided Route Filter Rule description
state	string (RouteFilterRuleState) Enum: "PROVISIONING" "REPROVISIONING" "DEPROVISIONING" "PROVISIONED" "DEPROVISIONED" "NOT_PROVISIONED" "NOT_DEPROVISIONED" Route filter rule status
prefixMatch	string Default: "orlonger" prefix matching operator
	object (RouteFilterRulesChange) Current state of latest route filter rule change
action	string Enum: "PERMIT" "DENY"
prefix	string
	object (Changelog) Change log

Request samples

Payload

Content type

application/json

Example

SearchRouteFilterRulesAndRequest

{"filter": {"and": [{"property": "/type",
"operator": "=",
"values": ["BGP_IPv4_PREFIX_FILTER_RULE"
]
},
{"property": "/state",
"operator": "=",
"values": ["PROVISIONED"
]
},
{"or": [{"property": "/name",
"operator": "LIKE",
"values": ["%Demo%"
]
},
{"property": "/name",
"operator": "LIKE",
"values": ["%Production%"
]
}
]
},
{"or": [{"property": "/state",
"operator": "=",
"values": ["PROVISIONED"
]
},
{"and": [{"property": "/prefix",
"operator": "=",
"values": ["192.168.2.0/24"
]
},
{"property": "/prefixMatch",
"operator": "=",
"values": ["exact"
]
}
]
}
]
}
]
},
"pagination": {"offset": 0,
"limit": 20
},
"sort": [{"property": "/changeLog/updatedDateTime",
"direction": "DESC"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 1,
"limit": 2,
"total": 10,
"next": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/search?offset=3&limit=2",
"previous": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/search?offset=0&limit=2"
},
"data": [{"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/65b025ef-022b-4180-85cf-82cfc1ab655b",
"type": "BGP_IPv4_PREFIX_FILTER_RULE",
"uuid": "65b025ef-022b-4180-85cf-82cfc1ab655b",
"name": "Route_Filter_Rule_Demo1",
"description": "Test rule1",
"prefixMatch": "exact",
"action": "PERMIT",
"prefix": "192.168.10.0/24",
"state": "PROVISIONED",
"changelog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
},
{"href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/ea48337b-fe04-4164-a3f0-48d81abf575b",
"type": "BGP_IPv4_PREFIX_FILTER_RULE",
"uuid": "ea48337b-fe04-4164-a3f0-48d81abf575b",
"name": "Route_Filter_Rule_Demo2",
"description": "Test rule2",
"prefixMatch": "orlonger",
"action": "PERMIT",
"prefix": "192.168.20.0/24",
"state": "PROVISIONED",
"changelog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
}
]
}

Route Aggregations

Get Connection Route Aggregations

This API provides capability to view all Route Aggregations attached to a Connection

Authorizations:

BearerAuth

path Parameters

connectionId

required

string

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

Connection Id

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (ConnectionRouteAggregationData)

List of Route Aggregations attached to a Connection

Array

href	string <uri> Route Aggregation URI
type	string Value: "BGP_IPv4_PREFIX_AGGREGATION" Route Aggregation type
uuid	string <uuid> Route Aggregation identifier
attachmentStatus	string Enum: "ATTACHING" "ATTACHED" "DETACHED" "DETACHING" "FAILED" "PENDING_BGP_CONFIGURATION"
	object (Changelog) Change log

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 4
},
"data": [{"href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"type": "BGP_IPv4_PREFIX_AGGREGATION",
"uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"attachmentStatus": "DETACHING"
},
{"href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeAggregations/52f7791a-fe90-49bc-8807-18b3d6eda566",
"type": "BGP_IPv4_PREFIX_AGGREGATION",
"uuid": "52f7791a-fe90-49bc-8807-18b3d6eda566",
"attachmentStatus": "ATTACHED"
},
{"href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeAggregations/8b67bf1c-7afa-4a9e-98c3-d5ab17da6652",
"type": "BGP_IPv4_PREFIX_AGGREGATION",
"uuid": "8b67bf1c-7afa-4a9e-98c3-d5ab17da6652",
"attachmentStatus": "ATTACHED"
},
{"href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeAggregations/65d74639-8f48-4e10-9684-45d364645e97",
"type": "BGP_IPv4_PREFIX_AGGREGATION",
"uuid": "65d74639-8f48-4e10-9684-45d364645e97",
"attachmentStatus": "ATTACHED"
}
]
}

Get Aggregation

This API provides capability to view a specific Route Aggregation attached to a Connection

Authorizations:

BearerAuth

path Parameters

routeAggregationId required	string Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Aggregations Id
connectionId required	string Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Connection Id

Responses

Response Schema: application/json

href

string <uri>

Route Aggregation URI

type

string

Value: "BGP_IPv4_PREFIX_AGGREGATION"

Route Aggregation type

uuid

string <uuid>

Route Aggregation identifier

attachmentStatus

string

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

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"type": "BGP_IPv4_PREFIX_AGGREGATION",
"uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"attachmentStatus": "ATTACHING"
}

Attach Aggregation

This API provides capability to attach a Route Aggregation to a Connection

Authorizations:

BearerAuth

path Parameters

routeAggregationId required	string Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Aggregations Id
connectionId required	string Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Connection Id

Responses

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"type": "BGP_IPv4_PREFIX_AGGREGATION",
"uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"attachmentStatus": "ATTACHING"
}

Detach Aggregation

This API provides capability to detach a Route Aggregation from a Connection

Authorizations:

BearerAuth

path Parameters

routeAggregationId required	string Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Aggregations Id
connectionId required	string Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Connection Id

Responses

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"type": "BGP_IPv4_PREFIX_AGGREGATION",
"uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"attachmentStatus": "DETACHING"
}

Create Route Aggregation

This API provides capability to create a Route Aggregation

Authorizations:

BearerAuth

Request Body schema: application/json
required

type

required

string

Enum: "BGP_IPv4_PREFIX_AGGREGATION" "BGP_IPv6_PREFIX_AGGREGATION"

Route Aggregation type

name

required

string

description

string

Customer-provided connection description

required

object (Project)

projectId

required

string

Subscriber-assigned project ID

Responses

Request samples

Payload

Content type

application/json

{"type": "BGP_IPv4_PREFIX_AGGREGATION",
"name": "My-route-aggregation-v4",
"description": "Test aggregation",
"project": {"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}
}

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"type": "BGP_IPv4_PREFIX_AGGREGATION",
"uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"name": "My-prefix-aggregation-v4",
"description": "Test aggregation",
"state": "PROVISIONING",
"change": {"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3",
"type": "BGP_IPv4_PREFIX_AGGREGATION_CREATION",
"uuid": "04af0d37-9160-43d8-97ef-9da9786996a3"
},
"rulesCount": 0,
"connectionsCount": 0,
"project": {"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
},
"changeLog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
}

Get Aggregation

This API provides capability to view a Route Aggregation by UUID

Authorizations:

BearerAuth

path Parameters

routeAggregationId

required

string

Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

Responses

Response Schema: application/json

href

string <uri>

Route Aggregation URI

type

string

Enum: "BGP_IPv4_PREFIX_AGGREGATION" "BGP_IPv6_PREFIX_AGGREGATION"

Route Aggregation type

uuid

string <uuid>

Route Aggregation identifier

name

string

description

string

Customer-provided connection description

object (RouteAggregationsChange)

Current state of latest Route Aggregation change

uuid required	string Uniquely identifies a change
type required	string Enum: "BGP_IPv4_PREFIX_AGGREGATION_UPDATE" "BGP_IPv4_PREFIX_AGGREGATION_CREATION" "BGP_IPv4_PREFIX_AGGREGATION_DELETION" "BGP_IPv6_PREFIX_AGGREGATION_UPDATE" "BGP_IPv6_PREFIX_AGGREGATION_CREATION" "BGP_IPv6_PREFIX_AGGREGATION_DELETION" Type of change
href	string <uri> Route AGGREGATION Change URI

connectionsCount

integer

rulesCount

integer

object

projectId required	string Subscriber-assigned project ID
href	string <uri> Project URI

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"type": "BGP_IPv4_PREFIX_AGGREGATION",
"uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"name": "My-prefix-aggregation-v4",
"description": "Test aggregation",
"state": "PROVISIONING",
"change": {"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3",
"type": "BGP_IPv4_PREFIX_AGGREGATION_CREATION",
"uuid": "04af0d37-9160-43d8-97ef-9da9786996a3"
},
"rulesCount": 0,
"connectionsCount": 0,
"project": {"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
},
"changeLog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
}

Delete Aggregation

This API provides capability to delete a Route Aggregation

Authorizations:

BearerAuth

path Parameters

routeAggregationId

required

string

Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

Responses

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"type": "BGP_IPv4_PREFIX_AGGREGATION",
"uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"name": "My-prefix-aggregation-v4",
"description": "Test Aggregation",
"state": "DEPROVISIONING",
"change": {"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/c2ec84c5-6de6-4f5c-b506-3ce218630c31",
"type": "BGP_IPv4_PREFIX_AGGREGATION_DELETION",
"uuid": "c2ec84c5-6de6-4f5c-b506-3ce218630c31"
},
"connectionsCount": 0,
"rulesCount": 0,
"project": {"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
},
"changeLog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "testuser1",
"updatedByEmail": "testuser@equinix.com",
"updatedByFullName": "testuser testuser",
"updatedDateTime": "2020-05-21T10:30:00Z",
"deletedBy": "testuser1",
"deletedByEmail": "testuser@equinix.com",
"deletedByFullName": "testuser testuser",
"deletedDateTime": "2020-05-21T10:30:00Z"
}
}

Update Route Aggregation

This API provides capability to partially update a Route Aggregation

Authorizations:

BearerAuth

path Parameters

routeAggregationId

required

string

Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

Request Body schema:
application/json
required

Array (non-empty)

op required	string Handy shortcut for operation name
path required	string path to change
value required	any new value for updated parameter

Responses

Request samples

Payload

Content type

application/json

[{"op": "replace",
"path": "/name",
"value": "My-route-aggregation-v4-updated"
}
]

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"type": "BGP_IPv4_PREFIX_AGGREGATION",
"uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"name": "My-prefix-aggregation-v4-updated",
"description": "Test aggregation",
"state": "REPROVISIONING",
"change": {"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3",
"type": "BGP_IPv4_PREFIX_AGGREGATION_UPDATE",
"uuid": "04af0d37-9160-43d8-97ef-9da9786996a3"
},
"connectionsCount": 1,
"rulesCount": 0,
"project": {"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
},
"changeLog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
}

Get Route Aggregation Changes

This API provides capability to retrieve all of a Route Aggregation's Changes

Authorizations:

BearerAuth

path Parameters

routeAggregationId

required

string

Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

query Parameters

offset	integer Example: offset=1 offset
limit	integer Example: limit=10 number of records to fetch

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (RouteAggregationChangeData)

Array

status	string Enum: "COMPLETED" "FAILED" "REQUESTED" Current outcome of the change flow
createdBy	string Created by User Key
createdDateTime	string <date-time> Set when change flow starts
updatedBy	string Updated by User Key
updatedDateTime	string <date-time> Set when change object is updated
information	string Additional information
	object (RouteAggregationsChangeOperation) Route Aggregation change operation data
uuid required	string Uniquely identifies a change
type required	string Enum: "BGP_IPv4_PREFIX_AGGREGATION_UPDATE" "BGP_IPv4_PREFIX_AGGREGATION_CREATION" "BGP_IPv4_PREFIX_AGGREGATION_DELETION" "BGP_IPv6_PREFIX_AGGREGATION_UPDATE" "BGP_IPv6_PREFIX_AGGREGATION_CREATION" "BGP_IPv6_PREFIX_AGGREGATION_DELETION" Type of change
href	string <uri> Route AGGREGATION Change URI

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 4,
"next": null,
"previous": null
},
"data": [{"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3",
"type": "BGP_IPv4_PREFIX_AGGREGATION_CREATION",
"uuid": "04af0d37-9160-43d8-97ef-9da9786996a3",
"status": "COMPLETED",
"createdBy": "testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "_system",
"updatedDateTime": "2020-05-21T10:30:00Z",
"data": {"op": "add",
"path": "/",
"value": {"type": "BGP_IPv4_PREFIX_AGGREGATION",
"name": "My-route-aggregation-v4",
"description": "Test Aggregation",
"project": {"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}
}
}
},
{"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3",
"type": "BGP_IPv4_PREFIX_AGGREGATION_UPDATE",
"uuid": "04af0d37-9160-43d8-97ef-9da9786996a3",
"status": "COMPLETED",
"createdBy": "testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "_system",
"updatedDateTime": "2020-05-21T10:30:00Z",
"data": {"op": "replace",
"path": "/name",
"value": {"type": "BGP_IPv4_PREFIX_AGGREGATION",
"name": "My-route-aggregations-v4-updated",
"description": "Test Aggregation",
"project": {"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}
}
}
}
]
}

Get Change By ID

This API provides capability to retrieve a specific Route Aggregation's Changes

Authorizations:

BearerAuth

path Parameters

routeAggregationId required	string Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Aggregations Id
changeId required	string <uuid> Example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 Routing Protocol Change UUID

Responses

Response Schema: application/json

status

string

Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdBy

string

Created by User Key

createdDateTime

string <date-time>

Set when change flow starts

updatedBy

string

Updated by User Key

updatedDateTime

string <date-time>

Set when change object is updated

information

string

Additional information

object (RouteAggregationsChangeOperation)

Route Aggregation change operation data

op

required

string

Enum: "add" "replace" "remove"

Handy shortcut for operation name

path

required

string

path inside document leading to updated parameter

required

object (RouteAggregationsBase)

type required	string Enum: "BGP_IPv4_PREFIX_AGGREGATION" "BGP_IPv6_PREFIX_AGGREGATION" Route Aggregation type
name required	string
description	string Customer-provided connection description
required	object (Project)

uuid

required

string

Uniquely identifies a change

type

required

string

Enum: "BGP_IPv4_PREFIX_AGGREGATION_UPDATE" "BGP_IPv4_PREFIX_AGGREGATION_CREATION" "BGP_IPv4_PREFIX_AGGREGATION_DELETION" "BGP_IPv6_PREFIX_AGGREGATION_UPDATE" "BGP_IPv6_PREFIX_AGGREGATION_CREATION" "BGP_IPv6_PREFIX_AGGREGATION_DELETION"

Type of change

href

string <uri>

Route AGGREGATION Change URI

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3",
"type": "BGP_IPv4_PREFIX_AGGREGATION_CREATION",
"uuid": "04af0d37-9160-43d8-97ef-9da9786996a3",
"status": "COMPLETED",
"createdBy": "testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "_system",
"updatedDateTime": "2020-05-21T10:30:00Z",
"data": {"op": "add",
"path": "/",
"value": {"type": "BGP_IPv4_PREFIX_AGGREGATION",
"name": "My-route-aggregation-v4",
"description": "Test aggregation",
"project": {"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}
}
}
}

Get Route Aggregation Connections

This API provides capability to view all Connections using the Route Aggregation

Authorizations:

BearerAuth

path Parameters

routeAggregationId

required

string

Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (RouteAggregationConnectionsData)

List of Connections using a Route Aggregation

Array

href	string <uri> Connection URI
type	string (ConnectionType) Enum: "EVPL_VC" "EPL_VC" "EC_VC" "IP_VC" "ACCESS_EPL_VC" "EIA_VC" "EVPLAN_VC" "EPLAN_VC" "EVPTREE_VC" "EPTREE_VC" "IPWAN_VC" "IA_VC" "MC_VC" "IX_VC" "GW_VC" "IPX_VC" Connection type
uuid	string <uuid> Route Aggregation identifier
name	string

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 1,
"next": null,
"previous": null
},
"data": [{"href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f",
"type": "IP_VC",
"name": "test-connection",
"uuid": "05de355a-6c9d-4636-8d7d-7b7595821c15"
}
]
}

Search Route Aggregations

This API provides capability to search Route Aggregations

Authorizations:

BearerAuth

Request Body schema: application/json
required

SearchAndExpression (object) or SearchOrExpression (object) (SearchFilter)

Top-level filter that can be either an AND expression or OR expression

One of

required	Array of SearchAndExpression (object) or SearchOrExpression (object) or SearchSimpleExpression (object) (SearchFilterExpression) [ 1 .. 8 ] items
Array ([ 1 .. 8 ] items) One of object SearchAndExpression Recursive

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (RouteAggregationSortCriteria)

Array

direction	string (RouteAggregationSortDirection) Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string (RouteAggregationSortBy) Default: "/changeLog/updatedDateTime" Enum: "/type" "/uuid" "/name" "/project/projectId" "/state" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" "/changeLog/deletedDateTime" Possible field names to use on sorting

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (RouteAggregationsData)

List of Route Aggregations

Array

href	string <uri> Route Aggregation URI
type	string Enum: "BGP_IPv4_PREFIX_AGGREGATION" "BGP_IPv6_PREFIX_AGGREGATION" Route Aggregation type
uuid	string <uuid> Route Aggregation identifier
name	string
description	string Customer-provided connection description
	object (RouteAggregationsChange) Current state of latest Route Aggregation change
connectionsCount	integer
rulesCount	integer
	object
	object (Changelog) Change log

Request samples

Payload

Content type

application/json

Example

searchRouteAggregationsAndRequest

{"filter": {"and": [{"property": "/type",
"operator": "=",
"values": ["BGP_IPv4_PREFIX_AGGREGATION"
]
},
{"property": "/state",
"operator": "IN",
"values": ["PROVISIONED",
"DEPROVISIONING"
]
}
]
},
"pagination": {"offset": 0,
"limit": 20
},
"sort": [{"property": "/changeLog/updatedDateTime",
"direction": "DESC"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 1,
"limit": 2,
"total": 10,
"next": "/search?offset=3&limit=2",
"previous": "/search?offset=0&limit=2"
},
"data": [{"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"type": "BGP_IPv4_PREFIX_AGGREGATION",
"uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"name": "My_Route_Aggregation_Demo_1",
"description": "Test aggregation",
"state": "PROVISIONING",
"connectionsCount": 1,
"rulesCount": 0,
"project": {"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
},
"changeLog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
},
{"href": "https://api.equinix.com/fabric/v4/routeAggregations/795a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"type": "BGP_IPv4_PREFIX_AGGREGATION",
"uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"name": "My_Route_Aggregation_Demo_2",
"description": "Test aggregation",
"state": "PROVISIONING",
"connectionsCount": 0,
"rulesCount": 0,
"project": {"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
},
"changeLog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
}
]
}

Search Cloud Router Route Aggregation Attachments

This API provides capability to search route aggregation attachments for a given cloud router ^Beta

Authorizations:

BearerAuth

path Parameters

routerId

required

string <uuid>

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

Cloud Router UUID

Request Body schema: application/json
required

CloudRouterRouteAggregationAndExpression (object) or CloudRouterRouteAggregationOrExpression (object) (CloudRouterRouteAggregationsFilter)

Top-level filter that can be either an AND expression or OR expression

Any of

	Array of CloudRouterRouteAggregationAndExpression (object) or CloudRouterRouteAggregationOrExpression (object) or CloudRouterRouteAggregationSimpleExpression (object) (CloudRouterRouteAggregationExpression) [ 1 .. 8 ] items
Array ([ 1 .. 8 ] items) Any of object CloudRouterRouteAggregationAndExpression Recursive

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (RaAttachmentSortItem) [ 1 .. 3 ] items

Array ([ 1 .. 3 ] items)

property	string Default: "/changeLog/updatedDateTime" Enum: "/type" "/uuid" "/attachmentStatus" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" Possible field names to use on sorting
direction	string Default: "DESC" Enum: "DESC" "ASC" Sorting direction

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (ConnectionRouteAggregationData)

List of route aggregation attachments for a given cloud router

Array

href	string <uri> Route Aggregation URI
type	string Value: "BGP_IPv4_PREFIX_AGGREGATION" Route Aggregation type
uuid	string <uuid> Route Aggregation identifier
attachmentStatus	string Enum: "ATTACHING" "ATTACHED" "DETACHED" "DETACHING" "FAILED" "PENDING_BGP_CONFIGURATION"
	object (Changelog) Change log

Request samples

Payload

Content type

application/json

{"filter": {"and": [{"property": "/type",
"operator": "=",
"values": ["BGP_IPv4_PREFIX_AGGREGATION"
]
},
{"property": "/attachmentStatus",
"operator": "=",
"values": ["ATTACHED"
]
}
]
},
"pagination": {"limit": 25,
"offset": 0
},
"sort": [{"property": "/changeLog/updatedDateTime",
"direction": "DESC"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 1,
"limit": 2,
"total": 10,
"next": "/search?offset=3&limit=2",
"previous": "/search?offset=0&limit=2"
},
"data": [{"href": "https://api.equinix.com/fabric/v4/connections/57f82f8c-d899-4a21-93ae-5cfe33c50556/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"type": "BGP_IPv4_PREFIX_AGGREGATION",
"uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
"attachmentStatus": "ATTACHED",
"changeLog": {"createdBy": "testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
},
{"href": "https://api.equinix.com/fabric/v4/connections/500589e0-4196-4839-8d43-a0c073b4d747/routeAggregations/4ed45b37-2b26-49de-ab35-4ad039586c7a",
"type": "BGP_IPv4_PREFIX_AGGREGATION",
"uuid": "4ed45b37-2b26-49de-ab35-4ad039586c7a",
"attachmentStatus": "ATTACHED",
"changeLog": {"createdBy": "testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
}
]
}

Route Aggregation Rules

Get Route Aggregation Rules

This API provides capability to get all Route Aggregations Rules for Fabric

Authorizations:

BearerAuth

path Parameters

routeAggregationId

required

string

Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

query Parameters

offset	integer Example: offset=1 offset
limit	integer Example: limit=10 number of records to fetch

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (RouteAggregationRulesData)

List of Route Aggregation Rules

Array

href	string <uri> Route Aggregation Rules URI
type	string Value: "BGP_IPv4_PREFIX_AGGREGATION_RULE" Route Aggregation type
uuid	string <uuid> Route Aggregation Rule identifier
name	string
description	string Customer-provided Route Aggregation Rule description
state	string (RouteAggregationRuleState) Enum: "PROVISIONING" "REPROVISIONING" "DEPROVISIONING" "PROVISIONED" "DEPROVISIONED" "NOT_PROVISIONED" "NOT_DEPROVISIONED" Route Aggregation Rule status
	object (RouteAggregationRulesChange) Current state of latest Route Aggregation Rule change
prefix	string
	object (Changelog) Change log

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 32,
"total": 2,
"next": null,
"previous": null
},
"data": [{"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/65b025ef-022b-4180-85cf-82cfc1ab655b",
"type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
"uuid": "65b025ef-022b-4180-85cf-82cfc1ab655b",
"name": "Private-subnet-aggregation-2",
"description": "Test rule",
"prefix": "192.168.10.0/24",
"state": "PROVISIONED",
"change": {"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/9397f111-19aa-489c-b3c7-349c86818f2d",
"type": "BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION",
"uuid": "9397f111-19aa-489c-b3c7-349c86818f2d"
},
"changeLog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
},
{"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/ea48337b-fe04-4164-a3f0-48d81abf575b",
"type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
"uuid": "ea48337b-fe04-4164-a3f0-48d81abf575b",
"name": "Private-subnet-aggregation-2",
"description": "Test rule",
"prefix": "192.168.20.0/24",
"state": "PROVISIONED",
"change": {"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/9397f111-19aa-489c-b3c7-349c86818f2d",
"type": "BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION",
"uuid": "9397f111-19aa-489c-b3c7-349c86818f2d"
},
"changeLog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
}
]
}

Create Route Aggregation Rule

This API provides capability to create a Route Aggregation Rule

Authorizations:

BearerAuth

path Parameters

routeAggregationId

required

string

Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

Request Body schema: application/json
required

name	string
description	string Customer-provided Route Aggregation Rule description
prefix required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "Private-subnet-aggregation",
"description": "Test rule",
"prefix": "192.168.0.0/24"
}

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403",
"type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
"uuid": "9890d520-1579-4489-8003-154b34b8f403",
"name": "Private-subnet-aggregation",
"state": "PROVISIONING",
"description": "Test rule",
"change": {"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/ff9653dc-88c5-47b5-b552-8a08d2f73f7e",
"type": "BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION",
"uuid": "ff9653dc-88c5-47b5-b552-8a08d2f73f7e"
},
"prefix": "192.168.0.0/24",
"changeLog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "testuser",
"updatedByEmail": "testuser@equinix.com",
"updatedByFullName": "testuser testuser",
"updatedDateTime": "2020-05-21T10:30:00Z"
}
}

Get Route Aggregation Rule by ID

This API provides capability to view a Route Aggregation Rule by UUID

Authorizations:

BearerAuth

path Parameters

routeAggregationId required	string Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Aggregations Id
routeAggregationRuleId required	string Example: 65b025ef-022b-4180-85cf-82cfc1ab655b Route Aggregation Rules Id

Responses

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403",
"type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
"uuid": "9890d520-1579-4489-8003-154b34b8f403",
"name": "Private-subnet-aggregation",
"state": "PROVISIONING",
"description": "Test rule",
"change": {"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/ff9653dc-88c5-47b5-b552-8a08d2f73f7e",
"type": "BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION",
"uuid": "ff9653dc-88c5-47b5-b552-8a08d2f73f7e"
},
"prefix": "192.168.0.0/24",
"changeLog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "testuser",
"updatedByEmail": "testuser@equinix.com",
"updatedByFullName": "testuser testuser",
"updatedDateTime": "2020-05-21T10:30:00Z"
}
}

Delete Route Aggregation Rule

This API provides capability to delete a Route aggregation Rule

Authorizations:

BearerAuth

path Parameters

routeAggregationId required	string Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Aggregations Id
routeAggregationRuleId required	string Example: 65b025ef-022b-4180-85cf-82cfc1ab655b Route Aggregation Rules Id

Responses

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403",
"type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
"uuid": "9890d520-1579-4489-8003-154b34b8f403",
"name": "Private-subnet-aggregation",
"description": "Test rule",
"state": "DEPROVISIONING",
"change": {"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/e8528788-14d3-4a7b-a740-99b702067485",
"type": "BGP_IPv4_PREFIX_AGGREGATION_RULE_DELETION",
"uuid": "e8528788-14d3-4a7b-a740-99b702067485"
},
"prefix": "192.168.0.0/24",
"changeLog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "testuser1",
"updatedByEmail": "testuser@equinix.com",
"updatedByFullName": "testuser testuser",
"updatedDateTime": "2020-05-21T10:30:00Z",
"deletedBy": "testuser1",
"deletedByEmail": "testuser@equinix.com",
"deletedByFullName": "testuser testuser",
"deletedDateTime": "2020-05-21T10:30:00Z"
}
}

Replace Route Aggregation Rule

This API provides capability to replace a Route Aggregation Rule completely

Authorizations:

BearerAuth

path Parameters

routeAggregationId required	string Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Aggregations Id
routeAggregationRuleId required	string Example: 65b025ef-022b-4180-85cf-82cfc1ab655b Route Aggregation Rules Id

Request Body schema: application/json
required

name	string
description	string Customer-provided Route Aggregation Rule description
prefix required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "Private-subnet-aggregation-update",
"description": "Test rule",
"prefix": "192.168.0.0/24"
}

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403",
"type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
"uuid": "9890d520-1579-4489-8003-154b34b8f403",
"name": "Private-subnet-aggregation-update",
"description": "Test rule",
"state": "REPROVISIONING",
"change": {"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/a25ca469-721a-4614-89a9-cdef287aa628",
"type": "BGP_IPv4_PREFIX_AGGREGATION_RULE_UPDATE",
"uuid": "a25ca469-721a-4614-89a9-cdef287aa628"
},
"prefix": "192.168.0.0/24",
"changeLog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "testuser1",
"updatedByEmail": "testuser@equinix.com",
"updatedByFullName": "testuser testuser",
"updatedDateTime": "2020-05-21T10:30:00Z"
}
}

Update Route Aggregation Rule

This API provides capability to partially update a Route Aggregation Rule

Authorizations:

BearerAuth

path Parameters

routeAggregationId required	string Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Aggregations Id
routeAggregationRuleId required	string Example: 65b025ef-022b-4180-85cf-82cfc1ab655b Route Aggregation Rules Id

Request Body schema:
application/json
required

Array (non-empty)

op required	string Handy shortcut for operation name
path required	string path to change
value required	any new value for updated parameter

Responses

Request samples

Payload

Content type

application/json

Example

RouteaggregationRuleName

[{"op": "replace",
"path": "/name",
"value": "test-route-aggregation-name-patch"
}
]

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403",
"type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
"uuid": "9890d520-1579-4489-8003-154b34b8f403",
"name": "Private-subnet-aggregation-update",
"description": "Test rule",
"state": "REPROVISIONING",
"change": {"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/a25ca469-721a-4614-89a9-cdef287aa628",
"type": "BGP_IPv4_PREFIX_AGGREGATION_RULE_UPDATE",
"uuid": "a25ca469-721a-4614-89a9-cdef287aa628"
},
"prefix": "192.168.0.0/24",
"changeLog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "testuser1",
"updatedByEmail": "testuser@equinix.com",
"updatedByFullName": "testuser testuser",
"updatedDateTime": "2020-05-21T10:30:00Z"
}
}

Get Route Aggregation Rule Changes

This API provides capability to retrieve all of a Route Aggregation Rule's Changes

Authorizations:

BearerAuth

path Parameters

routeAggregationId required	string Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Aggregations Id
routeAggregationRuleId required	string Example: 65b025ef-022b-4180-85cf-82cfc1ab655b Route Aggregation Rules Id

query Parameters

offset	integer Example: offset=1 offset
limit	integer Example: limit=10 number of records to fetch

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (RouteAggregationRulesChangeData)

Array

status	string Enum: "COMPLETED" "FAILED" "REQUESTED" Current outcome of the change flow
createdBy	string Created by User Key
createdDateTime	string <date-time> Set when change flow starts
updatedBy	string Updated by User Key
updatedDateTime	string <date-time> Set when change object is updated
	object (RouteAggregationRulesChangeOperation) Route Aggregation Rule change operation data
uuid required	string Uniquely identifies a change
type required	string Enum: "BGP_IPv4_PREFIX_AGGREGATION_RULE_UPDATE" "BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION" "BGP_IPv4_PREFIX_AGGREGATION_RULE_DELETION" Type of change
href	string <uri> Route Aggregation Change URI

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 3,
"next": null,
"previous": null
},
"data": [{"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/ff9653dc-88c5-47b5-b552-8a08d2f73f7e",
"type": "BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION",
"uuid": "ff9653dc-88c5-47b5-b552-8a08d2f73f7e",
"status": "COMPLETED",
"createdBy": "testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "_system",
"updatedDateTime": "2020-05-21T10:30:00Z",
"data": {"op": "add",
"path": "/",
"value": {"name": "Private-subnet-aggregation",
"description": "Test rule",
"prefix": "192.168.0.0/25"
}
}
}
]
}

Get Change By ID

This API provides capability to retrieve a specific Route Aggregation Rule's Changes

Authorizations:

BearerAuth

path Parameters

routeAggregationId required	string Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Aggregations Id
routeAggregationRuleId required	string Example: 65b025ef-022b-4180-85cf-82cfc1ab655b Route Aggregation Rules Id
changeId required	string <uuid> Example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 Route Aggregation Rule Change UUID

Responses

Response Schema: application/json

status

string

Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdBy

string

Created by User Key

createdDateTime

string <date-time>

Set when change flow starts

updatedBy

string

Updated by User Key

updatedDateTime

string <date-time>

Set when change object is updated

object (RouteAggregationRulesChangeOperation)

Route Aggregation Rule change operation data

op

required

string

Enum: "add" "replace" "remove"

Handy shortcut for operation name

path

required

string

path inside document leading to updated parameter

required

object (RouteAggregationRulesBase)

name	string
description	string Customer-provided Route Aggregation Rule description
prefix required	string

uuid

required

string

Uniquely identifies a change

type

required

string

Enum: "BGP_IPv4_PREFIX_AGGREGATION_RULE_UPDATE" "BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION" "BGP_IPv4_PREFIX_AGGREGATION_RULE_DELETION"

Type of change

href

string <uri>

Route Aggregation Change URI

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/ff9653dc-88c5-47b5-b552-8a08d2f73f7e",
"type": "BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION",
"uuid": "ff9653dc-88c5-47b5-b552-8a08d2f73f7e",
"status": "COMPLETED",
"createdBy": "testuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "_system",
"updatedDateTime": "2020-05-21T10:30:00Z",
"data": {"op": "add",
"path": "/",
"value": {"name": "Private-subnet-aggregation",
"description": "Test rule",
"prefix": "192.168.0.0/25"
}
}
}

Bulk Create Route Aggregation Rules

This API provides capability to create bulk route aggregation rules

Authorizations:

BearerAuth

path Parameters

routeAggregationId

required

string

Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

Request Body schema: application/json
required

Array of objects (RouteAggregationRulesBase)

Route Aggregation Rule configuration

Array

name	string
description	string Customer-provided Route Aggregation Rule description
prefix required	string

Responses

Request samples

Payload

Content type

application/json

{"data": [{"name": "Private-subnet-Aggregation",
"description": "string",
"prefix": "192.168.0.0/24"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 32,
"total": 2,
"next": null,
"previous": null
},
"data": [{"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/65b025ef-022b-4180-85cf-82cfc1ab655b",
"type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
"uuid": "65b025ef-022b-4180-85cf-82cfc1ab655b",
"name": "Private-subnet-aggregation-2",
"description": "Test rule",
"prefix": "192.168.10.0/24",
"state": "PROVISIONING",
"change": {"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/9397f111-19aa-489c-b3c7-349c86818f2d",
"type": "BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION",
"uuid": "9397f111-19aa-489c-b3c7-349c86818f2d"
},
"changeLog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
},
{"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/ea48337b-fe04-4164-a3f0-48d81abf575b",
"type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
"uuid": "ea48337b-fe04-4164-a3f0-48d81abf575b",
"name": "Private-subnet-aggregation-2",
"description": "Test rule",
"prefix": "192.168.20.0/24",
"state": "PROVISIONING",
"change": {"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/9397f111-19aa-489c-b3c7-349c86818f2d",
"type": "BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION",
"uuid": "9397f111-19aa-489c-b3c7-349c86818f2d"
},
"changeLog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
}
]
}

Search Route Aggregation Rules

This API provides capability to search Route Aggregation Rules

Authorizations:

BearerAuth

path Parameters

routeAggregationId

required

string

Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Route Aggregations Id

Request Body schema: application/json
required

RouteAggregationRuleAndExpression (object) or RouteAggregationRuleOrExpression (object) (RouteAggregationRulesFilter)

Top-level filter that can be either an AND expression or OR expression

Any of

	Array of RouteAggregationRuleAndExpression (object) or RouteAggregationRuleOrExpression (object) or RouteAggregationRuleSimpleExpression (object) (RouteAggregationRuleExpression) [ 1 .. 8 ] items
Array ([ 1 .. 8 ] items) Any of object RouteAggregationRuleAndExpression Recursive

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (RouteAggregationRuleSortCriteria)

Array

direction	string (RouteAggregationRuleSortDirection) Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string (RouteAggregationRuleSortBy) Default: "/changeLog/updatedDateTime" Enum: "/type" "/uuid" "/name" "/state" "/prefix" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" Possible field names to use on sorting

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (RouteAggregationRulesData)

List of route aggregation rules

Array

href	string <uri> Route Aggregation Rules URI
type	string Value: "BGP_IPv4_PREFIX_AGGREGATION_RULE" Route Aggregation type
uuid	string <uuid> Route Aggregation Rule identifier
name	string
description	string Customer-provided Route Aggregation Rule description
state	string (RouteAggregationRuleState) Enum: "PROVISIONING" "REPROVISIONING" "DEPROVISIONING" "PROVISIONED" "DEPROVISIONED" "NOT_PROVISIONED" "NOT_DEPROVISIONED" Route Aggregation Rule status
	object (RouteAggregationRulesChange) Current state of latest Route Aggregation Rule change
prefix	string
	object (Changelog) Change log

Request samples

Payload

Content type

application/json

Example

SearchRouteAggregationRulesAndRequest

{"filter": {"and": [{"property": "/type",
"operator": "=",
"values": ["BGP_IPv4_PREFIX_AGGREGATION_RULE"
]
},
{"property": "/state",
"operator": "=",
"values": ["PROVISIONED"
]
},
{"or": [{"property": "/name",
"operator": "LIKE",
"values": ["%Demo%"
]
},
{"property": "/name",
"operator": "LIKE",
"values": ["%Production%"
]
}
]
},
{"or": [{"property": "/prefix",
"operator": "=",
"values": ["192.168.2.0/24"
]
}
]
}
]
},
"pagination": {"offset": 0,
"limit": 20
},
"sort": [{"property": "/changeLog/updatedDateTime",
"direction": "DESC"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 1,
"limit": 2,
"total": 10,
"next": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/search?offset=3&limit=2",
"previous": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/search?offset=0&limit=2"
},
"data": [{"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/65b025ef-022b-4180-85cf-82cfc1ab655b",
"type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
"uuid": "65b025ef-022b-4180-85cf-82cfc1ab655b",
"name": "Route_Aggregation_Rule_Demo1",
"description": "Test rule1",
"prefix": "192.168.10.0/24",
"state": "PROVISIONED",
"changeLog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
},
{"href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/ea48337b-fe04-4164-a3f0-48d81abf575b",
"type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
"uuid": "ea48337b-fe04-4164-a3f0-48d81abf575b",
"name": "Route_Aggregation_Rule_Demo2",
"description": "Test rule2",
"prefix": "192.168.20.0/24",
"state": "PROVISIONED",
"changeLog": {"createdBy": "testuser",
"createdByEmail": "testuser@equinix.com",
"createdByFullName": "testuser testuser",
"createdDateTime": "2020-05-21T10:30:00Z"
}
}
]
}

Precision Time Packages

Get Packages

The API provides capability to get timing service's packages

Authorizations:

BearerAuth

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (precisionTimePackageRespose)

Data returned from the API call

Array

href	string <uri>
type required	string Value: "TIME_SERVICE_PACKAGE"
code required	string Enum: "NTP_STANDARD" "NTP_ENTERPRISE" "PTP_STANDARD" "PTP_ENTERPRISE"
bandwidth required	integer Connection bandwidth in Mbps.
clientsPerSecondMax	integer >= 0 Max. number of clients that can be synchronized per second at a packet rate of 1 per second.
redundancySupported	boolean Is Redundant virtual connection supported for the package code.
multiSubnetSupported	boolean Is Multiple subnet supported for the package code.
accuracySlaUnit	string Accuracy SLA unit.
accuracySla	integer Accuracy SLA for the package code, -1 value denotes the accuracySla is not published.
accuracySlaMin	integer >= 1 Typical minimum Accuracy for the package code.
accuracySlaMax	integer >= 1 Typical maximum Accuracy for the package code.
	object (Changelog) Change log

Response samples

200
415
500

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 4
},
"data": [{"href": "https://api.equinix.com/fabric/v4/timeServicePackages/NTP_STANDARD",
"type": "TIME_SERVICE_PACKAGE",
"code": "NTP_STANDARD",
"bandwidth": 1,
"clientsPerSecondMax": 1000,
"accuracySlaUnit": "microseconds",
"accuracySla": -1,
"accuracySlaMin": 1,
"accuracySlaMax": 100,
"redundancySupported": false,
"multiSubnetSupported": false,
"changelog": {"createdDateTime": "2023-05-16T07:50:49.749Z",
"updatedDateTime": "2023-05-17T07:50:49.749Z"
}
},
{"href": "https://api.equinix.com/fabric/v4/timeServicePackages/NTP_ENTERPRISE",
"type": "TIME_SERVICE_PACKAGE",
"code": "NTP_ENTERPRISE",
"bandwidth": 5,
"clientsPerSecondMax": 2000,
"accuracySlaUnit": "microseconds",
"accuracySla": -1,
"accuracySlaMin": 1,
"accuracySlaMax": 100,
"redundancySupported": false,
"multiSubnetSupported": true,
"changelog": {"createdDateTime": "2023-05-16T07:50:49.749Z",
"updatedDateTime": "2023-05-17T07:50:49.749Z"
}
},
{"href": "https://api.equinix.com/fabric/v4/timeServicePackages/PTP_STANDARD",
"type": "TIME_SERVICE_PACKAGE",
"code": "PTP_STANDARD",
"bandwidth": 5,
"clientsPerSecondMax": 20,
"accuracySlaUnit": "microseconds",
"accuracySla": 50,
"accuracySlaMin": 1,
"accuracySlaMax": 10,
"redundancySupported": false,
"multiSubnetSupported": true,
"changelog": {"createdDateTime": "2023-05-16T07:50:49.749Z",
"updatedDateTime": "2023-05-17T07:50:49.749Z"
}
},
{"href": "https://api.equinix.com/fabric/v4/timeServicePackages/PTP_ENTERPRISE",
"type": "TIME_SERVICE_PACKAGE",
"code": "PTP_ENTERPRISE",
"bandwidth": 10,
"clientsPerSecondMax": 100,
"accuracySlaUnit": "microseconds",
"accuracySla": 50,
"accuracySlaMin": 1,
"accuracySlaMax": 10,
"redundancySupported": false,
"multiSubnetSupported": true,
"changelog": {"createdDateTime": "2023-05-16T07:50:49.749Z",
"updatedDateTime": "2023-05-17T07:50:49.749Z"
}
}
]
}

Get Package By Code

The API provides capability to get timing service's package by code

Authorizations:

BearerAuth

path Parameters

packageCode

required

string

Enum: "NTP_STANDARD" "NTP_ENTERPRISE" "PTP_STANDARD" "PTP_ENTERPRISE"

Package Code

Responses

Response Schema: application/json

href

string <uri>

type

required

string

Value: "TIME_SERVICE_PACKAGE"

code

required

string

Enum: "NTP_STANDARD" "NTP_ENTERPRISE" "PTP_STANDARD" "PTP_ENTERPRISE"

bandwidth

required

integer

Connection bandwidth in Mbps.

clientsPerSecondMax

integer >= 0

Max. number of clients that can be synchronized per second at a packet rate of 1 per second.

redundancySupported

boolean

Is Redundant virtual connection supported for the package code.

multiSubnetSupported

boolean

Is Multiple subnet supported for the package code.

accuracySlaUnit

string

Accuracy SLA unit.

accuracySla

integer

Accuracy SLA for the package code, -1 value denotes the accuracySla is not published.

accuracySlaMin

integer >= 1

Typical minimum Accuracy for the package code.

accuracySlaMax

integer >= 1

Typical maximum Accuracy for the package code.

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

Response samples

200
415
500

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/timeServicePackages/NTP_STANDARD",
"type": "TIME_SERVICE_PACKAGE",
"code": "NTP_STANDARD",
"bandwidth": 10,
"clientsPerSecondMax": 100,
"accuracySlaUnit": "microseconds",
"accuracySla": 50,
"accuracySlaMin": 1,
"accuracySlaMax": 10,
"redundancySupported": true,
"multiSubnetSupported": true,
"changelog": {"createdDateTime": "2023-05-16T07:50:49.749Z",
"updatedDateTime": "2023-05-17T07:50:49.749Z"
}
}

Precision Time Services

Create Time Service

The API provides capability to create Precision Time service

Authorizations:

BearerAuth

Request Body schema: application/json
required

type

required

string

Enum: "NTP" "PTP"

Precision Time Service Type refers to the corresponding Protocol.

name

required

string

Precision Time Service name.

required

object (precisionTimePackageRequest)

Precision Time Service Level Request

code

required

string

Enum: "NTP_STANDARD" "NTP_ENTERPRISE" "PTP_STANDARD" "PTP_ENTERPRISE"

Precision Time Service Level

required

Array of objects (fabricConnectionUuid)

Array

type	string Connection Type
uuid required	string <uuid> Connection UUID.

required

object (ipv4)

EPT service network information

primary required	string <ipv4> Primary Timing Server IP Address
secondary required	string <ipv4> Secondary Timing Server IP Address
networkMask required	string <ipv4> Network Mask
defaultGateway	string <ipv4> Gateway Interface IP address

Array of objects (ntpAdvanceConfiguration)

NTP Advanced configuration - MD5 Authentication.

Array

type	string Enum: "ASCII" "HEX"
keyNumber	integer [ 1 .. 65535 ] The authentication Key ID.
key	string <byte> ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[... The plaintext authentication key. Must be Base64 encoded. For ASCII type, the key must contain printable ASCII characters, range 10-20 characters. For HEX type, range should be 10-40 characters.

object (ptpAdvanceConfiguration)

PTP Advanced Configuration.

timeScale	string Enum: "ARB" "PTP" Time Scale value, ARB denotes Arbitrary and PTP denotes Precision Time Protocol.
domain	integer [ 0 .. 127 ] The PTP domain value.
priority1	integer [ 0 .. 248 ] The priority1 value determines the best primary clock, Lower value indicates higher priority.
priority2	integer [ 0 .. 248 ] The priority2 value differentiates and prioritizes the primary clock to avoid confusion when priority1-value is the same for different primary clocks in a network.
logAnnounceInterval	integer Enum: -3 -2 -1 0 1 Logarithmic value that controls the rate of PTP Announce packets from the PTP time server. Default is 1 (1 packet every 2 seconds), Unit packets/second.
logSyncInterval	integer Enum: -5 -4 -3 -2 -1 0 1 Logarithmic value that controls the rate of PTP Sync packets. Default is -4 (16 packets per second), Unit packets/second..
logDelayReqInterval	integer Enum: -5 -4 -3 -2 -1 0 1 Logarithmic value that controls the rate of PTP DelayReq packets. Default is -4 (16 packets per second), Unit packets/second..
transportMode	string Enum: "MULTICAST" "UNICAST" "HYBRID"
grantTime	integer [ 30 .. 7200 ] Unicast Grant Time in seconds. For Multicast and Hybrid transport modes, grant time defaults to 300 seconds. For Unicast mode, grant time can be between 30 to 7200.

object (Project)

projectId

required

string

Subscriber-assigned project ID

object (precisionTimeOrder)

Precision Time Order

purchaseOrderNumber	string Purchase order number
customerReferenceNumber	string Customer reference number
orderNumber	string Order Reference Number

Responses

Request samples

Payload

Content type

application/json

Example

ntpStandard

{"type": "NTP",
"name": "EPT-NTP-Service",
"connections": [{"uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0"
}
],
"package": {"code": "NTP_STANDARD"
},
"ipv4": {"primary": "192.168.0.2",
"secondary": "192.168.0.3",
"networkMask": "255.255.255.255",
"defaultGateway": "192.167.0.1"
}
}

Response samples

Content type

application/json

Example

ntpStandard

{"href": "https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011",
"type": "NTP",
"uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
"name": "EPT-NTP-Service",
"state": "PROVISIONING",
"connections": [{"href": "https://api.equinix.com/fabric/v4/connections/06dbb0e3-e55d-4090-8aff-fc5654abaad0",
"type": "EVPL_VC",
"uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0",
"aSide": {"accessPoint": {"type": "COLO",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/NY",
"metroCode": "NY",
"ibx": "NY1"
}
}
},
"zSide": {"accessPoint": {"type": "SP",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/NY",
"metroCode": "NY"
}
}
}
}
],
"package": {"href": "https://api.equinix.com/fabric/v4/timeServicePackages/NTP_STANDARD",
"code": "NTP_STANDARD"
},
"ipv4": {"primary": "192.168.0.2",
"secondary": "192.168.0.3",
"networkMask": "255.255.255.255",
"defaultGateway": "192.167.0.1"
},
"account": {"accountNumber": 123456
},
"changeLog": {"createdByEmail": "abc@xyz.com",
"createdDateTime": "2024-08-24T06:50:46Z",
"updatedByEmail": "abc@xyz.com",
"updatedDateTime": "2024-08-24T06:51:46Z"
}
}

Update Time Service

The API provides capability to Configure/Fulfill the Precision Time Service

Authorizations:

BearerAuth

path Parameters

serviceId

required

string <uuid>

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

Service UUID

Request Body schema: application/json
required

type

required

string

Enum: "NTP" "PTP"

Precision Time Service Type refers to the corresponding Protocol.

name

required

string

Precision Time Service name.

required

object (precisionTimePackageRequest)

Precision Time Service Level Request

code

required

string

Enum: "NTP_STANDARD" "NTP_ENTERPRISE" "PTP_STANDARD" "PTP_ENTERPRISE"

Precision Time Service Level

required

Array of objects (fabricConnectionUuid)

Array

type	string Connection Type
uuid required	string <uuid> Connection UUID.

required

object (ipv4)

EPT service network information

primary required	string <ipv4> Primary Timing Server IP Address
secondary required	string <ipv4> Secondary Timing Server IP Address
networkMask required	string <ipv4> Network Mask
defaultGateway	string <ipv4> Gateway Interface IP address

Array of objects (ntpAdvanceConfiguration)

NTP Advanced configuration - MD5 Authentication.

Array

type	string Enum: "ASCII" "HEX"
keyNumber	integer [ 1 .. 65535 ] The authentication Key ID.
key	string <byte> ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[... The plaintext authentication key. Must be Base64 encoded. For ASCII type, the key must contain printable ASCII characters, range 10-20 characters. For HEX type, range should be 10-40 characters.

object (ptpAdvanceConfiguration)

PTP Advanced Configuration.

timeScale	string Enum: "ARB" "PTP" Time Scale value, ARB denotes Arbitrary and PTP denotes Precision Time Protocol.
domain	integer [ 0 .. 127 ] The PTP domain value.
priority1	integer [ 0 .. 248 ] The priority1 value determines the best primary clock, Lower value indicates higher priority.
priority2	integer [ 0 .. 248 ] The priority2 value differentiates and prioritizes the primary clock to avoid confusion when priority1-value is the same for different primary clocks in a network.
logAnnounceInterval	integer Enum: -3 -2 -1 0 1 Logarithmic value that controls the rate of PTP Announce packets from the PTP time server. Default is 1 (1 packet every 2 seconds), Unit packets/second.
logSyncInterval	integer Enum: -5 -4 -3 -2 -1 0 1 Logarithmic value that controls the rate of PTP Sync packets. Default is -4 (16 packets per second), Unit packets/second..
logDelayReqInterval	integer Enum: -5 -4 -3 -2 -1 0 1 Logarithmic value that controls the rate of PTP DelayReq packets. Default is -4 (16 packets per second), Unit packets/second..
transportMode	string Enum: "MULTICAST" "UNICAST" "HYBRID"
grantTime	integer [ 30 .. 7200 ] Unicast Grant Time in seconds. For Multicast and Hybrid transport modes, grant time defaults to 300 seconds. For Unicast mode, grant time can be between 30 to 7200.

object (Project)

projectId

required

string

Subscriber-assigned project ID

object (precisionTimeOrder)

Precision Time Order

purchaseOrderNumber	string Purchase order number
customerReferenceNumber	string Customer reference number
orderNumber	string Order Reference Number

Responses

Request samples

Payload

Content type

application/json

Example

ntpStandard

{"type": "NTP",
"name": "EPT-Standard-Service",
"connections": [{"uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0"
}
],
"package": {"code": "NTP_STANDARD"
},
"ipv4": {"primary": "192.168.0.2",
"secondary": "192.168.0.3",
"networkMask": "255.255.255.255",
"defaultGateway": "192.167.0.1"
}
}

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011",
"type": "NTP",
"uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
"name": "EPT-NTP-Service",
"state": "PROVISIONING",
"connections": [{"href": "https://api.equinix.com/fabric/v4/connections/06dbb0e3-e55d-4090-8aff-fc5654abaad0",
"type": "EVPL_VC",
"uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0",
"aSide": {"accessPoint": {"type": "COLO",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/NY",
"metroCode": "NY",
"ibx": "NY1"
}
}
},
"zSide": {"accessPoint": {"type": "SP",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/NY",
"metroCode": "NY"
}
}
}
}
],
"package": {"href": "https://api.equinix.com/fabric/v4/timeServicePackages/NTP_STANDARD",
"code": "NTP_STANDARD"
},
"ipv4": {"primary": "192.168.0.2",
"secondary": "192.168.0.3",
"networkMask": "255.255.255.255",
"defaultGateway": "192.167.0.1"
},
"account": {"accountNumber": 123456
},
"order": {"orderNumber": "1-129105284100"
},
"changeLog": {"createdByEmail": "abc@xyz.com",
"createdDateTime": "2024-08-24T06:50:46Z",
"updatedByEmail": "abc@xyz.com",
"updatedDateTime": "2024-08-24T06:51:46Z"
}
}

Get Time Service by ID

The API provides capability to get Precision Time Service details

Authorizations:

BearerAuth

path Parameters

serviceId

required

string <uuid>

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

Service UUID

Responses

Response Schema: application/json

href

required

string <uri>

Precision Time Service URI.

type

required

string

Enum: "NTP" "PTP"

Precision Time Service type refers to the corresponding protocol.

name

string

Precision Time Service Name.

uuid

required

string <uuid>

Precision Time Service UUID.

state

required

string

Enum: "CANCELLED" "CANCELLING" "CONFIGURING" "CONFIGURING_FAILED" "DRAFT" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "PROVISIONED" "PROVISIONING" "PROVISIONING_FAILED" "REPROVISIONING" "REPROVISIONING_FAILED"

Precision Time Service Status.

object (timeServiceOperation)

time service operational data

operationalStatus

string

Enum: "UP" "DOWN" "DEGRADED"

time service operational status

required

object (precisionTimePackagePostResponse)

href	string <uri>
code required	string Enum: "NTP_STANDARD" "NTP_ENTERPRISE" "PTP_STANDARD" "PTP_ENTERPRISE"

Array of objects (fabricConnectionResponse) [ 1 .. 2 ] items unique

Fabric Connections associated with Precision Time Service.

Array ([ 1 .. 2 ] items)

href	string <uri> Connection URI
type	string Connection Type.
uuid	string <uuid> Connection UUID.
	object (fabricConnectionAccessPoint) Fabric Connection access point object.
	object (fabricConnectionAccessPoint) Fabric Connection access point object.

object (ipv4)

EPT service network information

primary required	string <ipv4> Primary Timing Server IP Address
secondary required	string <ipv4> Secondary Timing Server IP Address
networkMask required	string <ipv4> Network Mask
defaultGateway	string <ipv4> Gateway Interface IP address

Array of objects (ntpAdvanceConfiguration)

NTP Advanced configuration - MD5 Authentication.

Array

type	string Enum: "ASCII" "HEX"
keyNumber	integer [ 1 .. 65535 ] The authentication Key ID.
key	string <byte> ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[... The plaintext authentication key. Must be Base64 encoded. For ASCII type, the key must contain printable ASCII characters, range 10-20 characters. For HEX type, range should be 10-40 characters.

object (ptpAdvanceConfiguration)

PTP Advanced Configuration.

timeScale	string Enum: "ARB" "PTP" Time Scale value, ARB denotes Arbitrary and PTP denotes Precision Time Protocol.
domain	integer [ 0 .. 127 ] The PTP domain value.
priority1	integer [ 0 .. 248 ] The priority1 value determines the best primary clock, Lower value indicates higher priority.
priority2	integer [ 0 .. 248 ] The priority2 value differentiates and prioritizes the primary clock to avoid confusion when priority1-value is the same for different primary clocks in a network.
logAnnounceInterval	integer Enum: -3 -2 -1 0 1 Logarithmic value that controls the rate of PTP Announce packets from the PTP time server. Default is 1 (1 packet every 2 seconds), Unit packets/second.
logSyncInterval	integer Enum: -5 -4 -3 -2 -1 0 1 Logarithmic value that controls the rate of PTP Sync packets. Default is -4 (16 packets per second), Unit packets/second..
logDelayReqInterval	integer Enum: -5 -4 -3 -2 -1 0 1 Logarithmic value that controls the rate of PTP DelayReq packets. Default is -4 (16 packets per second), Unit packets/second..
transportMode	string Enum: "MULTICAST" "UNICAST" "HYBRID"
grantTime	integer [ 30 .. 7200 ] Unicast Grant Time in seconds. For Multicast and Hybrid transport modes, grant time defaults to 300 seconds. For Unicast mode, grant time can be between 30 to 7200.

object (Project)

projectId

required

string

Subscriber-assigned project ID

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

object (precisionTimeOrder)

Precision Time Order

purchaseOrderNumber	string Purchase order number
customerReferenceNumber	string Customer reference number
orderNumber	string Order Reference Number

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

Response samples

Content type

application/json

Example

ntpStandardOriginPort

{"href": "https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011",
"type": "NTP",
"uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
"name": "EPT-NTP-Service",
"state": "PROVISIONED",
"operation": {"operationalStatus": "UP"
},
"connections": [{"href": "https://api.equinix.com/fabric/v4/connections/06dbb0e3-e55d-4090-8aff-fc5654abaad0",
"type": "EVPL_VC",
"uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0",
"aSide": {"accessPoint": {"type": "COLO",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/NY",
"metroCode": "NY",
"ibx": "NY1"
}
}
},
"zSide": {"accessPoint": {"type": "SP",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/NY",
"metroCode": "NY"
}
}
}
}
],
"package": {"href": "https://api.equinix.com/fabric/v4/timeServicePackages/NTP_STANDARD",
"code": "NTP_STANDARD"
},
"ipv4": {"primary": "192.168.0.2",
"secondary": "192.168.0.3",
"networkMask": "255.255.255.255",
"defaultGateway": "192.167.0.1"
},
"order": {"orderNumber": "1-129105284100"
},
"account": {"accountNumber": 123456
},
"changeLog": {"createdByEmail": "abc@xyz.com",
"createdDateTime": "2024-08-24T06:50:46Z",
"updatedByEmail": "abc@xyz.com",
"updatedDateTime": "2024-08-24T06:51:46Z"
}
}

Update Time Service by ID

The API provides capability to update Precision Time Service by service id

Authorizations:

BearerAuth

path Parameters

serviceId

required

string <uuid>

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

Service UUID

Request Body schema: application/json-patch+json
required

Array (= 1 items)

op required	string Enum: "replace" "add" "remove" Handy shortcut for operation name
path required	string Enum: "/name" "/package/code" "/ipv4" "/ntpAdvancedConfiguration" "/ptpAdvancedConfiguration" path inside document leading to updated parameter
value required	any new value for updated parameter

Responses

Request samples

Payload

Content type

application/json-patch+json

Example

updateName

[{"op": "replace",
"path": "/name",
"value": "Updated-Service-Name"
}
]

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011",
"type": "NTP",
"uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
"name": "EPT-NTP-Service",
"state": "REPROVISIONING",
"operation": {"operationalStatus": "UP"
},
"connections": [{"href": "https://api.equinix.com/fabric/v4/connections/06dbb0e3-e55d-4090-8aff-fc5654abaad0",
"type": "EVPL_VC",
"uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0",
"aSide": {"accessPoint": {"type": "COLO",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/NY",
"metroCode": "NY",
"ibx": "NY1"
}
}
},
"zSide": {"accessPoint": {"type": "SP",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/NY",
"metroCode": "NY"
}
}
}
}
],
"package": {"href": "https://api.equinix.com/fabric/v4/timeServicePackages/NTP_STANDARD",
"code": "NTP_STANDARD"
},
"ipv4": {"primary": "192.168.0.2",
"secondary": "192.168.0.3",
"networkMask": "255.255.255.255",
"defaultGateway": "192.167.0.1"
},
"account": {"accountNumber": 123456
},
"order": {"orderNumber": "1-129105284100"
},
"changeLog": {"createdByEmail": "abc@xyz.com",
"createdDateTime": "2024-08-24T06:50:46Z",
"updatedByEmail": "abc@xyz.com",
"updatedDateTime": "2024-08-24T06:51:46Z"
}
}

Delete Time Service by ID

The API provides capability to delete Precision Time Service by service id

Authorizations:

BearerAuth

path Parameters

serviceId

required

string <uuid>

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

Service UUID

Responses

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011",
"type": "NTP",
"uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
"name": "EPT-NTP-Service",
"state": "DEPROVISIONING",
"operation": {"operationalStatus": "UP"
},
"connections": [{"href": "https://api.equinix.com/fabric/v4/connections/06dbb0e3-e55d-4090-8aff-fc5654abaad0",
"type": "EVPL_VC",
"uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0",
"aSide": {"accessPoint": {"type": "COLO",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/NY",
"metroCode": "NY",
"ibx": "NY1"
}
}
},
"zSide": {"accessPoint": {"type": "SP",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/NY",
"metroCode": "NY"
}
}
}
}
],
"package": {"href": "https://api.equinix.com/fabric/v4/timeServicePackages/NTP_STANDARD",
"code": "NTP_STANDARD"
},
"ipv4": {"primary": "192.168.0.2",
"secondary": "192.168.0.3",
"networkMask": "255.255.255.255",
"defaultGateway": "192.167.0.1"
},
"account": {"accountNumber": 123456
},
"order": {"orderNumber": "1-216720438646"
},
"changeLog": {"createdByEmail": "abc@xyz.com",
"createdDateTime": "2024-08-24T06:50:46Z",
"updatedByEmail": "abc@xyz.com",
"updatedDateTime": "2024-08-24T06:51:46Z",
"deletedByEmail": "abc@xyz.com",
"deletedDateTime": "2024-08-24T06:52:46Z"
}
}

Search Time Services

The API provides capability to get list of user's Time Services using search criteria, including optional filtering, pagination and sorting

Authorizations:

BearerAuth

Request Body schema: application/json
required

object (TimeServiceFilters)

Array of TimeServiceSimpleExpression (object) or TimeServiceOrFilter (object) (TimeServiceFilter) <= 8 items

Array (<= 8 items)

Any of

property	string Possible field names to use on filters: `/project/projectId` - project id (mandatory) `/name` - Precision Time Service name `/uuid` - Precision Time Service uuid `/type` - Precision Time Service protocol `/state` - Precision Time Service status `/account/accountNumber` - Precision Time Service account number `/package/code` - Precision Time Service package `/*` - all-category search
operator	string Possible operators to use on filters: `=` - equal `!=` - not equal `[NOT] BETWEEN` - (not) between `[NOT] LIKE` - (not) like `[NOT] IN` - (not) in `ILIKE` - case-insensitive like
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (TimeServiceSortCriteria)

Array

direction	string (TimeServiceSortDirection) Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string (TimeServiceSortBy) Default: "/changeLog/updatedDateTime" Enum: "/name" "/uuid" "/state" "/type" "/package/code" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" Possible field names to use on sorting

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (precisionTimeServiceResponse)

Data returned from the API call.

Array

href required	string <uri> Precision Time Service URI.
type required	string Enum: "NTP" "PTP" Precision Time Service type refers to the corresponding protocol.
name	string Precision Time Service Name.
uuid required	string <uuid> Precision Time Service UUID.
state required	string Enum: "CANCELLED" "CANCELLING" "CONFIGURING" "CONFIGURING_FAILED" "DRAFT" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "PROVISIONED" "PROVISIONING" "PROVISIONING_FAILED" "REPROVISIONING" "REPROVISIONING_FAILED" Precision Time Service Status.
	object (timeServiceOperation) time service operational data
required	object (precisionTimePackagePostResponse)
	Array of objects (fabricConnectionResponse) [ 1 .. 2 ] items unique Fabric Connections associated with Precision Time Service.
	object (ipv4) EPT service network information
	Array of objects (ntpAdvanceConfiguration) NTP Advanced configuration - MD5 Authentication.
	object (ptpAdvanceConfiguration) PTP Advanced Configuration.
	object (Project)
	object (SimplifiedAccount)
	object (precisionTimeOrder) Precision Time Order
	object (Changelog) Change log

Request samples

Payload

Content type

application/json

Example

SearchFilterByStatus

{"filter": {"and": [{"property": "/state",
"operator": "=",
"values": ["PROVISIONED"
]
},
{"property": "/project/projectId",
"operator": "=",
"values": ["995072000433550"
]
}
]
},
"pagination": {"offset": 0,
"limit": 20
},
"sort": [{"direction": "DESC",
"property": "/changeLog/createdDateTime"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 20,
"limit": 20,
"total": 100,
"next": "/search?offset=40&limit=20",
"previous": "/search?offset=0&limit=20"
},
"data": [{"href": "https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011",
"type": "NTP",
"uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
"name": "EPT-NTP-STD-Service",
"state": "PROVISIONING",
"connections": [{"href": "https://api.equinix.com/fabric/v4/connections/06dbb0e3-e55d-4090-8aff-fc5654abaad0",
"type": "EVPL_VC",
"uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0",
"aSide": {"accessPoint": {"type": "COLO",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/NY",
"metroCode": "NY",
"ibx": "NY1"
}
}
},
"zSide": {"accessPoint": {"type": "SP",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/NY",
"metroCode": "NY"
}
}
}
}
],
"package": {"href": "https://api.equinix.com/fabric/v4/timeServicePackages/NTP_STANDARD",
"code": "NTP_STANDARD"
},
"ipv4": {"primary": "192.168.0.2",
"secondary": "192.168.0.3",
"networkMask": "255.255.255.255",
"defaultGateway": "192.167.0.1"
},
"account": {"accountNumber": 123456
},
"changeLog": {"createdByEmail": "abc@xyz.com",
"createdDateTime": "2024-08-24T06:50:46Z",
"updatedByEmail": "abc@xyz.com",
"updatedDateTime": "2024-08-24T06:51:46Z"
}
}
]
}

Get Connection Links

The API provides capability to get prevision timing service's details

Authorizations:

BearerAuth

path Parameters

serviceId

required

string <uuid>

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

Service UUID

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (connectionLink)

Data returned from the API call

Array

href	string <uri>
type	string Value: "EVPL_VC"
uuid	string <uuid>

Response samples

200
401
403
415
500

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 2
},
"data": [{"href": "https://api.equinix.com/fabric/v4/connections/92dc376a-a932-43aa-a6a2-c806dedbd784",
"type": "EVPL_VC",
"uuid": "92dc376a-a932-43aa-a6a2-c806dedbd784"
},
{"href": "https://api.equinix.com/fabric/v4/connections/42dc376a-a932-43aa-a6a2-d806dedbd783",
"type": "EVPL_VC",
"uuid": "42dc376a-a932-43aa-a6a2-d806dedbd783"
}
]
}

Internet Access Services

Equinix Internet Access (EIA) ^Beta

Create Internet Access Service

Creates Internet Access Service

Authorizations:

BearerAuth

Request Body schema: application/json
required

type

required

string (InternetAccessServiceType)

Enum: "SINGLE_IA" "DUAL_IA"

Type of the service, either single or dual internet access

name

required

string

The name of the EIA Service

bandwidth

integer

Bandwidth of the service

bandwidthCommit

integer

Minimum bandwidth commit for burst billing variant of the service

required

object (InternetAccessRoutingProtocolRequest)

type

required

string (InternetAccessRoutingProtocolType)

BGP

required

Array of objects (InternetAccessCustomerRouteRequest) [ 1 .. 100 ] items

Array ([ 1 .. 100 ] items)

required

object (InternetAccessIpBlockRequest)

uuid

required

string <uuid>

Unique identifier for the IP Block

required

Array of objects (InternetAccessConnectionBgpRequest) [ 1 .. 2 ] items

Array ([ 1 .. 2 ] items)

uuid

required

string <uuid>

Unique identifier for the connection

exportPolicy

required

string (InternetAccessExportPolicy)

Enum: "FULL" "DEFAULT" "FULL_DEFAULT" "PARTIAL"

Denotes which routes should be advertised to the internet

object

uuid

required

string <uuid>

Unique identifier of the ASN

customerAsn

integer <int64>

Deprecated

Customer ASN. Valid range is 1-64495 or 65536-4199999999.

bgpAuthKey

string

BGP authentication key

customerAsnRange

string (InternetAccessCustomerAsnRange)

Enum: "BITS_16" "BITS_32"

Customer Autonomous System Number range. Based on the value a proper private ASN will be generated.

object (InternetAccessOrderRequest)

purchaseOrderNumber	string or null Purchase order number
orderNumber	string or null Order Number
orderLine	string or null Order Line Number

required

object

type

required

string (InternetAccessBillingType)

Enum: "FIXED" "USAGE_BASED" "BURST_BASED"

required

object (Project)

projectId

required

string

Subscriber-assigned project ID

required

object (InternetAccessAccount)

accountNumber required	string Account number
href	string <uri> Account URL path

Responses

Request samples

Payload

Content type

application/json

{"type": "SINGLE_IA",
"name": "internet-access-primary",
"bandwidth": 1000,
"routingProtocol": {"type": "BGP",
"exportPolicy": "FULL",
"asn": {"uuid": "5dd81532-c313-35ba-8a0f-be05fb275fa1"
},
"connections": [{"uuid": "6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671"
}
],
"customerRoutes": [{"ipBlock": {"uuid": "fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92"
}
}
]
},
"billing": {"type": "FIXED"
},
"project": {"projectId": "44f4c4f8-2f39-494e-838c-d8e640591be5"
},
"account": {"accountNumber": "57689234"
},
"order": {"purchaseOrderNumber": "PO-98765"
}
}

Response samples

202
400
403
500

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4",
"type": "SINGLE_IA",
"uuid": "673c6e6c-2c36-4488-b3f1-47064357b5b4",
"name": "internet-access-primary",
"state": "PROVISIONING",
"change": {"href": "https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4/cloudEvents"
},
"routingProtocol": {"type": "BGP",
"exportPolicy": "FULL",
"asn": {"href": "https://api.equinix.com/fabric/v4/asns/5dd81532-c313-35ba-8a0f-be05fb275fa1",
"uuid": "5dd81532-c313-35ba-8a0f-be05fb275fa1"
},
"customerRoutes": [{"ipBlock": {"href": "https://api.equinix.com/fabric/v4/ipBlocks/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92",
"uuid": "fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92"
}
}
],
"connections": [{"href": "https://api.equinix.com/fabric/v4/connections/6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671",
"uuid": "6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671"
}
]
},
"billing": {"type": "FIXED",
"enabled": true,
"startDate": "2026-04-16T00:00:00Z"
},
"account": {"accountNumber": "57689234",
"href": "https://api.equinix.com/billing/v2/billingAccounts/accountNumber/57689234"
},
"project": {"projectId": "44f4c4f8-2f39-494e-838c-d8e640591be5"
},
"order": {"href": "https://api.equinix.com/colocations/v2/orders/100200300",
"orderNumber": 100200300,
"purchaseOrderNumber": "PO-98765"
},
"changeLog": {"createdBy": "api-user",
"createdDateTime": "2026-04-16T00:00:00Z",
"updatedBy": "api-user",
"updatedDateTime": "2026-04-16T00:00:01Z"
},
"useCase": "MAIN"
}

Search Internet Access Services

Search for Internet Access Services

Authorizations:

BearerAuth

Request Body schema: application/json
required

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

object (SearchExpression)

and	Array of objects (SearchExpressions)
or	Array of objects (SearchExpressions)
property	string
operator	string Enum: "=" "!=" ">" ">=" "<" "<=" "BETWEEN" "NOT BETWEEN" "LIKE" "NOT LIKE" "IN" "NOT IN" "IS NOT NULL" "IS NULL"
values	Array of strings

Array of objects (SearchSort)

Array

direction required	string Enum: "ASC" "DESC"
property required	string

Responses

Response Schema: application/json

required

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

required

Array of objects (SearchSort)

Array

direction required	string Enum: "ASC" "DESC"
property required	string

required

Array of objects (InternetAccessService)

Array

href required	string <uri> Service URL path
type required	string (InternetAccessServiceType) Enum: "SINGLE_IA" "DUAL_IA" Type of the service, either single or dual internet access
uuid required	string <uuid> Unique identifier for the EIA Service
name required	string The name of the EIA Service
bandwidth	integer Bandwidth of the service
bandwidthCommit	integer Minimum bandwidth commit for burst billing variant of the service
state required	string (InternetAccessServiceState) Enum: "PROVISIONING" "PROVISIONED" "FAILED" "DEPROVISIONING" "DEPROVISIONED" Current state of the service
required	object (InternetAccessChange)
	Array of objects (InternetAccessLocation) List of locations associated with the service
required	object (InternetAccessRoutingProtocol)
required	object (InternetAccessBilling)
required	object (InternetAccessAccount)
required	object (Project)
required	object (InternetAccessOrder)
required	object (Changelog) Change log
useCase required	string (InternetAccessUseCase) Enum: "MAIN" "MANAGEMENT_ACCESS"

Request samples

Payload

Content type

application/json

{"filter": {"and": [{"property": "/project/projectId",
"operator": "=",
"values": ["44f4c4f8-2f39-494e-838c-d8e640591be5"
]
}
]
},
"pagination": {"offset": 0,
"limit": 20
},
"sort": [{"direction": "DESC",
"property": "/changeLog/updatedDateTime"
}
]
}

Response samples

200
400
403
500

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 1
},
"sort": [{"direction": "DESC",
"property": "/changeLog/updatedDateTime"
}
],
"data": [{"href": "https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4",
"type": "SINGLE_IA",
"uuid": "673c6e6c-2c36-4488-b3f1-47064357b5b4",
"name": "internet-access-primary",
"state": "PROVISIONED",
"change": {"href": "https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4/cloudEvents"
},
"routingProtocol": {"type": "BGP",
"customerRoutes": [{"ipBlock": {"href": "https://api.equinix.com/fabric/v4/ipBlocks/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92",
"uuid": "fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92"
}
}
],
"connections": [{"href": "https://api.equinix.com/fabric/v4/connections/6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671",
"uuid": "6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671"
}
]
},
"billing": {"type": "FIXED"
},
"account": {"accountNumber": "57689234"
},
"project": {"projectId": "44f4c4f8-2f39-494e-838c-d8e640591be5"
},
"order": {"purchaseOrderNumber": "PO-98765"
},
"changeLog": {"createdDateTime": "2026-04-16T00:00:00Z"
},
"useCase": "MAIN"
}
]
}

Get Internet Access Service by ID

Retrieve Internet Access Service by UUID

Authorizations:

BearerAuth

path Parameters

uuid

required

string <uuid>

UUID of the EIA Service

Responses

Response Schema: application/json

href

required

string <uri>

Service URL path

type

required

string (InternetAccessServiceType)

Enum: "SINGLE_IA" "DUAL_IA"

Type of the service, either single or dual internet access

uuid

required

string <uuid>

Unique identifier for the EIA Service

name

required

string

The name of the EIA Service

bandwidth

integer

Bandwidth of the service

bandwidthCommit

integer

Minimum bandwidth commit for burst billing variant of the service

state

required

string (InternetAccessServiceState)

Enum: "PROVISIONING" "PROVISIONED" "FAILED" "DEPROVISIONING" "DEPROVISIONED"

Current state of the service

required

object (InternetAccessChange)

href

required

string <uri>

URI of the change object

Array of objects (InternetAccessLocation)

List of locations associated with the service

Array

metroHref required	string <uri> Metro URL path for the linked resource
metroCode required	string^[A-Z]{2}$ Code representing the metro
region required	string Enum: "APAC" "EMEA" "AMER" Geographic region
ibx required	string IBX data center code

required

object (InternetAccessRoutingProtocol)

type

required

string (InternetAccessRoutingProtocolType)

BGP

required

Array of objects (InternetAccessCustomerRoute)

Array

object (InternetAccessIpBlock)

href required	string <uri> URI of the IP block
uuid required	string <uuid> Unique identifier for the IP block

required

Array of objects (InternetAccessConnection)

Array

href required	string <uri> URI of the connection
uuid required	string <uuid> Unique identifier for the connection
	object (InternetAccessPeeringIpv4)
	object (InternetAccessPeeringIpv6)

exportPolicy

required

string (InternetAccessExportPolicy)

Enum: "FULL" "DEFAULT" "FULL_DEFAULT" "PARTIAL"

Denotes which routes should be advertised to the internet

object

href	string URI of the ASN resource
uuid required	string <uuid> Unique identifier of the ASN

customerAsn

integer <int64>

Deprecated

Customer ASN. Valid range is 1-64495 or 131072-4199999999. Currently this option is only available for EIA over dedicated port.

bgpAuthKey

string

Deprecated

BGP authentication key. This field is deprecated and will be removed in future releases. Please use bgpAuthType instead to determine if a BGP authentication key is configured.

bgpAuthType

string (InternetAccessBgpAuthType)

Default: "NONE"

Enum: "AUTH_KEY" "NONE"

Indicates whether a BGP authentication key is configured. AUTH_KEY when bgpAuthKey is set, NONE otherwise.

customerAsnRange

string (InternetAccessCustomerAsnRange)

Enum: "BITS_16" "BITS_32"

Customer Autonomous System Number range. Based on the value a proper private ASN will be generated.

required

object (InternetAccessBilling)

type required	string (InternetAccessBillingType) Enum: "FIXED" "USAGE_BASED" "BURST_BASED"
enabled	boolean Indicates whether the billing is enabled
startDate	string <date-time> The start date for the billing period

required

object (InternetAccessAccount)

accountNumber required	string Account number
href	string <uri> Account URL path

required

object (Project)

projectId

required

string

Subscriber-assigned project ID

required

object (InternetAccessOrder)

purchaseOrderNumber	string Purchase order number
customerReferenceNumber	string Customer reference number
billingTier	string Billing tier for connection bandwidth
orderId	string Order Identification
orderNumber	string Order Reference Number
termLength	integer [ 1 .. 60 ] Default: 1 Term length in months, valid values are 1, 12, 24, 36, 60 where 1 is the default value (for on-demand case).
contractedBandwidth	integer Contracted bandwidth
href	string <uri> Order URI

required

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

useCase

required

string (InternetAccessUseCase)

Enum: "MAIN" "MANAGEMENT_ACCESS"

Response samples

200
404

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4",
"type": "SINGLE_IA",
"uuid": "673c6e6c-2c36-4488-b3f1-47064357b5b4",
"name": "internet-access-primary",
"state": "PROVISIONED",
"bandwidth": 1000,
"bandwidthCommit": 500,
"change": {"href": "https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4/cloudEvents"
},
"locations": [{"metroHref": "https://api.equinix.com/fabric/v4/metros/WA",
"metroCode": "WA",
"region": "AMER",
"ibx": "WA1"
}
],
"routingProtocol": {"type": "BGP",
"exportPolicy": "FULL",
"asn": {"href": "https://api.equinix.com/fabric/v4/asns/5dd81532-c313-35ba-8a0f-be05fb275fa1",
"uuid": "5dd81532-c313-35ba-8a0f-be05fb275fa1"
},
"customerRoutes": [{"ipBlock": {"href": "https://api.equinix.com/fabric/v4/ipBlocks/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92",
"uuid": "fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92"
}
}
],
"connections": [{"href": "https://api.equinix.com/fabric/v4/connections/6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671",
"uuid": "6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671"
}
]
},
"billing": {"type": "FIXED",
"enabled": true,
"startDate": "2026-04-16T00:00:00Z"
},
"account": {"accountNumber": "57689234",
"href": "https://api.equinix.com/billing/v2/billingAccounts/accountNumber/57689234"
},
"project": {"projectId": "44f4c4f8-2f39-494e-838c-d8e640591be5"
},
"order": {"href": "https://api.equinix.com/colocations/v2/orders/100200300",
"orderNumber": 100200300,
"purchaseOrderNumber": "PO-98765"
},
"changeLog": {"createdBy": "api-user",
"createdDateTime": "2026-04-16T00:00:00Z",
"updatedBy": "api-user",
"updatedDateTime": "2026-04-16T00:10:00Z"
},
"useCase": "MAIN"
}

Update Internet Access Service by ID

Patch Internet Access Service by UUID

Authorizations:

BearerAuth

path Parameters

uuid

required

string <uuid>

UUID of the EIA Service

Request Body schema: application/json
required

Array ([ 1 .. 100 ] items)

op required	string (InternetAccessPatchOperationUpdateAllowedOp) Enum: "replace" "add" "remove" Allowed patch operations.
path required	string (InternetAccessPatchOperationUpdateAllowedPath) ^(\/name\|\/bandwidth\|\/bandwidthCommit\|\/rout... Allowed patch paths for Internet Access update.
value	any New value for updated parameter. Required for add and replace.

Responses

Request samples

Payload

Content type

application/json

Example

Add and remove IP Blocks in a single request

[{"op": "add",
"path": "/routingProtocol/customerRoutes",
"value": {"ipBlock": {"uuid": "fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92"
}
}
},
{"op": "remove",
"path": "/routingProtocol/customerRoutes[@.ipBlock.uuid=ad8c5042-b553-4d5e-a2ac-c73bf6d4fd91]"
}
]

Response samples

202
404

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4",
"type": "SINGLE_IA",
"uuid": "673c6e6c-2c36-4488-b3f1-47064357b5b4",
"name": "internet-access-primary",
"state": "PROVISIONING",
"change": {"href": "https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4/cloudEvents"
},
"routingProtocol": {"type": "BGP",
"exportPolicy": "FULL",
"asn": {"href": "https://api.equinix.com/fabric/v4/asns/5dd81532-c313-35ba-8a0f-be05fb275fa1",
"uuid": "5dd81532-c313-35ba-8a0f-be05fb275fa1"
},
"customerRoutes": [{"ipBlock": {"href": "https://api.equinix.com/fabric/v4/ipBlocks/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92",
"uuid": "fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92"
}
}
],
"connections": [{"href": "https://api.equinix.com/fabric/v4/connections/6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671",
"uuid": "6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671"
}
]
},
"billing": {"type": "FIXED",
"enabled": true,
"startDate": "2026-04-16T00:00:00Z"
},
"account": {"accountNumber": "57689234",
"href": "https://api.equinix.com/billing/v2/billingAccounts/accountNumber/57689234"
},
"project": {"projectId": "44f4c4f8-2f39-494e-838c-d8e640591be5"
},
"order": {"href": "https://api.equinix.com/colocations/v2/orders/100200300",
"orderNumber": 100200300,
"purchaseOrderNumber": "PO-98765"
},
"changeLog": {"createdBy": "api-user",
"createdDateTime": "2026-04-16T00:00:00Z",
"updatedBy": "api-user",
"updatedDateTime": "2026-04-16T00:00:01Z"
},
"useCase": "MAIN"
}

Delete Internet Access Service by ID

Delete Internet Access Service by UUID

Authorizations:

BearerAuth

path Parameters

uuid

required

string <uuid>

UUID of the EIA Service

Responses

Response samples

202
404
409

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4",
"type": "SINGLE_IA",
"uuid": "673c6e6c-2c36-4488-b3f1-47064357b5b4",
"name": "internet-access-primary",
"state": "PROVISIONING",
"change": {"href": "https://api.equinix.com/fabric/v4/internetAccessServices/673c6e6c-2c36-4488-b3f1-47064357b5b4/cloudEvents"
},
"routingProtocol": {"type": "BGP",
"exportPolicy": "FULL",
"asn": {"href": "https://api.equinix.com/fabric/v4/asns/5dd81532-c313-35ba-8a0f-be05fb275fa1",
"uuid": "5dd81532-c313-35ba-8a0f-be05fb275fa1"
},
"customerRoutes": [{"ipBlock": {"href": "https://api.equinix.com/fabric/v4/ipBlocks/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92",
"uuid": "fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92"
}
}
],
"connections": [{"href": "https://api.equinix.com/fabric/v4/connections/6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671",
"uuid": "6f31ab8d-09f5-4ab1-b0b1-0f0e455ef671"
}
]
},
"billing": {"type": "FIXED",
"enabled": true,
"startDate": "2026-04-16T00:00:00Z"
},
"account": {"accountNumber": "57689234",
"href": "https://api.equinix.com/billing/v2/billingAccounts/accountNumber/57689234"
},
"project": {"projectId": "44f4c4f8-2f39-494e-838c-d8e640591be5"
},
"order": {"href": "https://api.equinix.com/colocations/v2/orders/100200300",
"orderNumber": 100200300,
"purchaseOrderNumber": "PO-98765"
},
"changeLog": {"createdBy": "api-user",
"createdDateTime": "2026-04-16T00:00:00Z",
"updatedBy": "api-user",
"updatedDateTime": "2026-04-16T00:00:01Z"
},
"useCase": "MAIN"
}

IP Blocks

IP Blocks ^Beta

Create IP Block

Submits new Equinix owned or customer owned IP Block request

Authorizations:

BearerAuth

Request Body schema: application/json
required

object (IpBlockLocation)

metroHref	string Metro URL path for the linked resource
metroCode required	string^[A-Z]{2}$

type

required

string (TypeOfIpBlockProduct)

Enum: "IPV4_IP_BLOCK" "IPV6_IP_BLOCK"

required

object (IpBlockProjectRequest)

projectId

required

string

project id

object (IpBlockAccount)

accountNumber

required

string

account number

object (IpBlockOrderRequest)

purchaseOrderNumber	string or null Purchase order number
orderNumber	string or null Order Number
orderLine	string or null Order Line Number

object (IpBlockRegulations)

required

Array of objects (IpBlockAddressingPlan)

List of addressing plans

Array

purpose required	string purpose
size required	integer <int32> size

required

object

privateSpaceConsidered required	boolean
refusedPreviously required	boolean
returningAddressSpace required	boolean

prefixLength

integer (IpBlockPrefixLength) [ 1 .. 128 ]

IpBlockPrefix length

prefix

string (IpBlockPrefix)

CIDR prefix

Responses

Request samples

Payload

Content type

application/json

Example

EquinixOwnedApacWithRegulations

{"prefixLength": 24,
"location": {"metroCode": "SY"
},
"project": {"projectId": "52cb19be-63c4-434d-bec8-5e94636291fc"
},
"type": "IPV4_IP_BLOCK",
"regulations": {"addressingPlans": [{"purpose": "SERVERS",
"size": 100
},
{"purpose": "ROUTERS",
"size": 154
}
],
"questions": {"privateSpaceConsidered": true,
"refusedPreviously": true,
"returningAddressSpace": false
}
},
"account": {"accountNumber": "2-57689234"
},
"order": {"purchaseOrderNumber": "purchase-order123"
}
}

Response samples

202
400
403
500

Content type

application/json

Example

EquinixOwnedAccepted

{"href": "https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb",
"uuid": "31fbdb3f-8def-410d-868b-ef920878affb",
"state": "PENDING",
"ownership": "EQUINIX",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/WA",
"metroCode": "SY"
},
"prefixLength": 24,
"type": "IPV4_IP_BLOCK",
"change": {"href": "https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb/cloudEvents"
},
"order": {"href": "https://api.equinix.com/colocations/v2/orders/1-34834234",
"orderNumber": "1-34834234"
},
"account": {"href": "https://api.equinix.com/billing/v2/billingAccounts/accountNumber/2-57689234",
"accountNumber": "2-57689234"
},
"project": {"href": "https://api.equinix.com/resourceManager/v2/projects/03ed2230-604a-494c-bca2-c042d38d80bc",
"projectId": "03ed2230-604a-494c-bca2-c042d38d80bc"
},
"regulations": {"addressingPlans": [{"purpose": "SERVERS",
"size": 100
},
{"purpose": "ROUTERS",
"size": 154
}
],
"questions": {"privateSpaceConsidered": true,
"refusedPreviously": true,
"returningAddressSpace": false
}
},
"changeLog": {"createdDateTime": "2025-12-01T12:11:22.222351Z"
},
"assets": [ ]
}

Retrieve IP Block by ID

Retrieve IP Block by UUID

Authorizations:

BearerAuth

path Parameters

uuid

required

string <uuid>

UUID of the IP Block

Responses

Response Schema: application/json

uuid

required

string <uuid>

Unique identifier for the IP Block

href

required

string

Resource URL path for the IP Block

type

required

string (TypeOfIpBlockProduct)

Enum: "IPV4_IP_BLOCK" "IPV6_IP_BLOCK"

state

required

string (IpBlockState)

Enum: "PENDING" "ACTIVE" "DELETING" "DELETED" "FAILED"

Current state of the IP Block

ownership

required

string (IpBlockOwnership)

Enum: "EQUINIX" "CUSTOMER"

IpBlockOwnership of the IP Block

object (IpBlockLocation)

metroHref	string Metro URL path for the linked resource
metroCode required	string^[A-Z]{2}$

prefixLength

required

integer (IpBlockPrefixLength) [ 1 .. 128 ]

IpBlockPrefix length

prefix

string (IpBlockPrefix)

CIDR prefix

object (IpBlockOrderResponse)

href required	string <uri> Order URI
orderNumber required	string Order number

object (IpBlockAccount)

accountNumber

required

string

account number

required

object (IpBlockProject)

href	string <uri> URI of the project
projectId required	string project id

object (IpBlockRegulations)

required

Array of objects (IpBlockAddressingPlan)

List of addressing plans

Array

purpose required	string purpose
size required	integer <int32> size

required

object

privateSpaceConsidered required	boolean
refusedPreviously required	boolean
returningAddressSpace required	boolean

Array of objects (IpBlockAsset)

Products using this IP Block

Array

type required	string (IpBlockProductType) Enum: "EIA" "FABRIC" "NE"
uuid required	string <uuid> Unique identifier for the asset
href required	string Resource URL path for the linked resource

object (IpBlockChange)

href

required

string <uri>

URI of the IpBlockChange object

required

object (IpBlockChangeLog)

createdDateTime required	string <date-time>
updatedDateTime	string <date-time>
deletedDateTime	string <date-time>

object (Error)

Error Response with details

errorCode

required

string^EQ-\d{7}$

errorMessage

required

string

correlationId

string

details

string

help

string

Array of objects

Array

property	string
reason	string

Response samples

200
403
404
500

Content type

application/json

Example

EquinixOwnedRetrieved

{"href": "https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb",
"uuid": "31fbdb3f-8def-410d-868b-ef920878affb",
"state": "PENDING",
"ownership": "EQUINIX",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/WA",
"metroCode": "SY"
},
"prefixLength": 24,
"type": "IPV4_IP_BLOCK",
"change": {"href": "https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb/cloudEvents"
},
"order": {"href": "https://api.equinix.com/colocations/v2/orders/1-34834234",
"orderNumber": "1-34834234"
},
"account": {"href": "https://api.equinix.com/billing/v2/billingAccounts/accountNumber/2-57689234",
"accountNumber": "2-57689234"
},
"project": {"href": "https://api.equinix.com/resourceManager/v2/projects/03ed2230-604a-494c-bca2-c042d38d80bc",
"projectId": "03ed2230-604a-494c-bca2-c042d38d80bc"
},
"regulations": {"addressingPlans": [{"purpose": "SERVERS",
"size": 100
},
{"purpose": "ROUTERS",
"size": 154
}
],
"questions": {"privateSpaceConsidered": true,
"refusedPreviously": true,
"returningAddressSpace": false
}
},
"changeLog": {"createdDateTime": "2025-12-01T12:11:22.222351Z"
},
"assets": [ ]
}

Delete IP Block by ID

Delete IP Block by UUID

Authorizations:

BearerAuth

path Parameters

uuid

required

string <uuid>

UUID of the IP Block

Responses

Response samples

Content type

application/json

Example

EquinixOwnedAccepted

{"href": "https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb",
"uuid": "31fbdb3f-8def-410d-868b-ef920878affb",
"state": "PENDING",
"ownership": "EQUINIX",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/WA",
"metroCode": "SY"
},
"prefixLength": 24,
"type": "IPV4_IP_BLOCK",
"change": {"href": "https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb/cloudEvents"
},
"order": {"href": "https://api.equinix.com/colocations/v2/orders/1-34834234",
"orderNumber": "1-34834234"
},
"account": {"href": "https://api.equinix.com/billing/v2/billingAccounts/accountNumber/2-57689234",
"accountNumber": "2-57689234"
},
"project": {"href": "https://api.equinix.com/resourceManager/v2/projects/03ed2230-604a-494c-bca2-c042d38d80bc",
"projectId": "03ed2230-604a-494c-bca2-c042d38d80bc"
},
"regulations": {"addressingPlans": [{"purpose": "SERVERS",
"size": 100
},
{"purpose": "ROUTERS",
"size": 154
}
],
"questions": {"privateSpaceConsidered": true,
"refusedPreviously": true,
"returningAddressSpace": false
}
},
"changeLog": {"createdDateTime": "2025-12-01T12:11:22.222351Z"
},
"assets": [ ]
}

Update IP Block by ID

patch IP Block by UUID

Authorizations:

BearerAuth

path Parameters

uuid

required

string <uuid>

UUID of the IP Block

Request Body schema: application/json
required

Array (= 1 items)

op

required

string

Enum: "add" "remove"

operation

path

required

string

path

object

new value

uuid

required

string <uuid>

Responses

Request samples

Payload

Content type

application/json

[{"op": "add",
"path": "string",
"value": {"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
}
]

Response samples

202
404
500

Content type

application/json

Example

EquinixOwnedAccepted

{"href": "https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb",
"uuid": "31fbdb3f-8def-410d-868b-ef920878affb",
"state": "PENDING",
"ownership": "EQUINIX",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/WA",
"metroCode": "SY"
},
"prefixLength": 24,
"type": "IPV4_IP_BLOCK",
"change": {"href": "https://api.equinix.com/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb/cloudEvents"
},
"order": {"href": "https://api.equinix.com/colocations/v2/orders/1-34834234",
"orderNumber": "1-34834234"
},
"account": {"href": "https://api.equinix.com/billing/v2/billingAccounts/accountNumber/2-57689234",
"accountNumber": "2-57689234"
},
"project": {"href": "https://api.equinix.com/resourceManager/v2/projects/03ed2230-604a-494c-bca2-c042d38d80bc",
"projectId": "03ed2230-604a-494c-bca2-c042d38d80bc"
},
"regulations": {"addressingPlans": [{"purpose": "SERVERS",
"size": 100
},
{"purpose": "ROUTERS",
"size": 154
}
],
"questions": {"privateSpaceConsidered": true,
"refusedPreviously": true,
"returningAddressSpace": false
}
},
"changeLog": {"createdDateTime": "2025-12-01T12:11:22.222351Z"
},
"assets": [ ]
}

Search IP Blocks

Search for IP Blocks based on criteria

Authorizations:

BearerAuth

Request Body schema: application/json
required

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

object (IpBlockFilter)

Array of objects (IpBlockAndQuery)

Array

property required	string
operator required	string Value: "="
values required	Array of strings

Array of objects (SearchSort)

Array

direction required	string Enum: "ASC" "DESC"
property required	string

Responses

Response Schema: application/json

required

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (SearchSort)

Array

direction required	string Enum: "ASC" "DESC"
property required	string

required

Array of objects (IpBlock)

Array

uuid required	string <uuid> Unique identifier for the IP Block
href required	string Resource URL path for the IP Block
type required	string (TypeOfIpBlockProduct) Enum: "IPV4_IP_BLOCK" "IPV6_IP_BLOCK"
state required	string (IpBlockState) Enum: "PENDING" "ACTIVE" "DELETING" "DELETED" "FAILED" Current state of the IP Block
ownership required	string (IpBlockOwnership) Enum: "EQUINIX" "CUSTOMER" IpBlockOwnership of the IP Block
	object (IpBlockLocation)
prefixLength required	integer (IpBlockPrefixLength) [ 1 .. 128 ] IpBlockPrefix length
prefix	string (IpBlockPrefix) CIDR prefix
	object (IpBlockOrderResponse)
	object (IpBlockAccount)
required	object (IpBlockProject)
	object (IpBlockRegulations)
	Array of objects (IpBlockAsset) Products using this IP Block
	object (IpBlockChange)
required	object (IpBlockChangeLog)
	object (Error) Error Response with details

Request samples

Payload

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20
},
"filter": {"and": [{"property": "string",
"operator": "=",
"values": ["string"
]
}
]
},
"sort": [{"direction": "ASC",
"property": "string"
}
]
}

Response samples

200
400
500

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 0,
"next": "string",
"previous": "string"
},
"sort": [{"direction": "ASC",
"property": "string"
}
],
"data": [{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"href": "/fabric/v4/ipBlocks/31fbdb3f-8def-410d-868b-ef920878affb",
"type": "IPV4_IP_BLOCK",
"state": "PENDING",
"ownership": "EQUINIX",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/WA",
"metroCode": "WA"
},
"prefixLength": 1,
"prefix": "string",
"order": {"href": "https://api.equinix.com/colocations/v2/orders/1-34834234",
"orderNumber": "string"
},
"account": {"accountNumber": "string"
},
"project": {"href": "http://example.com",
"projectId": "string"
},
"regulations": {"addressingPlans": [{"purpose": "string",
"size": 0
}
],
"questions": {"privateSpaceConsidered": true,
"refusedPreviously": true,
"returningAddressSpace": true
}
},
"assets": [{"type": "EIA",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"href": "https://api.equinix.com/fabric/v4/internetAccesses/fd8c5042-b553-4d5e-a2ac-c73bf6d4fd92"
}
],
"change": {"href": "http://example.com"
},
"changeLog": {"createdDateTime": "2019-08-24T14:15:22Z",
"updatedDateTime": "2019-08-24T14:15:22Z",
"deletedDateTime": "2019-08-24T14:15:22Z"
},
"error": {"errorCode": "string",
"errorMessage": "string",
"correlationId": "string",
"details": "string",
"help": "string",
"additionalInfo": [{"property": "string",
"reason": "string"
}
]
}
}
]
}

ASNs

Autonomous System Number (ASN) ^Beta

Create ASN

Create a new Public or Private ASN record

Authorizations:

BearerAuth

Request Body schema: application/json
required

required

object (Project)

projectId

required

string

Subscriber-assigned project ID

number

integer <int64>

ASN number used for public ASN creation.

rirRegion

string (AsnRirRegion)

Enum: "AFRINIC" "APNIC" "ARIN" "LACNIC" "RIPE_NCC"

Regional Internet Registry region

object (AsnOwnershipChallengeDetails)

Ownership challenge details for public ASN verification

type required	string (AsnOwnershipChallengeType) Type of ownership challenge RPKI
message	string Challenge message to sign
signature	string Signed challenge value

object (SimplifiedLocation)

metroHref	string
region	string
metroName	string
metroCode	string
ibx	string Deprecated

range

string (AsnRange)

Enum: "16_BIT" "32_BIT"

ASN range selection

Responses

Request samples

Payload

Content type

application/json

Example

Create a public ASN

{"type": "PUBLIC_ASN",
"project": {"projectId": "03ed2230-604a-494c-bca2-c042d38d80bc"
},
"number": 64497,
"rirRegion": "RIPE_NCC",
"ownershipChallengeDetails": {"type": "RPKI"
}
}

Response samples

202
400
401
403
500

Content type

application/json

Example

Public ASN creation response

{"href": "fabric/v4/asns/6db706f8-2a37-4546-a3ed-1df113a84d43",
"uuid": "6db706f8-2a37-4546-a3ed-1df113a84d43",
"type": "PUBLIC_ASN",
"project": {"projectId": "03ed2230-604a-494c-bca2-c042d38d80bc"
},
"state": "PENDING",
"number": 64497,
"rirRegion": "RIPE_NCC",
"ownershipChallengeDetails": {"type": "RPKI",
"message": "eqx-rpki-challenge-2026-04-21T11:20:00Z-64497",
"signature": null
},
"assets": [ ],
"changeLog": {"createdDateTime": "2025-12-01T12:11:22.222351Z"
}
}

Search ASNs

Search for ASN records based on criteria

Authorizations:

BearerAuth

Request Body schema: application/json
required

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

object (SearchExpression)

and	Array of objects (SearchExpressions)
or	Array of objects (SearchExpressions)
property	string
operator	string Enum: "=" "!=" ">" ">=" "<" "<=" "BETWEEN" "NOT BETWEEN" "LIKE" "NOT LIKE" "IN" "NOT IN" "IS NOT NULL" "IS NULL"
values	Array of strings

Array of objects (AsnSearchSortCriteria)

Array

direction	string Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string Default: "/changeLog/updatedDateTime" Possible field names to use on sorting

Responses

Response Schema: application/json

required

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (AsnSearchSortCriteria)

Array

direction	string Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string Default: "/changeLog/updatedDateTime" Possible field names to use on sorting

required

Array of objects (Asn)

Array

href	string
uuid	string <uuid> Unique identifier for the ASN record
state	string (AsnState) Enum: "REQUESTED" "PROVISIONING" "PENDING" "PROVISIONED" "ATTACHED" "FAILED" "PROVISIONING_FAILED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" ASN lifecycle state
	object (Project)
number	integer <int64> Autonomous System Number
rirRegion	string (AsnRirRegion) Enum: "AFRINIC" "APNIC" "ARIN" "LACNIC" "RIPE_NCC" Regional Internet Registry region
	object (SimplifiedLocation)
range	string (AsnRange) Enum: "16_BIT" "32_BIT" ASN range selection
	object (AsnOwnershipChallengeDetails) Ownership challenge details for public ASN verification
	object (AsnChange) Change reference for ASN
	Array of objects (AsnAsset)
	Array of objects (Error) List of errors
	object (Changelog) Change log

Request samples

Payload

Content type

application/json

{"pagination": {"offset": 0,
"limit": 25
},
"filter": {"and": [{"property": "/project/projectId",
"operator": "=",
"values": ["03ed2230-604a-494c-bca2-c042d38d80bc"
]
}
]
},
"sort": [{"direction": "DESC",
"property": "/changeLog/createdDateTime"
}
]
}

Response samples

200
400
401
403
500

Content type

application/json

{"pagination": {"total": 1
},
"sort": [{"direction": "DESC",
"property": "/changeLog/createdDateTime"
}
],
"data": [{"href": "fabric/v4/asns/6db706f8-2a37-4546-a3ed-1df113a84d43",
"uuid": "6db706f8-2a37-4546-a3ed-1df113a84d43",
"type": "PUBLIC_ASN",
"project": {"projectId": "03ed2230-604a-494c-bca2-c042d38d80bc"
},
"state": "PROVISIONING",
"number": 64497,
"rirRegion": "RIPE_NCC",
"ownershipChallengeDetails": {"type": "RPKI",
"message": "eqx-rpki-challenge-2026-04-21T11:20:00Z-64497",
"signature": "MEUCIQCrExampleBase64SignatureValue7h4Yg=="
},
"assets": [{"service": {"href": "https://api.equinix.com/fabric/v4/internetAccessService/52fbdb3f-8def-410d-868b-ef920878bff8",
"type": "IA",
"uuid": "52fbdb3f-8def-410d-868b-ef920878bff8"
},
"announcingMetro": "LD",
"ipBlocks": [{"href": "https://api.equinix.com/fabric/v4/ipBlocks/129afa61-f706-41cb-a03a-69a276bdb0b4",
"type": "IPV4_IP_BLOCK",
"uuid": "129afa61-f706-41cb-a03a-69a276bdb0b4"
},
{"href": "https://api.equinix.com/fabric/v4/ipBlocks/72fc7c32-67c8-4ae4-b43f-d4d656961f04",
"type": "IPV6_IP_BLOCK",
"uuid": "72fc7c32-67c8-4ae4-b43f-d4d656961f04"
}
]
}
],
"changeLog": {"createdDateTime": "2025-12-01T12:11:22.222Z",
"updatedDateTime": "2025-12-01T13:11:22.222Z"
}
}
]
}

Get ASN

Retrieve ASN record by UUID

Authorizations:

BearerAuth

path Parameters

asnId

required

string <uuid>

UUID of the ASN record

Responses

Response Schema: application/json

href

string

uuid

string <uuid>

Unique identifier for the ASN record

state

string (AsnState)

Enum: "REQUESTED" "PROVISIONING" "PENDING" "PROVISIONED" "ATTACHED" "FAILED" "PROVISIONING_FAILED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED"

ASN lifecycle state

object (Project)

projectId

required

string

Subscriber-assigned project ID

number

integer <int64>

Autonomous System Number

rirRegion

string (AsnRirRegion)

Enum: "AFRINIC" "APNIC" "ARIN" "LACNIC" "RIPE_NCC"

Regional Internet Registry region

object (SimplifiedLocation)

metroHref	string
region	string
metroName	string
metroCode	string
ibx	string Deprecated

range

string (AsnRange)

Enum: "16_BIT" "32_BIT"

ASN range selection

object (AsnOwnershipChallengeDetails)

Ownership challenge details for public ASN verification

type required	string (AsnOwnershipChallengeType) Type of ownership challenge RPKI
message	string Challenge message to sign
signature	string Signed challenge value

object (AsnChange)

Change reference for ASN

href	string URL path to the change event

Array of objects (AsnAsset)

Array

uuid	string
	object (AsnAssetService) Associated Internet Access Service reference
announcingMetro	string
	Array of objects (AsnAssetIpBlockRef)
	object (Changelog) Change log

Array of objects (Error)

List of errors

Array

errorCode required	string^EQ-\d{7}$
errorMessage required	string
correlationId	string
details	string
help	string
	Array of objects

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

Response samples

200
401
403
404
500

Content type

application/json

{"href": "fabric/v4/asns/6db706f8-2a37-4546-a3ed-1df113a84d43",
"uuid": "6db706f8-2a37-4546-a3ed-1df113a84d43",
"type": "PUBLIC_ASN",
"project": {"projectId": "03ed2230-604a-494c-bca2-c042d38d80bc"
},
"state": "PROVISIONING",
"number": 64497,
"rirRegion": "RIPE_NCC",
"ownershipChallengeDetails": {"type": "RPKI",
"message": "eqx-rpki-challenge-2026-04-21T11:20:00Z-64497",
"signature": "MEUCIQCrExampleBase64SignatureValue7h4Yg=="
},
"assets": [{"service": {"href": "https://api.equinix.com/fabric/v4/internetAccessService/52fbdb3f-8def-410d-868b-ef920878bff8",
"type": "IA",
"uuid": "52fbdb3f-8def-410d-868b-ef920878bff8"
},
"announcingMetro": "LD",
"ipBlocks": [{"href": "https://api.equinix.com/fabric/v4/ipBlocks/129afa61-f706-41cb-a03a-69a276bdb0b4",
"type": "IPV4_IP_BLOCK",
"uuid": "129afa61-f706-41cb-a03a-69a276bdb0b4"
},
{"href": "https://api.equinix.com/fabric/v4/ipBlocks/72fc7c32-67c8-4ae4-b43f-d4d656961f04",
"type": "IPV6_IP_BLOCK",
"uuid": "72fc7c32-67c8-4ae4-b43f-d4d656961f04"
}
]
}
],
"changeLog": {"createdDateTime": "2025-12-01T12:11:22.222351Z",
"updatedDateTime": "2025-12-01T13:11:22.222351Z"
}
}

Update ASN

Update ASN record

Authorizations:

BearerAuth

path Parameters

asnId

required

string <uuid>

UUID of the ASN record

Request Body schema: application/json
required

Array

op required	string Enum: "add" "remove" "replace" JSON Patch operation
path required	string JSON Pointer to the field to update
value required	any New value for add or replace operations

Responses

Request samples

Payload

Content type

application/json

[{"op": "replace",
"path": "/ownershipChallengeDetails/signature",
"value": "MEUCIQCrExampleBase64SignatureValue7h4Yg=="
}
]

Response samples

Content type

application/json

Example

Public ASN creation response

{"href": "fabric/v4/asns/6db706f8-2a37-4546-a3ed-1df113a84d43",
"uuid": "6db706f8-2a37-4546-a3ed-1df113a84d43",
"type": "PUBLIC_ASN",
"project": {"projectId": "03ed2230-604a-494c-bca2-c042d38d80bc"
},
"state": "PENDING",
"number": 64497,
"rirRegion": "RIPE_NCC",
"ownershipChallengeDetails": {"type": "RPKI",
"message": "eqx-rpki-challenge-2026-04-21T11:20:00Z-64497",
"signature": null
},
"assets": [ ],
"changeLog": {"createdDateTime": "2025-12-01T12:11:22.222351Z"
}
}

Delete ASN

Deprovision ASN record by UUID

Authorizations:

BearerAuth

path Parameters

asnId

required

string <uuid>

UUID of the ASN record

Responses

Response samples

Content type

application/json

Example

Public ASN creation response

{"href": "fabric/v4/asns/6db706f8-2a37-4546-a3ed-1df113a84d43",
"uuid": "6db706f8-2a37-4546-a3ed-1df113a84d43",
"type": "PUBLIC_ASN",
"project": {"projectId": "03ed2230-604a-494c-bca2-c042d38d80bc"
},
"state": "PENDING",
"number": 64497,
"rirRegion": "RIPE_NCC",
"ownershipChallengeDetails": {"type": "RPKI",
"message": "eqx-rpki-challenge-2026-04-21T11:20:00Z-64497",
"signature": null
},
"assets": [ ],
"changeLog": {"createdDateTime": "2025-12-01T12:11:22.222351Z"
}
}

Internet Exchange Services

Internet Exchange Services ^Beta

Create Internet Exchange Service

This API provides capability to create Internet Exchange Service

Authorizations:

BearerAuth

Request Body schema: application/json
required

type

required

string

Value: "IX"

Internet Exchange Service type

name

required

string [ 1 .. 50 ] characters

Customer-provided internet exchange service name

description

string [ 1 .. 255 ] characters

Customer-provided internet exchange service description

required

object (PublicPeeringConnectionRequest)

Public Peering Connection

uuid	string <uuid> connection id

required

object (RoutingProtocolRequest)

customerAsn

integer

Customer Autonomous System Number (ASN)

macAddress

string

MAC address of the customer interface

object (ExchangeServiceRequestBgp)

domainName	string [ 1 .. 253 ] characters Domain name for BGP
asSet	string [ 2 .. 48 ] characters AS-SET used to filter the prefixes announced by the customer
mlpeEnabled	boolean Default: false Whether Multi-Lateral Peering Exchange (MLPE) is enabled
md5AuthKey	string [ 1 .. 255 ] characters MD5 key for BGP
rcMd5AuthKey	string [ 1 .. 255 ] characters RC MD5 key for BGP
prefixes	Array of strings List of IP prefix
maxPrefixLimit	integer <int64> Max Prefix Limit number
prependSelfEnabled	boolean Default: true Prepend Self Enabled

object (ExchangeServiceRequestBgp)

domainName	string [ 1 .. 253 ] characters Domain name for BGP
asSet	string [ 2 .. 48 ] characters AS-SET used to filter the prefixes announced by the customer
mlpeEnabled	boolean Default: false Whether Multi-Lateral Peering Exchange (MLPE) is enabled
md5AuthKey	string [ 1 .. 255 ] characters MD5 key for BGP
rcMd5AuthKey	string [ 1 .. 255 ] characters RC MD5 key for BGP
prefixes	Array of strings List of IP prefix
maxPrefixLimit	integer <int64> Max Prefix Limit number
prependSelfEnabled	boolean Default: true Prepend Self Enabled

object (ExchangeServiceOrder)

Ordering and billing reference details for this Exchange Service.

purchaseOrderNumber	string Purchase order number reference.
customerReferenceId	string Your own reference for this Exchange Service.
orderNumber	string Equinix order reference number.

object (Project)

projectId

required

string

Subscriber-assigned project ID

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

Array of objects (ExchangeServiceNotification)

Preferences for notifications on Internet Exchange Service configuration or status changes

Array

type required	string Enum: "NOTIFICATION" "TECHNICAL" "PEERING" "ESCALATION" "ORDERING" Internet Exchange Service Notification Type
registeredUsers required	Array of strings Array of registered users

Responses

Request samples

Payload

Content type

application/json

{"type": "IX",
"name": "ix_exchange_service",
"publicPeeringConnection": {"uuid": "b44c6e6c-2c36-4488-b3f1-47064357b5b4"
},
"description": "ix_exchange_service",
"routingProtocol": {"customerAsn": 5555,
"macAddress": "00:11:22:33:44:55",
"bgpIpv4": {"domainName": "gw01.sin.example.net",
"asSet": "AS-EC-SV",
"mlpeEnabled": true,
"md5AuthKey": "TESTMD5KEY12345",
"prefixes": ["203.0.113.0/24"
]
},
"bgpIpv6": {"domainName": "gw01.sin.example.net",
"asSet": "AS-EC-SV",
"mlpeEnabled": true,
"md5AuthKey": "TESTMD5KEY123456",
"prefixes": ["2001:DB8:123::/48"
]
}
},
"order": {"purchaseOrderNumber": "1-3456576"
},
"notifications": [{"type": "NOTIFICATION",
"registeredUsers": ["jaguarsuser-port-order"
]
}
],
"project": {"projectId": "e275485c-7072-439f-943a-c923548b2be5"
},
"account": {"accountNumber": 100179
}
}

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011",
"uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
"type": "IX",
"name": "ix_exchange_service",
"bandwidth": 400000,
"description": "ix_exchange_service",
"state": "PROVISIONING",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/SV",
"metroCode": "SV"
},
"publicPeeringConnection": {"type": "IX_VC",
"href": "https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4",
"uuid": "b44c6e6c-2c36-4488-b3f1-47064357b5b4"
},
"routingProtocol": {"customerAsn": 5555,
"macAddress": "00:11:22:33:44:55",
"vlan": 99,
"routeServerAsn": 24115,
"bgpIpv4": {"customerPeerIp": "12.1.1.1",
"domainName": "gw01.sin.example.net",
"primaryRouteServerIp": "10.1.1.1",
"secondaryRouteServerIp": "10.1.1.2",
"asSet": "AS-EC-SV",
"mlpeEnabled": true,
"md5AuthKey": "TESTMD5Key12345",
"prefixes": ["203.0.113.0/24"
],
"maxPrefixLimit": 300,
"prependSelfEnabled": true
},
"bgpIpv6": {"customerPeerIp": "2001:db8:c59b::22",
"domainName": "gw01.sin.example.net",
"primaryRouteServerIp": "2001:db8:c59b::33",
"secondaryRouteServerIp": "2001:db8:c59b::322",
"asSet": "AS-EC-SV",
"mlpeEnabled": true,
"md5AuthKey": "TESTMD5Key123456",
"prefixes": ["2001:DB8:123::/48"
],
"maxPrefixLimit": 300,
"prependSelfEnabled": true
},
"routeCollector": {"asn": 1238,
"ipV4": "10.255.255.254",
"ipV6": "2001:db8:85a3::8a2e:370:7334\\"
}
},
"order": {"purchaseOrderNumber": "1-3456576",
"orderNumber": "1-139105284200"
},
"project": {"projectId": "e275485c-7072-439f-943a-c923548b2be5"
},
"account": {"accountNumber": 100179
},
"notifications": [{"type": "NOTIFICATION",
"registeredUsers": ["jaguarsuser-port-order"
]
}
],
"changelog": {"createdBy": "12345",
"createdDateTime": "2025-08-30T07:21:39Z"
},
"additionalInfo": {"errorCode": "EQ-3058039",
"errorMessage": "Unable to activate Exchange Service Port. Please verify your configuration or contact support."
}
}

Get Internet Exchange Service

The API provides capability to get Internet Exchange Service

Authorizations:

BearerAuth

path Parameters

exchangeServiceId

required

string <uuid>

Example: a8ba52de-faae-43b5-b0b1-6904d37ee011

Internet Exchange Service Id

Responses

Response Schema: application/json

href

string

Internet Exchange Service URI

uuid

string <uuid>

Internet Exchange Service identifier

type

string

Default: "IX"

Value: "IX"

Internet Exchange Service Type

name

string

Name

bandwidth

integer

bandwidth in Mbps

description

string

Description

state

string

Enum: "PROVISIONING" "PROVISIONING_FAILED" "PENDING_ACTIVATION" "ACTIVATING" "ACTIVATING_FAILED" "PROVISIONED" "REPROVISIONING" "REPROVISIONING_FAILED" "DEPROVISIONING" "DEPROVISIONED" "DEPROVISIONING_FAILED"

State

object (SimplifiedLocation)

metroHref	string
region	string
metroName	string
metroCode	string
ibx	string Deprecated

object (PublicPeeringConnectionResponse)

type	string <enum> Connection type IX_VC
href	string <string> URI
uuid	string <uuid> uuid

object (RoutingProtocolResponse)

customerAsn

integer

Customer Autonomous System Number (ASN)

macAddress

string

MAC address of the customer interface

vlan

integer <int64>

VLAN ID

routeServerAsn

integer <int64>

Equinix Route Server ASN

object (ExchangeServiceResponseBgp)

customerPeerIp	string Customer peer IP address
domainName	string Domain name for BGP
primaryRouteServerIp	string Primary route server IP address with prefix length
secondaryRouteServerIp	string Secondary route server IP address with prefix length
asSet	string AS-SET used to filter the prefixes announced by the customer
mlpeEnabled	boolean Whether Multi-Lateral Peering Exchange (MLPE) is enabled
md5AuthKey	string MD5 key for BGP
rcMd5AuthKey	string RC MD5 key for BGP
prefixes	Array of strings List of IP prefix
maxPrefixLimit	integer <int64> Max Prefix Limit number
prependSelfEnabled	boolean Prepend Self Enabled

object (ExchangeServiceResponseBgp)

customerPeerIp	string Customer peer IP address
domainName	string Domain name for BGP
primaryRouteServerIp	string Primary route server IP address with prefix length
secondaryRouteServerIp	string Secondary route server IP address with prefix length
asSet	string AS-SET used to filter the prefixes announced by the customer
mlpeEnabled	boolean Whether Multi-Lateral Peering Exchange (MLPE) is enabled
md5AuthKey	string MD5 key for BGP
rcMd5AuthKey	string RC MD5 key for BGP
prefixes	Array of strings List of IP prefix
maxPrefixLimit	integer <int64> Max Prefix Limit number
prependSelfEnabled	boolean Prepend Self Enabled

object (RouteCollector)

Route Collector

asn	integer <int64> Route Collector ASN
ipV4	string Route Collector ipV4 address
ipV6	string Route Collector ipV6 address

object (ExchangeServiceOrder)

Ordering and billing reference details for this Exchange Service.

purchaseOrderNumber	string Purchase order number reference.
orderId	string Equinix-assigned order identifier.
customerReferenceId	string Your own reference for this Exchange Service.
orderNumber	string Equinix order reference number.
orderLineItemNumber	string Order Reference Number for Sales Assisted Order
domainOrderNumber	string product domain Order Number for Sales Assisted Order
uuid	string <uuid> Equinix-assigned order identifier, this is a derived response attribute

object (Project)

projectId

required

string

Subscriber-assigned project ID

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

Array of objects (ExchangeServiceNotification)

Preferences for notifications on Internet Exchange Service configuration or status changes

Array

type required	string Enum: "NOTIFICATION" "TECHNICAL" "PEERING" "ESCALATION" "ORDERING" Internet Exchange Service Notification Type
registeredUsers required	Array of strings Array of registered users

object (PlatformChangelog)

Change log

createdBy	string Created by User Key
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedDateTime	string <date-time> Deleted by Date and Time

object (ExchangeServiceAdditionalInfo)

Additional information regarding the specified Exchange Service

errorCode	string Error code shown if an operation on the Exchange Service fails
errorMessage	string Generic message shown if an operation on the Exchange Service fails

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011",
"uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
"type": "IX",
"name": "ix_exchange_service",
"bandwidth": 400000,
"description": "ix_exchange_service",
"state": "PROVISIONING",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/SV",
"metroCode": "SV"
},
"publicPeeringConnection": {"type": "IX_VC",
"href": "https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4",
"uuid": "b44c6e6c-2c36-4488-b3f1-47064357b5b4"
},
"routingProtocol": {"customerAsn": 5555,
"macAddress": "00:11:22:33:44:55",
"vlan": 99,
"routeServerAsn": 24115,
"bgpIpv4": {"customerPeerIp": "12.1.1.1",
"domainName": "gw01.sin.example.net",
"primaryRouteServerIp": "10.1.1.1",
"secondaryRouteServerIp": "10.1.1.2",
"asSet": "AS-EC-SV",
"mlpeEnabled": true,
"md5AuthKey": "TESTMD5Key12345",
"prefixes": ["203.0.113.0/24"
],
"maxPrefixLimit": 300,
"prependSelfEnabled": true
},
"bgpIpv6": {"customerPeerIp": "2001:db8:c59b::22",
"domainName": "gw01.sin.example.net",
"primaryRouteServerIp": "2001:db8:c59b::33",
"secondaryRouteServerIp": "2001:db8:c59b::322",
"asSet": "AS-EC-SV",
"mlpeEnabled": true,
"md5AuthKey": "TESTMD5Key123456",
"prefixes": ["2001:DB8:123::/48"
],
"maxPrefixLimit": 300,
"prependSelfEnabled": true
},
"routeCollector": {"asn": 1238,
"ipV4": "10.255.255.254",
"ipV6": "2001:db8:85a3::8a2e:370:7334\\"
}
},
"order": {"purchaseOrderNumber": "1-3456576",
"orderNumber": "1-139105284200"
},
"project": {"projectId": "e275485c-7072-439f-943a-c923548b2be5"
},
"account": {"accountNumber": 100179
},
"notifications": [{"type": "NOTIFICATION",
"registeredUsers": ["jaguarsuser-port-order"
]
}
],
"changelog": {"createdBy": "12345",
"createdDateTime": "2025-08-30T07:21:39Z"
},
"additionalInfo": {"errorCode": "EQ-3058039",
"errorMessage": "Unable to activate Exchange Service Port. Please verify your configuration or contact support."
}
}

Update Internet Exchange Service

The API provides capability to update Internet Exchange Service

Authorizations:

BearerAuth

path Parameters

exchangeServiceId

required

string <uuid>

Example: a8ba52de-faae-43b5-b0b1-6904d37ee011

Internet Exchange Service Id

Request Body schema: application/json-patch+json
required

Array

op required	string (ExchangeServiceOpEnum) Enum: "replace" "add" the operation to be performed
path required	string (ExchangeServicePath) A JSON Pointer path. `/name` - Name of the Internet Exchange Service `/description` - Description of the Internet Exchange Service `routingProtocol/macAddress` - MAC Address `routingProtocol/bgpIpv4/domainName` - Domain Name for BGP IPv4 `routingProtocol/bgpIpv4/asSet` - AS Set for BGP IPv4 `routingProtocol/bgpIpv4/md5AuthKey` - MD5 Auth Key for BGP IPv4 `routingProtocol/bgpIpv4/rcMd5AuthKey` - RC MD5 Auth Key for BGP IPv4 `routingProtocol/bgpIpv4/ipPrefixes` - IP Prefixes for BGP IPv4 `routingProtocol/bgpIpv6/mlpeEnabled` - MLPE Enabled for BGP IPv4 `routingProtocol/bgpIpv6/domainName`- Domain Name for BGP IPv6 `routingProtocol/bgpIpv6/asSet`- AS Set for BGP IPv6 `routingProtocol/bgpIpv6/md5AuthKey` - MD5 Auth Key for BGP IPv6 `routingProtocol/bgpIpv6/rcMd5AuthKey` - RC MD5 Auth Key for BGP IPv6 `routingProtocol/bgpIpv6/ipPrefixes` - IP Prefixes for BGP IPv6 `routingProtocol/bgpIpv6/mlpeEnabled` - MLPE Enabled for BGP IPv6
value required	any value to replace with

Responses

Request samples

Payload

Content type

application/json-patch+json

Example

ExchangeServicePatchMacAddressRequest

[{"op": "replace",
"path": "/routingProtocol/macAddress",
"value": "00:1A:2B:3C:4D:5E"
}
]

Response samples

202
400
403
404
500

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011",
"uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
"type": "IX",
"name": "ix_exchange_service",
"bandwidth": 400000,
"description": "ix_exchange_service",
"state": "REPROVISIONING",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/SV",
"metroCode": "SV"
},
"publicPeeringConnection": {"type": "IX_VC",
"href": "https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4",
"uuid": "b44c6e6c-2c36-4488-b3f1-47064357b5b4"
},
"routingProtocol": {"customerAsn": 5555,
"macAddress": "00:11:22:33:44:55",
"vlan": 99,
"routeServerAsn": 24115,
"bgpIpv4": {"customerPeerIp": "12.1.1.1",
"domainName": "gw01.sin.example.net",
"primaryRouteServerIp": "10.1.1.1",
"secondaryRouteServerIp": "10.1.1.2",
"asSet": "AS-EC-SV",
"mlpeEnabled": true,
"md5AuthKey": "TESTMD5Key12345",
"prefixes": ["203.0.113.0/24"
],
"maxPrefixLimit": 300,
"prependSelfEnabled": true
},
"bgpIpv6": {"customerPeerIp": "2001:db8:c59b::22",
"domainName": "gw01.sin.example.net",
"primaryRouteServerIp": "2001:db8:c59b::33",
"secondaryRouteServerIp": "2001:db8:c59b::322",
"asSet": "AS-EC-SV",
"mlpeEnabled": true,
"md5AuthKey": "TESTMD5Key123456",
"prefixes": ["2001:DB8:123::/48"
],
"maxPrefixLimit": 300,
"prependSelfEnabled": true
},
"routeCollector": {"asn": 1238,
"ipV4": "10.255.255.254",
"ipV6": "2001:db8:85a3::8a2e:370:7334"
}
},
"order": {"purchaseOrderNumber": "1-3456576",
"orderNumber": "1-139105284200"
},
"project": {"projectId": "e275485c-7072-439f-943a-c923548b2be5"
},
"account": {"accountNumber": 100179
},
"notifications": [{"type": "NOTIFICATION",
"registeredUsers": ["jaguarsuser-port-order"
]
}
],
"changelog": {"updatedBy": "12345",
"updatedDateTime": "2025-08-30T07:21:39Z"
}
}

Search Internet Exchange Services

The API provides capability to get list of user's Internet Exchange Service using search criteria, including optional filtering, pagination and sorting

Authorizations:

BearerAuth

Request Body schema: application/json
required

ExchangeServiceAndExpression (object) or ExchangeServiceOrExpression (object) or ExchangeServicePropertyExpression (object) (ExchangeServiceSearchExpression)

One of

and

required

Array of any (ExchangeServiceSearchExpression)

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (ExchangeServiceSearchSortCriteria)

Array

direction	string Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string Default: "/changeLog/updatedDateTime" Enum: "/name" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" Possible field names to use on sorting

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (ExchangeServiceSearchSortCriteria)

Array

direction	string Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string Default: "/changeLog/updatedDateTime" Enum: "/name" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" Possible field names to use on sorting

Array of objects (ExchangeServiceResponse)

Array

href	string Internet Exchange Service URI
uuid	string <uuid> Internet Exchange Service identifier
type	string Default: "IX" Value: "IX" Internet Exchange Service Type
name	string Name
bandwidth	integer bandwidth in Mbps
description	string Description
state	string Enum: "PROVISIONING" "PROVISIONING_FAILED" "PENDING_ACTIVATION" "ACTIVATING" "ACTIVATING_FAILED" "PROVISIONED" "REPROVISIONING" "REPROVISIONING_FAILED" "DEPROVISIONING" "DEPROVISIONED" "DEPROVISIONING_FAILED" State
	object (SimplifiedLocation)
	object (PublicPeeringConnectionResponse)
	object (RoutingProtocolResponse)
	object (ExchangeServiceOrder) Ordering and billing reference details for this Exchange Service.
	object (Project)
	object (SimplifiedAccount)
	Array of objects (ExchangeServiceNotification) Preferences for notifications on Internet Exchange Service configuration or status changes
	object (PlatformChangelog) Change log
	object (ExchangeServiceAdditionalInfo) Additional information regarding the specified Exchange Service

Request samples

Payload

Content type

application/json

Example

ExchangeServiceSearchProjectId

{"filter": {"and": [{"property": "/project/projectId",
"operator": "=",
"values": ["30ad25e2-53dc-11ed-bdc3-0242ac120002"
]
}
]
},
"pagination": {"limit": 25,
"offset": 0
},
"sort": [{"property": "/changeLog/updatedDateTime",
"direction": "DESC"
}
]
}

Response samples

200
400
401
403
500

Content type

application/json

{"pagination": {"offset": 0,
"limit": 10,
"total": 1
},
"sort": [{"property": "/changeLog/updatedDateTime",
"direction": "DESC"
}
],
"data": [{"href": "https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011",
"uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
"type": "IX",
"name": "ix_exchange_service",
"bandwidth": 400000,
"description": "ix_exchange_service",
"state": "PROVISIONING",
"location": {"metroHref": "https://api.equinix.com/fabric/v4/metros/SV",
"metroCode": "SV"
},
"publicPeeringConnection": {"type": "IX_VC",
"href": "https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4",
"uuid": "b44c6e6c-2c36-4488-b3f1-47064357b5b4"
},
"routingProtocol": {"customerAsn": 5555,
"macAddress": "00:11:22:33:44:55",
"vlan": 99,
"routeServerAsn": 24115,
"bgpIpv4": {"customerPeerIp": "12.1.1.1",
"domainName": "gw01.sin.example.net",
"primaryRouteServerIp": "10.1.1.1",
"secondaryRouteServerIp": "10.1.1.2",
"asSet": "AS-EC-SV",
"mlpeEnabled": true,
"md5AuthKey": "TESTMD5Key12345",
"prefixes": ["203.0.113.0/24"
],
"maxPrefixLimit": 300,
"prependSelfEnabled": true
},
"bgpIpv6": {"customerPeerIp": "2001:db8:c59b::22",
"domainName": "gw01.sin.example.net",
"primaryRouteServerIp": "2001:db8:c59b::33",
"secondaryRouteServerIp": "2001:db8:c59b::322",
"asSet": "AS-EC-SV",
"mlpeEnabled": true,
"md5AuthKey": "TESTMD5Key123456",
"prefixes": ["2001:DB8:123::/48"
],
"maxPrefixLimit": 300,
"prependSelfEnabled": true
},
"routeCollector": {"asn": 1238,
"ipV4": "10.255.255.254",
"ipV6": "2001:db8:85a3::8a2e:370:7334"
}
},
"order": {"purchaseOrderNumber": "1-3456576",
"orderNumber": "1-139105284200"
},
"project": {"projectId": "e275485c-7072-439f-943a-c923548b2be5"
},
"account": {"accountNumber": 100179
},
"notifications": [{"type": "NOTIFICATION",
"registeredUsers": ["jaguarsuser-port-order"
]
}
],
"changelog": {"updatedBy": "12345",
"updatedDateTime": "2025-08-30T07:21:39Z"
},
"additionalInfo": {"errorCode": "EQ-3058039",
"errorMessage": "Unable to activate Exchange Service Port. Please verify your configuration or contact support."
}
}
]
}

Create Internet Exchange Service Action

This API provides capability to perform actions on Internet Exchange Service

Authorizations:

BearerAuth

path Parameters

exchangeServiceId

required

string <uuid>

Example: a8ba52de-faae-43b5-b0b1-6904d37ee011

Internet Exchange Service Id

Request Body schema: application/json
required

type

required

string

Enum: "EXCHANGE_SERVICE_ACTIVATE" "EXCHANGE_SERVICE_VALIDATE" "EXCHANGE_SERVICE_RETRY_PROVISION"

Responses

Request samples

Payload

Content type

application/json

Example

ActivateExchangeServiceRequest

{"type": "EXCHANGE_SERVICE_ACTIVATE"
}

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/exchangeService/a8ba52de-faae-43b5-b0b1-6904d37ee011/actions/3a58dd05-f46d-4b1d-a154-2e85c396ea62",
"type": "EXCHANGE_SERVICE_ACTIVATE",
"uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",
"state": "SUCCEEDED",
"changelog": {"createdDateTime": "2026-02-10T11:30:00Z",
"createdBy": "Alice"
}
}

Cross Connects

Cross Connects ^Beta

Create Cross Connect

The API provides capability to create a new Cross Connect.

Authorizations:

BearerAuth

Request Body schema: application/json
required

type

required

string (CrossConnectType)

Value: "XC"

Type of Cross Connect.

name

required

string [ 3 .. 50 ] characters

A short, descriptive name for this Cross Connect.

bmmrType

string

Enum: "EQUINIX" "SELF"

Required when connecting to a BMMR.
Use EQUINIX when BMMR Extension is required and Equinix installs it, or SELF when you install it yourself.

circuitId

string

Circuit identifier of the Cross Connect.

object

Provide it to place a diverse Cross Connect against an existing one - set group to the redundancy group id or the serial number of the existing Cross Connect, and priority to SECONDARY.

group	string Redundancy group identifier. When placing a diverse Cross Connect against an existing one, provide either this identifier or the serial number of the existing Cross Connect.
priority	string Enum: "PRIMARY" "SECONDARY" Priority within the redundancy group.

required

object (CrossConnectASideRequest)

A-Side connection details.

object

Cross Connect Demarcation Point - patch panel and port details.

patchPanelId required	string Patch Panel Identifier.
patchPanelPortA	integer Specify the desired port number. When ports are not provided, next available ports will be used.
patchPanelPortB	integer Specify the desired port number. When ports are not provided, next available ports will be used. Required for Connector type FC and ST only.
connectorType required	string (CrossConnectConnectorType) Connector Type.

required

object (CrossConnectZSideRequest)

Z-Side connection details.
Provide the DemarcationPoint, the LOA reference or the BMMR location depending on the Cross Connect being requested.

object (CrossConnectZSideRequestDemarcationPoint)

Required for a patch panel to patch panel Cross Connect.

patchPanelId	string Patch Panel Identifier.
patchPanelPortA	integer Specify the desired port number. When ports are not provided, next available ports will be used.
patchPanelPortB	integer Specify the desired port number. When ports are not provided, next available ports will be used. Required for Connector type FC and ST only.
connectorType	string (CrossConnectConnectorType) Connector Type.
cageUniqueSpaceId	string Unique identifier of the Cage.
cabinetUniqueSpaceId	string Unique identifier of the Cabinet.

object

Required when connecting to a BMMR.

ibxCode

string

IBX Code.

object

Required for a Cross Connect with LOA and when bmmrType is EQUINIX.

uuid	string <uuid> LOA Identifier - Attachment UUID or LOA UUID.

object

Preferred installation schedule. When omitted, the Cross Connect is scheduled with the STANDARD schedule code.

type	string Value: "XC_INSTALL_SCHEDULE" Schedule type.
code required	string (ScheduleType) Enum: "STANDARD" "FLEXIBLE" "EXPEDITE" Schedule Code.
autoConvertToStandard	boolean Applicable only when the code is EXPEDITE. When true, Equinix schedules the Cross Connect as STANDARD when no EXPEDITE scheduling is available.
readinessDateTime	string <date-time> Carrier Circuit delivery date is the date when the Carrier commits to enable the circuit. Your order will be placed on hold, pending the date you enter. Equinix will wait for the Carrier to deliver the service and then will complete the installation.
requestedDateTime	string <date-time> Requested Installation Date and Time.

Array of objects (CrossConnectServiceRequest)

Cross Connect Services.

Array

type required	string (CrossConnectServiceType) Enum: "XC_LINK_LIGHT_VERIFICATION" "XC_PATCH_EQUIPMENT" Type of service ordered alongside the Cross Connect. XC_LINK_LIGHT_VERIFICATION - To verify transmit and receive alignment after the Cross Connect is Provisioned. XC_PATCH_EQUIPMENT - Equinix will install the Cross Connect from the demarcation panel to your equipment device.
	object Patch equipment device details. Required for the XC_PATCH_EQUIPMENT service.
description	string <= 100 characters Additional notes for the service. Required for the XC_PATCH_EQUIPMENT service.

Array of objects (CrossConnectNotification)

Preferences for notifications on Cross Connect configuration or status changes.

Array

type required	string (NotificationType) Enum: "ORDERING" "TECHNICAL" "NOTIFICATION" "PROVIDER_NOTIFICATION" "TECHNICAL_UNREGISTERED" Notification Type.
firstName	string First name of the unregistered contact. Applicable only to the TECHNICAL_UNREGISTERED type.
lastName	string Last name of the unregistered contact. Applicable only to the TECHNICAL_UNREGISTERED type.
emails required	Array of strings <email> [ items <email > ] Email addresses for notifications.
registeredUsers	Array of strings Registered users for notifications.
	Array of objects (CrossConnectPhone) Contact phone numbers.

object (OrderRequest)

Cross Connect Order.

orderNumber

string

Order Number.

orderLineItemNumber

string

Order Line Item Number.

object (PurchaseOrder)

Purchase Order information associated with the account.

number	string Purchase Order number.
amount	string Purchase Order amount.
startDate	string <date> Date the Purchase Order takes effect.
endDate	string <date> Date the Purchase Order expires.
attachmentId	string <uuid> Identifier of the uploaded purchase order document.
type	string Enum: "EXEMPTION" "EXISTING" "NEW" Purchase Order type.

customerReferenceId

string

Customer Reference Identifier.

Array of objects (CrossConnectNoteRequest) <= 1 items

Additional Note.

Array (<= 1 items)

comments

required

string <= 4000 characters

Note comments.

Array of objects (CrossConnectAttachment) <= 5 items

Additional Attachments.

Array (<= 5 items)

attachmentId

required

string <uuid>

Attachment Identifier.

Responses

Request samples

Payload

Content type

application/json

Example

Standard Cross Connect

Minimal Cross Connect request with only the required fields.

{"type": "XC",
"name": "My-CC-service",
"aSide": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1259684",
"patchPanelPortA": 35,
"patchPanelPortB": 32,
"connectorType": "SC"
}
},
"zSide": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1259684",
"patchPanelPortA": 12,
"patchPanelPortB": 24,
"connectorType": "SC"
}
},
"schedule": {"code": "STANDARD",
"requestedDateTime": "2026-02-27T07:21:39Z"
}
}

Response samples

Content type

application/json

Example

Standard Cross Connect By Patch Panel

{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743",
"type": "XC",
"name": "My-CC-service",
"uuid": "46bb1a31-c28f-4197-8b10-06e0e03d0743",
"state": "PROVISIONING",
"serialNumber": "234567890",
"redundancy": {"group": "7cf39156-9dec-40f7-a254-9bb401342e83",
"priority": "PRIMARY"
},
"aSide": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1259684",
"patchPanelPortA": 35,
"patchPanelPortB": 32,
"connectorType": "SC",
"cageUniqueSpaceId": "SV1:00:000000",
"cabinetUniqueSpaceId": "SV1:00:000000:0100"
},
"location": {"ibxCode": "SV1"
}
},
"zSide": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1259684",
"patchPanelPortA": 45,
"patchPanelPortB": 32,
"connectorType": "SC",
"cageUniqueSpaceId": "SV2:00:000000",
"cabinetUniqueSpaceId": "SV2:00:000000:0100"
},
"location": {"ibxCode": "SV1"
}
},
"account": {"accountNumber": 123456
},
"notifications": [{"type": "ORDERING",
"emails": ["abc@test.com"
],
"phone": [{"type": "MOBILE",
"number": "+14085551234",
"contactPreference": {"timezone": "PST",
"availability": "ANYTIME"
}
}
]
},
{"type": "TECHNICAL",
"emails": ["abc@test.com"
],
"phone": [{"type": "MOBILE",
"number": "+14085551234",
"contactPreference": {"timezone": "PST",
"availability": "ANYTIME"
}
}
]
},
{"type": "NOTIFICATION",
"emails": ["abc@test.com"
]
}
],
"order": {"orderNumber": "1-1234567890",
"customerReferenceId": "12345"
},
"links": [{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules",
"rel": "getCrossConnectSchedulesByUuid",
"method": "GET",
"contentType": "application/json",
"authenticate": true
},
{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services",
"rel": "getCrossConnectServicesByUuid",
"method": "GET",
"contentType": "application/json",
"authenticate": true
},
{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes",
"rel": "getCrossConnectNotesByUuid",
"method": "GET",
"contentType": "application/json",
"authenticate": true
},
{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments",
"rel": "getCrossConnectAttachmentsByUuid",
"method": "GET",
"contentType": "application/json",
"authenticate": true
}
],
"changeLog": {"createdDateTime": "2026-02-28T07:21:39Z",
"createdBy": "testuser"
}
}

Create Diverse Cross Connect

The API provides capability to create several Cross Connects in a single order - a diverse pair where the PRIMARY and the SECONDARY Cross Connect are placed at the same time, or multiple Cross Connects by sending one entry per Cross Connect.

Authorizations:

BearerAuth

Request Body schema: application/json
required

required

Array of objects (CreateCrossConnect) non-empty

For a diverse pair, send two entries - one with redundancy.priority PRIMARY and one with SECONDARY - and omit redundancy.group, which Equinix assigns.

Array (non-empty)

type required	string (CrossConnectType) Value: "XC" Type of Cross Connect.
name required	string [ 3 .. 50 ] characters A short, descriptive name for this Cross Connect.
bmmrType	string Enum: "EQUINIX" "SELF" Required when connecting to a BMMR. Use EQUINIX when BMMR Extension is required and Equinix installs it, or SELF when you install it yourself.
circuitId	string Circuit identifier of the Cross Connect.
	object Provide it to place a diverse Cross Connect against an existing one - set group to the redundancy group id or the serial number of the existing Cross Connect, and priority to SECONDARY.
required	object (CrossConnectASideRequest) A-Side connection details.
required	object (CrossConnectZSideRequest) Z-Side connection details. Provide the DemarcationPoint, the LOA reference or the BMMR location depending on the Cross Connect being requested.
	object Preferred installation schedule. When omitted, the Cross Connect is scheduled with the STANDARD schedule code.
	Array of objects (CrossConnectServiceRequest) Cross Connect Services.
	Array of objects (CrossConnectNotification) Preferences for notifications on Cross Connect configuration or status changes.
	object (OrderRequest) Cross Connect Order.
	Array of objects (CrossConnectNoteRequest) <= 1 items Additional Note.
	Array of objects (CrossConnectAttachment) <= 5 items Additional Attachments.

Responses

Request samples

Payload

Content type

application/json

Two Cross Connects placed at the same time on separate patch panels - one PRIMARY and one SECONDARY.

{"data": [{"type": "XC",
"name": "My-CC-service-PRI",
"redundancy": {"priority": "PRIMARY"
},
"aSide": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1259684",
"patchPanelPortA": 35,
"patchPanelPortB": 32,
"connectorType": "SC"
}
},
"zSide": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1259684",
"patchPanelPortA": 12,
"patchPanelPortB": 24,
"connectorType": "SC"
}
},
"schedule": {"code": "STANDARD",
"requestedDateTime": "2026-02-27T07:21:39Z"
},
"notifications": [{"type": "TECHNICAL",
"emails": ["abc@test.com"
],
"phone": [{"type": "MOBILE",
"number": "+14085551234",
"contactPreference": {"timezone": "PST",
"availability": "ANYTIME"
}
}
]
}
],
"order": {"customerReferenceId": "12345"
}
},
{"type": "XC",
"name": "My-CC-service-SEC",
"redundancy": {"priority": "SECONDARY"
},
"aSide": {"demarcationPoint": {"patchPanelId": "PP:Demarc:1260379",
"patchPanelPortA": 14,
"patchPanelPortB": 15,
"connectorType": "SC"
}
},
"zSide": {"demarcationPoint": {"patchPanelId": "PP:Demarc:1260379",
"patchPanelPortA": 22,
"patchPanelPortB": 23,
"connectorType": "SC"
}
},
"schedule": {"code": "STANDARD",
"requestedDateTime": "2026-02-27T07:21:39Z"
},
"notifications": [{"type": "TECHNICAL",
"emails": ["abc@test.com"
],
"phone": [{"type": "MOBILE",
"number": "+14085551234",
"contactPreference": {"timezone": "PST",
"availability": "ANYTIME"
}
}
]
}
],
"order": {"customerReferenceId": "12345"
}
}
]
}

Response samples

Content type

application/json

{"data": [{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743",
"type": "XC",
"uuid": "46bb1a31-c28f-4197-8b10-06e0e03d0743",
"name": "My-CC-service-PRI",
"state": "PROVISIONING",
"serialNumber": "234567890",
"redundancy": {"group": "7cf39156-9dec-40f7-a254-9bb401342e83",
"priority": "PRIMARY"
},
"aSide": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1259684",
"patchPanelPortA": 35,
"patchPanelPortB": 32,
"connectorType": "SC",
"cageUniqueSpaceId": "SV1:00:000000",
"cabinetUniqueSpaceId": "SV1:00:000000:0100"
},
"location": {"ibxCode": "SV1"
}
},
"zSide": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1259684",
"patchPanelPortA": 12,
"patchPanelPortB": 24,
"connectorType": "SC",
"cageUniqueSpaceId": "SV2:00:000000",
"cabinetUniqueSpaceId": "SV2:00:000000:0100"
}
},
"account": {"accountNumber": 123456
},
"notifications": [{"type": "ORDERING",
"emails": ["abc@test.com"
],
"phone": [{"type": "MOBILE",
"number": "+14085551234",
"contactPreference": {"timezone": "PST",
"availability": "ANYTIME"
}
}
]
},
{"type": "TECHNICAL",
"emails": ["abc@test.com"
],
"phone": [{"type": "MOBILE",
"number": "+14085551234",
"contactPreference": {"timezone": "PST",
"availability": "ANYTIME"
}
}
]
},
{"type": "NOTIFICATION",
"emails": ["abc@test.com"
]
}
],
"order": {"orderNumber": "1-1234567890",
"customerReferenceId": "12345"
},
"links": [{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules",
"rel": "getCrossConnectSchedulesByUuid",
"method": "GET",
"contentType": "application/json",
"authenticate": true
},
{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services",
"rel": "getCrossConnectServicesByUuid",
"method": "GET",
"contentType": "application/json",
"authenticate": true
},
{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes",
"rel": "getCrossConnectNotesByUuid",
"method": "GET",
"contentType": "application/json",
"authenticate": true
},
{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments",
"rel": "getCrossConnectAttachmentsByUuid",
"method": "GET",
"contentType": "application/json",
"authenticate": true
}
],
"changeLog": {"createdDateTime": "2026-02-28T07:21:39Z",
"createdBy": "testuser"
}
},
{"href": "https://api.equinix.com/fabric/v4/crossConnects/a6f77b33-96c6-4eeb-8d79-76374d950603",
"type": "XC",
"uuid": "a6f77b33-96c6-4eeb-8d79-76374d950603",
"name": "My-CC-service-SEC",
"state": "PROVISIONING",
"serialNumber": "234567891",
"redundancy": {"group": "7cf39156-9dec-40f7-a254-9bb401342e83",
"priority": "SECONDARY"
},
"aSide": {"demarcationPoint": {"patchPanelId": "PP:Demarc:1260379",
"patchPanelPortA": 14,
"patchPanelPortB": 15,
"connectorType": "SC",
"cageUniqueSpaceId": "SV1:00:000000",
"cabinetUniqueSpaceId": "SV1:00:000000:0100"
},
"location": {"ibxCode": "SV1"
}
},
"zSide": {"demarcationPoint": {"patchPanelId": "PP:Demarc:1260379",
"patchPanelPortA": 22,
"patchPanelPortB": 23,
"connectorType": "SC",
"cageUniqueSpaceId": "SV2:00:000000",
"cabinetUniqueSpaceId": "SV2:00:000000:0100"
}
},
"account": {"accountNumber": 123456
},
"notifications": [{"type": "ORDERING",
"emails": ["abc@test.com"
],
"phone": [{"type": "MOBILE",
"number": "+14085551234",
"contactPreference": {"timezone": "PST",
"availability": "ANYTIME"
}
}
]
},
{"type": "TECHNICAL",
"emails": ["abc@test.com"
],
"phone": [{"type": "MOBILE",
"number": "+14085551234",
"contactPreference": {"timezone": "PST",
"availability": "ANYTIME"
}
}
]
},
{"type": "NOTIFICATION",
"emails": ["abc@test.com"
]
}
],
"order": {"orderNumber": "1-1234567891",
"customerReferenceId": "12345"
},
"links": [{"href": "https://api.equinix.com/fabric/v4/crossConnects/a6f77b33-96c6-4eeb-8d79-76374d950603/schedules",
"rel": "getCrossConnectSchedulesByUuid",
"method": "GET",
"contentType": "application/json",
"authenticate": true
},
{"href": "https://api.equinix.com/fabric/v4/crossConnects/a6f77b33-96c6-4eeb-8d79-76374d950603/services",
"rel": "getCrossConnectServicesByUuid",
"method": "GET",
"contentType": "application/json",
"authenticate": true
},
{"href": "https://api.equinix.com/fabric/v4/crossConnects/a6f77b33-96c6-4eeb-8d79-76374d950603/notes",
"rel": "getCrossConnectNotesByUuid",
"method": "GET",
"contentType": "application/json",
"authenticate": true
},
{"href": "https://api.equinix.com/fabric/v4/crossConnects/a6f77b33-96c6-4eeb-8d79-76374d950603/attachments",
"rel": "getCrossConnectAttachmentsByUuid",
"method": "GET",
"contentType": "application/json",
"authenticate": true
}
],
"changeLog": {"createdDateTime": "2026-02-28T07:21:39Z",
"createdBy": "testuser"
}
}
]
}

Search Cross Connects

The API provides capability to get list of user's Cross Connects using search criteria, including optional filtering, pagination and sorting.

Authorizations:

BearerAuth

Request Body schema: application/json
required

object (CrossConnectSearchFilters)

Array of CrossConnectSearchSimpleExpressions (object) or CrossConnectOrFilter (object) (CrossConnectFilter) <= 8 items

Array (<= 8 items)

Any of

property	string (CrossConnectFieldName) Enum: "/uuid" "/name" "/type" "/state" "/bmmrType" "/circuitId" "/serialNumber" "/redundancy/group" "/redundancy/priority" "/aSide/demarcationPoint/patchPanelId" "/aSide/demarcationPoint/patchPanelPortA" "/aSide/demarcationPoint/patchPanelPortB" "/aSide/location/ibxCode" "/zSide/demarcationPoint/patchPanelId" "/zSide/demarcationPoint/patchPanelPortA" "/zSide/demarcationPoint/patchPanelPortB" "/zSide/location/ibxCode" "/zSide/loa/uuid" "/account/accountNumber" "/order/orderNumber" "/order/customerReferenceId" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" Possible field names to use on filters.
operator	string Enum: "=" "!=" "LIKE" "ILIKE" "BETWEEN" "NOT BETWEEN" "IN" "NOT IN" ">" "<" ">=" "<="
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (CrossConnectSortCriteria)

Array

direction	string Default: "DESC" Enum: "DESC" "ASC" Sorting direction.
property	string Default: "/changeLog/updatedDateTime" Enum: "/name" "/state" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" Possible field names to use on sorting.

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (CrossConnectSortCriteria)

Array

direction	string Default: "DESC" Enum: "DESC" "ASC" Sorting direction.
property	string Default: "/changeLog/updatedDateTime" Enum: "/name" "/state" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" Possible field names to use on sorting.

Array of objects (CrossConnectResponse)

Array

href	string <uri> Cross Connect URI.
type	string (CrossConnectType) Value: "XC" Type of Cross Connect.
uuid	string <uuid> Cross Connect Identifier.
name	string A short, descriptive name for this Cross Connect.
state	string (CrossConnectState) Enum: "PENDING" "PENDING_ACTION" "PROVISIONING" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONED" "CANCELLING" "CANCELLED" "FAILED" Cross Connect State.
	Array of objects List of actions that can be performed on the Cross Connect based on its current state. Use these values to determine which action types are valid to submit to the actions endpoint.
bmmrType	string (BmmrType) Enum: "EQUINIX" "SELF" Cross Connect BMMR Type.
mediaType	string Media type of the Cross Connect.
mediaSubType	string Media sub-type of the Cross Connect.
circuitId	string Circuit identifier of the Cross Connect.
serialNumber	string Serial number of the Cross Connect.
	object (CrossConnectRedundancy) Cross Connect Redundancy.
	object (CrossConnectASideResponse) A-Side connection details.
	object (CrossConnectZSideResponse) Z-Side connection details.
	object (CrossConnectAccount) Account the Cross Connect belongs to.
	Array of objects (CrossConnectNotification) Preferences for notifications on Cross Connect configuration or status changes.
	object (OrderResponse) Cross Connect Order.
	Array of objects (CrossConnectLink) Links to the Cross Connect sub-resources - schedules, services, notes and attachments.
	object (CrossConnectChangelog) Cross Connect Change Log.

Request samples

Payload

Content type

application/json

Example

SearchByNameWithState

{"filter": {"and": [{"property": "/name",
"operator": "LIKE",
"values": ["My-CC-service"
]
},
{"property": "/state",
"operator": "IN",
"values": ["PENDING",
"PENDING_ACTION"
]
}
]
},
"pagination": {"limit": 25,
"offset": 0
},
"sort": [{"property": "/changeLog/updatedDateTime",
"direction": "DESC"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 25,
"total": 1
},
"sort": [{"property": "/changeLog/updatedDateTime",
"direction": "DESC"
}
],
"data": [{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743",
"type": "XC",
"uuid": "46bb1a31-c28f-4197-8b10-06e0e03d0743",
"name": "My-CC-service",
"state": "PROVISIONING",
"serialNumber": "234567890",
"redundancy": {"group": "7cf39156-9dec-40f7-a254-9bb401342e83",
"priority": "PRIMARY"
},
"aSide": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1259684",
"patchPanelPortA": 35,
"patchPanelPortB": 32,
"connectorType": "SC",
"cageUniqueSpaceId": "SV1:00:000000",
"cabinetUniqueSpaceId": "SV1:00:000000:0100"
},
"location": {"ibxCode": "SV1"
}
},
"zSide": {"loa": {"href": "https://api.equinix.com/fabric/v4/loas/b51f485e-3094-42de-8797-0ef19a51df79",
"uuid": "c61f485e-3094-42de-8797-0ef19a51df79"
},
"location": {"ibxCode": "SV1"
}
},
"account": {"accountNumber": 123456
},
"notifications": [{"type": "ORDERING",
"emails": ["abc@test.com"
],
"phone": [{"type": "MOBILE",
"number": "+14085551234",
"contactPreference": {"timezone": "PST",
"availability": "ANYTIME"
}
}
]
},
{"type": "TECHNICAL",
"emails": ["abc@test.com"
],
"phone": [{"type": "MOBILE",
"number": "+14085551234",
"contactPreference": {"timezone": "PST",
"availability": "ANYTIME"
}
}
]
},
{"type": "NOTIFICATION",
"emails": ["abc@test.com"
]
}
],
"order": {"orderNumber": "1-1234567890",
"customerReferenceId": "12345"
},
"links": [{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules",
"rel": "getCrossConnectSchedulesByUuid",
"method": "GET",
"contentType": "application/json",
"authenticate": true
},
{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services",
"rel": "getCrossConnectServicesByUuid",
"method": "GET",
"contentType": "application/json",
"authenticate": true
},
{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes",
"rel": "getCrossConnectNotesByUuid",
"method": "GET",
"contentType": "application/json",
"authenticate": true
},
{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments",
"rel": "getCrossConnectAttachmentsByUuid",
"method": "GET",
"contentType": "application/json",
"authenticate": true
}
],
"changeLog": {"createdDateTime": "2026-02-26T07:21:39Z",
"createdBy": "testuser",
"updatedDateTime": "2026-02-28T07:21:39Z",
"updatedBy": "1234"
}
}
]
}

Get Cross Connect

The API provides capability to get Cross Connect details by Cross Connect ID.

Authorizations:

BearerAuth

path Parameters

crossConnectId

required

string <uuid>

Example: 46bb1a31-c28f-4197-8b10-06e0e03d0743

Cross Connect UUID.

Responses

Response Schema: application/json

href

string <uri>

Cross Connect URI.

type

string (CrossConnectType)

Value: "XC"

Type of Cross Connect.

uuid

string <uuid>

Cross Connect Identifier.

name

string

A short, descriptive name for this Cross Connect.

state

string (CrossConnectState)

Enum: "PENDING" "PENDING_ACTION" "PROVISIONING" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONED" "CANCELLING" "CANCELLED" "FAILED"

Cross Connect State.

Array of objects

List of actions that can be performed on the Cross Connect based on its current state. Use these values to determine which action types are valid to submit to the actions endpoint.

Array

type

string (CrossConnectActionType)

Enum: "XC_SIGNATURE_SUBMISSION" "XC_PROPOSED_DATE_TIME_ACCEPTANCE" "XC_PROPOSED_DATE_TIME_REJECTION" "XC_CANCEL" "XC_DEINSTALL" "XC_INFORMATION_UPDATE"

Action to perform on the Cross Connect. The applicable action types are listed in the allowedActions of the Cross Connect.
XC_SIGNATURE_SUBMISSION - resend the quote to the customer email for signature.
XC_PROPOSED_DATE_TIME_ACCEPTANCE - accept the date and time proposed by Equinix.
XC_PROPOSED_DATE_TIME_REJECTION - reject the date and time proposed by Equinix. The expedite is cancelled and the Cross Connect is scheduled as STANDARD.
XC_CANCEL - cancel the Cross Connect before it is provisioned.
XC_DEINSTALL - remove a provisioned Cross Connect. Provide the removal schedule, and optionally the services, the notification contacts and the order details, in data.
XC_INFORMATION_UPDATE - provide the requested information as a note and an attachment.

bmmrType

string (BmmrType)

Enum: "EQUINIX" "SELF"

Cross Connect BMMR Type.

mediaType

string

Media type of the Cross Connect.

mediaSubType

string

Media sub-type of the Cross Connect.

circuitId

string

Circuit identifier of the Cross Connect.

serialNumber

string

Serial number of the Cross Connect.

object (CrossConnectRedundancy)

Cross Connect Redundancy.

group	string Redundancy group identifier. When placing a diverse Cross Connect against an existing one, provide either this identifier or the serial number of the existing Cross Connect.
priority	string Enum: "PRIMARY" "SECONDARY" Priority within the redundancy group.

object (CrossConnectASideResponse)

A-Side connection details.

object (CrossConnectASideDemarcationPoint)

A-Side demarcation point.
cageUniqueSpaceId and cabinetUniqueSpaceId identify the A-Side space.

patchPanelId	string Patch Panel Identifier.
patchPanelPortA	integer Specify the desired port number. When ports are not provided, next available ports will be used.
patchPanelPortB	integer Specify the desired port number. When ports are not provided, next available ports will be used. Required for Connector type FC and ST only.
connectorType	string (CrossConnectConnectorType) Connector Type.
cageUniqueSpaceId	string Unique identifier of the Cage.
cabinetUniqueSpaceId	string Unique identifier of the Cabinet.

object (CrossConnectLocation)

Cross Connect Location details.

ibxCode

string

IBX Code.

object (CrossConnectZSideResponse)

Z-Side connection details.

object (CrossConnectZSideResponseDemarcationPoint)

Z-Side demarcation point.
cageUniqueSpaceId and cabinetUniqueSpaceId identify the Z-Side space.

patchPanelId	string Patch Panel Identifier.
patchPanelPortA	integer Specify the desired port number. When ports are not provided, next available ports will be used.
patchPanelPortB	integer Specify the desired port number. When ports are not provided, next available ports will be used. Required for Connector type FC and ST only.
connectorType	string (CrossConnectConnectorType) Connector Type.
cageUniqueSpaceId	string Unique identifier of the Cage.
cabinetUniqueSpaceId	string Unique identifier of the Cabinet.

object (CrossConnectLocation)

Cross Connect Location details.

ibxCode

string

IBX Code.

object (CrossConnectLoaRef)

LOA Reference for Cross Connect. Provide either uuid or digitalLoaId.

href	string <uri> LOA URI.
uuid	string <uuid> LOA Identifier - Attachment UUID or LOA UUID.

object (CrossConnectAccount)

Account the Cross Connect belongs to.

accountNumber

integer <int64>

Account number.

Array of objects (CrossConnectNotification)

Preferences for notifications on Cross Connect configuration or status changes.

Array

type required	string (NotificationType) Enum: "ORDERING" "TECHNICAL" "NOTIFICATION" "PROVIDER_NOTIFICATION" "TECHNICAL_UNREGISTERED" Notification Type.
firstName	string First name of the unregistered contact. Applicable only to the TECHNICAL_UNREGISTERED type.
lastName	string Last name of the unregistered contact. Applicable only to the TECHNICAL_UNREGISTERED type.
emails required	Array of strings <email> [ items <email > ] Email addresses for notifications.
registeredUsers	Array of strings Registered users for notifications.
	Array of objects (CrossConnectPhone) Contact phone numbers.

object (OrderResponse)

Cross Connect Order.

orderNumber

string

Order Number.

orderLineItemNumber

string

Order Line Item Number.

object (PurchaseOrder)

Purchase Order information associated with the account.

number	string Purchase Order number.
amount	string Purchase Order amount.
startDate	string <date> Date the Purchase Order takes effect.
endDate	string <date> Date the Purchase Order expires.
attachmentId	string <uuid> Identifier of the uploaded purchase order document.
type	string Enum: "EXEMPTION" "EXISTING" "NEW" Purchase Order type.

customerReferenceId

string

Customer Reference Identifier.

Array of objects (CrossConnectLink)

Links to the Cross Connect sub-resources - schedules, services, notes and attachments.

Array

href	string <uri> Sub-resource URI.
rel	string Operation identifier of the linked sub-resource.
method	string HTTP method to use on the sub-resource.
contentType	string Content type returned by the sub-resource.
authenticate	boolean Whether authentication is required.

object (CrossConnectChangelog)

Cross Connect Change Log.

createdDateTime	string <date-time> Created Date and Time.
createdBy	string User key of the user who created the resource.
updatedDateTime	string <date-time> Updated Date and Time.
updatedBy	string User key of the user who last updated the resource.

Response samples

Content type

application/json

Example

Standard Cross Connect By Patch Panel

{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743",
"type": "XC",
"name": "My-CC-service",
"uuid": "46bb1a31-c28f-4197-8b10-06e0e03d0743",
"state": "PROVISIONING",
"serialNumber": "234567890",
"redundancy": {"group": "7cf39156-9dec-40f7-a254-9bb401342e83",
"priority": "PRIMARY"
},
"aSide": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1259684",
"patchPanelPortA": 35,
"patchPanelPortB": 32,
"connectorType": "SC",
"cageUniqueSpaceId": "SV1:00:000000",
"cabinetUniqueSpaceId": "SV1:00:000000:0100"
},
"location": {"ibxCode": "SV1"
}
},
"zSide": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1259684",
"patchPanelPortA": 45,
"patchPanelPortB": 32,
"connectorType": "SC",
"cageUniqueSpaceId": "SV2:00:000000",
"cabinetUniqueSpaceId": "SV2:00:000000:0100"
},
"location": {"ibxCode": "SV1"
}
},
"account": {"accountNumber": 123456
},
"notifications": [{"type": "ORDERING",
"emails": ["abc@test.com"
],
"phone": [{"type": "MOBILE",
"number": "+14085551234",
"contactPreference": {"timezone": "PST",
"availability": "ANYTIME"
}
}
]
},
{"type": "TECHNICAL",
"emails": ["abc@test.com"
],
"phone": [{"type": "MOBILE",
"number": "+14085551234",
"contactPreference": {"timezone": "PST",
"availability": "ANYTIME"
}
}
]
},
{"type": "NOTIFICATION",
"emails": ["abc@test.com"
]
}
],
"order": {"orderNumber": "1-1234567890",
"customerReferenceId": "12345"
},
"links": [{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules",
"rel": "getCrossConnectSchedulesByUuid",
"method": "GET",
"contentType": "application/json",
"authenticate": true
},
{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services",
"rel": "getCrossConnectServicesByUuid",
"method": "GET",
"contentType": "application/json",
"authenticate": true
},
{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes",
"rel": "getCrossConnectNotesByUuid",
"method": "GET",
"contentType": "application/json",
"authenticate": true
},
{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments",
"rel": "getCrossConnectAttachmentsByUuid",
"method": "GET",
"contentType": "application/json",
"authenticate": true
}
],
"changeLog": {"createdDateTime": "2026-02-28T07:21:39Z",
"createdBy": "testuser"
}
}

Get Cross Connect Schedules

The API provides capability to get the schedules of a Cross Connect by Cross Connect ID.

Authorizations:

BearerAuth

path Parameters

crossConnectId

required

string <uuid>

Example: 46bb1a31-c28f-4197-8b10-06e0e03d0743

Cross Connect UUID.

Responses

Response Schema: application/json

Array of objects (CrossConnectScheduleResponse)

Array

href	string <uri> Schedule URI.
uuid	string <uuid> Schedule Identifier.
type	string Enum: "XC_INSTALL_SCHEDULE" "XC_DEINSTALL_SCHEDULE" Sub-resource type. XC_INSTALL_SCHEDULE - Installation schedule. XC_DEINSTALL_SCHEDULE - Deinstallation schedule.
code	string Enum: "STANDARD" "FLEXIBLE" "EXPEDITE" Schedule Code.
state	string Enum: "PENDING" "COMPLETED" "FAILED" "CANCELLED" "PENDING_ACTION" Cross Connect Schedule State.
autoConvertToStandard	boolean Indicates whether the Cross Connect is scheduled as STANDARD when no EXPEDITE scheduling is available. Returned only for EXPEDITE schedule.
readinessDateTime	string <date-time> Carrier Circuit delivery date is the date when the Carrier commits to enable the circuit. Your order will be placed on hold, pending the date you enter. Equinix will wait for the Carrier to deliver the service and then will complete the installation.
requestedDateTime	string <date-time> Requested Installation Date and Time.
equinixProposedDateTime	string <date-time> Date and Time proposed by Equinix when the EXPEDITE schedule is not available.
installationDateTime	string <date-time> Installation Date and Time.
deinstallationDateTime	string <date-time> Deinstallation Date and Time. Returned for a removal schedule.
	object (CrossConnectChangelog) Cross Connect Change Log.

Response samples

Content type

application/json

{"data": [{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules/e41f485e-3094-42de-8797-0ef19a51df79",
"uuid": "e41f485e-3094-42de-8797-0ef19a51df79",
"type": "XC_INSTALL_SCHEDULE",
"code": "EXPEDITE",
"state": "COMPLETED",
"autoConvertToStandard": true,
"readinessDateTime": "2026-08-23T07:21:39Z",
"requestedDateTime": "2026-08-24T07:21:39Z",
"equinixProposedDateTime": "2026-08-25T07:21:39Z",
"installationDateTime": "2026-08-25T09:21:39Z",
"changeLog": {"createdBy": "testuser",
"createdDateTime": "2026-08-22T07:21:39Z",
"updatedBy": "124",
"updatedDateTime": "2026-08-25T09:21:39Z"
}
},
{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/schedules/a11f485e-3094-42de-8797-0ef19a51df79",
"uuid": "a11f485e-3094-42de-8797-0ef19a51df79",
"type": "XC_DEINSTALL_SCHEDULE",
"code": "STANDARD",
"state": "PENDING",
"requestedDateTime": "2026-09-14T17:21:25.586Z",
"deinstallationDateTime": "2026-09-16T17:21:25.586Z",
"changeLog": {"createdBy": "testuser",
"createdDateTime": "2026-09-12T07:21:39Z"
}
}
]
}

Get Cross Connect Services

The API provides capability to get the services ordered alongside a Cross Connect by Cross Connect ID.

Authorizations:

BearerAuth

path Parameters

crossConnectId

required

string <uuid>

Example: 46bb1a31-c28f-4197-8b10-06e0e03d0743

Cross Connect UUID.

Responses

Response Schema: application/json

Array of objects (CrossConnectServiceResponse)

Array

href	string <uri> Service URI.
uuid	string <uuid> Service Identifier.
type	string Enum: "XC_LINK_LIGHT_VERIFICATION" "XC_PATCH_EQUIPMENT" Type of service ordered alongside the Cross Connect. XC_LINK_LIGHT_VERIFICATION - To verify transmit and receive alignment after the Cross Connect is Provisioned. XC_PATCH_EQUIPMENT - Equinix will install the Cross Connect from the demarcation panel to your equipment device.
state	string Enum: "PENDING" "COMPLETED" "FAILED" Service status.
	object Patch equipment device details. Returned for the XC_PATCH_EQUIPMENT service.
description	string <= 100 characters Additional notes captured for the service.
	object (CrossConnectChangelog) Cross Connect Change Log.

Response samples

Content type

application/json

{"data": [{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services/e41f485e-3094-42de-8797-0ef19a51df79",
"uuid": "e41f485e-3094-42de-8797-0ef19a51df79",
"type": "XC_LINK_LIGHT_VERIFICATION",
"state": "PENDING",
"changeLog": {"createdBy": "testuser",
"createdDateTime": "2026-02-28T07:21:39Z"
}
},
{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/services/a11f485e-3094-42de-8797-0ef19a51df79",
"uuid": "a11f485e-3094-42de-8797-0ef19a51df79",
"type": "XC_PATCH_EQUIPMENT",
"state": "PENDING",
"device": {"cabinetUniqueSpaceId": "SV2:00:000000:0100",
"port": 32,
"connectorType": "SC"
},
"description": "additional notes for patch equipment",
"changeLog": {"createdBy": "testuser",
"createdDateTime": "2026-02-28T07:21:39Z"
}
}
]
}

Get Cross Connect Attachments

The API provides capability to get the documents attached to a Cross Connect by Cross Connect ID.

Authorizations:

BearerAuth

path Parameters

crossConnectId

required

string <uuid>

Example: 46bb1a31-c28f-4197-8b10-06e0e03d0743

Cross Connect UUID.

Responses

Response Schema: application/json

Array of objects (CrossConnectAttachmentResponse)

Array

href	string <uri> URI to the attachment resource.
uuid	string <uuid> Attachment resource Identifier.
type	string Value: "ATTACHMENT" Sub-resource type.
source	string Enum: "CUSTOMER" "EQUINIX" Attachment Source.
attachmentId	string <uuid> Attachment Identifier.
downloadHref	string <uri> URI to download the attachment file content from the Equinix attachment service.
	object (CrossConnectChangelog) Cross Connect Change Log.

Response samples

Content type

application/json

{"data": [{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/e41f485e-3094-42de-8797-0ef19a51df79",
"uuid": "e41f485e-3094-42de-8797-0ef19a51df79",
"type": "ATTACHMENT",
"source": "CUSTOMER",
"attachmentId": "a11f485e-3094-42de-8797-0ef19a51df79",
"downloadHref": "https://api.equinix.com/ecp/attachments/a11f485e-3094-42de-8797-0ef19a51df79",
"changeLog": {"createdBy": "123",
"createdDateTime": "2026-02-28T07:21:39Z"
}
},
{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/a41f485e-3094-42de-8797-0ef19a51df81",
"uuid": "a41f485e-3094-42de-8797-0ef19a51df81",
"type": "ATTACHMENT",
"source": "EQUINIX",
"attachmentId": "b21f485e-3094-42de-8797-0ef19a51df80",
"downloadHref": "https://api.equinix.com/ecp/attachments/b21f485e-3094-42de-8797-0ef19a51df80",
"changeLog": {"createdBy": "EQUINIX",
"createdDateTime": "2026-02-27T07:21:39Z"
}
}
]
}

Get Cross Connect Notes

The API provides capability to get the notes added to a Cross Connect by Cross Connect ID.

Authorizations:

BearerAuth

path Parameters

crossConnectId

required

string <uuid>

Example: 46bb1a31-c28f-4197-8b10-06e0e03d0743

Cross Connect UUID.

query Parameters

offset	integer Example: offset=1 offset
limit	integer Example: limit=10 number of records to fetch

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (CrossConnectNoteResponse)

Array

href	string <uri> Note URI.
uuid	string <uuid> Note Identifier.
type	string Value: "NOTE" Sub-resource type.
source	string Enum: "CUSTOMER" "EQUINIX" Party that added the note.
comments	string <= 4000 characters Note comments.
	object The note this note is responding to. Returned when the note was added in response to an Equinix note.
	object (CrossConnectChangelog) Cross Connect Change Log.

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 10,
"total": 2
},
"data": [{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79",
"uuid": "e41f485e-3094-42de-8797-0ef19a51df79",
"type": "NOTE",
"source": "CUSTOMER",
"comments": "Additional note to EQUINIX technician.",
"changeLog": {"createdBy": "124",
"createdDateTime": "2026-02-28T07:21:39Z"
}
},
{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/a11f485e-3094-42de-8797-0ef19a51df79",
"uuid": "a11f485e-3094-42de-8797-0ef19a51df79",
"type": "NOTE",
"source": "EQUINIX",
"comments": "Please confirm the patch panel port before the scheduled installation.",
"changeLog": {"createdBy": "SYSTEM",
"createdDateTime": "2026-02-27T07:21:39Z"
}
}
]
}

Cross Connect Actions

The API provides capability to perform an action on a Cross Connect that is in the PENDING_ACTION state. The applicable action types are listed in the allowedActions of the Cross Connect.

Authorizations:

BearerAuth

path Parameters

crossConnectId

required

string <uuid>

Example: 46bb1a31-c28f-4197-8b10-06e0e03d0743

Cross Connect UUID.

Request Body schema: application/json
required

type

required

string (CrossConnectActionType)

Enum: "XC_SIGNATURE_SUBMISSION" "XC_PROPOSED_DATE_TIME_ACCEPTANCE" "XC_PROPOSED_DATE_TIME_REJECTION" "XC_CANCEL" "XC_DEINSTALL" "XC_INFORMATION_UPDATE"

Action to perform on the Cross Connect. The applicable action types are listed in the allowedActions of the Cross Connect.
XC_SIGNATURE_SUBMISSION - resend the quote to the customer email for signature.
XC_PROPOSED_DATE_TIME_ACCEPTANCE - accept the date and time proposed by Equinix.
XC_PROPOSED_DATE_TIME_REJECTION - reject the date and time proposed by Equinix. The expedite is cancelled and the Cross Connect is scheduled as STANDARD.
XC_CANCEL - cancel the Cross Connect before it is provisioned.
XC_DEINSTALL - remove a provisioned Cross Connect. Provide the removal schedule, and optionally the services, the notification contacts and the order details, in data.
XC_INFORMATION_UPDATE - provide the requested information as a note and an attachment.

object (CrossConnectActionData)

Action Data.
notes and attachments are applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL.
schedule is required for XC_DEINSTALL, where liveTrafficConsentProvided, services, notifications and order are applicable.
Not applicable to the other action types.

Array of objects (CrossConnectActionNote) <= 1 items

Applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL.

Array (<= 1 items)

	object (CrossConnectParentNote) Note that this note is responding to.
comments required	string <= 4000 characters Note comments.

Array of objects (CrossConnectAttachment) <= 5 items

Applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL.

Array (<= 5 items)

attachmentId

required

string <uuid>

Attachment Identifier.

object

Removal schedule. Required for XC_DEINSTALL - the requestedDateTime is mandatory and only the STANDARD schedule type is supported.

type	string Value: "XC_DEINSTALL_SCHEDULE" Schedule type.
code	string Default: "STANDARD" Value: "STANDARD" Schedule code of the removal. Only STANDARD is supported, and it is applied when the code is omitted.
requestedDateTime required	string <date-time> Requested Removal Date and Time.
deinstallationDateTime	string <date-time> Deinstallation Date and Time.

liveTrafficConsentProvided

boolean

Applicable for XC_DEINSTALL. Confirms the customer consents to the removal even though the Cross Connect may still be carrying live traffic.

Array of objects (CrossConnectServiceRequest)

Applicable for XC_DEINSTALL. Only XC_PATCH_EQUIPMENT is supported for deinstall.

Array

type required	string (CrossConnectServiceType) Enum: "XC_LINK_LIGHT_VERIFICATION" "XC_PATCH_EQUIPMENT" Type of service ordered alongside the Cross Connect. XC_LINK_LIGHT_VERIFICATION - To verify transmit and receive alignment after the Cross Connect is Provisioned. XC_PATCH_EQUIPMENT - Equinix will install the Cross Connect from the demarcation panel to your equipment device.
	object Patch equipment device details. Required for the XC_PATCH_EQUIPMENT service.
description	string <= 100 characters Additional notes for the service. Required for the XC_PATCH_EQUIPMENT service.

Array of objects (CrossConnectNotification)

Applicable for XC_DEINSTALL. The contacts are appended to the ones already held on the Cross Connect.

Array

type required	string (NotificationType) Enum: "ORDERING" "TECHNICAL" "NOTIFICATION" "PROVIDER_NOTIFICATION" "TECHNICAL_UNREGISTERED" Notification Type.
firstName	string First name of the unregistered contact. Applicable only to the TECHNICAL_UNREGISTERED type.
lastName	string Last name of the unregistered contact. Applicable only to the TECHNICAL_UNREGISTERED type.
emails required	Array of strings <email> [ items <email > ] Email addresses for notifications.
registeredUsers	Array of strings Registered users for notifications.
	Array of objects (CrossConnectPhone) Contact phone numbers.

object

Applicable for XC_DEINSTALL. The purchase order and the customer reference identifier replace the ones already held on the Cross Connect.

orderNumber	string Order Number.
orderLineItemNumber	string Order Line Item Number.
	object (PurchaseOrder) Purchase Order information associated with the account.
customerReferenceId	string Customer Reference Identifier.

Responses

Request samples

Payload

Content type

application/json

Example

SendSignatureQuote

{"type": "XC_SIGNATURE_SUBMISSION"
}

Response samples

Content type

application/json

Example

SendSignatureQuote

{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/30cc7878-54e3-4e1a-8651-87a61354bad4",
"uuid": "30cc7878-54e3-4e1a-8651-87a61354bad4",
"type": "XC_SIGNATURE_SUBMISSION",
"state": "COMPLETED",
"changeLog": {"createdDateTime": "2026-07-24T06:50:46Z",
"createdBy": "testuser"
}
}

Get Cross Connect Action by Action ID

The API provides capability to fetch Cross Connect action details by Action ID.

Authorizations:

BearerAuth

path Parameters

crossConnectId required	string <uuid> Example: 46bb1a31-c28f-4197-8b10-06e0e03d0743 Cross Connect UUID.
actionId required	string <uuid> Example: 30cc7878-54e3-4e1a-8651-87a61354bad4 Cross Connect Action UUID.

Responses

Response Schema: application/json

href

string <uri>

Action URI.

uuid

string <uuid>

Action Identifier.

type

string

Enum: "XC_SIGNATURE_SUBMISSION" "XC_PROPOSED_DATE_TIME_ACCEPTANCE" "XC_PROPOSED_DATE_TIME_REJECTION" "XC_CANCEL" "XC_DEINSTALL" "XC_INFORMATION_UPDATE"

Action to perform on the Cross Connect. The applicable action types are listed in the allowedActions of the Cross Connect.
XC_SIGNATURE_SUBMISSION - resend the quote to the customer email for signature.
XC_PROPOSED_DATE_TIME_ACCEPTANCE - accept the date and time proposed by Equinix.
XC_PROPOSED_DATE_TIME_REJECTION - reject the date and time proposed by Equinix. The expedite is cancelled and the Cross Connect is scheduled as STANDARD.
XC_CANCEL - cancel the Cross Connect before it is provisioned.
XC_DEINSTALL - remove a provisioned Cross Connect. Provide the removal schedule, and optionally the services, the notification contacts and the order details, in data.
XC_INFORMATION_UPDATE - provide the requested information as a note and an attachment.

state

string

Enum: "PENDING" "COMPLETED" "FAILED"

Cross Connect Action State.

object

Action Data.
notes and attachments are applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL.
schedule, services, liveTrafficConsentProvided, notifications and order are applicable for XC_DEINSTALL.
Each schedule, service, note and attachment carries the href and the uuid of the sub-resource it refers to.
Not applicable to the other action types.

Array of objects (CrossConnectActionNoteResponse) <= 1 items

Applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL.

Array (<= 1 items)

href	string <uri> Note URI.
uuid	string <uuid> Note Identifier.
	object The note this note is responding to. Returned when the note was added in response to an Equinix note.
comments	string <= 4000 characters Note comments.

Array of objects (CrossConnectActionAttachmentResponse) <= 5 items

Applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL.

Array (<= 5 items)

href	string <uri> URI to the attachment resource.
uuid	string <uuid> Attachment resource Identifier.
attachmentId	string <uuid> Attachment Identifier.

object

Applicable for XC_DEINSTALL.

href	string <uri> Schedule URI.
uuid	string <uuid> Schedule Identifier.
type	string Enum: "XC_INSTALL_SCHEDULE" "XC_DEINSTALL_SCHEDULE" Sub-resource type. XC_INSTALL_SCHEDULE - Installation schedule. XC_DEINSTALL_SCHEDULE - Deinstallation schedule.
code	string Enum: "STANDARD" "FLEXIBLE" "EXPEDITE" Schedule Code.
state	string Enum: "PENDING" "COMPLETED" "FAILED" "CANCELLED" "PENDING_ACTION" Cross Connect Schedule State.
autoConvertToStandard	boolean Indicates whether the Cross Connect is scheduled as STANDARD when no EXPEDITE scheduling is available. Returned only for EXPEDITE schedule.
readinessDateTime	string <date-time> Carrier Circuit delivery date is the date when the Carrier commits to enable the circuit. Your order will be placed on hold, pending the date you enter. Equinix will wait for the Carrier to deliver the service and then will complete the installation.
requestedDateTime	string <date-time> Requested Installation Date and Time.
equinixProposedDateTime	string <date-time> Date and Time proposed by Equinix when the EXPEDITE schedule is not available.
installationDateTime	string <date-time> Installation Date and Time.
deinstallationDateTime	string <date-time> Deinstallation Date and Time. Returned for a removal schedule.
	object (CrossConnectChangelog) Cross Connect Change Log.

liveTrafficConsentProvided

boolean

Applicable for XC_DEINSTALL. Confirms the customer consents to the removal even though the Cross Connect may still be carrying live traffic.

Array of objects (CrossConnectServiceResponse)

Applicable for XC_DEINSTALL. Only XC_PATCH_EQUIPMENT is supported for deinstall.

Array

href	string <uri> Service URI.
uuid	string <uuid> Service Identifier.
type	string Enum: "XC_LINK_LIGHT_VERIFICATION" "XC_PATCH_EQUIPMENT" Type of service ordered alongside the Cross Connect. XC_LINK_LIGHT_VERIFICATION - To verify transmit and receive alignment after the Cross Connect is Provisioned. XC_PATCH_EQUIPMENT - Equinix will install the Cross Connect from the demarcation panel to your equipment device.
state	string Enum: "PENDING" "COMPLETED" "FAILED" Service status.
	object Patch equipment device details. Returned for the XC_PATCH_EQUIPMENT service.
description	string <= 100 characters Additional notes captured for the service.
	object (CrossConnectChangelog) Cross Connect Change Log.

Array of objects (CrossConnectNotification)

Applicable for XC_DEINSTALL. The contacts are appended to the ones already held on the Cross Connect.

Array

type required	string (NotificationType) Enum: "ORDERING" "TECHNICAL" "NOTIFICATION" "PROVIDER_NOTIFICATION" "TECHNICAL_UNREGISTERED" Notification Type.
firstName	string First name of the unregistered contact. Applicable only to the TECHNICAL_UNREGISTERED type.
lastName	string Last name of the unregistered contact. Applicable only to the TECHNICAL_UNREGISTERED type.
emails required	Array of strings <email> [ items <email > ] Email addresses for notifications.
registeredUsers	Array of strings Registered users for notifications.
	Array of objects (CrossConnectPhone) Contact phone numbers.

object

Applicable for XC_DEINSTALL. The purchase order and the customer reference identifier replace the ones already held on the Cross Connect.

orderNumber	string Order Number.
orderLineItemNumber	string Order Line Item Number.
	object (PurchaseOrder) Purchase Order information associated with the account.
customerReferenceId	string Customer Reference Identifier.

object

Cross Connect Change Log.

createdDateTime	string <date-time> Created Date and Time.
createdBy	string User key of the user who created the resource.
updatedDateTime	string <date-time> Updated Date and Time.
updatedBy	string User key of the user who last updated the resource.

Response samples

Content type

application/json

Example

SendSignatureQuote

{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/30cc7878-54e3-4e1a-8651-87a61354bad4",
"uuid": "30cc7878-54e3-4e1a-8651-87a61354bad4",
"type": "XC_SIGNATURE_SUBMISSION",
"state": "COMPLETED",
"changeLog": {"createdDateTime": "2026-07-24T06:50:46Z",
"createdBy": "testuser"
}
}

Search Cross Connect Actions

The API provides capability to get list of Cross Connect Actions using search criteria, including optional filtering, pagination and sorting.

Authorizations:

BearerAuth

path Parameters

crossConnectId

required

string <uuid>

Example: 46bb1a31-c28f-4197-8b10-06e0e03d0743

Cross Connect UUID.

Request Body schema: application/json
required

object (CrossConnectActionSearchFilters)

Array of CrossConnectActionSearchSimpleExpressions (object) or CrossConnectActionOrFilter (object) (CrossConnectActionFilter) <= 8 items

Array (<= 8 items)

Any of

property	string (CrossConnectActionFieldName) Enum: "/type" "/state" "/uuid" Possible field names to use on filters.
operator	string Enum: "=" "!=" "LIKE" "ILIKE" "BETWEEN" "NOT BETWEEN" "IN" "NOT IN" ">" "<" ">=" "<="
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (CrossConnectActionSortCriteria)

Array

direction	string Default: "DESC" Enum: "DESC" "ASC" Sorting direction.
property	string Default: "/changeLog/createdDateTime" Value: "/changeLog/createdDateTime" Possible field names to use on sorting.

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (CrossConnectActionSortCriteria)

Array

direction	string Default: "DESC" Enum: "DESC" "ASC" Sorting direction.
property	string Default: "/changeLog/createdDateTime" Value: "/changeLog/createdDateTime" Possible field names to use on sorting.

Array of objects (CrossConnectActionResponse)

Array

href	string <uri> Action URI.
uuid	string <uuid> Action Identifier.
type	string Enum: "XC_SIGNATURE_SUBMISSION" "XC_PROPOSED_DATE_TIME_ACCEPTANCE" "XC_PROPOSED_DATE_TIME_REJECTION" "XC_CANCEL" "XC_DEINSTALL" "XC_INFORMATION_UPDATE" Action to perform on the Cross Connect. The applicable action types are listed in the allowedActions of the Cross Connect. XC_SIGNATURE_SUBMISSION - resend the quote to the customer email for signature. XC_PROPOSED_DATE_TIME_ACCEPTANCE - accept the date and time proposed by Equinix. XC_PROPOSED_DATE_TIME_REJECTION - reject the date and time proposed by Equinix. The expedite is cancelled and the Cross Connect is scheduled as STANDARD. XC_CANCEL - cancel the Cross Connect before it is provisioned. XC_DEINSTALL - remove a provisioned Cross Connect. Provide the removal schedule, and optionally the services, the notification contacts and the order details, in data. XC_INFORMATION_UPDATE - provide the requested information as a note and an attachment.
state	string Enum: "PENDING" "COMPLETED" "FAILED" Cross Connect Action State.
	object Action Data. notes and attachments are applicable for XC_INFORMATION_UPDATE and XC_DEINSTALL. schedule, services, liveTrafficConsentProvided, notifications and order are applicable for XC_DEINSTALL. Each schedule, service, note and attachment carries the href and the uuid of the sub-resource it refers to. Not applicable to the other action types.
	object Cross Connect Change Log.

Request samples

Payload

Content type

application/json

{"filter": {"and": [{"property": "/type",
"operator": "=",
"values": ["XC_INFORMATION_UPDATE"
]
}
]
},
"pagination": {"limit": 25,
"offset": 0
},
"sort": [{"property": "/changeLog/createdDateTime",
"direction": "DESC"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 25,
"total": 1
},
"sort": [{"property": "/changeLog/createdDateTime",
"direction": "DESC"
}
],
"data": [{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/actions/7400b2b2-98c7-4c5e-ca95-cbea5798fe08",
"uuid": "7400b2b2-98c7-4c5e-ca95-cbea5798fe08",
"type": "XC_INFORMATION_UPDATE",
"state": "COMPLETED",
"data": {"notes": [{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/e41f485e-3094-42de-8797-0ef19a51df79",
"uuid": "e41f485e-3094-42de-8797-0ef19a51df79",
"parentNote": {"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/notes/a11f485e-3094-42de-8797-0ef19a51df79",
"uuid": "a11f485e-3094-42de-8797-0ef19a51df79"
},
"comments": "Please proceed"
}
],
"attachments": [{"href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743/attachments/b41f485e-3094-42de-8797-0ef19a51df82",
"uuid": "b41f485e-3094-42de-8797-0ef19a51df82",
"attachmentId": "e41f485e-3094-42de-8797-0ef19a51df79"
}
]
},
"changeLog": {"createdDateTime": "2026-07-24T06:50:46Z",
"createdBy": "testuser"
}
}
]
}

Search Cross Connect Schedules

The API provides capability to search the Cross Connect schedule windows offered at an IBX, including optional filtering, pagination and sorting.

Authorizations:

BearerAuth

Request Body schema: application/json
required

object (CrossConnectScheduleSearchFilters)

Array of objects (CrossConnectScheduleSearchSimpleExpressions) <= 8 items

Array (<= 8 items)

property	string (CrossConnectScheduleFieldName) Enum: "/type" "/code" "/aSide/location/ibxCode" "/zSide/location/ibxCode" Possible field names to use on filters.
operator	string Enum: "=" "!=" "IN" "NOT IN"
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (CrossConnectScheduleSortCriteria)

Array

direction	string Default: "DESC" Enum: "DESC" "ASC" Sorting direction.
property	string Default: "/startDateTime" Enum: "/code" "/startDateTime" "/endDateTime" Possible field names to use on sorting.

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (CrossConnectScheduleSortCriteria)

Array

direction	string Default: "DESC" Enum: "DESC" "ASC" Sorting direction.
property	string Default: "/startDateTime" Enum: "/code" "/startDateTime" "/endDateTime" Possible field names to use on sorting.

Array of objects (CrossConnectScheduleAvailability)

Array

href	string <uri> Schedule URI.
type	string Value: "XC_INSTALL_SCHEDULE" Sub-resource type. XC_INSTALL_SCHEDULE - Installation schedule windows.
code	string Enum: "STANDARD" "FLEXIBLE" "EXPEDITE" Schedule Code.
	object A-Side of the schedule window.
	object Z-Side of the schedule window.
startDateTime	string <date-time> Start of the schedule window.
endDateTime	string <date-time> End of the schedule window.
unavailableDates	Array of strings <date> [ items <date > ] Dates within the schedule window when the IBX is unavailable, such as the holidays observed at the IBX.

Request samples

Payload

Content type

application/json

{"filter": {"and": [{"property": "/type",
"operator": "=",
"values": ["XC_INSTALL_SCHEDULE"
]
},
{"property": "/code",
"operator": "IN",
"values": ["EXPEDITE",
"FLEXIBLE",
"STANDARD"
]
},
{"property": "/aSide/location/ibxCode",
"operator": "=",
"values": ["SV11"
]
},
{"property": "/zSide/location/ibxCode",
"operator": "=",
"values": ["SV11"
]
}
]
},
"pagination": {"offset": 0,
"limit": 20
},
"sort": [{"direction": "DESC",
"property": "/startDateTime"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 3
},
"data": [{"href": "https://api.equinix.com/fabric/v4/crossConnectSchedules/EXPEDITE",
"type": "XC_INSTALL_SCHEDULE",
"code": "EXPEDITE",
"aSide": {"location": {"ibxCode": "SV11"
}
},
"zSide": {"location": {"ibxCode": "SV11"
}
},
"startDateTime": "2026-03-05T17:00:00Z",
"endDateTime": "2026-03-10T17:24:00Z",
"unavailableDates": ["2026-03-07",
"2026-03-08"
]
},
{"href": "https://api.equinix.com/fabric/v4/crossConnectSchedules/STANDARD",
"type": "XC_INSTALL_SCHEDULE",
"code": "STANDARD",
"aSide": {"location": {"ibxCode": "SV11"
}
},
"zSide": {"location": {"ibxCode": "SV11"
}
},
"startDateTime": "2026-03-10T18:00:00Z",
"endDateTime": "2026-04-10T17:24:00Z",
"unavailableDates": ["2026-03-27",
"2026-03-28",
"2026-03-29"
]
},
{"href": "https://api.equinix.com/fabric/v4/crossConnectSchedules/FLEXIBLE",
"type": "XC_INSTALL_SCHEDULE",
"code": "FLEXIBLE",
"aSide": {"location": {"ibxCode": "SV11"
}
},
"zSide": {"location": {"ibxCode": "SV11"
}
},
"startDateTime": "2026-04-10T18:00:00Z",
"endDateTime": "2026-06-10T17:24:00Z",
"unavailableDates": ["2026-04-17",
"2026-04-18",
"2026-04-19"
]
}
]
}

Loas

Loas ^Beta

Create Loa

The API provides capability to create a new Loa

Authorizations:

BearerAuth

Request Body schema: application/json
required

One of

type

required

string (LoaType)

Enum: "CAGE_LOA" "PATCH_PANEL_LOA" "PATCH_PANEL_PORT_LOA"

Type of Letter of Authorization

name

required

string [ 3 .. 50 ] characters

A short, descriptive name for this LOA.

description

string [ 0 .. 450 ] characters

Additional context about this LOA.

authorizedProductType

required

string (LoaProductType)

Enum: "XC" "XF_PORT" "VD"

Product type associated with this LOA.
XC - Cross Connect
XF_PORT - Fabric Port
VD - Network Edge

expirationDateTime

string <date-time> (LoaExpiration)

Date and time when this LOA expires.
Default to 3 months from the creation date

object (LoaRequestor)

Requestor

email	string <email> Email address of the requestor contact.
orgId	integer Organization ID of the requestor.
orgName	string Organization name of the requestor.

required

object (LoaDemarcationPoint)

Specifies the demarcation point.
For CAGE_LOA - cageUniqueSpaceId is required.
For PATCH_PANEL_LOA - patchPanelId is required.
For PATCH_PANEL_PORT_LOA - patchPanelId, patchPanelPortA, patchPanelPortB and connectorType is required.

cageUniqueSpaceId	string Unique identifier of the Cage.
cabinetUniqueSpaceId	string Unique identifier of the Cabinet.
patchPanelId	string Unique identifier of the Patch Panel.
patchPanelPortA	integer Specify the desired port number. When ports are not provided, next available ports will be used.
patchPanelPortB	integer Specify the desired port number. When ports are not provided, next available ports will be used. Required for Connector type FC and ST only.
connectorType	string (LoaPatchPanelConnectorType) Enum: "FC" "SC" "LC" "ST" Connector Type

Responses

Request samples

Payload

Content type

application/json

Example

IssueLoa-OnCageWithCageId

{"type": "CAGE_LOA",
"name": "LOA-Equinix-SV1-2026",
"description": "Authorization for cage access to Equinix at SV1",
"authorizedProductType": "XC",
"expirationDateTime": "2026-12-31T23:59:59Z",
"requestor": {"email": "user@org1.com",
"orgId": 95900,
"orgName": "organizationName1"
},
"demarcationPoint": {"cageUniqueSpaceId": "AM7:0G:0202"
}
}

Response samples

Content type

application/json

Example

ByRequestor

{"href": "https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2",
"uuid": "29cc7878-54e3-4e1a-8651-87a61354bac2",
"type": "PATCH_PANEL_PORT_LOA",
"name": "LOA-Equinix-SV1-2026",
"description": "Authorization for cage access to Equinix at SV1",
"authorizedProductType": "XC",
"state": "PENDING_AUTHORIZATION",
"requestor": {"email": "user@org1.com",
"orgId": 95900,
"orgName": "organizationName1"
},
"issuer": {"email": "user@org2.com",
"orgId": 95901,
"orgName": "organizationName2"
},
"location": {"ibxCode": "SV1"
},
"changeLog": {"createdDateTime": "2026-07-24T06:50:46Z",
"createdBy": "user",
"createdByEmail": "user@org1.com"
}
}

Get Loa

The API provides capability to get Loa details by Loa ID

Authorizations:

BearerAuth

path Parameters

loaId

required

string <uuid>

Example: 29cc7878-54e3-4e1a-8651-87a61354bac2

Loa UUID

Responses

Response Schema: application/json

href

string <uri>

URI of this LOA resource.

uuid

string <uuid>

Unique identifier of this LOA.

type

string (LoaType)

Enum: "CAGE_LOA" "PATCH_PANEL_LOA" "PATCH_PANEL_PORT_LOA"

Type of Letter of Authorization

name

string

A short, descriptive name for this LOA

description

string

Additional context about this LOA

authorizedProductType

string (LoaProductType)

Enum: "XC" "XF_PORT" "VD"

Product type associated with this LOA.
XC - Cross Connect
XF_PORT - Fabric Port
VD - Network Edge

state

string (LoaState)

Enum: "PENDING" "FAILED" "PENDING_AUTHORIZATION" "PENDING_ACCEPTANCE" "CANCELLED" "INACTIVE" "ACTIVE" "EXPIRED"

Current lifecycle state of the LOA.

object

consumersCount

integer

Number of consumers associated with this LOA.

object (LoaRequestor)

Requestor

email	string <email> Email address of the requestor contact.
orgId	integer Organization ID of the requestor.
orgName	string Organization name of the requestor.

object (LoaIssuer)

Issuer

email	string <email> Email address of the issuer contact.
orgId	integer Organization ID of the issuer.
orgName	string Organization name of the issuer.

object (LoaDemarcationPoint)

Specifies the demarcation point.
For CAGE_LOA - cageUniqueSpaceId is required.
For PATCH_PANEL_LOA - patchPanelId is required.
For PATCH_PANEL_PORT_LOA - patchPanelId, patchPanelPortA, patchPanelPortB and connectorType is required.

cageUniqueSpaceId	string Unique identifier of the Cage.
cabinetUniqueSpaceId	string Unique identifier of the Cabinet.
patchPanelId	string Unique identifier of the Patch Panel.
patchPanelPortA	integer Specify the desired port number. When ports are not provided, next available ports will be used.
patchPanelPortB	integer Specify the desired port number. When ports are not provided, next available ports will be used. Required for Connector type FC and ST only.
connectorType	string (LoaPatchPanelConnectorType) Enum: "FC" "SC" "LC" "ST" Connector Type

object (LoaLocation)

Eligible location where LOA can be issued.

ibxCode

string

IBX Code

expirationDateTime

string <date-time> (LoaExpiration)

Date and time when this LOA expires.
Default to 3 months from the creation date

object (LoaChangelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2",
"uuid": "29cc7878-54e3-4e1a-8651-87a61354bac2",
"type": "PATCH_PANEL_PORT_LOA",
"name": "LOA-Equinix-SV1-2026",
"description": "Authorization for cage access to Equinix at SV1",
"authorizedProductType": "XC",
"state": "INACTIVE",
"expirationDateTime": "2024-12-31T23:59:59Z",
"operation": {"consumersCount": 10
},
"requestor": {"email": "user@org1.com",
"orgId": 95900,
"orgName": "organizationName1"
},
"issuer": {"email": "user@org2.com",
"orgId": 95901,
"orgName": "organizationName2"
},
"demarcationPoint": {"cageUniqueSpaceId": "SV1:00:000000",
"cabinetUniqueSpaceId": "SV1:00:000000:0105",
"patchPanelId": "CP:Demarc:1259684",
"patchPanelPortA": 23,
"patchPanelPortB": 23,
"connectorType": "SC"
},
"location": {"ibxCode": "SV1"
},
"changeLog": {"createdDateTime": "2025-07-24T06:50:46Z",
"createdBy": "user",
"createdByEmail": "user@org2.com"
}
}

Update Loa

The API provides capability to update Loa details by Loa ID

Authorizations:

BearerAuth

path Parameters

loaId

required

string <uuid>

Example: 29cc7878-54e3-4e1a-8651-87a61354bac2

Loa UUID

Request Body schema: application/json-patch+json
required

Array

op required	string (LoaOpEnum) Enum: "replace" "add" "remove" Operation to be performed
path required	string (LoaPath) A JSON Pointer path. `/name` - Name of the Loa `/description` - Description of the Loa `/requestor/email` - Email of the requestor contact `/requestor/orgName` - Organization name of the requestor `/issuer/email` - Email of the issuer contact `/issuer/orgName` - Organization name of the issuer `/demarcationPoint/patchPanelId` - Patch Panel Identifier `/demarcationPoint/patchPanelPortA` - Patch Panel Port A `/demarcationPoint/patchPanelPortB` - Patch Panel Port B `/demarcationPoint/connectorType` - Connector Type `/demarcationPoint/cageUniqueSpaceId` - Cage Unique Space Identifier `/expirationDateTime` - Expiration date and time of the Loa `/location/ibxCode` - IBX code of the Eligible location
value required	any New value for updated parameter

Responses

Response Schema: application/json

href

string <uri>

URI of this LOA resource.

uuid

string <uuid>

Unique identifier of this LOA.

type

string (LoaType)

Enum: "CAGE_LOA" "PATCH_PANEL_LOA" "PATCH_PANEL_PORT_LOA"

Type of Letter of Authorization

name

string

A short, descriptive name for this LOA

description

string

Additional context about this LOA

authorizedProductType

string (LoaProductType)

Enum: "XC" "XF_PORT" "VD"

Product type associated with this LOA.
XC - Cross Connect
XF_PORT - Fabric Port
VD - Network Edge

state

string (LoaState)

Enum: "PENDING" "FAILED" "PENDING_AUTHORIZATION" "PENDING_ACCEPTANCE" "CANCELLED" "INACTIVE" "ACTIVE" "EXPIRED"

Current lifecycle state of the LOA.

object

consumersCount

integer

Number of consumers associated with this LOA.

object (LoaRequestor)

Requestor

email	string <email> Email address of the requestor contact.
orgId	integer Organization ID of the requestor.
orgName	string Organization name of the requestor.

object (LoaIssuer)

Issuer

email	string <email> Email address of the issuer contact.
orgId	integer Organization ID of the issuer.
orgName	string Organization name of the issuer.

object (LoaDemarcationPoint)

Specifies the demarcation point.
For CAGE_LOA - cageUniqueSpaceId is required.
For PATCH_PANEL_LOA - patchPanelId is required.
For PATCH_PANEL_PORT_LOA - patchPanelId, patchPanelPortA, patchPanelPortB and connectorType is required.

cageUniqueSpaceId	string Unique identifier of the Cage.
cabinetUniqueSpaceId	string Unique identifier of the Cabinet.
patchPanelId	string Unique identifier of the Patch Panel.
patchPanelPortA	integer Specify the desired port number. When ports are not provided, next available ports will be used.
patchPanelPortB	integer Specify the desired port number. When ports are not provided, next available ports will be used. Required for Connector type FC and ST only.
connectorType	string (LoaPatchPanelConnectorType) Enum: "FC" "SC" "LC" "ST" Connector Type

object (LoaLocation)

Eligible location where LOA can be issued.

ibxCode

string

IBX Code

expirationDateTime

string <date-time> (LoaExpiration)

Date and time when this LOA expires.
Default to 3 months from the creation date

object (LoaChangelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time

Request samples

Payload

Content type

application/json-patch+json

[{"op": "replace",
"path": "/demarcationPoint/patchPanelId",
"value": "CP:Demarc:1259685"
}
]

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2",
"uuid": "29cc7878-54e3-4e1a-8651-87a61354bac2",
"type": "PATCH_PANEL_PORT_LOA",
"name": "LOA-Equinix-SV1-2026",
"description": "Authorization for cage access to Equinix at SV1",
"authorizedProductType": "XC",
"state": "INACTIVE",
"operation": {"consumersCount": 1
},
"requestor": {"email": "user@org1.com",
"orgId": 95900,
"orgName": "organizationName1"
},
"issuer": {"email": "user@org2.com",
"orgId": 95901,
"orgName": "organizationName2"
},
"demarcationPoint": {"patchPanelId": "CP:Demarc:1259684",
"patchPanelPortA": 23,
"patchPanelPortB": 23,
"connectorType": "SC"
},
"location": {"ibxCode": "SV1"
},
"changeLog": {"createdDateTime": "2026-07-24T06:50:46Z",
"createdBy": "user",
"createdByEmail": "user@org2.com"
}
}

Create LOA Action

The API provides capability to perform actions on Loa

Authorizations:

BearerAuth

path Parameters

loaId

required

string <uuid>

Example: 29cc7878-54e3-4e1a-8651-87a61354bac2

Loa UUID

Request Body schema: application/json
required

type

required

string (LoaActionType)

Enum: "LOA_ISSUER_AUTHORIZATION" "LOA_REQUESTOR_ACCEPTANCE" "LOA_COPY_LINK" "LOA_SEND_EMAIL_NOTIFICATION" "LOA_CANCEL"

Action to perform on the LOA.

object (LoaActionData)

Action Data.
For LOA_ISSUER_AUTHORIZATION — always required.

object (LoaDemarcationPoint)

Specifies the demarcation point.
For CAGE_LOA - cageUniqueSpaceId is required.
For PATCH_PANEL_LOA - patchPanelId is required.
For PATCH_PANEL_PORT_LOA - patchPanelId, patchPanelPortA, patchPanelPortB and connectorType is required.

cageUniqueSpaceId	string Unique identifier of the Cage.
cabinetUniqueSpaceId	string Unique identifier of the Cabinet.
patchPanelId	string Unique identifier of the Patch Panel.
patchPanelPortA	integer Specify the desired port number. When ports are not provided, next available ports will be used.
patchPanelPortB	integer Specify the desired port number. When ports are not provided, next available ports will be used. Required for Connector type FC and ST only.
connectorType	string (LoaPatchPanelConnectorType) Enum: "FC" "SC" "LC" "ST" Connector Type

expirationDateTime

string <date-time> (LoaExpiration)

Date and time when this LOA expires.
Default to 3 months from the creation date

Responses

Request samples

Payload

Content type

application/json

Example

AuthorizeLoa

{"type": "LOA_ISSUER_AUTHORIZATION",
"data": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1259684",
"patchPanelPortA": 23,
"patchPanelPortB": 23,
"connectorType": "SC"
},
"expirationDateTime": "2026-08-07T07:00:00Z"
}
}

Response samples

Content type

application/json

Example

AuthorizeLoa

{"href": "https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4",
"uuid": "30cc7878-54e3-4e1a-8651-87a61354bad4",
"type": "LOA_ISSUER_AUTHORIZATION",
"state": "COMPLETED",
"data": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1259684",
"patchPanelPortA": 23,
"patchPanelPortB": 23,
"connectorType": "SC"
},
"expirationDateTime": "2026-08-07T07:00:00Z"
},
"changeLog": {"createdDateTime": "2026-06-24T06:50:46Z",
"createdBy": "user",
"createdByEmail": "user@org1.com"
}
}

Get Loa Action by Action ID

This API provides capability to fetch action details

Authorizations:

BearerAuth

path Parameters

loaId required	string <uuid> Example: 29cc7878-54e3-4e1a-8651-87a61354bac2 Loa UUID
actionId required	string <uuid> Example: 30cc7878-54e3-4e1a-8651-87a61354bad4 Action UUID

Responses

Response Schema: application/json

href

string <uri>

Action URI

uuid

string <uuid>

Action Identifier

state

string (LoaActionState)

Enum: "COMPLETED" "FAILED" "PENDING"

Action State

type

string (LoaActionType)

Enum: "LOA_ISSUER_AUTHORIZATION" "LOA_REQUESTOR_ACCEPTANCE" "LOA_COPY_LINK" "LOA_SEND_EMAIL_NOTIFICATION" "LOA_CANCEL"

Action to perform on the LOA.

object (LoaActionData)

Action Data.
For LOA_ISSUER_AUTHORIZATION — always required.

object (LoaDemarcationPoint)

Specifies the demarcation point.
For CAGE_LOA - cageUniqueSpaceId is required.
For PATCH_PANEL_LOA - patchPanelId is required.
For PATCH_PANEL_PORT_LOA - patchPanelId, patchPanelPortA, patchPanelPortB and connectorType is required.

cageUniqueSpaceId	string Unique identifier of the Cage.
cabinetUniqueSpaceId	string Unique identifier of the Cabinet.
patchPanelId	string Unique identifier of the Patch Panel.
patchPanelPortA	integer Specify the desired port number. When ports are not provided, next available ports will be used.
patchPanelPortB	integer Specify the desired port number. When ports are not provided, next available ports will be used. Required for Connector type FC and ST only.
connectorType	string (LoaPatchPanelConnectorType) Enum: "FC" "SC" "LC" "ST" Connector Type

expirationDateTime

string <date-time> (LoaExpiration)

Date and time when this LOA expires.
Default to 3 months from the creation date

portalUrl

string (LoaMagicLink)

Portal URL for the LOA to either accept from requestor
or authorize from the issuer.

object (LoaChangelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4",
"uuid": "30cc7878-54e3-4e1a-8651-87a61354bad4",
"type": "LOA_ISSUER_AUTHORIZATION",
"state": "COMPLETED",
"data": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1259684",
"patchPanelPortA": 23,
"patchPanelPortB": 23,
"connectorType": "SC"
},
"expirationDateTime": "2026-08-07T07:00:00Z"
},
"changeLog": {"createdDateTime": "2026-06-24T06:50:46Z",
"createdBy": "user",
"createdByEmail": "user@org1.com"
}
}

Search Loas

The API provides capability to get list of user's Loa using search criteria, including optional filtering, pagination and sorting

Authorizations:

BearerAuth

Request Body schema: application/json
required

object (LoaSearchFilters)

Array of LoaSimpleExpression (object) or LoaOrFilter (object) (LoaFilter) <= 8 items

Array (<= 8 items)

Any of

property	string (LoaFieldName) Enum: "/uuid" "/state" "/type" "/name" "/authorizedProductType" "/expirationDateTime" "/requestor/email" "/requestor/orgId" "/requestor/orgName" "/issuer/email" "/issuer/orgId" "/issuer/orgName" "/demarcationPoint/patchPanelId" "/demarcationPoint/patchPanelPortA" "/demarcationPoint/patchPanelPortB" "/demarcationPoint/connectorType" "/demarcationPoint/cageUniqueSpaceId" "/location/ibxCode" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" Possible field names to use on filters
operator	string Enum: "=" "!=" "LIKE" "ILIKE" "BETWEEN" "NOT BETWEEN" "IN" "NOT IN" ">" "<" ">=" "<="
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (LoaSortCriteria)

Array

direction	string Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string Default: "/changeLog/updatedDateTime" Enum: "/name" "/expirationDateTime" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" Possible field names to use on sorting

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (LoaSortCriteria)

Array

direction	string Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string Default: "/changeLog/updatedDateTime" Enum: "/name" "/expirationDateTime" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" Possible field names to use on sorting

Array of objects (LoaResponse)

Array

href	string <uri> URI of this LOA resource.
uuid	string <uuid> Unique identifier of this LOA.
type	string (LoaType) Enum: "CAGE_LOA" "PATCH_PANEL_LOA" "PATCH_PANEL_PORT_LOA" Type of Letter of Authorization
name	string A short, descriptive name for this LOA
description	string Additional context about this LOA
authorizedProductType	string (LoaProductType) Enum: "XC" "XF_PORT" "VD" Product type associated with this LOA. XC - Cross Connect XF_PORT - Fabric Port VD - Network Edge
state	string (LoaState) Enum: "PENDING" "FAILED" "PENDING_AUTHORIZATION" "PENDING_ACCEPTANCE" "CANCELLED" "INACTIVE" "ACTIVE" "EXPIRED" Current lifecycle state of the LOA.
	object
	object (LoaRequestor) Requestor
	object (LoaIssuer) Issuer
	object (LoaDemarcationPoint) Specifies the demarcation point. For CAGE_LOA - cageUniqueSpaceId is required. For PATCH_PANEL_LOA - patchPanelId is required. For PATCH_PANEL_PORT_LOA - patchPanelId, patchPanelPortA, patchPanelPortB and connectorType is required.
	object (LoaLocation) Eligible location where LOA can be issued.
expirationDateTime	string <date-time> (LoaExpiration) Date and time when this LOA expires. Default to 3 months from the creation date
	object (LoaChangelog) Change log

Request samples

Payload

Content type

application/json

Example

A named loa of a given type

{"filter": {"and": [{"property": "/name",
"operator": "ILIKE",
"values": ["LOA-Equinix-SV1"
]
},
{"property": "/type",
"operator": "=",
"values": ["PATCH_PANEL_PORT_LOA"
]
}
]
},
"pagination": {"limit": 25,
"offset": 0
},
"sort": [{"property": "/changeLog/updatedDateTime",
"direction": "DESC"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 25,
"total": 1
},
"sort": [{"property": "/changeLog/createdDateTime",
"direction": "DESC"
}
],
"data": [{"href": "https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2",
"uuid": "29cc7878-54e3-4e1a-8651-87a61354bac2",
"type": "PATCH_PANEL_PORT_LOA",
"name": "LOA-Equinix-SV1-2026",
"description": "Authorization for cage access to Equinix at SV1",
"authorizedProductType": "XC",
"state": "INACTIVE",
"expirationDateTime": "2026-12-31T23:59:59Z",
"operation": {"consumersCount": 1
},
"requestor": {"email": "user@org1.com",
"orgId": 95900,
"orgName": "organizationName1"
},
"issuer": {"email": "user@org2.com",
"orgId": 95901,
"orgName": "organizationName2"
},
"demarcationPoint": {"cageUniqueSpaceId": "SV1:00:000000",
"cabinetUniqueSpaceId": "SV1:00:000000:0105",
"patchPanelId": "CP:Demarc:1259684",
"patchPanelPortA": 23,
"patchPanelPortB": 23,
"connectorType": "SC"
},
"location": {"ibxCode": "SV1"
},
"changeLog": {"createdDateTime": "2026-07-24T06:50:46Z",
"createdBy": "user",
"createdByEmail": "user@org2.com"
}
}
]
}

Search Loa Actions

The API provides capability to get list of user's Loa Actions using search criteria, including optional filtering, pagination and sorting

Authorizations:

BearerAuth

path Parameters

loaId

required

string <uuid>

Example: 29cc7878-54e3-4e1a-8651-87a61354bac2

Loa UUID

Request Body schema: application/json
required

object (LoaActionSearchFilters)

Array of LoaActionSearchSimpleExpressions (object) or LoaActionOrFilter (object) (LoaActionFilter) <= 8 items

Array (<= 8 items)

Any of

property	string (LoaActionFieldName) Enum: "/type" "/state" "/uuid" Possible field names to use on filters
operator	string Enum: "=" "!=" "LIKE" "ILIKE" "BETWEEN" "NOT BETWEEN" "IN" "NOT IN" ">" "<" ">=" "<="
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (LoaActionSortCriteria)

Array

direction	string Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string Default: "/changeLog/createdDateTime" Value: "/changeLog/createdDateTime" Possible field names to use on sorting

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (LoaActionSortCriteria)

Array

direction	string Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string Default: "/changeLog/createdDateTime" Value: "/changeLog/createdDateTime" Possible field names to use on sorting

Array of objects (LoaActionResponse)

Array

href	string <uri> Action URI
uuid	string <uuid> Action Identifier
state	string (LoaActionState) Enum: "COMPLETED" "FAILED" "PENDING" Action State
type	string (LoaActionType) Enum: "LOA_ISSUER_AUTHORIZATION" "LOA_REQUESTOR_ACCEPTANCE" "LOA_COPY_LINK" "LOA_SEND_EMAIL_NOTIFICATION" "LOA_CANCEL" Action to perform on the LOA.
	object (LoaActionData) Action Data. For LOA_ISSUER_AUTHORIZATION — always required.
	object (LoaChangelog) Change log

Request samples

Payload

Content type

application/json

{"filter": {"and": [{"property": "/type",
"operator": "=",
"values": ["LOA_REQUESTOR_ACCEPTANCE"
]
}
]
},
"pagination": {"limit": 25,
"offset": 0
},
"sort": [{"property": "/changeLog/createdDateTime",
"direction": "DESC"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 25,
"total": 1
},
"sort": [{"property": "/changeLog/createdDateTime",
"direction": "DESC"
}
],
"data": [{"href": "https://api.equinix.com/fabric/v4/loas/29cc7878-54e3-4e1a-8651-87a61354bac2/actions/30cc7878-54e3-4e1a-8651-87a61354bad4",
"uuid": "30cc7878-54e3-4e1a-8651-87a61354bad4",
"type": "LOA_ISSUER_AUTHORIZATION",
"state": "COMPLETED",
"changeLog": {"createdDateTime": "2026-07-24T06:50:46Z",
"createdBy": "user",
"createdByEmail": "user@org2.com"
}
}
]
}

Get Loa Consumers

The API provides capability to get Loa consumers by Loa ID

Authorizations:

BearerAuth

path Parameters

loaId

required

string <uuid>

Example: 29cc7878-54e3-4e1a-8651-87a61354bac2

Loa UUID

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (LoaConsumer)

Array

href	string <uri> Consumer URI
uuid	string <uuid> Consumer Identifier
type	string (LoaProductType) Enum: "XC" "XF_PORT" "VD" Product type associated with this LOA. XC - Cross Connect XF_PORT - Fabric Port VD - Network Edge
	object (LoaChangelog) Change log

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 25,
"total": 2
},
"data": [{"href": "https://api.equinix.com/fabric/v4/ports/29cc7878-54e3-4e1a-8651-87a61354bac2",
"uuid": "29cc7878-54e3-4e1a-8651-87a61354bac2",
"type": "XF_PORT",
"changeLog": {"createdDateTime": "2025-07-24T06:50:46Z"
}
},
{"href": "https://api.equinix.com/fabric/v4/ports/b7e14c2d-93f8-4a61-8d5b-c29f71e4a306",
"uuid": "b7e14c2d-93f8-4a61-8d5b-c29f71e4a306",
"type": "XF_PORT",
"changeLog": {"createdDateTime": "2025-07-26T06:50:46Z"
}
}
]
}

Get Loa Notes

The API provides capability to get Loa notes by Loa ID

Authorizations:

BearerAuth

path Parameters

loaId

required

string <uuid>

Example: 29cc7878-54e3-4e1a-8651-87a61354bac2

Loa UUID

Responses

Response Schema: application/json

Array of objects (LoaNoteDetails)

Array

type	string Enum: "ISSUER" "REQUESTOR" Indicates which party added the note. ISSUER — note was added by a user from the issuer organization. REQUESTOR — note was added by a user from the requestor organization.
href	string <uri> URI to note resource.
uuid	string <uuid> Unique identifier of this note.
comments	string Content of the note as submitted by the user.
createdDateTime	string <date-time> Date and time when the note was created.

Response samples

Content type

application/json

{"data": [{"type": "ISSUER",
"href": "https://api.equinix.com/fabric/v4/loas/7c-5b93-4e6a-a218-6c7d9e3f45b1/notes/e41f485e-3094-42de-8797-0ef19a51df79",
"uuid": "e41f485e-3094-42de-8797-0ef19a51df79",
"comments": "test note from issuer",
"createdDateTime": "2026-07-24T06:50:46Z"
},
{"type": "REQUESTOR",
"href": "https://api.equinix.com/fabric/v4/loas/7c-5b93-4e6a-a218-6c7d9e3f45b1/notes/a41f485e-3094-42de-8797-0ef19a51df81",
"uuid": "a41f485e-3094-42de-8797-0ef19a51df81",
"comments": "test note from requestor",
"createdDateTime": "2026-07-25T06:50:46Z"
}
]
}

Create Loa Note

The API provides capability to create Loa note by Loa ID

Authorizations:

BearerAuth

path Parameters

loaId

required

string <uuid>

Example: 29cc7878-54e3-4e1a-8651-87a61354bac2

Loa UUID

Request Body schema: application/json
required

comments

required

string [ 0 .. 4000 ] characters

The note content to add to this LOA. Notes are visible to both the issuer and requestor organizations. Use notes to communicate updates, clarifications, or additional context about the LOA.

Responses

Response Schema: application/json

type	string Enum: "ISSUER" "REQUESTOR" Indicates which party added the note. ISSUER — note was added by a user from the issuer organization. REQUESTOR — note was added by a user from the requestor organization.
href	string <uri> URI to note resource.
uuid	string <uuid> Unique identifier of this note.
comments	string Content of the note as submitted by the user.
createdDateTime	string <date-time> Date and time when the note was created.

Request samples

Payload

Content type

application/json

{"comments": "LOA under review by our team. Expected response within 2 business days."
}

Response samples

Content type

application/json

{"type": "ISSUER",
"href": "https://api.equinix.com/fabric/v4/loas/7c-5b93-4e6a-a218-6c7d9e3f45b1/notes/e41f485e-3094-42de-8797-0ef19a51df79",
"uuid": "e41f485e-3094-42de-8797-0ef19a51df79",
"comments": "LOA under review by our team. Expected response within 2 business days.",
"createdDateTime": "2026-06-24T06:50:46Z"
}

Optical Metro Connects

Optical Metro Connects ^Beta

Create Optical Metro Connect Service

Create a single Optical Metro Connect circuit.

Authorizations:

BearerAuth

Request Body schema: application/json
required

type

required

string

Value: "OC"

OC - Optical Connect Type

bandwidth

required

integer

Connection bandwidth Mbps.
Available bandwidths depend on the IBX pair.
1000 - 1 Gbps.
10000 - 10 Gbps.
100000 - 100 Gbps.

connectionDestinationType

required

string

Enum: "COLO" "BMMR" "REMOTE"

Where the Z-side terminates.
COLO - your own colocation space at another Equinix IBX.
BMMR - a Building Meet-Me Room.
REMOTE - another customer's colocation space at another Equinix IBX.
BMMR and REMOTE require a Letter of Authorization on the Z-side.

pathType

required

string

Enum: "DUAL_DIVERSE" "PROTECTED" "UNPROTECTED"

Level of resilience for the connection.
UNPROTECTED - a single fiber path with no node redundancy.
PROTECTED - two diverse fiber paths between single nodes at each IBX.
DUAL_DIVERSE - two diverse fiber paths terminating on redundant nodes at both IBXs.

object (OpticalConnectRedundancy)

Optical Connect redundancy configuration.
Required only for DUAL_DIVERSE connection.

priority	string Enum: "PRIMARY" "SECONDARY" Role within the diverse pair. PRIMARY - first connection of the pair. SECONDARY - the diverse connection on a separate path.
group	string <uuid> Redundancy group identifier

required

object (OpticalConnectASideRequest)

A-Side configuration. Always a patch panel port from your cage.

object (OpticalConnectDemarcationPoint)

Specifies the demarcation point: the patch panel and ports at this side.

patchPanelId	string Unique identifier of the patch panel.
patchPanelPortA	string Specify the desired port number for Port A. When ports are not provided, next available ports will be used.
patchPanelPortB	string Specify the desired port number for Port B. When ports are not provided, next available ports will be used. Required for Connector type FC, SC and ST only.
connectorType	string Enum: "FC" "SC" "LC" "ST" Type of Connector

required

object (OpticalConnectZSideRequest)

Z-Side configuration.
For COLO, specify the destination patch panel and ports.
For BMMR and REMOTE, specify the location and Letter of Authorization.

object (OpticalConnectDemarcationPoint)

Specifies the demarcation point: the patch panel and ports at this side.

patchPanelId	string Unique identifier of the patch panel.
patchPanelPortA	string Specify the desired port number for Port A. When ports are not provided, next available ports will be used.
patchPanelPortB	string Specify the desired port number for Port B. When ports are not provided, next available ports will be used. Required for Connector type FC, SC and ST only.
connectorType	string Enum: "FC" "SC" "LC" "ST" Type of Connector

object (OpticalConnectLocation)

Destination location for BMMR and REMOTE connections.

ibxCode

string

Equinix IBX data centre code.

object (OpticalConnectLOA)

Letter of Authorization granting the right to terminate at the Z-side location.
Required for BMMR and REMOTE.

uuid	string Identifier of the Letter of Authorization

object (OpticalConnectOrder)

Ordering and billing reference details for this connection.

purchaseOrderNumber	string Purchase order number reference.
customerReferenceId	string Your own reference for this connection.
orderNumber	string Equinix order reference number.

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

Array of objects (OpticalConnectNotification)

Contacts to notify about connection configuration and status changes

Array

type required	string Enum: "NOTIFICATION" "ORDERING" "TECHNICAL" Notification category. NOTIFICATION - states and configuration updates. ORDERING - order and fulfilment correspondence. TECHNICAL - maintenance and technical advisories.
emails required	Array of strings <email> [ items <email > ] Email addresses to notify.
registeredUsers	Array of strings Usernames of registered Equinix Portal users to notify.

bmmrType

string

Enum: "EQUINIX" "SELF"

BMMR infrastructure ownership type.
EQUINIX - Equinix-operated.
SELF - customer-operated.
Required only when connectionDestinationType is BMMR.

Responses

Request samples

Payload

Content type

application/json

Example

COLOToCOLO

Both ends terminate on patch panels in colocation space you occupy, so no Letter of Authorization is needed.

{"type": "OC",
"bandwidth": 100000,
"connectionDestinationType": "COLO",
"pathType": "UNPROTECTED",
"aSide": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1259684",
"patchPanelPortA": "9",
"patchPanelPortB": "10",
"connectorType": "SC"
}
},
"zSide": {"demarcationPoint": {"patchPanelId": "PP:Demarc:1259695",
"patchPanelPortA": "20",
"patchPanelPortB": "21",
"connectorType": "SC"
}
},
"order": {"purchaseOrderNumber": "156576"
},
"notifications": [{"type": "NOTIFICATION",
"emails": ["test@test.com"
]
}
]
}

Response samples

202
400
403
404
500

Content type

application/json

Example

COLO connection

{"href": "https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0",
"uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0",
"type": "OC",
"name": "270848-SV1-SV2-01",
"state": "PROVISIONING",
"bandwidth": 100000,
"connectionDestinationType": "COLO",
"pathType": "UNPROTECTED",
"aSide": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1259684",
"patchPanelPortA": "10",
"patchPanelPortB": "11",
"connectorType": "SC",
"cageUniqueSpaceId": "SV1:01:002174",
"cabinetUniqueSpaceId": "Demarc"
},
"location": {"ibxCode": "SV1"
}
},
"zSide": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1259690",
"patchPanelPortA": "20",
"patchPanelPortB": "21",
"connectorType": "SC",
"cageUniqueSpaceId": "SV2:01:002174",
"cabinetUniqueSpaceId": "Demarc"
},
"location": {"ibxCode": "SV2"
}
},
"order": {"purchaseOrderNumber": "156576",
"orderNumber": "1-129105284100"
},
"account": {"accountNumber": 270848,
"orgId": 123
},
"notifications": [{"type": "NOTIFICATION",
"emails": ["test@test.com"
]
}
],
"changeLog": {"createdByEmail": "abc@xyz.com",
"createdDateTime": "2025-07-24T06:50:46Z",
"updatedByEmail": "abc@xyz.com",
"updatedDateTime": "2025-07-24T06:51:46Z"
}
}

Create Dual Diverse Optical Metro Connect Service

Create a dual diverse pair of circuits on separate optical paths.

Authorizations:

BearerAuth

Request Body schema: application/json
required

Array of objects (OpticalConnectPostRequest)

The two connections forming the diverse pair — one PRIMARY and one SECONDARY.

Array

type required	string Value: "OC" OC - Optical Connect Type
bandwidth required	integer Connection bandwidth Mbps. Available bandwidths depend on the IBX pair. 1000 - 1 Gbps. 10000 - 10 Gbps. 100000 - 100 Gbps.
connectionDestinationType required	string Enum: "COLO" "BMMR" "REMOTE" Where the Z-side terminates. COLO - your own colocation space at another Equinix IBX. BMMR - a Building Meet-Me Room. REMOTE - another customer's colocation space at another Equinix IBX. BMMR and REMOTE require a Letter of Authorization on the Z-side.
pathType required	string Enum: "DUAL_DIVERSE" "PROTECTED" "UNPROTECTED" Level of resilience for the connection. UNPROTECTED - a single fiber path with no node redundancy. PROTECTED - two diverse fiber paths between single nodes at each IBX. DUAL_DIVERSE - two diverse fiber paths terminating on redundant nodes at both IBXs.
	object (OpticalConnectRedundancy) Optical Connect redundancy configuration. Required only for DUAL_DIVERSE connection.
required	object (OpticalConnectASideRequest) A-Side configuration. Always a patch panel port from your cage.
required	object (OpticalConnectZSideRequest) Z-Side configuration. For COLO, specify the destination patch panel and ports. For BMMR and REMOTE, specify the location and Letter of Authorization.
	object (OpticalConnectOrder) Ordering and billing reference details for this connection.
	object (SimplifiedAccount)
	Array of objects (OpticalConnectNotification) Contacts to notify about connection configuration and status changes
bmmrType	string Enum: "EQUINIX" "SELF" BMMR infrastructure ownership type. EQUINIX - Equinix-operated. SELF - customer-operated. Required only when connectionDestinationType is BMMR.

Responses

Request samples

Payload

Content type

application/json

Example

COLO diverse pair

Two connections on separate patch panels. Equinix assigns the shared redundancy group and returns it on both connections.

{"data": [{"type": "OC",
"bandwidth": 100000,
"connectionDestinationType": "COLO",
"pathType": "DUAL_DIVERSE",
"redundancy": {"priority": "PRIMARY"
},
"aSide": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1259684",
"patchPanelPortA": "10",
"patchPanelPortB": "11",
"connectorType": "SC"
}
},
"zSide": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1259690",
"patchPanelPortA": "20",
"patchPanelPortB": "21",
"connectorType": "SC"
}
},
"notifications": [{"type": "NOTIFICATION",
"emails": ["test@test.com"
],
"registeredUsers": ["test"
]
}
]
},
{"type": "OC",
"bandwidth": 100000,
"connectionDestinationType": "COLO",
"pathType": "DUAL_DIVERSE",
"redundancy": {"priority": "SECONDARY"
},
"aSide": {"demarcationPoint": {"patchPanelId": "PP:Demarc:1260379",
"patchPanelPortA": "14",
"patchPanelPortB": "15",
"connectorType": "SC"
}
},
"zSide": {"demarcationPoint": {"patchPanelId": "PP:Demarc:1260385",
"patchPanelPortA": "24",
"patchPanelPortB": "25",
"connectorType": "SC"
}
},
"notifications": [{"type": "NOTIFICATION",
"emails": ["test@test.com"
]
}
]
}
]
}

Response samples

202
400
403
404
500

Content type

application/json

Example

COLOToCOLO

{"data": [{"href": "https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0",
"uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0",
"type": "OC",
"name": "270848-SV1-SV2-PRI-01",
"state": "PROVISIONING",
"bandwidth": 100000,
"connectionDestinationType": "COLO",
"pathType": "DUAL_DIVERSE",
"redundancy": {"priority": "PRIMARY",
"group": "22f8e668-4754-4564-825d-d1c7889c885a"
},
"aSide": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1259684",
"patchPanelPortA": "10",
"patchPanelPortB": "11",
"connectorType": "SC",
"cageUniqueSpaceId": "SV1:01:002174",
"cabinetUniqueSpaceId": "Demarc"
},
"location": {"ibxCode": "SV1"
}
},
"zSide": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1259690",
"patchPanelPortA": "20",
"patchPanelPortB": "21",
"connectorType": "SC",
"cageUniqueSpaceId": "SV2:01:002174",
"cabinetUniqueSpaceId": "Demarc"
},
"location": {"ibxCode": "SV2"
}
},
"order": {"orderNumber": "1-129105284100"
},
"account": {"accountNumber": 270848,
"orgId": 123
},
"notifications": [{"type": "NOTIFICATION",
"emails": ["test@test.com"
]
}
]
},
{"href": "https://api.equinix.com/fabric/v4/opticalConnects/a6f77b33-96c6-4eeb-8d79-76374d950603",
"uuid": "a6f77b33-96c6-4eeb-8d79-76374d950603",
"type": "OC",
"name": "270848-SV1-SV2-SEC-02",
"state": "PROVISIONING",
"bandwidth": 100000,
"connectionDestinationType": "COLO",
"pathType": "DUAL_DIVERSE",
"redundancy": {"priority": "SECONDARY",
"group": "22f8e668-4754-4564-825d-d1c7889c885a"
},
"aSide": {"demarcationPoint": {"patchPanelId": "PP:Demarc:1260379",
"patchPanelPortA": "14",
"patchPanelPortB": "15",
"connectorType": "SC",
"cageUniqueSpaceId": "SV1:01:002174",
"cabinetUniqueSpaceId": "Demarc"
},
"location": {"ibxCode": "SV1"
}
},
"zSide": {"demarcationPoint": {"patchPanelId": "PP:Demarc:1260385",
"patchPanelPortA": "24",
"patchPanelPortB": "25",
"connectorType": "SC",
"cageUniqueSpaceId": "SV2:01:002174",
"cabinetUniqueSpaceId": "Demarc"
},
"location": {"ibxCode": "SV2"
}
},
"order": {"orderNumber": "1-129105284100"
},
"account": {"accountNumber": 270848,
"orgId": 123
},
"notifications": [{"type": "NOTIFICATION",
"emails": ["test@test.com"
]
}
]
}
]
}

Get Optical Metro Connect Service

Get a single Optical Metro Connect by UUID.

Authorizations:

BearerAuth

path Parameters

opticalConnectId

required

string <uuid>

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

Unique identifier of an Optical Connect.

Responses

Response Schema: application/json

href

string <uri>

URI of this Optical Connect resource.

uuid

string <uuid>

Unique identifier of this Optical Connect.

type

string

Value: "OC"

Connection Type.
OC - Optical Connect.

name

string

Equinix-assigned name, derived from the account number and the two IBX locations.

state

string (OpticalConnectState)

Enum: "PROVISIONING" "PROVISIONED" "PROVISIONING_FAILED" "REPROVISIONING" "REPROVISIONING_FAILED" "DEPROVISIONING" "DEPROVISIONED"

Optical Connect lifecycle states.

bandwidth

integer

Provisioned connection bandwidth in Mbps.

connectionDestinationType

string

Enum: "COLO" "BMMR" "REMOTE"

Where the Z-side terminates.
COLO - your own colocation space at another Equinix IBX.
BMMR - a Building Meet-Me Room.
REMOTE - another customer's colocation space at another Equinix IBX.

pathType

string

Enum: "DUAL_DIVERSE" "PROTECTED" "UNPROTECTED"

Level of resilience for the connection.
UNPROTECTED - a single fiber path with no node redundancy.
PROTECTED - two diverse fiber paths between single nodes at each IBX.
DUAL_DIVERSE - two diverse fiber paths terminating on redundant nodes at both IBXs.

bmmrType

string

Enum: "EQUINIX" "SELF"

BMMR infrastructure ownership type.
EQUINIX - Equinix-operated.
SELF - customer-operated.
Required only when connectionDestinationType is BMMR.

object (OpticalConnectRedundancy)

Optical Connect redundancy configuration.
Required only for DUAL_DIVERSE connection.

priority	string Enum: "PRIMARY" "SECONDARY" Role within the diverse pair. PRIMARY - first connection of the pair. SECONDARY - the diverse connection on a separate path.
group	string <uuid> Redundancy group identifier

object (OpticalConnectASideResponse)

Originating end as provisioned, with the demarcation point and IBX location.

object (OpticalConnectResponseDemarcationPoint)

Demarcation point as provisioned, with the cage and cabinet it belongs to.

patchPanelId	string Unique identifier of the patch panel.
patchPanelPortA	string Specify the desired port number for Port A. When ports are not provided, next available ports will be used.
patchPanelPortB	string Specify the desired port number for Port B. When ports are not provided, next available ports will be used. Required for Connector type FC, SC and ST only.
connectorType	string Enum: "FC" "SC" "LC" "ST" Type of Connector
cageUniqueSpaceId	string Unique identifier of the cage.
cabinetUniqueSpaceId	string Unique identifier of the cabinet.

object (OpticalConnectLocation)

Destination location for BMMR and REMOTE connections.

ibxCode

string

Equinix IBX data centre code.

object (OpticalConnectZSideResponse)

Terminating end as provisioned, with the demarcation point and IBX location.

object (OpticalConnectResponseDemarcationPoint)

Demarcation point as provisioned, with the cage and cabinet it belongs to.

patchPanelId	string Unique identifier of the patch panel.
patchPanelPortA	string Specify the desired port number for Port A. When ports are not provided, next available ports will be used.
patchPanelPortB	string Specify the desired port number for Port B. When ports are not provided, next available ports will be used. Required for Connector type FC, SC and ST only.
connectorType	string Enum: "FC" "SC" "LC" "ST" Type of Connector
cageUniqueSpaceId	string Unique identifier of the cage.
cabinetUniqueSpaceId	string Unique identifier of the cabinet.

object (OpticalConnectLocation)

Destination location for BMMR and REMOTE connections.

ibxCode

string

Equinix IBX data centre code.

object (OpticalConnectLOA)

Letter of Authorization granting the right to terminate at the Z-side location.
Required for BMMR and REMOTE.

uuid	string Identifier of the Letter of Authorization

object (OpticalConnectOrder)

Ordering and billing reference details for this connection.

purchaseOrderNumber	string Purchase order number reference.
customerReferenceId	string Your own reference for this connection.
orderNumber	string Equinix order reference number.

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

Array of objects (OpticalConnectNotification)

Preferences for notifications on connection configuration or status changes

Array

type required	string Enum: "NOTIFICATION" "ORDERING" "TECHNICAL" Notification category. NOTIFICATION - states and configuration updates. ORDERING - order and fulfilment correspondence. TECHNICAL - maintenance and technical advisories.
emails required	Array of strings <email> [ items <email > ] Email addresses to notify.
registeredUsers	Array of strings Usernames of registered Equinix Portal users to notify.

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

Response samples

200
400
403
404
500

Content type

application/json

Example

COLO connection

{"href": "https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0",
"uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0",
"type": "OC",
"name": "270848-SV1-SV2-01",
"state": "PROVISIONING",
"bandwidth": 100000,
"connectionDestinationType": "COLO",
"pathType": "UNPROTECTED",
"aSide": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1259684",
"patchPanelPortA": "10",
"patchPanelPortB": "11",
"connectorType": "SC",
"cageUniqueSpaceId": "SV1:01:002174",
"cabinetUniqueSpaceId": "Demarc"
},
"location": {"ibxCode": "SV1"
}
},
"zSide": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1259690",
"patchPanelPortA": "20",
"patchPanelPortB": "21",
"connectorType": "SC",
"cageUniqueSpaceId": "SV2:01:002174",
"cabinetUniqueSpaceId": "Demarc"
},
"location": {"ibxCode": "SV2"
}
},
"order": {"purchaseOrderNumber": "156576",
"orderNumber": "1-129105284100"
},
"account": {"accountNumber": 270848,
"orgId": 123
},
"notifications": [{"type": "NOTIFICATION",
"emails": ["test@test.com"
]
}
],
"changeLog": {"createdByEmail": "abc@xyz.com",
"createdDateTime": "2025-07-24T06:50:46Z",
"updatedByEmail": "abc@xyz.com",
"updatedDateTime": "2025-07-24T06:51:46Z"
}
}

Search Optical Metro Connect Services

Get Optical Metro Connects matching the supplied criteria, with optional filtering, pagination and sorting.

Authorizations:

BearerAuth

Request Body schema: application/json
required

object (OpticalConnectFilters)

Array of OpticalConnectSimpleExpression (object) or OpticalConnectOrFilter (object) (OpticalConnectFilter) <= 8 items

Array (<= 8 items)

Any of

property	string Possible field names to use on filters: `/name` - Connection name `/uuid` - Connection uuid `/type` - type `/state` - state `/bandwidth` - Bandwidth
operator	string Possible operators to use on filters: `=` - equal `!=` - not equal `[NOT] BETWEEN` - (not) between `[NOT] LIKE` - (not) like `[NOT] IN` - (not) in `ILIKE` - case-insensitive like
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (OpticalConnectSortCriteria)

Array

direction	string (OpticalConnectSortDirection) Default: "DESC" Enum: "DESC" "ASC" Sorting direction. ASC - ascending DESC - descending
property	string (OpticalConnectSortBy) Default: "/changeLog/updatedDateTime" Enum: "/name" "/uuid" "/state" "/type" "/bandwidth" "/aSide/location/ibxCode" "/zSide/location/ibxCode" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" Possible field names to use on sorting

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (OpticalConnectResponse)

Data returned from the API call.

Array

href	string <uri> URI of this Optical Connect resource.
uuid	string <uuid> Unique identifier of this Optical Connect.
type	string Value: "OC" Connection Type. OC - Optical Connect.
name	string Equinix-assigned name, derived from the account number and the two IBX locations.
state	string (OpticalConnectState) Enum: "PROVISIONING" "PROVISIONED" "PROVISIONING_FAILED" "REPROVISIONING" "REPROVISIONING_FAILED" "DEPROVISIONING" "DEPROVISIONED" Optical Connect lifecycle states.
bandwidth	integer Provisioned connection bandwidth in Mbps.
connectionDestinationType	string Enum: "COLO" "BMMR" "REMOTE" Where the Z-side terminates. COLO - your own colocation space at another Equinix IBX. BMMR - a Building Meet-Me Room. REMOTE - another customer's colocation space at another Equinix IBX.
pathType	string Enum: "DUAL_DIVERSE" "PROTECTED" "UNPROTECTED" Level of resilience for the connection. UNPROTECTED - a single fiber path with no node redundancy. PROTECTED - two diverse fiber paths between single nodes at each IBX. DUAL_DIVERSE - two diverse fiber paths terminating on redundant nodes at both IBXs.
bmmrType	string Enum: "EQUINIX" "SELF" BMMR infrastructure ownership type. EQUINIX - Equinix-operated. SELF - customer-operated. Required only when connectionDestinationType is BMMR.
	object (OpticalConnectRedundancy) Optical Connect redundancy configuration. Required only for DUAL_DIVERSE connection.
	object (OpticalConnectASideResponse) Originating end as provisioned, with the demarcation point and IBX location.
	object (OpticalConnectZSideResponse) Terminating end as provisioned, with the demarcation point and IBX location.
	object (OpticalConnectOrder) Ordering and billing reference details for this connection.
	object (SimplifiedAccount)
	Array of objects (OpticalConnectNotification) Preferences for notifications on connection configuration or status changes
	object (Changelog) Change log

Request samples

Payload

Content type

application/json

Example

All provisioned connections

{"filter": {"and": [{"property": "/state",
"operator": "=",
"values": ["PROVISIONED"
]
}
]
},
"pagination": {"offset": 0,
"limit": 20
},
"sort": [{"direction": "DESC",
"property": "/changeLog/updatedDateTime"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 20,
"limit": 20,
"total": 100,
"next": "/search?offset=40&limit=20",
"previous": "/search?offset=0&limit=20"
},
"data": [{"href": "https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0",
"uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0",
"type": "OC",
"name": "270848-SV1-SV2-01-1",
"state": "PROVISIONING",
"bandwidth": 100000,
"connectionDestinationType": "COLO",
"aSide": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1259684",
"patchPanelPortA": "10",
"patchPanelPortB": "11",
"connectorType": "SC",
"cageUniqueSpaceId": "SV1:01:002174",
"cabinetUniqueSpaceId": "Demarc"
},
"location": {"ibxCode": "SV1"
}
},
"zSide": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1259690",
"patchPanelPortA": "20",
"patchPanelPortB": "21",
"cageUniqueSpaceId": "SV2:01:002174",
"cabinetUniqueSpaceId": "Demarc",
"connectorType": "SC"
},
"location": {"ibxCode": "SV2"
}
},
"order": {"purchaseOrderNumber": "156576",
"orderNumber": "1-129105284100"
},
"account": {"accountNumber": 270848,
"orgId": 123
},
"notifications": [{"type": "NOTIFICATION",
"emails": ["test@test.com"
]
}
],
"changeLog": {"createdByEmail": "abc@xyz.com",
"createdDateTime": "2025-07-24T06:50:46Z",
"updatedByEmail": "abc@xyz.com",
"updatedDateTime": "2025-07-24T06:51:46Z"
}
},
{"href": "https://api.equinix.com/fabric/v4/opticalConnects/07abb0e3-e67d-5090-9aff-fc5654abaae0",
"uuid": "07abb0e3-e67d-5090-9aff-fc5654abaae0",
"type": "OC",
"name": "270848-SV1-SV2-01-2",
"state": "PROVISIONED",
"bandwidth": 100000,
"connectionDestinationType": "COLO",
"aSide": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1234685",
"patchPanelPortA": "11",
"patchPanelPortB": "12",
"connectorType": "SC",
"cageUniqueSpaceId": "SV1:01:002174",
"cabinetUniqueSpaceId": "Demarc"
},
"location": {"ibxCode": "SV1"
}
},
"zSide": {"demarcationPoint": {"patchPanelId": "CP:Demarc:1259684",
"patchPanelPortA": "22",
"patchPanelPortB": "23",
"connectorType": "SC",
"cageUniqueSpaceId": "SV2:01:002174",
"cabinetUniqueSpaceId": "Demarc"
},
"location": {"ibxCode": "SV2"
}
},
"order": {"purchaseOrderNumber": "126758",
"orderNumber": "1-139105284200"
},
"account": {"accountNumber": 280845,
"orgId": 123
},
"notifications": [{"type": "NOTIFICATION",
"emails": ["test@test.com"
]
}
],
"changeLog": {"createdByEmail": "abc@xyz.com",
"createdDateTime": "2024-07-24T06:50:46Z",
"updatedByEmail": "abc@xyz.com",
"updatedDateTime": "2024-07-24T06:51:46Z"
}
}
]
}

Application Domains

Application Domains ^Beta

Create Domain

This API provides capability to create user's App Domain

Authorizations:

BearerAuth

Request Body schema: application/json
required

type

required

string (AppDomainType)

Default: "APP_DOMAIN"

Value: "APP_DOMAIN"

App Domain Type

name

required

string <string> [ 1 .. 50 ] characters

Customer-provided App Domain name

description

string <string>

Customer-provided App Domain description

required

object (Project)

projectId

required

string

Subscriber-assigned project ID

Responses

Request samples

Payload

Content type

application/json

{"type": "APP_DOMAIN",
"name": "atlassian.net",
"description": "Atlassian Domain",
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
}
}

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"type": "APP_DOMAIN",
"name": "atlassian.net",
"description": "Atlassian Domain",
"state": "PENDING_VERIFICATION",
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
},
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z"
}
}

Get Domain

This API provides capability to retrieve user's Domain

Authorizations:

BearerAuth

path Parameters

appDomainId

required

string <uuid>

Example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3

App Domain UUID

Responses

Response Schema: application/json

href

string <uri>

Resource URI

type

required

string (AppDomainType)

Default: "APP_DOMAIN"

Value: "APP_DOMAIN"

App Domain Type

uuid

string <uuid>

Equinix-assigned access point identifier

name

required

string <string>

Customer-provided App Domain name

description

string <string>

Customer-provided App Domain description

state

string <string> (AppDomainState)

Enum: "PENDING_VERIFICATION" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED"

App Domain lifecycle state

required

object (Project)

projectId

required

string

Subscriber-assigned project ID

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

object (AppDomainChange)

Current state of latest AppDomain change

uuid

string

Uniquely identifies a change

type

required

string

Value: "APP_DOMAIN_UPDATE"

Type of change

status

string

Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdDateTime

string <date-time>

Set when change flow starts

updatedDateTime

required

string <date-time>

Set when change object is updated

Array of objects (AppDomainChangeOperation)

Array

op required	string Enum: "replace" "add" "remove" operation type applied to the resource
path required	string Value: "/description" path inside document leading to updated parameter
value required	any new value for updated parameter

Response samples

200
401
403
404
500

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"type": "APP_DOMAIN",
"name": "atlassian.net",
"description": "Atlassian Domain",
"state": "PROVISIONED",
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
},
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedBy": "test",
"updatedDateTime": "2026-06-28T04:20:55.471Z"
}
}

Delete Domain

This API provides capability to delete user's Domain

Authorizations:

BearerAuth

path Parameters

appDomainId

required

string <uuid>

Example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3

App Domain UUID

Responses

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"type": "APP_DOMAIN",
"name": "atlassian.net",
"description": "Atlassian Domain",
"state": "DEPROVISIONED",
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
},
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedBy": "test",
"updatedDateTime": "2026-06-28T04:20:55.471Z",
"deletedBy": "test",
"deletedDateTime": "2026-06-29T04:20:55.471Z"
}
}

Update Domain

This API provides capability to update user's Domain

Authorizations:

BearerAuth

path Parameters

appDomainId

required

string <uuid>

Example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3

App Domain UUID

Request Body schema: application/json-patch+json
required

Array (= 1 items)

op required	string Enum: "replace" "add" "remove" operation type applied to the resource
path required	string Value: "/description" path inside document leading to updated parameter
value required	any new value for updated parameter

Responses

Request samples

Payload

Content type

application/json-patch+json

[{"op": "replace",
"path": "/description",
"value": "Updated Atlassian Domain"
}
]

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"type": "APP_DOMAIN",
"name": "atlassian.net",
"description": "Updated Atlassian Domain",
"state": "PROVISIONED",
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
},
"change": {"uuid": "531c4ab5-43b0-4352-8975-ee9045325841",
"type": "APP_DOMAIN_UPDATE",
"status": "REQUESTED",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedDateTime": "2026-06-28T04:20:55.471Z",
"data": [{"op": "replace",
"path": "/description",
"value": "Updated Atlassian Domain"
}
]
},
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedBy": "test",
"updatedDateTime": "2026-06-28T04:20:55.471Z"
}
}

Search Domains

The API provides capability to get list of user's App Domains using search criteria, including optional filtering, pagination and sorting

Authorizations:

BearerAuth

Request Body schema: application/json
required

object (AppDomainFilters)

Array of AppDomainSimpleExpression (object) or AppDomainOrFilter (object) (AppDomainFilter) <= 8 items

Array (<= 8 items)

Any of

property	string Possible field names to use on filters: `/project/projectId` - project id `/uuid` - App Domain uuid `/name` - App Domain name `/description` - App Domain description `/state` - App Domain status `/changeLog/createdDateTime` - App Domain creation timestamp `/changeLog/updatedDateTime` - App Domain last updated timestamp `/changeLog/deletedDateTime` - App Domain deletion timestamp
operator	string Possible operators to use on filters: `=` - equal `!=` - not equal `>` - greater than `<` - less than `IN` - in `NOT IN` - not in `LIKE` - like `ILIKE` - case-insensitive like `BETWEEN` - between `NOT BETWEEN` - not between
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (AppDomainSortCriteria)

Array

direction	string (AppDomainSortDirection) Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string <string> (AppDomainSortBy) Default: "/changeLog/updatedDateTime" Possible field names to use on '400_InvalidSorting': `/name` - App Domain name `/uuid` - App Domain uuid `/state` - App Domain status `/changeLog/createdDateTime` - Date and time when change flow starts `/changeLog/updatedDateTime` - Date and time when change object is updated

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (AppDomain)

Data returned from the API call.

Array

href	string <uri> Resource URI
type required	string (AppDomainType) Default: "APP_DOMAIN" Value: "APP_DOMAIN" App Domain Type
uuid	string <uuid> Equinix-assigned access point identifier
name required	string <string> Customer-provided App Domain name
description	string <string> Customer-provided App Domain description
state	string <string> (AppDomainState) Enum: "PENDING_VERIFICATION" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" App Domain lifecycle state
required	object (Project)
	object (Changelog) Change log
	object (AppDomainChange) Current state of latest AppDomain change

Request samples

Payload

Content type

application/json

Example

SearchFilterByStatus

{"filter": {"and": [{"property": "/state",
"operator": "=",
"values": ["PROVISIONED"
]
},
{"property": "/project/projectId",
"operator": "IN",
"values": ["71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
]
}
]
},
"pagination": {"offset": 0,
"limit": 20
},
"sort": [{"direction": "DESC",
"property": "/changeLog/createdDateTime"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 1,
"next": "/search?offset=1&limit=20",
"previous": "/search?offset=0&limit=20"
},
"data": [{"href": "https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"type": "APP_DOMAIN",
"name": "atlassian.net",
"description": "Atlassian Domain",
"state": "PROVISIONED",
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
}
}
]
}

Get Attached Links for Domain

This API provides capability to retrieve App Links attached to an App Domain

Authorizations:

BearerAuth

path Parameters

appDomainId

required

string <uuid>

Example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3

App Domain UUID

query Parameters

offset	integer Example: offset=1 offset
limit	integer Example: limit=10 number of records to fetch
state	Array of strings <string> (AttachedAppLinkState) [ items <string > ] Items Enum: "PROVISIONING" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "REPROVISIONING" Example: state=PROVISIONED,PROVISIONING Filter attached App Links by one or more lifecycle states.
order	string (AttachedAppLinkOrder) Default: "DESC" Enum: "DESC" "ASC" Example: order=DESC Sort order for attached App Links.
style	string (Style) Default: "MEDIUM" Enum: "MIN" "MEDIUM" "FULL" Example: style=MEDIUM Detail level of the response.

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (AppDomainAttachedAppLink)

Data returned from the API call.

Array

href	string <uri> Resource URI
type required	string (AppLinkType) Default: "APP_LINK" Value: "APP_LINK" App Link Type
uuid required	string <uuid> Equinix-assigned access point identifier
name	string <string> Customer-provided App Link name
description	string <string> Customer-provided App Link description
state	string <string> (AppLinkState) Enum: "PROVISIONING" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "REPROVISIONING" App Link lifecycle state
	object (AppLinkCloudRouter) App Link Cloud Router
ipv4Subnet	string Customer-provided IP subnet for AppLink setup (/29 or larger subnet)
ipv4Address	string <ipv4> App Link IP address
bandwidth	integer App Link aggregated data transfer capacity in Mbps
	object (Project)

Response samples

Content type

application/json

{"pagination": {"limit": 20,
"offset": 0,
"total": 1
},
"data": [{"href": "https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914",
"type": "APP_LINK",
"uuid": "23cd19ab-d3bb-478b-9f25-bd12a3af1914",
"name": "Atlassian App Link",
"description": "Atlassian App Link in SV",
"state": "PROVISIONED",
"router": {"href": "https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6",
"type": "XF_ROUTER",
"uuid": "36204584-2ae1-44f6-980f-08ecd555d9c6"
},
"bandwidth": 1000,
"ipv4Subnet": "192.168.10.0/29",
"ipv4Address": "192.168.10.3",
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
}
}
]
}

Application Services

Application Services ^Beta

Create Service

This API provides capability to create user's Service

Authorizations:

BearerAuth

Request Body schema: application/json
required

type

required

string (AppServiceType)

Default: "APP_SERVICE"

Value: "APP_SERVICE"

App Service Type

name

required

string <string> [ 1 .. 50 ] characters

Customer-provided App Service name

description

string <string>

Customer-provided App Service description

endpoint

required

string

Accessible endpoint through this service

sourceDomains

Array of strings

List of source domains from where traffic is allowed

required

object (Project)

projectId

required

string

Subscriber-assigned project ID

Responses

Request samples

Payload

Content type

application/json

{"type": "APP_SERVICE",
"name": "Atlassian App Service",
"description": "Atlassian App Service in SV",
"endpoint": "equinixjira.atlassian.net",
"sourceDomains": ["equinix.com"
],
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
}
}

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2",
"uuid": "5008a109-9d1c-485c-b0ba-de9736f283c2",
"type": "APP_SERVICE",
"name": "Atlassian App Service",
"description": "Atlassian App Service in SV",
"state": "PROVISIONING",
"endpoint": "equinixjira.atlassian.net",
"sourceDomains": ["equinix.com"
],
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
},
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z"
}
}

Get Service

This API provides capability to retrieve user's Service

Authorizations:

BearerAuth

path Parameters

appServiceId

required

string <uuid>

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

App Service UUID

Responses

Response Schema: application/json

href

string <uri>

Resource URI

type

required

string (AppServiceType)

Default: "APP_SERVICE"

Value: "APP_SERVICE"

App Service Type

uuid

string <uuid>

Equinix-assigned access point identifier

name

required

string <string>

Customer-provided App Service name

description

string <string>

Customer-provided App Service description

state

string (AppServiceState)

Enum: "PROVISIONING" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONED" "REPROVISIONING"

App Service lifecycle state

endpoint

string

Accessible endpoint through this service

sourceDomains

Array of strings

List of source domains from where traffic is allowed

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

object (Project)

projectId

required

string

Subscriber-assigned project ID

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

object (AppServiceChange)

Current state of latest AppService change

uuid

string

Uniquely identifies a change

type

required

string

Value: "APP_SERVICE_UPDATE"

Type of change

status

string

Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdDateTime

string <date-time>

Set when change flow starts

updatedDateTime

required

string <date-time>

Set when change object is updated

Array of objects (AppServiceChangeOperation)

Array

op required	string Enum: "replace" "add" "remove" operation type applied to the resource
path required	string Enum: "/name" "/description" "/sourceDomains" path inside document leading to updated parameter
value required	any new value for updated parameter

Response samples

200
401
403
404
500

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2",
"uuid": "5008a109-9d1c-485c-b0ba-de9736f283c2",
"type": "APP_SERVICE",
"name": "Atlassian App Service",
"description": "Atlassian App Service in SV",
"state": "PROVISIONED",
"endpoint": "equinixjira.atlassian.net",
"sourceDomains": ["equinix.com"
],
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
},
"account": {"organizationName": "atlassian"
},
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedBy": "test",
"updatedDateTime": "2026-06-28T04:20:55.471Z"
}
}

Delete Service

This API provides capability to delete user's Service

Authorizations:

BearerAuth

path Parameters

appServiceId

required

string <uuid>

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

App Service UUID

Responses

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2",
"uuid": "5008a109-9d1c-485c-b0ba-de9736f283c2",
"type": "APP_SERVICE",
"name": "Atlassian App Service",
"description": "Atlassian App Service in SV",
"state": "DEPROVISIONING",
"endpoint": "equinixjira.atlassian.net",
"sourceDomains": ["equinix.com"
],
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
},
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedBy": "test",
"updatedDateTime": "2026-06-28T04:20:55.471Z",
"deletedBy": "test",
"deletedDateTime": "2026-06-29T04:20:55.471Z"
}
}

Update Service

This API provides capability to update user's Service

Authorizations:

BearerAuth

path Parameters

appServiceId

required

string <uuid>

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

App Service UUID

Request Body schema: application/json-patch+json
required

Array (= 1 items)

op required	string Enum: "replace" "add" "remove" operation type applied to the resource
path required	string Enum: "/name" "/description" "/sourceDomains" path inside document leading to updated parameter
value required	any new value for updated parameter

Responses

Request samples

Payload

Content type

application/json-patch+json

[{"op": "replace",
"path": "/name",
"value": "Updated Atlassian App Service"
}
]

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2",
"uuid": "5008a109-9d1c-485c-b0ba-de9736f283c2",
"type": "APP_SERVICE",
"name": "Updated Atlassian App Service",
"description": "Atlassian App Service in SV",
"state": "REPROVISIONING",
"endpoint": "equinixjira.atlassian.net",
"sourceDomains": ["equinix.com"
],
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
},
"change": {"uuid": "531c4ab5-43b0-4352-8975-ee9045325841",
"type": "APP_SERVICE_UPDATE",
"status": "REQUESTED",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedDateTime": "2026-06-28T04:20:55.471Z",
"data": [{"op": "replace",
"path": "/name",
"value": "Updated Atlassian App Service"
}
]
},
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedBy": "test",
"updatedDateTime": "2026-06-28T04:20:55.471Z"
}
}

Search Services

The API provides capability to get list of user's App Services using search criteria, including optional filtering, pagination and sorting

Authorizations:

BearerAuth

Request Body schema: application/json
required

object (AppServiceFilters)

Array of AppServiceSimpleExpression (object) or AppServiceOrFilter (object) (AppServiceFilter) <= 8 items

Array (<= 8 items)

Any of

property	string Possible field names to use on filters: `/project/projectId` - project id `/uuid` - App Service uuid `/name` - App Service name `/description` - App Service description `/state` - App Service status `/endpoint` - App Service endpoint `/sourceDomains` - App Service source domains `/changeLog/createdDateTime` - App Service creation timestamp `/changeLog/updatedDateTime` - App Service last updated timestamp `/changeLog/deletedDateTime` - App Service deletion timestamp
operator	string Possible operators to use on filters: `=` - equal `!=` - not equal `>` - greater than `<` - less than `IN` - in `NOT IN` - not in `LIKE` - like `ILIKE` - case-insensitive like `BETWEEN` - between `NOT BETWEEN` - not between
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (AppServiceSortCriteria)

Array

direction	string (AppServiceSortDirection) Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string <string> (AppServiceSortBy) Default: "/changeLog/updatedDateTime" Possible field names to use on '400_InvalidSorting': `/name` - App Service name `/uuid` - App Service uuid `/state` - App Service status `/changeLog/createdDateTime` - Date and time when change flow starts `/changeLog/updatedDateTime` - Date and time when change object is updated

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (AppService)

Data returned from the API call.

Array

href	string <uri> Resource URI
type required	string (AppServiceType) Default: "APP_SERVICE" Value: "APP_SERVICE" App Service Type
uuid	string <uuid> Equinix-assigned access point identifier
name required	string <string> Customer-provided App Service name
description	string <string> Customer-provided App Service description
state	string (AppServiceState) Enum: "PROVISIONING" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONED" "REPROVISIONING" App Service lifecycle state
endpoint	string Accessible endpoint through this service
sourceDomains	Array of strings List of source domains from where traffic is allowed
	object (SimplifiedAccount)
	object (Project)
	object (Changelog) Change log
	object (AppServiceChange) Current state of latest AppService change

Request samples

Payload

Content type

application/json

Example

SearchFilterByStatus

{"filter": {"and": [{"property": "/state",
"operator": "=",
"values": ["PROVISIONED"
]
},
{"property": "/project/projectId",
"operator": "IN",
"values": ["71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
]
}
]
},
"pagination": {"offset": 0,
"limit": 20
},
"sort": [{"direction": "DESC",
"property": "/changeLog/createdDateTime"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 1,
"next": "/search?offset=1&limit=20",
"previous": "/search?offset=0&limit=20"
},
"data": [{"href": "https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2",
"uuid": "5008a109-9d1c-485c-b0ba-de9736f283c2",
"type": "APP_SERVICE",
"name": "Atlassian App Service",
"description": "Atlassian App Service in SV",
"state": "PROVISIONED",
"endpoint": "equinixjira.atlassian.net",
"sourceDomains": ["equinix.com"
],
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
},
"account": {"organizationName": "atlassian"
}
}
]
}

Get Attached Links for Service

This API provides capability to retrieve App Links attached to an App Service

Authorizations:

BearerAuth

path Parameters

appServiceId

required

string <uuid>

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

App Service UUID

query Parameters

offset	integer Example: offset=1 offset
limit	integer Example: limit=10 number of records to fetch
state	Array of strings <string> (AttachedAppLinkState) [ items <string > ] Items Enum: "PROVISIONING" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "REPROVISIONING" Example: state=PROVISIONED,PROVISIONING Filter attached App Links by one or more lifecycle states.
order	string (AttachedAppLinkOrder) Default: "DESC" Enum: "DESC" "ASC" Example: order=DESC Sort order for attached App Links.
style	string (Style) Default: "MEDIUM" Enum: "MIN" "MEDIUM" "FULL" Example: style=MEDIUM Detail level of the response.

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (AppServiceAttachedAppLink)

Data returned from the API call.

Array

href	string <uri> Resource URI
type required	string (AppLinkType) Default: "APP_LINK" Value: "APP_LINK" App Link Type
uuid required	string <uuid> Equinix-assigned access point identifier
name	string <string> Customer-provided App Link name
description	string <string> Customer-provided App Link description
state	string <string> (AppLinkState) Enum: "PROVISIONING" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "REPROVISIONING" App Link lifecycle state
	object (AppLinkCloudRouter) App Link Cloud Router
ipv4Subnet	string Customer-provided IP subnet for AppLink setup (/29 or larger subnet)
ipv4Address	string <ipv4> App Link IP address
bandwidth	integer App Link aggregated data transfer capacity in Mbps
	object (Project)

Response samples

Content type

application/json

{"pagination": {"limit": 20,
"offset": 0,
"total": 1
},
"data": [{"href": "https://api.equinix.com/fabric/v4/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914",
"type": "APP_LINK",
"uuid": "23cd19ab-d3bb-478b-9f25-bd12a3af1914",
"name": "Atlassian App Link",
"description": "Atlassian App Link in SV",
"state": "PROVISIONED",
"router": {"href": "https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6",
"type": "XF_ROUTER",
"uuid": "36204584-2ae1-44f6-980f-08ecd555d9c6"
},
"bandwidth": 1000,
"ipv4Subnet": "192.168.10.0/29",
"ipv4Address": "192.168.10.3",
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
}
}
]
}

Get Attached Subscriptions for Service

This API provides capability to retrieve App Subscriptions attached to an App Service

Authorizations:

BearerAuth

path Parameters

appServiceId

required

string <uuid>

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

App Service UUID

query Parameters

offset	integer Example: offset=1 offset
limit	integer Example: limit=10 number of records to fetch
state	Array of strings (AttachedAppSubscriptionState) Items Enum: "PROVISIONING" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "REPROVISIONING" Example: state=PROVISIONED,PROVISIONING Filter attached App Subscriptions by one or more lifecycle states.
order	string (AttachedAppSubscriptionOrder) Default: "DESC" Enum: "DESC" "ASC" Example: order=DESC Sort order for attached App Subscriptions.
style	string (Style) Default: "MEDIUM" Enum: "MIN" "MEDIUM" "FULL" Example: style=MEDIUM Detail level of the response.

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (AppServiceAttachedAppSubscription)

Data returned from the API call.

Array

href	string <uri> Resource URI
type required	string (AppSubscriptionType) Default: "APP_SUBSCRIPTION" Value: "APP_SUBSCRIPTION" App Subscription Type
uuid required	string <uuid> Equinix-assigned access point identifier
state required	string (AppSubscriptionState) Enum: "PROVISIONING" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "REPROVISIONING" App Subscription lifecycle state
	object (SimplifiedAccount)

Response samples

Content type

application/json

{"pagination": {"limit": 20,
"offset": 0,
"total": 1
},
"data": [{"href": "https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"type": "APP_SUBSCRIPTION",
"uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"state": "PROVISIONED",
"account": {"organizationName": "equinix"
}
}
]
}

Search Attached Subscriptions

The API provides capability to get list of App Subscriptions attached to an App Service using search criteria

Authorizations:

BearerAuth

path Parameters

appServiceId

required

string <uuid>

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

App Service UUID

Request Body schema: application/json
required

object (AppServiceAttachedAppSubscriptionFilters)

Array of AppServiceAttachedAppSubscriptionSimpleExpression (object) or AppServiceAttachedAppSubscriptionOrFilter (object) (AppServiceAttachedAppSubscriptionFilter) <= 8 items

Array (<= 8 items)

Any of

property	string Possible field names to use on filters: `/uuid` - App Subscription UUID `/state` - App Subscription lifecycle state
operator	string Possible operators to use on filters: `=` - equal `!=` - not equal `IN` - in `NOT IN` - not in
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (AppServiceAttachedAppSubscriptionSortCriteria)

Array

direction	string (AppServiceAttachedAppSubscriptionSortDirection) Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string <string> (AppServiceAttachedAppSubscriptionSortBy) Default: "/uuid" Possible field names to use on '400_InvalidSorting': `/uuid` - App Subscription UUID `/state` - App Subscription lifecycle state

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (AppServiceAttachedAppSubscription)

Data returned from the API call.

Array

href	string <uri> Resource URI
type required	string (AppSubscriptionType) Default: "APP_SUBSCRIPTION" Value: "APP_SUBSCRIPTION" App Subscription Type
uuid required	string <uuid> Equinix-assigned access point identifier
state required	string (AppSubscriptionState) Enum: "PROVISIONING" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "REPROVISIONING" App Subscription lifecycle state
	object (SimplifiedAccount)

Request samples

Payload

Content type

application/json

{"filter": {"and": [{"property": "/state",
"operator": "IN",
"values": ["PROVISIONED"
]
}
]
},
"pagination": {"offset": 0,
"limit": 20
},
"sort": [{"direction": "DESC",
"property": "/uuid"
}
]
}

Response samples

Content type

application/json

{"pagination": {"limit": 20,
"offset": 0,
"total": 1
},
"data": [{"href": "https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"type": "APP_SUBSCRIPTION",
"uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"state": "PROVISIONED",
"account": {"organizationName": "equinix"
}
}
]
}

Application Links

Application Links ^Beta

Create Link

This API provides capability to create user's Link

Authorizations:

BearerAuth

Request Body schema: application/json
required

type

required

string (AppLinkType)

Default: "APP_LINK"

Value: "APP_LINK"

App Link Type

name

required

string <string> [ 1 .. 50 ] characters

Customer-provided App Link name

description

string <string>

Customer-provided App Link description

required

object (AppLinkPostRequestRouter)

Cloud Router reference for App Link

uuid

required

string <uuid>

Cloud Router UUID

ipv4Subnet

required

string

Customer-provided IP subnet for AppLink setup (/29 or larger subnet)

bandwidth

required

integer

App Link aggregated data transfer capacity in Mbps

required

object (Project)

projectId

required

string

Subscriber-assigned project ID

Responses

Request samples

Payload

Content type

application/json

{"type": "APP_LINK",
"name": "Atlassian App Link",
"description": "Atlassian App Link in SV",
"router": {"uuid": "36204584-2ae1-44f6-980f-08ecd555d9c6"
},
"ipv4Subnet": "192.168.10.0/29",
"bandwidth": 1000,
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
}
}

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914",
"uuid": "23cd19ab-d3bb-478b-9f25-bd12a3af1914",
"type": "APP_LINK",
"name": "Atlassian App Link",
"description": "Atlassian App Link in SV",
"state": "PROVISIONING",
"router": {"href": "https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6",
"uuid": "36204584-2ae1-44f6-980f-08ecd555d9c6",
"type": "XF_ROUTER"
},
"ipv4Subnet": "192.168.10.0/29",
"ipv4Address": "192.168.10.3",
"bandwidth": 1000,
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
},
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z"
}
}

Get Link

This API provides capability to retrieve user's Link

Authorizations:

BearerAuth

path Parameters

appLinkId

required

string <uuid>

Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914

App Link UUID

Responses

Response Schema: application/json

href

string <uri>

Resource URI

type

required

string (AppLinkType)

Default: "APP_LINK"

Value: "APP_LINK"

App Link Type

uuid

string <uuid>

Equinix-assigned access point identifier

name

required

string <string>

Customer-provided App Link name

description

string <string>

Customer-provided App Link description

state

string <string> (AppLinkState)

Enum: "PROVISIONING" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "REPROVISIONING"

App Link lifecycle state

required

object (AppLinkCloudRouter)

App Link Cloud Router

href	string <uri> Resource URI
type	string Value: "XF_ROUTER" Cloud Router Type
uuid	string <uuid> Cloud Router UUID

ipv4Subnet

required

string

Customer-provided IP subnet for AppLink setup (/29 or larger subnet)

ipv4Address

string <ipv4>

App Link IP address

bandwidth

required

integer

App Link aggregated data transfer capacity in Mbps

required

object (Project)

projectId

required

string

Subscriber-assigned project ID

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

object (AppLinkChange)

Current state of latest AppLink change

uuid

string

Uniquely identifies a change

type

required

string

Value: "APP_LINK_UPDATE"

Type of change

status

string

Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdDateTime

string <date-time>

Set when change flow starts

updatedDateTime

required

string <date-time>

Set when change object is updated

Array of objects (AppLinkChangeOperation)

Array

op required	string Enum: "replace" "add" "remove" operation type applied to the resource
path required	string Enum: "/name" "/description" "/bandwidth" "/ipv4Subnet" path inside document leading to updated parameter
value required	any new value for updated parameter

Response samples

200
401
403
404
500

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914",
"uuid": "23cd19ab-d3bb-478b-9f25-bd12a3af1914",
"type": "APP_LINK",
"name": "Atlassian App Link",
"description": "Atlassian App Link in SV",
"state": "PROVISIONED",
"router": {"href": "https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6",
"uuid": "36204584-2ae1-44f6-980f-08ecd555d9c6",
"type": "XF_ROUTER"
},
"ipv4Subnet": "192.168.10.0/29",
"ipv4Address": "192.168.10.3",
"bandwidth": 1000,
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
},
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedBy": "test",
"updatedDateTime": "2026-06-28T04:20:55.471Z"
}
}

Delete Link

This API provides capability to delete user's Link

Authorizations:

BearerAuth

path Parameters

appLinkId

required

string <uuid>

Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914

App Link UUID

Responses

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914",
"uuid": "23cd19ab-d3bb-478b-9f25-bd12a3af1914",
"type": "APP_LINK",
"name": "Atlassian App Link",
"description": "Atlassian App Link in SV",
"state": "DEPROVISIONING",
"router": {"href": "https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6",
"uuid": "36204584-2ae1-44f6-980f-08ecd555d9c6",
"type": "XF_ROUTER"
},
"ipv4Subnet": "192.168.10.0/29",
"ipv4Address": "192.168.10.3",
"bandwidth": 1000,
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
},
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedBy": "test",
"updatedDateTime": "2026-06-28T04:20:55.471Z",
"deletedBy": "test",
"deletedDateTime": "2026-06-29T04:20:55.471Z"
}
}

Update Link

This API provides capability to update user's Link

Authorizations:

BearerAuth

path Parameters

appLinkId

required

string <uuid>

Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914

App Link UUID

Request Body schema: application/json-patch+json
required

Array (= 1 items)

op required	string Enum: "replace" "add" "remove" operation type applied to the resource
path required	string Enum: "/name" "/description" "/bandwidth" "/ipv4Subnet" path inside document leading to updated parameter
value required	any new value for updated parameter

Responses

Request samples

Payload

Content type

application/json-patch+json

[{"op": "replace",
"path": "/name",
"value": "Updated Atlassian App Link"
}
]

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914",
"uuid": "23cd19ab-d3bb-478b-9f25-bd12a3af1914",
"type": "APP_LINK",
"name": "Updated Atlassian App Link",
"description": "Atlassian App Link in SV",
"state": "REPROVISIONING",
"router": {"href": "https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6",
"uuid": "36204584-2ae1-44f6-980f-08ecd555d9c6",
"type": "XF_ROUTER"
},
"ipv4Subnet": "192.168.10.0/29",
"ipv4Address": "192.168.10.3",
"bandwidth": 1000,
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
},
"change": {"uuid": "531c4ab5-43b0-4352-8975-ee9045325841",
"type": "APP_LINK_UPDATE",
"status": "REQUESTED",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedDateTime": "2026-06-28T04:20:55.471Z",
"data": [{"op": "replace",
"path": "/name",
"value": "Updated Atlassian App Link"
}
]
},
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedBy": "test",
"updatedDateTime": "2026-06-28T04:20:55.471Z"
}
}

Search Links

The API provides capability to get list of user's App Links using search criteria, including optional filtering, pagination and sorting

Authorizations:

BearerAuth

Request Body schema: application/json
required

object (AppLinkFilters)

Array of AppLinkSimpleExpression (object) or AppLinkOrFilter (object) (AppLinkFilter) <= 8 items

Array (<= 8 items)

Any of

property	string Possible field names to use on filters: `/project/projectId` - project id `/uuid` - App Link uuid `/name` - App Link name `/description` - App Link description `/state` - App Link status `/ipv4Subnet` - App Link ipv4 subnet `/bandwidth` - App Link bandwidth `/changeLog/createdDateTime` - App Link creation timestamp `/changeLog/updatedDateTime` - App Link last updated timestamp `/changeLog/deletedDateTime` - App Link deletion timestamp
operator	string Possible operators to use on filters: `=` - equal `!=` - not equal `>` - greater than `<` - less than `IN` - in `NOT IN` - not in `LIKE` - like `ILIKE` - case-insensitive like `BETWEEN` - between `NOT BETWEEN` - not between
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (AppLinkSortCriteria)

Array

direction	string (AppLinkSortDirection) Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string <string> (AppLinkSortBy) Default: "/changeLog/updatedDateTime" Possible field names to use on '400_InvalidSorting': `/name` - App Link name `/uuid` - App Link uuid `/state` - App Link status `/changeLog/createdDateTime` - Date and time when change flow starts `/changeLog/updatedDateTime` - Date and time when change object is updated

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (AppLink)

Data returned from the API call.

Array

href	string <uri> Resource URI
type required	string (AppLinkType) Default: "APP_LINK" Value: "APP_LINK" App Link Type
uuid	string <uuid> Equinix-assigned access point identifier
name required	string <string> Customer-provided App Link name
description	string <string> Customer-provided App Link description
state	string <string> (AppLinkState) Enum: "PROVISIONING" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "REPROVISIONING" App Link lifecycle state
required	object (AppLinkCloudRouter) App Link Cloud Router
ipv4Subnet required	string Customer-provided IP subnet for AppLink setup (/29 or larger subnet)
ipv4Address	string <ipv4> App Link IP address
bandwidth required	integer App Link aggregated data transfer capacity in Mbps
required	object (Project)
	object (Changelog) Change log
	object (AppLinkChange) Current state of latest AppLink change

Request samples

Payload

Content type

application/json

Example

SearchFilterByStatus

{"filter": {"and": [{"property": "/state",
"operator": "=",
"values": ["PROVISIONED"
]
},
{"property": "/project/projectId",
"operator": "IN",
"values": ["71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
]
}
]
},
"pagination": {"offset": 0,
"limit": 20
},
"sort": [{"direction": "DESC",
"property": "/changeLog/createdDateTime"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 1,
"next": "/search?offset=1&limit=20",
"previous": "/search?offset=0&limit=20"
},
"data": [{"href": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914",
"uuid": "23cd19ab-d3bb-478b-9f25-bd12a3af1914",
"type": "APP_LINK",
"name": "Atlassian App Link",
"description": "Atlassian App Link in SV",
"state": "PROVISIONED",
"router": {"href": "https://api.equinix.com/fabric/v4/routers/36204584-2ae1-44f6-980f-08ecd555d9c6",
"uuid": "36204584-2ae1-44f6-980f-08ecd555d9c6",
"type": "XF_ROUTER"
},
"ipv4Subnet": "192.168.10.0/29",
"ipv4Address": "192.168.10.3",
"bandwidth": 1000,
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
}
}
]
}

Attach Domain to Link

This API provides ability to attach the user's App Domain to App Link

Authorizations:

BearerAuth

path Parameters

appLinkId required	string <uuid> Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 App Link UUID
appDomainId required	string <uuid> Example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 App Domain UUID

Responses

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"type": "APP_DOMAIN",
"name": "atlassian.net",
"attachmentStatus": "ATTACHING",
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedBy": "test",
"updatedDateTime": "2026-06-27T04:20:55.471Z"
}
}

Detach Domain from Link

This API provides ability to detach App Domain from App Link

Authorizations:

BearerAuth

path Parameters

appLinkId required	string <uuid> Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 App Link UUID
appDomainId required	string <uuid> Example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 App Domain UUID

Responses

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"type": "APP_DOMAIN",
"name": "atlassian.net",
"attachmentStatus": "DETACHING",
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedBy": "test",
"updatedDateTime": "2026-06-28T04:20:55.471Z"
}
}

Get Attached Domain for Link

This API provides ability to retrieve an App Domain attached to an App Link

Authorizations:

BearerAuth

path Parameters

appLinkId required	string <uuid> Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 App Link UUID
appDomainId required	string <uuid> Example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3 App Domain UUID

Responses

Response Schema: application/json

href

string <uri>

Resource URI

type

string (AppDomainType)

Default: "APP_DOMAIN"

Value: "APP_DOMAIN"

App Domain Type

uuid

required

string <uuid>

Equinix-assigned access point identifier

name

string

Customer-provided App Domain name

attachmentStatus

string <string> (AppLinkAttachState)

Enum: "ATTACHING" "ATTACHING_FAILED" "ATTACHED" "DETACHING" "DETACHING_FAILED" "DETACHED" "REATTACHING" "REATTACHING_FAILED"

App Link attachment lifecycle state

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

Response samples

200
401
403
404
500

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"type": "APP_DOMAIN",
"name": "atlassian.net",
"attachmentStatus": "ATTACHED",
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedBy": "test",
"updatedDateTime": "2026-06-28T04:20:55.471Z"
}
}

Search Attached Domains for Link

The API provides capability to get list of user's attached App Domains using search criteria, including optional filtering, pagination and sorting

Authorizations:

BearerAuth

path Parameters

appLinkId

required

string <uuid>

Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914

App Link UUID

Request Body schema: application/json
required

object (AppLinkAttachDomainFilters)

Array of AppLinkAttachDomainSimpleExpression (object) or AppLinkAttachDomainOrFilter (object) (AppLinkAttachDomainFilter) <= 8 items

Array (<= 8 items)

Any of

property	string Possible field names to use on filters: `/uuid` - App Domain attach to App Link uuid `/attachmentStatus` - App Domain attach to App Link status
operator	string Possible operators to use on filters: `=` - equal `!=` - not equal `IN` - in `NOT IN` - not in
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (AppLinkAttachDomainSortCriteria)

Array

direction	string (AppLinkAttachDomainSortDirection) Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string <string> (AppLinkAttachDomainSortBy) Default: "/changeLog/updatedDateTime" Possible field names to use on '400_InvalidSorting': `/uuid` - App Domain attach to App Link uuid `/attachmentStatus` - App Domain attach to App Link status `/changeLog/createdDateTime` - Date and time when change flow starts `/changeLog/updatedDateTime` - Date and time when change object is updated

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (AppLinkAppDomainAttachment)

Data returned from the API call.

Array

href	string <uri> Resource URI
type	string (AppDomainType) Default: "APP_DOMAIN" Value: "APP_DOMAIN" App Domain Type
uuid required	string <uuid> Equinix-assigned access point identifier
name	string Customer-provided App Domain name
attachmentStatus	string <string> (AppLinkAttachState) Enum: "ATTACHING" "ATTACHING_FAILED" "ATTACHED" "DETACHING" "DETACHING_FAILED" "DETACHED" "REATTACHING" "REATTACHING_FAILED" App Link attachment lifecycle state
	object (Changelog) Change log

Request samples

Payload

Content type

application/json

Example

SearchAttachedDomainFilterByStatus

{"filter": {"and": [{"property": "/attachmentStatus",
"operator": "=",
"values": ["ATTACHED"
]
}
]
},
"pagination": {"offset": 0,
"limit": 20
},
"sort": [{"direction": "DESC",
"property": "/changeLog/createdDateTime"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 1,
"next": "/search?offset=1&limit=20",
"previous": "/search?offset=0&limit=20"
},
"data": [{"href": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"type": "APP_DOMAIN",
"name": "atlassian.net",
"attachmentStatus": "ATTACHED"
}
]
}

Get Attached Domains for Link

This API provides capability to retrieve App Domains attached to an App Link

Authorizations:

BearerAuth

path Parameters

appLinkId

required

string <uuid>

Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914

App Link UUID

query Parameters

offset	integer Example: offset=1 offset
limit	integer Example: limit=10 number of records to fetch
attachmentStatus	Array of strings <string> (AttachedAppDomainAttachmentStatus) [ items <string > ] Items Enum: "ATTACHING" "ATTACHING_FAILED" "ATTACHED" "DETACHING" "DETACHING_FAILED" "DETACHED" "REATTACHING" "REATTACHING_FAILED" Example: attachmentStatus=ATTACHED,ATTACHING Filter attached App Domains by one or more attachment lifecycle states.
order	string (AttachedAppDomainOrder) Default: "DESC" Enum: "DESC" "ASC" Example: order=DESC Sort order for attached App Domains.
style	string (Style) Default: "MEDIUM" Enum: "MIN" "MEDIUM" "FULL" Example: style=MEDIUM Detail level of the response.

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (AppLinkAttachedAppDomain)

Data returned from the API call.

Array

href	string <uri> Resource URI
type required	string (AppDomainType) Default: "APP_DOMAIN" Value: "APP_DOMAIN" App Domain Type
uuid required	string <uuid> Equinix-assigned access point identifier
name	string <string> Customer-provided App Domain name
description	string <string> Customer-provided App Domain description
state	string <string> (AppDomainState) Enum: "PENDING_VERIFICATION" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" App Domain lifecycle state
	object (Project)
attachmentStatus	string <string> (AppLinkAttachState) Enum: "ATTACHING" "ATTACHING_FAILED" "ATTACHED" "DETACHING" "DETACHING_FAILED" "DETACHED" "REATTACHING" "REATTACHING_FAILED" App Link attachment lifecycle state

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 1,
"next": "/search?offset=1&limit=20",
"previous": "/search?offset=0&limit=20"
},
"data": [{"href": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"type": "APP_DOMAIN",
"name": "atlassian.net",
"description": "Atlassian Domain",
"state": "PROVISIONED",
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
},
"attachmentStatus": "ATTACHED",
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedBy": "test",
"updatedDateTime": "2026-06-28T04:20:55.471Z"
}
}
]
}

Attach Service to Link

This API provides ability to attach the user's App Service to App Link

Authorizations:

BearerAuth

path Parameters

appLinkId required	string <uuid> Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 App Link UUID
appServiceId required	string <uuid> Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 App Service UUID

Request Body schema: application/json
required

geoScope required	string Geo scope for the App Service
destinationIp required	string <ipv4> Target IP for forwarding API requests

Responses

Request samples

Payload

Content type

application/json

{"geoScope": "GLOBAL",
"destinationIp": "10.10.1.110"
}

Response samples

202
401
403
404
500

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2",
"uuid": "5008a109-9d1c-485c-b0ba-de9736f283c2",
"type": "APP_SERVICE",
"geoScope": "GLOBAL",
"destinationIp": "10.10.1.110",
"attachmentStatus": "ATTACHING",
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedBy": "test",
"updatedDateTime": "2026-06-27T04:20:55.471Z"
}
}

Detach Service from Link

This API provides ability to detach App Service from App Link

Authorizations:

BearerAuth

path Parameters

appLinkId required	string <uuid> Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 App Link UUID
appServiceId required	string <uuid> Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 App Service UUID

Responses

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2",
"uuid": "5008a109-9d1c-485c-b0ba-de9736f283c2",
"type": "APP_SERVICE",
"geoScope": "GLOBAL",
"destinationIp": "10.10.1.110",
"attachmentStatus": "DETACHING",
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedBy": "test",
"updatedDateTime": "2026-06-28T04:20:55.471Z"
}
}

Update Service Attachment for Link

This API provides ability to update the App Service attachment to App Link

Authorizations:

BearerAuth

path Parameters

appLinkId required	string <uuid> Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 App Link UUID
appServiceId required	string <uuid> Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 App Service UUID

Request Body schema: application/json-patch+json
required

Array (= 1 items)

op required	string Enum: "replace" "add" "remove" operation type applied to the resource
path required	string Value: "/destinationIp" path inside document leading to updated parameter
value required	any new value for updated parameter

Responses

Request samples

Payload

Content type

application/json-patch+json

[{"op": "replace",
"path": "/destinationIp",
"value": "10.10.1.120"
}
]

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2",
"uuid": "5008a109-9d1c-485c-b0ba-de9736f283c2",
"type": "APP_SERVICE",
"geoScope": "GLOBAL",
"destinationIp": "10.10.1.120",
"attachmentStatus": "ATTACHING",
"change": {"uuid": "531c4ab5-43b0-4352-8975-ee9045325841",
"type": "APP_SERVICE_UPDATE",
"status": "REQUESTED",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedDateTime": "2026-06-27T04:20:55.471Z",
"data": [{"op": "replace",
"path": "/destinationIp",
"value": "10.10.1.120"
}
]
},
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedBy": "test",
"updatedDateTime": "2026-06-27T04:20:55.471Z"
}
}

Get Attached Service for Link

This API provides ability to retrieve an App Service attached to an App Link

Authorizations:

BearerAuth

path Parameters

appLinkId required	string <uuid> Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 App Link UUID
appServiceId required	string <uuid> Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 App Service UUID

Responses

Response Schema: application/json

href

string <uri>

Resource URI

type

string (AppServiceType)

Default: "APP_SERVICE"

Value: "APP_SERVICE"

App Service Type

uuid

required

string <uuid>

Equinix-assigned access point identifier

geoScope

required

string

Geo scope for the App Service

destinationIp

required

string <ipv4>

Target IP for forwarding API requests

attachmentStatus

string <string> (AppLinkAttachState)

Enum: "ATTACHING" "ATTACHING_FAILED" "ATTACHED" "DETACHING" "DETACHING_FAILED" "DETACHED" "REATTACHING" "REATTACHING_FAILED"

App Link attachment lifecycle state

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

object (AppLinkAppServiceAttachmentChange)

Current state of latest AppLink change

uuid

string

Uniquely identifies a change

type

required

string

Value: "APP_SERVICE_UPDATE"

Type of change

status

string

Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdDateTime

string <date-time>

Set when change flow starts

updatedDateTime

required

string <date-time>

Set when change object is updated

Array of objects (AppLinkChangeOperation)

Array

op required	string Enum: "replace" "add" "remove" operation type applied to the resource
path required	string Enum: "/name" "/description" "/bandwidth" "/ipv4Subnet" path inside document leading to updated parameter
value required	any new value for updated parameter

Response samples

200
401
403
404
500

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2",
"uuid": "5008a109-9d1c-485c-b0ba-de9736f283c2",
"type": "APP_SERVICE",
"geoScope": "GLOBAL",
"destinationIp": "10.10.1.110",
"attachmentStatus": "ATTACHED",
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedBy": "test",
"updatedDateTime": "2026-06-28T04:20:55.471Z"
}
}

Search Attached Services for Link

The API provides capability to get list of user's attached App Services using search criteria, including optional filtering, pagination and sorting

Authorizations:

BearerAuth

path Parameters

appLinkId

required

string <uuid>

Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914

App Link UUID

Request Body schema: application/json
required

object (AppLinkAttachServiceFilters)

Array of AppLinkAttachServiceSimpleExpression (object) or AppLinkAttachServiceOrFilter (object) (AppLinkAttachServiceFilter) <= 8 items

Array (<= 8 items)

Any of

property	string Possible field names to use on filters: `/uuid` - App Service attach to App Link uuid `/attachmentStatus` - App Service attach to App Link status
operator	string Possible operators to use on filters: `=` - equal `!=` - not equal `IN` - in `NOT IN` - not in
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (AppLinkAttachServiceSortCriteria)

Array

direction	string (AppLinkAttachServiceSortDirection) Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string <string> (AppLinkAttachServiceSortBy) Default: "/changeLog/updatedDateTime" Possible field names to use on '400_InvalidSorting': `/uuid` - App Service attach to App Link uuid `/attachmentStatus` - App Service attach to App Link status `/changeLog/createdDateTime` - Date and time when change flow starts `/changeLog/updatedDateTime` - Date and time when change object is updated

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (AppLinkAppServiceAttachment)

Data returned from the API call.

Array

href	string <uri> Resource URI
type	string (AppServiceType) Default: "APP_SERVICE" Value: "APP_SERVICE" App Service Type
uuid required	string <uuid> Equinix-assigned access point identifier
geoScope required	string Geo scope for the App Service
destinationIp required	string <ipv4> Target IP for forwarding API requests
attachmentStatus	string <string> (AppLinkAttachState) Enum: "ATTACHING" "ATTACHING_FAILED" "ATTACHED" "DETACHING" "DETACHING_FAILED" "DETACHED" "REATTACHING" "REATTACHING_FAILED" App Link attachment lifecycle state
	object (Changelog) Change log
	object (AppLinkAppServiceAttachmentChange) Current state of latest AppLink change

Request samples

Payload

Content type

application/json

Example

SearchAttachedServiceFilterByStatus

{"filter": {"and": [{"property": "/attachmentStatus",
"operator": "=",
"values": ["ATTACHED"
]
}
]
},
"pagination": {"offset": 0,
"limit": 20
},
"sort": [{"direction": "DESC",
"property": "/changeLog/createdDateTime"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 1,
"next": "/search?offset=1&limit=20",
"previous": "/search?offset=0&limit=20"
},
"data": [{"href": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2",
"uuid": "5008a109-9d1c-485c-b0ba-de9736f283c2",
"type": "APP_SERVICE",
"geoScope": "GLOBAL",
"destinationIp": "10.10.1.110",
"attachmentStatus": "ATTACHED"
}
]
}

Get Attached Services for Link

This API provides capability to retrieve App Services attached to an App Link

Authorizations:

BearerAuth

path Parameters

appLinkId

required

string <uuid>

Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914

App Link UUID

query Parameters

offset	integer Example: offset=1 offset
limit	integer Example: limit=10 number of records to fetch
attachmentStatus	Array of strings <string> (AttachedAppServiceAttachmentStatus) [ items <string > ] Items Enum: "ATTACHING" "ATTACHING_FAILED" "ATTACHED" "DETACHING" "DETACHING_FAILED" "DETACHED" "REATTACHING" "REATTACHING_FAILED" Example: attachmentStatus=ATTACHED,ATTACHING Filter attached App Services by one or more attachment lifecycle states.
order	string (AttachedAppServiceOrder) Default: "DESC" Enum: "DESC" "ASC" Example: order=DESC Sort order for attached App Services.
style	string (Style) Default: "MEDIUM" Enum: "MIN" "MEDIUM" "FULL" Example: style=MEDIUM Detail level of the response.

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (AppLinkAttachedAppService)

Data returned from the API call.

Array

href	string <uri> Resource URI
type required	string (AppServiceType) Default: "APP_SERVICE" Value: "APP_SERVICE" App Service Type
uuid required	string <uuid> Equinix-assigned access point identifier
name	string <string> Customer-provided App Service name
description	string <string> Customer-provided App Service description
state	string (AppServiceState) Enum: "PROVISIONING" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONED" "REPROVISIONING" App Service lifecycle state
endpoint	string Accessible endpoint through this service
sourceDomains	Array of strings List of source domains from where traffic is allowed
	object (Project)
geoScope required	string Geo scope for the App Service
destinationIp required	string <ipv4> Target IP for forwarding API requests
attachmentStatus	string <string> (AppLinkAttachState) Enum: "ATTACHING" "ATTACHING_FAILED" "ATTACHED" "DETACHING" "DETACHING_FAILED" "DETACHED" "REATTACHING" "REATTACHING_FAILED" App Link attachment lifecycle state

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 1,
"next": "/search?offset=1&limit=20",
"previous": "/search?offset=0&limit=20"
},
"data": [{"href": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appServices/5008a109-9d1c-485c-b0ba-de9736f283c2",
"uuid": "5008a109-9d1c-485c-b0ba-de9736f283c2",
"type": "APP_SERVICE",
"name": "Atlassian App Service",
"description": "Atlassian App Service in SV",
"state": "PROVISIONED",
"endpoint": "equinixjira.atlassian.net",
"sourceDomains": ["equinix.com"
],
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
},
"geoScope": "GLOBAL",
"destinationIp": "10.10.1.110",
"attachmentStatus": "ATTACHED",
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedBy": "test",
"updatedDateTime": "2026-06-28T04:20:55.471Z"
}
}
]
}

Attach Processor to Link

This API provides ability to attach an App Processor to an App Link.

Authorizations:

BearerAuth

path Parameters

appLinkId required	string <uuid> Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 App Link UUID
appProcessorId required	string <uuid> Example: 90ee425c-9988-454c-96d9-1128bc16350f App Processor UUID

Request Body schema: application/json
required

config

required

string <byte>

Base64-encoded configuration for the processor attachment

Responses

Request samples

Payload

Content type

application/json

{"config": "bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA..."
}

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f",
"uuid": "90ee425c-9988-454c-96d9-1128bc16350f",
"type": "APP_PROCESSOR",
"config": "bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA...",
"endpoint": "123456.privateai.link",
"attachmentStatus": "ATTACHING",
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedBy": "test",
"updatedDateTime": "2026-06-27T04:20:55.471Z"
}
}

Detach App Processor from App Link

This API provides ability to detach an App Processor from an App Link.

Authorizations:

BearerAuth

path Parameters

appLinkId required	string <uuid> Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 App Link UUID
appProcessorId required	string <uuid> Example: 90ee425c-9988-454c-96d9-1128bc16350f App Processor UUID

Responses

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f",
"uuid": "90ee425c-9988-454c-96d9-1128bc16350f",
"type": "APP_PROCESSOR",
"config": "bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA...",
"endpoint": "123456.privateai.link",
"attachmentStatus": "DETACHING",
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedBy": "test",
"updatedDateTime": "2026-06-28T04:20:55.471Z"
}
}

Get attached App Processor for App Link

This API provides ability to get an App Processor attached to an App Link.

Authorizations:

BearerAuth

path Parameters

appLinkId required	string <uuid> Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914 App Link UUID
appProcessorId required	string <uuid> Example: 90ee425c-9988-454c-96d9-1128bc16350f App Processor UUID

Responses

Response Schema: application/json

href

string <uri>

Resource URI

type

string (AppProcessorType)

Default: "APP_PROCESSOR"

Value: "APP_PROCESSOR"

App Processor Type

uuid

required

string <uuid>

App Processor UUID

config

string <byte>

Base64-encoded configuration for the processor attachment

endpoint

string

Endpoint DNS name assigned to the attached App Processor

attachmentStatus

string <string> (AppLinkAttachState)

Enum: "ATTACHING" "ATTACHING_FAILED" "ATTACHED" "DETACHING" "DETACHING_FAILED" "DETACHED" "REATTACHING" "REATTACHING_FAILED"

App Link attachment lifecycle state

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

Response samples

200
401
403
404
500

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f",
"uuid": "90ee425c-9988-454c-96d9-1128bc16350f",
"type": "APP_PROCESSOR",
"config": "bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA...",
"endpoint": "123456.privateai.link",
"attachmentStatus": "ATTACHED",
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedBy": "test",
"updatedDateTime": "2026-06-28T04:20:55.471Z"
}
}

Search attached Processors to Link

The API provides capability to get list of App Processors attached to an App Link using search criteria, including optional filtering, pagination and sorting

Authorizations:

BearerAuth

path Parameters

appLinkId

required

string <uuid>

Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914

App Link UUID

Request Body schema: application/json
required

object (AppLinkAttachProcessorFilters)

Array of AppLinkAttachProcessorSimpleExpression (object) or AppLinkAttachProcessorOrFilter (object) (AppLinkAttachProcessorFilter) <= 8 items

Array (<= 8 items)

Any of

property	string Possible field names to use on filters: `/uuid` - App Processor attach to App Link uuid `/attachmentStatus` - App Processor attach to App Link status
operator	string Possible operators to use on filters: `=` - equal `!=` - not equal `IN` - in `NOT IN` - not in
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (AppLinkAttachProcessorSortCriteria)

Array

direction	string (AppLinkAttachProcessorSortDirection) Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string <string> (AppLinkAttachProcessorSortBy) Default: "/changeLog/updatedDateTime" Possible field names to use on '400_InvalidSorting': `/uuid` - App Processor attach to App Link uuid `/attachmentStatus` - App Processor attach to App Link status `/changeLog/createdDateTime` - Date and time when change flow starts `/changeLog/updatedDateTime` - Date and time when change object is updated

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (AppLinkAppProcessorAttachment)

Data returned from the API call.

Array

href	string <uri> Resource URI
type	string (AppProcessorType) Default: "APP_PROCESSOR" Value: "APP_PROCESSOR" App Processor Type
uuid required	string <uuid> App Processor UUID
config	string <byte> Base64-encoded configuration for the processor attachment
endpoint	string Endpoint DNS name assigned to the attached App Processor
attachmentStatus	string <string> (AppLinkAttachState) Enum: "ATTACHING" "ATTACHING_FAILED" "ATTACHED" "DETACHING" "DETACHING_FAILED" "DETACHED" "REATTACHING" "REATTACHING_FAILED" App Link attachment lifecycle state
	object (Changelog) Change log

Request samples

Payload

Content type

application/json

{"filter": {"and": [{"property": "/attachmentStatus",
"operator": "=",
"values": ["ATTACHED"
]
}
]
},
"pagination": {"offset": 0,
"limit": 20
},
"sort": [{"direction": "DESC",
"property": "/changeLog/createdDateTime"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 1,
"next": "/search?offset=1&limit=20",
"previous": "/search?offset=0&limit=20"
},
"data": [{"href": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f",
"uuid": "90ee425c-9988-454c-96d9-1128bc16350f",
"type": "APP_PROCESSOR",
"config": "bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA...",
"endpoint": "123456.privateai.link",
"attachmentStatus": "ATTACHED"
}
]
}

Get attached Processors for Link

This API provides capability to retrieve App Processors attached to an App Link.

Authorizations:

BearerAuth

path Parameters

appLinkId

required

string <uuid>

Example: 23cd19ab-d3bb-478b-9f25-bd12a3af1914

App Link UUID

query Parameters

offset	integer Example: offset=1 offset
limit	integer Example: limit=10 number of records to fetch
attachmentStatus	Array of strings <string> (AttachedAppProcessorAttachmentStatus) [ items <string > ] Items Enum: "ATTACHING" "ATTACHING_FAILED" "ATTACHED" "DETACHING" "DETACHING_FAILED" "DETACHED" "REATTACHING" "REATTACHING_FAILED" Example: attachmentStatus=ATTACHED,ATTACHING Filter attached App Processors by one or more attachment lifecycle states.
order	string (AttachedAppProcessorOrder) Default: "DESC" Enum: "DESC" "ASC" Example: order=DESC Sort order for attached App Processors.
style	string (Style) Default: "MEDIUM" Enum: "MIN" "MEDIUM" "FULL" Example: style=MEDIUM Detail level of the response.

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (AppLinkAppProcessorAttachment)

Data returned from the API call.

Array

href	string <uri> Resource URI
type	string (AppProcessorType) Default: "APP_PROCESSOR" Value: "APP_PROCESSOR" App Processor Type
uuid required	string <uuid> App Processor UUID
config	string <byte> Base64-encoded configuration for the processor attachment
endpoint	string Endpoint DNS name assigned to the attached App Processor
attachmentStatus	string <string> (AppLinkAttachState) Enum: "ATTACHING" "ATTACHING_FAILED" "ATTACHED" "DETACHING" "DETACHING_FAILED" "DETACHED" "REATTACHING" "REATTACHING_FAILED" App Link attachment lifecycle state
	object (Changelog) Change log

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 1,
"next": "/appProcessors?offset=1&limit=20",
"previous": "/appProcessors?offset=0&limit=20"
},
"data": [{"href": "https://api.equinix.com/fabric/v4/appLinks/23cd19ab-d3bb-478b-9f25-bd12a3af1914/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f",
"uuid": "90ee425c-9988-454c-96d9-1128bc16350f",
"type": "APP_PROCESSOR",
"attachmentStatus": "ATTACHED",
"config": "bW9kZWxfbGlzdDoKICAtIG1vZGVsX25hbWU6IGdwdC00bwogICA...",
"endpoint": "123456.privateai.link",
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedBy": "test",
"updatedDateTime": "2026-06-28T04:20:55.471Z"
}
}
]
}

Application Subscriptions

Application Subscriptions ^Beta

Create Subscription

This API provides capability to create user's Subscription

Authorizations:

BearerAuth

Request Body schema: application/json
required

type

required

string (AppSubscriptionType)

Default: "APP_SUBSCRIPTION"

Value: "APP_SUBSCRIPTION"

App Subscription Type

object (AppSubscriptionSourceRequest)

Source details for the Subscription

object (AppSubscriptionSourceRequestAppLink)

App Link reference for App Subscription

uuid

required

string <uuid>

Equinix-assigned access point identifier

ipSubnets

required

Array of strings <ipv4-cidr> [ items <ipv4-cidr > ]

List of IP subnets in CIDR notation

object (AppSubscriptionTargetRequest)

Target details for the Subscription

object (AppSubscriptionTargetRequestAppService)

App Service reference for App Subscription

uuid

required

string <uuid>

Equinix-assigned access point identifier

geoScope

required

string

Geo scope

prioritization

required

string (AppSubscriptionPrioritization)

Enum: "LATENCY" "PERFORMANCE" "UTILIZATION" "THRESHOLD" "ANY_TAG"

Prioritization strategy for forwarding API requests

required

object (Project)

projectId

required

string

Subscriber-assigned project ID

Responses

Request samples

Payload

Content type

application/json

{"type": "APP_SUBSCRIPTION",
"source": {"appLink": {"uuid": "e32c9c7a-0149-4582-8345-192b82aef972"
},
"ipSubnets": ["192.168.100.0/24"
]
},
"target": {"appService": {"uuid": "e18c15f4-c8aa-4c18-9e35-a7e9b288201d"
},
"geoScope": "GLOBAL",
"prioritization": "LATENCY"
},
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
}
}

Response samples

202
401
403
415
500

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"type": "APP_SUBSCRIPTION",
"source": {"appLink": {"uuid": "e32c9c7a-0149-4582-8345-192b82aef972"
},
"ipSubnets": ["192.168.100.0/24"
]
},
"target": {"appService": {"uuid": "e18c15f4-c8aa-4c18-9e35-a7e9b288201d"
},
"geoScope": "GLOBAL",
"prioritization": "LATENCY"
},
"state": "PROVISIONING",
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
},
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z"
}
}

Get Subscription

This API provides capability to retrieve user's Subscription

Authorizations:

BearerAuth

path Parameters

appSubscriptionId

required

string <uuid>

Example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3

App Subscription UUID

Responses

Response Schema: application/json

href

string <uri>

Resource URI

type

required

string (AppSubscriptionType)

Default: "APP_SUBSCRIPTION"

Value: "APP_SUBSCRIPTION"

App Subscription Type

uuid

string <uuid>

Equinix-assigned access point identifier

required

object (AppSubscriptionSource)

Source details for the Subscription

object (AppSubscriptionSourceAppLink)

App Link reference for App Subscription

href	string <uri> Resource URI
type	string App Link Type
uuid required	string <uuid> Equinix-assigned access point identifier

ipSubnets

required

Array of strings <ipv4-cidr> [ items <ipv4-cidr > ]

List of IP subnets in CIDR notation

required

object (AppSubscriptionTarget)

Target details for the Subscription

object (AppSubscriptionTargetAppService)

App Service reference for App Subscription

href	string <uri> Resource URI
type	string App Service Type
uuid required	string <uuid> Equinix-assigned access point identifier

geoScope

required

string

Geo scope

prioritization

required

string (AppSubscriptionPrioritization)

Enum: "LATENCY" "PERFORMANCE" "UTILIZATION" "THRESHOLD" "ANY_TAG"

Prioritization strategy for forwarding API requests

state

string (AppSubscriptionState)

Enum: "PROVISIONING" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "REPROVISIONING"

App Subscription lifecycle state

required

object (Project)

projectId

required

string

Subscriber-assigned project ID

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

object (AppSubscriptionChange)

Current state of latest AppSubscription change

uuid

string

Uniquely identifies a change

type

required

string

Value: "APP_SUBSCRIPTION_UPDATE"

Type of change

status

string

Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdDateTime

string <date-time>

Set when change flow starts

updatedDateTime

required

string <date-time>

Set when change object is updated

Array of objects (AppSubscriptionChangeOperation)

Array

op required	string Enum: "replace" "add" "remove" operation type applied to the resource
path required	string path inside document leading to updated parameter
value required	any new value for updated parameter

Response samples

200
401
403
404
500

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"type": "APP_SUBSCRIPTION",
"source": {"appLink": {"uuid": "e32c9c7a-0149-4582-8345-192b82aef972"
},
"ipSubnets": ["192.168.100.0/24"
]
},
"target": {"appService": {"uuid": "e18c15f4-c8aa-4c18-9e35-a7e9b288201d"
},
"geoScope": "GLOBAL",
"prioritization": "LATENCY"
},
"state": "PROVISIONED",
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
},
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedBy": "test",
"updatedDateTime": "2026-06-28T04:20:55.471Z"
}
}

Delete Subscription

This API provides capability to delete user's Subscription

Authorizations:

BearerAuth

path Parameters

appSubscriptionId

required

string <uuid>

Example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3

App Subscription UUID

Responses

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"type": "APP_SUBSCRIPTION",
"source": {"appLink": {"uuid": "e32c9c7a-0149-4582-8345-192b82aef972"
},
"ipSubnets": ["192.168.100.0/24"
]
},
"target": {"appService": {"uuid": "e18c15f4-c8aa-4c18-9e35-a7e9b288201d"
},
"geoScope": "GLOBAL",
"prioritization": "LATENCY"
},
"state": "DEPROVISIONED",
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
},
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedBy": "test",
"updatedDateTime": "2026-06-28T04:20:55.471Z",
"deletedBy": "test",
"deletedDateTime": "2026-06-29T04:20:55.471Z"
}
}

Update Subscription

This API provides capability to update user's Subscription

Authorizations:

BearerAuth

path Parameters

appSubscriptionId

required

string <uuid>

Example: 20f3ef8e-d670-4236-86fa-bb0038adcfc3

App Subscription UUID

Request Body schema: application/json-patch+json
required

Array (non-empty)

op required	string Enum: "replace" "add" "remove" operation type applied to the resource
path required	string path inside document leading to updated parameter
value required	any new value for updated parameter

Responses

Request samples

Payload

Content type

application/json-patch+json

[{"op": "add",
"path": "/source/ipSubnets",
"value": ["192.168.200.0/24"
]
}
]

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"type": "APP_SUBSCRIPTION",
"source": {"appLink": {"uuid": "e32c9c7a-0149-4582-8345-192b82aef972"
},
"ipSubnets": ["192.168.100.0/24",
"192.168.200.0/24"
]
},
"target": {"appService": {"uuid": "e18c15f4-c8aa-4c18-9e35-a7e9b288201d"
},
"geoScope": "GLOBAL",
"prioritization": "LATENCY"
},
"state": "PROVISIONING",
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
},
"change": {"uuid": "531c4ab5-43b0-4352-8975-ee9045325841",
"type": "APP_SUBSCRIPTION_UPDATE",
"status": "REQUESTED",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedDateTime": "2026-06-28T04:20:55.471Z",
"data": [{"op": "add",
"path": "/source/ipSubnets",
"value": ["192.168.200.0/24"
]
}
]
},
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-06-27T04:20:55.471Z",
"updatedBy": "test",
"updatedDateTime": "2026-06-28T04:20:55.471Z"
}
}

Search Subscriptions

The API provides capability to get list of user's App Subscriptions using search criteria, including optional filtering, pagination and sorting

Authorizations:

BearerAuth

Request Body schema: application/json
required

object (AppSubscriptionFilters)

Array of AppSubscriptionSimpleExpression (object) or AppSubscriptionOrFilter (object) (AppSubscriptionFilter) <= 8 items

Array (<= 8 items)

Any of

property	string Possible field names to use on filters: `/project/projectId` - project id `/uuid` - App Subscription uuid `/state` - App Subscription status `/source/appLink/uuid` - Source App Link uuid `/source/ipSubnets` - Source App Link ip subnets `/target/appService/uuid` - Target App Service uuid `/target/geoScope` - Target App Service geo scope `/target/prioritization` - Target App Service prioritization `/changeLog/createdDateTime` - App Subscription creation timestamp `/changeLog/updatedDateTime` - App Subscription last updated timestamp `/changeLog/deletedDateTime` - App Subscription deletion timestamp
operator	string Possible operators to use on filters: `=` - equal `!=` - not equal `>` - greater than `<` - less than `IN` - in `NOT IN` - not in `LIKE` - like `ILIKE` - case-insensitive like `BETWEEN` - between `NOT BETWEEN` - not between
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (AppSubscriptionSortCriteria)

Array

direction	string (AppSubscriptionSortDirection) Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string <string> (AppSubscriptionSortBy) Default: "/changeLog/updatedDateTime" Possible field names to use on '400_InvalidSorting': `/uuid` - App Subscription uuid `/state` - App Subscription status `/changeLog/createdDateTime` - Date and time when change flow starts `/changeLog/updatedDateTime` - Date and time when change object is updated

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (AppSubscription)

Data returned from the API call.

Array

href	string <uri> Resource URI
type required	string (AppSubscriptionType) Default: "APP_SUBSCRIPTION" Value: "APP_SUBSCRIPTION" App Subscription Type
uuid	string <uuid> Equinix-assigned access point identifier
required	object (AppSubscriptionSource) Source details for the Subscription
required	object (AppSubscriptionTarget) Target details for the Subscription
state	string (AppSubscriptionState) Enum: "PROVISIONING" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "REPROVISIONING" App Subscription lifecycle state
required	object (Project)
	object (Changelog) Change log
	object (AppSubscriptionChange) Current state of latest AppSubscription change

Request samples

Payload

Content type

application/json

Example

SearchFilterByStatus

{"filter": {"and": [{"property": "/state",
"operator": "IN",
"values": ["PROVISIONED"
]
},
{"property": "/project/projectId",
"operator": "IN",
"values": ["71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
]
}
]
},
"pagination": {"offset": 0,
"limit": 20
},
"sort": [{"direction": "DESC",
"property": "/changeLog/createdDateTime"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 1,
"next": "/search?offset=1&limit=20",
"previous": "/search?offset=0&limit=20"
},
"data": [{"href": "https://api.equinix.com/fabric/v4/appSubscriptions/20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3",
"type": "APP_SUBSCRIPTION",
"source": {"appLink": {"uuid": "e32c9c7a-0149-4582-8345-192b82aef972"
},
"ipSubnets": ["192.168.100.0/24"
]
},
"target": {"appService": {"uuid": "e18c15f4-c8aa-4c18-9e35-a7e9b288201d"
},
"geoScope": "GLOBAL",
"prioritization": "LATENCY"
},
"state": "PROVISIONED",
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
}
}
]
}

Application Processors

Application Processors ^Beta

Get Processor

This API provides capability to retrieve user's App Processor

Authorizations:

BearerAuth

path Parameters

appProcessorId

required

string <uuid>

Example: 90ee425c-9988-454c-96d9-1128bc16350f

App Processor UUID

Responses

Response Schema: application/json

href

string <uri>

Resource URI

type

required

string (AppProcessorType)

Default: "APP_PROCESSOR"

Value: "APP_PROCESSOR"

App Processor Type

uuid

string <uuid>

Equinix-assigned access point identifier

name

required

string <string> [ 1 .. 50 ] characters

Customer-provided App Processor name

description

string <string> [ 1 .. 255 ] characters

Customer-provided App Processor description

state

string <string> (AppProcessorState)

Enum: "PROVISIONING" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "REPROVISIONING"

App Processor lifecycle state

registryId

required

string <string> [ 1 .. 255 ] characters

Container image reference for the processor runtime

required

object (AppProcessorMarketplace)

App Processor marketplace settings

visibility

required

string <string>

Default: "PUBLIC"

Enum: "PUBLIC" "PRIVATE"

App Processor marketplace visibility

required

object (Project)

projectId

required

string

Subscriber-assigned project ID

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

object (AppProcessorChange)

Current state of latest AppProcessor change

uuid

string

Uniquely identifies a change

type

required

string

Value: "APP_PROCESSOR_UPDATE"

Type of change

status

string

Enum: "COMPLETED" "FAILED" "REQUESTED"

Current outcome of the change flow

createdDateTime

string <date-time>

Set when change flow starts

updatedDateTime

required

string <date-time>

Set when change object is updated

Array of objects (AppProcessorChangeOperation)

Array

op required	string Enum: "replace" "add" "remove" operation type applied to the resource
path required	string Value: "/name" path inside document leading to updated parameter
value required	any new value for updated parameter

Response samples

200
401
403
404
500

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f",
"uuid": "90ee425c-9988-454c-96d9-1128bc16350f",
"type": "APP_PROCESSOR",
"name": "agent-gateway",
"description": "llm-routing, a2a-routing, mcp-routing",
"registryId": "agentgateway/agentgateway:1.3.0",
"marketplace": {"visibility": "PUBLIC"
},
"state": "PROVISIONED",
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
},
"changeLog": {"createdBy": "test",
"createdDateTime": "2026-09-08T04:20:55.471Z",
"updatedBy": "test",
"updatedDateTime": "2026-09-08T04:20:55.471Z"
}
}

Search Processors

The API provides capability to get list of user's App Processors using search criteria, including optional filtering, pagination and sorting

Authorizations:

BearerAuth

Request Body schema: application/json
required

object (AppProcessorFilters)

Array of AppProcessorSimpleExpression (object) or AppProcessorOrFilter (object) (AppProcessorFilter) <= 8 items

Array (<= 8 items)

Any of

property	string Possible field names to use on filters: `/project/projectId` - project id `/uuid` - App Processor uuid `/name` - App Processor name `/description` - App Processor description `/state` - App Processor status `/ipv4Subnet` - App Processor ipv4 subnet `/bandwidth` - App Processor bandwidth `/changeLog/createdDateTime` - App Processor creation timestamp `/changeLog/updatedDateTime` - App Processor last updated timestamp `/changeLog/deletedDateTime` - App Processor deletion timestamp
operator	string Possible operators to use on filters: `=` - equal `!=` - not equal `>` - greater than `<` - less than `IN` - in `NOT IN` - not in `LIKE` - like `ILIKE` - case-insensitive like `BETWEEN` - between `NOT BETWEEN` - not between
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (AppProcessorSortCriteria)

Array

direction	string (AppProcessorSortDirection) Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string <string> (AppProcessorSortBy) Default: "/changeLog/updatedDateTime" Possible field names to use on '400_InvalidSorting': `/name` - App Processor name `/uuid` - App Processor uuid `/state` - App Processor status `/changeLog/createdDateTime` - Date and time when change flow starts `/changeLog/updatedDateTime` - Date and time when change object is updated

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (AppProcessor)

Data returned from the API call.

Array

href	string <uri> Resource URI
type required	string (AppProcessorType) Default: "APP_PROCESSOR" Value: "APP_PROCESSOR" App Processor Type
uuid	string <uuid> Equinix-assigned access point identifier
name required	string <string> [ 1 .. 50 ] characters Customer-provided App Processor name
description	string <string> [ 1 .. 255 ] characters Customer-provided App Processor description
state	string <string> (AppProcessorState) Enum: "PROVISIONING" "PROVISIONING_FAILED" "PROVISIONED" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "REPROVISIONING" App Processor lifecycle state
registryId required	string <string> [ 1 .. 255 ] characters Container image reference for the processor runtime
required	object (AppProcessorMarketplace) App Processor marketplace settings
required	object (Project)
	object (Changelog) Change log
	object (AppProcessorChange) Current state of latest AppProcessor change

Request samples

Payload

Content type

application/json

Example

SearchFilterByStatus

{"filter": {"and": [{"property": "/state",
"operator": "=",
"values": ["PROVISIONED"
]
},
{"property": "/project/projectId",
"operator": "IN",
"values": ["71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
]
}
]
},
"pagination": {"offset": 0,
"limit": 20
},
"sort": [{"direction": "DESC",
"property": "/changeLog/createdDateTime"
}
]
}

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 1,
"next": "/search?offset=1&limit=20",
"previous": "/search?offset=0&limit=20"
},
"data": [{"href": "https://api.equinix.com/fabric/v4/appProcessors/90ee425c-9988-454c-96d9-1128bc16350f",
"uuid": "90ee425c-9988-454c-96d9-1128bc16350f",
"type": "APP_PROCESSOR",
"name": "agent-gateway",
"description": "llm-routing, a2a-routing, mcp-routing",
"registryId": "agentgateway/agentgateway:1.3.0",
"marketplace": {"visibility": "PUBLIC"
},
"state": "PROVISIONED",
"project": {"projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4"
}
}
]
}

Prices

Search Prices

Search prices by search criteria

Authorizations:

BearerAuth

Request Body schema: application/json
required

object (SearchExpression)

and	Array of objects (SearchExpressions)
or	Array of objects (SearchExpressions)
property	string
operator	string Enum: "=" "!=" ">" ">=" "<" "<=" "BETWEEN" "NOT BETWEEN" "LIKE" "NOT LIKE" "IN" "NOT IN" "IS NOT NULL" "IS NULL"
values	Array of strings

Responses

Response Schema: application/json

Array of objects (Price)

Array

href	string <url> An absolute URL that returns specified pricing data
type	string (ProductType) Enum: "VIRTUAL_CONNECTION_PRODUCT" "IP_BLOCK_PRODUCT" "VIRTUAL_PORT_PRODUCT" "CLOUD_ROUTER_PRODUCT" "PRECISION_TIME_PRODUCT" "OPTICAL_CONNECT_PRODUCT" Product type
code	string Equinix-assigned product code
name	string Full product name
description	string Product description
	object (SimplifiedAccount)
	Array of objects (PriceCharge)
currency	string Product offering price currency
termLength	integer Enum: 1 12 24 36 60 In months. No value or value of 1 means on-demand
catgory	string (PriceCategory) Enum: "COUNTRY" "CUSTOMER" Price category
	object (VirtualConnectionPrice) Virtual Connection Product configuration
	object (IpBlockPrice) IP Block Product configuration
	object (FabricCloudRouterPrice) Cloud Router Product configuration
	object (VirtualPortPrice) Preferences and settings for a virtual port connected to an internet service provider (ISP) or other Equinix platform entity.
	object (TimeServicePrice) Time Service Product configuration
	object Optical Metro Connect Port Product configuration

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Request samples

Payload

Content type

application/json

Example

virtualConnectionProductEvplVcTypeFromColoToColo

{"filter": {"and": [{"property": "/type",
"operator": "=",
"values": ["VIRTUAL_CONNECTION_PRODUCT"
]
},
{"property": "/connection/type",
"operator": "=",
"values": ["EVPL_VC"
]
},
{"property": "/connection/bandwidth",
"operator": "IN",
"values": ["100"
]
},
{"property": "/connection/aSide/accessPoint/type",
"operator": "=",
"values": ["COLO"
]
},
{"property": "/connection/aSide/accessPoint/location/metroCode",
"operator": "=",
"values": ["CH"
]
},
{"property": "/connection/aSide/accessPoint/port/settings/buyout",
"operator": "=",
"values": ["false"
]
},
{"property": "/connection/zSide/accessPoint/location/metroCode",
"operator": "=",
"values": ["CH"
]
},
{"property": "/connection/zSide/accessPoint/type",
"operator": "=",
"values": ["COLO"
]
}
]
}
}

Response samples

200
400
500

Content type

application/json

Example

virtualConnection

{"pagination": {"offset": 0,
"limit": 1,
"total": 1
},
"data": [{"type": "VIRTUAL_CONNECTION_PRODUCT",
"code": "ECX00015.PROD",
"name": "Equinix Fabric Virtual Connection Product",
"description": "Equinix Fabric Virtual Connection",
"account": {"accountNumber": 200001
},
"charges": [{"type": "MONTHLY_RECURRING",
"price": 500
}
],
"currency": "USD",
"connection": {"type": "EVPL_VC",
"bandwidth": 100,
"aSide": {"accessPoint": {"type": "COLO",
"location": {"metroCode": "CH"
},
"port": {"settings": {"buyout": false
}
}
}
},
"zSide": {"accessPoint": {"type": "SP",
"location": {"metroCode": "CH"
},
"profile": {"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f2"
}
}
}
}
}
]
}

Metros

Get Metros

GET All Subscriber Metros with an option query parameter to return all Equinix Fabric metros in which the customer has a presence, as well as latency data for each location

Authorizations:

BearerAuth

query Parameters

presence	string (Presence) Value: "MY_PORTS" User On Boarded Metros based on Fabric resource availability
offset	integer Example: offset=1 offset
limit	integer Example: limit=10 number of records to fetch

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (Metro)

List of Fabric Metros.

Array

href	string The Canonical URL at which the resource resides.
type	string Indicator of a Fabric Metro
code	string Code Assigned to an Equinix IBX data center in a specified metropolitan area.
region	string Board geographic area in which the data center is located
name	string Name of the region in which the data center is located.
country	string Country code in which the data center is located.
equinixAsn	integer <int64> Autonomous system number (ASN) for a specified Fabric metro. The ASN is a unique identifier that carries the network routing protocol and exchanges that data with other internal systems via border gateway protocol.
localVCBandwidthMax	integer <int64> This field holds Max Connection speed with in the metro
	object (GeoCoordinates) Geographic location data of Fabric Metro
	Array of objects (ConnectedMetro)
	Array of objects (services)
geoScopes	Array of strings (GeoScopeType) Items Enum: "CANADA" "CONUS" "JAPAN" "UK" "AUSTRALIA" "BRAZIL" "SWITZERLAND" "EU" List of supported geographic boundaries of a Fabric Metro.
	Array of objects (GeoZone) List of supported geographic zones of a Fabric Metro.

Response samples

200
400
401
500

Content type

application/json

{"pagination": {"offset": 0,
"limit": 75,
"total": 1
},
"data": [{"href": "https://api.equinix.com/v4/fabric/metros/AM",
"type": "XF_METRO",
"code": "AM",
"name": "Amsterdam",
"region": "EMEA",
"equinixAsn": 60000,
"localVCBandwidthMax": 10000,
"geoCoordinates": {"latitude": 52.30049,
"longitude": 4.942603
},
"connectedMetros": [{"href": "https://api.equinix.com/v4/fabric/metros/MX",
"code": "MX",
"avgLatency": 132,
"remoteVCBandwidthMax": 10000
},
{"href": "https://api.equinix.com/v4/fabric/metros/AM",
"code": "HH",
"avgLatency": 8.62,
"remoteVCBandwidthMax": 10000
},
{"href": "https://api.equinix.com/v4/fabric/metros/SL",
"code": "SL",
"avgLatency": 229,
"remoteVCBandwidthMax": 10000
},
{"href": "https://api.equinix.com/v4/fabric/metros/SO",
"code": "SO",
"avgLatency": 36.3,
"remoteVCBandwidthMax": 50000
},
{"href": "https://api.equinix.com/v4/fabric/metros/IL",
"code": "IL",
"avgLatency": 44.8,
"remoteVCBandwidthMax": 50000
},
{"href": "https://api.equinix.com/v4/fabric/metros/LS",
"code": "LS",
"avgLatency": 36.6,
"remoteVCBandwidthMax": 50000
},
{"href": "https://api.equinix.com/v4/fabric/metros/BA",
"code": "BA",
"avgLatency": 32.6,
"remoteVCBandwidthMax": 50000
},
{"href": "https://api.equinix.com/v4/fabric/metros/BL",
"code": "BL",
"avgLatency": 3.28,
"remoteVCBandwidthMax": 50000
},
{"href": "https://api.equinix.com/v4/fabric/metros/GV",
"code": "GV",
"avgLatency": 15.3,
"remoteVCBandwidthMax": 50000
},
{"href": "https://api.equinix.com/v4/fabric/metros/LD",
"code": "LD",
"avgLatency": 5.85,
"remoteVCBandwidthMax": 50000
}
],
"services": [{"type": "ETHERNET_IP_SERVICE"
},
{"type": "TIME_SERVICE"
}
],
"geoScopes": ["CANADA",
"CONUS",
"JAPAN",
"UK",
"AUSTRALIA",
"BRAZIL",
"SWITZERLAND",
"EU"
],
"geoZones": [{"code": "EU",
"name": "European Union",
"description": "Note that Ireland and Italy are not currently included"
}
]
}
]
}

Get Metro by Code

GET Metros retrieves all Equinix Fabric metros, as well as latency data between each metro location

Authorizations:

BearerAuth

path Parameters

metroCode

required

string

Metro Code

Responses

Response Schema: application/json

href

string

The Canonical URL at which the resource resides.

type

string

Indicator of a Fabric Metro

code

string

Code Assigned to an Equinix IBX data center in a specified metropolitan area.

region

string

Board geographic area in which the data center is located

name

string

Name of the region in which the data center is located.

country

string

Country code in which the data center is located.

equinixAsn

integer <int64>

Autonomous system number (ASN) for a specified Fabric metro. The ASN is a unique identifier that carries the network routing protocol and exchanges that data with other internal systems via border gateway protocol.

localVCBandwidthMax

integer <int64>

This field holds Max Connection speed with in the metro

object (GeoCoordinates)

Geographic location data of Fabric Metro

latitude	number <double> Latitude of a Fabric Metro
longitude	number <double> Longitude of a Fabric Metro

Array of objects (ConnectedMetro)

Array

href	string The Canonical URL at which the resource resides.
code	string Code assigned to an Equinix International Business Exchange (IBX) data center in a specified metropolitan area.
avgLatency	number Average latency (in milliseconds[ms]) between two specified metros.
remoteVCBandwidthMax	integer <int64> This field holds the Max Connection speed with connected metros

Array of objects (services)

Array

type	string Type of Service

geoScopes

Array of strings (GeoScopeType)

Items Enum: "CANADA" "CONUS" "JAPAN" "UK" "AUSTRALIA" "BRAZIL" "SWITZERLAND" "EU"

List of supported geographic boundaries of a Fabric Metro.

Array of objects (GeoZone)

List of supported geographic zones of a Fabric Metro.

Array

code	string Code assigned to a geographic zone.
name	string Name of a geographic zone.
description	string Description of a geographic zone.

Response samples

200
400
401
500

Content type

application/json

{"href": "https://api.equinix.com/v4/fabric/metros/AM",
"type": "XF_METRO",
"code": "AM",
"region": "EMEA",
"name": "Amsterdam",
"equinixAsn": 60000,
"localVCBandwidthMax": 50000,
"geoCoordinates": {"latitude": 52.30049,
"longitude": 4.942603
},
"connectedMetros": [{"href": "https://api.equinix.com/v4/fabric/metros/MX",
"code": "MX",
"avgLatency": 132,
"remoteVCBandwidthMax": 50000
},
{"href": "https://api.equinix.com/v4/fabric/metros/HH",
"code": "HH",
"avgLatency": 8.62,
"remoteVCBandwidthMax": 50000
},
{"href": "https://api.equinix.com/v4/fabric/metros/SL",
"code": "SL",
"avgLatency": 229,
"remoteVCBandwidthMax": 50000
},
{"href": "https://api.equinix.com/v4/fabric/metros/SO",
"code": "SO",
"avgLatency": 36.3,
"remoteVCBandwidthMax": 10000
},
{"href": "https://api.equinix.com/v4/fabric/metros/IL",
"code": "IL",
"avgLatency": 44.8,
"remoteVCBandwidthMax": 10000
},
{"href": "https://api.equinix.com/v4/fabric/metros/LS",
"code": "LS",
"avgLatency": 36.6,
"remoteVCBandwidthMax": 10000
},
{"href": "https://api.equinix.com/v4/fabric/metros/AM",
"code": "BA",
"avgLatency": 32.6,
"remoteVCBandwidthMax": 10000
},
{"href": "https://api.equinix.com/v4/fabric/metros/BL",
"code": "BL",
"avgLatency": 3.28,
"remoteVCBandwidthMax": 10000
},
{"href": "https://api.equinix.com/v4/fabric/metros/GV",
"code": "GV",
"avgLatency": 15.3,
"remoteVCBandwidthMax": 10000
},
{"href": "https://api.equinix.com/v4/fabric/metros/LD",
"code": "LD",
"avgLatency": 5.85,
"remoteVCBandwidthMax": 10000
}
],
"services": [{"type": "ETHERNET_IP_SERVICE"
},
{"type": "TIME_SERVICE"
}
],
"geoScopes": ["CANADA",
"CONUS",
"JAPAN",
"UK",
"AUSTRALIA",
"BRAZIL",
"SWITZERLAND",
"EU"
],
"geoZones": [{"code": "EU",
"name": "European Union",
"description": "Note that Ireland and Italy are not currently included"
}
]
}

Service Profiles

List Service Profiles

The API request returns all Equinix Fabric Service Profiles in accordance with the view point requested

Authorizations:

BearerAuth

query Parameters

offset	integer Example: offset=1 offset
limit	integer Example: limit=10 number of records to fetch
viewPoint	string Default: "aSide" Enum: "aSide" "zSide" flips view between buyer and seller representation

Responses

Response Schema: application/json; charset=UTF-8

Array of objects (ServiceProfile)

Array

state	string (ServiceProfileStateEnum) Enum: "ACTIVE" "PENDING_APPROVAL" "DELETED" "REJECTED" Equinix assigned state.
	object (SimplifiedAccount)
	object (Project)
	object (ServiceProfileChange) Current state of latest service profile change
	object (Changelog) Change log
href	string <uri> Service Profile URI response attribute
type	string (ServiceProfileTypeEnum) Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE" "IX_PROFILE" "IC_PROFILE" "LMAAS_PROFILE" Service profile type
name	string <= 50 characters Customer-assigned service profile name
uuid	string <uuid> Equinix-assigned service profile identifier
description	string User-provided service description should be of maximum length 375
	Array of objects (SimplifiedNotification) Recipients of notifications on service profile change
tags	Array of strings (Tags)
visibility	string (ServiceProfileVisibilityEnum) Enum: "PRIVATE" "PUBLIC"
allowedEmails	Array of strings <email> [ items <email > ]
	Array of ServiceProfileAccessPointTypeCOLO (object) or ServiceProfileAccessPointTypeVD (object) (ServiceProfileAccessPointType) non-empty
	Array of objects (CustomField)
	object (MarketingInfo)
	Array of objects (ServiceProfileAccessPointCOLO)
	Array of objects (ServiceProfileAccessPointVD)
	Array of objects (ServiceMetro) Derived response attribute.
	Array of objects (ProviderEnvironment) Provider environments associated with this IC_PROFILE service profile. ^Beta
selfProfile	boolean response attribute indicates whether the profile belongs to the same organization as the api-invoker.
projectId	string
	object (ServiceProfileLastMileConfig) Last-mile configuration for the service profile.

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Response samples

200
400
401
403
500

Content type

application/json; charset=UTF-8

Example

ASideServiceProfile

{"data": [{"state": "ACTIVE",
"account": {"organizationName": "testSeller-270010"
},
"changeLog": {"createdBy": "fusiontestseller",
"createdByFullName": "fusiontestSeller fusiontestSeller",
"createdByEmail": "fusiontestSeller@equinix.com",
"createdDateTime": "2022-04-12T19:06:57.940Z",
"updatedBy": "fusiontestseller",
"updatedByFullName": "fusiontestSeller fusiontestSeller",
"updatedByEmail": "fusiontestSeller@equinix.com",
"updatedDateTime": "2022-04-12T19:11:04.017Z"
},
"href": "https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f?viewPoint=aSide",
"type": "L2_PROFILE",
"name": "Service Profile 2",
"uuid": "ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
"description": "Sample_description",
"visibility": "PUBLIC",
"allowedEmails": ["test@equinix.com",
"testagain@equinix.com"
],
"accessPointTypeConfigs": [{"type": "COLO",
"uuid": "f20c49cd-b022-4aeb-b3e4-49db4389aff3",
"supportedBandwidths": [100,
500
],
"allowRemoteConnections": false,
"allowCustomBandwidth": true,
"allowBandwidthAutoApproval": false,
"linkProtocolConfig": {"encapsulationStrategy": "CTAGED",
"reuseVlanSTag": false,
"encapsulation": "DOT1Q"
},
"enableAutoGenerateServiceKey": false,
"connectionRedundancyRequired": false,
"selectiveRedundancy": false,
"apiConfig": {"apiAvailable": false,
"bandwidthFromApi": false
},
"connectionLabel": "true1",
"authenticationKey": {"required": false,
"label": "Service Key"
}
}
],
"marketingInfo": {"promotion": true
},
"metros": [{"code": "SY",
"name": "Sydney",
"ibxs": ["SY4"
],
"displayName": "Sydney"
}
],
"selfProfile": true
}
],
"pagination": {"offset": 0,
"limit": 1,
"total": 52,
"next": "/serviceProfiles?offset=1&limit=1"
}
}

Create Service Profile

Create Service Profile creates Equinix Fabric™ Service Profile

Authorizations:

BearerAuth

Request Body schema: application/json
required

object (Project)

projectId

required

string

Subscriber-assigned project ID

type

required

string (ServiceProfileTypeEnum)

Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE" "IX_PROFILE" "IC_PROFILE" "LMAAS_PROFILE"

Service profile type

name

required

string <= 50 characters

Customer-assigned service profile name

uuid

string <uuid>

Equinix-assigned service profile identifier

description

required

string

User-provided service description should be of maximum length 375

Array of objects (SimplifiedNotification)

Recipients of notifications on service profile change

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

tags

Array of strings (Tags)

visibility

string (ServiceProfileVisibilityEnum)

Enum: "PRIVATE" "PUBLIC"

allowedEmails

Array of strings <email> [ items <email > ]

Array of ServiceProfileAccessPointTypeCOLO (object) or ServiceProfileAccessPointTypeVD (object) (ServiceProfileAccessPointType) non-empty

Array (non-empty)

One of

uuid	string
type required	string (ServiceProfileAccessPointTypeEnum) Enum: "VD" "COLO" Access point type
supportedBandwidths	Array of integers (Bandwidths)
allowRemoteConnections	boolean Default: false Setting to allow or prohibit remote connections to the service profile.
allowCustomBandwidth	boolean Default: false Setting to enable or disable the ability of the buyer to customize the bandwidth.
bandwidthAlertThreshold	number percentage of port bandwidth at which an allocation alert is generated - missing on wiki.
allowBandwidthAutoApproval	boolean Default: false Setting to enable or disable the ability of the buyer to change connection bandwidth without approval of the seller.
allowBandwidthUpgrade	boolean Availability of a bandwidth upgrade. The default is false.
	object (ServiceProfileLinkProtocolConfig) Configuration for dot1q to qinq translation support
enableAutoGenerateServiceKey	boolean for verizon only.
connectionRedundancyRequired	boolean Default: false Mandate redundant connections
selectiveRedundancy	boolean Default: false Optional redundant connections
	object (ApiConfig) Configuration for API based Integration for Service Profile
connectionLabel	string custom name for "Connection"
	object (AuthenticationKey) Authentication Key Support and Customization
	object (ServiceProfileMetadata) Metadata. Response attribute. Ignored on request payload.

Array of objects (CustomField)

Array

label required	string
description	string
required required	boolean
dataType required	string Enum: "STRING" "LIST" "NUMBER"
options	Array of strings
captureInEmail	boolean capture this field as a part of email notification

object (MarketingInfo)

logo

string

Logo file name

promotion

boolean

Profile promotion on marketplace

Array of objects (ProcessStep) <= 3 items

Array (<= 3 items)

title	string Service profile custom step title
subTitle	string Service profile custom step sub title
description	string Service profile custom step description

Array of objects (ServiceProfileAccessPointCOLO)

Array

type required	string Enum: "XF_PORT" "IX_PORT"
uuid required	string <uuid>
	object (SimplifiedLocation)
sellerRegion	string
sellerRegionDescription	string
crossConnectId	string

Array of objects (ServiceProfileAccessPointVD)

Array

type required	string Value: "VD"
uuid required	string <uuid>
	object (SimplifiedLocation)
interfaceUuid	string <uuid>

Array of objects (ServiceMetro)

Derived response attribute.

Array

code	string metro code
name	string metro name
vcBandwidthMax	integer max VC speed supported in Mbps
ibxs	Array of strings
inTrail	boolean
displayName	string service metro display name
	object

Array of objects (ProviderEnvironment)

Provider environments associated with this IC_PROFILE service profile. ^Beta

Array

uuid	string <uuid> Equinix-assigned provider environment identifier
type	string (ProviderEnvironmentTypeEnum) Value: "IC_ENV" Provider environment type
name	string Provider environment name
description	string Provider environment description
sellerRegion	string Cloud provider region identifier
supportedBandwidths	Array of integers Supported bandwidths in Mbps
	Array of objects (ServiceMetro) Derived response attribute.
supportedFeatures	Array of strings Supported Feature Types
	object (Changelog) Change log

projectId

string

object (ServiceProfileLastMileConfig)

Last-mile configuration for the service profile.

object (ServiceProfileLastMileApiIntegration)

Last-mile API integration details.

siteValidationEnabled	boolean Whether site validation is enabled for the last-mile provider.
dataCenterLocationEnabled	boolean Whether data center location is enabled for the last-mile provider.
productOfferingEnabled	boolean Whether product offering is enabled for the last-mile provider.
poqEnabled	boolean Whether product qualification is enabled for the last-mile provider.
quoteEnabled	boolean Whether quote generation is enabled for the last-mile provider.
placeOrderEnabled	boolean Whether place order is enabled for the last-mile provider.
quoteViaAggregatorEnabled	boolean Whether quote via aggregator is enabled for the last-mile provider.

Array of objects (ServiceProfileLastMileProductCatalog)

Last-mile provider catalogs.

Array

name	string Last-mile provider or catalog name.
id	string Last-mile provider or catalog identifier.
webUrl	string Last-mile catalog or provider website URL.
	object (ServiceProfileLastMileDeliveryDateRange) Range details for delivery window.
billingTerms	Array of integers or null Enum: 1 12 24 36 48 60 Available billing terms in months.
	Array of objects (ServiceProfileLastMileOffering) Available last-mile offerings.

Responses

Response Headers
ETag	string response header - identifier for a specific version of a resource.

Response Schema: application/json; charset=UTF-8

state

string (ServiceProfileStateEnum)

Enum: "ACTIVE" "PENDING_APPROVAL" "DELETED" "REJECTED"

Equinix assigned state.

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

object (Project)

projectId

required

string

Subscriber-assigned project ID

object (ServiceProfileChange)

Current state of latest service profile change

uuid

string

Uniquely identifies a change

type

required

string

Type of change

status

string

Enum: "APPROVED" "COMPLETED" "FAILED" "REJECTED" "REQUESTED" "SUBMITTED_FOR_APPROVAL"

Current outcome of the change flow

createdDateTime

required

string <date-time>

Set when change flow starts

updatedDateTime

string <date-time>

Set when change object is updated

information

string

Additional information

Array of AddOperation (object) or RemoveOperation (object) or ReplaceOperation (object) (ServiceProfileUpdateRequest)

Array

One of

op required	string Value: "add"
path required	string (Path) A JSON Pointer path.
value required	object value to add

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

href

string <uri>

Service Profile URI response attribute

type

string (ServiceProfileTypeEnum)

Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE" "IX_PROFILE" "IC_PROFILE" "LMAAS_PROFILE"

Service profile type

name

string <= 50 characters

Customer-assigned service profile name

uuid

string <uuid>

Equinix-assigned service profile identifier

description

string

User-provided service description should be of maximum length 375

Array of objects (SimplifiedNotification)

Recipients of notifications on service profile change

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

tags

Array of strings (Tags)

visibility

string (ServiceProfileVisibilityEnum)

Enum: "PRIVATE" "PUBLIC"

allowedEmails

Array of strings <email> [ items <email > ]

Array of ServiceProfileAccessPointTypeCOLO (object) or ServiceProfileAccessPointTypeVD (object) (ServiceProfileAccessPointType) non-empty

Array (non-empty)

One of

uuid	string
type required	string (ServiceProfileAccessPointTypeEnum) Enum: "VD" "COLO" Access point type
supportedBandwidths	Array of integers (Bandwidths)
allowRemoteConnections	boolean Default: false Setting to allow or prohibit remote connections to the service profile.
allowCustomBandwidth	boolean Default: false Setting to enable or disable the ability of the buyer to customize the bandwidth.
bandwidthAlertThreshold	number percentage of port bandwidth at which an allocation alert is generated - missing on wiki.
allowBandwidthAutoApproval	boolean Default: false Setting to enable or disable the ability of the buyer to change connection bandwidth without approval of the seller.
allowBandwidthUpgrade	boolean Availability of a bandwidth upgrade. The default is false.
	object (ServiceProfileLinkProtocolConfig) Configuration for dot1q to qinq translation support
enableAutoGenerateServiceKey	boolean for verizon only.
connectionRedundancyRequired	boolean Default: false Mandate redundant connections
selectiveRedundancy	boolean Default: false Optional redundant connections
	object (ApiConfig) Configuration for API based Integration for Service Profile
connectionLabel	string custom name for "Connection"
	object (AuthenticationKey) Authentication Key Support and Customization
	object (ServiceProfileMetadata) Metadata. Response attribute. Ignored on request payload.

Array of objects (CustomField)

Array

label required	string
description	string
required required	boolean
dataType required	string Enum: "STRING" "LIST" "NUMBER"
options	Array of strings
captureInEmail	boolean capture this field as a part of email notification

object (MarketingInfo)

logo

string

Logo file name

promotion

boolean

Profile promotion on marketplace

Array of objects (ProcessStep) <= 3 items

Array (<= 3 items)

title	string Service profile custom step title
subTitle	string Service profile custom step sub title
description	string Service profile custom step description

Array of objects (ServiceProfileAccessPointCOLO)

Array

type required	string Enum: "XF_PORT" "IX_PORT"
uuid required	string <uuid>
	object (SimplifiedLocation)
sellerRegion	string
sellerRegionDescription	string
crossConnectId	string

Array of objects (ServiceProfileAccessPointVD)

Array

type required	string Value: "VD"
uuid required	string <uuid>
	object (SimplifiedLocation)
interfaceUuid	string <uuid>

Array of objects (ServiceMetro)

Derived response attribute.

Array

code	string metro code
name	string metro name
vcBandwidthMax	integer max VC speed supported in Mbps
ibxs	Array of strings
inTrail	boolean
displayName	string service metro display name
	object

Array of objects (ProviderEnvironment)

Provider environments associated with this IC_PROFILE service profile. ^Beta

Array

href	string <uri> Provider Environment URI
uuid	string <uuid> Equinix-assigned provider environment identifier
type	string (ProviderEnvironmentTypeEnum) Value: "IC_ENV" Provider environment type
name	string Provider environment name
description	string Provider environment description
sellerRegion	string Cloud provider region identifier
supportedBandwidths	Array of integers Supported bandwidths in Mbps
	Array of objects (ServiceMetro) Derived response attribute.
supportedFeatures	Array of strings Supported Feature Types
	object (Changelog) Change log

selfProfile

boolean

response attribute indicates whether the profile belongs to the same organization as the api-invoker.

projectId

string

object (ServiceProfileLastMileConfig)

Last-mile configuration for the service profile.

object (ServiceProfileLastMileApiIntegration)

Last-mile API integration details.

siteValidationEnabled	boolean Whether site validation is enabled for the last-mile provider.
dataCenterLocationEnabled	boolean Whether data center location is enabled for the last-mile provider.
productOfferingEnabled	boolean Whether product offering is enabled for the last-mile provider.
poqEnabled	boolean Whether product qualification is enabled for the last-mile provider.
quoteEnabled	boolean Whether quote generation is enabled for the last-mile provider.
placeOrderEnabled	boolean Whether place order is enabled for the last-mile provider.
quoteViaAggregatorEnabled	boolean Whether quote via aggregator is enabled for the last-mile provider.

Array of objects (ServiceProfileLastMileProductCatalog)

Last-mile provider catalogs.

Array

name	string Last-mile provider or catalog name.
id	string Last-mile provider or catalog identifier.
webUrl	string Last-mile catalog or provider website URL.
	object (ServiceProfileLastMileDeliveryDateRange) Range details for delivery window.
billingTerms	Array of integers or null Enum: 1 12 24 36 48 60 Available billing terms in months.
	Array of objects (ServiceProfileLastMileOffering) Available last-mile offerings.

Request samples

Payload

Content type

application/json

Example

ServiceProfileCreate

{"name": "Service Profile 1",
"description": "Sample_description",
"type": "L2_PROFILE",
"notifications": [{"emails": ["someone@sample.com"
],
"type": "BANDWIDTH_ALERT"
}
],
"visibility": "PUBLIC",
"allowedEmails": ["test@equinix.com",
"testagain@equinix.com"
],
"ports": [{"uuid": "c791f8cb-5cc9-cc90-8ce0-306a5c00a4ee",
"type": "XF_PORT",
"location": {"metroCode": "SY"
}
}
],
"marketingInfo": {"promotion": true
},
"accessPointTypeConfigs": [{"type": "COLO",
"connectionRedundancyRequired": false,
"selectiveRedundancy": false,
"allowBandwidthAutoApproval": false,
"allowRemoteConnections": true,
"connectionLabel": "Service Profile 1",
"enableAutoGenerateServiceKey": false,
"bandwidthAlertThreshold": 10,
"allowCustomBandwidth": true,
"apiConfig": {"apiAvailable": false,
"equinixManagedVlan": false,
"bandwidthFromApi": false,
"integrationId": null,
"equinixManagedPort": false
},
"authenticationKey": {"required": false,
"label": "Service Key",
"description": "XYZ"
},
"supportedBandwidths": [100,
500
]
}
]
}

Response samples

201
400
401
403
500

Content type

application/json; charset=UTF-8

Example

ServiceProfile

{"state": "PENDING_APPROVAL",
"account": {"orgId": 91785,
"globalOrgId": "0016u000003JZ4tAAG"
},
"changeLog": {"createdDateTime": "2022-04-12T19:06:57.940Z"
},
"href": "https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
"type": "L2_PROFILE",
"name": "Service Profile 1",
"uuid": "ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
"description": "Sample_description",
"notifications": [{"type": "BANDWIDTH_ALERT",
"emails": ["someone@sample.com"
]
},
{"type": "CONNECTION_APPROVAL",
"emails": ["someone@sample.com"
]
},
{"type": "PROFILE_LIFECYCLE",
"emails": ["someone@sample.com"
]
}
],
"visibility": "PUBLIC",
"allowedEmails": ["test@equinix.com",
"testagain@equinix.com"
],
"accessPointTypeConfigs": [{"type": "COLO",
"uuid": "f20c49cd-b022-4aeb-b3e4-49db4389aff3",
"supportedBandwidths": [100,
500
],
"allowRemoteConnections": false,
"allowCustomBandwidth": true,
"bandwidthAlertThreshold": 10,
"allowBandwidthAutoApproval": false,
"linkProtocolConfig": {"encapsulationStrategy": "CTAGED",
"reuseVlanSTag": false,
"encapsulation": "DOT1Q"
},
"enableAutoGenerateServiceKey": false,
"connectionRedundancyRequired": false,
"selectiveRedundancy": false,
"apiConfig": {"apiAvailable": false,
"equinixManagedPort": true,
"equinixManagedVlan": true,
"allowOverSubscription": false,
"overSubscriptionLimit": 1,
"bandwidthFromApi": false
},
"connectionLabel": "true1",
"authenticationKey": {"required": false,
"label": "Service Key"
}
}
],
"marketingInfo": {"promotion": true
},
"ports": [{"type": "XF_PORT",
"uuid": "c791f8cb-5cc9-cc90-8ce0-306a5c00a4ee",
"location": {"metroCode": "SY"
}
}
],
"metros": [{"code": "SY",
"ibxs": ["SY4"
]
}
]
}

Search Service Profiles

Search service profiles by search criteria

Authorizations:

BearerAuth

query Parameters

viewPoint

string

Default: "aSide"

Enum: "aSide" "zSide"

flips view between buyer and seller representation

Request Body schema: application/json
required

ServiceProfileSimpleExpression (object) or ServiceProfileAndFilter (object) (ServiceProfileFilter)

Any of

property	string Possible field names to use on filters: `/name` - Service Profile name `/uuid` - Service Profile uuid `/state` - Service Profile status `/metros/code` - Service Profile metro code `/visibility` - Service Profile package `/type` - Service Profile package `/project/projectId` - Service Profile project id
operator	string Possible operators to use on filters: `=` - equal
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (ServiceProfileSortCriteria)

Array

direction	string (ServiceProfileSortDirection) Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property	string (ServiceProfileSortBy) Default: "/changeLog/updatedDateTime" Enum: "/name" "/state" "/changeLog/createdDateTime" "/changeLog/updatedDateTime" Possible field names to use on sorting

Responses

Response Schema: application/json; charset=UTF-8

Array of objects (ServiceProfile)

Array

state	string (ServiceProfileStateEnum) Enum: "ACTIVE" "PENDING_APPROVAL" "DELETED" "REJECTED" Equinix assigned state.
	object (SimplifiedAccount)
	object (Project)
	object (ServiceProfileChange) Current state of latest service profile change
	object (Changelog) Change log
href	string <uri> Service Profile URI response attribute
type	string (ServiceProfileTypeEnum) Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE" "IX_PROFILE" "IC_PROFILE" "LMAAS_PROFILE" Service profile type
name	string <= 50 characters Customer-assigned service profile name
uuid	string <uuid> Equinix-assigned service profile identifier
description	string User-provided service description should be of maximum length 375
	Array of objects (SimplifiedNotification) Recipients of notifications on service profile change
tags	Array of strings (Tags)
visibility	string (ServiceProfileVisibilityEnum) Enum: "PRIVATE" "PUBLIC"
allowedEmails	Array of strings <email> [ items <email > ]
	Array of ServiceProfileAccessPointTypeCOLO (object) or ServiceProfileAccessPointTypeVD (object) (ServiceProfileAccessPointType) non-empty
	Array of objects (CustomField)
	object (MarketingInfo)
	Array of objects (ServiceProfileAccessPointCOLO)
	Array of objects (ServiceProfileAccessPointVD)
	Array of objects (ServiceMetro) Derived response attribute.
	Array of objects (ProviderEnvironment) Provider environments associated with this IC_PROFILE service profile. ^Beta
selfProfile	boolean response attribute indicates whether the profile belongs to the same organization as the api-invoker.
projectId	string
	object (ServiceProfileLastMileConfig) Last-mile configuration for the service profile.

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Request samples

Payload

Content type

application/json

Example

ServiceProfileSearchWithUuid

{"filter": {"property": "/uuid",
"operator": "=",
"values": ["13100b2d-234f-4425-ab5c-1449d4b806be"
]
},
"pagination": {"offset": 0,
"limit": 20
},
"sort": [{"direction": "DESC",
"property": "/changeLog/updatedDateTime"
}
]
}

Response samples

200
400
401
500

Content type

application/json; charset=UTF-8

{"data": [{"state": "ACTIVE",
"account": {"organizationName": "testSeller-270010"
},
"changeLog": {"createdBy": "fusiontestseller",
"createdByFullName": "fusiontestSeller fusiontestSeller",
"createdByEmail": "fusiontestSeller@equinix.com",
"createdDateTime": "2022-04-12T19:06:57.940Z",
"updatedBy": "fusiontestseller",
"updatedByFullName": "fusiontestSeller fusiontestSeller",
"updatedByEmail": "fusiontestSeller@equinix.com",
"updatedDateTime": "2022-04-12T19:11:04.017Z"
},
"href": "https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f?viewPoint=aSide",
"type": "L2_PROFILE",
"name": "Service Profile 2",
"uuid": "ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
"description": "Sample_description",
"visibility": "PUBLIC",
"allowedEmails": ["test@equinix.com",
"testagain@equinix.com"
],
"accessPointTypeConfigs": [{"type": "COLO",
"uuid": "f20c49cd-b022-4aeb-b3e4-49db4389aff3",
"supportedBandwidths": [100,
500
],
"allowRemoteConnections": false,
"allowCustomBandwidth": true,
"allowBandwidthAutoApproval": false,
"linkProtocolConfig": {"encapsulationStrategy": "CTAGED",
"reuseVlanSTag": false,
"encapsulation": "DOT1Q"
},
"enableAutoGenerateServiceKey": false,
"connectionRedundancyRequired": false,
"selectiveRedundancy": false,
"apiConfig": {"apiAvailable": false,
"bandwidthFromApi": false
},
"connectionLabel": "true1",
"authenticationKey": {"required": false,
"label": "Service Key"
}
}
],
"marketingInfo": {"promotion": true
},
"metros": [{"code": "SY",
"name": "Sydney",
"ibxs": ["SY4"
],
"displayName": "Sydney"
}
],
"selfProfile": true
}
],
"pagination": {"offset": 0,
"limit": 1,
"total": 52,
"next": "/serviceProfiles?offset=1&limit=1"
}
}

Get Service Profile

Get service profile by UUID. View Point parameter if set to zSide will give seller's view of the profile otherwise buyer's view

Authorizations:

BearerAuth

path Parameters

serviceProfileId

required

string <uuid>

Service Profile UUID

query Parameters

viewPoint

string

Default: "aSide"

Enum: "aSide" "zSide"

flips view between buyer and seller representation

Responses

Response Headers
ETag	string response header - identifier for a specific version of a resource.

Response Schema: application/json; charset=UTF-8

state

string (ServiceProfileStateEnum)

Enum: "ACTIVE" "PENDING_APPROVAL" "DELETED" "REJECTED"

Equinix assigned state.

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

object (Project)

projectId

required

string

Subscriber-assigned project ID

object (ServiceProfileChange)

Current state of latest service profile change

uuid

string

Uniquely identifies a change

type

required

string

Type of change

status

string

Enum: "APPROVED" "COMPLETED" "FAILED" "REJECTED" "REQUESTED" "SUBMITTED_FOR_APPROVAL"

Current outcome of the change flow

createdDateTime

required

string <date-time>

Set when change flow starts

updatedDateTime

string <date-time>

Set when change object is updated

information

string

Additional information

Array of AddOperation (object) or RemoveOperation (object) or ReplaceOperation (object) (ServiceProfileUpdateRequest)

Array

One of

op required	string Value: "add"
path required	string (Path) A JSON Pointer path.
value required	object value to add

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

href

string <uri>

Service Profile URI response attribute

type

string (ServiceProfileTypeEnum)

Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE" "IX_PROFILE" "IC_PROFILE" "LMAAS_PROFILE"

Service profile type

name

string <= 50 characters

Customer-assigned service profile name

uuid

string <uuid>

Equinix-assigned service profile identifier

description

string

User-provided service description should be of maximum length 375

Array of objects (SimplifiedNotification)

Recipients of notifications on service profile change

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

tags

Array of strings (Tags)

visibility

string (ServiceProfileVisibilityEnum)

Enum: "PRIVATE" "PUBLIC"

allowedEmails

Array of strings <email> [ items <email > ]

Array of ServiceProfileAccessPointTypeCOLO (object) or ServiceProfileAccessPointTypeVD (object) (ServiceProfileAccessPointType) non-empty

Array (non-empty)

One of

uuid	string
type required	string (ServiceProfileAccessPointTypeEnum) Enum: "VD" "COLO" Access point type
supportedBandwidths	Array of integers (Bandwidths)
allowRemoteConnections	boolean Default: false Setting to allow or prohibit remote connections to the service profile.
allowCustomBandwidth	boolean Default: false Setting to enable or disable the ability of the buyer to customize the bandwidth.
bandwidthAlertThreshold	number percentage of port bandwidth at which an allocation alert is generated - missing on wiki.
allowBandwidthAutoApproval	boolean Default: false Setting to enable or disable the ability of the buyer to change connection bandwidth without approval of the seller.
allowBandwidthUpgrade	boolean Availability of a bandwidth upgrade. The default is false.
	object (ServiceProfileLinkProtocolConfig) Configuration for dot1q to qinq translation support
enableAutoGenerateServiceKey	boolean for verizon only.
connectionRedundancyRequired	boolean Default: false Mandate redundant connections
selectiveRedundancy	boolean Default: false Optional redundant connections
	object (ApiConfig) Configuration for API based Integration for Service Profile
connectionLabel	string custom name for "Connection"
	object (AuthenticationKey) Authentication Key Support and Customization
	object (ServiceProfileMetadata) Metadata. Response attribute. Ignored on request payload.

Array of objects (CustomField)

Array

label required	string
description	string
required required	boolean
dataType required	string Enum: "STRING" "LIST" "NUMBER"
options	Array of strings
captureInEmail	boolean capture this field as a part of email notification

object (MarketingInfo)

logo

string

Logo file name

promotion

boolean

Profile promotion on marketplace

Array of objects (ProcessStep) <= 3 items

Array (<= 3 items)

title	string Service profile custom step title
subTitle	string Service profile custom step sub title
description	string Service profile custom step description

Array of objects (ServiceProfileAccessPointCOLO)

Array

type required	string Enum: "XF_PORT" "IX_PORT"
uuid required	string <uuid>
	object (SimplifiedLocation)
sellerRegion	string
sellerRegionDescription	string
crossConnectId	string

Array of objects (ServiceProfileAccessPointVD)

Array

type required	string Value: "VD"
uuid required	string <uuid>
	object (SimplifiedLocation)
interfaceUuid	string <uuid>

Array of objects (ServiceMetro)

Derived response attribute.

Array

code	string metro code
name	string metro name
vcBandwidthMax	integer max VC speed supported in Mbps
ibxs	Array of strings
inTrail	boolean
displayName	string service metro display name
	object

Array of objects (ProviderEnvironment)

Provider environments associated with this IC_PROFILE service profile. ^Beta

Array

href	string <uri> Provider Environment URI
uuid	string <uuid> Equinix-assigned provider environment identifier
type	string (ProviderEnvironmentTypeEnum) Value: "IC_ENV" Provider environment type
name	string Provider environment name
description	string Provider environment description
sellerRegion	string Cloud provider region identifier
supportedBandwidths	Array of integers Supported bandwidths in Mbps
	Array of objects (ServiceMetro) Derived response attribute.
supportedFeatures	Array of strings Supported Feature Types
	object (Changelog) Change log

selfProfile

boolean

response attribute indicates whether the profile belongs to the same organization as the api-invoker.

projectId

string

object (ServiceProfileLastMileConfig)

Last-mile configuration for the service profile.

object (ServiceProfileLastMileApiIntegration)

Last-mile API integration details.

siteValidationEnabled	boolean Whether site validation is enabled for the last-mile provider.
dataCenterLocationEnabled	boolean Whether data center location is enabled for the last-mile provider.
productOfferingEnabled	boolean Whether product offering is enabled for the last-mile provider.
poqEnabled	boolean Whether product qualification is enabled for the last-mile provider.
quoteEnabled	boolean Whether quote generation is enabled for the last-mile provider.
placeOrderEnabled	boolean Whether place order is enabled for the last-mile provider.
quoteViaAggregatorEnabled	boolean Whether quote via aggregator is enabled for the last-mile provider.

Array of objects (ServiceProfileLastMileProductCatalog)

Last-mile provider catalogs.

Array

name	string Last-mile provider or catalog name.
id	string Last-mile provider or catalog identifier.
webUrl	string Last-mile catalog or provider website URL.
	object (ServiceProfileLastMileDeliveryDateRange) Range details for delivery window.
billingTerms	Array of integers or null Enum: 1 12 24 36 48 60 Available billing terms in months.
	Array of objects (ServiceProfileLastMileOffering) Available last-mile offerings.

Response samples

200
400
401
403
500

Content type

application/json; charset=UTF-8

Example

ASideServiceProfile

{"state": "ACTIVE",
"account": {"organizationName": "testSeller-270010"
},
"changeLog": {"createdBy": "fusiontestseller",
"createdByFullName": "fusiontestSeller fusiontestSeller",
"createdByEmail": "fusiontestSeller@equinix.com",
"createdDateTime": "2022-04-12T19:06:57.940Z",
"updatedBy": "fusiontestseller",
"updatedByFullName": "fusiontestSeller fusiontestSeller",
"updatedByEmail": "fusiontestSeller@equinix.com",
"updatedDateTime": "2022-04-12T19:11:04.017Z"
},
"href": "https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f?viewPoint=aSide",
"type": "L2_PROFILE",
"name": "Service Profile 2",
"uuid": "ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
"description": "Sample_description",
"visibility": "PUBLIC",
"allowedEmails": ["test@equinix.com",
"testagain@equinix.com"
],
"accessPointTypeConfigs": [{"type": "COLO",
"uuid": "f20c49cd-b022-4aeb-b3e4-49db4389aff3",
"supportedBandwidths": [100,
500
],
"allowRemoteConnections": false,
"allowCustomBandwidth": true,
"allowBandwidthAutoApproval": false,
"linkProtocolConfig": {"encapsulationStrategy": "CTAGED",
"reuseVlanSTag": false,
"encapsulation": "DOT1Q"
},
"enableAutoGenerateServiceKey": false,
"connectionRedundancyRequired": false,
"selectiveRedundancy": false,
"apiConfig": {"apiAvailable": false,
"bandwidthFromApi": false
},
"connectionLabel": "true1",
"authenticationKey": {"required": false,
"label": "Service Key"
}
}
],
"marketingInfo": {"promotion": true
},
"metros": [{"code": "SY",
"name": "Sydney",
"ibxs": ["SY4"
],
"displayName": "Sydney"
}
],
"selfProfile": true
}

Replace Service Profile

This API request replaces a service profile definition

Authorizations:

BearerAuth

path Parameters

serviceProfileId

required

string <uuid>

Service Profile UUID

header Parameters

If-Match

required

string

conditional request

Request Body schema: application/json
required

object (Project)

projectId

required

string

Subscriber-assigned project ID

type

required

string (ServiceProfileTypeEnum)

Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE" "IX_PROFILE" "IC_PROFILE" "LMAAS_PROFILE"

Service profile type

name

required

string <= 50 characters

Customer-assigned service profile name

uuid

string <uuid>

Equinix-assigned service profile identifier

description

required

string

User-provided service description should be of maximum length 375

Array of objects (SimplifiedNotification)

Recipients of notifications on service profile change

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

tags

Array of strings (Tags)

visibility

string (ServiceProfileVisibilityEnum)

Enum: "PRIVATE" "PUBLIC"

allowedEmails

Array of strings <email> [ items <email > ]

Array of ServiceProfileAccessPointTypeCOLO (object) or ServiceProfileAccessPointTypeVD (object) (ServiceProfileAccessPointType) non-empty

Array (non-empty)

One of

uuid	string
type required	string (ServiceProfileAccessPointTypeEnum) Enum: "VD" "COLO" Access point type
supportedBandwidths	Array of integers (Bandwidths)
allowRemoteConnections	boolean Default: false Setting to allow or prohibit remote connections to the service profile.
allowCustomBandwidth	boolean Default: false Setting to enable or disable the ability of the buyer to customize the bandwidth.
bandwidthAlertThreshold	number percentage of port bandwidth at which an allocation alert is generated - missing on wiki.
allowBandwidthAutoApproval	boolean Default: false Setting to enable or disable the ability of the buyer to change connection bandwidth without approval of the seller.
allowBandwidthUpgrade	boolean Availability of a bandwidth upgrade. The default is false.
	object (ServiceProfileLinkProtocolConfig) Configuration for dot1q to qinq translation support
enableAutoGenerateServiceKey	boolean for verizon only.
connectionRedundancyRequired	boolean Default: false Mandate redundant connections
selectiveRedundancy	boolean Default: false Optional redundant connections
	object (ApiConfig) Configuration for API based Integration for Service Profile
connectionLabel	string custom name for "Connection"
	object (AuthenticationKey) Authentication Key Support and Customization
	object (ServiceProfileMetadata) Metadata. Response attribute. Ignored on request payload.

Array of objects (CustomField)

Array

label required	string
description	string
required required	boolean
dataType required	string Enum: "STRING" "LIST" "NUMBER"
options	Array of strings
captureInEmail	boolean capture this field as a part of email notification

object (MarketingInfo)

logo

string

Logo file name

promotion

boolean

Profile promotion on marketplace

Array of objects (ProcessStep) <= 3 items

Array (<= 3 items)

title	string Service profile custom step title
subTitle	string Service profile custom step sub title
description	string Service profile custom step description

Array of objects (ServiceProfileAccessPointCOLO)

Array

type required	string Enum: "XF_PORT" "IX_PORT"
uuid required	string <uuid>
	object (SimplifiedLocation)
sellerRegion	string
sellerRegionDescription	string
crossConnectId	string

Array of objects (ServiceProfileAccessPointVD)

Array

type required	string Value: "VD"
uuid required	string <uuid>
	object (SimplifiedLocation)
interfaceUuid	string <uuid>

Array of objects (ServiceMetro)

Derived response attribute.

Array

code	string metro code
name	string metro name
vcBandwidthMax	integer max VC speed supported in Mbps
ibxs	Array of strings
inTrail	boolean
displayName	string service metro display name
	object

Array of objects (ProviderEnvironment)

Provider environments associated with this IC_PROFILE service profile. ^Beta

Array

uuid	string <uuid> Equinix-assigned provider environment identifier
type	string (ProviderEnvironmentTypeEnum) Value: "IC_ENV" Provider environment type
name	string Provider environment name
description	string Provider environment description
sellerRegion	string Cloud provider region identifier
supportedBandwidths	Array of integers Supported bandwidths in Mbps
	Array of objects (ServiceMetro) Derived response attribute.
supportedFeatures	Array of strings Supported Feature Types
	object (Changelog) Change log

projectId

string

object (ServiceProfileLastMileConfig)

Last-mile configuration for the service profile.

object (ServiceProfileLastMileApiIntegration)

Last-mile API integration details.

siteValidationEnabled	boolean Whether site validation is enabled for the last-mile provider.
dataCenterLocationEnabled	boolean Whether data center location is enabled for the last-mile provider.
productOfferingEnabled	boolean Whether product offering is enabled for the last-mile provider.
poqEnabled	boolean Whether product qualification is enabled for the last-mile provider.
quoteEnabled	boolean Whether quote generation is enabled for the last-mile provider.
placeOrderEnabled	boolean Whether place order is enabled for the last-mile provider.
quoteViaAggregatorEnabled	boolean Whether quote via aggregator is enabled for the last-mile provider.

Array of objects (ServiceProfileLastMileProductCatalog)

Last-mile provider catalogs.

Array

name	string Last-mile provider or catalog name.
id	string Last-mile provider or catalog identifier.
webUrl	string Last-mile catalog or provider website URL.
	object (ServiceProfileLastMileDeliveryDateRange) Range details for delivery window.
billingTerms	Array of integers or null Enum: 1 12 24 36 48 60 Available billing terms in months.
	Array of objects (ServiceProfileLastMileOffering) Available last-mile offerings.

Responses

Request samples

Payload

Content type

application/json

{"name": "Service Profile 2",
"description": "Sample_description",
"type": "L2_PROFILE",
"notifications": [{"emails": ["someone@sample.com"
],
"type": "BANDWIDTH_ALERT"
}
],
"visibility": "PUBLIC",
"allowedEmails": ["test@equinix.com",
"testagain@equinix.com"
],
"ports": [{"uuid": "c791f8cb-5cc9-cc90-8ce0-306a5c00a4ee",
"type": "XF_PORT",
"location": {"metroCode": "SY"
}
}
],
"marketingInfo": {"promotion": true
},
"accessPointTypeConfigs": [{"type": "COLO",
"connectionRedundancyRequired": false,
"selectiveRedundancy": false,
"allowBandwidthAutoApproval": false,
"allowRemoteConnections": false,
"connectionLabel": "true1",
"enableAutoGenerateServiceKey": false,
"bandwidthAlertThreshold": 10,
"allowCustomBandwidth": true,
"apiConfig": {"apiAvailable": false,
"equinixManagedVlan": true,
"bandwidthFromApi": false,
"integrationId": null,
"equinixManagedPort": true
},
"authenticationKey": {"required": false,
"label": "Service Key",
"description": "XYZ"
},
"supportedBandwidths": [100,
500
]
}
]
}

Response samples

Content type

application/json; charset=UTF-8

{"state": "ACTIVE",
"account": {"orgId": 91785,
"organizationName": "testSeller-270010",
"globalOrgId": "0016u000003JZ4tAAG"
},
"changeLog": {"createdBy": "fusiontestseller",
"createdByFullName": "fusiontestSeller fusiontestSeller",
"createdByEmail": "fusiontestSeller@equinix.com",
"createdDateTime": "2022-04-12T19:06:57.940Z",
"updatedDateTime": "2022-04-12T19:11:04.017Z"
},
"href": "https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
"type": "L2_PROFILE",
"name": "Service Profile 2",
"uuid": "ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
"description": "Sample_description",
"notifications": [{"type": "BANDWIDTH_ALERT",
"emails": ["someone@sample.com"
]
},
{"type": "CONNECTION_APPROVAL",
"emails": ["someone@sample.com"
]
},
{"type": "PROFILE_LIFECYCLE",
"emails": ["someone@sample.com"
]
}
],
"visibility": "PUBLIC",
"allowedEmails": ["test@equinix.com",
"testagain@equinix.com"
],
"accessPointTypeConfigs": [{"type": "COLO",
"uuid": "f20c49cd-b022-4aeb-b3e4-49db4389aff3",
"supportedBandwidths": [100,
500
],
"allowRemoteConnections": false,
"allowCustomBandwidth": true,
"bandwidthAlertThreshold": 10,
"allowBandwidthAutoApproval": false,
"linkProtocolConfig": {"encapsulationStrategy": "CTAGED",
"reuseVlanSTag": false,
"encapsulation": "DOT1Q"
},
"enableAutoGenerateServiceKey": false,
"connectionRedundancyRequired": false,
"selectiveRedundancy": false,
"apiConfig": {"apiAvailable": false,
"equinixManagedPort": true,
"equinixManagedVlan": true,
"allowOverSubscription": false,
"overSubscriptionLimit": 1,
"bandwidthFromApi": false
},
"connectionLabel": "true1",
"authenticationKey": {"required": false,
"label": "Service Key"
}
}
],
"marketingInfo": {"promotion": true
},
"ports": [{"type": "XF_PORT",
"uuid": "c791f8cb-5cc9-cc90-8ce0-306a5c00a4ee",
"location": {"metroCode": "SY"
}
}
],
"metros": [{"code": "SY",
"name": "Sydney",
"ibxs": ["SY4"
],
"displayName": "Sydney"
}
]
}

Update Service Profile

Update Service Profile by UUID

Authorizations:

BearerAuth

path Parameters

serviceProfileId

required

string <uuid>

Service Profile UUID

Request Body schema: application/json-patch+json
required

Array

One of

op required	string Value: "add"
path required	string (Path) A JSON Pointer path.
value required	object value to add

Responses

Response Headers
ETag	string response header - identifier for a specific version of a resource.

Response Schema: application/json; charset=UTF-8

state

string (ServiceProfileStateEnum)

Enum: "ACTIVE" "PENDING_APPROVAL" "DELETED" "REJECTED"

Equinix assigned state.

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

object (Project)

projectId

required

string

Subscriber-assigned project ID

object (ServiceProfileChange)

Current state of latest service profile change

uuid

string

Uniquely identifies a change

type

required

string

Type of change

status

string

Enum: "APPROVED" "COMPLETED" "FAILED" "REJECTED" "REQUESTED" "SUBMITTED_FOR_APPROVAL"

Current outcome of the change flow

createdDateTime

required

string <date-time>

Set when change flow starts

updatedDateTime

string <date-time>

Set when change object is updated

information

string

Additional information

Array of AddOperation (object) or RemoveOperation (object) or ReplaceOperation (object) (ServiceProfileUpdateRequest)

Array

One of

op required	string Value: "add"
path required	string (Path) A JSON Pointer path.
value required	object value to add

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

href

string <uri>

Service Profile URI response attribute

type

string (ServiceProfileTypeEnum)

Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE" "IX_PROFILE" "IC_PROFILE" "LMAAS_PROFILE"

Service profile type

name

string <= 50 characters

Customer-assigned service profile name

uuid

string <uuid>

Equinix-assigned service profile identifier

description

string

User-provided service description should be of maximum length 375

Array of objects (SimplifiedNotification)

Recipients of notifications on service profile change

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

tags

Array of strings (Tags)

visibility

string (ServiceProfileVisibilityEnum)

Enum: "PRIVATE" "PUBLIC"

allowedEmails

Array of strings <email> [ items <email > ]

Array of ServiceProfileAccessPointTypeCOLO (object) or ServiceProfileAccessPointTypeVD (object) (ServiceProfileAccessPointType) non-empty

Array (non-empty)

One of

uuid	string
type required	string (ServiceProfileAccessPointTypeEnum) Enum: "VD" "COLO" Access point type
supportedBandwidths	Array of integers (Bandwidths)
allowRemoteConnections	boolean Default: false Setting to allow or prohibit remote connections to the service profile.
allowCustomBandwidth	boolean Default: false Setting to enable or disable the ability of the buyer to customize the bandwidth.
bandwidthAlertThreshold	number percentage of port bandwidth at which an allocation alert is generated - missing on wiki.
allowBandwidthAutoApproval	boolean Default: false Setting to enable or disable the ability of the buyer to change connection bandwidth without approval of the seller.
allowBandwidthUpgrade	boolean Availability of a bandwidth upgrade. The default is false.
	object (ServiceProfileLinkProtocolConfig) Configuration for dot1q to qinq translation support
enableAutoGenerateServiceKey	boolean for verizon only.
connectionRedundancyRequired	boolean Default: false Mandate redundant connections
selectiveRedundancy	boolean Default: false Optional redundant connections
	object (ApiConfig) Configuration for API based Integration for Service Profile
connectionLabel	string custom name for "Connection"
	object (AuthenticationKey) Authentication Key Support and Customization
	object (ServiceProfileMetadata) Metadata. Response attribute. Ignored on request payload.

Array of objects (CustomField)

Array

label required	string
description	string
required required	boolean
dataType required	string Enum: "STRING" "LIST" "NUMBER"
options	Array of strings
captureInEmail	boolean capture this field as a part of email notification

object (MarketingInfo)

logo

string

Logo file name

promotion

boolean

Profile promotion on marketplace

Array of objects (ProcessStep) <= 3 items

Array (<= 3 items)

title	string Service profile custom step title
subTitle	string Service profile custom step sub title
description	string Service profile custom step description

Array of objects (ServiceProfileAccessPointCOLO)

Array

type required	string Enum: "XF_PORT" "IX_PORT"
uuid required	string <uuid>
	object (SimplifiedLocation)
sellerRegion	string
sellerRegionDescription	string
crossConnectId	string

Array of objects (ServiceProfileAccessPointVD)

Array

type required	string Value: "VD"
uuid required	string <uuid>
	object (SimplifiedLocation)
interfaceUuid	string <uuid>

Array of objects (ServiceMetro)

Derived response attribute.

Array

code	string metro code
name	string metro name
vcBandwidthMax	integer max VC speed supported in Mbps
ibxs	Array of strings
inTrail	boolean
displayName	string service metro display name
	object

Array of objects (ProviderEnvironment)

Provider environments associated with this IC_PROFILE service profile. ^Beta

Array

href	string <uri> Provider Environment URI
uuid	string <uuid> Equinix-assigned provider environment identifier
type	string (ProviderEnvironmentTypeEnum) Value: "IC_ENV" Provider environment type
name	string Provider environment name
description	string Provider environment description
sellerRegion	string Cloud provider region identifier
supportedBandwidths	Array of integers Supported bandwidths in Mbps
	Array of objects (ServiceMetro) Derived response attribute.
supportedFeatures	Array of strings Supported Feature Types
	object (Changelog) Change log

selfProfile

boolean

response attribute indicates whether the profile belongs to the same organization as the api-invoker.

projectId

string

object (ServiceProfileLastMileConfig)

Last-mile configuration for the service profile.

object (ServiceProfileLastMileApiIntegration)

Last-mile API integration details.

siteValidationEnabled	boolean Whether site validation is enabled for the last-mile provider.
dataCenterLocationEnabled	boolean Whether data center location is enabled for the last-mile provider.
productOfferingEnabled	boolean Whether product offering is enabled for the last-mile provider.
poqEnabled	boolean Whether product qualification is enabled for the last-mile provider.
quoteEnabled	boolean Whether quote generation is enabled for the last-mile provider.
placeOrderEnabled	boolean Whether place order is enabled for the last-mile provider.
quoteViaAggregatorEnabled	boolean Whether quote via aggregator is enabled for the last-mile provider.

Array of objects (ServiceProfileLastMileProductCatalog)

Last-mile provider catalogs.

Array

name	string Last-mile provider or catalog name.
id	string Last-mile provider or catalog identifier.
webUrl	string Last-mile catalog or provider website URL.
	object (ServiceProfileLastMileDeliveryDateRange) Range details for delivery window.
billingTerms	Array of integers or null Enum: 1 12 24 36 48 60 Available billing terms in months.
	Array of objects (ServiceProfileLastMileOffering) Available last-mile offerings.

Request samples

Payload

Content type

application/json-patch+json

Example

ServiceProfilePatchRequest

[{"op": "add",
"path": "/tags",
"value": ["sample_tag"
]
}
]

Response samples

Content type

application/json; charset=UTF-8

Example

ServiceProfile

{"state": "ACTIVE",
"account": {"orgId": 91785,
"organizationName": "testSeller-270010",
"globalOrgId": "0016u000003JZ4tAAG"
},
"changeLog": {"createdBy": "fusiontestseller",
"createdByFullName": "fusiontestSeller fusiontestSeller",
"createdByEmail": "fusiontestSeller@equinix.com",
"createdDateTime": "2022-04-12T19:06:57.940Z",
"updatedDateTime": "2022-04-12T19:11:04.017Z"
},
"href": "https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
"type": "L2_PROFILE",
"name": "Service Profile 2",
"uuid": "ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
"description": "Sample_description",
"notifications": [{"type": "BANDWIDTH_ALERT",
"emails": ["someone@sample.com"
]
},
{"type": "CONNECTION_APPROVAL",
"emails": ["someone@sample.com"
]
},
{"type": "PROFILE_LIFECYCLE",
"emails": ["someone@sample.com"
]
}
],
"visibility": "PUBLIC",
"tags": ["sample_tag"
],
"allowedEmails": ["test@equinix.com",
"testagain@equinix.com"
],
"accessPointTypeConfigs": [{"type": "COLO",
"uuid": "f20c49cd-b022-4aeb-b3e4-49db4389aff3",
"supportedBandwidths": [100,
500
],
"allowRemoteConnections": false,
"allowCustomBandwidth": true,
"bandwidthAlertThreshold": 10,
"allowBandwidthAutoApproval": false,
"linkProtocolConfig": {"encapsulationStrategy": "CTAGED",
"reuseVlanSTag": false,
"encapsulation": "DOT1Q"
},
"enableAutoGenerateServiceKey": false,
"connectionRedundancyRequired": false,
"selectiveRedundancy": false,
"apiConfig": {"apiAvailable": false,
"equinixManagedPort": true,
"equinixManagedVlan": true,
"allowOverSubscription": false,
"overSubscriptionLimit": 1,
"bandwidthFromApi": false
},
"connectionLabel": "true1",
"authenticationKey": {"required": false,
"label": "Service Key"
}
}
],
"marketingInfo": {"promotion": true
},
"ports": [{"type": "XF_PORT",
"uuid": "c791f8cb-5cc9-cc90-8ce0-306a5c00a4ee",
"location": {"metroCode": "SY"
}
}
],
"metros": [{"code": "SY",
"name": "Sydney",
"ibxs": ["SY4"
],
"displayName": "Sydney"
}
]
}

Delete Service Profile

delete Service Profile by UUID

Authorizations:

BearerAuth

path Parameters

serviceProfileId

required

string <uuid>

Service Profile UUID

Responses

Response Headers
ETag	string response header - identifier for a specific version of a resource.

Response Schema: application/json; charset=UTF-8

state

string (ServiceProfileStateEnum)

Enum: "ACTIVE" "PENDING_APPROVAL" "DELETED" "REJECTED"

Equinix assigned state.

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

object (Project)

projectId

required

string

Subscriber-assigned project ID

object (ServiceProfileChange)

Current state of latest service profile change

uuid

string

Uniquely identifies a change

type

required

string

Type of change

status

string

Enum: "APPROVED" "COMPLETED" "FAILED" "REJECTED" "REQUESTED" "SUBMITTED_FOR_APPROVAL"

Current outcome of the change flow

createdDateTime

required

string <date-time>

Set when change flow starts

updatedDateTime

string <date-time>

Set when change object is updated

information

string

Additional information

Array of AddOperation (object) or RemoveOperation (object) or ReplaceOperation (object) (ServiceProfileUpdateRequest)

Array

One of

op required	string Value: "add"
path required	string (Path) A JSON Pointer path.
value required	object value to add

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

href

string <uri>

Service Profile URI response attribute

type

string (ServiceProfileTypeEnum)

Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE" "IX_PROFILE" "IC_PROFILE" "LMAAS_PROFILE"

Service profile type

name

string <= 50 characters

Customer-assigned service profile name

uuid

string <uuid>

Equinix-assigned service profile identifier

description

string

User-provided service description should be of maximum length 375

Array of objects (SimplifiedNotification)

Recipients of notifications on service profile change

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

tags

Array of strings (Tags)

visibility

string (ServiceProfileVisibilityEnum)

Enum: "PRIVATE" "PUBLIC"

allowedEmails

Array of strings <email> [ items <email > ]

Array of ServiceProfileAccessPointTypeCOLO (object) or ServiceProfileAccessPointTypeVD (object) (ServiceProfileAccessPointType) non-empty

Array (non-empty)

One of

uuid	string
type required	string (ServiceProfileAccessPointTypeEnum) Enum: "VD" "COLO" Access point type
supportedBandwidths	Array of integers (Bandwidths)
allowRemoteConnections	boolean Default: false Setting to allow or prohibit remote connections to the service profile.
allowCustomBandwidth	boolean Default: false Setting to enable or disable the ability of the buyer to customize the bandwidth.
bandwidthAlertThreshold	number percentage of port bandwidth at which an allocation alert is generated - missing on wiki.
allowBandwidthAutoApproval	boolean Default: false Setting to enable or disable the ability of the buyer to change connection bandwidth without approval of the seller.
allowBandwidthUpgrade	boolean Availability of a bandwidth upgrade. The default is false.
	object (ServiceProfileLinkProtocolConfig) Configuration for dot1q to qinq translation support
enableAutoGenerateServiceKey	boolean for verizon only.
connectionRedundancyRequired	boolean Default: false Mandate redundant connections
selectiveRedundancy	boolean Default: false Optional redundant connections
	object (ApiConfig) Configuration for API based Integration for Service Profile
connectionLabel	string custom name for "Connection"
	object (AuthenticationKey) Authentication Key Support and Customization
	object (ServiceProfileMetadata) Metadata. Response attribute. Ignored on request payload.

Array of objects (CustomField)

Array

label required	string
description	string
required required	boolean
dataType required	string Enum: "STRING" "LIST" "NUMBER"
options	Array of strings
captureInEmail	boolean capture this field as a part of email notification

object (MarketingInfo)

logo

string

Logo file name

promotion

boolean

Profile promotion on marketplace

Array of objects (ProcessStep) <= 3 items

Array (<= 3 items)

title	string Service profile custom step title
subTitle	string Service profile custom step sub title
description	string Service profile custom step description

Array of objects (ServiceProfileAccessPointCOLO)

Array

type required	string Enum: "XF_PORT" "IX_PORT"
uuid required	string <uuid>
	object (SimplifiedLocation)
sellerRegion	string
sellerRegionDescription	string
crossConnectId	string

Array of objects (ServiceProfileAccessPointVD)

Array

type required	string Value: "VD"
uuid required	string <uuid>
	object (SimplifiedLocation)
interfaceUuid	string <uuid>

Array of objects (ServiceMetro)

Derived response attribute.

Array

code	string metro code
name	string metro name
vcBandwidthMax	integer max VC speed supported in Mbps
ibxs	Array of strings
inTrail	boolean
displayName	string service metro display name
	object

Array of objects (ProviderEnvironment)

Provider environments associated with this IC_PROFILE service profile. ^Beta

Array

href	string <uri> Provider Environment URI
uuid	string <uuid> Equinix-assigned provider environment identifier
type	string (ProviderEnvironmentTypeEnum) Value: "IC_ENV" Provider environment type
name	string Provider environment name
description	string Provider environment description
sellerRegion	string Cloud provider region identifier
supportedBandwidths	Array of integers Supported bandwidths in Mbps
	Array of objects (ServiceMetro) Derived response attribute.
supportedFeatures	Array of strings Supported Feature Types
	object (Changelog) Change log

selfProfile

boolean

response attribute indicates whether the profile belongs to the same organization as the api-invoker.

projectId

string

object (ServiceProfileLastMileConfig)

Last-mile configuration for the service profile.

object (ServiceProfileLastMileApiIntegration)

Last-mile API integration details.

siteValidationEnabled	boolean Whether site validation is enabled for the last-mile provider.
dataCenterLocationEnabled	boolean Whether data center location is enabled for the last-mile provider.
productOfferingEnabled	boolean Whether product offering is enabled for the last-mile provider.
poqEnabled	boolean Whether product qualification is enabled for the last-mile provider.
quoteEnabled	boolean Whether quote generation is enabled for the last-mile provider.
placeOrderEnabled	boolean Whether place order is enabled for the last-mile provider.
quoteViaAggregatorEnabled	boolean Whether quote via aggregator is enabled for the last-mile provider.

Array of objects (ServiceProfileLastMileProductCatalog)

Last-mile provider catalogs.

Array

name	string Last-mile provider or catalog name.
id	string Last-mile provider or catalog identifier.
webUrl	string Last-mile catalog or provider website URL.
	object (ServiceProfileLastMileDeliveryDateRange) Range details for delivery window.
billingTerms	Array of integers or null Enum: 1 12 24 36 48 60 Available billing terms in months.
	Array of objects (ServiceProfileLastMileOffering) Available last-mile offerings.

Response samples

Content type

application/json; charset=UTF-8

{"state": "DELETED",
"account": {"orgId": 91785,
"organizationName": "testSeller-270010",
"globalOrgId": "0016u000003JZ4tAAG"
},
"changeLog": {"createdBy": "fusiontestseller",
"createdByFullName": "fusiontestSeller fusiontestSeller",
"createdByEmail": "fusiontestSeller@equinix.com",
"createdDateTime": "2022-04-12T19:06:57.940Z",
"updatedBy": "fusiontestseller",
"updatedByFullName": "fusiontestSeller fusiontestSeller",
"updatedByEmail": "fusiontestSeller@equinix.com",
"updatedDateTime": "2022-04-12T21:53:57.816Z"
},
"href": "https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
"type": "L2_PROFILE",
"name": "Service Profile 2",
"uuid": "ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
"description": "Sample_description",
"notifications": [{"type": "BANDWIDTH_ALERT",
"emails": ["someone@sample.com"
]
},
{"type": "CONNECTION_APPROVAL",
"emails": ["someone@sample.com"
]
},
{"type": "PROFILE_LIFECYCLE",
"emails": ["someone@sample.com"
]
}
],
"tags": ["sample_tag"
],
"visibility": "PUBLIC",
"allowedEmails": ["test@equinix.com",
"testagain@equinix.com"
],
"accessPointTypeConfigs": [{"type": "COLO",
"uuid": "f20c49cd-b022-4aeb-b3e4-49db4389aff3",
"supportedBandwidths": [100,
500
],
"allowRemoteConnections": false,
"allowCustomBandwidth": true,
"bandwidthAlertThreshold": 10,
"allowBandwidthAutoApproval": false,
"linkProtocolConfig": {"encapsulationStrategy": "CTAGED",
"reuseVlanSTag": false,
"encapsulation": "DOT1Q"
},
"enableAutoGenerateServiceKey": false,
"connectionRedundancyRequired": false,
"selectiveRedundancy": false,
"apiConfig": {"apiAvailable": false,
"equinixManagedPort": true,
"equinixManagedVlan": true,
"allowOverSubscription": false,
"overSubscriptionLimit": 1,
"bandwidthFromApi": false
},
"connectionLabel": "true1",
"authenticationKey": {"required": false,
"label": "Service Key"
}
}
],
"marketingInfo": {"promotion": true
},
"ports": [{"type": "XF_PORT",
"uuid": "c791f8cb-5cc9-cc90-8ce0-306a5c00a4ee",
"location": {"metroCode": "SY"
}
}
],
"metros": [{"code": "SY",
"name": "Sydney",
"ibxs": ["SY4"
],
"displayName": "Sydney"
}
]
}

Create Service Profile Action

This API provides capability to accept/reject service profile update requests

Authorizations:

BearerAuth

path Parameters

serviceProfileId

required

string <uuid>

Service Profile UUID

Request Body schema: application/json
required

type required	string Action type. Example values: PROFILE_UPDATE_ACCEPTANCE, PROFILE_UPDATE_REJECTION
description	string Action description

Responses

Response Schema: application/json; charset=UTF-8

href

string <uri>

Service Profile Action URI

type

string

Action type. Example values: PROFILE_UPDATE_ACCEPTANCE, PROFILE_UPDATE_REJECTION

uuid

string <uuid>

Equinix-assigned action identifier

comments

string

Action comments

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

Request samples

Payload

Content type

application/json

Example

AcceptProfileUpdate

{"type": "PROFILE_UPDATE_ACCEPTANCE",
"description": "Approved to migrate to public"
}

Response samples

Content type

application/json; charset=UTF-8

{"href": "https://api.equinix.com/fabric/v4/serviceProfiles/f30a9de3-c79e-443e-b65d-0a0692c6f3e0/actions/ac2a3233-23d9-423c-b375-0e78717bd348",
"type": "PROFILE_UPDATE_ACCEPTANCE",
"uuid": "ac2a3233-23d9-423c-b375-0e78717bd348",
"comments": "Approved to migrate to public",
"changeLog": {"createdBy": "adminuser",
"createdDateTime": "2026-03-04T10:30:00Z",
"updatedBy": "adminuser",
"updatedDateTime": "2026-03-04T10:35:00Z"
}
}

Get Service Profile Environments

Get service profile provider environments by UUID ^Beta

Authorizations:

BearerAuth

path Parameters

serviceProfileId

required

string <uuid>

Service Profile UUID

query Parameters

offset	integer Example: offset=1 offset
limit	integer Example: limit=10 number of records to fetch

Responses

Response Schema: application/json; charset=UTF-8

Array of objects (ProviderEnvironment)

Array

href	string <uri> Provider Environment URI
uuid	string <uuid> Equinix-assigned provider environment identifier
type	string (ProviderEnvironmentTypeEnum) Value: "IC_ENV" Provider environment type
name	string Provider environment name
description	string Provider environment description
sellerRegion	string Cloud provider region identifier
supportedBandwidths	Array of integers Supported bandwidths in Mbps
	Array of objects (ServiceMetro) Derived response attribute.
supportedFeatures	Array of strings Supported Feature Types
	object (Changelog) Change log

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Response samples

200
400
401
403
500

Content type

application/json; charset=UTF-8

{"data": [{"href": "https://api.equinix.com/fabric/v4/serviceProfiles/23ad37d0-6b1c-4d1f-a4eb-9f3d68fbe4fd/environments/6ad498b5-d929-44ac-a199-ce9f0d31d9ac",
"uuid": "6ad498b5-d929-44ac-a199-ce9f0d31d9ac",
"type": "IC_ENV",
"name": "US West 1 – Production",
"description": "Primary production environment",
"sellerRegion": "us-west-1",
"metros": [{"code": "CH",
"name": "Chicago",
"displayName": "Chicago"
},
{"code": "DC",
"name": "Ashburn",
"displayName": "Ashburn"
}
],
"supportedBandwidths": [1000,
10000,
100000
]
},
{"href": "https://api.equinix.com/fabric/v4/serviceProfiles/23ad37d0-6b1c-4d1f-a4eb-9f3d68fbe4fd/environments/1ad498b5-d929-44ac-a199-ce9f0d31d9ab",
"uuid": "1ad498b5-d929-44ac-a199-ce9f0d31d9ab",
"type": "IC_ENV",
"name": "US East 1 – Production",
"description": "Primary production environment",
"sellerRegion": "us-east-1",
"metros": [{"code": "DC",
"name": "Ashburn",
"displayName": "Ashburn"
}
],
"supportedBandwidths": [1000,
10000,
100000
]
}
],
"pagination": {"offset": 0,
"limit": 2,
"total": 2
}
}

Create Service Profile Environment Action

This API provides capability to perform actions on a service profile environment, such as validating an activation key.^Beta

Authorizations:

BearerAuth

path Parameters

serviceProfileId required	string <uuid> Service Profile UUID
environmentId required	string Provider Environment Reference

Request Body schema: application/json
required

type

required

string (EnvironmentActionTypeEnum)

Value: "VALIDATE_ACTIVATION_KEY"

Environment action type

required

object (ActivationKeyDetails)

Activation Key Details ^Beta

value	string Provider Encoded activation key
providerId	string AWS Connection identifier
accountId	string Account identifier
bandwidth	integer Bandwidth in Mbps
region	string Cloud provider region identifier

Responses

Response Schema: application/json

href

string <uri>

Environment action URI

type

string (EnvironmentActionTypeEnum)

Value: "VALIDATE_ACTIVATION_KEY"

Environment action type

uuid

string <uuid>

Equinix-assigned action identifier

state

string (EnvironmentActionStateEnum)

Enum: "ACTIVE" "INACTIVE"

Environment action state. ACTIVE - already used , INACTIVE - not used

object (ActivationKeyDetails)

Activation Key Details ^Beta

value	string Provider Encoded activation key
providerId	string AWS Connection identifier
accountId	string Account identifier
bandwidth	integer Bandwidth in Mbps
region	string Cloud provider region identifier

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

Request samples

Payload

Content type

application/json

{"type": "VALIDATE_ACTIVATION_KEY",
"keyDetails": {"value": "key_here"
}
}

Response samples

201
400
401
403
500

Content type

application/json

{"href": "http://example.com",
"type": "VALIDATE_ACTIVATION_KEY",
"uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",
"state": "ACTIVE",
"keyDetails": {"value": "key_here",
"providerId": "string",
"accountId": "string",
"bandwidth": 0,
"region": "string"
},
"changeLog": {"createdBy": "johnsmith",
"createdByFullName": "John Smith",
"createdByEmail": "john.smith@example.com",
"createdDateTime": "2020-11-06T07:00:00Z",
"updatedBy": "johnsmith",
"updatedByFullName": "John Smith",
"updatedByEmail": "john.smith@example.com",
"updatedDateTime": "2020-11-06T07:00:00Z",
"deletedBy": "johnsmith",
"deletedByFullName": "John Smith",
"deletedByEmail": "john.smith@example.com",
"deletedDateTime": "2020-11-06T07:00:00Z"
}
}

Get Service Profile Metros

Get service profile metros by UUID

Authorizations:

BearerAuth

path Parameters

serviceProfileId

required

string <uuid>

Service Profile UUID

query Parameters

offset	integer Example: offset=1 offset
limit	integer Example: limit=10 number of records to fetch

Responses

Response Schema: application/json; charset=UTF-8

Array of objects (ServiceMetro)

Array

code	string metro code
name	string metro name
vcBandwidthMax	integer max VC speed supported in Mbps
ibxs	Array of strings
inTrail	boolean
displayName	string service metro display name
	object

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Response samples

200
400
401
403
500

Content type

application/json; charset=UTF-8

{"data": [{"state": "ACTIVE",
"account": {"organizationName": "testSeller-270010"
},
"changeLog": {"createdBy": "fusiontestseller",
"createdByFullName": "fusiontestSeller fusiontestSeller",
"createdByEmail": "fusiontestSeller@equinix.com",
"createdDateTime": "2022-04-12T19:06:57.940Z",
"updatedBy": "fusiontestseller",
"updatedByFullName": "fusiontestSeller fusiontestSeller",
"updatedByEmail": "fusiontestSeller@equinix.com",
"updatedDateTime": "2022-04-12T19:11:04.017Z"
},
"href": "https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f?viewPoint=aSide",
"type": "L2_PROFILE",
"name": "Service Profile 2",
"uuid": "ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
"description": "Sample_description",
"visibility": "PUBLIC",
"allowedEmails": ["test@equinix.com",
"testagain@equinix.com"
],
"accessPointTypeConfigs": [{"type": "COLO",
"uuid": "f20c49cd-b022-4aeb-b3e4-49db4389aff3",
"supportedBandwidths": [100,
500
],
"allowRemoteConnections": false,
"allowCustomBandwidth": true,
"allowBandwidthAutoApproval": false,
"linkProtocolConfig": {"encapsulationStrategy": "CTAGED",
"reuseVlanSTag": false,
"encapsulation": "DOT1Q"
},
"enableAutoGenerateServiceKey": false,
"connectionRedundancyRequired": false,
"selectiveRedundancy": false,
"apiConfig": {"apiAvailable": false,
"bandwidthFromApi": false
},
"connectionLabel": "true1",
"authenticationKey": {"required": false,
"label": "Service Key"
}
}
],
"marketingInfo": {"promotion": true
},
"metros": [{"code": "SY",
"name": "Sydney",
"ibxs": ["SY4"
],
"displayName": "Sydney"
}
],
"selfProfile": true
}
],
"pagination": {"offset": 0,
"limit": 1,
"total": 52,
"next": "/serviceProfiles?offset=1&limit=1"
}
}

Company Profiles

Company Profiles ^Beta

Create Company Profile

Create a new company profile ^Beta

Authorizations:

BearerAuth

Request Body schema: application/json
required

type

required

string

name

required

string [ 1 .. 50 ] characters

summary

required

string [ 1 .. 125 ] characters

description

required

string [ 1 .. 450 ] characters

Array of objects (CompanyProfileContact)

Array

type	string Value: "SUPPORT" Contact Type
	Array of objects

Array of objects (SimplifiedNotification)

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

overview

string

webUrl

required

string

contactUrl

string

Responses

Request samples

Payload

Content type

application/json

{"type": "COMPANY_PROFILE",
"name": "Equinix",
"summary": "Global interconnection and data center company",
"description": "Equinix, Inc. connects the world's leading businesses to their customers, employees and partners inside the most interconnected data centers.",
"pointOfContacts": [{"type": "SUPPORT",
"contacts": [{"name": "Peter Griffin",
"role": "Vice President of Sales",
"email": "example1@example.com"
},
{"name": "Taylor Swift",
"role": "Director of Marketing",
"email": "example2@example.com"
},
{"name": "Darth Vader",
"role": "Head of Engineering",
"email": "example3@example.com"
}
]
}
],
"notifications": [{"type": "NOTIFICATION",
"emails": ["example1@example.com",
"example2@example.com"
]
}
],
"overview": "<b>About Initech Corp</b> <p>lorem ipsum</p>",
"webUrl": "https://www.equinix.com",
"contactUrl": "https://www.equinix.com/contact-us"
}

Response samples

202
400
401
403

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/companyProfiles/123e4567-e89b-12d3-a456-426614174000",
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"type": "COMPANY_PROFILE",
"name": "Equinix",
"summary": "Global interconnection and data center company",
"description": "Equinix, Inc. connects the world's leading businesses to their customers, employees and partners inside the most interconnected data centers.",
"state": "string",
"metros": [{"href": "https://api.equinix.com/fabric/v4/metros/SV",
"metroCode": "SV"
}
],
"logo": {"href": "string",
"uuid": "string",
"extensionType": "string"
},
"tags": [{"href": "https://api.equinix.com/fabric/v4/tags/260af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"uuid": "260af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"type": "RESOURCE_TAG",
"name": "environment",
"displayName": "Environment",
"weight": 30000
}
],
"serviceProfiles": [{"href": "https://api.equinix.com/fabric/v4/serviceProfiles/423af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"uuid": "423af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"type": "L2_PROFILE"
}
],
"privateServices": [{"href": "https://api.equinix.com/fabric/v4/privateServices/460af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"uuid": "460af68b-42f0-4f2e-9c5c-2fbd44b4b387"
},
{"href": "https://api.equinix.com/fabric/v4/privateServices/8a5685a6-063d-41ac-9279-d32431e8d8f6",
"uuid": "8a5685a6-063d-41ac-9279-d32431e8d8f6"
}
],
"pointOfContacts": [{"type": "SUPPORT",
"contacts": [{"name": "Peter Griffin",
"role": "Vice President of Sales",
"email": "example1@example.com"
},
{"name": "Taylor Swift",
"role": "Director of Marketing",
"email": "example2@example.com"
},
{"name": "Darth Vader",
"role": "Head of Engineering",
"email": "example3@example.com"
}
]
}
],
"notifications": [{"type": "NOTIFICATION",
"emails": ["example1@example.com",
"example2@example.com"
]
}
],
"overview": "<b>About Initech Corp</b> <p>lorem ipsum</p>",
"webUrl": "https://www.equinix.com",
"contactUrl": "https://www.equinix.com/contact-us",
"change": {"uuid": "string",
"type": "string",
"status": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"updatedDateTime": "2019-08-24T14:15:22Z",
"data": [ ]
},
"changeLog": {"createdBy": "johnsmith",
"createdByFullName": "John Smith",
"createdByEmail": "john.smith@example.com",
"createdDateTime": "2020-11-06T07:00:00Z",
"updatedBy": "johnsmith",
"updatedByFullName": "John Smith",
"updatedByEmail": "john.smith@example.com",
"updatedDateTime": "2020-11-06T07:00:00Z",
"deletedBy": "johnsmith",
"deletedByFullName": "John Smith",
"deletedByEmail": "john.smith@example.com",
"deletedDateTime": "2020-11-06T07:00:00Z"
}
}

Get Company Profile by ID

Get company profile details by UUID ^Beta

Authorizations:

BearerAuth

path Parameters

companyProfileId

required

string

Company Profile UUID

Responses

Response Schema: application/json

href

string

uuid

string

type

string

name

string [ 1 .. 50 ] characters

summary

string [ 1 .. 125 ] characters

description

string [ 1 .. 450 ] characters

state

string (CompanyProfileState)

Company Profile State

Array of objects (CompanyMetro)

Array

href	string
metroCode	string

object (CompanyLogo)

href	string
uuid	string
extensionType	string

Array of objects (TagResponse)

Array

href	string <uri>
uuid	string <uuid>
type	string
name	string
displayName	string
state	string Enum: "APPROVED" "PENDING_APPROVAL" "REJECTED" Status of the Tag request. Can be APPROVED, PENDING_APPROVAL, REJECT
	Array of objects (SimplifiedNotification)
	object (Changelog) Change log
weight	integer

Array of objects (CompanyServiceProfile)

Array

href	string
uuid	string
type	string (ServiceProfileTypeEnum) Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE" "IX_PROFILE" "IC_PROFILE" "LMAAS_PROFILE" Service profile type

Array of objects (PrivateService)

Array

href	string
uuid	string

Array of objects (CompanyProfileContact)

Array

type	string Value: "SUPPORT" Contact Type
	Array of objects

Array of objects (SimplifiedNotification)

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

overview

string

webUrl

string

contactUrl

string

object (CompanyProfileChange)

uuid

string

type

string

status

string

createdDateTime

string <date-time>

updatedDateTime

string <date-time>

Array of objects (CompanyProfileChangeItem)

Default: []

Array

op required	string Handy shortcut for operation name
path required	string path inside document leading to updated parameter
value required	any new value for updated parameter

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

Response samples

200
400
403
404

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/companyProfiles/123e4567-e89b-12d3-a456-426614174000",
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"type": "COMPANY_PROFILE",
"name": "Equinix",
"summary": "Global interconnection and data center company",
"description": "Equinix, Inc. connects the world's leading businesses to their customers, employees and partners inside the most interconnected data centers.",
"state": "string",
"metros": [{"href": "https://api.equinix.com/fabric/v4/metros/SV",
"metroCode": "SV"
}
],
"logo": {"href": "string",
"uuid": "string",
"extensionType": "string"
},
"tags": [{"href": "https://api.equinix.com/fabric/v4/tags/260af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"uuid": "260af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"type": "RESOURCE_TAG",
"name": "environment",
"displayName": "Environment",
"weight": 30000
}
],
"serviceProfiles": [{"href": "https://api.equinix.com/fabric/v4/serviceProfiles/423af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"uuid": "423af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"type": "L2_PROFILE"
}
],
"privateServices": [{"href": "https://api.equinix.com/fabric/v4/privateServices/460af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"uuid": "460af68b-42f0-4f2e-9c5c-2fbd44b4b387"
},
{"href": "https://api.equinix.com/fabric/v4/privateServices/8a5685a6-063d-41ac-9279-d32431e8d8f6",
"uuid": "8a5685a6-063d-41ac-9279-d32431e8d8f6"
}
],
"pointOfContacts": [{"type": "SUPPORT",
"contacts": [{"name": "Peter Griffin",
"role": "Vice President of Sales",
"email": "example1@example.com"
},
{"name": "Taylor Swift",
"role": "Director of Marketing",
"email": "example2@example.com"
},
{"name": "Darth Vader",
"role": "Head of Engineering",
"email": "example3@example.com"
}
]
}
],
"notifications": [{"type": "NOTIFICATION",
"emails": ["example1@example.com",
"example2@example.com"
]
}
],
"overview": "<b>About Initech Corp</b> <p>lorem ipsum</p>",
"webUrl": "https://www.equinix.com",
"contactUrl": "https://www.equinix.com/contact-us",
"change": {"uuid": "string",
"type": "string",
"status": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"updatedDateTime": "2019-08-24T14:15:22Z",
"data": [ ]
},
"changeLog": {"createdBy": "johnsmith",
"createdByFullName": "John Smith",
"createdByEmail": "john.smith@example.com",
"createdDateTime": "2020-11-06T07:00:00Z",
"updatedBy": "johnsmith",
"updatedByFullName": "John Smith",
"updatedByEmail": "john.smith@example.com",
"updatedDateTime": "2020-11-06T07:00:00Z",
"deletedBy": "johnsmith",
"deletedByFullName": "John Smith",
"deletedByEmail": "john.smith@example.com",
"deletedDateTime": "2020-11-06T07:00:00Z"
}
}

Delete Company Profile

Delete company profile by UUID ^Beta

Authorizations:

BearerAuth

path Parameters

companyProfileId

required

string

Company Profile UUID

Responses

Response Schema: application/json

href

string

uuid

string

type

string

name

string [ 1 .. 50 ] characters

summary

string [ 1 .. 125 ] characters

description

string [ 1 .. 450 ] characters

state

string (CompanyProfileState)

Company Profile State

Array of objects (CompanyMetro)

Array

href	string
metroCode	string

object (CompanyLogo)

href	string
uuid	string
extensionType	string

Array of objects (TagResponse)

Array

href	string <uri>
uuid	string <uuid>
type	string
name	string
displayName	string
state	string Enum: "APPROVED" "PENDING_APPROVAL" "REJECTED" Status of the Tag request. Can be APPROVED, PENDING_APPROVAL, REJECT
	Array of objects (SimplifiedNotification)
	object (Changelog) Change log
weight	integer

Array of objects (CompanyServiceProfile)

Array

href	string
uuid	string
type	string (ServiceProfileTypeEnum) Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE" "IX_PROFILE" "IC_PROFILE" "LMAAS_PROFILE" Service profile type

Array of objects (PrivateService)

Array

href	string
uuid	string

Array of objects (CompanyProfileContact)

Array

type	string Value: "SUPPORT" Contact Type
	Array of objects

Array of objects (SimplifiedNotification)

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

overview

string

webUrl

string

contactUrl

string

object (CompanyProfileChange)

uuid

string

type

string

status

string

createdDateTime

string <date-time>

updatedDateTime

string <date-time>

Array of objects (CompanyProfileChangeItem)

Default: []

Array

op required	string Handy shortcut for operation name
path required	string path inside document leading to updated parameter
value required	any new value for updated parameter

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

Response samples

200
400
403
404

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/companyProfiles/123e4567-e89b-12d3-a456-426614174000",
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"type": "COMPANY_PROFILE",
"name": "Equinix",
"summary": "Global interconnection and data center company",
"description": "Equinix, Inc. connects the world's leading businesses to their customers, employees and partners inside the most interconnected data centers.",
"state": "string",
"metros": [{"href": "https://api.equinix.com/fabric/v4/metros/SV",
"metroCode": "SV"
}
],
"logo": {"href": "string",
"uuid": "string",
"extensionType": "string"
},
"tags": [{"href": "https://api.equinix.com/fabric/v4/tags/260af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"uuid": "260af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"type": "RESOURCE_TAG",
"name": "environment",
"displayName": "Environment",
"weight": 30000
}
],
"serviceProfiles": [{"href": "https://api.equinix.com/fabric/v4/serviceProfiles/423af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"uuid": "423af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"type": "L2_PROFILE"
}
],
"privateServices": [{"href": "https://api.equinix.com/fabric/v4/privateServices/460af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"uuid": "460af68b-42f0-4f2e-9c5c-2fbd44b4b387"
},
{"href": "https://api.equinix.com/fabric/v4/privateServices/8a5685a6-063d-41ac-9279-d32431e8d8f6",
"uuid": "8a5685a6-063d-41ac-9279-d32431e8d8f6"
}
],
"pointOfContacts": [{"type": "SUPPORT",
"contacts": [{"name": "Peter Griffin",
"role": "Vice President of Sales",
"email": "example1@example.com"
},
{"name": "Taylor Swift",
"role": "Director of Marketing",
"email": "example2@example.com"
},
{"name": "Darth Vader",
"role": "Head of Engineering",
"email": "example3@example.com"
}
]
}
],
"notifications": [{"type": "NOTIFICATION",
"emails": ["example1@example.com",
"example2@example.com"
]
}
],
"overview": "<b>About Initech Corp</b> <p>lorem ipsum</p>",
"webUrl": "https://www.equinix.com",
"contactUrl": "https://www.equinix.com/contact-us",
"change": {"uuid": "string",
"type": "string",
"status": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"updatedDateTime": "2019-08-24T14:15:22Z",
"data": [ ]
},
"changeLog": {"createdBy": "johnsmith",
"createdByFullName": "John Smith",
"createdByEmail": "john.smith@example.com",
"createdDateTime": "2020-11-06T07:00:00Z",
"updatedBy": "johnsmith",
"updatedByFullName": "John Smith",
"updatedByEmail": "john.smith@example.com",
"updatedDateTime": "2020-11-06T07:00:00Z",
"deletedBy": "johnsmith",
"deletedByFullName": "John Smith",
"deletedByEmail": "john.smith@example.com",
"deletedDateTime": "2020-11-06T07:00:00Z"
}
}

Search Company Profiles

Search company profiles based on filter criteria ^Beta

Authorizations:

BearerAuth

query Parameters

viewPoint

string

Default: "aSide"

Viewpoint for the request, either 'aSide' or 'zSide'

Request Body schema: application/json
required

object (CompanyProfileSearchFilters)

Filter criteria for company profile search. The and array combines conditions where all must match. Each item in and is either a simple expression (property/operator/values) or an or group. At most one or group is allowed per request.

Array of CompanyProfileSearchSimpleExpression (object) or CompanyProfileSearchOrFilter (object) (CompanyProfileSearchFilter)

Array

One of

property required	string Enum: "/name" "/uuid" "/tags/name" "/tags/uuid" "/tags/displayName" "/state" "/metros/metroCode" "/change/status" Searchable field name. Properties are grouped by their supported operators: String properties (support all operators): `/name` - Company profile name `/uuid` - Company profile UUID `/tags/name` - Tag name `/tags/uuid` - Tag UUID `/tags/displayName` - Tag display name Discrete value properties (only support `=`, `!=`, `IN`, `NOT IN`): `/state` - Company profile state (`PENDING`, `PROVISIONED`, `DEPROVISIONED`, `REJECTED`) `/metros/metroCode` - Metro code (e.g. `SV`, `NY`, `DC`) `/change/status` - Change status (`PENDING`, `COMPLETED`, `REJECTED`) — seller and admin users only
operator required	string Enum: "=" "!=" "LIKE" "NOT LIKE" "ILIKE" "NOT ILIKE" "IN" "NOT IN" Comparison operator. `LIKE`, `NOT LIKE`, `ILIKE`, and `NOT ILIKE` require exactly one value. All other operators accept one or more values. `=` - equal; equivalent to `IN` when multiple values are provided `!=` - not equal; equivalent to `NOT IN` when multiple values are provided `LIKE` - case-sensitive partial match (single value) `NOT LIKE` - case-sensitive partial non-match (single value) `ILIKE` - case-insensitive partial match (single value) `NOT ILIKE` - case-insensitive partial non-match (single value) `IN` - matches any of the provided values `NOT IN` - does not match any of the provided values
values required	Array of strings non-empty

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

object (Sort)

property	string Property to sort by. Supported values: `/name` - Company profile name `/state` - Company profile state `/changeLog/updatedDateTime` - Date and time the profile was last updated `/changeLog/createdDateTime` - Date and time the profile was created
direction	string (CompanyProfileSortDirection) Default: "ASC" Enum: "DESC" "ASC" Sorting direction

Responses

Response Schema: application/json

required

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

required

Array of objects (CompanyProfileResponse)

Array

href	string
uuid	string
type	string
name	string [ 1 .. 50 ] characters
summary	string [ 1 .. 125 ] characters
description	string [ 1 .. 450 ] characters
state	string (CompanyProfileState) Company Profile State
	Array of objects (CompanyMetro)
	object (CompanyLogo)
	Array of objects (TagResponse)
	Array of objects (CompanyServiceProfile)
	Array of objects (PrivateService)
	Array of objects (CompanyProfileContact)
	Array of objects (SimplifiedNotification)
overview	string
webUrl	string
contactUrl	string
	object (CompanyProfileChange)
	object (Changelog) Change log

Request samples

Payload

Content type

application/json

{"filter": {"and": [{"property": "/state",
"operator": "=",
"values": ["PROVISIONED"
]
},
{"or": [{"property": "/name",
"operator": "ILIKE",
"values": ["equinix"
]
},
{"property": "/tags/name",
"operator": "=",
"values": ["environment"
]
}
]
}
]
},
"pagination": {"offset": 0,
"limit": 20,
"total": 0
},
"sort": {"property": "/changeLog/updatedDateTime",
"direction": "DESC"
}
}

Response samples

200
400
403

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 0,
"next": "string",
"previous": "string"
},
"data": [{"href": "https://api.equinix.com/fabric/v4/companyProfiles/123e4567-e89b-12d3-a456-426614174000",
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"type": "COMPANY_PROFILE",
"name": "Equinix",
"summary": "Global interconnection and data center company",
"description": "Equinix, Inc. connects the world's leading businesses to their customers, employees and partners inside the most interconnected data centers.",
"state": "string",
"metros": [{"href": "https://api.equinix.com/fabric/v4/metros/SV",
"metroCode": "SV"
}
],
"logo": {"href": "string",
"uuid": "string",
"extensionType": "string"
},
"tags": [{"href": "https://api.equinix.com/fabric/v4/tags/260af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"uuid": "260af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"type": "RESOURCE_TAG",
"name": "environment",
"displayName": "Environment",
"weight": 30000
}
],
"serviceProfiles": [{"href": "https://api.equinix.com/fabric/v4/serviceProfiles/423af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"uuid": "423af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"type": "L2_PROFILE"
}
],
"privateServices": [{"href": "https://api.equinix.com/fabric/v4/privateServices/460af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"uuid": "460af68b-42f0-4f2e-9c5c-2fbd44b4b387"
},
{"href": "https://api.equinix.com/fabric/v4/privateServices/8a5685a6-063d-41ac-9279-d32431e8d8f6",
"uuid": "8a5685a6-063d-41ac-9279-d32431e8d8f6"
}
],
"pointOfContacts": [{"type": "SUPPORT",
"contacts": [{"name": "Peter Griffin",
"role": "Vice President of Sales",
"email": "example1@example.com"
},
{"name": "Taylor Swift",
"role": "Director of Marketing",
"email": "example2@example.com"
},
{"name": "Darth Vader",
"role": "Head of Engineering",
"email": "example3@example.com"
}
]
}
],
"notifications": [{"type": "NOTIFICATION",
"emails": ["example1@example.com",
"example2@example.com"
]
}
],
"overview": "<b>About Initech Corp</b> <p>lorem ipsum</p>",
"webUrl": "https://www.equinix.com",
"contactUrl": "https://www.equinix.com/contact-us",
"change": {"uuid": "string",
"type": "string",
"status": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"updatedDateTime": "2019-08-24T14:15:22Z",
"data": [ ]
},
"changeLog": {"createdBy": "johnsmith",
"createdByFullName": "John Smith",
"createdByEmail": "john.smith@example.com",
"createdDateTime": "2020-11-06T07:00:00Z",
"updatedBy": "johnsmith",
"updatedByFullName": "John Smith",
"updatedByEmail": "john.smith@example.com",
"updatedDateTime": "2020-11-06T07:00:00Z",
"deletedBy": "johnsmith",
"deletedByFullName": "John Smith",
"deletedByEmail": "john.smith@example.com",
"deletedDateTime": "2020-11-06T07:00:00Z"
}
}
]
}

Get Service Profiles

Get all service profiles attached to a company profile ^Beta

Authorizations:

BearerAuth

path Parameters

companyProfileId

required

string

Company Profile UUID

Responses

Response Schema: application/json

Array of objects (CompanyServiceProfile)

List of service profiles

Array

href	string
uuid	string
type	string (ServiceProfileTypeEnum) Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE" "IX_PROFILE" "IC_PROFILE" "LMAAS_PROFILE" Service profile type

Response samples

200
400
403
404

Content type

application/json

{"data": [{"href": "https://api.equinix.com/fabric/v4/serviceProfiles/423af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"uuid": "423af68b-42f0-4f2e-9c5c-2fbd44b4b387"
}
]
}

Attach Service Profile

Attach a service profile to a company profile ^Beta

Authorizations:

BearerAuth

path Parameters

companyProfileId required	string Company Profile UUID
serviceProfileId required	string Service Profile UUID

Responses

Response Schema: application/json

href	string URL to the attached service profile
type required	string Type of the service or attachment
uuid required	string Unique identifier for the service profile
attachmentStatus	string Status of the attachment operation

Response samples

200
400
403
404

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/serviceProfiles/423af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"type": "SERVICE_PROFILE",
"uuid": "423af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"attachmentStatus": "ATTACHED"
}

Detach Service Profile

Detach a service profile from a company profile ^Beta

Authorizations:

BearerAuth

path Parameters

companyProfileId required	string Company Profile UUID
serviceProfileId required	string Service Profile UUID

Responses

Response Schema: application/json

href	string URL to the attached service profile
type required	string Type of the service or attachment
uuid required	string Unique identifier for the service profile
attachmentStatus	string Status of the attachment operation

Response samples

200
400
403
404

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/serviceProfiles/423af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"type": "SERVICE_PROFILE",
"uuid": "423af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"attachmentStatus": "ATTACHED"
}

Get Tags

Get all tags attached to a company profile ^Beta

Authorizations:

BearerAuth

path Parameters

companyProfileId

required

string

Company Profile UUID

Responses

Response Schema: application/json

Array of objects (TagResponse)

Array

href	string <uri>
uuid	string <uuid>
type	string
name	string
displayName	string
state	string Enum: "APPROVED" "PENDING_APPROVAL" "REJECTED" Status of the Tag request. Can be APPROVED, PENDING_APPROVAL, REJECT
	Array of objects (SimplifiedNotification)
	object (Changelog) Change log
weight	integer

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Response samples

200
400
403
404

Content type

application/json

{"data": [{"href": "https://api.equinix.com/fabric/v4/tags/18a127ad-9d0c-46e2-a66d-8ed85d1858b0",
"uuid": "18a127ad-9d0c-46e2-a66d-8ed85d1858b0",
"type": "PREDEFINED_TAG",
"name": "equinix.fabric.spotlight.ai.llm",
"displayName": "LLM",
"state": "PENDING_APPROVAL",
"notifications": [{"type": "NOTIFICATION",
"emails": ["example1@example.com",
"example2@example.com"
]
}
],
"changeLog": {"createdBy": "johnsmith",
"createdByFullName": "John Smith",
"createdByEmail": "john.smith@example.com",
"createdDateTime": "2020-11-06T07:00:00Z",
"updatedBy": "johnsmith",
"updatedByFullName": "John Smith",
"updatedByEmail": "john.smith@example.com",
"updatedDateTime": "2020-11-06T07:00:00Z",
"deletedBy": "johnsmith",
"deletedByFullName": "John Smith",
"deletedByEmail": "john.smith@example.com",
"deletedDateTime": "2020-11-06T07:00:00Z"
},
"weight": 30000
}
],
"pagination": {"offset": 0,
"limit": 20,
"total": 0,
"next": "string",
"previous": "string"
}
}

Attach Tag

Attach a tag to a company profile ^Beta

Authorizations:

BearerAuth

path Parameters

companyProfileId required	string Company Profile UUID
tagId required	string Tag UUID

Responses

Response Schema: application/json

href	string URL to the attached tag
type required	string Type of the tag or attachment
uuid required	string Unique identifier for the tag
attachmentStatus	string Status of the attachment operation

Response samples

200
400
403
404

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/tags/260af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"type": "TAG",
"uuid": "260af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"attachmentStatus": "ATTACHED"
}

Detach Tag

Detach a tag from a company profile ^Beta

Authorizations:

BearerAuth

path Parameters

companyProfileId required	string Company Profile UUID
tagId required	string Tag UUID

Responses

Response Schema: application/json

href	string URL to the attached tag
type required	string Type of the tag or attachment
uuid required	string Unique identifier for the tag
attachmentStatus	string Status of the attachment operation

Response samples

200
400
403
404

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/tags/260af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"type": "TAG",
"uuid": "260af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"attachmentStatus": "ATTACHED"
}

Get Private Services

Get all private services attached to a company profile ^Beta

Authorizations:

BearerAuth

path Parameters

companyProfileId

required

string

Company Profile UUID

Responses

Response Schema: application/json

Array of objects (PrivateService)

List of private services

Array

href	string
uuid	string

Response samples

200
400
403
404

Content type

application/json

{"data": [{"href": "https://api.equinix.com/fabric/v4/privateServices/460af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"uuid": "460af68b-42f0-4f2e-9c5c-2fbd44b4b387"
}
]
}

Attach Private Service

Attach a private service to a company profile ^Beta

Authorizations:

BearerAuth

path Parameters

companyProfileId required	string Company Profile UUID
privateServiceId required	string Private Service UUID

Responses

Response Schema: application/json

href	string URL to the attached private service
type required	string Type of the private service or attachment
uuid required	string Unique identifier for the private service
attachmentStatus	string Status of the attachment operation

Response samples

200
400
403
404

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/privateServices/460af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"type": "PRIVATE_SERVICE",
"uuid": "460af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"attachmentStatus": "ATTACHED"
}

Detach Private Service

Detach a private service from a company profile ^Beta

Authorizations:

BearerAuth

path Parameters

companyProfileId required	string Company Profile UUID
privateServiceId required	string Private Service UUID

Responses

Response Schema: application/json

href	string URL to the attached private service
type required	string Type of the private service or attachment
uuid required	string Unique identifier for the private service
attachmentStatus	string Status of the attachment operation

Response samples

200
400
403
404

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/privateServices/460af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"type": "PRIVATE_SERVICE",
"uuid": "460af68b-42f0-4f2e-9c5c-2fbd44b4b387",
"attachmentStatus": "ATTACHED"
}

Logos

Logos ^Beta

Create Logo

Create Logo for Equinix Fabric™ Company Profile

Authorizations:

BearerAuth

Request Body schema: multipart/form-data
required

logo required	string <binary> Logo image file
name required	string [ 1 .. 24 ] characters Name of the Logo
description required	string [ 1 .. 125 ] characters Description of the logo
type required	string Type of logo

Responses

Response Schema: application/json

href

string <uri>

uuid

string <uuid>

type

string

Type of logo

name

string

description

string

status

string

extensionType

string

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

Response samples

201
400
401
403
500

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/logos/18a127ad-9d0c-46e2-a66d-8ed85d1858b0",
"uuid": "18a127ad-9d0c-46e2-a66d-8ed85d1858b0",
"type": "COMPANY_LOGO",
"name": "Equinix Logo",
"description": "Company branding logo",
"status": "CREATED",
"extensionType": ".png",
"changelog": {"createdBy": "johnsmith",
"createdByFullName": "John Smith",
"createdByEmail": "john.smith@example.com",
"createdDateTime": "2020-11-06T07:00:00Z",
"updatedBy": "johnsmith",
"updatedByFullName": "John Smith",
"updatedByEmail": "john.smith@example.com",
"updatedDateTime": "2020-11-06T07:00:00Z",
"deletedBy": "johnsmith",
"deletedByFullName": "John Smith",
"deletedByEmail": "john.smith@example.com",
"deletedDateTime": "2020-11-06T07:00:00Z"
}
}

Get Logo

Get Logo by UUID

Authorizations:

BearerAuth

path Parameters

uuid

required

string <uuid>

UUID of the Logo

Responses

Response Schema: multipart/mixed

string <binary>

Response samples

400
401
403
404
500

Content type

application/json

[{"errorCode": "string",
"errorMessage": "string",
"correlationId": "string",
"details": "string",
"help": "string",
"additionalInfo": [{"property": "string",
"reason": "string"
}
]
}
]

Delete Logo

Delete Logo by UUID

Authorizations:

BearerAuth

path Parameters

uuid

required

string <uuid>

UUID of the Logo

Responses

Response samples

202
401
403
404
500

Content type

application/json; charset=UTF-8

{"href": "https://api.equinix.com/fabric/v4/logos/18a127ad-9d0c-46e2-a66d-8ed85d1858b0",
"uuid": "18a127ad-9d0c-46e2-a66d-8ed85d1858b0",
"type": "COMPANY_LOGO",
"name": "Equinix Logo",
"description": "Company branding logo",
"status": "CREATED",
"extensionType": ".png",
"changelog": {"createdBy": "johnsmith",
"createdByFullName": "John Smith",
"createdByEmail": "john.smith@example.com",
"createdDateTime": "2020-11-06T07:00:00Z",
"updatedBy": "johnsmith",
"updatedByFullName": "John Smith",
"updatedByEmail": "john.smith@example.com",
"updatedDateTime": "2020-11-06T07:00:00Z",
"deletedBy": "johnsmith",
"deletedByFullName": "John Smith",
"deletedByEmail": "john.smith@example.com",
"deletedDateTime": "2020-11-06T07:00:00Z"
}
}

Create Tag

Create Tag for Equinix Fabric™

Authorizations:

BearerAuth

Request Body schema: application/json
required

type

required

string

Type of tag

displayName

required

string [ 1 .. 24 ] characters

Display name of the Tag

Array of objects (SimplifiedNotification)

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

Responses

Request samples

Payload

Content type

application/json

{"type": "PREDEFINED_TAG",
"displayName": "LLM",
"notifications": [{"type": "NOTIFICATION",
"emails": ["example1@example.com",
"example2@example.com"
]
}
]
}

Response samples

202
400
401
403
500

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/tags/18a127ad-9d0c-46e2-a66d-8ed85d1858b0",
"uuid": "18a127ad-9d0c-46e2-a66d-8ed85d1858b0",
"type": "PREDEFINED_TAG",
"name": "equinix.fabric.spotlight.ai.llm",
"displayName": "LLM",
"state": "PENDING_APPROVAL",
"notifications": [{"type": "NOTIFICATION",
"emails": ["example1@example.com",
"example2@example.com"
]
}
],
"changeLog": {"createdBy": "johnsmith",
"createdByFullName": "John Smith",
"createdByEmail": "john.smith@example.com",
"createdDateTime": "2020-11-06T07:00:00Z",
"updatedBy": "johnsmith",
"updatedByFullName": "John Smith",
"updatedByEmail": "john.smith@example.com",
"updatedDateTime": "2020-11-06T07:00:00Z",
"deletedBy": "johnsmith",
"deletedByFullName": "John Smith",
"deletedByEmail": "john.smith@example.com",
"deletedDateTime": "2020-11-06T07:00:00Z"
},
"weight": 30000
}

Get Tag

Get Tag by UUID

Authorizations:

BearerAuth

path Parameters

uuid

required

string <uuid>

UUID of the Tag

Responses

Response Schema: application/json

href

string <uri>

uuid

string <uuid>

type

string

name

string

displayName

string

state

string

Enum: "APPROVED" "PENDING_APPROVAL" "REJECTED"

Status of the Tag request. Can be APPROVED, PENDING_APPROVAL, REJECT

Array of objects (SimplifiedNotification)

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

weight

integer

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/tags/18a127ad-9d0c-46e2-a66d-8ed85d1858b0",
"uuid": "18a127ad-9d0c-46e2-a66d-8ed85d1858b0",
"type": "PREDEFINED_TAG",
"name": "equinix.fabric.spotlight.ai.llm",
"displayName": "LLM",
"state": "PENDING_APPROVAL",
"notifications": [{"type": "NOTIFICATION",
"emails": ["example1@example.com",
"example2@example.com"
]
}
],
"changeLog": {"createdBy": "johnsmith",
"createdByFullName": "John Smith",
"createdByEmail": "john.smith@example.com",
"createdDateTime": "2020-11-06T07:00:00Z",
"updatedBy": "johnsmith",
"updatedByFullName": "John Smith",
"updatedByEmail": "john.smith@example.com",
"updatedDateTime": "2020-11-06T07:00:00Z",
"deletedBy": "johnsmith",
"deletedByFullName": "John Smith",
"deletedByEmail": "john.smith@example.com",
"deletedDateTime": "2020-11-06T07:00:00Z"
},
"weight": 30000
}

Marketplace Subscriptions

Get Subscription

The API provides capability to get subscription

Authorizations:

BearerAuth

path Parameters

subscriptionId

required

string <uuid>

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

Subscription UUID

Responses

Response Schema: application/json

href

string <uri>

Subscription URL

uuid

string <uuid>

Unique identifier of the Subscription

state

required

string (SubscriptionState)

Enum: "ACTIVE" "EXPIRED" "CANCELLED" "GRACE_PERIOD"

Subscription State

marketplace

required

string

Enum: "AWS" "GCP" "AZURE" "REDHAT"

Marketplace Type

offerType

string

Enum: "PUBLIC" "PRIVATE_OFFER"

Marketplace Offer Type

isAutoRenew

boolean

Is Auto Renewal Enabled

offerId

string

Marketplace Offer Id

object (SubscriptionTrial)

Free Trial Subscription

enabled	boolean Free Trial Enabled
expiryDateTime	string <date-time> Free Trial Expiry Date

metroCodes

Array of strings

List of available metro

required

Array of objects (SubscriptionEntitlementResponse)

List of entitlements associated with the subscription

Array

uuid	string <uuid> Subscription Entitlement Id
quantityEntitled	integer >= 0 Quantity entitled for the subscription
quantityConsumed	integer >= 0 Quantity consumed from the entitlement
quantityAvailable	integer >= 0 Quantity available from the entitlement
	object (SubscriptionAsset) Asset information

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

Response samples

200
401
403
415
500

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/marketplaceSubscriptions/c5557b51-7938-4f7d-afaa-41b930903a5e",
"uuid": "c5557b51-7938-4f7d-afaa-41b930903a5e",
"state": "ACTIVE",
"marketplace": "AWS",
"offerType": "PRIVATE_OFFER",
"isAutoRenew": false,
"offerId": "offer-wqquayy2jy25o",
"trial": {"enabled": true
},
"metroCodes": ["SV",
"DC"
],
"entitlements": [{"uuid": "a15b6b20-b765-4bf7-a661-a3e9372d5435",
"quantityEntitled": 1,
"quantityConsumed": 0,
"quantityAvailable": 1,
"asset": {"type": "XF_ROUTER",
"package": {"code": "STANDARD"
}
}
},
{"uuid": "2e3a9041-19ce-4c80-add3-3e3a069fc5e9",
"quantityEntitled": 1,
"quantityConsumed": 0,
"quantityAvailable": 1,
"asset": {"type": "IP_VC",
"bandwidth": 500
}
},
{"uuid": "9e30f661-d92e-4083-812f-db359807806e",
"quantityEntitled": 1,
"quantityConsumed": 0,
"quantityAvailable": 1,
"asset": {"type": "IPWAN_VC",
"bandwidth": 200
}
}
],
"changelog": {"createdBy": "adminuser",
"createdDateTime": "2020-05-21T10:30:00Z",
"updatedBy": "adminuser",
"updatedDateTime": "2020-05-21T10:30:00Z"
}
}

Streams

Create Stream

This API provides capability to create user's stream

Authorizations:

BearerAuth

Request Body schema: application/json
required

type

required

string

Value: "TELEMETRY_STREAM"

name

required

string

Customer-provided stream name

description

string

Customer-provided stream description

required

object (Project)

projectId

required

string

Subscriber-assigned project ID

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

Array of objects (SimplifiedNotification) <= 1 items

Preferences for stream notifications. Optional; at most one entry, of type ALL, with up to 12 emails. Set at creation only.

Array (<= 1 items)

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

Responses

Request samples

Payload

Content type

application/json

{"type": "TELEMETRY_STREAM",
"name": "splunk1",
"description": "subscription-1",
"project": {"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
},
"account": {"accountNumber": 123456
},
"notifications": [{"type": "ALL",
"emails": ["johndoe@equinix.com"
]
}
]
}

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418",
"uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
"type": "TELEMETRY_STREAM",
"name": "stream1",
"description": "stream 1",
"project": {"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
},
"account": {"accountNumber": 123456
},
"notifications": [{"type": "ALL",
"emails": ["johndoe@equinix.com"
]
}
],
"state": "PROVISIONED",
"assetsCount": 1,
"streamSubscriptionsCount": 2,
"alertRulesCount": 3,
"changeLog": {"createdDateTime": "2024-05-06T16:21:18.545214Z"
}
}

Get Streams

This API provides capability to retrieve streams

Authorizations:

BearerAuth

query Parameters

offset	integer Example: offset=1 offset
limit	integer Example: limit=10 number of records to fetch

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (Stream)

Data returned from the API call.

Array

href	string <uri> Stream URI
uuid	string <uuid> Equinix-assigned access point identifier
type	string Value: "TELEMETRY_STREAM" type
name	string Customer-provided stream name
description	string Customer-provided stream description
	object (Project)
	object (SimplifiedAccount)
	Array of objects (SimplifiedNotification) Preferences for stream notifications, set at creation
state	string Enum: "PROVISIONING" "PROVISIONED" "REPROVISIONING" "DEPROVISIONING" "DEPROVISIONED" "FAILED" Stream provision state
assetsCount	integer Stream assets count
streamSubscriptionsCount	integer Stream subscriptions count
alertRulesCount	integer Stream alert rules count
	object (Changelog) Change log

Response samples

200
401
403
404
500

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 1
},
"data": [{"href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418",
"uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
"type": "TELEMETRY_STREAM",
"name": "stream 1",
"description": "stream dec 1",
"project": {"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
},
"state": "PROVISIONED",
"assetsCount": 1,
"streamSubscriptionsCount": 2,
"alertRulesCount": 3,
"changeLog": {"createdDateTime": "2024-05-06T16:21:18.545214Z"
}
}
]
}

Search Streams

This API provides capability to search streams

Authorizations:

BearerAuth

Request Body schema: application/json
optional

object (StreamSearchFilters)

required

Array of StreamSearchSimpleExpression (object) or StreamSearchOrFilter (object) (StreamSearchFilter) [ 1 .. 10 ] items

Array ([ 1 .. 10 ] items)

Any of

property	string Possible field names to use on filters: `/uuid` - Stream uuid `/name` - Stream name `/state` - Stream state (`DEPROVISIONED` returned only when explicitly requested) `/type` - Stream type `/description` - Stream description `/project/projectId` - Stream project id `/changeLog/createdDateTime` - Stream created date time `/changeLog/updatedDateTime` - Stream updated date time
operator	string Possible operators to use on filters: `=` - equal `!=` - not equal `>` - greater than `>=` - greater than or equal to `<` - less than `<=` - less than or equal to `BETWEEN` - between `NOT BETWEEN` - not between `LIKE` - like `ILIKE` - like case-insensitive `IN` - in `NOT IN` - not in
values	Array of strings [ 1 .. 100 ] items

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (StreamSearchSortCriteria)

Array

direction required	string (StreamSearchSortDirection) Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property required	string (StreamSearchSortBy) Default: "/changeLog/createdDateTime" Enum: "/changeLog/createdDateTime" "/changeLog/updatedDateTime" Possible field names to use on sorting

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (Stream)

Data returned from the API call.

Array

href	string <uri> Stream URI
uuid	string <uuid> Equinix-assigned access point identifier
type	string Value: "TELEMETRY_STREAM" type
name	string Customer-provided stream name
description	string Customer-provided stream description
	object (Project)
	object (SimplifiedAccount)
	Array of objects (SimplifiedNotification) Preferences for stream notifications, set at creation
state	string Enum: "PROVISIONING" "PROVISIONED" "REPROVISIONING" "DEPROVISIONING" "DEPROVISIONED" "FAILED" Stream provision state
assetsCount	integer Stream assets count
streamSubscriptionsCount	integer Stream subscriptions count
alertRulesCount	integer Stream alert rules count
	object (Changelog) Change log

Request samples

Payload

Content type

application/json

{"filter": {"and": [{"property": "/project/projectId",
"operator": "IN",
"values": ["2f7f1a59-2dbf-43f8-b1a4-3c1f4e4b55b5"
]
},
{"or": [{"property": "/uuid",
"operator": "IN",
"values": ["12f4d4a1-c7cb-4def-9f77-5ce93c19d999",
"8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d"
]
}
]
},
{"property": "/state",
"operator": "=",
"values": ["PROVISIONED"
]
}
]
},
"sort": [{"direction": "DESC",
"property": "/changeLog/createdDateTime"
}
],
"pagination": {"offset": 0,
"limit": 20
}
}

Response samples

200
401
403
404
500

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 1
},
"data": [{"href": "https://api.equinix.com/fabric/v4/streams/12f4d4a1-c7cb-4def-9f77-5ce93c19d999",
"uuid": "12f4d4a1-c7cb-4def-9f77-5ce93c19d999",
"type": "TELEMETRY_STREAM",
"name": "stream-dev-01",
"description": "Observability stream for project assets",
"project": {"projectId": "2f7f1a59-2dbf-43f8-b1a4-3c1f4e4b55b5"
},
"state": "PROVISIONED",
"assetsCount": 3,
"streamSubscriptionsCount": 1,
"alertRulesCount": 2,
"changeLog": {"createdDateTime": "2026-06-17T10:15:30Z",
"updatedDateTime": "2026-06-18T10:15:30Z"
}
}
]
}

Get Stream

This API provides capability to get user's stream

Authorizations:

BearerAuth

path Parameters

streamId

required

string <uuid>

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

Stream UUID

Responses

Response Schema: application/json

href

string <uri>

Stream URI

uuid

string <uuid>

Equinix-assigned access point identifier

type

string

Value: "TELEMETRY_STREAM"

type

name

string

Customer-provided stream name

description

string

Customer-provided stream description

object (Project)

projectId

required

string

Subscriber-assigned project ID

object (SimplifiedAccount)

accountNumber	integer <int64> Account number
accountName	string Account name
orgId	integer <int64> Customer organization identifier
organizationName	string Customer organization name
globalOrgId	string Global organization identifier
globalOrganizationName	string Global organization name
ucmId	string Account ucmId
globalCustId	string Deprecated Account name
resellerAccountNumber	integer <int64> Reseller account number
resellerAccountName	string Reseller account name
resellerUcmId	string Reseller account ucmId
resellerOrgId	integer <int64> Reseller customer organization identifier

Array of objects (SimplifiedNotification)

Preferences for stream notifications, set at creation

Array

type required	string Enum: "NOTIFICATION" "BANDWIDTH_ALERT" "CONNECTION_APPROVAL" "PROFILE_LIFECYCLE" "ALL" "SALES_REP_NOTIFICATIONS" "TECHNICAL" "ORDERING" "QUOTE_NOTIFICATIONS" Notification Type
sendInterval	string
emails required	Array of strings <email> [ items <email > ] Array of contact emails
registeredUsers	Array of strings Array of registered users
	Array of objects (Phone) Array of contact phone numbers

state

string

Enum: "PROVISIONING" "PROVISIONED" "REPROVISIONING" "DEPROVISIONING" "DEPROVISIONED" "FAILED"

Stream provision state

assetsCount

integer

Stream assets count

streamSubscriptionsCount

integer

Stream subscriptions count

alertRulesCount

integer

Stream alert rules count

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418",
"uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
"type": "TELEMETRY_STREAM",
"name": "stream1",
"description": "stream 1",
"project": {"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
},
"account": {"accountNumber": 123456
},
"notifications": [{"type": "ALL",
"emails": ["johndoe@equinix.com"
]
}
],
"state": "PROVISIONED",
"assetsCount": 1,
"streamSubscriptionsCount": 2,
"alertRulesCount": 3,
"changeLog": {"createdDateTime": "2024-05-06T16:21:18.545214Z"
}
}

Delete Stream

This API provides capability to delete user's stream

Authorizations:

BearerAuth

path Parameters

streamId

required

string <uuid>

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

Stream UUID

Responses

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418",
"uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
"type": "TELEMETRY_STREAM",
"name": "stream1",
"description": "stream 1",
"project": {"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
},
"state": "DEPROVISIONING",
"assetsCount": 1,
"streamSubscriptionsCount": 2,
"changeLog": {"createdDateTime": "2024-05-06T16:21:18.545214Z"
}
}

Update Stream

This API provides capability to update user's stream

Authorizations:

BearerAuth

path Parameters

streamId

required

string <uuid>

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

Stream UUID

Request Body schema: application/json
required

name required	string Customer-provided stream name
description	string Customer-provided stream description

Responses

Request samples

Payload

Content type

application/json

{"name": "splunk1",
"description": "subscription 1"
}

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418",
"uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
"type": "TELEMETRY_STREAM",
"name": "stream1",
"description": "stream 1",
"project": {"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
},
"account": {"accountNumber": 123456
},
"notifications": [{"type": "ALL",
"emails": ["johndoe@equinix.com"
]
}
],
"state": "PROVISIONED",
"assetsCount": 1,
"streamSubscriptionsCount": 2,
"alertRulesCount": 3,
"changeLog": {"createdDateTime": "2024-05-06T16:21:18.545214Z"
}
}

Search Stream Assets

This API provides capability to search stream assets

Authorizations:

BearerAuth

Request Body schema: application/json
required

object (StreamAssetFilters)

Array of StreamAssetSimpleExpression (object) or StreamAssetOrFilter (object) (StreamAssetFilter) <= 8 items

Array (<= 8 items)

Any of

property	string Possible field names to use on filters: `/uuid` - Asset uuid (`=` and `IN` only) `/streamUuid` - Stream uuid (`=` and `IN` only) `/attachmentStatus` - Asset attachment status (`=`, `IN`, and `NOT IN`)
operator	string Possible operators to use on filters: `=` - equal `IN` - in `NOT IN` - not in
values	Array of strings non-empty

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (StreamAssetSortCriteria)

Array

direction required	string (StreamAssetSortDirection) Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property required	string (StreamAssetSortBy) Default: "/uuid" Enum: "/uuid" "/streamUuid" Possible field names to use on sorting

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (StreamSearchAsset)

Data returned from the API call.

Array

href	string <uri> Stream Asset URI
uuid	string <uuid> Equinix-assigned access point identifier
streamUuid	string <uuid> Equinix-assigned access point identifier
type	string Asset type
metricsEnabled	boolean enable metric
attachmentStatus	string Enum: "ATTACHING" "ATTACHED" "DETACHED" "DETACHING" "FAILED" asset status
projectId	string project ic

Request samples

Payload

Content type

application/json

{"filter": {"and": [{"property": "/uuid",
"operator": "IN",
"values": ["8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d",
"9ac8ecfe-c7cb-4def-9f77-5ce93c19d83e"
]
},
{"property": "/streamUuid",
"operator": "=",
"values": ["4719e319-65ae-4001-aabf-ca5f107b9b29"
]
},
{"property": "/attachmentStatus",
"operator": "IN",
"values": ["ATTACHED",
"ATTACHING"
]
}
]
},
"sort": [{"direction": "DESC",
"property": "/uuid"
}
],
"pagination": {"offset": 0,
"limit": 20
}
}

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 1
},
"data": [{"href": "https://api.equinix.com/fabric/v4/ports/e684aa26-8276-48b7-bb42-a6d9def0a419",
"uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
"streamUuid": "e784aa26-8276-48b7-bb42-a6d9def0a424",
"type": "XF_PORT",
"metricsEnabled": false,
"attachmentStatus": "ATTACHED",
"projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}
]
}

Get Asset

This API provides capability to get user's assets attached to a stream

Authorizations:

BearerAuth

path Parameters

assetId required	string <uuid> Example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 asset UUID
asset required	string (Asset) Enum: "ports" "connections" "routers" "metros" "organizations" "projects" "companyProfiles" asset
streamId required	string <uuid> Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 Stream UUID

Responses

Response Schema: application/json

href	string <uri> Stream Asset URI
uuid	string <uuid> Equinix-assigned access point identifier
type	string Enum: "XF_PORT" "IP_VC" "EVPLAN_VC" "EVPL_VC" "XF_METRO" "XF_ROUTER" "ORGANIZATION" "PROJECT" "VIRTUAL_DEVICE" "DATA" "MGMT" "SSH" "FAB" "CTRL" Asset types
metricsEnabled	boolean enable metric
attachmentStatus	string Enum: "ATTACHING" "ATTACHED" "DETACHED" "DETACHING" "FAILED" asset status

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/streams/e684aa26-8276-48b7-bb42-a6d9def0a419/connections/d684aa26-8276-48b7-bb42-a6d9def0a418",
"uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
"type": "IP_VC",
"metricsEnabled": false,
"attachmentStatus": "ATTACHED"
}

Attach Asset

This API provides capability to attach an asset to a stream

Authorizations:

BearerAuth

path Parameters

assetId required	string <uuid> Example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 asset UUID
asset required	string (Asset) Enum: "ports" "connections" "routers" "metros" "organizations" "projects" "companyProfiles" asset
streamId required	string <uuid> Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 Stream UUID

Request Body schema: application/json
required

metricsEnabled

boolean

Default: false

enable metric

Responses

Request samples

Payload

Content type

application/json

{"metricsEnabled": false
}

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/streams/e684aa26-8276-48b7-bb42-a6d9def0a419/routers/d684aa26-8276-48b7-bb42-a6d9def0a418",
"uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
"type": "XF_ROUTER",
"metricsEnabled": false,
"attachmentStatus": "ATTACHING"
}

Detach Asset

This API provides capability to detach an asset from a stream

Authorizations:

BearerAuth

path Parameters

assetId required	string <uuid> Example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 asset UUID
asset required	string (Asset) Enum: "ports" "connections" "routers" "metros" "organizations" "projects" "companyProfiles" asset
streamId required	string <uuid> Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 Stream UUID

Responses

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/streams/e684aa26-8276-48b7-bb42-a6d9def0a419/routers/d684aa26-8276-48b7-bb42-a6d9def0a418",
"uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
"type": "XF_ROUTER",
"metricsEnabled": false,
"attachmentStatus": "DETACHING"
}

Get Network Edge Device

This API provides capability to get a Network Edge Device and its interfaces attached to a stream

Authorizations:

BearerAuth

path Parameters

streamId required	string <uuid> Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 Stream UUID
deviceId required	string <uuid> Example: 8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d Network Edge Device UUID

Responses

Response Schema: application/json

href	string <uri> Stream Asset URI
uuid	string <uuid> Equinix-assigned access point identifier
type	string Enum: "XF_PORT" "IP_VC" "EVPLAN_VC" "EVPL_VC" "XF_METRO" "XF_ROUTER" "ORGANIZATION" "PROJECT" "VIRTUAL_DEVICE" "DATA" "MGMT" "SSH" "FAB" "CTRL" Asset types
metricsEnabled	boolean enable metric
attachmentStatus	string Enum: "ATTACHING" "ATTACHED" "DETACHED" "DETACHING" "FAILED" asset status

Response samples

Content type

application/json

{"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": "ATTACHED",
"interfaces": [{"href": "https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/3",
"id": 3,
"uuid": "1f2e3d4c-5b6a-4978-8a9b-0c1d2e3f4a5b",
"type": "DATA",
"state": "ASSIGNED",
"attachmentStatus": "ATTACHED"
},
{"href": "https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/5",
"id": 5,
"uuid": "4a1b2c3d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"type": "DATA",
"state": "ASSIGNED",
"attachmentStatus": "ATTACHED"
}
]
}

Attach Network Edge Device Interfaces

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.

Authorizations:

BearerAuth

path Parameters

streamId required	string <uuid> Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 Stream UUID
deviceId required	string <uuid> Example: 8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d Network Edge Device UUID

Request Body schema: application/json
required

metricsEnabled

boolean

Default: false

enable metric. Must be true when interfaces are provided

Array 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.

Array

id

required

integer <int32>

Network Edge Device interface identifier

Responses

Request samples

Payload

Content type

application/json

{"metricsEnabled": true,
"interfaces": [{"id": 3
},
{"id": 5
}
]
}

Response samples

Content type

application/json

{"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": [{"href": "https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/3",
"id": 3,
"uuid": "1f2e3d4c-5b6a-4978-8a9b-0c1d2e3f4a5b",
"type": "DATA",
"state": "ASSIGNED",
"attachmentStatus": "ATTACHING"
},
{"href": "https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/5",
"id": 5,
"uuid": "4a1b2c3d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"type": "DATA",
"state": "ASSIGNED",
"attachmentStatus": "ATTACHING"
}
]
}

Detach Network Edge Device

This API provides capability to detach a Network Edge Device and all of its interfaces from a stream

Authorizations:

BearerAuth

path Parameters

streamId required	string <uuid> Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 Stream UUID
deviceId required	string <uuid> Example: 8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d Network Edge Device UUID

Responses

Response samples

Content type

application/json

{"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": "DETACHING",
"interfaces": [{"href": "https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/3",
"id": 3,
"uuid": "1f2e3d4c-5b6a-4978-8a9b-0c1d2e3f4a5b",
"type": "DATA",
"state": "ASSIGNED",
"attachmentStatus": "DETACHING"
},
{"href": "https://api.equinix.com/ne/v1/devices/8a9b7c6d-1e2f-4a3b-9c4d-5e6f7a8b9c0d/interfaces/5",
"id": 5,
"uuid": "4a1b2c3d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"type": "DATA",
"state": "ASSIGNED",
"attachmentStatus": "DETACHING"
}
]
}

Stream Subscriptions

Create Subscription

This API provides capability to create user's Stream Subscriptions

Authorizations:

BearerAuth

path Parameters

streamId

required

string <uuid>

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

Stream UUID

Request Body schema: application/json
required

type

required

string

Value: "STREAM_SUBSCRIPTION"

name

required

string

Customer-provided stream subscription name

description

string

Customer-provided stream subscription description

enabled

boolean

Default: true

Stream subscription enabled status

object (StreamSubscriptionSelector)

include	Array of strings (StreamSubscriptionSelectorExpression) <= 8 items
except	Array of strings (StreamSubscriptionSelectorExpression) <= 8 items

object (StreamSubscriptionSelector)

include	Array of strings (StreamSubscriptionSelectorExpression) <= 8 items
except	Array of strings (StreamSubscriptionSelectorExpression) <= 8 items

required

object (StreamSubscriptionSink)

Create Stream destination

uri

string

any publicly reachable http endpoint

type

required

string

Enum: "DATADOG" "DYNATRACE" "GOOGLE_PUBSUB" "PAGERDUTY" "SERVICENOW" "SLACK" "SPLUNK_HEC" "TEAMS" "WEBHOOK"

destination type

batchEnabled

boolean

batch mode on/off

batchSizeMax

integer

maximum batch size

batchWaitTimeMax

integer

maximum batch waiting time

object (StreamSubscriptionSinkCredential)

Stream subscription sink credentials

type	string Enum: "ACCESS_TOKEN" "INTEGRATION_KEY" "API_KEY" "USERNAME_PASSWORD" "API_TOKEN" credential type
accessToken	string passed as Authorization header value
integrationKey	string passed as Authorization header value
apiKey	string passed as Authorization header value
username	string passed as Authorization header value
password	string passed as Authorization header value
apiToken	string passed as Authorization header value

object (StreamSubscriptionSinkSetting)

Stream subscription sink settings

eventIndex	string event index
metricIndex	string metric index
source	string source
applicationKey	string Application key
eventUri	string event uri
metricUri	string metric uri
format	string Default: "CLOUDEVENT" Enum: "CLOUDEVENT" "OPENTELEMETRY" webhook message format

host

string

sink host

Responses

Request samples

Payload

Content type

application/json

Example

CreateStreamSubscription_Splunk_Simple

{"type": "STREAM_SUBSCRIPTION",
"name": "splunk1",
"description": "subscription-1",
"enabled": true,
"sink": {"uri": "https://http-inputs-<host>.splunkcloud.com:<port>/services/collector/event",
"type": "SPLUNK_HEC",
"credential": {"type": "ACCESS_TOKEN",
"accessToken": "Splunk <my-access-token>"
},
"settings": {"source": "Equinix",
"eventIndex": "idx-hec-event",
"metricIndex": "idx-hec-metric"
}
}
}

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/subscriptions/d684aa26-8276-48b7-bb42-a6d9def0a418",
"uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
"type": "STREAM_SUBSCRIPTION",
"name": "stream 1",
"description": "stream dec 1",
"state": "PROVISIONED",
"enabled": true,
"metricSelector": {"include": ["equinix.fabric.connection.*"
]
},
"eventSelector": {"include": ["equinix.fabric.connection.*"
]
},
"sink": {"uri": "https://http-inputs-<host>.splunkcloud.com:<port>/services/collector/event",
"type": "SPLUNK_HEC",
"credential": {"type": "ACCESS_TOKEN",
"accessToken": "Splunk <my-access-token>"
},
"settings": {"source": "Equinix",
"eventIndex": "idx-hec-event",
"metricIndex": "idx-hec-metric"
},
"batchEnabled": false,
"batchSizeMax": 50,
"batchWaitTimeMax": 5
},
"operation": {"eventsDeliveredCount": 0,
"metricsDeliveredCount": 0,
"alertsDeliveredCount": 0,
"errors": [ ]
},
"changeLog": {"createdDateTime": "2024-05-06T16:21:18.545214Z"
}
}

Get Subscriptions

This API provides capability to retrieve stream subscriptions

Authorizations:

BearerAuth

path Parameters

streamId

required

string <uuid>

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

Stream UUID

query Parameters

offset	integer Example: offset=1 offset
limit	integer Example: limit=10 number of records to fetch

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (StreamSubscription)

Data returned from the API call.

Array

href	string <uri> Stream Subscription URI
uuid	string <uuid> Equinix-assigned access point identifier
type	string Value: "STREAM_SUBSCRIPTION" type
name	string Customer-provided subscription name
description	string Customer-provided subscription description
state	string Enum: "PROVISIONING" "PROVISIONED" "REPROVISIONING" "DEPROVISIONING" "DEPROVISIONED" "FAILED" Steam subscription provision state
enabled	boolean Stream subscription enabled status
	object (StreamSubscriptionSelector)
	object (StreamSubscriptionSelector)
	object (StreamSubscriptionSinkResponse) Create Stream destination
	object (StreamSubscriptionOperation) Stream subscription operational information
	object (Changelog) Change log

Response samples

200
401
403
404
500

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 1
},
"data": [{"href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/subscriptions/d684aa26-8276-48b7-bb42-a6d9def0a418",
"uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
"type": "STREAM_SUBSCRIPTION",
"name": "splunk",
"description": "subscription 1",
"state": "PROVISIONED",
"metricSelector": {"include": ["equinix.fabric.connection.*"
]
},
"eventSelector": {"include": ["equinix.fabric.connection.*"
]
},
"sink": {"uri": "https://xxxxxx",
"type": "SPLUNK_HEC",
"batchEnabled": false,
"batchSizeMax": 50,
"batchWaitTimeMax": 5
},
"operation": {"eventsDeliveredCount": 0,
"metricsDeliveredCount": 0,
"alertsDeliveredCount": 0,
"errors": [ ]
},
"changeLog": {"createdDateTime": "2024-05-06T16:21:18.545214Z"
}
}
]
}

Get Subscription

This API provides capability to delete user's get Stream Subscriptions

Authorizations:

BearerAuth

path Parameters

streamId required	string <uuid> Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 Stream UUID
subscriptionId required	string <uuid> Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Stream Subscription UUID

Responses

Response Schema: application/json

href

string <uri>

Stream Subscription URI

uuid

string <uuid>

Equinix-assigned access point identifier

type

string

Value: "STREAM_SUBSCRIPTION"

type

name

string

Customer-provided subscription name

description

string

Customer-provided subscription description

state

string

Enum: "PROVISIONING" "PROVISIONED" "REPROVISIONING" "DEPROVISIONING" "DEPROVISIONED" "FAILED"

Steam subscription provision state

enabled

boolean

Stream subscription enabled status

object (StreamSubscriptionSelector)

include	Array of strings (StreamSubscriptionSelectorExpression) <= 8 items
except	Array of strings (StreamSubscriptionSelectorExpression) <= 8 items

object (StreamSubscriptionSelector)

include	Array of strings (StreamSubscriptionSelectorExpression) <= 8 items
except	Array of strings (StreamSubscriptionSelectorExpression) <= 8 items

object (StreamSubscriptionSinkResponse)

Create Stream destination

uri

string

any publicly reachable http endpoint

type

string

Enum: "DATADOG" "DYNATRACE" "GOOGLE_PUBSUB" "PAGERDUTY" "SERVICENOW" "SLACK" "SPLUNK_HEC" "TEAMS" "WEBHOOK"

destination type

batchEnabled

boolean

batch mode on/off

batchSizeMax

integer

maximum batch size

batchWaitTimeMax

integer

maximum batch waiting time

object (StreamSubscriptionSinkCredential)

Stream subscription sink credentials

type	string Enum: "ACCESS_TOKEN" "INTEGRATION_KEY" "API_KEY" "USERNAME_PASSWORD" "API_TOKEN" credential type
accessToken	string passed as Authorization header value
integrationKey	string passed as Authorization header value
apiKey	string passed as Authorization header value
username	string passed as Authorization header value
password	string passed as Authorization header value
apiToken	string passed as Authorization header value

object (StreamSubscriptionSinkSetting)

Stream subscription sink settings

eventIndex	string event index
metricIndex	string metric index
source	string source
applicationKey	string Application key
eventUri	string event uri
metricUri	string metric uri
format	string Default: "CLOUDEVENT" Enum: "CLOUDEVENT" "OPENTELEMETRY" webhook message format

host

string

sink host

object (StreamSubscriptionOperation)

Stream subscription operational information

eventsDeliveredCount

integer

count of delivered events

metricsDeliveredCount

integer

count of delivered metrics

alertsDeliveredCount

integer

count of delivered alerts

lastSuccessfulDeliveryDateTime

string <date-time>

last successful date time of delivered event, metric, or alert

suspendedDateTime

string <date-time>

suspended date time of stream subscription delivery for event, metric, or alert

Array of objects (StreamSubscriptionOperationErrors)

List of error information for stream subscription delivery

Array

errorCode	string Equinix Observability error code
errorMessage	string Equinix Observability error message
dateTime	string <date-time> Equinix Observability error date time
	object (StreamSubscriptionOperationAdditionalInfo) External error information from subscription sink

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/subscriptions/d684aa26-8276-48b7-bb42-a6d9def0a418",
"uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
"type": "STREAM_SUBSCRIPTION",
"name": "stream 1",
"description": "stream dec 1",
"state": "PROVISIONED",
"enabled": true,
"metricSelector": {"include": ["equinix.fabric.connection.*"
]
},
"eventSelector": {"include": ["equinix.fabric.connection.*"
]
},
"sink": {"uri": "https://http-inputs-<host>.splunkcloud.com:<port>/services/collector/event",
"type": "SPLUNK_HEC",
"credential": {"type": "ACCESS_TOKEN",
"accessToken": "Splunk <my-access-token>"
},
"settings": {"source": "Equinix",
"eventIndex": "idx-hec-event",
"metricIndex": "idx-hec-metric"
},
"batchEnabled": false,
"batchSizeMax": 50,
"batchWaitTimeMax": 5
},
"operation": {"eventsDeliveredCount": 0,
"metricsDeliveredCount": 0,
"alertsDeliveredCount": 0,
"errors": [ ]
},
"changeLog": {"createdDateTime": "2024-05-06T16:21:18.545214Z"
}
}

Delete Subscription

This API provides capability to delete user's Stream Subscriptions

Authorizations:

BearerAuth

path Parameters

streamId required	string <uuid> Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 Stream UUID
subscriptionId required	string <uuid> Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Stream Subscription UUID

Responses

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/subscriptions/d684aa26-8276-48b7-bb42-a6d9def0a418",
"uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
"type": "STREAM_SUBSCRIPTION",
"name": "stream 1",
"description": "stream dec 1",
"state": "DEPROVISIONING",
"enabled": true,
"metricSelector": {"include": ["equinix.fabric.connection.*"
]
},
"eventSelector": {"include": ["equinix.fabric.connection.*"
]
},
"sink": {"uri": "https://xxxxxx",
"type": "SPLUNK_HEC",
"credential": {"type": "ACCESS_TOKEN",
"accessToken": "Splunk <my-access-token>"
},
"settings": {"source": "Equinix",
"eventIndex": "idx-hec-event",
"metricIndex": "idx-hec-metric"
},
"batchEnabled": false,
"batchSizeMax": 50,
"batchWaitTimeMax": 5
},
"changeLog": {"createdDateTime": "2024-05-06T16:21:18.545214Z"
}
}

Update Subscription

This API provides capability to update user's Stream Subscriptions

Authorizations:

BearerAuth

path Parameters

streamId required	string <uuid> Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 Stream UUID
subscriptionId required	string <uuid> Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Stream Subscription UUID

Request Body schema: application/json
required

type

required

string

Value: "STREAM_SUBSCRIPTION"

name

required

string

Customer-provided stream subscription name

description

string

Customer-provided stream subscription description

enabled

boolean

Stream subscription enabled status

object (StreamSubscriptionFilter)

Array of StreamFilterSimpleExpression (object) or StreamFilterOrFilter (object) (StreamFilter) <= 8 items

Array (<= 8 items)

Any of

property	string Possible field names to use on filters: `/subject` - subject `/type` - type
operator	string Possible operators to use on filters: `=` - equal `in` - in `LIKE` - case-sensitive like `ILIKE` - case-insensitive like
values	Array of strings Supported event or metric names to use on filters with property /type: `` - all events or metrics `equinix.fabric.company_profile.` - company profile events `equinix.fabric.connection.` - connection events, metrics, or alerts `equinix.fabric.connection_bgpipv4_session.` - connection BGP IPv4 session events `equinix.fabric.connection_bgpipv6_session.` - connection BGP IPv6 session events `equinix.fabric.connection_maintenance.` - connection maintenance events `equinix.fabric.connection_route_aggregation.` - connection route aggregation events `equinix.fabric.connection_route_filter.` - connection route filter events `equinix.fabric.connection_routing_protocol.` - connection routing protocol events `equinix.fabric.internet_access.` - internet access service events `equinix.fabric.ip_block.` - IP block events `equinix.fabric.metric` - metric collection events `equinix.fabric.metro.` - metro metrics or alerts `equinix.fabric.network.` - network events `equinix.fabric.physical_port.` - physical port events `equinix.fabric.port.` - virtual port events, metrics, or alerts `equinix.fabric.port_maintenance.` - port maintenance events `equinix.fabric.route_aggregation.` - route aggregation events `equinix.fabric.route_aggregation_rule.` - route aggregation rule events `equinix.fabric.route_filter.` - route filter events `equinix.fabric.route_filter_rule.` - route filter rule events `equinix.fabric.router.` - cloud router events or alerts `equinix.fabric.router_action.` - cloud router action events `equinix.fabric.router_command.` - cloud router command events `equinix.fabric.routing_protocol_action.` - routing protocol action events `equinix.fabric.service_profile_connection.` - service profile connection events `equinix.fabric.service_token.` - service token events `equinix.fabric.time_service.` - precision time service events `equinix.network.maintenance.` - network maintenance events `equinix.network.repair.` - network repair events `equinix.network_edge.` - network edge events, metrics, or alerts `equinix.network_edge.acl.` - network edge acl events `equinix.network_edge.device.` - network edge device events `equinix.network_edge.device_interface.` - network edge device interface metrics or alerts `equinix.network_edge.devicelinkgroup.` - network edge device link group events `equinix.access_manager.` - identity access manager events `equinix.access_manager.user.role.` - identity access manager user role events `equinix.iam.principal.` - IAM principal authorization and token events `equinix.identity.user.` - identity user events `equinix.identity.organization.` - identity organization membership events `equinix.resource_manager.organization.` - resource manager organization events `equinix.resource_manager.project.` - resource manager project events Supported event or metric names to use on filters with property /subject: `` - all events or metrics `/fabric/v4/ports/<uuid>` - port events or metrics `/fabric/v4/ports/<uuid>/maintenances/<uuid>` - port maintenance events `/fabric/v4/connections/<uuid>` - connection events or metrics `/fabric/v4/connections/<uuid>/maintenances/<uuid>` - connection maintenance events `/fabric/v4/routers/<uuid>` - cloud router events `/fabric/v4/metros/<metroCode>` - metro metrics `/fabric/v4/networks/<uuid>` - network events `/fabric/v4/tokens/<uuid>` - service token events `/ne/v1/acl/<uuid>` - network edge acl events `/ne/v1/devices/<uuid>` - network edge device events `/am/v2/users/<uuid>/roleAssignments/<uuid>` - identity access manager events

object (StreamSubscriptionSelector)

include	Array of strings (StreamSubscriptionSelectorExpression) <= 8 items
except	Array of strings (StreamSubscriptionSelectorExpression) <= 8 items

object (StreamSubscriptionSelector)

include	Array of strings (StreamSubscriptionSelectorExpression) <= 8 items
except	Array of strings (StreamSubscriptionSelectorExpression) <= 8 items

required

object (StreamSubscriptionSink)

Create Stream destination

uri

string

any publicly reachable http endpoint

type

required

string

Enum: "DATADOG" "DYNATRACE" "GOOGLE_PUBSUB" "PAGERDUTY" "SERVICENOW" "SLACK" "SPLUNK_HEC" "TEAMS" "WEBHOOK"

destination type

batchEnabled

boolean

batch mode on/off

batchSizeMax

integer

maximum batch size

batchWaitTimeMax

integer

maximum batch waiting time

object (StreamSubscriptionSinkCredential)

Stream subscription sink credentials

type	string Enum: "ACCESS_TOKEN" "INTEGRATION_KEY" "API_KEY" "USERNAME_PASSWORD" "API_TOKEN" credential type
accessToken	string passed as Authorization header value
integrationKey	string passed as Authorization header value
apiKey	string passed as Authorization header value
username	string passed as Authorization header value
password	string passed as Authorization header value
apiToken	string passed as Authorization header value

object (StreamSubscriptionSinkSetting)

Stream subscription sink settings

eventIndex	string event index
metricIndex	string metric index
source	string source
applicationKey	string Application key
eventUri	string event uri
metricUri	string metric uri
format	string Default: "CLOUDEVENT" Enum: "CLOUDEVENT" "OPENTELEMETRY" webhook message format

host

string

sink host

Responses

Request samples

Payload

Content type

application/json

{"type": "STREAM_SUBSCRIPTION",
"name": "splunk1",
"description": "subscription 1",
"enabled": true,
"metricSelector": {"include": ["equinix.fabric.connection.*"
]
},
"eventSelector": {"include": ["equinix.fabric.connection.*"
]
},
"sink": {"uri": "https://xxxxxx",
"type": "SPLUNK_HEC",
"credential": {"type": "ACCESS_TOKEN",
"accessToken": "my-access-token"
},
"settings": {"source": "Equinix",
"eventIndex": "idx-hec-event",
"metricIndex": "idx-hec-metric"
},
"batchEnabled": false,
"batchSizeMax": 50,
"batchWaitTimeMax": 5
}
}

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/subscriptions/d684aa26-8276-48b7-bb42-a6d9def0a418",
"uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
"type": "STREAM_SUBSCRIPTION",
"name": "stream 1",
"description": "stream dec 1",
"state": "PROVISIONED",
"enabled": true,
"metricSelector": {"include": ["equinix.fabric.connection.*"
]
},
"eventSelector": {"include": ["equinix.fabric.connection.*"
]
},
"sink": {"uri": "https://http-inputs-<host>.splunkcloud.com:<port>/services/collector/event",
"type": "SPLUNK_HEC",
"credential": {"type": "ACCESS_TOKEN",
"accessToken": "Splunk <my-access-token>"
},
"settings": {"source": "Equinix",
"eventIndex": "idx-hec-event",
"metricIndex": "idx-hec-metric"
},
"batchEnabled": false,
"batchSizeMax": 50,
"batchWaitTimeMax": 5
},
"operation": {"eventsDeliveredCount": 0,
"metricsDeliveredCount": 0,
"alertsDeliveredCount": 0,
"errors": [ ]
},
"changeLog": {"createdDateTime": "2024-05-06T16:21:18.545214Z"
}
}

Search Stream Subscriptions

This API provides capability to search stream subscriptions

Authorizations:

BearerAuth

Request Body schema: application/json
required

required

object (StreamSubscriptionSearchFilters)

required

Array of StreamSubscriptionSearchSimpleExpression (object) or StreamSubscriptionSearchOrFilter (object) (StreamSubscriptionSearchFilter) non-empty

Array (non-empty)

Any of

property	string Possible field names to use on filters: `/uuid` - Subscription uuid `/streamUuid` - Stream uuid the subscription belongs to `/state` - Subscription state (`DEPROVISIONED` returned only when explicitly requested) `/name` - Subscription name `/project/projectId` - Subscription project id `/description` - Subscription description `/changeLog/createdDateTime` - Subscription created date time `/changeLog/updatedDateTime` - Subscription updated date time
operator	string Possible operators to use on filters: `=` - equal `!=` - not equal `>` - greater than `>=` - greater than or equal to `<` - less than `<=` - less than or equal to `BETWEEN` - between `NOT BETWEEN` - not between `LIKE` - like `ILIKE` - like case-insensitive `IN` - in `NOT IN` - not in
values	Array of strings non-empty

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Array of objects (StreamSubscriptionSearchSortCriteria)

Array

direction required	string (StreamSubscriptionSearchSortDirection) Default: "DESC" Enum: "DESC" "ASC" Sorting direction
property required	string (StreamSubscriptionSearchSortBy) Default: "/changeLog/createdDateTime" Enum: "/changeLog/createdDateTime" "/changeLog/updatedDateTime" Possible field names to use on sorting

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (StreamSubscription)

Data returned from the API call.

Array

href	string <uri> Stream Subscription URI
uuid	string <uuid> Equinix-assigned access point identifier
type	string Value: "STREAM_SUBSCRIPTION" type
name	string Customer-provided subscription name
description	string Customer-provided subscription description
state	string Enum: "PROVISIONING" "PROVISIONED" "REPROVISIONING" "DEPROVISIONING" "DEPROVISIONED" "FAILED" Steam subscription provision state
enabled	boolean Stream subscription enabled status
	object (StreamSubscriptionSelector)
	object (StreamSubscriptionSelector)
	object (StreamSubscriptionSinkResponse) Create Stream destination
	object (StreamSubscriptionOperation) Stream subscription operational information
	object (Changelog) Change log

Request samples

Payload

Content type

application/json

{"filter": {"and": [{"property": "/streamUuid",
"operator": "=",
"values": ["12f4d4a1-c7cb-4def-9f77-5ce93c19d999"
]
},
{"or": [{"property": "/uuid",
"operator": "=",
"values": ["8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d"
]
},
{"property": "/name",
"operator": "ILIKE",
"values": ["demo%"
]
}
]
}
]
},
"sort": [{"direction": "DESC",
"property": "/changeLog/createdDateTime"
}
],
"pagination": {"offset": 0,
"limit": 20
}
}

Response samples

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 1
},
"data": [{"href": "https://api.equinix.com/fabric/v4/streams/12f4d4a1-c7cb-4def-9f77-5ce93c19d999/subscriptions/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d",
"uuid": "8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d",
"type": "STREAM_SUBSCRIPTION",
"name": "demo-subscription",
"description": "Subscription for demo stream events",
"state": "PROVISIONED",
"enabled": true,
"metricSelector": {"include": ["equinix.fabric.connection.*"
]
},
"eventSelector": {"include": ["equinix.fabric.connection.*"
]
},
"sink": {"uri": "https://hooks.example.com/fabric",
"type": "WEBHOOK",
"batchEnabled": false,
"batchSizeMax": 50,
"batchWaitTimeMax": 5
},
"operation": {"eventsDeliveredCount": 12,
"metricsDeliveredCount": 4,
"alertsDeliveredCount": 0,
"errors": [ ]
},
"changeLog": {"createdDateTime": "2026-06-17T10:15:30Z",
"updatedDateTime": "2026-06-18T10:15:30Z"
}
}
]
}

Stream Alert Rules

Create Stream Alert Rule

This API provides capability to create user's Stream Alert Rules

Authorizations:

BearerAuth

path Parameters

streamId

required

string <uuid>

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

Stream UUID

Request Body schema: application/json
required

type

required

string

Value: "METRIC_ALERT"

name

required

string

Customer-provided stream name

description

string

Customer-provided stream description

enabled

boolean

Default: true

Stream alert rule enabled status

required

object (MetricSelector)

include

required

Array of strings

Stream alert rule filtered by metric name

required

object (ResourceSelector)

include

required

Array of strings

Supported metric names to use on filters with property /subject:

/fabric/v4/ports/<uuid> - port metrics
/fabric/v4/connections/<uuid> - connection metrics
/fabric/v4/metros/<metroCode> - metro latency metrics

required

object (DetectionMethod)

type required	string Enum: "THRESHOLD" "OUTLIER" THRESHOLD - Alert when a metric crosses a defined threshold by user. OUTLIER - Intelligent Alert that has an outlier behavior. This option is currently supported for metro latency metric.
windowSize	string Stream alert rule metric window size
operand	string Enum: "ABOVE" "BELOW" Stream alert rule metric operand
warningThreshold	string Stream alert rule metric warning threshold
criticalThreshold	string Stream alert rule metric critical threshold

Responses

Request samples

Payload

Content type

application/json

Example

CreateStreamAlertRules

{"name": "metric-alert-1",
"type": "METRIC_ALERT",
"description": "metric-alert-1",
"enabled": true,
"metricSelector": {"include": ["equinix.fabric.connection.bandwidth_tx.usage"
]
},
"resourceSelector": {"include": ["/fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b"
]
},
"detectionMethod": {"type": "THRESHOLD",
"windowSize": "PT15M",
"warningThreshold": "35000000",
"criticalThreshold": "45000000"
}
}

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/alertRules/0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15",
"uuid": "0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15",
"type": "METRIC_ALERT",
"name": "metric-alert-1",
"description": "metric-alert-1",
"state": "ACTIVE",
"enabled": true,
"metricSelector": {"include": ["equinix.fabric.connection.bandwidth_tx.usage"
]
},
"resourceSelector": {"include": ["/fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b"
]
},
"detectionMethod": {"type": "THRESHOLD",
"windowSize": "PT15M",
"operand": "ABOVE",
"warningThreshold": "35000000",
"criticalThreshold": "45000000"
},
"changeLog": {"createdBy": "user",
"createdDateTime": "2024-05-06T16:21:18.545214Z",
"updatedBy": "user",
"updatedDateTime": "2025-02-04T00:20:54.511118575Z"
}
}

Get Stream Alert Rules

This API provides capability to retrieve stream alert rules

Authorizations:

BearerAuth

path Parameters

streamId

required

string <uuid>

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

Stream UUID

query Parameters

offset	integer Example: offset=1 offset
limit	integer Example: limit=10 number of records to fetch

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (StreamAlertRule)

Data returned from the API call.

Array

href	string <uri> Stream Alert Rule URI
uuid	string <uuid> Equinix-assigned access point identifier
type	string Value: "METRIC_ALERT" Stream subscription type
name	string Customer-provided stream alert rule name
description	string Customer-provided stream alert rule description
state	string Enum: "ACTIVE" "INACTIVE" Steam subscription provision state
enabled	boolean Default: true Stream alert rule enabled status
	object (MetricSelectorResponse)
	object (ResourceSelectorResponse)
	object (DetectionMethodResponse)
	object (Changelog) Change log

Response samples

200
401
403
404
500

Content type

application/json

{"pagination": {"offset": 0,
"limit": 20,
"total": 1
},
"data": [{"href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/alertRules/0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15",
"uuid": "0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15",
"type": "METRIC_ALERT",
"name": "metric-alert-1",
"description": "metric-alert-1",
"state": "ACTIVE",
"enabled": true,
"metricSelector": {"include": ["equinix.fabric.connection.bandwidth_tx.usage"
]
},
"resourceSelector": {"include": ["/fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b"
]
},
"detectionMethod": {"type": "THRESHOLD",
"windowSize": "PT15M",
"operand": "ABOVE",
"warningThreshold": "35000000",
"criticalThreshold": "45000000"
},
"changeLog": {"createdBy": "user",
"createdDateTime": "2024-05-06T16:21:18.545214Z"
}
}
]
}

Get Stream Alert Rule

This API provides capability to get user's stream alert rule

Authorizations:

BearerAuth

path Parameters

streamId required	string <uuid> Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 Stream UUID
alertRuleId required	string <uuid> Example: 0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15 alert rule UUID

Responses

Response Schema: application/json

href

string <uri>

Stream Alert Rule URI

uuid

string <uuid>

Equinix-assigned access point identifier

type

string

Value: "METRIC_ALERT"

Stream subscription type

name

string

Customer-provided stream alert rule name

description

string

Customer-provided stream alert rule description

state

string

Enum: "ACTIVE" "INACTIVE"

Steam subscription provision state

enabled

boolean

Default: true

Stream alert rule enabled status

object (MetricSelectorResponse)

include

Array of strings

Stream alert rule filtered by metric name

object (ResourceSelectorResponse)

include

Array of strings

Supported metric names to use on filters with property /subject:

/fabric/v4/ports/<uuid> - port metrics
/fabric/v4/connections/<uuid> - connection metrics
/fabric/v4/metros/<metroCode> - metro latency metrics

object (DetectionMethodResponse)

type	string Enum: "THRESHOLD" "OUTLIER" THRESHOLD - Alert when a metric crosses a defined threshold by user. OUTLIER - Intelligent Alert that has an outlier behavior. This option is currently supported for metro latency metric.
windowSize	string Stream alert rule metric window size
operand	string Enum: "ABOVE" "BELOW" Stream alert rule metric operand
warningThreshold	string Stream alert rule metric warning threshold
criticalThreshold	string Stream alert rule metric critical threshold

object (Changelog)

Change log

createdBy	string Created by User Key
createdByFullName	string Created by User Full Name
createdByEmail	string Created by User Email Address
createdDateTime	string <date-time> Created by Date and Time
updatedBy	string Updated by User Key
updatedByFullName	string Updated by User Full Name
updatedByEmail	string Updated by User Email Address
updatedDateTime	string <date-time> Updated by Date and Time
deletedBy	string Deleted by User Key
deletedByFullName	string Deleted by User Full Name
deletedByEmail	string Deleted by User Email Address
deletedDateTime	string <date-time> Deleted by Date and Time

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/alertRules/0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15",
"uuid": "0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15",
"type": "METRIC_ALERT",
"name": "metric-alert-1",
"description": "metric-alert-1",
"state": "ACTIVE",
"enabled": true,
"metricSelector": {"include": ["equinix.fabric.connection.bandwidth_tx.usage"
]
},
"resourceSelector": {"include": ["/fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b"
]
},
"detectionMethod": {"type": "THRESHOLD",
"windowSize": "PT15M",
"operand": "ABOVE",
"warningThreshold": "35000000",
"criticalThreshold": "45000000"
},
"changeLog": {"createdBy": "user",
"createdDateTime": "2024-05-06T16:21:18.545214Z",
"updatedBy": "user",
"updatedDateTime": "2025-02-04T00:20:54.511118575Z"
}
}

Update Stream Alert Rule

This API provides capability to update a user's stream alert rule

Authorizations:

BearerAuth

path Parameters

streamId required	string <uuid> Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 Stream UUID
alertRuleId required	string <uuid> Example: 0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15 alert rule UUID

Request Body schema: application/json
required

name

required

string

Customer-provided stream name

type

required

string

Value: "METRIC_ALERT"

description

string

Customer-provided stream description

enabled

boolean

Default: true

Stream alert rule enabled status

required

object (MetricSelector)

include

required

Array of strings

Stream alert rule filtered by metric name

required

object (ResourceSelector)

include

required

Array of strings

Supported metric names to use on filters with property /subject:

/fabric/v4/ports/<uuid> - port metrics
/fabric/v4/connections/<uuid> - connection metrics
/fabric/v4/metros/<metroCode> - metro latency metrics

required

object (DetectionMethod)

type required	string Enum: "THRESHOLD" "OUTLIER" THRESHOLD - Alert when a metric crosses a defined threshold by user. OUTLIER - Intelligent Alert that has an outlier behavior. This option is currently supported for metro latency metric.
windowSize	string Stream alert rule metric window size
operand	string Enum: "ABOVE" "BELOW" Stream alert rule metric operand
warningThreshold	string Stream alert rule metric warning threshold
criticalThreshold	string Stream alert rule metric critical threshold

Responses

Request samples

Payload

Content type

application/json

{"name": "metric-alert-1",
"type": "METRIC_ALERT",
"description": "metric-alert-1",
"enabled": true,
"metricSelector": {"include": ["equinix.fabric.connection.bandwidth_tx.usage"
]
},
"resourceSelector": {"include": ["/fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b"
]
},
"detectionMethod": {"type": "THRESHOLD",
"windowSize": "PT15M",
"operand": "ABOVE",
"warningThreshold": "35000000",
"criticalThreshold": "45000000"
}
}

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/alertRules/0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15",
"uuid": "0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15",
"type": "METRIC_ALERT",
"name": "metric-alert-1",
"description": "metric-alert-1",
"state": "ACTIVE",
"enabled": true,
"metricSelector": {"include": ["equinix.fabric.connection.bandwidth_tx.usage"
]
},
"resourceSelector": {"include": ["/fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b"
]
},
"detectionMethod": {"type": "THRESHOLD",
"windowSize": "PT15M",
"operand": "ABOVE",
"warningThreshold": "35000000",
"criticalThreshold": "45000000"
},
"changeLog": {"createdBy": "user",
"createdDateTime": "2024-05-06T16:21:18.545214Z",
"updatedBy": "user",
"updatedDateTime": "2025-02-04T00:20:54.511118575Z"
}
}

Delete Stream Alert Rule

This API provides capability to delete a user's stream alert rule

Authorizations:

BearerAuth

path Parameters

streamId required	string <uuid> Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 Stream UUID
alertRuleId required	string <uuid> Example: 0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15 alert rule UUID

Responses

Response samples

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/alertRules/0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15",
"uuid": "0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15",
"type": "METRIC_ALERT",
"name": "metric-alert-1",
"description": "metric-alert-1",
"state": "INACTIVE",
"enabled": true,
"metricSelector": {"include": ["equinix.fabric.connection.bandwidth_tx.usage"
]
},
"resourceSelector": {"include": ["/fabric/v4/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b"
]
},
"detectionMethod": {"type": "THRESHOLD",
"windowSize": "PT15M",
"operand": "ABOVE",
"warningThreshold": "35000000",
"criticalThreshold": "45000000"
},
"changeLog": {"createdBy": "user",
"createdDateTime": "2024-05-06T16:21:18.545214Z",
"updatedBy": "user",
"updatedDateTime": "2025-02-04T00:20:54.511118575Z"
}
}

Metrics

Get Metrics by Asset Id (Deprecated) Deprecated

This API provides capability to retrieve Metrics of an asset id

Authorizations:

BearerAuth

path Parameters

asset required	string (MetricAssetType) Enum: "ports" "connections" "metros" asset
assetId required	string <uuid> Example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 asset UUID

query Parameters

name required	string^equinix\.fabric\.(connection\|port\|metro)\..+... Examples: name=equinix.fabric.connection.bandwidth_rx.usage - name=equinix.fabric.connection.bandwidth_tx.usage - name=equinix.fabric.connection.packets_dropped_rx_aside_rateexceeded.count - name=equinix.fabric.connection.packets_dropped_tx_aside_rateexceeded.count - name=equinix.fabric.connection.packets_dropped_rx_zside_rateexceeded.count - name=equinix.fabric.connection.packets_dropped_tx_zside_rateexceeded.count - name=equinix.fabric.connection.byte_rx.count - name=equinix.fabric.connection.byte_tx.count - name=equinix.fabric.connection.bandwidth_rx.usage_summary - name=equinix.fabric.connection.bandwidth_tx.usage_summary - name=equinix.fabric.port.bandwidth_rx.usage - name=equinix.fabric.port.bandwidth_tx.usage - name=equinix.fabric.port.packets_dropped_rx.count - name=equinix.fabric.port.packets_dropped_tx.count - name=equinix.fabric.port.packets_erred_rx.count - name=equinix.fabric.port.packets_erred_tx.count - name=equinix.fabric.metro.sv_dc.latency - name=equinix.fabric.metro.sv_dc.jitter_avg - Name of the metric types: `equinix.fabric.connection.bandwidth_rx.usage` `equinix.fabric.connection.bandwidth_tx.usage` `equinix.fabric.connection.packets_dropped_rx_aside_rateexceeded.count` `equinix.fabric.connection.packets_dropped_tx_aside_rateexceeded.count` `equinix.fabric.connection.packets_dropped_rx_zside_rateexceeded.count` `equinix.fabric.connection.packets_dropped_tx_zside_rateexceeded.count` `equinix.fabric.connection.byte_rx.count` `equinix.fabric.connection.byte_tx.count` `equinix.fabric.connection.bandwidth_rx.usage_summary` `equinix.fabric.connection.bandwidth_tx.usage_summary` `equinix.fabric.port.bandwidth_rx.usage` `equinix.fabric.port.bandwidth_tx.usage` `equinix.fabric.port.packets_dropped_rx.count` `equinix.fabric.port.packets_dropped_tx.count` `equinix.fabric.port.packets_erred_rx.count` `equinix.fabric.port.packets_erred_tx.count` `equinix.fabric.metro.{SOURCE_METRO_CODE}_{DESTINATION_METRO_CODE}.latency` `equinix.fabric.metro.{SOURCE_METRO_CODE}_{DESTINATION_METRO_CODE}.jitter_avg`
fromDateTime	string <date-time> (StartDateTime) Example: fromDateTime=2024-07-11T18:06:21.000Z Start date and time
toDateTime	string <date-time> (EndDateTime) Example: toDateTime=2024-07-11T18:06:21.000Z End date and time
offset	integer (Offset) Default: 0 Example: offset=0 offset
limit	integer (Limit-2) Default: 20 Example: limit=20 limit

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (Metric)

Data returned from the API call.

Array

type	string Equinix supported metric type
name	string Metric name
unit	string Metric unit
interval	string Metric interval (set automatically based on search range)
	object Metric resource
summary	string Metric summary
	Array of objects Metric data points

Response samples

200
401
403
404
500

Content type

application/json

{"pagination": {"offset": 0,
"limit": 10,
"total": 2,
"next": null,
"previous": null
},
"data": [{"type": "GAUGE",
"name": "equinix.fabric.port.bandwidth_rx.usage",
"unit": "bit/s",
"interval": "PT5M",
"resource": {"href": "https://api.equinix.com/fabric/v4/ports/0689734d-25c6-40d1-a9ff-3e4edea07a72",
"uuid": "0689734d-25c6-40d1-a9ff-3e4edea07a72",
"type": "XF_PORT",
"state": "PROVISIONED",
"name": "my-port-name"
},
"summary": {"mean": 102.15384615384616,
"max": 107
},
"datapoints": [{"endDateTime": "2025-05-14T13:57:56.000Z",
"value": 107
},
{"endDateTime": "2025-05-14T14:02:48.000Z",
"value": 97
},
{"endDateTime": "2025-05-14T14:07:58.000Z",
"value": 105
},
{"endDateTime": "2025-05-14T14:12:36.000Z",
"value": 102
},
{"endDateTime": "2025-05-14T14:18:00.000Z",
"value": 96
},
{"endDateTime": "2025-05-14T14:23:03.000Z",
"value": 106
},
{"endDateTime": "2025-05-14T14:27:59.000Z",
"value": 104
},
{"endDateTime": "2025-05-14T14:32:56.000Z",
"value": 104
},
{"endDateTime": "2025-05-14T14:37:51.000Z",
"value": 103
},
{"endDateTime": "2025-05-14T14:42:59.000Z",
"value": 100
},
{"endDateTime": "2025-05-14T14:47:58.000Z",
"value": 105
},
{"endDateTime": "2025-05-14T14:53:08.000Z",
"value": 94
},
{"endDateTime": "2025-05-14T14:57:46.000Z",
"value": 105
}
]
},
{"type": "GAUGE",
"name": "equinix.fabric.port.bandwidth_tx.usage",
"unit": "bit/s",
"interval": "PT5M",
"resource": {"href": "https://api.equinix.com/fabric/v4/ports/0689734d-25c6-40d1-a9ff-3e4edea07a72",
"uuid": "0689734d-25c6-40d1-a9ff-3e4edea07a72"
},
"summary": {"mean": 255.92307692307693,
"max": 295
},
"datapoints": [{"endDateTime": "2025-05-14T13:57:56.000Z",
"value": 259
},
{"endDateTime": "2025-05-14T14:02:48.000Z",
"value": 234
},
{"endDateTime": "2025-05-14T14:07:58.000Z",
"value": 242
},
{"endDateTime": "2025-05-14T14:12:36.000Z",
"value": 280
},
{"endDateTime": "2025-05-14T14:18:00.000Z",
"value": 243
},
{"endDateTime": "2025-05-14T14:23:03.000Z",
"value": 262
},
{"endDateTime": "2025-05-14T14:27:59.000Z",
"value": 247
},
{"endDateTime": "2025-05-14T14:32:56.000Z",
"value": 295
},
{"endDateTime": "2025-05-14T14:37:51.000Z",
"value": 284
},
{"endDateTime": "2025-05-14T14:42:59.000Z",
"value": 227
},
{"endDateTime": "2025-05-14T14:47:58.000Z",
"value": 260
},
{"endDateTime": "2025-05-14T14:53:08.000Z",
"value": 251
},
{"endDateTime": "2025-05-14T14:57:46.000Z",
"value": 243
}
]
}
]
}

Get Metrics by Name

This API provides capability to retrieve Metrics by specific wildcard metric types

Authorizations:

BearerAuth

query Parameters

name required	string^equinix\.fabric\.metro\.\\..+ Examples: name=equinix.fabric.metro..latency - name=equinix.fabric.metro..jitter_avg - Name of the metric types with wildcard: `equinix.fabric.metro..latency` `equinix.fabric.metro.*.jitter_avg`
value required	string (Value) Example: value=last value
offset	integer (Offset) Default: 0 Example: offset=0 offset
limit	integer (Limit-2) Default: 20 Example: limit=20 limit

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (Metric)

Data returned from the API call.

Array

type	string Equinix supported metric type
name	string Metric name
unit	string Metric unit
interval	string Metric interval (set automatically based on search range)
	object Metric resource
summary	string Metric summary
	Array of objects Metric data points

Response samples

200
401
403
404
500

Content type

application/json

{"pagination": {"offset": 0,
"limit": 5000,
"total": 3
},
"data": [{"type": "GAUGE",
"name": "equinix.fabric.metro.at_am.latency",
"unit": "ms",
"resource": {"href": "https://uatapi.equinix.com/fabric/v4/metros/AT",
"type": "XF_METRO",
"description": "Atlanta to Amsterdam intermetro latency, average in milliseconds"
},
"datapoints": [{"endDateTime": "2026-02-03T23:05:04Z",
"value": 94.8
}
]
},
{"type": "GAUGE",
"name": "equinix.fabric.metro.at_ba.latency",
"unit": "ms",
"resource": {"href": "https://uatapi.equinix.com/fabric/v4/metros/AT",
"type": "XF_METRO",
"description": "Atlanta to Barcelona intermetro latency, average in milliseconds"
},
"datapoints": [{"endDateTime": "2026-02-03T23:05:04Z",
"value": 111
}
]
},
{"type": "GAUGE",
"name": "equinix.fabric.metro.at_bg.latency",
"unit": "ms",
"resource": {"href": "https://uatapi.equinix.com/fabric/v4/metros/AT",
"type": "XF_METRO",
"description": "Atlanta to Bogota intermetro latency, average in milliseconds"
},
"datapoints": [{"endDateTime": "2026-02-03T23:05:04Z",
"value": 69.8
}
]
}
]
}

Search Metrics

This API provides capability to search metrics from a filtered query

Authorizations:

BearerAuth

Request Body schema: application/json
required

required

object (MetricFilters)

Array of MetricSimpleExpression (object) (MetricFilter)

Array

Any of

property	string Possible field names to use on filters: `/subject` - Metric subject description (required and limited to 1 value) `/name` - Metric names (required) `/dataPoints/endDateTime` - Time of Metrics `/time` - Time of Metrics `/interval` - ISO-8601 duration format to specify the interval of metrics data points `/value` - specific data points of the metric to return (e.g. 'last' - for metros only)
operator	string Possible operators to use on filters: `=` - equal `>` - greater than `>=` - greater than or equal to `<` - less than `<=` - less than or equal to `BETWEEN` - between `IN` - in
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (Metric)

Data returned from the API call.

Array

type	string Equinix supported metric type
name	string Metric name
unit	string Metric unit
interval	string Metric interval (set automatically based on search range)
	object Metric resource
summary	string Metric summary
	Array of objects Metric data points

Request samples

Payload

Content type

application/json

{"filter": {"and": [{"property": "/subject",
"operator": "=",
"values": ["/fabric/v4/ports/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d"
]
},
{"property": "/name",
"operator": "IN",
"values": ["equinix.fabric.port.bandwidth_rx.usage",
"equinix.fabric.port.bandwidth_tx.usage",
"equinix.fabric.port.packets_dropped_rx.count",
"equinix.fabric.port.packets_dropped_tx.count"
]
},
{"property": "/dataPoints/endDateTime",
"operator": "BETWEEN",
"values": ["2025-09-01T19:19:50Z",
"2025-09-03T19:19:50Z"
]
}
]
},
"pagination": {"offset": 0,
"limit": 10
}
}

Response samples

200
401
403
404
500

Content type

application/json

{"pagination": {"offset": 0,
"limit": 10,
"total": 2,
"next": null,
"previous": null
},
"data": [{"type": "GAUGE",
"name": "equinix.fabric.port.bandwidth_rx.usage",
"unit": "bit/s",
"interval": "PT5M",
"resource": {"href": "https://api.equinix.com/fabric/v4/ports/0689734d-25c6-40d1-a9ff-3e4edea07a72",
"uuid": "0689734d-25c6-40d1-a9ff-3e4edea07a72",
"type": "XF_PORT",
"state": "PROVISIONED",
"name": "my-port-name"
},
"summary": {"mean": 102.15384615384616,
"max": 107
},
"datapoints": [{"endDateTime": "2025-05-14T13:57:56.000Z",
"value": 107
},
{"endDateTime": "2025-05-14T14:02:48.000Z",
"value": 97
},
{"endDateTime": "2025-05-14T14:07:58.000Z",
"value": 105
},
{"endDateTime": "2025-05-14T14:12:36.000Z",
"value": 102
},
{"endDateTime": "2025-05-14T14:18:00.000Z",
"value": 96
},
{"endDateTime": "2025-05-14T14:23:03.000Z",
"value": 106
},
{"endDateTime": "2025-05-14T14:27:59.000Z",
"value": 104
},
{"endDateTime": "2025-05-14T14:32:56.000Z",
"value": 104
},
{"endDateTime": "2025-05-14T14:37:51.000Z",
"value": 103
},
{"endDateTime": "2025-05-14T14:42:59.000Z",
"value": 100
},
{"endDateTime": "2025-05-14T14:47:58.000Z",
"value": 105
},
{"endDateTime": "2025-05-14T14:53:08.000Z",
"value": 94
},
{"endDateTime": "2025-05-14T14:57:46.000Z",
"value": 105
}
]
},
{"type": "GAUGE",
"name": "equinix.fabric.port.bandwidth_tx.usage",
"unit": "bit/s",
"interval": "PT5M",
"resource": {"href": "https://api.equinix.com/fabric/v4/ports/0689734d-25c6-40d1-a9ff-3e4edea07a72",
"uuid": "0689734d-25c6-40d1-a9ff-3e4edea07a72"
},
"summary": {"mean": 255.92307692307693,
"max": 295
},
"datapoints": [{"endDateTime": "2025-05-14T13:57:56.000Z",
"value": 259
},
{"endDateTime": "2025-05-14T14:02:48.000Z",
"value": 234
},
{"endDateTime": "2025-05-14T14:07:58.000Z",
"value": 242
},
{"endDateTime": "2025-05-14T14:12:36.000Z",
"value": 280
},
{"endDateTime": "2025-05-14T14:18:00.000Z",
"value": 243
},
{"endDateTime": "2025-05-14T14:23:03.000Z",
"value": 262
},
{"endDateTime": "2025-05-14T14:27:59.000Z",
"value": 247
},
{"endDateTime": "2025-05-14T14:32:56.000Z",
"value": 295
},
{"endDateTime": "2025-05-14T14:37:51.000Z",
"value": 284
},
{"endDateTime": "2025-05-14T14:42:59.000Z",
"value": 227
},
{"endDateTime": "2025-05-14T14:47:58.000Z",
"value": 260
},
{"endDateTime": "2025-05-14T14:53:08.000Z",
"value": 251
},
{"endDateTime": "2025-05-14T14:57:46.000Z",
"value": 243
}
]
}
]
}

Statistics

Get Stats by ID (DEPRECATED) Deprecated

This API provides service-level traffic metrics so that you can view access and gather key information required to manage service subscription sizing and capacity.(DEPRECATED)

Authorizations:

BearerAuth

path Parameters

portId

required

string <uuid>

Port UUID

query Parameters

startDateTime required	string <date-time> (startDateTime) Example: startDateTime=2020-11-06T07:00:00Z startDateTime
endDateTime required	string <date-time> (endDateTime) Example: endDateTime=2020-11-10T07:00:00Z endDateTime

Responses

Response Schema: application/json

startDateTime

string <date-time>

Start and duration of the statistical analysis interval.

endDateTime

string <date-time>

End and duration of the statistical analysis interval.

viewPoint

string

Enum: "aSide" "zSide"

Point of view for connection metrics - aSide or zSide

object (BandwidthUtilization)

Bandwidth utilization statistics (octet counters-based)

unit

string

Value: "Mbps"

Aggregated data transfer capacity. Possible values- Mbps, megabits (1 million bits) per second; Gbps, gigabits (1 billion bits) per second.

metricInterval

string

An interval formatted value, indicating the time-interval the metric objects within the response represent

object (Direction)

Directional statistics

max	number <float> Max bandwidth within request time range, represented in units specified by response "units" field
mean	number <float> Mean bandwidth within request time range, represented in units specified by response "units" field
	Array of objects (Metrics) Bandwidth utilization statistics for a specified interval.

object (Direction)

Directional statistics

max	number <float> Max bandwidth within request time range, represented in units specified by response "units" field
mean	number <float> Mean bandwidth within request time range, represented in units specified by response "units" field
	Array of objects (Metrics) Bandwidth utilization statistics for a specified interval.

Response samples

200
401
403
500

Content type

application/json

{"href": "http://api.equinix.com/fabric/v4/ports/xxxxx191-xx70-xxxx-xx04-xxxxxxxa37xx",
"type": "XF_PORT",
"uuid": "xxxxx191-xx70-xxxx-xx04-xxxxxxxa37xx",
"name": "Equinix-EM-CX-xxx-L-Dot1q-BO-100G-PRI-xx",
"bandwidthUtilization": 10000,
"stats": {"startDateTime": "2020-05-21T08:00:00Z",
"endDateTime": "2020-05-21T10:30:00Z",
"bandwidthUtilization": {"unit": "Mbps",
"metricInterval": "PT5M",
"inbound": {"max": 68.00905623111112,
"mean": 48.90562310112,
"lastPolled": 41.00905623111112,
"metrics": [{"intervalEndDateTime": "2020-05-21T10:30:00Z",
"max": 45.5623145112009,
"mean": 31.38641687333333
}
]
},
"outbound": {"max": 41.99068261111111,
"mean": 33.70374303096296,
"lastPolled": 41.43428905111111,
"metrics": [{"intervalEndDateTime": "2020-05-21T10:30:00Z",
"max": 42.01401189333334,
"mean": 39.40894303096296
}
]
}
}
}
}

Get Stats by ID (DEPRECATED) Deprecated

This API provides service-level metrics so that you can view access and gather key information required to manage service subscription sizing and capacity (DEPRECATED)

Authorizations:

BearerAuth

path Parameters

connectionId

required

string

Connection UUID

query Parameters

startDateTime required	string <date-time> (startDateTime) Example: startDateTime=2020-11-06T07:00:00Z startDateTime
endDateTime required	string <date-time> (endDateTime) Example: endDateTime=2020-11-10T07:00:00Z endDateTime
viewPoint required	string (viewPoint) Enum: "aSide" "zSide" Example: viewPoint=aSide viewPoint

Responses

Response Schema: application/json

startDateTime

string <date-time>

Start and duration of the statistical analysis interval.

endDateTime

string <date-time>

End and duration of the statistical analysis interval.

viewPoint

string

Enum: "aSide" "zSide"

Point of view for connection metrics - aSide or zSide

object (BandwidthUtilization)

Bandwidth utilization statistics (octet counters-based)

unit

string

Value: "Mbps"

Aggregated data transfer capacity. Possible values- Mbps, megabits (1 million bits) per second; Gbps, gigabits (1 billion bits) per second.

metricInterval

string

An interval formatted value, indicating the time-interval the metric objects within the response represent

object (Direction)

Directional statistics

max	number <float> Max bandwidth within request time range, represented in units specified by response "units" field
mean	number <float> Mean bandwidth within request time range, represented in units specified by response "units" field
	Array of objects (Metrics) Bandwidth utilization statistics for a specified interval.

object (Direction)

Directional statistics

max	number <float> Max bandwidth within request time range, represented in units specified by response "units" field
mean	number <float> Mean bandwidth within request time range, represented in units specified by response "units" field
	Array of objects (Metrics) Bandwidth utilization statistics for a specified interval.

Response samples

200
401
403

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/connections/97d1850f-4df0-468c-9281-fa7b0dfa2096",
"type": "EVPL_VC",
"uuid": "97d1850f-4df0-468c-9281-fa7b0dfa2096",
"name": "Admin-STATS-123-Abc",
"stats": {"startDateTime": "2021-01-10T20:05:08Z",
"endDateTime": "2021-01-10T21:05:08Z",
"viewPoint": "aSide",
"bandwidthUtilization": {"unit": "Mbps",
"metricInterval": "PT5M",
"inbound": {"max": 68.38641687333333,
"mean": 39.96267986650665,
"lastPolled": 41.00905623111112,
"metrics": [{"intervalEndDateTime": "2021-01-10T20:05:00Z",
"max": 41.89234537555556,
"mean": 33.62481298948148
},
{"intervalEndDateTime": "2021-01-10T20:10:00Z",
"max": 41.86234987534256,
"mean": 36.92451598748148
},
{"intervalEndDateTime": "2021-01-10T20:15:00Z",
"max": 41.86907222888888,
"mean": 43.98230834555556
},
{"intervalEndDateTime": "2021-01-10T20:20:00Z",
"max": 41.91562025333334,
"mean": 41.086565260765425
}
]
},
"outbound": {"max": 67.79944363333334,
"mean": 38.116581250214345,
"lastPolled": 41.43428905111111,
"metrics": [{"intervalEndDateTime": "2021-01-10T20:05:00Z",
"max": 41.99068261111111,
"mean": 33.70374303096296
},
{"intervalEndDateTime": "2021-01-10T20:10:00Z",
"max": 42.56065261666111,
"mean": 31.52464373892222
},
{"intervalEndDateTime": "2021-01-10T20:15:00Z",
"max": 41.96735416222222,
"mean": 44.08555118977779
},
{"intervalEndDateTime": "2021-01-10T20:20:00Z",
"max": 42.01401189333334,
"mean": 39.40894303096296
}
]
}
}
}
}

Events

Get Cloud Events by Asset Id (Deprecated) Deprecated

This API provides capability to retrieve cloud events of an asset id

Authorizations:

BearerAuth

path Parameters

asset required	string (CloudEventAssetType) Enum: "ports" "connections" "routers" "metros" "serviceTokens" "networks" "projects" "organizations" "timeServices" "companyProfiles" asset
assetId required	string <uuid> Example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 asset UUID

query Parameters

fromDateTime	string <date-time> (StartDateTime) Example: fromDateTime=2024-07-11T18:06:21.000Z Start date and time
toDateTime	string <date-time> (EndDateTime) Example: toDateTime=2024-07-11T18:06:21.000Z End date and time
offset	integer (Offset) Default: 0 Example: offset=0 offset
limit	integer (Limit) Default: 100 Example: limit=20 limit

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (CloudEvent)

Data returned from the API call.

Array

specversion	string Cloud Event Open Telemetry specification
source	string Cloud Event source
id	string <uuid> Cloud Event identifier
type	string Equinix supported event type
subject	string Cloud Event subject
time	string <date-time> Cloud Event time the event occurred
dataschema	string Cloud Event dataschema reference
datacontenttype	string Cloud Event data content type
severitynumber	string Cloud Event severity number
severitytext	string Cloud Event severity text
equinixalert	string Equinix alert
equinixorganization	string Equinix organization identifier
equinixproject	string Equinix project identifier
authtype	string Cloud Event auth type
authid	string Cloud Event user identifier
traceparent	string Cloud Event traceparent
tracestate	string Cloud Event tracestate
	object (CloudEventData)

Response samples

200
401
403
404
500

Content type

application/json

{"pagination": {"offset": 20,
"limit": 10,
"total": 3,
"next": null,
"previous": null
},
"data": [{"specversion": "1.0",
"source": "https://api.equinix.com/fabric/v4/events",
"id": "66c62c1a-f186-4fbd-9792-71a60705518f",
"time": "2025-03-20T13:13:12Z",
"type": "equinix.fabric.connection.bgpipv4_session_status.connect",
"subject": "/fabric/v4/connections/dab9fc84-cc95-4cb4-abe3-ca39361285a9/routingProtocol/e92cdf09-59eb-4131-ade4-49a87dc816dc",
"dataschema": "https://equinix.github.io/equinix-cloudevents/jsonschema/equinix/fabric/v1/ChangeEvent.json",
"datacontenttype": "application/json",
"severitynumber": "5",
"severitytext": "INFO",
"equinixproject": "dadd3ab6-c0af-430c-8216-43d44f08c1c5",
"authtype": "system",
"authid": "equinix",
"traceparent": "00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00,",
"tracestate": "71a60705518f,81a607055181",
"data": {"message": "Neighbor 100.100.100.102 address session state changed to Connect",
"auth": {"authtype": "system",
"authid": "equinix"
}
}
},
{"specversion": "1.0",
"source": "https://api.equinix.com/fabric/v4/cloudevents",
"id": "66c62c1a-f186-4fbd-9792-71a60705518f",
"type": "equinix.fabric.connection.state.provisioning",
"subject": "/fabric/v4/connections/dab9fc84-cc95-4cb4-abe3-ca39361285a9",
"time": "2025-03-20T13:13:12Z",
"dataschema": "https://equinix.github.io/equinix-cloudevents/jsonschema/equinix/fabric/v1/ChangeEvent.json",
"datacontenttype": "application/json",
"severitynumber": "9",
"severitytext": "INFO",
"equinixproject": "dadd3ab6-c0af-430c-8216-43d44f08c1c5",
"authtype": "user",
"authid": "123456",
"traceparent": "00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00,",
"tracestate": "71a60705518f,81a607055181",
"data": {"message": "Connection named TEST-CONNECTION state changed to provisioning",
"resource": {"href": "http://api.corp.equinix.com/fabric/v4/connections/dab9fc84-cc95-4cb4-abe3-ca39361285a9",
"uuid": "dab9fc84-cc95-4cb4-abe3-ca39361285a9",
"type": "IP_VC",
"name": "TEST-CONNECTION",
"state": "PROVISIONING"
},
"auth": {"authtype": "user",
"authid": "123456",
"name": "test user",
"email": "testuser@test.com"
}
}
},
{"specversion": "1.0",
"source": "https://api.equinix.com/fabric/v4/cloudevents",
"id": "66c62c1a-f186-4fbd-9792-71a60705518f",
"type": "equinix.fabric.connection.state.provisioned",
"subject": "/fabric/v4/connections/dab9fc84-cc95-4cb4-abe3-ca39361285a9",
"time": "2025-03-20T13:13:12Z",
"dataschema": "https://equinix.github.io/equinix-cloudevents/jsonschema/equinix/fabric/v1/ChangeEvent.json",
"datacontenttype": "application/json",
"severitynumber": "9",
"severitytext": "INFO",
"equinixproject": "dadd3ab6-c0af-430c-8216-43d44f08c1c5",
"authtype": "system",
"authid": "equinix",
"traceparent": "00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00,",
"tracestate": "71a60705518f,81a607055181",
"data": {"message": "Connection named TEST-CONNECTION state changed to provisioned",
"resource": {"href": "http://api.corp.equinix.com/fabric/v4/connections/dab9fc84-cc95-4cb4-abe3-ca39361285a9",
"uuid": "dab9fc84-cc95-4cb4-abe3-ca39361285a9",
"type": "IP_VC",
"name": "TEST-CONNECTION",
"state": "PROVISIONED"
},
"auth": {"authtype": "system",
"authid": "equinix"
}
}
}
]
}

Get Cloud Event

This API provides capability to retrieve a cloud event by uuid

Authorizations:

BearerAuth

path Parameters

cloudEventId

required

string <uuid>

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

Cloud Event UUID

Responses

Response Schema: application/json

specversion

string

Cloud Event Open Telemetry specification

source

string

Cloud Event source

id

string <uuid>

Cloud Event identifier

type

string

Equinix supported event type

subject

string

Cloud Event subject

time

string <date-time>

Cloud Event time the event occurred

dataschema

string

Cloud Event dataschema reference

datacontenttype

string

Cloud Event data content type

severitynumber

string

Cloud Event severity number

severitytext

string

Cloud Event severity text

equinixalert

string

Equinix alert

equinixorganization

string

Equinix organization identifier

equinixproject

string

Equinix project identifier

authtype

string

Cloud Event auth type

authid

string

Cloud Event user identifier

traceparent

string

Cloud Event traceparent

tracestate

string

Cloud Event tracestate

object (CloudEventData)

message

string

Cloud Event message

object (ResourceData)

href	string Cloud Event asset href
uuid	string Cloud Event asset uuid
type	string Cloud Event asset type
name	string Cloud Event asset name
state	string Cloud Event asset state
	object (OperationalStatus)

object (AuthContext)

authtype	string Enum: "system" "user" Cloud Event auth type
authid	string Enum: "equinix" "userId" Cloud Event auth identifier
name	string Cloud Event username
email	string Cloud Event email

Response samples

200
401
403
404
500

Content type

application/json

{"specversion": "1.0",
"source": "https://api.equinix.com/fabric/v4/cloudevents",
"id": "66c62c1a-f186-4fbd-9792-71a60705518f",
"type": "equinix.fabric.connection.state.provisioning",
"subject": "/fabric/v4/connections/dab9fc84-cc95-4cb4-abe3-ca39361285a9",
"time": "2025-03-20T13:13:12Z",
"dataschema": "https://equinix.github.io/equinix-cloudevents/jsonschema/equinix/fabric/v1/ChangeEvent.json",
"datacontenttype": "application/json",
"severitynumber": "9",
"severitytext": "INFO",
"equinixproject": "dadd3ab6-c0af-430c-8216-43d44f08c1c5",
"authtype": "user",
"authid": "123456",
"traceparent": "00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00,",
"tracestate": "71a60705518f,81a607055181",
"data": {"message": "Connection named TEST-CONNECTION state changed to provisioning",
"resource": {"href": "http://api.corp.equinix.com/fabric/v4/connections/dab9fc84-cc95-4cb4-abe3-ca39361285a9",
"uuid": "dab9fc84-cc95-4cb4-abe3-ca39361285a9",
"type": "IP_VC",
"name": "TEST-CONNECTION",
"state": "PROVISIONING"
},
"auth": {"authtype": "user",
"authid": "123456",
"name": "test user",
"email": "testuser@test.com"
}
}
}

Search Cloud Events

This API provides capability to search cloud events from a filtered query

Authorizations:

BearerAuth

Request Body schema: application/json
required

required

object (CloudEventFilters)

Array of CloudEventSimpleExpression (object) (CloudEventFilter)

Array

Any of

property	string Possible field names to use on filters: `/id` - Cloud Event identifier `/subject` - Cloud Event subject description `/type` - Cloud Event type `/time` - Time of Cloud Events `/equinixproject` - Equinix Project of Cloud Events `/equinixorganization` - Equinix Organization of Cloud Events `/equinixalert` - Equinix Alert Identifier for raise/clear Cloud Events `/severitytext` - cloud event severity text `/authid` - Equinix user key to identify the user that performed the action that triggered the Cloud Event `/authtype` - Equinix user type either user or system
operator	string Possible operators to use on filters: `=` - equal `!=` - not equal `>` - greater than `>=` - greater than or equal to `<` - less than `<=` - less than or equal to `BETWEEN` - between `IN` - in `LIKE` - like `ILIKE` - like case-insensitive `IS NULL` - is null `IS NOT NULL` - is not null
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (CloudEvent)

Data returned from the API call.

Array

specversion	string Cloud Event Open Telemetry specification
source	string Cloud Event source
id	string <uuid> Cloud Event identifier
type	string Equinix supported event type
subject	string Cloud Event subject
time	string <date-time> Cloud Event time the event occurred
dataschema	string Cloud Event dataschema reference
datacontenttype	string Cloud Event data content type
severitynumber	string Cloud Event severity number
severitytext	string Cloud Event severity text
equinixalert	string Equinix alert
equinixorganization	string Equinix organization identifier
equinixproject	string Equinix project identifier
authtype	string Cloud Event auth type
authid	string Cloud Event user identifier
traceparent	string Cloud Event traceparent
tracestate	string Cloud Event tracestate
	object (CloudEventData)

Request samples

Payload

Content type

application/json

{"filter": {"and": [{"property": "/type",
"operator": "IN",
"values": ["equinix.fabric.port.status.*"
]
},
{"property": "/subject",
"operator": "IN",
"values": ["/fabric/v4/ports/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d*",
"/fabric/v4/ports/c8bba3be-5132-4669-bb47-7f1a8811359b*"
]
},
{"property": "/equinixorganization",
"operator": "=",
"values": ["526698000597331"
]
},
{"property": "/equinixproject",
"operator": "=",
"values": ["dadd3ab6-c0af-430c-8216-43d44f08c1c5"
]
},
{"property": "/time",
"operator": ">",
"values": ["2018-04-05T17:31:00.000Z"
]
}
]
},
"pagination": {"offset": 0,
"limit": 20
}
}

Response samples

200
401
403
404
500

Content type

application/json

{"pagination": {"offset": 20,
"limit": 10,
"total": 3,
"next": null,
"previous": null
},
"data": [{"specversion": "1.0",
"source": "https://api.equinix.com/fabric/v4/events",
"id": "66c62c1a-f186-4fbd-9792-71a60705518f",
"time": "2025-03-20T13:13:12Z",
"type": "equinix.fabric.connection.bgpipv4_session_status.connect",
"subject": "/fabric/v4/connections/dab9fc84-cc95-4cb4-abe3-ca39361285a9/routingProtocol/e92cdf09-59eb-4131-ade4-49a87dc816dc",
"dataschema": "https://equinix.github.io/equinix-cloudevents/jsonschema/equinix/fabric/v1/ChangeEvent.json",
"datacontenttype": "application/json",
"severitynumber": "5",
"severitytext": "INFO",
"equinixproject": "dadd3ab6-c0af-430c-8216-43d44f08c1c5",
"authtype": "system",
"authid": "equinix",
"traceparent": "00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00,",
"tracestate": "71a60705518f,81a607055181",
"data": {"message": "Neighbor 100.100.100.102 address session state changed to Connect",
"auth": {"authtype": "system",
"authid": "equinix"
}
}
},
{"specversion": "1.0",
"source": "https://api.equinix.com/fabric/v4/cloudevents",
"id": "66c62c1a-f186-4fbd-9792-71a60705518f",
"type": "equinix.fabric.connection.state.provisioning",
"subject": "/fabric/v4/connections/dab9fc84-cc95-4cb4-abe3-ca39361285a9",
"time": "2025-03-20T13:13:12Z",
"dataschema": "https://equinix.github.io/equinix-cloudevents/jsonschema/equinix/fabric/v1/ChangeEvent.json",
"datacontenttype": "application/json",
"severitynumber": "9",
"severitytext": "INFO",
"equinixproject": "dadd3ab6-c0af-430c-8216-43d44f08c1c5",
"authtype": "user",
"authid": "123456",
"traceparent": "00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00,",
"tracestate": "71a60705518f,81a607055181",
"data": {"message": "Connection named TEST-CONNECTION state changed to provisioning",
"resource": {"href": "http://api.corp.equinix.com/fabric/v4/connections/dab9fc84-cc95-4cb4-abe3-ca39361285a9",
"uuid": "dab9fc84-cc95-4cb4-abe3-ca39361285a9",
"type": "IP_VC",
"name": "TEST-CONNECTION",
"state": "PROVISIONING"
},
"auth": {"authtype": "user",
"authid": "123456",
"name": "test user",
"email": "testuser@test.com"
}
}
},
{"specversion": "1.0",
"source": "https://api.equinix.com/fabric/v4/cloudevents",
"id": "66c62c1a-f186-4fbd-9792-71a60705518f",
"type": "equinix.fabric.connection.state.provisioned",
"subject": "/fabric/v4/connections/dab9fc84-cc95-4cb4-abe3-ca39361285a9",
"time": "2025-03-20T13:13:12Z",
"dataschema": "https://equinix.github.io/equinix-cloudevents/jsonschema/equinix/fabric/v1/ChangeEvent.json",
"datacontenttype": "application/json",
"severitynumber": "9",
"severitytext": "INFO",
"equinixproject": "dadd3ab6-c0af-430c-8216-43d44f08c1c5",
"authtype": "system",
"authid": "equinix",
"traceparent": "00-66c62c1af1864fbd979271a60705518f-00f067aa0ba90111-00,",
"tracestate": "71a60705518f,81a607055181",
"data": {"message": "Connection named TEST-CONNECTION state changed to provisioned",
"resource": {"href": "http://api.corp.equinix.com/fabric/v4/connections/dab9fc84-cc95-4cb4-abe3-ca39361285a9",
"uuid": "dab9fc84-cc95-4cb4-abe3-ca39361285a9",
"type": "IP_VC",
"name": "TEST-CONNECTION",
"state": "PROVISIONED"
},
"auth": {"authtype": "system",
"authid": "equinix"
}
}
}
]
}

Search last Operational Cloud Events

This API provides capability to search last operational cloud events from a filtered query

Authorizations:

BearerAuth

Request Body schema: application/json
required

object (LiveEventFilters)

Array of LiveEventSimpleExpression (object) (LiveEventFilter)

Array

Any of

property	string Possible field names to use on filters: `/subject` - Cloud Event subject description
operator	string Possible operators to use on filters: `=` - equal `IN` - in
values	Array of strings

object (PaginationRequest)

Pagination request information

offset	integer >= 0 Default: 0 Index of the first element.
limit	integer >= 1 Default: 20 Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20.

Responses

Response Schema: application/json

object (Pagination)

Pagination response information

offset	integer >= 0 Default: 0 Index of the first item returned in the response. The default is 0.
limit required	integer >= 0 Default: 20 Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20.
total required	integer >= 0 Total number of elements returned.
next	string URL relative to the next item in the response.
previous	string URL relative to the previous item in the response.

Array of objects (CloudEvent)

Data returned from the API call.

Array

specversion	string Cloud Event Open Telemetry specification
source	string Cloud Event source
id	string <uuid> Cloud Event identifier
type	string Equinix supported event type
subject	string Cloud Event subject
time	string <date-time> Cloud Event time the event occurred
dataschema	string Cloud Event dataschema reference
datacontenttype	string Cloud Event data content type
severitynumber	string Cloud Event severity number
severitytext	string Cloud Event severity text
equinixalert	string Equinix alert
equinixorganization	string Equinix organization identifier
equinixproject	string Equinix project identifier
authtype	string Cloud Event auth type
authid	string Cloud Event user identifier
traceparent	string Cloud Event traceparent
tracestate	string Cloud Event tracestate
	object (CloudEventData)

Request samples

Payload

Content type

application/json

{"filter": {"and": [{"property": "/subject",
"operator": "IN",
"values": ["/fabric/v4/ports/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d"
]
}
]
},
"pagination": {"offset": 0,
"limit": 2
}
}

Response samples

200
401
403
404
500

Content type

application/json

{"pagination": {"offset": 0,
"limit": 2,
"total": 1
},
"data": [{"specversion": "1.0",
"source": "https://api.equinix.com/fabric/v4/cloudevents",
"id": "6c573287-9914-4202-8b6d-2d15e7da04b8",
"type": "equinix.fabric.port.status.down",
"subject": "/fabric/v4/ports/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d",
"time": "2018-04-05T17:31:00.000Z",
"dataschema": "https://equinix.github.io/equinix-cloudevents/jsonschema/equinix/fabric/v1/ChangeEvent.json",
"datacontenttype": "application/json",
"severitynumber": "21",
"severitytext": "FATAL",
"equinixalert": "raise/AABBcCCDDeEfFf123,",
"equinixproject": "project-123",
"data": {"message": "Virtual port 'port-name' status changed to DOWN",
"resource": {"href": "https://api.equinix.com//fabric/v4/ports/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d",
"uuid": "8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d",
"type": "XF_PORT",
"state": "PROVISIONED",
"operation": {"operationalStatus": "DOWN"
}
}
}
}
]
}

Health

Get Service Status

Retrieves the operational health status of all Equinix Fabric services, enabling customers to monitor service availability and detect potential disruptions across regions where they have a presence. Supports an optional query parameter to filter results by customer

Authorizations:

BearerAuth

Responses

Response Schema: application/json

href

string

The Canonical URL at which the resource resides.

version

string

Indicator of a version

release

string

release details.

state

string

status of a service

object (ApiServices)

Available services details

route	string service routes
status	string service status
changedDateTime	string service status change date

Response samples

200

Content type

application/json

{"href": "https://api.equinix.com/fabric/v4/health",
"version": "4.4",
"release": "2022.4.0",
"state": "HEALTHY",
"apiServices": [{"route": "/prices",
"status": "UP",
"changedDateTime": "2022-10-03T18:37:54.760+00:00"
},
{"route": "/connections",
"status": "UP",
"changedDateTime": "2022-10-03T18:37:56.818+00:00"
},
{"route": "/ports",
"status": "UP",
"changedDateTime": "2022-10-03T18:37:56.886+00:00"
},
{"route": "/serviceTokens",
"status": "UP",
"changedDateTime": "2022-10-03T18:37:56.919+00:00"
},
{"route": "/stats",
"status": "UP",
"changedDateTime": "2022-10-03T18:37:56.951+00:00"
},
{"route": "/routers",
"status": "UP",
"changedDateTime": "2022-10-03T18:37:57.271+00:00"
},
{"route": "/serviceProfiles",
"status": "UP",
"changedDateTime": "2022-10-03T18:38:01.298+00:00"
}
]
}

type	Array of strings Filter by tag type
offset	integer <int32> Default: 0 Offset for pagination
limit	integer <int32> <= 100 Default: 20 Limit for pagination

Equinix Fabric API v4 (4.34.0)

Ports

Get All Ports

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

Create Port

Authorizations:

query Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Add to Lag

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Get Port by ID

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Delete Port

Authorizations:

path Parameters

query Parameters

Responses

Response Schema: application/json

Response samples

Update Port by ID

Authorizations:

path Parameters

query Parameters

Request Body schema: application/json-patch+jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Get Vlans

Authorizations:

path Parameters

query Parameters

Responses

Response Schema: application/json

Response samples

Search Ports

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Port Packages

List Port Packages

Authorizations:

Responses

Response Schema: application/json

Response samples

Connections

Create Connection

Authorizations:

query Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Response Schema: application/json

Request samples

Response samples

Get Connection by ID

Authorizations:

path Parameters

query Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json-patch+json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json-patch+json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json-patch+json
required

Request Body schema: application/json
required