Fabric v4 APIs

Connections

Create Connection

	POST /fabric/v4/connections
Method	POST
URL or Endpoint	/fabric/v4/connections
Headers	Authorization, Content-Type
Path Parameters	Not applicable
Query Parameters	Not applicable
Body Parameters	type, name, order, bandwidth, aSide, zSide, notifications

The POST Connections API request creates a layer 2 connection between two endpoints located in IBX data centers.

For detailed instructions covering a specific use case, refer to a corresponding Getting Started information:

Sample curl request - non-redundant connection from a DOT1Q port to a QINQ port

curl -X
POST 'https://api.equinix.com/fabric/v4/connections'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "type": "EVPL_VC",
    "name": "Conn-1",
    "order": {
        "purchaseOrderNumber": "1-129105284100"
    },
    "bandwidth": 1000,
    "aSide": {
        "accessPoint": {
            "type": "COLO",
            "port": {
                "uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
            },
            "linkProtocol": {
                "type": "DOT1Q",
                "vlanTag": 1001
            }
        }
    },
    "zSide": {
        "accessPoint": {
            "type": "COLO",
            "port": {
                "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
            },
            "linkProtocol": {
                "type": "QINQ",
                "vlanSTag": 2001,
                "vlanCTag": 2002,
            }
        }
    },
    "project": {
        "projectId": "1234567"
    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "test@equinix.com",
                "test@equinix.com"
            ]
        }
    ]
}'

Sample curl request - non-redundant connection to a QINQ port using an A-side servie token

curl -X
POST 'https://api.equinix.com/fabric/v4/connections'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "type": "EVPL_VC",
    "name": "My-Layer2-Connection-3",
    "bandwidth": 1000,
    "redundancy": {
        "priority": "PRIMARY"
    },
    "aSide": {
        "serviceToken": {
            "uuid": "a00cef6f-8e35-4794-9ff9-665e084e4e6d"
        }
    },
    "order": {
        "purchaseOrderNumber": "po1234"
    },
    "zSide": {
        "accessPoint": {
            "type": "COLO",
            "port": {
                "uuid": "a00cef6f-8e35-4794-9ff9-665e084e4e6d"
            },
            "linkProtocol": {
                "type": "DOT1Q",
                "vlanTag": 1001
            }
        }
    },
    "project": {
        "projectId": "1234567"
    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "test@test.com"
            ]
        }
    ]
}'

Sample curl request - Network Edge virtual device to DOT1Q port with VLAN range

curl -X
POST 'https://api.equinix.com/fabric/v4/connections'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "type": "EVPL_VC",
    "bandwidth": 1000,
    "name": "vd to COLO",
    "aSide": {
        "accessPoint": {
            "type": "VD",
            "virtualDevice": {
                "type": "EDGE",
                "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
            },
            "interface": {
                "type": "NETWORK",
                "id": 45645
            }
        }
    },
    "zSide": {
        "accessPoint": {
            "type": "COLO",
            "port": {
                "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
            },
            "linkProtocol": {
                "type": "DOT1Q",
                "vlanTagMin": 300,
                "vlanTagMax": 1099
            }
        }
    },
    "order": {
        "purchaseOrderNumber": "1-129105284100"
    },
    "project": {
        "projectId": "1234567"
    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "test@equinix.com",
                "test1@equinix.com"
            ]
        }
    ]
}'

Body parameters

Parameter	Description
type `string` REQUIRED	Connection type. Applicable values: EVPL_VC - Ethernet virtual private line connection type used for tagged layer 2 connections. EPL_VC - Ethernet private line connection type used for untagged layer 2 connections. ACCESS_EPL_VC - E-access, layer 2 connection between a QINQ port and an EPL port. IP_VC - Layer 2 connection between a Fabric Cloud Router instance and a port. EVPLAN_VC - Ethernet virtual private local area network connection for DOT1Q ports or virtual devices.
name `string` REQUIRED	Connection name. Applicable values: Maximum: 24 characters Allowed characters: alpha-numeric, hyphens ('-') and underscores ('_') Example: my_connection
order `object` REQUIRED	Order details.
purchaseOrderNumber `string` OPTIONAL	Subscriber's purchase order identifier. Example: 1-129105284100
bandwidth `integer` REQUIRED	Connection bandwidth in Mbps. Applicable values: 10 50 200 500 1000 2000 5000 10000
redundancy `object` OPTIONAL	Connection redundancy configuration.
group `string` REQUIRED	Redundancy group identifier. Example: 5c0e9384-aa79-4ec9-b7a2-557f8c307292
priority `string` REQUIRED	Relative priority in a redundancy group. Applicable values: PRIMARY SECONDARY
aSide `object` REQUIRED	Source port definition.
accessPoint `object` REQUIRED	Connection endpoint configuration.
type `string` REQUIRED	Connection endpoint type. Applicable values: COLO - Colocation space in an IBX data center. VD - Network Edge virtual device. CLOUD_ROUTER - Fabric Cloud Router instance. NETWORK - Fabric network that enables creating multipoint connections. METAL_NETWORK - Metal instance.
port `object` REQUIRED	Port associated with the connection.
uuid `string` REQUIRED	Equinix-assigned port identifier.
linkProtocol `object` REQUIRED	Link protocol configuration. Applicable to `COLO` type access points.
type `string` REQUIRED	Link protocol type. Applicable values: DOT1Q QINQ UNTAGGED
vlanTag `integer` REQUIRED	DOT1Q protocol VLAN tag. Applicable values: Minimum: 2 Maximum: 4094
vlanSTag `integer` REQUIRED	QINQ protocol, outer (service) VLAN tag used to identify packets as they traverse trunk lines. Applicable values: Minimum: 2 Maximum: 4094
vlanCTag `integer` REQUIRED	QINQ protocol, inner (customer) VLAN tag used to identify packets as they traverse trunk lines. Applicable values: Minimum: 2 Maximum: 4094
virtualDevice `object` REQUIRED	Virtual device configuration. Applicable to `VD` type access points.
type `string` REQUIRED	Equinix-assigned virtual device identifier. EDGE
uuid `string` REQUIRED	Virtual device instance identifier.
interface `object` REQUIRED	Interface configuration. Applicable to `VD` type access points.
type `string` REQUIRED	Virtual device network interface type. Applicable values: NETWORK CLOUD
id `integer` REQUIRED	Virtual device network interface identifier. Example: 544211
serviceToken `object` REQUIRED	Service token specification. Applicable to connections that use A-side service tokens.
uuid `string` REQUIRED	Service token identifier. Example: e05f4f23-d098-4d7c-a9ca-c2897b465107
zSide `object` REQUIRED	Destination port definition.
serviceToken `object` REQUIRED	Service token specification. Applicable to connections that use Z-side service tokens.
uuid `string` REQUIRED	Service token identifier. Example: e05f4f23-d098-4d7c-a9ca-c2897b465107
accessPoint `object` REQUIRED	Connection endpoint configuration.
type `string` REQUIRED	Connection endpoint type. Applicable values: COLO - Colocation space in an IBX data center. SP - Service profile. VD - Network Edge virtual device. NETWORK - Fabric network that enables creating multipoint connections. METAL_NETWORK - Metal instance.
port `object` REQUIRED	Port associated with the connection. Applicable to `COLO` type access points.
uuid `string` REQUIRED	Equinix-assigned port identifier. Example: 20d32a80-0d61-4333-bc03-707b591ae2f4
linkProtocol `object` REQUIRED	Link protocol configuration. Applicable to `COLO` type access points.
type `string` REQUIRED	Link protocol type. Applicable values: DOT1Q QINQ UNTAGGED
vlanTag `integer` REQUIRED	DOT1Q protocol VLAN tag. Applicable values: Minimum: 2 Maximum: 4094
vlanTagMin `integer` CONDITIONAL	DOT1Q protocol VLAN tag range lowest value. Applicable to connections originating from Network Edge devices. Required if `vlanTag` isn't specified.
vlanTagMax `integer` CONDITIONAL	DOT1Q protocol VLAN tag range highest value. Applicable to connections originating from Network Edge devices. Required if `vlanTag` isn't specified.
vlanSTag `integer` REQUIRED	QINQ protocol, outer (service) VLAN tag used to identify packets as they traverse trunk lines. Applicable values: Minimum: 2 Maximum: 4094
vlanCTag `integer` REQUIRED	QINQ protocol, inner (customer) VLAN tag used to identify packets as they traverse trunk lines. Applicable values: Minimum: 2 Maximum: 4094
vlanCTagMin `integer` CONDITIONAL	QINQ protocol lowest customer VLAN tag value. Applicable to connections originating from Network Edge devices. Required if `vlanCTag` isn't specified.
vlanCTagMax `integer` CONDITOINAL	QINQ protocol highest customer VLAN tag value. Applicable to connections originating from Network Edge devices. Required if `vlanCTag` isn't specified.
profile `object` REQUIRED	A named provider service and its network connectivity requirements. Applicable to `SP` type access points. Use the Retrieve Service Profiles API request to search for service profiles and determine their identifiers and available locations.
type `string` REQUIRED	Service profile type. Applicable values: L2_PROFILE
uuid `string` REQUIRED	Service profile identifier. Example: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c
location `object` REQUIRED	Connection endpoint location information. Applicable to `SP` type access points.
metroCode `string` REQUIRED	Metropolitan area identifier. Use the Get Specified Service Profile API request to determine where a given service is available.
network `object` REQUIRED	Fabric network instance information. Applicable to `NETWORK` type access points.
uuid `string` REQUIRED	Equinix-assigned Fabric network instance identifier. Example: 20d32a80-0d61-4333-bc03-707b591ae2f4
project `object` OPTIONAL	Customer resource hierarchy project information. Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId `string` OPTIONAL	Customer project identifier. Example: 377533000114703
notifications `array[object]` REQUIRED	Notification settings for messages related to the asset configuration or its status.
type `string` REQUIRED	Notification messages category. Applicable values: ALL
emails `array[string]` REQUIRED	Email addresses of up to 12 recipients. Example: ["mike@mspp.com","dwight@dm.com"]

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Sample response - non-redundant connection from a DOT1Q port to a QINQ port

{
    "href": "https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62",
    "type": "EVPL_VC",
    "uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",
    "name": "Conn-1",
    "state": "PENDING_AUTO_APPROVAL",
    "order": {
        "purchaseOrderNumber": "1-129105284100",
        "billingTier": "Up to 1 Gbps"
    },
    "bandwidth": 1000,
    "aSide": {
        "accessPoint" {
            "type": "COLO",
            "port": {
                "href": "https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd",
                "type": "XF_PORT",
                "uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
            },
            "linkProtocol": {
                "type": "DOT1Q",
                "vlanTag": 1001
            }
        }
    },
    "zSide": {
        "accessPoint": {
            "type": "COLO",
            "port": {
                "href": "https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd",
                "type": "XF_PORT",
                "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
            },
            "linkProtocol": {
                "type": "QINQ",
                "vlanSTag": 2001,
                "vlanCTag": 2002,
            }
        }
    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "test@equinix.com",
                "test@equinix.com"
            ]
        }
    ],
    "operation": {
        "equinixStatus": "PROVISIONING",
        "providerStatus": "NOT_AVAILABLE"
    },
    "changeLog": {
        "createdDateTime": "2021-07-15T19:30:29.526Z"
    }
}

Response payload body description

Response payload includes configuration parameters defined in the request body. The following table contains descriptions of additional information included in the response payload. For descriptions of the remaining fields, refer to the Body parameters section.

Parameter	Description
href `string`	An absolute URL that returns the specified connection. Example: https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62
uuid `string`	Equinix-assigned connection identifier. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
state `string`	Lifecycle stage of a connection. Example: PENDING_AUTO_APPROVAL
order `object`	Order information.
billingTier `string`	Billing tier for connection bandwidth. Example: Up to 1 Gbps
aSide `object`	Source port definition.
accessPoint `object`	Connection endpoint configuration.
port `object`	Port associated with the connection. Applicable to `COLO` type access points.
href `string`	An absolute URL that returns the specified port. Example: https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd
type `string`	Type of port. Example: XF_PORT - Equinix Fabric port used as a Fabric connection endpoint.
zSide `object`	Destination port definition.
accessPoint `object`	Connection endpoint configuration.
port `object`	Port associated with the connection. Applicable to `COLO` type access points.
href `string`	An absolute URL that returns the specified port. Example: https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd
type `string`	Type of port. Example: XF_PORT - Equinix Fabric port used as a Fabric connection endpoint.
profile `object`	A named provider service and its network connectivity requirements. Applicable to `SP` type access points.
href `string`	An absolute URL that returns complete specification for the given entity. Example: https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f
type `string`	Service profile type. Example: L2_PROFILE - layer 2 service profile for establishing connections in layer 2 of the OSI networking model. L3_PROFILE - layer 3 service profile for establishing connections in layer 2 of the OSI networking model.
operation `object`	Connection type-specific operational data.
equinixStatus `string`	Progress towards provisioning a specified connection. Example: PROVISIONING
providerStatus `string`	Provider's progress towards provisioning a specified connection. Example: NOT_AVAILABLE
changeLog `object`	A permanent record of asset creation, modification, or deletion.
createdBy `string`	Identity of the asset creator. Example: AverageJoe
createdDateTime `string`	Asset creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z

Get Specified Connection

	GET /fabric/v4/connections/{uuid}
Method	GET
URL or Endpoint	/fabric/v4/connections/{uuid}
Headers	Authorization
Path Parameters	uuid
Query Parameters	direction
Body Parameters	Not applicable

This API request retrieves details of the specified connection.

For instructions on how to obtain an authorization token, refer to Requesting Access and Refresh Tokens.

Sample curl request

curl -X
GET 'https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter	Description
uuid `string` REQUIRED	Equinix-assigned connection identifier.

Query parameters

Parameter	Description
direction `string` OPTIONAL	Connection direction from the requestor's perspective. Applicable values: INCOMING OUTGOING INTERNAL

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Sample response

{
    "type": "EVPL_VC",
    "href": "https://api.equinix.com/fabric/v4/connections/d3ba5c1a-7763-492f-8881-091052420bb1",
    "uuid": "d3ba5c1a-7763-492f-8881-091052420bb1",
    "name": "SustainStandardConn",
    "state": "PROVISIONED",
    "operation": {
        "providerStatus": "AVAILABLE",
        "equinixStatus": "PROVISIONED"
    },
    "order": {
        "billingTier": "Up to 1 Gbps",
        "purchaseOrderNumber": "PO439401015499"
    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "fake@mail.com"
            ]
        }
    ],
    "account": {
        "accountNumber": 270106,
        "orgId": 91996,
        "globalOrgId": "0016u000003JZ4rAAG"
    },
    "changeLog": {
        "createdBy": "testV",
        "createdDateTime": "2022-02-09T05:12:32.183Z",
        "updatedBy": "testBuyerStandardUserAllPerm",
        "updatedDateTime": "2022-02-09T05:12:33.078Z"
    },
    "bandwidth": 1000,
    "redundancy": {
        "group": "2e455f6d-da91-4f7d-a50b-40cdcab257fe",
        "priority": "PRIMARY"
    },
    "isRemote": false,
    "direction": "INCOMING",
    "aSide": {
        "accessPoint": {
            "type": "COLO",
            "account": {
                "accountNumber": 270106,
                "orgId": 91996,
                "organizationName": "testGlobalcust-270100",
                "globalOrgId": "0016u000003JZ4rAAG"
            },
            "location": {
                "region": "EMEA",
                "metroName": "Brussels",
                "metroCode": "BL"
            },
            "port": {
                "href": "https://api.equinix.com/fabric/v4/ports/c791f8cb-5bf9-bf90-8ce0-306a5c00a4ee",
                "uuid": "c791f8cb-5bf9-bf90-8ce0-306a5c00a4ee",
                "name": "testGlobalcust-BL1-NL-Dot1q-STD-PRI-10G-JN-769",
                "redundancy": {
                    "priority": "PRIMARY"
                }
            },
            "linkProtocol": {
                "type": "DOT1Q",
                "vlanTag": 1140
            }
        }
    },
    "zSide": {
        "accessPoint": {
            "type": "SP",
            "account": {
                "orgId": 91997,
                "organizationName": "testBuyer-270001",
                "globalOrgId": "0016u000003JZ4sAAG"
            },
            "location": {
                "region": "EMEA",
                "metroName": "Brussels",
                "metroCode": "BL"
            },
            "port": {
                "href": "https://api.equinix.com/fabric/v4/ports/c791f8cb-5bd1-bd10-8ce0-306a5c00a4ee",
                "uuid": "c791f8cb-5bd1-bd10-8ce0-306a5c00a4ee",
                "name": "testBuyer-BL1-L-Dot1q-STD-PRI-10G-JN-729",
                "redundancy": {
                    "priority": "PRIMARY"
                }
            },
            "profile": {
                "href": "https://api.equinix.com/fabric/v4/serviceProfiles/73e92924-7ea7-4aff-9d2c-50d3faf6c792",
                "type": "L2_PROFILE",
                "name": "Sustain_Standard_USER_SP_L2_2",
                "uuid": "73e92924-7ea7-4aff-9d2c-50d3faf6c792"
            },
            "linkProtocol": {
                "type": "DOT1Q",
                "vlanTag": 4080
            }
        }
    }
}

Response payload body description

Parameter	Description
type `string`	Connection type. Example: EVPL_VC - Ethernet virtual private line connection type used for tagged layer 2 connections. EPL_VC - Ethernet private line connection type used for untagged layer 2 connections. ACCESS_EPL_VC - E-access, layer 2 connection between a QINQ port and an EPL port. IP_VC - Layer 2 connection between a Fabric Cloud Router instance and a port. EVPLAN_VC - Ethernet virtual private local area network connection for DOT1Q ports or virtual devices.
href `string`	An absolute URL that returns the specified connection. Example: https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62
uuid `string`	Equinix-assigned connection identifier. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
name `string`	Connection name. Example: my_connection
state `string`	Lifecycle stage of a connection. Example: PENDING_AUTO_APPROVAL
operation `object`	Connection type-specific operational data.
equinixStatus `string`	Progress towards provisioning a specified connection. Example: PROVISIONING
providerStatus `string`	Provider's progress towards provisioning a specified connection. Example: NOT_AVAILABLE
order `object`	Order details.
purchaseOrderNumber `string`	Subscriber's purchase order identifier. Example: 1-129105284100
billingTier `string`	Billing tier for connection bandwidth. Example: Up to 1 Gbps
notifications `array[object]`	Notification settings for messages related to the asset configuration or its status.
type `string`	Notification messages category. Example: ALL
emails `array[string]`	Email addresses of up to 12 recipients. Example: ["mike@mspp.com","dwight@dm.com"]
account `object`	Customer account information.
accountNumber `integer`	Equinix-assigned account number. Example: 270106
orgId `integer`	Equinix-assigned organization identifier. Example: 92362
globalOrgId `string`	Equinix-assigned top-level organization identifier. Example: 0016u000003JZ62AAG
changeLog `object`	A permanent record of asset creation, modification, or deletion.
createdBy `string`	Identity of the asset creator. Example: AverageJoe
createdDateTime `string`	Asset creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z
bandwidth `integer`	Connection bandwidth in Mbps. Example: 10 50 200 500 1000 2000 5000 10000
redundancy `object`	Connection redundancy configuration.
group `string`	Redundancy group identifier. Example: 5c0e9384-aa79-4ec9-b7a2-557f8c307292
priority `string`	Relative priority in a redundancy group. Example: PRIMARY SECONDARY
isRemote `boolean`	Indicates if both connection endpoints are in the same location. Example: false
direction `string`	Direction of the connection (from the requester's point of view). Example: OUTGOING
aSide `object`	Source port definition.
accessPoint `object`	Connection endpoint configuration.
type `string`	Connection endpoint type. Example: COLO - Colocation space in an IBX data center. VD - Network Edge virtual device. CLOUD_ROUTER - Fabric Cloud Router instance. NETWORK - Fabric network that enables creating multipoint connections. METAL_NETWORK - Metal instance.
account `object`	Customer account information.
accountNumber `integer`	Equinix-assigned account number. Example: 270106
orgId `integer`	Equinix-assigned organization identifier. Example: 92362
globalOrgId `string`	Equinix-assigned top-level organization identifier. Example: 0016u000003JZ62AAG
location `object`	Port associated with the connection.
region `string`	Broad geographic area in which a specified Equinix asset is located. Example: EMEA
metroName `string`	Metropolitan area name. Example: Brussels
metroCode `string`	Metropolitan area identifier. Example: BL
port `object`	Port associated with the connection.
href `string`	An absolute URL that returns the specified port. Example: https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd
uuid `string`	Equinix-assigned port identifier. Example:
name `string`	Equinix-assigned port name. Example: 272010-SV5-CX-Secondary-01
redundancy `object`	Port redundancy information.
priority `string`	Relative port priority. Example: SECONDARY
linkProtocol `object`	Link protocol configuration. Applicable to `COLO` and `VD` type access points.
type `string`	Link protocol type. Example: DOT1Q QINQ UNTAGGED
vlanTag `integer`	DOT1Q protocol VLAN tag. Example: 222
vlanSTag `integer`	QINQ protocol, outer (service) VLAN tag used to identify packets as they traverse trunk lines. Example: 222
vlanCTag `integer`	QINQ protocol, inner (customer) VLAN tag used to identify packets as they traverse trunk lines. Example: 333
virtualDevice `object`	Virtual device configuration. Applicable to `VD` type access points.
type `string`	Equinix-assigned virtual device identifier. EDGE
uuid `string`	Virtual device instance identifier.
interface `object`	Interface configuration. Applicable to `VD` type access points.
type `string`	Virtual device network interface type. Example: NETWORK CLOUD
id `integer`	Virtual device network interface identifier. Example: 544211
router `object`	Cloud Router associated with the connection.
href `string`	Absolute URL that returns the specified entity. Example: http://api.equinix.com/fabric/v4/routers/bb818900-d4b4-445a-85a2-cecd88061662
uuid `string`	Fabric Cloud Router identifier. Example: bb818900-d4b4-445a-85a2-cecd88061662
name `string`	Fabric Cloud Router name. Example: E2E-API-FG
serviceToken `object`	Service token specification. Applicable to connections that use A-side service tokens.
uuid `string`	Service token identifier. Example: e05f4f23-d098-4d7c-a9ca-c2897b465107
zSide `object`	Destination port definition.
accessPoint `object`	Connection endpoint configuration.
type `string`	Connection endpoint type. Example: COLO - Colocation space in an IBX data center. SP - Service profile. VD - Network Edge virtual device. NETWORK - Fabric network that enables creating multipoint connections. METAL_NETWORK - Metal instance.
account `object`	Customer account information.
accountNumber `integer`	Equinix-assigned account number. Example: 270106
orgId `string`	Equinix-assigned organization identifier. Example: 92362
globalOrgId `string`	Equinix-assigned top-level organization identifier. Example: 0016u000003JZ62AAG
location `object`	Port associated with the connection.
region `string`	Broad geographic area in which a specified Equinix asset is located. Example: EMEA
metroName `string`	Metropolitan area name. Example: Brussels
metroCode `string`	Metropolitan area identifier. Example: BL
port `object`	Port associated with the connection.
href `string`	An absolute URL that returns the specified port. Example: https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd
uuid `string`	Equinix-assigned port identifier. Example:
name `string`	Equinix-assigned port name. Example: 272010-SV5-CX-Secondary-01
redundancy `object`	Port redundancy information.
priority `string`	Relative port priority. Example: SECONDARY
linkProtocol `object`	Link protocol configuration. Applicable to `COLO` and `VD` type access points.
type `string`	Link protocol type. Example: DOT1Q QINQ UNTAGGED
vlanTag `integer`	DOT1Q protocol VLAN tag. Example: 222
vlanTagMin `integer`	DOT1Q protocol VLAN tag range lowest value. Applicable to connections originating from Network Edge devices. Required if `vlanTag` isn't specified. Example: 222
vlanTagMax `integer`	DOT1Q protocol VLAN tag range highest value. Applicable to connections originating from Network Edge devices. Required if `vlanTag` isn't specified. Example: 333
vlanSTag `integer`	QINQ protocol, outer (service) VLAN tag used to identify packets as they traverse trunk lines. Example: 222
vlanCTag `integer`	QINQ protocol, inner (customer) VLAN tag used to identify packets as they traverse trunk lines. Example: 222
vlanCTagMin `integer`	QINQ protocol lowest customer VLAN tag value. Applicable to connections originating from Network Edge devices. Required if `vlanCTag` isn't specified. Example: 222
vlanCTagMax `integer`	QINQ protocol highest customer VLAN tag value. Applicable to connections originating from Network Edge devices. Required if `vlanCTag` isn't specified. Example: 333
profile `object`	A named provider service and its network connectivity requirements. Applicable to `SP` type access points. Use the Retrieve Service Profiles API request to search for service profiles and determine their identifiers and available locations.
type `string`	Service profile type. Example: L2_PROFILE
uuid `string`	Service profile identifier. Example: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c
location `object`	Connection endpoint location information. Applicable to `SP` type access points.
region `string`	Broad geographic area in which a specified Equinix asset is located. Example: EMEA
metroName `string`	Metropolitan area name. Example: Brussels
metroCode `string`	Metropolitan area identifier. Example: BL
network `object`	Fabric network instance information. Applicable to `NETWORK` type access points.
uuid `string`	Equinix-assigned Fabric network instance identifier. Example: 20d32a80-0d61-4333-bc03-707b591ae2f4
name `string`	Network name. Example: EPLAN-GLOBAL-1017a
type `string`	Network type. Example: EPLAN
scope `string`	Network geographic scope. Example: GLOBAL
serviceToken `object`	Service token specification. Applicable to connections that use Z-side service tokens.
uuid `string`	Service token identifier. Example: e05f4f23-d098-4d7c-a9ca-c2897b465107

Retrieve Connections

	POST /fabric/v4/connections/search
Method	POST
URL or Endpoint	/fabric/v4/connections/search
Headers	Authorization, Content-Type
Path Parameters	Not applicable
Query Parameters	Not applicable
Body Parameters	filter, pagination, sort

This API request retrieves layer 2 connections that match provided search criteria.

For instructions on how to obtain an authorization token, refer to Requesting Access and Refresh Tokens.

Sample curl request

curl -X POST 'http://api.equinix.com/fabric/v4/connections/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "filter": {
        "and": [
            {
                "property": "/direction",
                "operator": "=",
                "values": [
                    "OUTGOING"
                ]
            },
            {
                "property": "/operation/equinixStatus",
                "operator": "=",
                "values": [
                    "PROVISIONING"
                ]
            }
        ]
    },
    "pagination": {
        "limit": 25,
        "offset": 0,
        "total": 0
    },
    "sort": [
        {
            "property": "/name",
            "direction": "DESC"
        }
    ]
}'

Body parameters

Parameter	Description
filter `object` REQUIRED	Object defining search conditions.
and `array[object]` REQUIRED	Array of search parameters.
property `string` REQUIRED	Search parameter. Applicable values: /isRemote /name /uuid /account/orgId /aSide/accessPoint/account/accountName /aSide/accessPoint/account/accountNumber /aSide/accessPoint/router/uuid /aSide/accessPoint/linkProtocol/vlanCTag /aSide/accessPoint/linkProtocol/vlanSTag /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 /change/status /operation/equinixStatus /operation/providerStatus /project/projectId /redundancy/group /redundancy/priority /zSide/accessPoint/account/accountName /zSide/accessPoint/authenticationKey /zSide/accessPoint/linkProtocol/vlanCTag /zSide/accessPoint/linkProtocol/vlanSTag /zSide/accessPoint/location/metroCode /zSide/accessPoint/location/metroName /zSide/accessPoint/name /zSide/accessPoint/port/uuid /zSide/accessPoint/network/uuid /zSide/accessPoint/port/name /zSide/accessPoint/profile/uuid /zSide/accessPoint/type /zSide/accessPoint/virtualDevice/name /zSide/accessPoint/virtualDevice/uuid /zSide/serviceToken/uuid *
operator `string` REQUIRED	Search parameter operator. Applicable values: = != > >= < <= BETWEEN NOT BETWEEN LIKE NOT LIKE IN NOT IN ~* - Case insensitive like.
values `string` REQUIRED	Search parameter value. Example: ACTIVE
pagination `object` OPTIONAL	Search results pagination settings.
offset `integer` OPTIONAL	Index of the first item returned in the response. Minimum: 0 Default value: 0
limit `integer` OPTIONAL	Maximum number of items returned per page. Minimum: 1 Maximum: 100 Default value: 20
sort `object` OPTIONAL	Search results sorting settings.
direction `string` OPTIONAL	Search results sorting direction. Applicable values: ASC DESC
property `string` OPTIONAL	Search results sorting parameter. Applicable values: /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/account/accountName /zSide/accessPoint/location/metroName /zSide/accessPoint/location/metroCode /zSide/accessPoint/linkProtocol/vlanCTag /zSide/accessPoint/linkProtocol/vlanSTag /zSide/accessPoint/authenticationKey /bandwidth /uuid /changeLog/createdDateTime /changeLog/updatedDateTime /operation/equinixStatus /operation/providerStatus /redundancy/priority Default value: /changeLog/updatedDateTime

/name	Example: "property": "/name", "operator": "LIKE", "values": [ "%myFavoriteConnection%" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: = != LIKE IN NOT LIKE NOT IN ~*
value `array[string]` REQUIRED	Connection name. Example: ["%myFavoriteConnection%"]

/uuid	Example: "property": "/uuid", "operator": "=", "values": [ "3a58dd05-f46d-4b1d-a154-2e85c396ea62 ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: =
value `array[string]` REQUIRED	Connection identifier. Example: ["3a58dd05-f46d-4b1d-a154-2e85c396ea62"]

/account/orgId	Example: "property": "/account/orgId", "operator": "=", "values": [ 91997 ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: = LIKE
value `array[integer]` REQUIRED	Equinix-assigned organization identifier. Example: [91997]

/aSide/accessPoint/account/accountName /zSide/accessPoint/account/accountName	Example: "property": "/aSide/accessPoint/account/accountName", "operator": "=", "values": [ "John Doe" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: = LIKE
value `array[string]` REQUIRED	Legal name of the account holder. Example: ["John Doe"]

/aSide/accessPoint/account/accountNumber	Example: "property": "/aSide/accessPoint/account/accountNumber", "operator": "=", "values": [ 299001 ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: =
value `array[integer]` REQUIRED	Customer account number. Example: [299001]

/aSide/accessPoint/router/uuid	Example: "property": "/aSide/accessPoint/router/uuid", "operator": "=", "values": [ "cea65afb-aa36-a366-2ae0-387a5c00a944" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: =
value `array[string]` REQUIRED	Equinix-assigned Fabric Cloud Router identifier. Example: cea65afb-aa36-a366-2ae0-387a5c00a944

/aSide/accessPoint/linkProtocol/vlanCTag /zSide/accessPoint/linkProtocol/vlanCTag	Example: "property": "/aSide/accessPoint/linkProtocol/vlanCTag", "operator": "=", "values": [ "486" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: =
value `array[integer]` REQUIRED	QINQ protocol inner (customer) VLAN tag used to identify packets as they traverse trunk lines. Example: ["486"]

/aSide/accessPoint/linkProtocol/vlanSTag /zSide/accessPoint/linkProtocol/vlanSTag	Example: "property": "/aSide/accessPoint/linkProtocol/vlanSTag", "operator": "=", "values": [ "486" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: =
value `array[integer]` REQUIRED	QINQ protocol outer (service) VLAN tag used to identify packets as they traverse trunk lines. Example: ["486"]

/aSide/accessPoint/location/metroCode /zSide/accessPoint/location/metroCode	Example: "property": "/aSide/accessPoint/location/metroCode", "operator": "=", "values": [ "SV" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: = LIKE
value `array[string]` REQUIRED	Metropolitan area identifier. Use the Get All Metros API request to retrieve the list of available metros. Example: ["SV"]

/aSide/accessPoint/location/metroName /zSide/accessPoint/location/metroName	Example: "property": "/aSide/accessPoint/location/metroName", "operator": "=", "values": [ "Silicon Valley" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: = LIKE
value `array[string]` REQUIRED	Metropolitan area name. Example: ["Silicon Valley"]

/aSide/accessPoint/name /zSide/accessPoint/name	Example: "property": "/aSide/accessPoint/name", "operator": "=", "values": [ "Name" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: =
value `array[string]` REQUIRED	Access point name. Example: ["Name"]

/aSide/accessPoint/port/uuid /zSide/accessPoint/port/uuid	Example: "property": "/aSide/accessPoint/port/uuid", "operator": "=", "values": [ "cea65afb-aa34-a346-2ae0-387a5c00a944" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: =
value `array[string]` REQUIRED	Equinix-assigned port identifier. Use the Get All Ports API request to retrieve ports information. Example: ["cea65afb-aa34-a346-2ae0-387a5c00a944"]

/aSide/accessPoint/port/name /zSide/accessPoint/port/name	Example: "property": "/aSide/accessPoint/port/name", "operator": "=", "values": [ "290071-WA1-NL-Qinq-10G-9" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: = LIKE
value `array[string]` REQUIRED	Equinix-assigned port identifier. Use the Get All Ports API request to retrieve ports information. Example: ["290071-WA1-NL-Qinq-10G-9"]

/aSide/accessPoint/type /zSide/accessPoint/type	Example: "property": "/aSide/accessPoint/type", "operator": "=", "values": [ "COLO" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: = LIKE
value `array[string]` REQUIRED	Metropolitan area name. Applicable values: COLO - Colocation endpoint in an Equinix IBX data center. SP - Service profile. VD - Netork Edge virtual device. CLOUD_ROUTER - Fabric Cloud Router instance. NETWORK - Fabric network that enables creating multipoint connections.

/aSide/accessPoint/virtualDevice/name /zSide/accessPoint/virtualDevice/name	Example: "property": "/zSide/accessPoint/virtualDevice/name", "operator": "=", "values": [ "E2E-NE-Device-Aut-171221033749146" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: = LIKE
value `array[string]` REQUIRED	Virtual device name. Example: ["E2E-NE-Device-Aut-171221033749146"]

/aSide/accessPoint/virtualDevice/uuid /zSide/accessPoint/virtualDevice/uuid	Example: "property": "/zSide/accessPoint/virtualDevice/uuid", "operator": "=", "values": [ "0e9daf19-72bd-4ba7-b305-e0132740224b" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: = LIKE
value `array[string]` REQUIRED	Equinix-assigned virtual device identifier. Example: ["0e9daf19-72bd-4ba7-b305-e0132740224b"]

/aSide/serviceToken/uuid /zSide/serviceToken/uuid	Example: "property": "/zSide/serviceToken/uuid", "operator": "=", "values": [ "0e9daf19-72bd-4ba7-b305-e0132740224b" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: = LIKE
value `array[string]` REQUIRED	Equinix-assigned service token identifier. Example: ["0e9daf19-72bd-4ba7-b305-e0132740224b"]

/project/projectId	Example: "property": "/project/projectId", "operator": "=", "values": [ "1003513458238" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: = LIKE
value `array[string]` REQUIRED	Customer project identifier. Example: ["1003513458238"]

/zSide/accessPoint/authenticationKey	Example: "property": "/zSide/accessPoint/authenticationKey", "operator": "=", "values": [ "qwerASDF" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: = LIKE
value `array[string]` REQUIRED	Z-side acess point authentication key. Example: ["qwerASDF"]

/zSide/accessPoint/profile/uuid	Example: "property": "/zSide/accessPoint/profile/uuid", "operator": "=", "values": [ "0e9daf19-72bd-4ba7-b305-e0132740224b" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: = LIKE
value `array[string]` REQUIRED	Equinix-assigned service profile identifier. Example: ["0e9daf19-72bd-4ba7-b305-e0132740224b"]

/zSide/accessPoint/network/uuid	Example: "property": "/zSide/accessPoint/network/uuid", "operator": "=", "values": [ "0e9daf19-72bd-4ba7-b305-e0132740224b" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: = LIKE
value `array[string]` REQUIRED	Fabric network instance identifier. Example: ["0e9daf19-72bd-4ba7-b305-e0132740224b"]

/change/status	Example: "property": "/change/status", "operator": "=", "values": [ "SUBMITTED_FOR_APPROVAL" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: = LIKE
value `array[string]` REQUIRED	Operation status life cycle. Applicable values: SUBMITTED_FOR_APPROVAL APPROVED REJECTED

/operation/equinixStatus	Example: "property": "/operation/equinixStatus", "operator": "=", "values": [ "PROVISIONED" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: = LIKE
value `array[string]` REQUIRED	Progress toward provisioning a specified connection. Applicable values: REJECTED_ACK REJECTED PENDING_DELETE PROVISIONED BEING_REPROVISIONED BEING_DEPROVISIONED BEING_PROVISIONED CREATED ERRORED PENDING_DEPROVISIONING APPROVED ORDERING PENDING_APPROVAL NOT_PROVISIONED DEPROVISIONING NOT_DEPROVISIONED PENDING_AUTO_APPROVAL PROVISIONING PENDING_BGP_PEERING PENDING_PROVIDER_VLAN DEPROVISIONED DELETED PENDING_BANDWIDTH_APPROVAL AUTO_APPROVAL_FAILED UPDATE_PENDING DELETED_API MODIFIED PENDING_PROVIDER_VLAN_ERROR DRAFT CANCELLED PENDING_INTERFACE_CONFIGURATION

/operation/providerStatus	Example: "property": "/operation/providerStatus", "operator": "=", "values": [ "AVAILABLE" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: = LIKE
value `array[string]` REQUIRED	Provider's progress toward provisioning a specified connection. Applicable values: AVAILABLE DEPROVISIONED DEPROVISIONING FAILED NOT_AVAILABLE PENDING_APPROVAL PROVISIONED PROVISIONING REJECTED PENDING_BGP OUT_OF_BANDWIDTH DELETED ERROR ERRORED NOTPROVISIONED ORDERING DELETING PENDING DELETE

/redundancy/group	Example: "property": "/redundancy/group", "operator": "=", "values": [ "0e9daf19-72bd-4ba7-b305-e0132740224b" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: = LIKE
value `array[string]` REQUIRED	Redundancy group identifier. Example: ["0e9daf19-72bd-4ba7-b305-e0132740224b"]

/redundancy/priority	Example: "property": "/redundancy/priority", "operator": "=", "values": [ "PRIMARY" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: = LIKE
value `array[string]` REQUIRED	Relative priority within the redundancy group. Applicable values: PRIMARY SECONDARY

/isRemote	Example: "property": "/isRemote", "operator": "=", "values": [ false ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: =
value `array[string]` REQUIRED	Indicates if both connection endpoints are in the same location. Applicable values: true false

/*	Example: "property": "/*", "operator": "LIKE", "values": [ "%Silicon%" ]
operator `string` REQUIRED	Search field parameter operator. Use the Get All Ports API request to retrieve ports information. Example: = != LIKE IN NOT LIKE NOT IN ~*
value `array[string]` REQUIRED	All categories search. Example: ["%Silicon%"]

Sample response

{
    "data": [
        {
            "type": "EVPL_VC",
            "href": "https://api.equinix.com/fabric/v4/connections/50a4ad8f-2b00-434a-9ea1-f3bbb894541f",
            "uuid": "50a4ad8f-2b00-434a-9ea1-f3bbb894541f",
            "name": "P2SPConn012",
            "state": "PROVISIONED",
            "change": {
                "uuid": "da6a1a0b-0872-4c06-b9d7-5c8ee3056775",
                "type": "CONNECTION_UPDATE",
                "status": "APPROVED",
                "createdDateTime": "2021-12-12T06:00:01.183Z",
                "updatedDateTime": "2021-12-12T06:00:09.278916Z",
                "data": {
                    "op": "replace",
                    "path": "/aSide/accessPoint/port/uuid",
                    "value": "c791f8cb-58f9-8f90-8ce0-306a5c00a4ee"
                }
            },
            "operation": {
                "providerStatus": "AVAILABLE",
                "equinixStatus": "PROVISIONED"
            },
            "order": {
                "purchaseOrderNumber": "POTEST1"
            },
            "notifications": [
                {
                    "type": "ALL",
                    "emails": [
                        "dragonstestBuyer@equinix.com"
                    ]
                }
            ],
            "account": {
                "accountNumber": 270001,
                "orgId": 91997,
                "globalOrgId": "0016u000003JZ4sAAG"
            },
            "changeLog": {
                "createdBy": "dragonstestBuyer",
                "createdDateTime": "2021-11-19T22:56:24.666Z",
                "updatedBy": "dragonstestBuyer"
            },
            "bandwidth": 10000,
            "redundancy": {
                "group": "66c10a60-789e-4b25-b85c-7eb225a4c344",
                "priority": "PRIMARY"
            },
            "isRemote": true,
            "direction": "OUTGOING",
            "aSide": {
                "accessPoint": {
                    "type": "COLO",
                    "account": {
                        "accountNumber": 270001,
                        "orgId": 91997,
                        "organizationName": "testBuyer-270001",
                        "globalOrgId": "0016u000003JZ4sAAG"
                    },
                    "location": {
                        "href": "https://api.equinix.com/fabric/v4/metros/MetroCode(value=SV)",
                        "region": "AMER",
                        "metroName": "Silicon Valley",
                        "metroCode": "SV"
                    },
                    "port": {
                        "href": "https://api.equinix.com/fabric/v4/ports/c791f8cb-58fa-8fa0-8ce0-306a5c00a4ee",
                        "uuid": "c791f8cb-58fa-8fa0-8ce0-306a5c00a4ee",
                        "name": "testBuyer-SV1-L-Dot1q-STD-PRI-10G-JN-2",
                        "redundancy": {
                            "priority": "PRIMARY"
                        }
                    },
                    "linkProtocol": {
                        "type": "DOT1Q",
                        "vlanTag": 2021
                    }
                }
            },
            "zSide": {
                "accessPoint": {
                    "type": "SP",
                    "account": {
                        "orgId": 92154,
                        "organizationName": "testSeller1-270271",
                        "globalOrgId": "0016u000003JZ59AAG"
                    },
                    "location": {
                        "href": "https://api.equinix.com/fabric/v4/metros/MetroCode(value=DA)",
                        "region": "AMER",
                        "metroName": "Dallas",
                        "metroCode": "DA"
                    },
                    "port": {
                        "href": "https://api.equinix.com/fabric/v4/ports/c791f8cb-5a85-a850-8ce0-306a5c00a4ee",
                        "uuid": "c791f8cb-5a85-a850-8ce0-306a5c00a4ee",
                        "name": "testSeller1-DA1-L-Dot1q-STD-SEC-10G-NK-397",
                        "redundancy": {
                            "priority": "SECONDARY"
                        }
                    },
                    "profile": {
                        "type": "L2_PROFILE",
                        "name": "Non-Redundant-DOT1Q-SP",
                        "uuid": "bebd6257-bf4d-4819-8ff9-e921c564ce26"
                    },
                    "linkProtocol": {
                        "type": "DOT1Q",
                        "vlanTag": 458
                    }
                }
            }
        }
    ],
    "pagination": {
        "offset": 0,
        "limit": 25,
        "total": 1
    }
}

Response payload body description

Parameter	Description
data `array[object]`	Data array containing search results.
type `string`	Connection type. Example: EVPL_VC - Ethernet virtual private line connection type used for tagged layer 2 connections. EPL_VC - Ethernet private line connection type used for untagged layer 2 connections. ACCESS_EPL_VC - E-access, layer 2 connection between a QINQ port and an EPL port. IP_VC - Layer 2 connection between a Fabric Cloud Router instance and a port. EVPLAN_VC - Ethernet virtual private local area network connection for DOT1Q ports or virtual devices.
href `string`	An absolute URL that returns the specified connection. Example: https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62
uuid `string`	Equinix-assigned connection identifier. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
name `string`	Connection name. Example: my_connection
state `string`	Lifecycle stage of a connection. Example: PENDING_AUTO_APPROVAL
operation `object`	Connection type-specific operational data.
equinixStatus `string`	Progress towards provisioning a specified connection. Example: PROVISIONING
providerStatus `string`	Provider's progress towards provisioning a specified connection. Example: NOT_AVAILABLE
order `object`	Order details.
purchaseOrderNumber `string`	Subscriber's purchase order identifier. Example: 1-129105284100
billingTier `string`	Billing tier for connection bandwidth. Example: Up to 1 Gbps
notifications `array[object]`	Notification settings for messages related to the asset configuration or its status.
type `string`	Notification messages category. Example: ALL
emails `array[string]`	Email addresses of up to 12 recipients. Example: ["mike@mspp.com","dwight@dm.com"]
account `object`	Customer account information.
accountNumber `integer`	Equinix-assigned account number. Example: 270106
orgId `integer`	Equinix-assigned organization identifier. Example: 92362
globalOrgId `string`	Equinix-assigned top-level organization identifier. Example: 0016u000003JZ62AAG
changeLog `object`	A permanent record of asset creation, modification, or deletion.
createdBy `string`	Identity of the asset creator. Example: AverageJoe
createdDateTime `string`	Asset creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z
bandwidth `integer`	Connection bandwidth in Mbps. Example: 10 50 200 500 1000 2000 5000 10000
redundancy `object`	Connection redundancy configuration.
group `string`	Redundancy group identifier. Example: 5c0e9384-aa79-4ec9-b7a2-557f8c307292
priority `string`	Relative priority in a redundancy group. Example: PRIMARY SECONDARY
isRemote `boolean`	Indicates if both connection endpoints are in the same location. Example: false
direction `string`	Direction of the connection (from the requester's point of view). Example: OUTGOING
aSide `object`	Source port definition.
accessPoint `object`	Connection endpoint configuration.
type `string`	Connection endpoint type. Example: COLO - Colocation space in an IBX data center. VD - Network Edge virtual device. CLOUD_ROUTER - Fabric Cloud Router instance. NETWORK - Fabric network that enables creating multipoint connections. METAL_NETWORK - Metal instance.
account `object`	Customer account information.
accountNumber `integer`	Equinix-assigned account number. Example: 270106
orgId `integer`	Equinix-assigned organization identifier. Example: 92362
globalOrgId `string`	Equinix-assigned top-level organization identifier. Example: 0016u000003JZ62AAG
location `object`	Port associated with the connection.
region `string`	Broad geographic area in which a specified Equinix asset is located. Example: EMEA
metroName `string`	Metropolitan area name. Example: Brussels
metroCode `string`	Metropolitan area identifier. Example: BL
port `object`	Port associated with the connection.
href `string`	An absolute URL that returns the specified port. Example: https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd
uuid `string`	Equinix-assigned port identifier. Example:
name `string`	Equinix-assigned port name. Example: 272010-SV5-CX-Secondary-01
redundancy `object`	Port redundancy information.
priority `string`	Relative port priority. Example: SECONDARY
linkProtocol `object`	Link protocol configuration. Applicable to `COLO` and `VD` type access points.
type `string`	Link protocol type. Example: DOT1Q QINQ UNTAGGED
vlanTag `integer`	DOT1Q protocol VLAN tag. Example: 222
vlanSTag `integer`	QINQ protocol, outer (service) VLAN tag used to identify packets as they traverse trunk lines. Example: 222
vlanCTag `integer`	QINQ protocol, inner (customer) VLAN tag used to identify packets as they traverse trunk lines. Example: 333
virtualDevice `object`	Virtual device configuration. Applicable to `VD` type access points.
type `string`	Equinix-assigned virtual device identifier. EDGE
uuid `string`	Virtual device instance identifier.
interface `object`	Interface configuration. Applicable to `VD` type access points.
type `string`	Virtual device network interface type. Example: NETWORK CLOUD
id `integer`	Virtual device network interface identifier. Example: 544211
router `object`	Cloud Router associated with the connection.
href `string`	Absolute URL that returns the specified entity. Example: http://api.equinix.com/fabric/v4/routers/bb818900-d4b4-445a-85a2-cecd88061662
uuid `string`	Fabric Cloud Router identifier. Example: bb818900-d4b4-445a-85a2-cecd88061662
name `string`	Fabric Cloud Router name. Example: E2E-API-FG
serviceToken `object`	Service token specification. Applicable to connections that use A-side service tokens.
uuid `string`	Service token identifier. Example: e05f4f23-d098-4d7c-a9ca-c2897b465107
zSide `object`	Destination port definition.
accessPoint `object`	Connection endpoint configuration.
type `string`	Connection endpoint type. Example: COLO - Colocation space in an IBX data center. SP - Service profile. VD - Network Edge virtual device. NETWORK - Fabric network that enables creating multipoint connections. METAL_NETWORK - Metal instance.
account `object`	Customer account information.
accountNumber `integer`	Equinix-assigned account number. Example: 270106
orgId `string`	Equinix-assigned organization identifier. Example: 92362
globalOrgId `string`	Equinix-assigned top-level organization identifier. Example: 0016u000003JZ62AAG
location `object`	Port associated with the connection.
region `string`	Broad geographic area in which a specified Equinix asset is located. Example: EMEA
metroName `string`	Metropolitan area name. Example: Brussels
metroCode `string`	Metropolitan area identifier. Example: BL
port `object`	Port associated with the connection.
href `string`	An absolute URL that returns the specified port. Example: https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd
uuid `string`	Equinix-assigned port identifier. Example:
name `string`	Equinix-assigned port name. Example: 272010-SV5-CX-Secondary-01
redundancy `object`	Port redundancy information.
priority `string`	Relative port priority. Example: SECONDARY
linkProtocol `object`	Link protocol configuration. Applicable to `COLO` and `VD` type access points.
type `string`	Link protocol type. Example: DOT1Q QINQ UNTAGGED
vlanTag `integer`	DOT1Q protocol VLAN tag. Example: 222
vlanTagMin `integer`	DOT1Q protocol VLAN tag range lowest value. Applicable to connections originating from Network Edge devices. Required if `vlanTag` isn't specified. Example: 222
vlanTagMax `integer`	DOT1Q protocol VLAN tag range highest value. Applicable to connections originating from Network Edge devices. Required if `vlanTag` isn't specified. Example: 333
vlanSTag `integer`	QINQ protocol, outer (service) VLAN tag used to identify packets as they traverse trunk lines. Example: 222
vlanCTag `integer`	QINQ protocol, inner (customer) VLAN tag used to identify packets as they traverse trunk lines. Example: 222
vlanCTagMin `integer`	QINQ protocol lowest customer VLAN tag value. Applicable to connections originating from Network Edge devices. Required if `vlanCTag` isn't specified. Example: 222
vlanCTagMax `integer`	QINQ protocol highest customer VLAN tag value. Applicable to connections originating from Network Edge devices. Required if `vlanCTag` isn't specified. Example: 333
profile `object`	A named provider service and its network connectivity requirements. Applicable to `SP` type access points. Use the Retrieve Service Profiles API request to search for service profiles and determine their identifiers and available locations.
type `string`	Service profile type. Example: L2_PROFILE
uuid `string`	Service profile identifier. Example: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c
location `object`	Connection endpoint location information. Applicable to `SP` type access points.
region `string`	Broad geographic area in which a specified Equinix asset is located. Example: EMEA
metroName `string`	Metropolitan area name. Example: Brussels
metroCode `string`	Metropolitan area identifier. Example: BL
network `object`	Fabric network instance information. Applicable to `NETWORK` type access points.
uuid `string`	Equinix-assigned Fabric network instance identifier. Example: 20d32a80-0d61-4333-bc03-707b591ae2f4
name `string`	Network name. Example: EPLAN-GLOBAL-1017a
type `string`	Network type. Example: EPLAN
scope `string`	Network geographic scope. Example: GLOBAL
serviceToken `object`	Service token specification. Applicable to connections that use Z-side service tokens.
uuid `string`	Service token identifier. Example: e05f4f23-d098-4d7c-a9ca-c2897b465107

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Update Connection

	PATCH /fabric/v4/connections/{uuid}
Method	PATCH
URL or Endpoint	/fabric/v4/connections/{uuid}
Headers	Authorization, Content-Type
Path Parameters	uuid
Query Parameters	Not applicable
Body Parameters	op, path, value

This API enables modifying connection parameters.

For instructions on how to obtain an authorization token, refer to Requesting Access and Refresh Tokens.

Sample curl request - update connection name

curl -X
PATCH 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '[
    {
        "op": "replace",
        "path": "/name",
        "value": "Conn-Name-2"
    }
]'

Sample curl request - update connection bandwidth

curl -X
PATCH 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '[
    {
        "op": "replace",
        "path": "/bandwidth",
        "value": 1000
    }
]'

Sample curl request - update A-side port

curl -X
PATCH 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '[
    {
        "op": "replace",
        "path": "/aSide/accessPoint/port/uuid",
        "value": "c791f8cb-599a-99a0-8ce0-306a5c00a4ee"
    }
]'

Sample curl request - update notifications recipients

curl -X
PATCH 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '[
    {
        "op": "replace",
        "path": "/notifications",
        "value": [
            {
                "type": "ALL",
                "emails": [
                    "testEmail1@equinix.com",
                    "testEmail2@equinix.com"
                ]
            }
        ]
    }
]'

Sample curl request - update A-side Virtual Device

curl -X
PATCH 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '[
   {
      "op": "replace",
      "path": "/aSide/accessPoint",
      "value": {
         "virtualDevice": {
            "type": "EDGE",
            "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
         },
         "interface": {
            "type": "NETWORK",
            "id": 5
         }
      }
   }
]'

Path parameters

Parameter	Description
uuid `string` REQUIRED	Equinix-assigned connection identifier.

Body parameters

Parameter	Description
op `string` REQUIRED	Update reqest type. Applicable values: replace
path `string` REQUIRED	Parameter path. Applicable values: /name /bandwidth /aSide/accessPoint/port/uuid /notifications
value `string` REQUIRED	New parameter value.

/name
value `string` REQUIRED	Connection name. Applicable values: Maximum: 24 characters Allowed characters: alpha-numeric, hyphens ('-') and underscores ('_') Example: Conn-Name-2

/bandwidth
value `integer` REQUIRED	Connection bandwidth in Mbps. Applicable values: 10 50 200 500 1000 2000 5000 10000

/aSide/accessPoint/port/uuid
value `string` REQUIRED	Equinix-assigned port identifier. Use the Get All Ports API request to retrieve available ports information. Example: c791f8cb-599a-99a0-8ce0-306a5c00a4ee

/notifications
value `array[object]` REQUIRED	List of up to 12 recipients. Example: [ { "type": "ALL", "emails": [ "email1@eqix.com", "email2@eqix.com" ] } ]

/aSide/accessPoint
value `object[object]` REQUIRED	Id of the Virtual Device and the interface Id. Example: { "virtualDevice": { "type": "EDGE", "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4" }, "interface": { "type": "NETWORK", "id": 5 } }

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Sample response - update connection bandwidth

{
    "href": "https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62",
    "type": "EVPL_VC",
    "uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",
    "name": "Conn-Name-2",
    "state": "PROVISIONED",
    "change": {
        "uuid": "af90d2b5-c7f9-4183-b050-637b7a9e3bf7",
        "type": "CONNECTION_UPDATE",
        "status": "COMPLETED",
        "createdDateTime": "2022-11-30T08:37:14.536Z",
        "updatedDateTime": "2022-11-30T08:41:21.539960Z",
        "data": {
            "op": "replace",
            "path": "/bandwidth",
            "value": "1000"
        }
    },
    "order": {
        "purchaseOrderNumber": "1-129105284100",
        "billingTier": "Up to 1 Gbps"
    },
    "bandwidth": 1000,
    "redundancy": {
        "group": "m167f685-41b0-1b07-6de0-320a5c00abeu",
        "priority": "PRIMARY"
    },
    "aSide": {
        "accessPoint": {
            "type": "COLO",
            "port": {
                "href": "https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd",
                "type": "XF_PORT",
                "uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
            },
            "linkProtocol": {
                "type": "DOT1Q",
                "vlanTag": 1001
            }
        }
    },
    "zSide": {
        "accessPoint": {
            "type": "SP",
            "profile": {
                "href": "https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd",
                "type": "L2_Profile",
                "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
            },
            "location": {
                "href": "https://api.equinix.com/v4/metros/SV",
                "metrocode": "SV",
                "region": "AMER"
            }
        }
    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "test@equinix.com",
                "test@equinix.com"
            ]
        }
    ],
    "operation": {
        "equinixStatus": "PROVISIONED",
        "providerStatus": "PROVISIONED"
    },
    "changeLog": {
        "createdDateTime": "2021-07-15T19:30:29.526Z",
        "updatedDateTime": "2021-08-15T19:30:29.526Z"
    }
}

Response payload body description

Parameter	Description
type `string`	Connection type. Example: EVPL_VC - Ethernet virtual private line connection type used for tagged layer 2 connections. EPL_VC - Ethernet private line connection type used for untagged layer 2 connections. ACCESS_EPL_VC - E-access, layer 2 connection between a QINQ port and an EPL port. IP_VC - Layer 2 connection between a Fabric Cloud Router instance and a port. EVPLAN_VC - Ethernet virtual private local area network connection for DOT1Q ports or virtual devices.
href `string`	An absolute URL that returns the specified connection. Example: https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62
uuid `string`	Equinix-assigned connection identifier. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
name `string`	Connection name. Example: my_connection
state `string`	Lifecycle stage of a connection. Example: PENDING_AUTO_APPROVAL
change `object`	Specifics of the connections change.
uuid `string`	Equinix-assigned change request identifier. Example: af90d2b5-c7f9-4183-b050-637b7a9e3bf7
type `string`	Change request type. Example: CONNECTION_UPDATE
status `string`	Change request processing status. Example: COMPLETED
createdDateTime `string`	Change request creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z
updatedDateTime `string`	Change request update timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z
data `object`	Change request details.
op `string`	Update reqest type. Example: replace
path `string`	Parameter path. Example: /bandwidth
value `string/integer`	New parameter value. Example: 1000
operation `object`	Connection type-specific operational data.
equinixStatus `string`	Progress towards provisioning a specified connection. Example: PROVISIONING
providerStatus `string`	Provider's progress towards provisioning a specified connection. Example: NOT_AVAILABLE
op `string`	Update reqest type. Example: replace
path `string`	Parameter path. Example: /aSide/accessPoint/port/uuid
value `string`	Parameter value. Example: c791f8cb-58f9-8f90-8ce0-306a5c00a4ee
order `object`	Order details.
purchaseOrderNumber `string`	Subscriber's purchase order identifier. Example: 1-129105284100
billingTier `string`	Billing tier for connection bandwidth. Example: Up to 1 Gbps
notifications `array[object]`	Notification settings for messages related to the asset configuration or its status.
type `string`	Notification messages category. Example: ALL
emails `array[string]`	Email addresses of up to 12 recipients. Example: ["mike@mspp.com","dwight@dm.com"]
account `object`	Customer account information.
accountNumber `integer`	Equinix-assigned account number. Example: 270106
orgId `integer`	Equinix-assigned organization identifier. Example: 92362
globalOrgId `string`	Equinix-assigned top-level organization identifier. Example: 0016u000003JZ62AAG
changeLog `object`	A permanent record of asset creation, modification, or deletion.
createdBy `string`	Identity of the asset creator. Example: AverageJoe
createdDateTime `string`	Asset creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z
bandwidth `integer`	Connection bandwidth in Mbps. Example: 10 50 200 500 1000 2000 5000 10000
redundancy `object`	Connection redundancy configuration.
group `string`	Redundancy group identifier. Example: 5c0e9384-aa79-4ec9-b7a2-557f8c307292
priority `string`	Relative priority in a redundancy group. Example: PRIMARY SECONDARY
isRemote `boolean`	Indicates if both connection endpoints are in the same location. Example: false
direction `string`	Direction of the connection (from the requester's point of view). Example: OUTGOING
aSide `object`	Source port definition.
accessPoint `object`	Connection endpoint configuration.
type `string`	Connection endpoint type. Example: COLO - Colocation space in an IBX data center. VD - Network Edge virtual device. CLOUD_ROUTER - Fabric Cloud Router instance. NETWORK - Fabric network that enables creating multipoint connections. METAL_NETWORK - Metal instance.
account `object`	Customer account information.
accountNumber `integer`	Equinix-assigned account number. Example: 270106
orgId `integer`	Equinix-assigned organization identifier. Example: 92362
globalOrgId `string`	Equinix-assigned top-level organization identifier. Example: 0016u000003JZ62AAG
location `object`	Port associated with the connection.
region `string`	Broad geographic area in which a specified Equinix asset is located. Example: EMEA
metroName `string`	Metropolitan area name. Example: Brussels
metroCode `string`	Metropolitan area identifier. Example: BL
port `object`	Port associated with the connection.
href `string`	An absolute URL that returns the specified port. Example: https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd
uuid `string`	Equinix-assigned port identifier. Example:
name `string`	Equinix-assigned port name. Example: 272010-SV5-CX-Secondary-01
redundancy `object`	Port redundancy information.
priority `string`	Relative port priority. Example: SECONDARY
linkProtocol `object`	Link protocol configuration. Applicable to `COLO` and `VD` type access points.
type `string`	Link protocol type. Example: DOT1Q QINQ UNTAGGED
vlanTag `integer`	DOT1Q protocol VLAN tag. Example: 222
vlanSTag `integer`	QINQ protocol, outer (service) VLAN tag used to identify packets as they traverse trunk lines. Example: 222
vlanCTag `integer`	QINQ protocol, inner (customer) VLAN tag used to identify packets as they traverse trunk lines. Example: 333
router `object`	Port associated with the connection.
href `string`	Absolute URL that returns the specified entity. Example: http://api.equinix.com/fabric/v4/routers/bb818900-d4b4-445a-85a2-cecd88061662
uuid `string`	Fabric Cloud Router identifier. Example: bb818900-d4b4-445a-85a2-cecd88061662
name `string`	Fabric Cloud Router name. Example: E2E-API-FG
serviceToken `object`	Service token specification. Applicable to connections that use A-side service tokens.
uuid `string`	Service token identifier. Example: e05f4f23-d098-4d7c-a9ca-c2897b465107
zSide `object`	Destination port definition.
accessPoint `object`	Connection endpoint configuration.
type `string`	Connection endpoint type. Example: COLO - Colocation space in an IBX data center. SP - Service profile. VD - Network Edge virtual device. NETWORK - Fabric network that enables creating multipoint connections. METAL_NETWORK - Metal instance.
account `object`	Customer account information.
accountNumber `integer`	Equinix-assigned account number. Example: 270106
orgId `string`	Equinix-assigned organization identifier. Example: 92362
globalOrgId `string`	Equinix-assigned top-level organization identifier. Example: 0016u000003JZ62AAG
location `object`	Port associated with the connection.
region `string`	Broad geographic area in which a specified Equinix asset is located. Example: EMEA
metroName `string`	Metropolitan area name. Example: Brussels
metroCode `string`	Metropolitan area identifier. Example: BL
port `object`	Port associated with the connection.
href `string`	An absolute URL that returns the specified port. Example: https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd
uuid `string`	Equinix-assigned port identifier. Example:
name `string`	Equinix-assigned port name. Example: 272010-SV5-CX-Secondary-01
redundancy `object`	Port redundancy information.
priority `string`	Relative port priority. Example: SECONDARY
linkProtocol `object`	Link protocol configuration. Applicable to `COLO` and `VD` type access points.
type `string`	Link protocol type. Example: DOT1Q QINQ UNTAGGED
vlanTag `integer`	DOT1Q protocol VLAN tag. Example: 222
vlanTagMin `integer`	DOT1Q protocol VLAN tag range lowest value. Applicable to connections originating from Network Edge devices. Required if `vlanTag` isn't specified. Example: 222
vlanTagMax `integer`	DOT1Q protocol VLAN tag range highest value. Applicable to connections originating from Network Edge devices. Required if `vlanTag` isn't specified. Example: 333
vlanSTag `integer`	QINQ protocol, outer (service) VLAN tag used to identify packets as they traverse trunk lines. Example: 222
vlanCTag `integer`	QINQ protocol, inner (customer) VLAN tag used to identify packets as they traverse trunk lines. Example: 222
vlanCTagMin `integer`	QINQ protocol lowest customer VLAN tag value. Applicable to connections originating from Network Edge devices. Required if `vlanCTag` isn't specified. Example: 222
vlanCTagMax `integer`	QINQ protocol highest customer VLAN tag value. Applicable to connections originating from Network Edge devices. Required if `vlanCTag` isn't specified. Example: 333
profile `object`	A named provider service and its network connectivity requirements. Applicable to `SP` type access points. Use the Retrieve Service Profiles API request to search for service profiles and determine their identifiers and available locations.
type `string`	Service profile type. Example: L2_PROFILE
uuid `string`	Service profile identifier. Example: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c
location `object`	Connection endpoint location information. Applicable to `SP` type access points.
region `string`	Broad geographic area in which a specified Equinix asset is located. Example: EMEA
metroName `string`	Metropolitan area name. Example: Brussels
metroCode `string`	Metropolitan area identifier. Example: BL
network `object`	Fabric network instance information. Applicable to `NETWORK` type access points.
uuid `string`	Equinix-assigned Fabric network instance identifier. Example: 20d32a80-0d61-4333-bc03-707b591ae2f4
name `string`	Network name. Example: EPLAN-GLOBAL-1017a
type `string`	Network type. Example: EPLAN
scope `string`	Network geographic scope. Example: GLOBAL
serviceToken `object`	Service token specification. Applicable to connections that use Z-side service tokens.
uuid `string`	Service token identifier. Example: e05f4f23-d098-4d7c-a9ca-c2897b465107

Manage Connection

	POST /fabric/v4/connections/{uuid}/actions
Method	POST
URL or Endpoint	/fabric/v4/connections/{uuid}/actions
Headers	Authorization, Content-Type
Path Parameters	uuid
Query Parameters	Not applicable
Body Parameters	type, data, description

This API enables:

Approving connections
Rejecting connections
Approving connection bandwidth change
Rejecting connection bandwidth change
Accepting connection deletion
Triggering BGP synchronization (applicable to Microsoft Azure connections)
Fetching latest bandwidth from provider

For instructions on how to obtain an authorization token, refer to Requesting Access and Refresh Tokens.

Sample curl request - approve connection

curl -X
POST 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62/actions'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "type": "CONNECTION_CREATION_ACCEPTANCE",
    "data": {
        "zSide": {
            "accessPoint": {
                "type": "COLO",
                "port": {
                    "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
                },
                "linkProtocol": {
                    "type": "QINQ",
                    "vlanSTag": 1002,
                    "vlanCTag": 1001
                }
            }
        }
    }
}'

Sample curl request - reject connection

curl -X
POST 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62/actions'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "type": "CONNECTION_CREATION_REJECTION",
    "description": "Invalid connection update request"
}'

Sample curl request - approve connection bandwidth update

curl -X
POST 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62/actions'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "type": "CONNECTION_UPDATE_ACCEPTANCE"
}'

Sample curl request - reject connection bandwidth update

curl -X
POST 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62/actions'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "type": "CONNECTION_UPDATE_REJECTION",
    "description": "Invalid connection update request"
}'

Sample curl request - accept connection deletion

curl -X
POST 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62/actions'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "type": "CONNECTION_DELETION_ACCEPTANCE"
}'

Sample curl request - trigger Microsoft Azure connection BGP synchronization

curl -X
POST 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62/actions'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "type": "CONNECTION_PROVIDER_STATUS_REQUEST"
}'

Sample curl request - fetching latest bandwidth from provider

curl -X
POST 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62/actions'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "type": "CONNECTION_PROVIDER_BANDWIDTH_REQUEST"
}'

Path parameters

Parameter	Description
uuid `string` REQUIRED	Equinix-assigned connection identifier.

Body parameters

Parameter	Description
type `string` REQUIRED	Connection management action. Applicable values: CONNECTION_CREATION_ACCEPTANCE - Approve pending connection. CONNECTION_CREATION_REJECTION - Reject pending connection. CONNECTION_UPDATE_ACCEPTANCE - Approve bandwidth update. CONNECTION_UPDATE_REJECTION - Reject bandwidth update. CONNECTION_DELETION_ACCEPTANCE - Accept connection deletion. CONNECTION_PROVIDER_STATUS_REQUEST - Send BGP synchronization request. CONNECTION_PROVIDER_BANDWIDTH_REQUEST - fetch the latest bandwidth from provider. Note that the action type determines the list of applicable body parameters.
description `object` REQUIRED	Rejection reason. Applicable to `CONNECTION_UPDATE_REJECTION` action type. Example: Invalid connection update request.
data `string` CONDITIONAL	Additional data related to the connection action type. Applicable to `CONNECTION_CREATION_ACCEPTANCE` action type.
zSide `object` REQUIRED	Z-side (provider) connection configuration.
accessPoint `object` REQUIRED	Connection endpoint configuration.
type `string` REQUIRED	Connection endpoint type. Applicable values: COLO - Colocation space in an IBX data center.
port `object` REQUIRED	Port associated with the connection.
uuid `string` REQUIRED	Equinix-assigned port identifier. Example: 20d32a80-0d61-4333-bc03-707b591ae2f4
linkProtocol `object` REQUIRED	Link protocol configuration.
type `string` REQUIRED	Link protocol type. Applicable values: DOT1Q QINQ
vlanTag `integer` REQUIRED	DOT1Q protocol VLAN tag. Applicable values: Minimum: 2 Maximum: 4094
vlanSTag `integer` REQUIRED	QINQ protocol outer (service) VLAN tag used to identify packets as they traverse trunk lines. Applicable values: Minimum: 2 Maximum: 4094
vlanCTag `integer` REQUIRED	QINQ protocol inner (customer) VLAN tag used to identify packets as they traverse trunk lines. Applicable values: Minimum: 2 Maximum: 4094

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Sample response - approve connection

{
    "href": "https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62",
    "type": "EVPL_VC",
    "uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",
    "name": "Conn-Name-2",
    "state": "PROVISIONED",
    "order": {
        "purchaseOrderNumber": "1-129105284100",
        "billingTier": "Up to 1 Gbps"
    },
    "bandwidth": 1000,
    "change": {
        "uuid": "da6a1a0b-0872-4c06-b9d7-5c8ee3056775",
        "type": "CONNECTION_CREATION",
        "status": "APPROVED",
        "createdDateTime": "2021-12-12T06:00:01.183Z",
    },
    "redundancy": {
        "group": "m167f685-41b0-1b07-6de0-320a5c00abeu",
        "priority": "PRIMARY"
    },
    "aSide": {
        "accessPoint": {
            "type": "COLO",
            "port": {
                "href": "https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd",
                "type": "XF_PORT",
                "uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
            },
            "linkProtocol": {
                "type": "DOT1Q",
                "vlanTag": 1001
            }
        }
    },
    "zSide": {
        "accessPoint": {
            "type": "SP",
            "profile": {
                "href": "https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd",
                "type": "L2_Profile",
                "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
            },
            "location": {
                "href": "https://api.equinix.com/v4/metros/SV",
                "metrocode": "SV",
                "region": "AMER"
            },
            "port": {
                "href": "https://api.equinix.com/fabric/v4/ports/c791f8cb-5ae1-ae10-8ce0-306a5c00a4ee",
                "uuid": "c791f8cb-5ae1-ae10-8ce0-306a5c00a4ee",
                "name": "testBuyer-FR4-L-Dot1q-STD-PRI-10G-JN-489"
            },
            "linkProtocol": {
                "type": "DOT1Q",
                "vlanTag": 837
            }
        }
    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "test@equinix.com",
                "test@equinix.com"
            ]
        }
    ],
    "operation": {
        "equinixStatus": "PROVISIONED",
        "providerStatus": "PROVISIONED"
    },
    "changeLog": {
        "createdDateTime": "2021-07-15T19:30:29.526Z",
        "updatedDateTime": "2021-08-15T19:30:29.526Z",
    }
}

Response payload body description

Parameter	Description
href `string`	An absolute URL that returns the specified connection. Example: https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62
type `string`	Connection type. Example: EVPL_VC - Ethernet virtual private line connection type used for tagged layer 2 connections. EPL_VC - Ethernet private line connection type used for untagged layer 2 connections. ACCESS_EPL_VC - E-access, layer 2 connection between a QINQ port and an EPL port. IP_VC - Layer 2 connection between a Fabric Cloud Router instance and a port. EVPLAN_VC - Ethernet virtual private local area network connection for DOT1Q ports or virtual devices.
uuid `string`	Equinix-assigned connection identifier. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
name `string`	Connection name. Example: my_connection
state `string`	Lifecycle stage of a connection. Example: PROVISIONED
order `object`	Order details.
purchaseOrderNumber `string`	Subscriber's purchase order identifier. Example: 1-129105284100
billingTier `string`	Billing tier for connection bandwidth. Example: Up to 1 Gbps
bandwidth `integer`	Connection bandwidth in Mbps. Example: 10 50 200 500 1000 2000 5000 10000
change `object`	Connection update details.
uuid `string`	Connection change identifier. Example: da6a1a0b-0872-4c06-b9d7-5c8ee3056775
type `string`	Connection change action. Example: CONNECTION_CREATION
status `string`	Connection change status. Example: APPROVED
createdDateTime `string`	Connection change creation timestamp in the IETF ISO 8601 extended date/time format: Example: 2021-07-15T19:30:29.526Z
redundancy `object`	Connection redundancy configuration.
group `string`	Redundancy group identifier. Example: 5c0e9384-aa79-4ec9-b7a2-557f8c307292
priority `string`	Relative priority in a redundancy group. Example: PRIMARY SECONDARY
operation `object`	Connection type-specific operational data.
equinixStatus `string`	Progress towards provisioning a specified connection. Example: PROVISIONING
providerStatus `string`	Provider's progress towards provisioning a specified connection. Example: NOT_AVAILABLE
notifications `array[object]`	Notification settings for messages related to the asset configuration or its status.
type `string`	Notification messages category. Example: ALL
emails `array[string]`	Email addresses of up to 12 recipients. Example: ["mike@mspp.com","dwight@dm.com"]
account `object`	Customer account information.
accountNumber `integer`	Equinix-assigned account number. Example: 270106
orgId `integer`	Equinix-assigned organization identifier. Example: 92362
globalOrgId `string`	Equinix-assigned top-level organization identifier. Example: 0016u000003JZ62AAG
changeLog `object`	A permanent record of asset creation, modification, or deletion.
createdBy `string`	Identity of the asset creator. Example: AverageJoe
createdDateTime `string`	Asset creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z
updatedBy `string`	Identity of the person who updated the asset. Example: AverageJoe
updatedDateTime `string`	Asset update request timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z
bandwidth `integer`	Connection bandwidth in Mbps. Example: 10 50 200 500 1000 2000 5000 10000
isRemote `boolean`	Indicates if both connection endpoints are in the same location. Example: false
direction `string`	Direction of the connection (from the requester's point of view). Example: OUTGOING
aSide `object`	Source port definition.
accessPoint `object`	Connection endpoint configuration.
type `string`	Connection endpoint type. Example: COLO - Colocation space in an IBX data center. VD - Network Edge virtual device. CLOUD_ROUTER - Fabric Cloud Router instance. NETWORK - Fabric network that enables creating multipoint connections. METAL_NETWORK - Metal instance.
account `object`	Customer account information.
accountNumber `integer`	Equinix-assigned account number. Example: 270106
orgId `integer`	Equinix-assigned organization identifier. Example: 92362
globalOrgId `string`	Equinix-assigned top-level organization identifier. Example: 0016u000003JZ62AAG
location `object`	Port associated with the connection.
region `string`	Broad geographic area in which a specified Equinix asset is located. Example: EMEA
metroName `string`	Metropolitan area name. Example: Brussels
metroCode `string`	Metropolitan area identifier. Example: BL
port `object`	Port associated with the connection.
href `string`	An absolute URL that returns the specified port. Example: https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd
uuid `string`	Equinix-assigned port identifier. Example:
name `string`	Equinix-assigned port name. Example: 272010-SV5-CX-Secondary-01
redundancy `object`	Port redundancy information.
priority `string`	Relative port priority. Example: SECONDARY
linkProtocol `object`	Link protocol configuration. Applicable to `COLO` and `VD` type access points.
type `string`	Link protocol type. Example: DOT1Q QINQ UNTAGGED
vlanTag `integer`	DOT1Q protocol VLAN tag. Example: 222
vlanSTag `integer`	QINQ protocol, outer (service) VLAN tag used to identify packets as they traverse trunk lines. Example: 222
vlanCTag `integer`	QINQ protocol, inner (customer) VLAN tag used to identify packets as they traverse trunk lines. Example: 333
virtualDevice `object`	Virtual device configuration. Applicable to `VD` type access points.
type `string`	Equinix-assigned virtual device identifier. EDGE
uuid `string`	Virtual device instance identifier.
interface `object`	Interface configuration. Applicable to `VD` type access points.
type `string`	Virtual device network interface type. Example: NETWORK CLOUD
id `integer`	Virtual device network interface identifier. Example: 544211
router `object`	Port associated with the connection.
href `string`	Absolute URL that returns the specified entity. Example: http://api.equinix.com/fabric/v4/routers/bb818900-d4b4-445a-85a2-cecd88061662
uuid `string`	Fabric Cloud Router identifier. Example: bb818900-d4b4-445a-85a2-cecd88061662
name `string`	Fabric Cloud Router name. Example: E2E-API-FG
serviceToken `object`	Service token specification. Applicable to connections that use A-side service tokens.
uuid `string`	Service token identifier. Example: e05f4f23-d098-4d7c-a9ca-c2897b465107
zSide `object`	Destination port definition.
accessPoint `object`	Connection endpoint configuration.
type `string`	Connection endpoint type. Example: COLO - Colocation space in an IBX data center. SP - Service profile. VD - Network Edge virtual device. NETWORK - Fabric network that enables creating multipoint connections. METAL_NETWORK - Metal instance.
account `object`	Customer account information.
accountNumber `integer`	Equinix-assigned account number. Example: 270106
orgId `string`	Equinix-assigned organization identifier. Example: 92362
globalOrgId `string`	Equinix-assigned top-level organization identifier. Example: 0016u000003JZ62AAG
location `object`	Port associated with the connection.
region `string`	Broad geographic area in which a specified Equinix asset is located. Example: EMEA
metroName `string`	Metropolitan area name. Example: Brussels
metroCode `string`	Metropolitan area identifier. Example: BL
port `object`	Port associated with the connection.
href `string`	An absolute URL that returns the specified port. Example: https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd
uuid `string`	Equinix-assigned port identifier. Example:
name `string`	Equinix-assigned port name. Example: 272010-SV5-CX-Secondary-01
redundancy `object`	Port redundancy information.
priority `string`	Relative port priority. Example: SECONDARY
linkProtocol `object`	Link protocol configuration. Applicable to `COLO` and `VD` type access points.
type `string`	Link protocol type. Example: DOT1Q QINQ UNTAGGED
vlanTag `integer`	DOT1Q protocol VLAN tag. Example: 222
vlanTagMin `integer`	DOT1Q protocol VLAN tag range lowest value. Applicable to connections originating from Network Edge devices. Required if `vlanTag` isn't specified. Example: 222
vlanTagMax `integer`	DOT1Q protocol VLAN tag range highest value. Applicable to connections originating from Network Edge devices. Required if `vlanTag` isn't specified. Example: 333
vlanSTag `integer`	QINQ protocol, outer (service) VLAN tag used to identify packets as they traverse trunk lines. Example: 222
vlanCTag `integer`	QINQ protocol, inner (customer) VLAN tag used to identify packets as they traverse trunk lines. Example: 222
vlanCTagMin `integer`	QINQ protocol lowest customer VLAN tag value. Applicable to connections originating from Network Edge devices. Required if `vlanCTag` isn't specified. Example: 222
vlanCTagMax `integer`	QINQ protocol highest customer VLAN tag value. Applicable to connections originating from Network Edge devices. Required if `vlanCTag` isn't specified. Example: 333
profile `object`	A named provider service and its network connectivity requirements. Applicable to `SP` type access points. Use the Retrieve Service Profiles API request to search for service profiles and determine their identifiers and available locations.
type `string`	Service profile type. Example: L2_PROFILE
uuid `string`	Service profile identifier. Example: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c
location `object`	Connection endpoint location information. Applicable to `SP` type access points.
region `string`	Broad geographic area in which a specified Equinix asset is located. Example: EMEA
metroName `string`	Metropolitan area name. Example: Brussels
metroCode `string`	Metropolitan area identifier. Example: BL
network `object`	Fabric network instance information. Applicable to `NETWORK` type access points.
uuid `string`	Equinix-assigned Fabric network instance identifier. Example: 20d32a80-0d61-4333-bc03-707b591ae2f4
name `string`	Network name. Example: EPLAN-GLOBAL-1017a
type `string`	Network type. Example: EPLAN
scope `string`	Network geographic scope. Example: GLOBAL
serviceToken `object`	Service token specification. Applicable to connections that use Z-side service tokens.
uuid `string`	Service token identifier. Example: e05f4f23-d098-4d7c-a9ca-c2897b465107

Sample response - fetching the latest bandwidth from provider

{
    "type": "CONNECTION_PROVIDER_BANDWIDTH_REQUEST",
    "data": {
        "providerBandwidth": 500
    },
    "changeLog": {
        "createdDateTime": "2024-07-10T21:58:51.581Z",
        "updatedDateTime": "2024-07-10T21:58:51.581Z"
    }

Response payload body description - fetching the latest bandwidth from provider

Parameter	Description
type `string`	Connection change action. Example: CONNECTION_PROVIDER_BANDWIDTH_REQUEST
data `object`	Object with result set.
providerBandwidth `integer`	Bandwidth configured on the provider token. This may be different from (usually equal or greater than) the bandwidth utilized on the connection. Example: 2GB
changeLog `object`	A permanent record of asset creation, modification, or deletion.
createdBy `string`	Identity of the asset creator. Example: AverageJoe
createdDateTime `string`	Asset creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z

Delete Connection

	DELETE /fabric/v4/connections/{uuid}
Method	DELETE
URL or Endpoint	/fabric/v4/connections/{uuid}
Headers	Authorization
Path Parameters	uuid
Query Parameters	Not applicable
Body Parameters	Not applicable

This API request deletes a specified connection.

For instructions on how to obtain an authorization token, refer to Requesting Access and Refresh Tokens.

Sample curl request

curl -X
DELETE 'https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI

Path parameters

Parameter	Description
uuid `string` REQUIRED	Equinix-assigned connection identifier.

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Sample response

{
    "href": "https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62",
    "type": "EVPL_VC",
    "uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",
    "name": "Conn-1",
    "state": "DEPROVISIONING",
    "order": {
        "purchaseOrderNumber": "1-129105284100",
        "billingTier": "Up to 1 Gbps"
    },
    "bandwidth": 1000,
    "redundancy": {
        "group": "m167f685-41b0-1b07-6de0-320a5c00abeu",
        "priority": "PRIMARY"
    },
    "aSide": {
        "accessPoint": {
            "type": "COLO",
            "port": {
                "href": "https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd",
                "type": "XF_PORT",
                "uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
            },
            "linkProtocol": {
                "type": "DOT1Q",
                "vlanTag": 1001
            }
        }
    },
    "zSide": {
        "accessPoint": {
            "type": "SP",
            "profile": {
                "href": "https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd",
                "type": "L2_Profile",
                "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
            },
            "location": {
                "href": "https://api.equinix.com/v4/metros/SV",
                "metrocode": "SV",
                "region": "AMER"
            }
        }
    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "test@equinix.com",
                "test@equinix.com"
            ]
        }
    ],
    "operation": {
        "equinixStatus": "DEPROVISIONING",
        "providerStatus": "DEPROVISIONING"
    },
    "changeLog": {
        "createdDateTime": "2021-07-15T19:30:29.526Z",
        "deletedDateTime": "2021-08-15T11:10:19.516Z"
    }
}

Response payload body description

Parameter	Description
type `string`	Connection type. Example: EVPL_VC - Ethernet virtual private line connection type used for tagged layer 2 connections. EPL_VC - Ethernet private line connection type used for untagged layer 2 connections. ACCESS_EPL_VC - E-access, layer 2 connection between a QINQ port and an EPL port. IP_VC - Layer 2 connection between a Fabric Cloud Router instance and a port. EVPLAN_VC - Ethernet virtual private local area network connection for DOT1Q ports or virtual devices.
href `string`	An absolute URL that returns the specified connection. Example: https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62
uuid `string`	Equinix-assigned connection identifier. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
name `string`	Connection name. Example: my_connection
state `string`	Lifecycle stage of a connection. Example: DEPROVISIONING
operation `object`	Connection type-specific operational data.
equinixStatus `string`	Progress towards provisioning a specified connection. Example: PROVISIONING
providerStatus `string`	Provider's progress towards provisioning a specified connection. Example: NOT_AVAILABLE
order `object`	Order details.
purchaseOrderNumber `string`	Subscriber's purchase order identifier. Example: 1-129105284100
billingTier `string`	Billing tier for connection bandwidth. Example: Up to 1 Gbps
notifications `array[object]`	Notification settings for messages related to the asset configuration or its status.
type `string`	Notification messages category. Example: ALL
emails `array[string]`	Email addresses of up to 12 recipients. Example: ["mike@mspp.com","dwight@dm.com"]
account `object`	Customer account information.
accountNumber `integer`	Equinix-assigned account number. Example: 270106
orgId `integer`	Equinix-assigned organization identifier. Example: 92362
globalOrgId `string`	Equinix-assigned top-level organization identifier. Example: 0016u000003JZ62AAG
changeLog `object`	A permanent record of asset creation, modification, or deletion.
createdBy `string`	Identity of the asset creator. Example: AverageJoe
createdDateTime `string`	Asset creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z
bandwidth `integer`	Connection bandwidth in Mbps. Example: 10 50 200 500 1000 2000 5000 10000
redundancy `object`	Connection redundancy configuration.
group `string`	Redundancy group identifier. Example: 5c0e9384-aa79-4ec9-b7a2-557f8c307292
priority `string`	Relative priority in a redundancy group. Example: PRIMARY SECONDARY
isRemote `boolean`	Indicates if both connection endpoints are in the same location. Example: false
direction `string`	Direction of the connection (from the requester's point of view). Example: OUTGOING
aSide `object`	Source port definition.
accessPoint `object`	Connection endpoint configuration.
type `string`	Connection endpoint type. Example: COLO - Colocation space in an IBX data center. VD - Network Edge virtual device. CLOUD_ROUTER - Fabric Cloud Router instance. NETWORK - Fabric network that enables creating multipoint connections. METAL_NETWORK - Metal instance.
account `object`	Customer account information.
accountNumber `integer`	Equinix-assigned account number. Example: 270106
orgId `integer`	Equinix-assigned organization identifier. Example: 92362
globalOrgId `string`	Equinix-assigned top-level organization identifier. Example: 0016u000003JZ62AAG
location `object`	Port associated with the connection.
region `string`	Broad geographic area in which a specified Equinix asset is located. Example: EMEA
metroName `string`	Metropolitan area name. Example: Brussels
metroCode `string`	Metropolitan area identifier. Example: BL
port `object`	Port associated with the connection.
href `string`	An absolute URL that returns the specified port. Example: https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd
uuid `string`	Equinix-assigned port identifier. Example:
name `string`	Equinix-assigned port name. Example: 272010-SV5-CX-Secondary-01
redundancy `object`	Port redundancy information.
priority `string`	Relative port priority. Example: SECONDARY
linkProtocol `object`	Link protocol configuration. Applicable to `COLO` and `VD` type access points.
type `string`	Link protocol type. Example: DOT1Q QINQ UNTAGGED
vlanTag `integer`	DOT1Q protocol VLAN tag. Example: 222
vlanSTag `integer`	QINQ protocol, outer (service) VLAN tag used to identify packets as they traverse trunk lines. Example: 222
vlanCTag `integer`	QINQ protocol, inner (customer) VLAN tag used to identify packets as they traverse trunk lines. Example: 333
virtualDevice `object`	Virtual device configuration. Applicable to `VD` type access points.
type `string`	Equinix-assigned virtual device identifier. EDGE
uuid `string`	Virtual device instance identifier.
interface `object`	Interface configuration. Applicable to `VD` type access points.
type `string`	Virtual device network interface type. Example: NETWORK CLOUD
id `integer`	Virtual device network interface identifier. Example: 544211
router `object`	Port associated with the connection.
href `string`	Absolute URL that returns the specified entity. Example: http://api.equinix.com/fabric/v4/routers/bb818900-d4b4-445a-85a2-cecd88061662
uuid `string`	Fabric Cloud Router identifier. Example: bb818900-d4b4-445a-85a2-cecd88061662
name `string`	Fabric Cloud Router name. Example: E2E-API-FG
serviceToken `object`	Service token specification. Applicable to connections that use A-side service tokens.
uuid `string`	Service token identifier. Example: e05f4f23-d098-4d7c-a9ca-c2897b465107
zSide `object`	Destination port definition.
accessPoint `object`	Connection endpoint configuration.
type `string`	Connection endpoint type. Example: COLO - Colocation space in an IBX data center. SP - Service profile. VD - Network Edge virtual device. NETWORK - Fabric network that enables creating multipoint connections. METAL_NETWORK - Metal instance.
account `object`	Customer account information.
accountNumber `integer`	Equinix-assigned account number. Example: 270106
orgId `string`	Equinix-assigned organization identifier. Example: 92362
globalOrgId `string`	Equinix-assigned top-level organization identifier. Example: 0016u000003JZ62AAG
location `object`	Port associated with the connection.
region `string`	Broad geographic area in which a specified Equinix asset is located. Example: EMEA
metroName `string`	Metropolitan area name. Example: Brussels
metroCode `string`	Metropolitan area identifier. Example: BL
port `object`	Port associated with the connection.
href `string`	An absolute URL that returns the specified port. Example: https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd
uuid `string`	Equinix-assigned port identifier. Example:
name `string`	Equinix-assigned port name. Example: 272010-SV5-CX-Secondary-01
redundancy `object`	Port redundancy information.
priority `string`	Relative port priority. Example: SECONDARY
linkProtocol `object`	Link protocol configuration. Applicable to `COLO` and `VD` type access points.
type `string`	Link protocol type. Example: DOT1Q QINQ UNTAGGED
vlanTag `integer`	DOT1Q protocol VLAN tag. Example: 222
vlanTagMin `integer`	DOT1Q protocol VLAN tag range lowest value. Applicable to connections originating from Network Edge devices. Required if `vlanTag` isn't specified. Example: 222
vlanTagMax `integer`	DOT1Q protocol VLAN tag range highest value. Applicable to connections originating from Network Edge devices. Required if `vlanTag` isn't specified. Example: 333
vlanSTag `integer`	QINQ protocol, outer (service) VLAN tag used to identify packets as they traverse trunk lines. Example: 222
vlanCTag `integer`	QINQ protocol, inner (customer) VLAN tag used to identify packets as they traverse trunk lines. Example: 222
vlanCTagMin `integer`	QINQ protocol lowest customer VLAN tag value. Applicable to connections originating from Network Edge devices. Required if `vlanCTag` isn't specified. Example: 222
vlanCTagMax `integer`	QINQ protocol highest customer VLAN tag value. Applicable to connections originating from Network Edge devices. Required if `vlanCTag` isn't specified. Example: 333
profile `object`	A named provider service and its network connectivity requirements. Applicable to `SP` type access points. Use the Retrieve Service Profiles API request to search for service profiles and determine their identifiers and available locations.
type `string`	Service profile type. Example: L2_PROFILE
uuid `string`	Service profile identifier. Example: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c
location `object`	Connection endpoint location information. Applicable to `SP` type access points.
region `string`	Broad geographic area in which a specified Equinix asset is located. Example: EMEA
metroName `string`	Metropolitan area name. Example: Brussels
metroCode `string`	Metropolitan area identifier. Example: BL
network `object`	Fabric network instance information. Applicable to `NETWORK` type access points.
uuid `string`	Equinix-assigned Fabric network instance identifier. Example: 20d32a80-0d61-4333-bc03-707b591ae2f4
name `string`	Network name. Example: EPLAN-GLOBAL-1017a
type `string`	Network type. Example: EPLAN
scope `string`	Network geographic scope. Example: GLOBAL
serviceToken `object`	Service token specification. Applicable to connections that use Z-side service tokens.
uuid `string`	Service token identifier. Example: e05f4f23-d098-4d7c-a9ca-c2897b465107

Validate Connection Authorization Key

	POST /fabric/v4/connection/validate
Method	POST
URL or Endpoint	/fabric/v4/connection/validate
Headers	Authorization, Content-Type
Path Parameters	Not applicable
Query Parameters	Not applicable
Body Parameters	filter

This API request validates the authorization key required for establishing connections to cloud service providers.

For instructions on how to obtain an authorization token, refer to Requesting Access and Refresh Tokens.

Sample curl request

curl -X POST 'http://api.equinix.com/fabric/v4/connections/validate'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "filter": {
        "and": [
            {
                "property": "/zSide/accessPoint/authenticationKey",
                "operator": "=",
                "values": [
                    "xx-xx-xx"
                ]
            },
            {
                "property": "/zSide/accessPoint/profile/uuid",
                "operator": "=",
                "values": [
                    "20d32a80-0d61-4333-bc03-707b591ae2f5"
                ]
            },
            {
                "property": "/zSide/accessPoint/sellerRegion",
                "operator": "=",
                "values": [
                    "us-west1"
                ]
            }
        ]
    }
}'

Body parameters

Parameter	Description
filter `object` REQUIRED	Object containing Z-side access point parameters for validation.
and `array[object]` REQUIRED	Array of access point parameters.
property `string` REQUIRED	Access point parameter. Applicable values: /zSide/accessPoint/authenticationKey /zSide/accessPoint/profile/uuid /zSide/accessPoint/sellerRegion
operator `string` REQUIRED	Parameter operator. Applicable values: =
values `string` REQUIRED	Parameter value. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

/zSide/accessPoint/authenticationKey	Example: "property": "/zSide/accessPoint/authenticationKey", "operator": "=", "values": [ "xx-xx-xx" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: =
value `array[string]` REQUIRED	Connection name. Example: ["xx-xx-xx"]

/zSide/accessPoint/profile/uuid	Example: "property": "/zSide/accessPoint/profile/uuid", "operator": "=", "values": [ "3a58dd05-f46d-4b1d-a154-2e85c396ea62 ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: =
value `array[string]` REQUIRED	Equinix-assigned service profile identifier. Example: ["3a58dd05-f46d-4b1d-a154-2e85c396ea62"]

/zSide/accessPoint/sellerRegion	Example: "property": "/zSide/accessPoint/sellerRegion", "operator": "=", "values": [ "us-west1" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: =
value `array[string]` REQUIRED	Service provider region. Not applicable to connections to Microsoft Azure. Example: ["us-west1"]

Sample response - validate connection to Microsoft Azure

{
    "additionalInfo": [
        {
            "key": "message",
            "value": "Authorization key provided is valid"
        }
    ],
    "data": [
        {
            "bandwidth": 500,
            "redundancy": {
                "priority": "PRIMARY"
            },
            "zSide": {
                "accessPoint": {
                    "type": "COLO",
                    "port": {
                        "type": "XF_PORT",
                        "name": "SIN-TEST-EQIX-06GMR-CIS-1-PRI-A"
                    },
                    "linkProtocol": {
                        "type": "QINQ",
                        "vlanSTag": 1003
                    }
                }
            }
        },
        {
            "bandwidth": 500,
            "redundancy": {
                "priority": "SECONDARY"
            },
            "zSide": {
                "accessPoint": {
                    "type": "COLO",
                    "port": {
                        "type": "XF_PORT",
                        "name": "SIN-TEST-EQIX-06GMR-CIS-1-PRI-2"
                    },
                    "linkProtocol": {
                        "type": "QINQ",
                        "vlanSTag": 1003
                    }
                }
            }
        }
    ]
}

Response payload body description

Parameter	Description
additionalInfo `array[object]`	An array of key-value pair objects containing additional information.
key `string`	Additional information key parameter. Example: message
value `string`	Validation result message. Example: Authorization key provided is valid
data `array[object]`	Data array containing connection properties.
bandwidth `integer`	Connection bandwidth in Mbps. Example: 500
redundancy `object`	Connection redundancy configuration.
priority `string`	Relative priority in a redundancy group. Example: PRIMARY
zSide `object`	Destination port definition.
accessPoint `object`	Connection endpoint configuration.
type `string`	Connection endpoint type. Example: COLO - Colocation space in an IBX data center.
port `object`	Port associated with the connection.
name `string`	Equinix-assigned port name. Example: 272010-SV5-CX-Secondary-01
linkProtocol `object`	Link protocol configuration. Applicable to `COLO` and `VD` type access points.
type `string`	Link protocol type. Example: DOT1Q QINQ UNTAGGED
vlanTag `integer`	DOT1Q protocol VLAN tag. Example: 222
vlanSTag `integer`	QINQ protocol, outer (service) VLAN tag used to identify packets as they traverse trunk lines. Example: 222

Fabric Cloud Routers

Create Fabric Cloud Router

	POST /fabric/v4/routers
Method	POST
URL or Endpoint	/fabric/v4/routers
Headers	Authorization, Content-Type
Path Parameters	Not applicable
Query Parameters	Not applicable
Body Parameters	type, name, location, package, order, notifications, account, project

This API creates a Fabric Cloud Router instance.

Sample curl request

curl -X
POST 'https: //api.equinix.com/fabric/v4/routers'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "type": "XF_ROUTER",
    "name": "My-Fabric-Cloud-Router",
    "location": {
        "metroCode": "SV"
    },
    "package": {
        "code": "LAB"
    },
    "order": {
        "purchaseOrderNumber": "1-129105284100"
    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "test@test.com"
            ]
        }
    ],
    "account": {
        "accountNumber": 272010
    },
    "project": {
        "projectId": "995072000433550"
    }
}'

Body parameters

Parameter	Description
type `string` REQUIRED	Asset instance type. Example: XF_ROUTER - Fabric Cloud Router.
name `string` REQUIRED	Fabric Cloud Router instance name. Example: My-Fabric-Cloud-Router
location `object` REQUIRED	Fabric Cloud Router location information.
metroCode `string` REQUIRED	Metropolitan area identifier. Example: SV
package `object` REQUIRED	Fabric Cloud Router package determining the number of supported routes and Network Access Control Lists (NACL).
code `string` REQUIRED	Fabric Cloud Router package code. Applicable values: LAB - Max Routes IPv4 = 50; Max Routes IPv6 = 50; 10Mbps max per connection ingress/egress bandwidth limit; Max connections per FCR: 10 (Trial package) STANDARD - Max Routes IPv4 = 1000; Max Routes IPv6 = 100
order `object` OPTIONAL	Order details.
purchaseOrderNumber `string` OPTIONAL	Purchase order identifier. Example: 1-129105284100
notifications `object` REQUIRED	Notification preferences regarding changes in asset configuration or its status.
type `string` REQUIRED	Notification preferences for a specified asset. Applicable values: ALL
emails `array[string]` REQUIRED	List of recipients. Minimum: 1 Maximum: 12 Example: ["test@equinix.com"]
account `object` REQUIRED	Customer billing account information.
accountNumber `integer` REQUIRED	Equinix-assigned account number. Example: 272010
project `object` REQUIRED	Customer resource hierarchy project information. Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId `string` REQUIRED	Customer project identifier. Example: 995072000433550

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Sample response

{
    "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-Fabric-Cloud-Router",
    "location": {
        "metroCode": "HH"
    },
    "package": {
        "code": "LAB"
    },
    "order": {
        "purchaseOrderNumber": "1-129105284100"
    },
    "project": {
        "projectId": "12345"
    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "abc@abc.com"
            ]
        }
    ],
    "account": {
        "accountNumber": 123
    },
    "bgpIpv4RoutesCount": 0,
    "bgpIpv6RoutesCount": 0,
    "connectionCount": 0,
    "changeLog": {
        "createdBy": "abc@xyz.com",
        "createdByFullName": "abc",
        "createdByEmail": "abc@xyz.com",
        "createdDateTime": "2021-09-24T06:59:46Z"
    }
}

Response payload body description

Parameter	Description
href `string`	An absolute URL that returns the specified asset. Example: https://api.equinix.com/fabric/v4/routers/3a58dd05-f46d-4b1d-a154-2e85c396ea62
uuid `string`	Equinix-assigned asset identifier. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
state `string`	Asset lifecycle stage. PENDING - Fabric Cloud Router creation pending. PROVISIONING - Fabric Cloud Router is being provisioned. PROVISIONED - Fabric Cloud Router has been provisioned. LOCKED - Fabric Cloud Router package upgrade has failed. Existing connections associated with this Fabric Cloud Router instance continue to work but you can't make any changes to them or create new ones. For assistance, open a support case with Equinix Service Desk. DEPROVISIONING - Fabric Cloud Router is being deprovisioned. DEPROVISIONED - Fabric Cloud Router has been deprovisioned.
type `string`	Asset instance type. Example: XF_ROUTER - Fabric Cloud Router.
name `string`	Fabric Cloud Router instance name. Example: My-Fabric-Cloud-Router
location `object`	Fabric Cloud Router location information.
metroCode `string`	Metropolitan area identifier. Example: SV
package `object`	Fabric Cloud Router package determining the number of supported routes and Network Access Control Lists (NACL).
code `string`	Fabric Cloud Router package code. Applicable values: LAB - Max Routes IPv4 = 50; Max Routes IPv6 = 50; 10Mbps max per connection ingress/egress bandwidth limit; Max connections per FCR: 10 (Trial package) STANDARD - Max Routes IPv4 = 1000; Max Routes IPv6 = 100
order `object`	Order details.
purchaseOrderNumber `string`	Purchase order identifier. Example: 1-129105284100
project `object`	Customer resource hierarchy project information. Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId `string`	Customer project identifier. Example: 995072000433550
notifications `object`	Notification preferences regarding changes in asset configuration or its status.
type `string`	Notification preferences for a specified asset. Applicable values: ALL
emails `array[string]`	List of recipients. Minimum: 1 Maximum: 12 Example: ["test@equinix.com"]
account `object`	Customer billing account information.
accountNumber `integer`	Equinix-assigned account number. Example: 272010
bgpIpv4RoutesCount `integer`	Number of IPv4 BGP routes in use. Example: 0
bgpIpv6RoutesCount `integer`	Number of IPv6 BGP routes in use. Example: 0
connectionCount `integer`	Number of connections associated with this Fabric Cloud Router instance. Example: 0
changeLog `object`	A permanent record of asset creation, modification, or deletion.
createdBy `string`	Identity of the asset creator. Example: AverageJoe
createdByFullName `string`	First and last name of the asset creator. Example: Joe Average
createdByEmail `string`	Email address of the asset creator. Example: joe@average.org
createdDateTime `string`	Asset creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z

Get Specified Fabric Cloud Router

	GET /fabric/v4/routers/{uuid}
Method	GET
URL or Endpoint	/fabric/v4/routers/{uuid}
Headers	Authorization, Content-Type
Path Parameters	uuid
Query Parameters	Not applicable
Body Parameters	Not applicable

This API request retrieves details of a specified Fabric Cloud Router instance.

Sample curl request

curl -X
GET 'https://api.equinix.com/fabric/v4/routers/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter	Description
uuid `string` REQUIRED	Equinix-assigned Fabric Cloud Router identifier. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Sample response

{
    "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-Fabric-Cloud-Router",
    "location": {
        "metroCode": "HH"
    },
    "package": {
        "code": "LAB"
    },
    "order": {
        "purchaseOrderNumber": "1-129105284100"
    },
    "project": {
        "projectId": "12345"
    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "abc@abc.com"
            ]
        }
    ],
    "account": {
        "accountNumber": 123
    },
    "bgpIpv4RoutesCount": 0,
    "bgpIpv6RoutesCount": 0,
    "distinctIpv4PrefixesCount": 4,
    "distinctIpv6PrefixesCount": 4,
    "connectionCount": 0,
    "changeLog": {
        "createdBy": "abc@xyz.com",
        "createdByFullName": "abc",
        "createdByEmail": "abc@xyz.com",
        "createdDateTime": "2021-09-24T06:59:46Z"
    }
}

Response payload body description

Parameter	Description
href `string`	An absolute URL that returns the specified asset. Example: https://api.equinix.com/fabric/v4/routers/3a58dd05-f46d-4b1d-a154-2e85c396ea62
uuid `string`	Equinix-assigned asset identifier. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
state `string`	Asset lifecycle stage. PENDING - Fabric Cloud Router creation pending. PROVISIONING - Fabric Cloud Router is being provisioned. PROVISIONED - Fabric Cloud Router has been provisioned. LOCKED - Fabric Cloud Router package upgrade has failed. Existing connections associated with this Fabric Cloud Router instance continue to work but you can't make any changes to them or create new ones. For assistance, open a support case with Equinix Service Desk. DEPROVISIONING - Fabric Cloud Router is being deprovisioned. DEPROVISIONED - Fabric Cloud Router has been deprovisioned.
type `string`	Asset instance type. Example: XF_ROUTER - Fabric Cloud Router.
name `string`	Fabric Cloud Router instance name. Example: My-Fabric-Cloud-Router
location `object`	Fabric Cloud Router location information.
metroCode `string`	Metropolitan area identifier. Example: SV
package `object`	Fabric Cloud Router package determining the number of supported routes and Network Access Control Lists (NACL).
code `string`	Fabric Cloud Router package code. Applicable values: LAB - Max Routes IPv4 = 50; Max Routes IPv6 = 50; 10Mbps max per connection ingress/egress bandwidth limit; Max connections per FCR: 10 (Trial package) STANDARD - Max Routes IPv4 = 1000; Max Routes IPv6 = 100
order `object`	Order details.
purchaseOrderNumber `string`	Purchase order identifier. Example: 1-129105284100
project `object`	Customer resource hierarchy project information. Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId `string`	Customer project identifier. Example: 995072000433550
notifications `object`	Notification preferences regarding changes in asset configuration or its status.
type `string`	Notification preferences for a specified asset. Applicable values: ALL
emails `array[string]`	List of recipients. Minimum: 1 Maximum: 12 Example: ["test@equinix.com"]
account `object`	Customer billing account information.
accountNumber `integer`	Equinix-assigned account number. Example: 272010
bgpIpv4RoutesCount `integer`	Number of IPv4 BGP routes in use (including non-distinct prefixes). Example: 0
bgpIpv6RoutesCount `integer`	Number of IPv6 BGP routes in use (including non-distinct prefixes). Example: 0
distinctIpv4PrefixesCount `integer`	Number of distinct IPv4 routes. Example: 4
distinctIpv6PrefixesCount `integer`	Number of distinct IPv6 routes. Example: 4
connectionCount `integer`	Number of connections associated with this Fabric Cloud Router instance. Example: 0
changeLog `object`	A permanent record of asset creation, modification, or deletion.
createdBy `string`	Identity of the asset creator. Example: AverageJoe
createdByFullName `string`	First and last name of the asset creator. Example: Joe Average
createdByEmail `string`	Email address of the asset creator. Example: joe@average.org
createdDateTime `string`	Asset creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z

Update Fabric Cloud Router

	PATCH /fabric/v4/routers/{uuid}
Method	PATCH
URL or Endpoint	/fabric/v4/routers/{uuid}
Headers	Authorization, Content-Type
Path Parameters	uuid
Query Parameters	Not applicable
Body Parameters	op, path, value

This API modifies Fabric Cloud Router instance parameters.

Sample curl request

curl -X
PATCH 'https: //api.equinix.com/fabric/v4/routers/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '[
    {
        "op": "replace",
        "path": "/name",
        "value": "Cloud-Router-2"
    }
]'

Path parameters

Parameter	Description
uuid `string` REQUIRED	Equinix-assigned Fabric Cloud Router identifier. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

Body parameters

Parameter	Description
op `string` REQUIRED	Update reqest type. Applicable values: replace add remove
path `string` REQUIRED	Parameter path. Applicable values: /name /package/code
value `string` REQUIRED	New parameter value.

/name
value `string` REQUIRED	Fabric Cloud Router instance name. Example: myUpdatedFabricCloudRouter

/package/code
value `string` REQUIRED	Fabric Cloud Router package code that determines the maximum allowed number of routes and ACL rules. Note that when you upgrade a Fabric Cloud Router package, you can only upgrade to a higher package level. Applicable values: LAB - Max Routes IPv4 = 50; Max Routes IPv6 = 50; 10Mbps max per connection ingress/egress bandwidth limit; Max connections per FCR: 10 (Trial package) STANDARD - Max Routes IPv4 = 1000; Max Routes IPv6 = 100

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Sample response

{
    "href": "https://api.equinix.com/fabric/v4/routers/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
    "uuid": "3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
    "state": "PROVISIONED",
    "operation": {
        "bgpIpv4RoutesUsage": 0,
        "bgpIpv6RoutesUsage": 0,
        "staticIpv4RoutesUsage": 0,
        "staticIpv6RoutesUsage": 0,
        "aclsUsage": 0,
        "aclRulesUsage": 0,
        "connectionCount": 0
    },
    "type": "XF_ROUTER",
    "name": "Cloud-Router-2",
    "location": {
        "metroCode": "HH"
    },
    "package": {
        "code": "LAB"
    },
    "order": {
        "purchaseOrderNumber": "1-129105284100"
    },
    "project": {
        "projectId": 123456
    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "abc@abc.com"
            ]
        }
    ],
    "account": {
        "accountNumber": 123
    },
    "changelog": {
        "createdDateTime": "2021-07-15T19:30:29.526Z",
    }
}

Response payload body description

Parameter	Type	Example values	Description
href	string	https://api.equinix.com/fabric/v4/routers/3a58dd05-f46d-4b1d-a154-2e85c396ea62	An absolute URL that returns the specified asset.
uuid	string	3a58dd05-f46d-4b1d-a154-2e85c396ea62	Equinix-assigned asset identifier.
state	string	PROVISIONED	Asset lifecycle stage. PENDING - Fabric Cloud Router creation pending. PROVISIONING - Fabric Cloud Router is being provisioned. PROVISIONED - Fabric Cloud Router has been provisioned. LOCKED - Fabric Cloud Router package upgrade has failed. Existing connections associated with this Fabric Cloud Router instance continue to work but you can't make any changes to them or create new ones. For assistance, open a support case with Equinix Service Desk. DEPROVISIONING - Fabric Cloud Router is being deprovisioned. DEPROVISIONED - Fabric Cloud Router has been deprovisioned.
operation	object	-	Operational status information.
type	string	XF_ROUTER	Asset instance type. XF_ROUTER - Fabric Cloud Router.
name	string	Cloud-Router-2	Fabric Cloud Router instance name.
location	object	-	Fabric Cloud Router location information.
package	object	-	Fabric Cloud Router package determining the number of supported routes and Access Control Lists (ACL).
order	object	-	Order details.
project	object	-	Project data in customer resource hierarchy.
notifications	array[object]	-	Subscriber preferences for notification of changes in asset configuration or status.
account	object	-	Customer billing account data.
changeLog	object	-	A permanent record of asset creation, modification, or deletion.

operation
bgpIpv4RoutesUsage	integer	0	Number of IPv4 BGP routes in use.
bgpIpv6RoutesUsage	integer	0	Number of IPv6 BGP routes in use.
staticIpv4RoutesUsage	integer	0	Number of IPv4 static routes in use.
staticIpv6RoutesUsage	integer	0	Number of IPv6 static routes in use.
aclsUsage	integer	0	Number of Access Control Lists (ACL) in use.
aclRulesUsage	integer	0	Number of ACL rules in use.
connectionCount	integer	0	Total number of connections to the given Fabric Cloud Router instance.

location
metroCode	string	HH	Metropolitan area identifier.

package
code	string	LAB	Fabric Cloud Router package code. LAB - Max Routes IPv4 = 50; Max Routes IPv6 = 50; 10Mbps max per connection ingress/egress bandwidth limit; Max connections per FCR: 10 (Trial package) STANDARD - Max Routes IPv4 = 1000; Max Routes IPv6 = 100

order
purchaseOrderNumber	string	1-129105284100	Subscriber's purchase order identifier.

project
projectId	integer	123456	Project identifier.

notifications
type	string	ALL	Notification preferences for a specified asset, such as a service token, port, access point, or profile.
emails	array[string]	["test@equinix.com"]	List of recipients.

account
accountNumber	integer	123	Equinix-assigned account number.

changeLog
changeLog.createdDateTime	string	2021-07-15T19:30:29.526Z	Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000

Manage Routing Tables

	POST /fabric/v4/routers/{uuid}/actions
Method	POST
URL or Endpoint	/fabric/v4/routers/{uuid}/actions
Headers	Authorization, Content-Type
Path Parameters	uuid
Query Parameters	Not applicable
Body Parameters	type

This API request triggers update of the Fabric Cloud Router instance's routing tables.

Sample curl request

curl -X
POST 'https://api.equinix.com/fabric/v4/routers/638895bc-4458-4627-9a3d-02c76ab362d7/actions'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "type": "ROUTE_TABLE_ENTRY_UPDATE"
}'

Path parameters

Parameter	Mandatory	Type	Example Values	Applicable Values	Description
uuid	yes	string	638895bc-4458-4627-9a3d-02c76ab362d7	-	Equinix-assigned Fabric Cloud Router instance identifier.

Body parameters

Parameter	Mandatory	Type	Example Values	Applicable Values	Description
type	yes	string	ROUTE_TABLE_ENTRY_UPDATE	ROUTE_TABLE_ENTRY_UPDATE	Routing table management action. ROUTE_TABLE_ENTRY_UPDATE - Update routing table.

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Sample response

{
    "type": "ROUTE_TABLE_ENTRY_UPDATE",
    "uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
    "state": "PENDING",
    "changeLog": {
        "createdDateTime": "2021-07-15T19:30:29.526Z",
        "updatedDateTime": "2021-08-15T19:30:29.526Z"
    }
}

Response payload body description

Parameter	Type	Example values	Description
type	string	ROUTE_TABLE_ENTRY_UPDATE	Routing table management action. ROUTE_TABLE_ENTRY_UPDATE - Update routing table.
uuid	string	3a58dd05-f46d-4b1d-a154-2e85c396ea62	Equinix-assigned action request identifier.
state	string	PENDING	Action execution status. PENDING - Requested action execution pending. DONE - Requested action has been completed successfully. FAILED - Requested action execution has failed.
changeLog	object	-	A permanent record of asset creation, modification, or deletion.

changeLog
createdDateTime	string	2021-07-15T19:30:29.526Z	Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
updatedDateTime	string	2021-08-15T19:30:29.526Z	Asset update timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000

Get Routing Tables Management Requests

	GET /fabric/v4/routers/{uuid}/actions?state=PENDING
Method	GET
URL or Endpoint	/fabric/v4/routers/{uuid}/actions?state=PENDING
Headers	Authorization
Path Parameters	uuid
Query Parameters	state
Body Parameters	Not applicable

This API retrieves routing tables management actions requests.

Sample curl request

curl -X
GET 'https://api.equinix.com/fabric/v4/routers/638895bc-4458-4627-9a3d-02c76ab362d7/actions?state=PENDING'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter	Mandatory	Type	Example Values	Applicable Values	Description
uuid	yes	string	638895bc-4458-4627-9a3d-02c76ab362d7	-	Equinix-assigned Fabric Cloud Router instance identifier.

Query parameters

Parameter	Mandatory	Type	Example Values	Applicable Values	Description
state	no	string	PENDING	PENDING DONE FAILED	Action execution status. PENDING - Requested action execution pending. DONE - Requested action has been completed successfully. FAILED - Requested action execution has failed.

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Sample response

{
    "type": "ROUTE_TABLE_ENTRY_UPDATE",
    "uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
    "state": "PENDING",
    "changeLog": {
        "createdDateTime": "2021-07-15T19:30:29.526Z",
        "updatedDateTime": "2021-08-15T19:30:29.526Z"
    }
}

Response payload body description

Parameter	Type	Example values	Description
type	string	ROUTE_TABLE_ENTRY_UPDATE	Routing table management action. ROUTE_TABLE_ENTRY_UPDATE - Update routing table.
uuid	string	3a58dd05-f46d-4b1d-a154-2e85c396ea62	Equinix-assigned action request identifier.
state	string	PENDING	Action execution status. PENDING - Requested action execution pending. DONE - Requested action has been completed successfully. FAILED - Requested action execution has failed.
changeLog	object	-	A permanent record of asset creation, modification, or deletion.

changeLog
createdDateTime	string	2021-07-15T19:30:29.526Z	Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
updatedDateTime	string	2021-08-15T19:30:29.526Z	Asset update timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000

Retrieve Fabric Cloud Routers

	POST /fabric/v4/routers/search
Method	POST
URL or Endpoint	/fabric/v4/routers/search
Headers	Authorization, Content-Type
Path Parameters	Not applicable
Query Parameters	Not applicable
Body Parameters	filter, pagination, sort

This API request retrieves Fabric Cloud Router instances that match provided search criteria.

For instructions on how to obtain an authorization token, refer to Requesting Access and Refresh Tokens.

Sample curl request

curl -X POST 'http: //api.equinix.com/fabric/v4/routers/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "filter": {
        "and": [
            {
                "property": "/name",
                "operator": "LIKE",
                "values": [
                    "%Test%"
                ]
            },
            {
                "property": "/state",
                "operator": "=",
                "values": [
                    "PROVISIONED"
                ]
            },
            {
                "property": "/project/projectId",
                "operator": "=",
                "values": [
                    "995072000433550"
                ]
            },
            {
                "property": "/location/metroCode",
                "operator": "=",
                "values": [
                    "SV"
                ]
            }
        ]
    },
    "pagination": {
        "offset": 0,
        "limit": 20
    },
    "sort": [
        {
            "direction": "DESC",
            "property": "/changeLog/createdDateTime"
        }
    ]
}'

Body parameters

Parameter	Description
filter `string` REQUIRED	Array of objects defining search conditions.
and `array[object]` REQUIRED	Logical operator applied on objects in the array.
property `string` REQUIRED	Search field parameter. Note that the property value determines the list of applicable operators and values. Applicable values: /name /uuid /state /location/metroCode /location/metroName /package/code /*
operator `string` REQUIRED	Search field parameter operator. Applicable values: = != > >= < <= BETWEEN LIKE IN NOT BETWEEN NOT LIKE NOT IN ~*
value `array[string]` REQUIRED	Search field parameter value.
pagination `object` OPTIONAL	Search results pagination settings.
offset `integer` OPTIONAL	Index of the first item returned in the response. Minimum: 0 Default: 0
limit `integer` OPTIONAL	Maximum number of items returned per data page. Minimum: 1 Default: 20
sort `object` OPTIONAL	Search results sorting settings.
direction `string` OPTIONAL	Search results sorting direction. Applicable values: ASC DESC
property `string` OPTIONAL	Search results sorting parameter. Applicable values: /name /uuid /state /location/metroCode /location/metroName /package/code /changeLog/createdDateTime /changeLog/updatedDateTime Default value: /changeLog/updatedDateTime

/name	Example: "property": "/name", "operator": "LIKE", "values": [ "%test% ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: = != LIKE IN NOT LIKE NOT IN ~*
value `array[string]` REQUIRED	Fabric Cloud Router name. Example: ["%Test%"]

/uuid	Example: "property": "/uuid", "operator": "=", "values": [ "3a58dd05-f46d-4b1d-a154-2e85c396ea62 ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: =
value `array[string]` REQUIRED	Fabric Cloud Router instance identifier. Example: ["3a58dd05-f46d-4b1d-a154-2e85c396ea62"]

/state	Example: "property": "/state", "operator": "=", "values": [ "PROVISIONED" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: = != LIKE IN NOT LIKE NOT IN ~*
value `array[string]` REQUIRED	Asstet lifecycle status. Applicable values: PROVISIONED PROVISIONING DEPROVISIONING DEPROVISIONED LOCKED

/location/metroCode	Example: "property": "/location/metroCode", "operator": "=", "values": [ "SV" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: = != LIKE IN NOT LIKE NOT IN ~*
value `array[string]` REQUIRED	Metropolitan area identifier. Example: ["SV"]

/location/metroName	Example: "property": "/location/metroName", "operator": "=", "values": [ "Silicon Valley" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: = != LIKE IN NOT LIKE NOT IN ~*
value `array[string]` REQUIRED	Metropolitan area name. Example: ["Silicon Valley"]

/router/package/code	Example: "property": "/router/package/code", "operator": "IN", "values": [ "STANDARD", "LAB" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: = != LIKE IN NOT LIKE NOT IN ~*
value `array[string]` REQUIRED	Fabric Cloud Router package identifier. Applicable values: LAB STANDARD

/*	Example: "property": "/*", "operator": "LIKE", "values": [ "%Silicon%" ]
operator `string` REQUIRED	Search field parameter operator. Applicable values: = != LIKE IN NOT LIKE NOT IN ~*
value `array[string]` REQUIRED	All categories search. Example: ["%Silicon%"]

Sample response

{
    "pagination": {
        "offset": 0,
        "limit": 20,
        "total": 1,
        "next": "/search?offset=4&limit=2",
        "previous": "/search?offset=0&limit=2"
    },
    "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-Fabric-Cloud-Router",
            "location": {
                "metroCode": "HH"
            },
            "package": {
                "code": "LAB"
            },
            "order": {
                "purchaseOrderNumber": "1-129105284100"
            },
            "project": {
                "projectId": "12345"
            },
            "notifications": [
                {
                    "type": "ALL",
                    "emails": [
                        "abc@abc.com"
                    ]
                }
            ],
            "account": {
                "accountNumber": 123
            },
            "bgpIpv4RoutesCount": 0,
            "bgpIpv6RoutesCount": 0,
            "connectionCount": 0,
            "changeLog": {
                "createdBy": "abc@xyz.com",
                "createdByFullName": "abc",
                "createdByEmail": "abc@xyz.com",
                "createdDateTime": "2021-09-24T06:59:46Z"
            }
        }
    ]
}

Response payload body description

Parameter	Description
pagination `object`	Search results pagination settings.
offset `integer`	Index of the first item returned in the response. Example: 0
limit `integer`	Maximum number of items returned per page. Example: 20
total `integer`	Total number of items returned. Example: 10
next `string`	Next data page URL. Example: /search?offset=40&limit=20
previous `string`	Previous data page URL. Example: /search?offset=0&limit=20
data `array[object]`	Data array containing objects that match the provided search criteria.
href `string`	An absolute URL that returns the specified asset. Example: https://api.equinix.com/fabric/v4/routers/3a58dd05-f46d-4b1d-a154-2e85c396ea62
uuid `string`	Equinix-assigned asset identifier. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
state `string`	Asset lifecycle stage. PENDING - Fabric Cloud Router creation pending. PROVISIONING - Fabric Cloud Router is being provisioned. PROVISIONED - Fabric Cloud Router has been provisioned. LOCKED - Fabric Cloud Router package upgrade has failed. Existing connections associated with this Fabric Cloud Router instance continue to work but you can't make any changes to them or create new ones. For assistance, open a support case with Equinix Service Desk. DEPROVISIONING - Fabric Cloud Router is being deprovisioned. DEPROVISIONED - Fabric Cloud Router has been deprovisioned.
type `string`	Asset instance type. Example: XF_ROUTER - Fabric Cloud Router.
name `string`	Fabric Cloud Router instance name. Example: My-Fabric-Cloud-Router
location `object`	Fabric Cloud Router location information.
metroCode `string`	Metropolitan area identifier. Example: SV
package `object`	Fabric Cloud Router package determining the number of supported routes and Network Access Control Lists (NACL).
code `string`	Fabric Cloud Router package code. Applicable values: LAB - Max Routes IPv4 = 50; Max Routes IPv6 = 50; 10Mbps max per connection ingress/egress bandwidth limit; Max connections per FCR: 10 (Trial package) STANDARD - Max Routes IPv4 = 1000; Max Routes IPv6 = 100
order `object`	Order details.
purchaseOrderNumber `string`	Purchase order identifier. Example: 1-129105284100
project `object`	Customer resource hierarchy project information. Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId `string`	Customer project identifier. Example: 995072000433550
notifications `object`	Notification preferences regarding changes in asset configuration or its status.
type `string`	Notification preferences for a specified asset. Applicable values: ALL
emails `array[string]`	List of recipients. Minimum: 1 Maximum: 12 Example: ["test@equinix.com"]
account `object`	Customer billing account information.
accountNumber `integer`	Equinix-assigned account number. Example: 272010
bgpIpv4RoutesCount `integer`	Number of IPv4 BGP routes in use. Example: 0
bgpIpv6RoutesCount `integer`	Number of IPv6 BGP routes in use. Example: 0
connectionCount `integer`	Number of connections associated with this Fabric Cloud Router instance. Example: 0
changeLog `object`	A permanent record of asset creation, modification, or deletion.
createdBy `string`	Identity of the asset creator. Example: AverageJoe
createdByFullName `string`	First and last name of the asset creator. Example: Joe Average
createdByEmail `string`	Email address of the asset creator. Example: joe@average.org
createdDateTime `string`	Asset creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Delete Fabric Cloud Router

	DELETE /fabric/v4/routers/{uuid}
Method	DELETE
URL or Endpoint	/fabric/v4/routers/{uuid}
Headers	Authorization, Content-Type
Path Parameters	uuid
Query Parameters	Not applicable
Body Parameters	Not applicable

This API request deletes a specified Fabric Cloud Router instance.

Sample curl request

curl -X
DELETE 'https://api.equinix.com/fabric/v4/routers/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter	Description
uuid `string` REQUIRED	Equinix-assigned Fabric Cloud Router identifier. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric portal access.

Get All Fabric Cloud Router Packages

	GET /fabric/v4/routerPackages
Method	GET
URL or Endpoint	/fabric/v4/routerPackages
Headers	Authorization, Content-Type
Path Parameters	Not applicable
Query Parameters	offset, limit
Body Parameters	Not applicable

This API request retrieves Fabric Cloud Router packages' details.

Sample curl request

curl -X
GET 'https://api.equinix.com/fabric/v4/routerPackages'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Query parameters

Parameter	Description
offset `integer` OPTIONAL	Index of the first item returned in the response. Minimum: 0 Default value: 0
limit `integer` OPTIONAL	Maximum number of items returned per page. Minimum: 1 Maximum: 100 Default value: 20

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Sample response

{
    "pagination": {
        "offset": 0,
        "limit": 20,
        "total": 1
    },
    "data": [
        {
            "href": "https://api.equinix.com/fabric/v4/routerPackages/STANDARD",
            "type": "ROUTER_PACKAGE",
            "code": "STANDARD",
            "description": "string",
            "totalIPv4RoutesMax": 5,
            "totalIPv6RoutesMax": 5,
            "staticIPv4RoutesMax": 3,
            "staticIPv6RoutesMax": 3,
            "naclsMax": 2,
            "naclRulesMax": 5,
            "haSupported": true,
            "routeFilterSupported": true,
            "natType": "STATIC_NAT",
            "maxConnLimit": 10,
            "maxGwLimit": 3,
            "maxBwLimit": 50,
            "changeLog": {
                "createdDateTime": "2022-02-10T00:14:47Z",
                "updatedDateTime": "2022-02-10T00:14:47Z"
            }
        }
    ]
}

Response payload body description

Parameter	Description
pagination `object`	Data set pagination information.
offset `integer`	Index of the first item returned in the response. Example: 0
limit `integer`	Maximum number of items returned per page. Example: 20
total `integer`	Total number of items returned. Example: 123
data `array[object]`	Data set containing Fabric Cloud Router packages.
href `string`	An absolute URL that returns the specified asset. Example: https://api.equinix.com/fabric/v4/routerPackages/STANDARD
type `string`	Fabric Cloud Router package type. Example: ROUTER_PACKAGE
code `string`	Fabric Cloud Router package identifier. Example: STANDARD
description `string`	Fabric Cloud Router package description.
totalIPv4RoutesMax `integer`	Maximum number of IPv4 BPG routes allowed. Example: 5
totalIPv6RoutesMax `integer`	Maximum number of IPv6 BGP routes allowed. Example: 10
staticIPv4RoutesMax `integer`	Maximum number of IPv4 static routes allowed. Example: 3
staticIPv6RoutesMax `integer`	Maximum number of IPv6 static routes allowed. Example: 3
naclMax `integer`	Maximum number of network access control Lists (NACL) allowed. Example: 2
naclRuleMax `integer`	Maximum number of network ACL rules allowed. Example: 10
haSupported `boolean`	Indicator showing if high availability configuration is supported. Example: true
routeFilterSupported `boolean`	Indicator showing if route filtering feature is supported. Example: true
natType `string`	Cloud Router package network address translation (NAT) type. Possible values: STATIC_NAT - Static network address translation.
maxConnLimit `integer`	Maximum number of connections that can be created using this cloud router. Example: 10
maxGwLimit `integer`	Fabric Cloud Router limit per customer org. Only applicable for LAB package tier of Fabric Cloud Router. Example: 3
maxBwLimit `integer`	Maximum allowed bandwidth. Example: 50 Mbps
changeLog `object`	A permanent record of asset creation, modification, or deletion.
createdDateTime `string`	Asset creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z
updatedDateTime `string`	Asset modification timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15611:12:29.526Z

Get Specified Fabric Cloud Router Package

	GET /fabric/v4/routerPackages/{routerPackageCode}
Method	GET
URL or Endpoint	/fabric/v4/routerPackages/{routerPackageCode}
Headers	Authorization, Content-Type
Path Parameters	routerPackageCode
Query Parameters	Not applicable
Body Parameters	Not applicable

This API request retrieves details of a specified Fabric Cloud Router package.

Sample curl request

curl -X
GET 'https://api.equinix.com/fabric/v4/routerPackages/STANDARD'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter	Description
routerPackageCode `string` REQUIRED	Fabric Cloud Router package identifier. Applicable values: LAB STANDARD

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Sample response

{
    "href": "https://api.equinix.com/fabric/v4/routerPackages/STANDARD",
    "type": "ROUTER_PACKAGE",
    "code": "STANDARD",
    "description": "string",
    "totalIPv4RoutesMax": 5,
    "totalIPv6RoutesMax": 5,
    "staticIPv4RoutesMax": 3,
    "staticIPv6RoutesMax": 3,
    "aclMax": 2,
    "aclRuleMax": 10,
    "haSupported": true,
    "routeFilterSupported": true,
    "natType": "STATIC_NAT",
    "maxConnLimit": 10,
    "maxGwLimit": 3,
    "maxBwLimit": 50,
    "changeLog": {
        "createdDateTime": "2022-01-24T10:28:51.024Z",
        "updatedDateTime": "2022-01-24T10:28:51.024Z"
    }
}

Response payload body description

Parameter	Description
href `string`	An absolute URL that returns the specified asset. Example: https://api.equinix.com/fabric/v4/routerPackages/STANDARD
type `string`	Fabric Cloud Router package type. Example: ROUTER_PACKAGE
code `string`	Fabric Cloud Router package identifier. Example: STANDARD
description `string`	Fabric Cloud Router package description.
totalIPv4RoutesMax `integer`	Maximum number of IPv4 BPG routes allowed. Example: 5
totalIPv6RoutesMax `integer`	Maximum number of IPv6 BGP routes allowed. Example: 10
staticIPv4RoutesMax `integer`	Maximum number of IPv4 static routes allowed. Example: 3
staticIPv6RoutesMax `integer`	Maximum number of IPv6 static routes allowed. Example: 3
naclMax `integer`	Maximum number of network access control Lists (NACL) allowed. Example: 2
naclRuleMax `integer`	Maximum number of network ACL rules allowed. Example: 10
haSupported `boolean`	Indicator showing if high availability configuration is supported. Example: true
routeFilterSupported `boolean`	Indicator showing if route filtering feature is supported. Example: true
natType `string`	Cloud Router package network address translation (NAT) type. Possible values: STATIC_NAT - Static network address translation.
maxConnLimit `integer`	Maximum number of connections that can be created using this cloud router. Example: 10
maxGwLimit `integer`	Fabric Cloud Router limit per customer org. Only applicable for LAB package tier of Fabric Cloud Router. Example: 3
maxBwLimit `integer`	Maximum allowed bandwidth. Example: 50 Mbps
changeLog `object`	A permanent record of asset creation, modification, or deletion.
createdDateTime `string`	Asset creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z
updatedDateTime `string`	Asset modification timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15611:12:29.526Z

Metros

Get All Metros

	GET /fabric/v4/metros
Method	GET
URL or Endpoint	/fabric/v4/metros
Headers	Content-Type, Authorization
Path Parameters	Not applicable
Query Parameters	offset, limit, presence
Body Parameters	Not applicable

The GET Metros API request retrieves metros where Equinix Fabric is available. Returned data set includes connection latency information for each location. This performance data helps network planning engineers and administrators make strategic decisions about port locations and traffic routes.

To learn how to obtain an authorization token, see Requesting Access and Refresh Tokens under the Getting Access Token section.

Sample curl request - get all metros with user-provisioned ports

curl -X GET 'https://api.equinix.com/fabric/v4/metros?presence=MY_PORTS'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer qwErtY8zyW1abcdefGHI'

Query parameters

Parameter	Description
offset `integer` OPTIONAL	Index of the first item returned in the response. Minimum: 0 Default value: 0
limit `integer` OPTIONAL	Maximum number of items returned per page. Minimum: 1 Maximum: 100 Default value: 10
presence `string` OPTIONAL	Returns all metros with user-provisioned Fabric ports. Applicable values: MY_PORTS

Response body

{
    "pagination": {
        "offset": 0,
        "limit": 75,
        "total": 12
    },
    "data": [
        {
            "href": "https://api.equinix.com/fabric/v4/metros/AM",
            "type": "XF_METRO",
            "code": "AM",
            "name": "Amsterdam",
            "region": "EMEA",
            "localVCBandwidthMax": 10000,
            "geoScopes": [],
            "connectedMetros": [
                {
                    "href": "https://api.equinix.com/fabric/v4/metros/MX",
                    "code": "MX",
                    "avgLatency": 133,
                    "remoteVCBandwidthMax": 10000
                },
                {
                    "href": "https://api.equinix.com/fabric/v4/metros/HH",
                    "code": "HH",
                    "avgLatency": 8.65,
                    "remoteVCBandwidthMax": 10000
                },
                {
                    "href": "https://api.equinix.com/fabric/v4/metros/SL",
                    "code": "SL",
                    "avgLatency": 230,
                    "remoteVCBandwidthMax": 25000
                },
                {
                    "href": "https://api.equinix.com/fabric/v4/metros/SO",
                    "code": "SO",
                    "avgLatency": 36.5,
                    "remoteVCBandwidthMax": 50000
                }
            ]
        }
    ]
}

Response payload body description

Parameter	Description
pagination `object`	Search results pagination settings.
offset `integer`	Index of the first item returned in the response. Example: 20
limit `integer`	Maximum number of items returned per page. Example: 20
total `integer`	Total number of items returned. Example: 1
data `array[object]`	Data array containing search results.
href `string`	Absolute URL that returns the specified entity. Example: https://api.equinix.com/fabric/v4/metros/AM
type `string`	Metro type. Example: XF_METRO - Metro in which Equinix Fabric is available.
code `string`	Metropolitan area identifier. Example: AM
name `string`	Name of the city in which the data center is located. Example: Amsterdam
region `string`	Broad geographic area in which the data center is located. EMEA - comprises Abhu Dhabi (AD), Amsterdam (AM), Barcelona (BA), Dubai (DX), Dublin (DB), Dusseldorf (DU), Enschede (EN), Frankfurt (FR), Geneva (GV), Hamburg (HH), Helsinki (HE), Istanbul (IL), Lisbon (LS), London (LD), Madrid (MD), Manchester (MA), Milan (ML), Munich (MU), Muscat (MC), Paris (PA), Seville (SA), Sofia (SO), Stockholm (SK), Warsaw (WA), Zurich (ZH), and Zwolle (ZW). AMER - comprises Atlanta (AT), Bogota (BG), Boston (BO), Chicago (CH), Culpepper (CU), Dallas (DA), Denver (DE), Houston (HO), Los Angeles (LA), Mexico City (MX), Miami (MI), Monterrey (MO), Montreal (MT), New York (NY), Philadelphia (PH), Rio de Janeiro (RJ), Sao Paulo (SP), Seattle (SE), Silicon Valley (SV), Toronto (TR), and Washington, DC [Ashburn] (DC). APAC - comprises Adelaide (AE), Brisbane (BR), Canberra (CA), Hongkong (HK), Jakarta (JK), Melbourne (ME), Osaka (OS), Perth (PE), Seoul (SL), Shanghai (SH), Singapore (SG), Sydney (SY), and Tokyo (TY)
localVCBandwidthMax `integer`	This is the max bandwidth for a local virtual connection. Example: 10000
geoScopes `array[string]`	A list of boundaries within which the connection traffic can be constrained. Example: ["CONUS"]
connectedMetros `array[object]`	Array of objects with connection latency data for the specified metros.
href `string`	Absolute URL that returns the specified entity. Example: https://api.equinix.com/fabric/v4/metros/MX
code `string`	Metropolitan area identifier. Example: MX
avgLatency `integer`	Average monthly connection latency in ms. Example: 133
remoteVCBandwidthMax `integer`	Max bandwidth for the remote connection. Example: 50000

If you get an “Access Denied” error, please contact your local Equinix Service Desk for help.

Get Metros by Metro Code

	GET /fabric/v4/metros/{metroCode}
Method	GET
URL or Endpoint	/fabric/v4/metros
Headers	Content-Type, Authorization
Path Parameters	metroCode
Query Parameters	Not applicable
Body Parameters	Not applicable

This API request retrieves a specified metro. Returned data set includes connection latency information for each location. This performance data helps network planning engineers and administrators make strategic decisions about port locations and traffic routes.

To learn how to obtain an authorization token, see Requesting Access and Refresh Tokens under the Getting Access Token section.

Sample cURL request

curl -X GET 'https://api.equinix.com/fabric/v4/metros/AM'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter

Description

metroCode string
REQUIRED

Metropolitan area identifier.
Applicable values:
EMEA

AD - Abhu Dhabi
AM - Amsterdam
BA - Barcelona
DX - Dubai
DB - Dublin
DU - Dusseldorf
EN - Enschede
FR - Frankfurt
GV - Geneva
HH - Hamburg
HE - Helsinki
IL - Istanbul
LS - Lisbon
LD - London
MD - Madrid
MA - Manchester
ML - Milan
MU - Munich
MC - Muscat
PA - Paris
SA - Seville
SO - Sofia
SK - Stockholm
WA - Warsaw
ZH - Zurich
ZW - Zwolle

AMER

AT - Atlanta
BG - Bogota
BO - Boston
CH - Chicago
CU - Culpepper
DA - Dallas
DE - Denver
HO - Houston
LA - Los Angeles
MX - Mexico City
MI - Miami
MO - Monterrey
MT - Montreal
NY - New York
PH - Philadelphia
RJ - Rio de Janeiro
SP - Sao Paulo
SE - Seattle
SV - Silicon Valley
TR - Toronto
DC - Washington, DC [Ashburn].

APAC

AE - Adelaide
BR - Brisbane
CA - Canberra
HK - Hongkong
JK - Jakarta
ME - Melbourne
OS - Osaka
PerthPE -
SL - Seoul
SH - Shanghai
SG - Singapore
SY - Sydney
TY Tokyo

Response body

{
    "href": "https://api.equinix.com/fabric/v4/metros/AT",
    "type": "XF_METRO",
    "code": "AT",
    "name": "Atlanta",
    "region": "EMEA",
    "localVCBandwidthMax": 10000,
    "geoScopes": [],
    "connectedMetros": [
        {
            "href": "https://api.equinix.com/fabric/v4/metros/LD",
            "code": "LD",
            "avgLatency": 100,
            "remoteVCBandwidthMax": 10000
        },
        {
            "href": "https://api.equinix.com/fabric/v4/metros/SV",
            "code": "SV",
            "avgLatency": 150,
            "remoteVCBandwidthMax": 25000
        }
    ]
}

Response payload body description

Parameter	Description
href `string`	Absolute URL that returns the specified entity. Example: https://api.equinix.com/fabric/v4/metros/AM
type `string`	Metro type. Example: XF_METRO - Metro in which Equinix Fabric is available.
code `string`	Metropolitan area identifier. Example: AM
name `string`	Name of the city in which the data center is located. Example: Amsterdam
region `string`	Broad geographic area in which the data center is located. EMEA - comprises Abhu Dhabi (AD), Amsterdam (AM), Barcelona (BA), Dubai (DX), Dublin (DB), Dusseldorf (DU), Enschede (EN), Frankfurt (FR), Geneva (GV), Hamburg (HH), Helsinki (HE), Istanbul (IL), Lisbon (LS), London (LD), Madrid (MD), Manchester (MA), Milan (ML), Munich (MU), Muscat (MC), Paris (PA), Seville (SA), Sofia (SO), Stockholm (SK), Warsaw (WA), Zurich (ZH), and Zwolle (ZW). AMER - comprises Atlanta (AT), Bogota (BG), Boston (BO), Chicago (CH), Culpepper (CU), Dallas (DA), Denver (DE), Houston (HO), Los Angeles (LA), Mexico City (MX), Miami (MI), Monterrey (MO), Montreal (MT), New York (NY), Philadelphia (PH), Rio de Janeiro (RJ), Sao Paulo (SP), Seattle (SE), Silicon Valley (SV), Toronto (TR), and Washington, DC [Ashburn] (DC). APAC - comprises Adelaide (AE), Brisbane (BR), Canberra (CA), Hongkong (HK), Jakarta (JK), Melbourne (ME), Osaka (OS), Perth (PE), Seoul (SL), Shanghai (SH), Singapore (SG), Sydney (SY), and Tokyo (TY)
localVCBandwidthMax `integer`	This is the max bandwidth for a local virtual connection. Example: 10000
geoScopes `array[string]`	A list of boundaries within which the connection traffic can be constrained. Example: ["CONUS"]
connectedMetros `array[object]`	Array of objects with connection latency data for the specified metros.
href `string`	Absolute URL that returns the specified entity. Example: https://api.equinix.com/fabric/v4/metros/MX
code `string`	Metropolitan area identifier. Example: MX
avgLatency `integer`	Average monthly connection latency in ms. Example: 133
remoteVCBandwidthMax `integer`	Max bandwidth for the remote connection. Example: 25000

If you get an “Access Denied” error, please contact your local Equinix Service Desk for help.

Get All Subscriber Metros

	GET /fabric/v4/metros?presence=MY_PORTS
Method	GET
URL or Endpoint	/fabric/v4/metros
Headers	Content-Type, Authorization
Path Parameters	Not applicable
Query Parameters	offset, limit, presence
Body Parameters	pagination, data

GET All Subscriber Metros uses the /fabric/v4/metros endpoint 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. Network planning engineers and administrators can then analyze this performance data in making strategic decisions about port utilization.

To learn how to obtain an authorization token, see Requesting Access and Refresh Tokens under the Getting Access Token section.

Sample cURL request

curl --location --request GET
https://api.equinix.com/fabric/v4/metros?presence=MY_PORTS
-H "Content-Type: application/json"
-H "Authorization: Bearer qwErtY8zyW1abcdefGHI" 

Query parameters

Parameter Name	Mandatory	Type	Example	Applicable Values	Description
offset	no	integer	?offset=0	>=0	Index of the first item returned in the response. The default is 0.
limit	no	integer	?limit=75	[1 .. 100]	Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 10.
presence	no	string	?presence=MY_PORTS	MY_PORTS	Returns all ports associated with the customer's account, as well as latency data for each port.

Response body

{
  "pagination": {
    "offset": 0,
    "limit": 75,
    "total": 12
  },
  "data": [
    {
      "href": "https://api.equinix.com/fabric/v4/metros/AM",

      "type": "XF_METRO",     
      "code": "AM",

      "name": "Amsterdam",
      "region": "EMEA",     
      "localVCBandwidthMax": 10000,
      "connectedMetros": [
        {
          "href": "https://api.equinix.com/fabric/v4/metros/MX",

          "code": "MX",
          "avgLatency": 133,
          "remoteVCBandwidthMax": 10000
        },
        {
          "href": "https://api.equinix.com/fabric/v4/metros/HH", 

          "code": "HH",
          "avgLatency": 8.65,
          "remoteVCBandwidthMax": 10000
        },
        {
          "href": "https://api.equinix.com/fabric/v4/metros/SL",

          "code": "SL",
          "avgLatency": 230,
          "remoteVCBandwidthMax": 25000
        },
        {
          "href": "https://api.equinix.com/fabric/v4/metros/SO",

          "code": "SO",
          "avgLatency": 36.5,
          "remoteVCBandwidthMax": 50000
        }
      ]
    }
  ]
}

Response body description

Field	Data Type	Example	Description
pagination	object		Pagination specifications for the response data.
data	array[object]		Data returned from the API call.
pagination object
offset	integer	0	Index of the first element returned in the response. The default is 0.
limit	integer	75	Maximum number of elements returned. The default value is 75.
total	integer	12	Total number of elements returned.
data array
href	string	https://api.equinix.com/fabric/v4/metros/AM	The canonical URL at which the resource resides.
type	string	XF_METRO	Indicator of a Fabric metro.
code	string	AM	Code assigned to an Equinix International Business Exchange (IBX) data center in a specified metropolitan area.
name	string	Amsterdam	Name of the city in which the data center is located.
region	string	EMEA	Broad geographic area in which the data center is located (EMEA, AMER, or APAC): EMEA comprises Abhu Dhabi (AD), Amsterdam (AM), Barcelona (BA), Dubai (DX), Dublin (DB), Dusseldorf (DU), Enschede (EN), Frankfurt (FR), Geneva (GV), Hamburg (HH), Helsinki (HE), Istanbul (IL), Lisbon (LS), London (LD), Madrid (MD), Manchester (MA), Milan (ML), Munich (MU), Muscat (MC), Paris (PA), Seville (SA), Sofia (SO), Stockholm (SK), Warsaw (WA), Zurich (ZH), and Zwolle (ZW). AMER comprises Atlanta (AT), Bogota (BG), Boston (BO), Chicago (CH), Culpepper (CU), Dallas (DA), Denver (DE), Houston (HO), Los Angeles (LA), Mexico City (MX), Miami (MI), Monterrey (MO), Montreal (MT), New York (NY), Philadelphia (PH), Rio de Janeiro (RJ), Sao Paulo (SP), Seattle (SE), Silicon Valley (SV), Toronto (TR), and Washington, DC [Ashburn] (DC). APAC comprises Adelaide (AE), Brisbane (BR), Canberra (CA), Hongkong (HK), Jakarta (JK), Melbourne (ME), Osaka (OS), Perth (PE), Seoul (SL), Shanghai (SH), Singapore (SG), Sydney (SY), and Tokyo (TY).
localVCBandwidthMax	integer	10000	Max bandwidth of a local connection. Example: 10000
connectedMetros	array[object]		Array of objects containing latency data for the specified metros.
data.connectedMetros
href	string	https://api.equinix.com/fabric/v4/metros/MX	Canonical URL at which the resource resides.
code	string	MX	Code assigned to an Equinix International Business Exchange (IBX) data center in a specified metropolitan area.
avgLatency	integer	133.0	Average monthly latency (in milliseconds[ms]) between two specified metros.
remoteVCBandwidthMax	integer	50000	Max bandwidth of the remote connection. Example: 50000

If you get an “Access Denied” error, please contact your local Equinix Service Desk for help.

Ports

Create Port

	POST /fabric/v4/ports
Method	POST
URL or Endpoint	/fabric/v4/ports
Headers	Authorization, Content-Type
Path Parameters	Not applicable
Query Parameters	Not applicable
Body Parameters	type, physicalPortsSpeed, physicalPortsType, connectivitySourceType, location, project, demarcationPointIbx, tetherIbx, settings, lagEnabled, encapsulation, account, notifications, physicalPorts

This API request creates a virtual Fabric port that can be used as an endpoint in virtual connections.

To obtain an authorization token, see the Getting Access Token section under Requesting Access and Refresh Tokens.

Sample curl request - colocation, non-LAG port

curl -X POST 'https://api.equinix.com/fabric/v4/ports'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'
-d '{
    "type": "XF_PORT",
    "physicalPortsSpeed": 1000,
    "physicalPortsType": "1000BASE_LX",
    "connectivitySourceType": "COLO",
    "location": {
        "metroCode": "GV"
    },
    "project": {
        "projectId": "1234567"
    },

    "demarcationPointIbx": "GV1",
    "settings": {
        "packageType": "STANDARD"
    },
    "lagEnabled": false,
    "encapsulation": {
        "type": "DOT1Q",
        "tagProtocolId": "33024"
    },
    "account": {
        "accountNumber": 270848
    },
    "notifications": [
        {
            "registeredUsers": [
                "jaguarsuser-port-order"
            ],
            "type": "TECHNICAL"
        }
    ],
    "physicalPorts": [
        {
            "demarcationPoint": {
                "ibx": "GV1",
                "cabinetUniqueSpaceId": "Demarc",
                "cageUniqueSpaceId": "GV1:01:002174",
                "patchPanel": "CP:Demarc:1259684",
                "patchPanelPortA": 8,
                "patchPanelPortB": 9,
                "connectorType": "SC"
            }
        },
        {
            "demarcationPoint": {
                "ibx": "GV1",
                "cabinetUniqueSpaceId": "Demarc",
                "cageUniqueSpaceId": "GV1:01:002174",
                "patchPanel": "CP:Demarc:1259684",
                "patchPanelPortA": 10,
                "patchPanelPortB": 11,
                "connectorType": "SC"
            }
        }
    ]
}'

Body parameters

Parameter	Description
type `string` REQUIRED	Port instance type. Applicable values: XF_PORT - Fabric port
physicalPortsSpeed `integer` REQUIRED	Rated port bandwidth capacity in Mbps. Example: 1000
physicalPortsType `string` REQUIRED	Physical ports type. Example: 1000BASE_LX
connectivitySourceType `string` REQUIRED	Port type based on its location in the data center facility. Applicable values: COLO - Customer's cage in Equinix IBX colocation space.
location `object` REQUIRED	Geographic attributes of the port.
metroCode `string` REQUIRED	Metropolitan area identifier. Example: GV
project `object` OPTIONAL	Customer resource hierarchy project information. Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId `string` OPTIONAL	Customer project identifier. Example: 377533000114703
demarcationPointIbx `string` REQUIRED	Physical ports demarcation point IBX. Example: GV1
tetherIbx `string` OPTIONAL	Physical ports tether IBX. Example: GV1
settings `object` REQUIRED	Port configuration settings.
packageType `string` REQUIRED	Port package determinig its use. Applicable values: STANDARD UNTAGGED UNLIMITED NETWORK_EDGE FREE
lagEnabled `boolean` REQUIRED	Indicator showing if port is LAG enabled. Example: false
encapsulation `object` REQUIRED	Encapsulation specification.
type `string` REQUIRED	Encapsulation protocol. Applicable values: DOT1Q QINQ UNTAGGED NULL
tagProtocolId `string` REQUIRED	Ethertype value that identifies the tagging protocol. Applicable values: 33024 34984 37120 37376 NONE
account `object` REQUIRED	Account information.
accountNumber `integer` REQUIRED	Equinix-assigned account number. Example: 24124
notifications `array[object]` REQUIRED	Notifications settings for messages related to the asset configuration or its status.
registeredUsers `array[string]` REQUIRED	Usernames of registered users. Example: ["mikeScott","dwightShrute"]
type `string` REQUIRED	Notification messages category. Applicable values: NOTIFICATION - Notifications related to asset's lifecycle. TECHNICAL - Contact information for technical inquiries.
physicalPorts `array[object]` OPTIONAL	Physical ports that implement virtual port instance.
demarcationPoint `object` OPTIONAL	Customer-side physical port connector information.
ibx `string` OPTIONAL	IBX data center identifier. Example: GV1
cabinetUniqueSpaceId `string` OPTIONAL	Identifier of the colocation space where the cabinet is located. Example: AM1:02:032575:0105
cageUniqueSpaceId `string` OPTIONAL	Identifier of the colocation space where the cage is located. Example: AM1:02:032575
patchPanel `string` OPTIONAL	Patch panel identifier. Example: CP:Demarc:1259684
patchPanelPortA `integer` OPTIONAL	Patch panel port number. If the port number isn't provided, next available port is selected. Example: 8
patchPanelPortB `integer` OPTIONAL	Patch panel port number. If the port number isn't provided, next available port is selected. Example: 9
connectorType `string` OPTIONAL	Physical port connector type. Applicable values: For applicable values, use the Lookup - Get Patch Panel Details. Example: ST

Sample response

{
    "href": "https://api.equinix.com/fabric/v4/ports/0f6bdb36-e130-4924-b038-ee1785fad166",
    "type": "XF_PORT",
    "uuid": "0f6bdb36-e130-4924-b038-ee1785fad166",
    "state": "PENDING",
    "physicalPortsType": "10GBASE_LR",
    "physicalPortsSpeed": 10000,
    "physicalPortsCount": 1,
    "location": {
        "metroCode": "AM"
    },
    "project": {
        "projectId": "1234567"
    },

    "demarcationPointIbx": "AM1",
    "redundancy": {
        "group": "1f6bdb37-f131-5925-c039-fe1785fad165",
        "priority": "PRIMARY"
        
    },
    "lagEnabled": false,
    "encapsulation": {
        "type": "DOT1Q",
        "tagProtocolId": "33024"
    },
    "settings": {
        "sharedPortType": false,
        "packageType": "STANDARD"
    },
    "account": {
        "accountNumber": 1000
    },
    "order": {
        "orderNumber": "1-207799950758"
    },
    "notifications": [
        {
            "type": "TECHNICAL",
            "registeredUsers": [
                "jaguarsuser-port-order"
            ]
        },
        {
            "type": "NOTIFICATION",
            "registeredUsers": [
                "jaguarsuser-port-order"
            ]
        }
    ],
    "physicalPorts": [
        {
            "demarcationPoint": {
                "ibx": "GV1",
                "cabinetUniqueSpaceId": "Demarc",
                "cageUniqueSpaceId": "GV1:01:002174",
                "patchPanel": "CP:Demarc:1259684",
                "patchPanelPortA": 8,
                "patchPanelPortB": 9,
                "connectorType": "SC"
            }
        },
        {
            "demarcationPoint": {
                "ibx": "GV1",
                "cabinetUniqueSpaceId": "Demarc",
                "cageUniqueSpaceId": "GV1:01:002174",
                "patchPanel": "CP:Demarc:1259684",
                "patchPanelPortA": 10,
                "patchPanelPortB": 11,
                "connectorType": "SC"
            }
        }
    ]
}

Response payload body description

Parameter	Description
href `string`	Absolute URL that returns the specified asset. Example: https://api.equinix.com/fabric/v4/ports/0f6bdb36-e130-4924-b038-ee1785fad166
type `string`	Port instance type. Possible values: XF_PORT - Fabric port
uuid `string`	Port instance identifier. Example: 0f6bdb36-e130-4924-b038-ee1785fad166
state `string`	Fabric port operational status. Example: PENDING
physicalPortsSpeed `integer`	Rated port bandwidth capacity in Mbps. Example: 1000
physicalPortsType `string`	Physical ports type. Example: 1000BASE_LX
physicalPortsCount `integer`	Number of physical ports that comprise the given virtual port instance. Example: 1
location `object`	Geographic attributes of the port.
metroCode `string`	Mtropolitan area identifier. Example: AM
project `object` OPTIONAL	Customer resource hierarchy project information. Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId `string` OPTIONAL	Customer project identifier. Example: 377533000114703
demarcationPointIbx `string` REQUIRED	Physical ports demarcation point IBX. Example: AM1
tetherIbx `string` OPTIONAL	Physical ports tether point IBX. Example: AM1
device `object`	Device configuration settings.
name `string`	Equinix-assigned device identifier. Example: dev-int-vsim-2.lab
redundancy `object`	Device redundancy configuration.
group `integer`	Device redundancy group. Example: 1
priority `string`	Relative priority in redundancy group. Example: PRIMARY
lagEnabled `boolean`	Indicator showing if port is LAG enabled. Example: false
encapsulation `object`	Encapsulation specification.
type `string`	Encapsulation protocol. Possible values: DOT1Q QINQ UNTAGGED NULL
tagProtocolId `string`	Tagging protocol identifier. Possible values: 33024 34984 37120 37376 NONE
settings `object`	Port configuration settings.
sharedPortType `boolean`	A shared port is a single physical port that handles multiple virtual connections. True value signifies a port that can handle multiple virtual connections. Example: true
packageType `string`	Package type. Possible values: STANDARD UNTAGGED UNLIMITED FREE
account `object`	Customer account information.
accountNumber `integer`	Equinix-assigned account number. Example: 24124
order `object`	Asset order information.
orderNumber `string`	Asset order number. Example: 1-207799950758
notifications `array[object]`	Notifications settings for messages related to the asset configuration or its status.
registeredUsers `array[string]`	Usernames of registered users. Example: ["mikeScott","dwightShrute"]
type `string`	Notification messages category. Possible values: NOTIFICATION - Notifications related to asset's lifecycle. TECHNICAL - Contact information for technical inquiries.
physicalPorts `array[object]`	Physical ports that implement virtual port instance.
demarcationPoint `object`	Customer-side physical port connector information.
ibx `string`	IBX data center identifier. Example: GV1
cabinetUniqueSpaceId `string`	Identifier of the colocation space where the cabinet is located. Example: AM1:02:032575:0105
cageUniqueSpaceId `string`	Identifier of the colocation space where the cage is located. Example: AM1:02:032575
patchPanel `string`	Patch panel identifier. Example: CP:Demarc:1259684
connectorType `string`	Physical port connector type. Example: SC

Create Pair of Redundant Ports

	POST /fabric/v4/ports/bulk
Method	POST
URL or Endpoint	/fabric/v4/ports/bulk
Headers	Authorization, Content-Type
Path Parameters	Not applicable
Query Parameters	Not applicable
Body Parameters	type, description, physicalPortsSpeed, physicalPortsType, connectivitySourceType, location, project, demarcationPointIbx, tetherIbx, settings, lag, encapsulation, account, notifications, physicalPorts

This API request creates a pair of redundant Fabric ports that can be used as an endpoint in virtual connections.

To obtain an authorization token, see the Getting Access Token section under Requesting Access and Refresh Tokens.

Sample curl request - redundant, colocation, non-LAG ports

curl -X POST 'https://api.equinix.com/fabric/v4/ports'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'
-d '{
    "data": [
        {
            "type": "XF_PORT",
            "name": "L2-DEV-USER01-CX-10G-PRIMARY",
            "description": "Test Redundant port in Amsterdam",
            "physicalPortsSpeed": 10000,
            "lagEnabled": false,
            "demarcationPointIbx": "AM1",
            "encapsulation": {
                "type": "DOT1Q",
                "tagProtocolId": "33024"
            },
            "account": {
                "accountNumber": 1000
            },
            "order": {
                "purchaseOrder": {
                    "number": 156576,
                    "amount": 10,
                    "startDate": "2018-06-11",
                    "endDate": "2018-07-11",
                    "selectionType": "NEW"
                },
                "signature": {
                    "signatory": "DELEGATE",
                    "delegate": {
                        "firstName": "John",
                        "lastName": "Doe",
                        "email": "john.doe@company.com"
                        }
                }
            },
            "redundancy": {
                "priority": "PRIMARY"
            },
            "project": {
                "projectId": "1234567"
            },
            "physicalPorts": [
                {
                    "demarcationPoint": {
                        "ibx": "AM1",
                        "cabinet": "AM1:02:032575:0105",
                        "cage": "AM1:02:032575",
                        "patchPanel": "PP:0105:1260379",
                        "patchPanelPortA": 14,
                        "patchPanelPortB": 15,
                        "connectorType": "LC"
                    }
                }
            ]
        },
        {
            "type": "XF_PORT",
            "name": "L2-DEV-USER01-CX-10G-SECONDARY",
            "description": "Test Redundant port in Amsterdam",
            "physicalPortsSpeed": 10000,
            "lagEnabled": false,
            "demarcationPointIbx": "AM1",
            "encapsulation": {
                "type": "DOT1Q",
                "tagProtocolId": "33024"
            },
            "account": {
                "accountNumber": 1000
            },
            "order": {
                "purchaseOrderNumber": "1-129105284100"
            },
            "redundancy": {
                "priority": "SECONDARY"
            },
            "project": {
                "projectId": "1234567"
            },
            "physicalPorts": [
                {
                    "demarcationPoint": {
                        "ibx": "AM1",
                        "cabinet": "AM1:02:032575:0105",
                        "cage": "AM1:02:032575",
                        "patchPanel": "PP:0105:1260379",
                        "patchPanelPortA": 16,
                        "patchPanelPortB": 17,
                        "connectorType": "LC"
                    }
                }
            ]
        }
    ]
}'

Body parameters

For body parameters descriptions, refer to the Response payload body parameters section in Create Port.

Sample response

{
    "data": [
        {
            "href": "https://api.equinix.com/fabric/v4/ports/0f6bdb36-e130-4924-b038-ee1785fad999",
            "type": "XF_PORT",
            "uuid": "0f6bdb36-e130-4924-b038-ee1785fad999",
            "state": "PENDING",
            "connectivitySourceType": "COLO",
            "physicalPortsType": "10GBASE_LR",
            "physicalPortsSpeed": 10000,
            "location": {
                "metroCode": "AM"
            },
            "project": {
                "projectId": "1234567"
            },
            "demarcationPointIbx": "AM1",
            "redundancy": {
                "group": 1,
                "priority": "PRIMARY"
            },
            "lagEnabled": false,
            "encapsulation": {
                "type": "DOT1Q",
                "tagProtocolId": "33024"
            },
            "settings": {
                "sharedPortType": false,
                "packageType": "STANDARD"
            },
            "account": {
                "accountNumber": 1000
            },
            "order": {
                "orderNumber": "1-210210611904"
            },
            "notifications": [
                {
                    "type": "TECHNICAL",
                    "registeredUsers": [
                        "jaguarsuser-port-order"
                    ]
                },
                {
                    "type": "NOTIFICATION",
                    "registeredUsers": [
                        "jaguarsuser-port-order"
                    ]
                }
            ]
        },
        {
            "href": "https://api.equinix.com/fabric/v4/ports/0f6bdb36-e130-4924-b038-ee1785fad999",
            "type": "XF_PORT",
            "uuid": "0f6bdb36-e130-4924-b038-ee1785fad999",
            "state": "PENDING",
            "connectivitySourceType": "COLO",
            "physicalPortsType": "10GBASE_LR",
            "physicalPortsSpeed": 10000,
            "location": {
                "metroCode": "AM"
            },
            "project": {
                "projectId": "1234567"
            },
            "demarcationPointIbx": "AM1",
            "redundancy": {
                "group": 1,
                "priority": "SECONDARY"
            },
            "lagEnabled": false,
            "encapsulation": {
                "type": "DOT1Q",
                "tagProtocolId": "33024"
            },
            "settings": {
                "sharedPortType": false,
                "packageType": "STANDARD"
            },
            "account": {
                "accountNumber": 1000
            },
            "order": {
                "orderNumber": "1-210210611904"
            }
        }
    ]
}

Response payload body description

For body parameters descriptions, refer to the Response payload body description section in Create Port.

Add Physical Ports to Virtual Port

	POST /fabric/v4/ports/{uuid}/physicalPorts/bulk
Method	POST
URL or Endpoint	/fabric/v4/ports/{uuid}/physicalPorts/bulk
Headers	Authorization, Content-Type
Path Parameters	uuid
Query Parameters	Not applicable
Body Parameters	type, demarcationPoint, account, order

Adds physical ports to a virtual port.

To obtain an authorization token, see the Getting Access Token section under Requesting Access and Refresh Tokens.

Sample curl request - colocation, non-LAG port

curl -X POST 'https://api.equinix.com/fabric/v4/ports/c64de7e5-7fe7-41e6-b984-80d5aa159a0d/physicalPorts/bulk'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'
-d '{
  "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-11",
          "endDate": "2018-07-11",
          "selectionType": "NEW"
        },
        "signature": {
          "signatory": "DELEGATE",
          "delegate": {
            "firstName": "John",
            "lastName": "Doe",
            "email": "john.doe@company.com"
          }
        }
      },
    },
    {
      "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-11",
          "endDate": "2018-07-11",
          "selectionType": "NEW"
        },
        "signature": {
          "signatory": "DELEGATE",
          "delegate": {
            "firstName": "John",
            "lastName": "Doe",
            "email": "john.doe@company.com"
          }
        }
      }
    }
  ]
}'

Path parameters

Parameter	Description
uuid `string` REQUIRED	Fabric port identifier.

Body parameters

Parameter	Description
data `array[object]` REQUIRED	Array of physical ports definitions.
type `string` REQUIRED	Port instance type. Applicable values: XF_PORT - Fabric port
demarcationPoint `object` REQUIRED	Demarcation point.
ibx `string` REQUIRED	IBX data center identifier. Example: GV1
cabinetUniqueSpaceId `string` REQUIRED	Identifier of the colocation space where the cabinet is located. Example: AM1:02:032575:0105
cageUniqueSpaceId `string` REQUIRED	Identifier of the colocation space where the cage is located. Example: AM1:02:032575
patchPanel `string` REQUIRED	Patch panel. Example:CP:Demarc:1259684
patchPanelPortA `integer` REQUIRED	Patch panel PortA identifier. Example: 14
patchPanelPortB `integer` REQUIRED	Patch panel PortB identifier. Example: 15
connectorType `string` REQUIRED	Physical port connector type. Applicable values: SC
account `object` OPTIONAL	Port owner's account details.
accountNumber `integer` OPTIONAL	Port owner's account number. Example: 17829
order `object` OPTIONAL	Order details.
purchaseOrder `object` OPTIONAL	Purchase order details.
number `integer` OPTIONAL	Purchase order number. Example: 156576
amount `integer` OPTIONAL	Purchase order amount. Example: 10
startDate `string` OPTIONAL	Purchase order start date. Example: 2018-06-11
endDate `string` OPTIONAL	Purchase order end date. Example: 2018-07-11
selectionType`string` OPTIONAL	Selection type. Example: NEW
signature `object` OPTIONAL	Signature details.
signatory `string` OPTIONAL	Signatory details. Applicable values: DELEGATE SELF ACCOUNT_SUPPORT
delegate `object` OPTIONAL	Details of the delegate.
firstname `string` OPTIONAL	Firstname of the delegate.
lasttname `string` OPTIONAL	Lastname of the delegate.
email `string` OPTIONAL	Email of the delegate.
loas `array[object]` OPTIONAL	An array of objects containing the unique Ids of Letters of Agreements (LOAs).
uuid `string` OPTIONAL	Unique Ids of Letters of Agreements (LOAs). Example: g42de7e5-7fe7-41e6-b984-80d5aa159a8m

Sample response

{
  "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"
      }
    },
    {
      "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"
      }
    }
  ]
}

Response payload description

Parameter	Description
pagination `object`	Data set pagination information.
offset `integer`	Index of the first item returned in the response. Example: 0
limit `integer`	Maximum number of items returned per page. Example: 20
total `integer`	Total number of items returned. Example: 123
data `array[object]`	Array of physical ports definitions.
type `string`	Port instance type. Example value: XF_PORT - Fabric port
demarcationPoint `object`	Demarcation point details.
ibx `string`	IBX data center identifier. Example: GV1
cabinetUniqueSpaceId `string`	Identifier of the colocation space where the cabinet is located. Example: AM1:02:032575:0105
cageUniqueSpaceId `string`	Identifier of the colocation space where the cage is located. Example: AM1:02:032575
patchPanel `string`	Patch panel identifier. Example: CP:Demarc:1259684
patchPanelPortA `integer`	Patch panel PortA identifier. Example: 14
patchPanelPortB `integer`	Patch panel PortB identifier. Example: 15
connectorType `string`	Physical port connector type. Example values: SC
portReservationId `string`	Port reservation Id. Example values:1793011453
portGroup `string`	Port group. Example values: 1886328826
key `string`	Additional information parameter. Example values: internalReferenceId quoteReferenceId orderUuid lagType connectivitySourceType physicalPortsType packageType notification
value `string`/`integer`	Additional information parameter value. Note that the value's data type and its applicable values depend on the selected key parameter.
order `object`	Order details.
orderNumber `string`	Order number. Example values:1-210210611904

Get All Ports

	GET /fabric/v4/ports
Method	GET
URL or Endpoint	/fabric/v4/ports
Headers	Authorization
Path Parameters	Not applicable
Query Parameters	Not applicable
Body Parameters	Not applicable

This API request returns details of all available ports for the specified user credentials.

To obtain an authorization token, see the Getting Access Token section under Requesting Access and Refresh Tokens.

Sample curl request

curl -X GET 'https://api.equinix.com/fabric/v4/ports'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'

Sample Response

{
    "pagination": {
        "offset": 0,
        "limit": 999,
        "total": 133
    },
    "data": [
        {
            "href": "https://api.equinix.com/fabric/v4/ports/c791f8cb-599b-99b0-8ce0-306a5c00a4ee",
            "type": "XF_PORT",
            "uuid": "c791f8cb-599b-99b0-8ce0-306a5c00a4ee",
            "name": "testBuyer-DC5-NL-Dot1q-BO-PRI-10G-JN-163",
            "state": "ACTIVE",
            "cvpId": "1614613",
            "bandwidth": 10000,
            "usedBandwidth": 6165,
            "availableBandwidth": 3835,
            "location": {
                "href": "https://api.equinix.com/fabric/v4/metros/DC",
                "ibx": "DC5",
                "metroCode": "DC",
                "metroName": "Ashburn",
                "region": "AMER"
            },
            "project": {
                "projectId": "1234567"
            },

            "device": {
                "name": "qa3-dc-a1.lab",
                "redundancy": {
                    "priority": "PRIMARY"
                }
            },
            "encapsulation": {
                "type": "DOT1Q",
                "tagProtocolId": "0x8100"
            },
            "lag": {
                "enabled": false
            },
            "settings": {
                "buyout": true,
                "placeVcOrderPermission": true,
                "viewPortPermission": true
            },
            "physicalPorts": [
                {
                    "uuid": "dfd8884bb-4f65-4ab3-8f77-500dec2f87777",
                    "state": "ACTIVE",
                    "type": "XF_PHYSICAL_PORT",
                    "id": 1426515,
                    "bandwidth": 10000,
                    "tether": {
                        "crossConnectId": "ECX.01.00002995",
                        "cabinetNumber": "Demarc",
                        "systemName": "DC5:01:001015",
                        "patchPanelName": "PP:Demarc:00001016",
                        "patchPanelPortA": "1",
                        "patchPanelPortB": "2",
                    },
                    "demarcationPoint": {
                        "patchPanelName": "PP:Demarc:00001015",
                        "patchPanelPortA": "5",
                        "patchPanelPortB": "6",
                        "ibx": "DC5"
                    },
                    "settings": {
                        "sharedPortType": false,
                        "sharedPortProduct": "NA"
                    },
                    "operation": {
                        "operationalStatus": "UP",
                        "opStatusChangedAt": "2021-12-02T00:00:00Z"
                    }
                }
            ],
            "operation": {
                "operationalStatus": "UP",
                "opStatusChangedAt": "2021-07-20T17:04:18Z",
                "connectionCount": 53,
                "evplVCCount": 53,
                "fgVCCount": 0,
                "accessVCCount": 0
            },
            "account": {
                "accountNumber": 270001,
                "accountName": "testBuyer",
                "ucmId": "08374E19-9B56-4c27-84BA-33D42BB0940C",
                "globalCustId": "0016u000003JZ4sAAG",
                "orgId": "91997",
                "organizationName": "testBuyer-270001"
            },
            "changeLog": {
                "updatedDateTime": "2021-07-20T17:04:18Z",
                "createdDateTime": "2021-07-20T17:04:18Z"
            }
        }
    ]
}

Use the Metros API to create a list of all metros your account can connect to.

Response payload body description

Parameter	Data Type	Example Values	Description
pagination	object	-	Search results pagination settings.
data	array[object]	-	Data array containing returned objects.
pagination
offset	integer	?offset=0	Index of the first item returned in the response. The value must be >=0, and the default is 0.
limit	integer	?limit=10	Maximum number of items returned per page. Number must be between 1 and 1000, and the default is 999.
total	integer	1	Total number of items returned.
data
href	string	https://api.equinix.com/fabric/v4/ports/e91484bb-4f65-4ab3-8f77-500dec2f855d	An absolute URL that returns the specified asset.
type	string	XF_PORT	Type of port.
uuid	string	e91484bb-4f65-4ab3-8f77-500dec2f855d	Equinix-assigned port identifier.
name	string	AT1-Dot1q-L-Secondary-108608	Port name.
state	string	ACTIVE	Port lifecycle status.
cvpId	string	108608	CloudVision Portal port identifier.
bandwidth	integer	1000	Data transfer capacity (Mbps).
usedBandwidth	integer	0	Port bandwidth consumed (Mbps).
availableBandwidth	integer	1000	Remaining port bandwidth (Mbps).
location	object	-	Geographic attributes of the specified access point.
project	object	-	Customer resource hierarchy project information. Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
device	object	-	Device configuration settings.
encapsulation	object	-	Encapsulation specification.
lag	object	-	Link aggregation group (LAG) configuration.
settings	object	-	Port configuration settings.
physicalPorts	array[object]	-	Preferences and settings for physical ports.
operation	object	-	Port operational status.
account	object	-	Port owner account information.
changeLog	object	-	A permanent record of asset creation, modification, or deletion.
location
href	string	https://api.equinix.com/fabric/v4/metros/AT	An absolute URL that returns the specified asset.
ibx	string	AT1	Alphanumeric identifier assigned to an Equinix International Business Exchange (IBX) data center in which a specified asset is located.
metroCode	string	AT	Metropolitan area identifier.
metroName	string	Atlanta	Metropolitan area name.
region	string	AMER	Broad geographic area in which a specified Equinix asset is located: AMER — The Americas APAC — Asia-Pacific) EMEA — Europe, the Middle East, and Africa
project
projectId	string	377533000114703	Customer project identifier.
device
name	string	dev-m7a2.lab	Equinix-assigned device identifier.
redundancy	object	-	Port redundancy configuration.
device.redundancy
priority	string	Secondary	Relative priority in the redundancy group.
encapsulation
type	string	DOT1Q	Encapsulation protocol.
tagProtocolId	string	0x8100	Tagging protocol identifier. 0x8100 - DOT1Q 0x9100 - QINQ
lag
id	string	108608	Link aggregation group (LAG) ID.
enabled	boolean	true	Indicator showing if port is LAG enabled. The default value is false.
name	string	ae-108608	LAG name.
settings
buyout	boolean	false	Buyout (true) or standard port configuration. Buyout ports offer free unlimited connections. Standard ports (false) do not. The default value is false.
placeVcOrderPermission	boolean	true	Permission to order a virtual connection. The default value is false.
viewPortPermission	boolean	true	Indicates if the user can see the port. The default value is false.
physicalPorts
uuid	string	dfd8884bb-4f65-4ab3-8f77-500dec2f87777	Unique Id of the switch port.
state	string	PROVISIONED	Port availability.
type	string	XF_PHYSICAL_PORT	Physical port type.
id	integer	6967	Physical port identifier.
bandwidth	integer	10000	Data transfer capacity (Mbps).
tether	object	-	Equinix-side physical port connector information.
demarcationPoint	object	-	Customer-side physical port connector information.
settings	object	-	Physical port specifications.
operation	object	-	Operational data for a specified port.
physicalPorts.tether
crossConnectId	string	100179-A	Cross-connection identifier.
cabinetNumber	string	Demarc	Cabinet name.
systemName	string	GV1:01:001032	Colocation cage identifier.
patchPanelName	string	PP:956:66107	Name of the patch panel where the given port is located.
patchPanelPortA	string	5	ID for the origin of a cross-connect port interface.
patchPanelPortB	string	42	ID for the destination side of a cross-connect port interface.
physicalPorts.demarcationPoint
patchPanelName	string	PP:956:66107	Name of the patch panel where the given port is located.
patchPanelPortA	string	5	ID for the origin of a cross-connect port interface.
patchPanelPortB	string	42	ID for the destination side of a cross-connect port interface.
ibx	string	DC6	Identifier of the IBX data center where the given physical port is located.
physicalPorts.settings
sharedPortType	boolean	false	Type of shared port. A shared port is a single physical port that handles multiple virtual connections.
sharedPortProduct	string	NA	Name of the Equinix product associated with the shared port.
physicalPorts.operation
operationalStatus	string	UP	Availability of a given physical port.
operation
operationalStatus	string	UP	Availability of a given port.
opStatusChangedAt	string	2021-08-14T19:30:29.526Z	Date and time at which port availability changed in IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` or `YYYY-MM-DDTHH:MM:SSZ`.
connectionCount	integer	0	Total number of connections established using this port.
acount
accountNumber	integer	100179	Equinix-assigned account number.
accountName	string	L2	Legal name of the accountholder.
globalCustId	string	007700000090982RG8	Equinix-assigned ID of the subscriber's parent organization.
orgId	string	100179	Equinix-assigned ID of the subscriber's organization.
organizationName	string	Cust_Org_100179	Equinix-assigned name of the subscriber's organization.
changeLog
createdDateTime	string	2021-08-14T19:30:29.526Z	Asset creation timestamp in IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` or `YYYY-MM-DDTHH:MM:SSZ`.

If you get an “Access Denied” error, contact your local Equinix Service Desk for help.

Get Specified Port

	GET /fabric/v4/ports/{portUuid}
Method	GET
URL or Endpoint	/fabric/v4/ports/{portUuid}
Headers	Authorization
Path Parameters	uuid
Query Parameters	Not applicable
Body Parameters	Not applicable

This API request returns details for the specified port.

To obtain an authorization token, see the Getting Access Token section under Requesting Access and Refresh Tokens.

Sample curl request

curl -X GET 'https://api.equinix.com/fabric/v4/ports/13c0f286-1190-480c-8a45-b3df00cad9cf'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'

Path parameters

Parameter	Mandatory	Type	Example	Applicable Values	Description
uuid	no	string	e91484bb-4f65-4ab3-8f77-500dec2f855d	-	Equinix-assigned port identifier.

Sample response

{
    "href": "https://api.equinix.com/fabric/v4/ports/cecd1039-eadd-add3-31e0-387a5c00aeb9",
    "type": "XF_PORT",
    "uuid": "cecd1039-eadd-add3-31e0-387a5c00aeb9",
    "name": "testBuyer-DC6-NL-Qinq-STD-SEC-10G-JUN-2",
    "state": "ACTIVE",
    "cvpId": "1617846",
    "bandwidth": 10000,
    "usedBandwidth": 3596,
    "availableBandwidth": 6403,
    "location": {
        "href": "https://api.equinix.com/fabric/v4/metros/DC",
        "ibx": "DC6",
        "metroCode": "DC",
        "metroName": "Ashburn",
        "region": "AMER"
    },
    "project": {
        "projectId": "1234567"
    },

    "device": {
        "name": "qa3-dc-a2.lab",
        "redundancy": {
            "priority": "SECONDARY"
        }
    },
    "encapsulation": {
        "type": "QINQ",
        "tagProtocolId": "0x9100"
    },
    "lag": {
        "enabled": false
    },
    "settings": {
        "buyout": false,
        "placeVcOrderPermission": true,
        "viewPortPermission": true
    },
    "physicalPorts": [
        {
            "uuid": "dfd8884bb-4f65-4ab3-8f77-500dec2f87777",
            "state": "ACTIVE",
            "type": "XF_PHYSICAL_PORT",
            "id": 1426505,
            "bandwidth": 10000,
            "tether": {
                "crossConnectId": "21864962",
                "cabinetNumber": "Demarc",
                "systemName": "DC6:01:001285",
                "patchPanelName": "CP:Demarc:1258531",
                "patchPanelPortA": "1",
                "patchPanelPortB": "2"
            },
            "demarcationPoint": {
                "patchPanelName": "CP:Demarc:1258533",
                "patchPanelPortA": "3",
                "patchPanelPortB": "4",
                "ibx": "DC6"
            },
            "settings": {
                "sharedPortType": false,
                "sharedPortProduct": "NA"
            },
            "operation": {
                "operationalStatus": "UP",
                "opStatusChangedAt": "2021-12-02T00:00:00Z"
            }
        }
    ],
    "operation": {
        "operationalStatus": "UP",
        "opStatusChangedAt": "2021-10-20T17:25:24Z",
        "connectionCount": 30,
        "evplVCCount": 30,
        "fgVCCount": 0,
        "accessVCCount": 0
    },
    "account": {
        "accountNumber": 270001,
        "accountName": "testBuyer",
        "ucmId": "08374E19-9B56-4c27-84BA-33D42BB0940C",
        "globalCustId": "0016u000003JZ4sAAG",
        "orgId": "91997",
        "organizationName": "testBuyer-270001"
    },
    "changeLog": {
        "updatedDateTime": "2021-10-20T17:25:24Z",
        "createdDateTime": "2021-10-20T17:25:24Z"
    }
}

Use the Metros API to create a list of all metros your account can connect to.

Response payload body description

Parameter	Type	Example	Description
href	string	https://api.equinix.com/fabric/v4/ports/e91484bb-4f65-4ab3-8f77-500dec2f855d	An absolute URL that returns the specified asset.
type	string	XF_PORT	Type of port.
uuid	string	e91484bb-4f65-4ab3-8f77-500dec2f855d	Equinix-assigned port identifier.
name	string	AT1-Dot1q-L-Secondary-108608	Port name.
state	string	ACTIVE	Port lifecycle status.
cvpId	string	108608	CloudVision Portal port identifier.
bandwidth	integer	1000	Data transfer capacity (Mbps).
usedBandwidth	integer	0	Port bandwidth consumed (Mbps).
availableBandwidth	integer	1000	Remaining port bandwidth (Mbps).
location	object	-	Geographic attributes of the specified access point.
project	object	-	Customer resource hierarchy project information. Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
device	object	-	Device configuration settings.
encapsulation	object	-	Encapsulation specification.
lag	object	-	Link aggregation group (LAG) configuration.
settings	object	-	Port configuration settings.
physicalPorts	array[object]	-	Preferences and settings for physical ports.
operation	object	-	Port operational status.
account	object	-	Port owner account information.
changeLog	object	-	A permanent record of asset creation, modification, or deletion.
location
href	string	https://api.equinix.com/fabric/v4/metros/AT	An absolute URL that returns the specified asset.
ibx	string	AT1	Alphanumeric identifier assigned to an Equinix International Business Exchange (IBX) data center in which a specified asset is located.
metroCode	string	AT	Metropolitan area identifier.
metroName	string	Atlanta	Metropolitan area name.
region	string	AMER	Broad geographic area in which a specified Equinix asset is located: AMER — The Americas APAC — Asia-Pacific) EMEA — Europe, the Middle East, and Africa
project
projectId	string	377533000114703	Customer project identifier.
device
name	string	dev-m7a2.lab	Equinix-assigned device identifier.
redundancy	object	-	Port redundancy configuration.
device.redundancy
priority	string	Secondary	Relative priority in the redundancy group.
encapsulation
type	string	DOT1Q	Encapsulation protocol.
tagProtocolId	string	0x8100	Tagging protocol identifier. 0x8100 - DOT1Q 0x9100 - QINQ
lag
id	string	108608	Link aggregation group (LAG) ID.
enabled	boolean	true	Indicator showing if port is LAG enabled. The default value is false.
name	string	ae-108608	LAG name.
settings
buyout	boolean	false	Buyout (true) or standard port configuration. Buyout ports offer free unlimited connections. Standard ports (false) do not. The default value is false.
placeVcOrderPermission	boolean	true	Permission to order a virtual connection. The default value is false.
viewPortPermission	boolean	true	Indicates if the user can see the port. The default value is false.
physicalPorts
uuid	string	dfd8884bb-4f65-4ab3-8f77-500dec2f87777	Unique Id of the switch port.
state	string	PROVISIONED	Port availability.
type	string	XF_PHYSICAL_PORT	Physical port type.
id	integer	6967	Physical port identifier.
bandwidth	integer	10000	Data transfer capacity (Mbps).
tether	object	-	Equinix-side physical port connector information.
demarcationPoint	object	-	Customer-side physical port connector information.
settings	object	-	Physical port specifications.
operation	object	-	Operational data for a specified port.
physicalPorts.tether
crossConnectId	string	100179-A	Cross-connection identifier.
cabinetNumber	string	Demarc	Cabinet name.
systemName	string	GV1:01:001032	Colocation cage identifier.
patchPanelName	string	PP:956:66107	Name of the patch panel where the given port is located.
patchPanelPortA	string	5	ID for the origin of a cross-connect port interface.
patchPanelPortB	string	42	ID for the destination side of a cross-connect port interface.
physicalPorts.demarcationPoint
patchPanelName	string	PP:956:66107	Name of the patch panel where the given port is located.
patchPanelPortA	string	5	ID for the origin of a cross-connect port interface.
patchPanelPortB	string	42	ID for the destination side of a cross-connect port interface.
ibx	string	DC6	Identifier of the IBX data center where the given physical port is located.
physicalPorts.settings
sharedPortType	boolean	false	Type of shared port. A shared port is a single physical port that handles multiple virtual connections.
sharedPortProduct	string	NA	Name of the Equinix product associated with the shared port.
physicalPorts.operation
operationalStatus	string	UP	Availability of a given physical port.
operation
operationalStatus	string	UP	Availability of a given port.
opStatusChangedAt	string	2021-08-14T19:30:29.526Z	Date and time at which port availability changed in IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` or `YYYY-MM-DDTHH:MM:SSZ`.
connectionCount	integer	0	Total number of connections established using this port.
acount
accountNumber	integer	100179	Equinix-assigned account number.
accountName	string	L2	Legal name of the accountholder.
globalCustId	string	007700000090982RG8	Equinix-assigned ID of the subscriber's parent organization.
orgId	string	100179	Equinix-assigned ID of the subscriber's organization.
organizationName	string	Cust_Org_100179	Equinix-assigned name of the subscriber's organization.
changeLog
createdDateTime	string	2021-08-14T19:30:29.526Z	Asset creation timestamp in IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` or `YYYY-MM-DDTHH:MM:SSZ`.

If you get an “Access Denied” error, please contact your local Equinix Service Desk for help.

Delete Specified Port

	DELETE /fabric/v4/ports/{portUuid}
Method	DELETE
URL or Endpoint	/fabric/v4/ports/{portUuid}
Headers	Authorization
Path Parameters	uuid
Query Parameters	Not applicable
Body Parameters	Not applicable

Deletes a port.

To obtain an authorization token, see the Getting Access Token section under Requesting Access and Refresh Tokens.

Sample curl request

curl -X DELETE 'https://api.equinix.com/fabric/v4/ports/13c0f286-1190-480c-8a45-b3df00cad9cf'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'

Path parameters

Parameter	Description
portUuid `string` REQUIRED	Unique Id of a port. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

Sample response

{
  "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": "DEPROVISIONING",
  "bandwidth": 10000,
  "usedBandwidth": 0,
  "availableBandwidth": 20000,
  "redundancy": {
    "group": "C91484bb-4f65-4ab3-8f77-500dec2f855C",
    "priority": "PRIMARY"
  },
  "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": "C91484bb-4f65-4ab3-8f77-500dec2f855C",
      "priority": "PRIMARY"
    }
  },
  "encapsulation": {
    "type": "DOT1Q",
    "tagProtocolId": 33024
  },
  "lagEnabled": true,
  "lag": {
    "enabled": true
  },
  "settings": {
    "buyout": false,
    "placeVcOrderPermission": true,
    "viewPortPermission": true
  },
  "physicalPorts": [
    {
      "state": "DEPROVISIONING",
      "type": "XF_PHYSICAL_PORT",
      "bandwidth": 10000,
      "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"
      }
    }
  ],
  "account": {
    "accountNumber": 100179,
    "accountName": "L2 account",
    "globalCustId": "007700000090982RG8",
    "orgId": 100179,
    "organizationName": "Cust_Org_100179"
  },
  "changeLog": {
    "createdDateTime": "2018-06-14T17:21:25.587Z"
  }
}

Response payload body description

For a detailed description of the response, refer to the response of Get Specified Port.

Get Used Vlans

	GET /fabric/v4/ports/{portUuid}/linkProtocols
Method	GET
URL or Endpoint	/fabric/v4/ports/{portUuid}/linkProtocols
Headers	Authorization
Path Parameters	uuid
Query Parameters	offset, limit
Body Parameters	Not applicable

This API returns used Vlans for a specified port.

To obtain an authorization token, see the Getting Access Token section under Requesting Access and Refresh Tokens.

Sample curl request

curl -X GET 'https://api.equinix.com/fabric/v4/ports/13c0f286-1190-480c-8a45-b3df00cad9cf/linkProtocols'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'

Path parameters

Parameter	Mandatory	Type	Example	Applicable Values	Description
uuid	no	string	e91484bb-4f65-4ab3-8f77-500dec2f855d	-	Equinix-assigned port identifier.

Sample response

{
    "pagination": {
        "offset": 0,
        "limit": 20,
        "total": 3
    },
    "data": [
        {
            "href": "https://api.equinix.com/fabric/v4/ports/637bb50e-3f3c-4587-972d-540a1e8a27ca/linkProtocols?offset=0&limit=20",
            "uuid": "fcd4ffdf-d4ef-45c8-9a83-7389d4912695",
            "state": "RESERVED",
            "type": "DOT1Q",
            "vlanSTag": 2288,
            "connection": {
                "uuid": "9624b2bf-dd4c-40f2-9a13-72c7601b1d8a",
                "bandwidth": 50000000
            },
            "changeLog": {
                "createdDateTime": "2023-01-19T23:03:47.192Z"
            }
        },
        {
            "href": "https://api.equinix.com/fabric/v4/ports/637bb50e-3f3c-4587-972d-540a1e8a27ca/linkProtocols?offset=0&limit=20",
            "uuid": "6648145c-01e9-4437-b6f7-5dab4a2c8a8d",
            "state": "RESERVED",
            "type": "DOT1Q",
            "vlanTagMin": 0,
            "vlanTagMax": 0,
            "vlanSTag": 588,
            "vlanCTagMin": 0,
            "vlanCTagMax": 0,
            "serviceToken": {
                "uuid": "f6e45f4c-71df-4640-b344-21db9343562f",
                "bandwidth": 50000000
            },
            "changeLog": {
                "createdDateTime": "2023-03-06T23:09:13.249Z"
            }
        },
        {
            "href": "https://api.equinix.com/fabric/v4/ports/637bb50e-3f3c-4587-972d-540a1e8a27ca/linkProtocols?offset=0&limit=20",
            "uuid": "da4711ee-63a4-4eb4-9f0d-861313e2c247",
            "state": "RESERVED",
            "type": "DOT1Q",
            "vlanTagMin": 0,
            "vlanTagMax": 0,
            "vlanSTag": 663,
            "vlanCTagMin": 0,
            "vlanCTagMax": 0,
            "connection": {
                "uuid": "7f32f834-24f8-460f-a704-bd27b3dff9af",
                "bandwidth": 5000000
            },
            "changeLog": {
                "createdDateTime": "2023-03-08T16:56:28.093Z"
            }
        }
    ]
}

Use the Metros API to create a list of all metros your account can connect to.

Response payload body description

Parameter	Type	Example	Description
pagination	object	-	Search results pagination settings.
data	array[object]	-	Data array containing returned objects.
pagination
offset	integer	?offset=0	Index of the first item returned in the response. The value must be >=0, and the default is 0.
limit	integer	?limit=10	Maximum number of items returned per page. Number must be between 1 and 1000, and the default is 999.
total	integer	1	Total number of items returned.
data
href	string	https://api.equinix.com/fabric/v4/ports/e91484bb-4f65-4ab3-8f77-500dec2f855d	An absolute URL that returns the specified asset.
uuid	string	e91484bb-4f65-4ab3-8f77-500dec2f855d	Equinix-assigned port identifier.
state	string	RESERVED	Whether the port is RESERVED or not.
type	string	DOT1Q	Type.
vlanSTag	integer	588	QINQ protocol outer (service) VLAN tag used to identify packets as they traverse trunk lines.
vlanCTag	integer	588	QINQ protocol inner (customer) VLAN tag used to identify packets as they traverse trunk lines.
vlanCTagMin	integer	0	QINQ protocol lowest customer VLAN tag value.
vlanCTagMax	integer	0	QINQ protocol highest customer VLAN tag value.
vlanTagMin	integer	0	DOT1Q protocol VLAN tag range lowest value.
vlanTagMax	integer	0	DOT1Q protocol VLAN tag range highest value.
serviceToken	object	-	An object that has the details of the service token.
connection	object	-	An object that has the details of the connection.
changeLog	object	-	A permanent record of asset creation, modification, or deletion.
serviceToken
uuid	string	e91484bb-4f65-4ab3-8f77-500dec2f855d	Equinix-assigned service token identifier.
bandwidth	integer	1000000	Bandwidth.
connection
uuid	string	e91484bb-4f65-4ab3-8f77-500dec2f855d	Equinix-assigned connection identifier.
bandwidth	integer	1000000	Bandwidth.
changeLog
createdBy	string	_system	Created by
createdDateTime	string	2021-08-14T19:30:29.526Z	Asset creation timestamp in IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` or `YYYY-MM-DDTHH:MM:SSZ`.
updatedDateTime	string	2021-08-14T19:30:29.526Z	Asset creation timestamp in IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` or `YYYY-MM-DDTHH:MM:SSZ`.

If you get an “Access Denied” error, please contact your local Equinix Service Desk for help.

Search Ports

	POST /fabric/v4/ports/search
Method	POST
URL or Endpoint	/fabric/v4/ports/search
Headers	Authorization, Content-Type
Path Parameters	Not applicable
Query Parameters	Not applicable
Body Parameters	filter

Search for ports.

For instructions on how to obtain an authorization token, refer to Requesting Access and Refresh Tokens.

Sample curl request

curl -X POST 'http://api.equinix.com/fabric/v4/ports/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
  "filter": {
    "or": [
      {
        "and": [
          {
            "operator": "=",
            "property": "/project/projectId",
            "values": [
              "30ad25e2-53dc-11ed-bdc3-0242ac120002"
            ]
          },
          {
            "operator": "=",
            "property": "/state",
            "values": [
              "ACTIVE"
            ]
          },
          {
            "operator": "=",
            "property": "/settings/productCode",
            "values": [
              "CX"
            ]
          }
        ]
      }
    ]
  },
  "pagination": {
    "limit": 25,
    "offset": 0,
    "total": 0
  },
  "sort": [
    {
      "property": "/device/name",
      "direction": "DESC"
    }
  ]
}'

Body parameters

Parameter	Description
filter `object` REQUIRED	Object containing filtering criteria to search for ports.
or `array[object]` REQUIRED	Array of criteria joined by the "or" operator.
and `array[object]` REQUIRED	Array of criteria joined by the "and" operator.
property `string` REQUIRED	Search for ports based on filtering criteria. Applicable values: /project/projectId /state /settings/productCode
operator `string` REQUIRED	Parameter operator. Applicable values: =
values `string` REQUIRED	Parameter value. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

/project/projectId	Example: "property": "/project/projectId", "operator": "=", "values": [ "xx-xx-xx" ]
operator `string` REQUIRED	Search field operator. Applicable values: =
value `array[string]` REQUIRED	Connection name. Example: ["xx-xx-xx"]

/state	Example: "property": "/state", "operator": "=", "values": [ "ACTIVE ]
operator `string` REQUIRED	Search field operator. Applicable values: =
value `array[string]` REQUIRED	State of the port. Example: ["ACTIVE"]

/settings/productCode	Example: "property": "/settings/productCode", "operator": "=", "values": [ "CX" ]
operator `string` REQUIRED	Search field operator. Applicable values: =
value `array[string]` REQUIRED	Search by the state of ports. Example: ["CX"]

Sample response - ports

{
    "pagination": {
        "offset": 0,
        "limit": 999,
        "total": 133
    },
    "data": [
        {
            "href": "https://api.equinix.com/fabric/v4/ports/c791f8cb-599b-99b0-8ce0-306a5c00a4ee",
            "type": "XF_PORT",
            "uuid": "c791f8cb-599b-99b0-8ce0-306a5c00a4ee",
            "name": "testBuyer-DC5-NL-Dot1q-BO-PRI-10G-JN-163",
            "state": "ACTIVE",
            "cvpId": "1614613",
            "bandwidth": 10000,
            "usedBandwidth": 6165,
            "availableBandwidth": 3835,
            "location": {
                "href": "https://api.equinix.com/fabric/v4/metros/DC",
                "ibx": "DC5",
                "metroCode": "DC",
                "metroName": "Ashburn",
                "region": "AMER"
            },
            "project": {
                "projectId": "1234567"
            },

            "device": {
                "name": "qa3-dc-a1.lab",
                "redundancy": {
                    "priority": "PRIMARY"
                }
            },
            "encapsulation": {
                "type": "DOT1Q",
                "tagProtocolId": "0x8100"
            },
            "lag": {
                "enabled": false
            },
            "settings": {
                "buyout": true,
                "placeVcOrderPermission": true,
                "viewPortPermission": true
            },
            "physicalPorts": [
                {
                    "state": "ACTIVE",
                    "type": "XF_PHYSICAL_PORT",
                    "id": 1426515,
                    "bandwidth": 10000,
                    "tether": {
                        "crossConnectId": "ECX.01.00002995",
                        "cabinetNumber": "Demarc",
                        "systemName": "DC5:01:001015",
                        "patchPanelName": "PP:Demarc:00001016",
                        "patchPanelPortA": "1",
                        "patchPanelPortB": "2",
                    },
                    "demarcationPoint": {
                        "patchPanelName": "PP:Demarc:00001015",
                        "patchPanelPortA": "5",
                        "patchPanelPortB": "6",
                        "ibx": "DC5"
                    },
                    "settings": {
                        "sharedPortType": false,
                        "sharedPortProduct": "NA"
                    },
                    "operation": {
                        "operationalStatus": "UP",
                        "opStatusChangedAt": "2021-12-02T00:00:00Z"
                    }
                }
            ],
            "operation": {
                "operationalStatus": "UP",
                "opStatusChangedAt": "2021-07-20T17:04:18Z",
                "connectionCount": 53,
                "evplVCCount": 53,
                "fgVCCount": 0,
                "accessVCCount": 0
            },
            "account": {
                "accountNumber": 270001,
                "accountName": "testBuyer",
                "ucmId": "08374E19-9B56-4c27-84BA-33D42BB0940C",
                "globalCustId": "0016u000003JZ4sAAG",
                "orgId": "91997",
                "organizationName": "testBuyer-270001"
            },
            "changeLog": {
                "updatedDateTime": "2021-07-20T17:04:18Z",
                "createdDateTime": "2021-07-20T17:04:18Z"
            }
        }
    ]
}

Response payload body description

Parameter	Data Type	Example Values	Description
pagination	object	-	Search results pagination settings.
data	array[object]	-	Data array containing returned objects.
pagination
offset	integer	?offset=0	Index of the first item returned in the response. The value must be >=0, and the default is 0.
limit	integer	?limit=10	Maximum number of items returned per page. Number must be between 1 and 1000, and the default is 999.
total	integer	1	Total number of items returned.
data
href	string	https://api.equinix.com/fabric/v4/ports/e91484bb-4f65-4ab3-8f77-500dec2f855d	An absolute URL that returns the specified asset.
type	string	XF_PORT	Type of port.
uuid	string	e91484bb-4f65-4ab3-8f77-500dec2f855d	Equinix-assigned port identifier.
name	string	AT1-Dot1q-L-Secondary-108608	Port name.
state	string	ACTIVE	Port lifecycle status.
cvpId	string	108608	CloudVision Portal port identifier.
bandwidth	integer	1000	Data transfer capacity (Mbps).
usedBandwidth	integer	0	Port bandwidth consumed (Mbps).
availableBandwidth	integer	1000	Remaining port bandwidth (Mbps).
location	object	-	Geographic attributes of the specified access point.
project	object	-	Customer resource hierarchy project information. Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
device	object	-	Device configuration settings.
encapsulation	object	-	Encapsulation specification.
lag	object	-	Link aggregation group (LAG) configuration.
settings	object	-	Port configuration settings.
physicalPorts	array[object]	-	Preferences and settings for physical ports.
operation	object	-	Port operational status.
account	object	-	Port owner account information.
changeLog	object	-	A permanent record of asset creation, modification, or deletion.
location
href	string	https://api.equinix.com/fabric/v4/metros/AT	An absolute URL that returns the specified asset.
ibx	string	AT1	Alphanumeric identifier assigned to an Equinix International Business Exchange (IBX) data center in which a specified asset is located.
metroCode	string	AT	Metropolitan area identifier.
metroName	string	Atlanta	Metropolitan area name.
region	string	AMER	Broad geographic area in which a specified Equinix asset is located: AMER — The Americas APAC — Asia-Pacific) EMEA — Europe, the Middle East, and Africa
project
projectId	string	377533000114703	Customer project identifier.
device
name	string	dev-m7a2.lab	Equinix-assigned device identifier.
redundancy	object	-	Port redundancy configuration.
device.redundancy
priority	string	Secondary	Relative priority in the redundancy group.
encapsulation
type	string	DOT1Q	Encapsulation protocol.
tagProtocolId	string	0x8100	Tagging protocol identifier. 0x8100 - DOT1Q 0x9100 - QINQ
lag
id	string	108608	Link aggregation group (LAG) ID.
enabled	boolean	true	Indicator showing if port is LAG enabled. The default value is false.
name	string	ae-108608	LAG name.
settings
buyout	boolean	false	Buyout (true) or standard port configuration. Buyout ports offer free unlimited connections. Standard ports (false) do not. The default value is false.
placeVcOrderPermission	boolean	true	Permission to order a virtual connection. The default value is false.
viewPortPermission	boolean	true	Indicates if the user can see the port. The default value is false.
physicalPorts
state	string	PROVISIONED	Port availability.
type	string	XF_PHYSICAL_PORT	Physical port type.
id	integer	6967	Physical port identifier.
bandwidth	integer	10000	Data transfer capacity (Mbps).
tether	object	-	Equinix-side physical port connector information.
demarcationPoint	object	-	Customer-side physical port connector information.
settings	object	-	Physical port specifications.
operation	object	-	Operational data for a specified port.
physicalPorts.tether
crossConnectId	string	100179-A	Cross-connection identifier.
cabinetNumber	string	Demarc	Cabinet name.
systemName	string	GV1:01:001032	Colocation cage identifier.
patchPanelName	string	PP:956:66107	Name of the patch panel where the given port is located.
patchPanelPortA	string	5	ID for the origin of a cross-connect port interface.
patchPanelPortB	string	42	ID for the destination side of a cross-connect port interface.
physicalPorts.demarcationPoint
patchPanelName	string	PP:956:66107	Name of the patch panel where the given port is located.
patchPanelPortA	string	5	ID for the origin of a cross-connect port interface.
patchPanelPortB	string	42	ID for the destination side of a cross-connect port interface.
ibx	string	DC6	Identifier of the IBX data center where the given physical port is located.
physicalPorts.settings
sharedPortType	boolean	false	Type of shared port. A shared port is a single physical port that handles multiple virtual connections.
sharedPortProduct	string	NA	Name of the Equinix product associated with the shared port.
physicalPorts.operation
operationalStatus	string	UP	Availability of a given physical port.
operation
operationalStatus	string	UP	Availability of a given port.
opStatusChangedAt	string	2021-08-14T19:30:29.526Z	Date and time at which port availability changed in IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` or `YYYY-MM-DDTHH:MM:SSZ`.
connectionCount	integer	0	Total number of connections established using this port.
acount
accountNumber	integer	100179	Equinix-assigned account number.
accountName	string	L2	Legal name of the accountholder.
globalCustId	string	007700000090982RG8	Equinix-assigned ID of the subscriber's parent organization.
orgId	string	100179	Equinix-assigned ID of the subscriber's organization.
organizationName	string	Cust_Org_100179	Equinix-assigned name of the subscriber's organization.
changeLog
createdDateTime	string	2021-08-14T19:30:29.526Z	Asset creation timestamp in IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` or `YYYY-MM-DDTHH:MM:SSZ`.

If you get an “Access Denied” error, contact your local Equinix Service Desk for help.

Prices

Retrieve Pricing

	POST /fabric/v4/prices/search
Method	POST
URL or Endpoint	/fabric/v4/prices/search
Headers	Authorization, Content-Type
Path Parameters	Not applicable
Query Parameters	Not applicable
Body Parameters	filter

This API request retrieves pricing information for a specified product.

Refer to one of the following for specific use case examples:

For instructions on how to obtain an authorization token, refer to Requesting Access and Refresh Tokens.

Sample curl request - pricing information for a connection between a colocation port and a service profile

curl -X POST 'http://api.equinix.com/fabric/v4/prices/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "filter": {
        "and": [
            {
                "property": "/type",
                "operator": "=",
                "values": [
                    "VIRTUAL_CONNECTION_PRODUCT"
                ]
            },
            {
                "property": "/connection/type",
                "operator": "=",
                "values": [
                    "EVPL_VC"
                ]
            },
            {
                "property": "/connection/bandwidth",
                "operator": "IN",
                "values": [
                    50,
                    1000
                ]
            },
            {
                "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": [
                    "DC"
                ]
            },
            {
                "property": "/connection/zSide/accessPoint/type",
                "operator": "=",
                "values": [
                    "SP"
                ]
            },
            {
                "property": "/connection/zSide/accessPoint/profile/uuid",
                "operator": "=",
                "values": [
                    "e0346949-00af-480b-801b-bdd2b8980c6e"
                ]
            }
        ]
    }
}' 

Body parameters

Parameter Name

Mandatory

Data Type

Example

Applicable Values

Description

filter

yes

object

—

Array of objects defining search conditions.

and

yes

array[object]

—

Logical operator.

property

yes

string

/type

/type
/account/accountNumber
/connection/type
/connection/bandwidth
/connection/aSide/accessPoint/type
/connection/aSide/accessPoint/location/metroCode
/connection/aSide/accessPoint/port/settings/buyout
/connection/zSide/accessPoint/location/metroCode
/connection/zSide/accessPoint/type
/connection/zSide/accessPoint/profile/uuid
/connection/zSide/accessPoint/bridge/package/code

/ipBlock/type
/ipBlock/prefixLength
/ipBlock/location/metroCode

/router/location/metroCode
/router/package/code

/port/location/ibx
/port/type
/port/bandwidth
/port/settings/buyout
/port/connectivitySource/type
/port/serviceType
/port/lag/enabled

Search field parameter. Note that the property value determines the list of applicable operators and values.

operator

yes

string

=
IN

Search field parameter operator.

values

yes

array[string]

["VIRTUAL_CONNECTION_PRODUCT"]

VIRTUAL_CONNECTION_PRODUCT
IP_BLOCK_PRODUCT
CLOUD_ROUTER_PRODUCT
VIRTUAL_PORT_PRODUCT

Search field parameter value.

/type

yes

"property": "/type",
"operator": "=",
"values": [
"VIRTUAL_CONNECTION_PRODUCT"
]

Product type.

Note that the product type determines the properties required to retrieve pricing information.

operator

yes

string

Search field parameter operator.

values

yes

array[string]

["VIRTUAL_CONNECTION_PRODUCT"]

VIRTUAL_CONNECTION_PRODUCT
IP_BLOCK_PRODUCT
CLOUD_ROUTER_PRODUCT
VIRTUAL_PORT_PRODUCT

/account/accountNumber

conditional

"property": "/account/accountNumber",
"operator": "=",
"values": [
270001
]

Billing account number.

Mandatory for port pricing.

operator

yes

string

Search field parameter operator.

values

yes

array[integer]

[270001]

Connection product specific properties

/connection/type

yes

"property": "/connection/type",
"operator": "=",
"values": [
"EVPL_VC"
]

Connection type.

Note that the connection type determines the A-side and the Z-side endpoints' properties.

operator

yes

string

Search field parameter operator.

values

yes

array[string]

["EVPL_VC"]

EVPL_VC
IP_VC
VD_CHAIN_VC

EVPL_VC - Ethernet virtual private line‒virtual connection.
IP_VC - Fabric Cloud Router virtual connection.
VD_CHAIN_VC - Device link connection between Network Edge virtual devices.

/connection/bandwidth

yes

"property": "/connection/bandwidth",
"operator": "IN",
"values": [
200,
500
]

Connection bandwidth (Mbps).

operator

yes

string

Search field parameter operator.

values

yes

array[integer]

[200, 500]

50
200
500
1000
2000
5000
10000

/connection/aSide /accessPoint/type

yes

"property": "/connection/aSide/accessPoint/type",
"operator": "=",
"values": [
"COLO"
]

Type of access point.

operator

yes

string

Search field parameter operator.

values

yes

array[string]

["COLO"]

COLO
CLOUD_ROUTER
VD

COLO - Colocation space in an IBX data center.
CLOUD_ROUTER - Fabric Cloud Router instance.
VD - Network Edge virtual device.

/connection/aSide /accessPoint/location/metroCode

required

"property": "/connection/aSide/accessPoint/location/metroCode",
"operator": "=",
"values": [
"CH"
]

Metropolitan area identifier.

operator

yes

string

Search field parameter operator.

values

yes

array[string]

["CH"]

Use the Get All Metros API request to retrieve the list of metros.

/connection/aSide /accessPoint/port/settings/buyout

"property": "/connection/aSide/accessPoint/port/settings/buyout",
"operator": "=",
"values": [
false
]

Buyout (true) or standard (false) configuration of the port at this access point. Buyout ports offer free unlimited connections. Standard ports do not.

operator

yes

string

Search field parameter operator.

values

yes

array[boolean]

[false]

true
false

Default: false

/connection/zSide /accessPoint/location/metroCode

"property": "/connection/zSide/accessPoint/location/metroCode",
"operator": "=",
"values": [
"CH"
]

Metropolitan area identifier.

operator

yes

string

Search field parameter operator.

values

yes

array[string]

["SV"]

Use the Get All Metros API request to retrieve the list of metros.

/connection/zSide /accessPoint/type

yes

{
"property": "/connection/zSide/accessPoint/type",
"operator": "=",
"values": [
"SP"
]
}

Type of access point.

operator

yes

string

Search field parameter operator.

values

yes

array[string]

["SP"]

CHAINGROUP
COLO
SP

CHAINGROUP - Device link group.
COLO - Colocation space in an IBX data center.
SP - Service profile.

/connection/zSide /accessPoint/profile/uuid

contitional

"property": "/connection/zSide/accessPoint/profile/uuid",
"operator": "=",
"values": [
"20d32a80-0d61-4333-bc03-707b591ae2f2"
]

Equinix-assigned service profile identifier.

Required for the SP access point type.

operator

yes

string

Search field parameter operator.

values

yes

array[string]

["20d32a80-0d61-4333-bc03-707b591ae2f2"]

/connection/zSide /accessPoint/bridge/package/code

conditional

"property": "/connection/zSide/accessPoint/bridge/package/code",
"operator": "=",
"values": [
"GLOBAL"
]

Connection bridge package code.

Required for the CHAINGROUP access point type.

operator

yes

string

values

yes

array[string]

["GLOBAL"]

GLOBAL
REGIONAL

GLOBAL - across all regions/metros.
REGIONAL - within a region.
LOCAL - within a metro

IP block product specific properties

/ipBlock/type

yes

"property": "/ipBlock/type",
"operator": "=",
"values": [
"IPv4"
]

IP addressing block type.

operator

yes

string

Search field parameter operator.

values

yes

array[string]

["IPv4"]

IPv4

IPv4 - IP version 4 addressing.

/ipBlock/prefixLength

yes

"property": "/ipBlock/prefixLength",
"operator": "=",
"values": [
29
]

The number of bits in the IP address that identify the network.

operator

yes

string

Search field parameter operator.

values

yes

array[integer]

[29]

/ipBlock/location/metroCode

yes

"property": "/ipBlock/location/metroCode",
"operator": "IN",
"values": [
"SV", "WA", "AM"
]

Metropolitan area identifier.

operator

yes

string

Search field parameter operator.

values

yes

array[string]

["SV", "WA", "AM"]

Use the Get All Metros API request to retrieve the list of metros.

Fabric Cloud Router product specific properties

/router/location/metroCode

yes

"property": "/router/location/metroCode",
"operator": "=",
"values": [
"SV"
]

Metropolitan area identifier.

operator

yes

string

Search field parameter operator.

values

yes

array[string]

["SV"]

Use the Get All Metros API request to retrieve the list of metros.

/router/package/code

yes

"property": "/router/package/code",
"operator": "IN",
"values": [
"LAB", "STANDARD"
]

Fabric Cloud Router package identifier.

operator

yes

string

Search field parameter operator.

values

yes

array[string]

["LAB", "STANDARD"]

LAB
STANDARD

LAB - Max Routes IPv4 = 50, Max Routes IPv6 = 50; 10Mbps max per connection ingress/egress bandwidth limit; Max connections per FCR: 10 (Trial package)

STANDARD - Max Routes IPv4 = 1000, Max Routes IPv6 = 100.

Virtual Port product specific properties

/port/location/ibx

yes

"property": "/port/location/ibx",
"operator": "=",
"values": [
"WA1"
]

Equinix IBX data center identifier.

operator

yes

string

Search field parameter operator.

values

yes

array[string]

["WA1"]

Use the Get All Metros API request to retrieve the list of metros.

/port/type

yes

"property": "/port/type",
"operator": "=",
"values": [
"XF_PORT"
]

Type of port.

operator

yes

string

Search field parameter operator.

values

yes

array[string]

["XF_PORT"]

XF_PORT

XF_PORT - Equinix Fabric port used as a Fabric connection endpoint.

/port/bandwidth

yes

"property": "/port/bandwidth",
"operator": "=",
"values": [
1000
]

Port bandwidth in Mbps.

operator

yes

string

Search field parameter operator.

values

yes

array[integer]

[1000]

1000
10000
100000

/port/settings/buyout

"property": "/port/settings/buyout",
"operator": "=",
"values": [
false
]

Buyout (true) or standard (false) configuration of the port at this access point. Buyout ports offer free, unlimited connections. Standard ports do not.

operator

yes

string

Search field parameter operator.

values

yes

array[boolean]

[false]

false
true

Default: false

/port/connectivitySource/type

"property": "/port/connectivitySource/type",
"operator": "=",
"values": [
"COLO"
]

Port connectivity source type.

operator

yes

string

Search field parameter operator.

values

yes

array[string]

["COLO"]

BMMR
COLO
REMOTE

Default: COLO

BMMR - Building's Meet Me Room available in one of the multitenant data centers.
COLO - Colocation space in an Equinix IBX data center.
REMOTE - Remote ports enable access to Equinix Fabric services through a third party such as an NSP.

/port/serviceType

"property": "/port/serviceType",
"operator": "=",
"values": [
"MSP"
]

Port service type.

operator

yes

string

Search field parameter operator.

values

yes

array[string]

["MSP"]

EPL
MSP

Default: MSP

EPL - Ethernet Private Line port for untagged, EPL connections.
MSP - Managed service port.

/port/lag/enabled

"property": "/port/lag/enabled",
"operator": "=",
"values": [
false
]

Indicator showing if a port can be part of a link aggregation group.

operator

yes

string

Search field parameter operator.

values

yes

array[boolean]

[false]

false
true

Default: false

Sample response

{
    "data": [
        {
            "type": "VIRTUAL_CONNECTION_PRODUCT",
            "code": "ECX00015.PROD",
            "name": "Equinix Fabric Virtual Connection Product",
            "description": "Equinix Fabric Virtual Connection",
            "charges": [
                {
                    "type": "MONTHLY_RECURRING",
                    "price": 250.0
                }
            ],
            "currency": "USD",
            "connection": {
                "type": "EVPL_VC",
                "bandwidth": 50,
                "aSide": {
                    "accessPoint": {
                        "type": "COLO",
                        "location": {
                            "metroCode": "CH"
                        }
                    }
                },
                "zSide": {
                    "accessPoint": {
                        "type": "SP",
                        "location": {
                            "metroCode": "DC"
                        },
                        "profile": {
                            "uuid": "e0346949-00af-480b-801b-bdd2b8980c6e"
                        }
                    }
                }
            }
        },
        {
            "type": "VIRTUAL_CONNECTION_PRODUCT",
            "code": "ECX00015.PROD",
            "name": "Equinix Fabric Virtual Connection Product",
            "description": "Equinix Fabric Virtual Connection",
            "charges": [
                {
                    "type": "MONTHLY_RECURRING",
                    "price": 900.0
                }
            ],
            "currency": "USD",
            "connection": {
                "type": "EVPL_VC",
                "bandwidth": 1000,
                "aSide": {
                    "accessPoint": {
                        "type": "COLO",
                        "location": {
                            "metroCode": "CH"
                        }
                    }
                },
                "zSide": {
                    "accessPoint": {
                        "type": "SP",
                        "location": {
                            "metroCode": "DC"
                        },
                        "profile": {
                            "uuid": "e0346949-00af-480b-801b-bdd2b8980c6e"
                        }
                    }
                }
            }
        }
    ],
    "pagination": {
        "offset": 0,
        "limit": 2,
        "total": 2
    }
}

Response body description

Field Name	Data Type	Example Values	Description
type	string	VIRTUAL_CONNECTION_PRODUCT	Product type.
code	string	ECX00015.PROD	Product code.
name	string	Equinix Fabric Virtual Connection Product	Product name.
description	string	Equinix Fabric Virtual Connection	Product description.
account	object	—	Customer billing account information.
charges	array[object]	—	List of product offerings with properties and prices.
currency	string	USD	Product offering price currency.
conenction	object	—	Connection information.

account
accountNumber	string	270001	Billing account number.

charges
type	string	MONTHLY_RECURRING	Charge type.
price	number	900.0	Offering price.

connection
type	string	EVPL_VC	Connection type.
bandwidth	integer	1000	Connection bandwidth (Mbps).
aSide/zSide	object	—	An A-Side (subscriber) or Z-side (provider) connection configuration.

aSide/zSide
accessPoint	object	—	Carrier-neutral network hub for interconnectivity among global internet access providers.

aSide/zSide.accessPoint
type	string	SP	Type of access point.
location	object	—	Attributes associated with the location of the specified connection.

aSide/zSide.accessPoint.location
metroCode	string	CH	Code assigned to an Equinix International Business Exchange (IBX) data center in a specified metropolitan area.

pagination
offset	integer	0	Index of the first item returned in the response.
limit	integer	2	Maximum number of items returned per page.
total	integer	2	Total number of items that match request criteria.

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Routing Table Entries

Retrieve Routing Tables Entries

	POST /fabric/v4/routers/{uuid}/routes/search
Method	POST
URL or Endpoint	/fabric/v4/routers/{uuid}/routes/search
Headers	Authorization, Content-Type
Path Parameters	uuid
Query Parameters	Not applicable
Body Parameters	filter, pagination, sort

This API request retrieves Fabric Cloud Router instances routing table entries that match provided search criteria.

For instructions on how to obtain an authorization token, refer to Requesting Access and Refresh Tokens.

Sample curl request - AND logical operator

curl -X POST 'http://api.equinix.com/fabric/v4/routers/{uuid}/routes/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "filter": {
        "and": [
            {
                "property": "/type",
                "operator": "=",
                "values": [
                    "IPv4_BGP_ROUTE"
                ]
            }
        ]
    },
    "pagination": {
        "offset": 0,
        "limit": 20
    },
    "sort": [
        {
            "direction": "DESC",
            "property": "/changeLog/createdDateTime"
        }
    ]
}'

Sample curl request - AND logical operator in conjunction with OR logical operator

curl -X POST 'http: //api.equinix.com/fabric/v4/routers/{uuid}/routes/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "filter": {
        "and": [
            {
                "or": [
                    {
                        "property": "/type",
                        "operator": "LIKE",
                        "values": [
                            "IPv4_BGP_ROUTE"
                        ]
                    },
                    {
                        "property": "/type",
                        "operator": "LIKE",
                        "values": [
                            "abc"
                        ]
                    }
                ]
            ]
        }
    ]
},
"pagination": {
    "offset": 0,
    "limit": 20
},
"sort": [
    {
        "direction": "DESC",
        "property": "/changeLog/createdDateTime"
    }
]
}'

Path parameters

Parameter	Mandatory	Type	Example	Applicable Values	Description
uuid	yes	string	638895bc-4458-4627-9a3d-02c76ab362d7	-	Equinix-assigned Fabric Cloud Router instance identifier.

Body parameters

Parameter	Mandatory	Type	Example	Applicable Values	Description
filter	no	object	-	-	Array of objects defining search conditions.
pagination	no	object	-	-	Search results pagination settings.
sort	no	object	-	-	Search results sorting settings.

filter
and	yes	array[object]	-	-	Logical operator.
property	yes	string	/type	/nextHop /prefix /status /type /*	Search field parameter. Note that the property value determines the list of applicable operators and values. /nextHop - The IP address of the next router through which a packet must pass on the way to its destination. /prefix - Subscriber subnet prefix. /type - Routing table entries type. /status - Routing table entry status. /* - All categories search.
operator	yes	string	=	= != > >= < <= LIKE IN NOT LIKE NOT IN ~*	Search field parameter operator. ~* - Case-insensitive all-category like.
values	yes	array[string]	["IPv4_BGP_ROUTE"]	-	Search field parameter value.

/nextHop	no		"property": "/nextHop", "operator": "=", "values": [ "10.10.10.5" ]		The IP address of the next router through which a packet must pass on the way to its destination.
operator	yes	string	=	= != LIKE IN NOT LIKE NOT IN ~*	Search field parameter operator.
values	yes	array[string]	["10.10.10.5"]	-	-

/state	no		"property": "/state", "operator": "=", "values": [ "ACTIVE" ]		Routing table entry status.
operator	yes	string	=	= != LIKE IN NOT LIKE NOT IN ~*	Search field parameter operator.
values	yes	array[string]	["ACTIVE"]	ACTIVE INACTIVE	ACTIVE - Routing trable entry represents an active route. INACTIVE - Routing trable entry represents an inactive route.

/prefix	no		{ "property": "/prefix", "operator": "=", "values": [ "10.203.1.0/30" ] }		Subscriber subnet prefix.
operator	yes	string	=	= != LIKE IN NOT LIKE NOT IN ~*	Search field parameter operator.
values	yes	array[string]	["10.203.1.0/30"]	-	-

/type	no		"property": "/type", "operator": "=", "values": [ "IPv4_BGP_ROUTE" ]		Routing table entry type.
operator	yes	string	LIKE	= != LIKE IN NOT LIKE NOT IN ~*	Search field parameter operator.
values	yes	array[string]	["IPv4_BGP_ROUTE"]	IPv4_BGP_ROUTE IPv6_BGP_ROUTE	IPv4_BGP_ROUTE - IPv4 BGP protocol routing entry. IPv6_BGP_ROUTE - IPv6 BGP protocol routing entry.

/*	no		"property": "/*", "operator": "LIKE", "values": [ "IPv4" ]		All category search.
operator	yes	string	LIKE	= != LIKE IN NOT LIKE NOT IN ~*	Search field parameter operator.
values	yes	array[string]	["IPv4"]	-	-

or
or	no	array[objects]	-	Maximum: 3 array elements	Array of objects defining search criteria. Refer to filtering parameters for information on available search options.

pagination
offset	no	integer	0	Minimum: 0 Default: 0	Index of the first item returned in the response.
limit	no	integer	20	Minimum: 1 Default: 20	Maximum number of items returned per page.

sort
direction	no	string	DESC	ASC DESC	Search results sorting direction.
property	no	string	/changeLog/updatedDateTime	/prefix /changeLog/createdDateTime Default: /changeLog/createdDateTime	Search results sorting parameter.

Sample response - AND logical operator

{
    "pagination": {
        "offset": 0,
        "limit": 20,
        "total": 100
    },
    "data": [
        {
            "type": "IPv4_BGP_ROUTE",
            "state": "ACTIVE",
            "age": "PT5M30S",
            "prefix": "192.168.10.0/24",
            "nextHop": "10.10.10.5",
            "metric": 5,
            "localPreference": 200,
            "asPath": [
                66008,
                12672
            ],
            "connection": {
                "uuid": "81331c52-04c0-4656-a4a7-18c52669348f",
                "name": "My-Connection"
            },
            "changeLog": {
                "createdDateTime": "2022-03-15T10:33:42.579Z",
                "updatedDateTime": "2022-03-15T10:33:42.579Z"
            }
        }
    ]
}

Response payload body description

Parameter	Type	Example values	Description
pagination	object	-	Search results pagination settings.
data	array[object]	-	Data array containing search results.

pagination
offset	integer	0	Index of the first item returned in the response.
limit	integer	20	Maximum number of items returned per page.
total	integer	1	Total number of items returned.

data
type	string	IPv4_BGP_ROUTE	Routing table entry type. IPv4_BGP_ROUTE - IPv4 BGP protocol routing entry. IPv6_BGP_ROUTE - IPv6 BGP protocol routing entry.
state	string	ACTIVE	Routing table entry status. ACTIVE - Routing trable entry represents an active route. INACTIVE - Routing trable entry represents an inactive route.
age	string	PT5M30S	The time that has passed since the entry has been added to the routing table, in ISO 8601 date and time format.
prefix	string	192.168.10.0/24	Subscriber subnet prefix.
nextHop	string	10.10.10.5	The IP address of the next router through which a packet must pass on the way to its destination.
metric	integer	5	The minimum number of hops it takes to reach the destination.
localPreference	integer	200	Local preference value determining the best path for outbound traffic.
asPath	array[integer]	[66008, 12672]	The list of autonomous systems that must be traversed to reach a given destination.
connection	object	-	Equinix Fabric connection associated with a given routing table entry.
changeLog	object	-	A permanent record of asset creation, modification, or deletion.

connection
uuid	string	81331c52-04c0-4656-a4a7-18c52669348f	Equinix-assigned connection identifier.
name	string	My-Connection	Connection name.

changeLog
createdDateTime	string	2021-07-15T19:30:29.526Z	Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
updatedDateTime	string	2021-07-15T19:30:29.526Z	Asset update timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Routing Protocols

Create Routing Protocol Instance

	POST /fabric/v4/connections/{connectionUuid}/routingProtocols
Method	POST
URL or Endpoint	/fabric/v4/connections/{connectionUuid}/routingProtocols
Headers	Authorization, Content-Type
Path Parameters	connectionUuid
Query Parameters	Not applicable
Body Parameters	type, name, directIpv4, directIpv6, bgpIpv4, bgpIpv6, asOverrideEnabled, customerAsn, bgpAuthKey, bfd

This API request adds a routing protocol definition to a given connection.

Sample curl request - direct routing instance

curl -X
POST 'https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4/routingProtocols'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "type": "DIRECT",
    "name": "My-Direct-route-1",
    "directIpv4": {
        "equinixIfaceIp": "192.168.100.1/30"
    },
    "directIpv6": {
        "equinixIfaceIp": "2001:7a9::34f4:0:f3dd:1/126"
    }
}'

Sample curl request - BGP routing protocol instance

curl -X
POST 'https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4/routingProtocols'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "type": "BGP",
    "bgpIpv4": {
        "customerPeerIp": "10.1.1.2",
        "enabled": true,
        "outboundASPrependCount": 1
    },
    "bgpIpv6": {
        "customerPeerIp": "2001:db8:c59b::1",
        "enabled": true,
        "outboundASPrependCount": 1
    },
    "customerAsn": 65002,
    "bgpAuthKey": "string",
    "bfd": {
        "enabled": true,
        "interval": 100
    }
}' 

Sample curl request - connection to Google Cloud Platform - direct routing instance (IPv4)

curl -X
POST 'https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4/routingProtocols'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "type": "DIRECT",
    "directIpv4": {
        "equinixIfaceIp": "169.254.100.1/30"
    }
}' 

Sample curl request - connection to Google Cloud Platform - BGP routing protocol instance

curl -X
POST 'https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4/routingProtocols'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'-d '{
    "type": "BGP",
    "bgpIpv4": {
        "customerPeerIp": "169.254.100.2",
        "enabled": true,
        "outboundASPrependCount": 1
    },
    "customerAsn": 65002,
    "bgpAuthKey": "string",
    "bfd": {
        "enabled": true,
        "interval": 100
    }
}' 

Path parameters

Parameter	Mandatory	Type	Example Values	Applicable Values	Description
connectionUuid	yes	string	557400f8-d360-11e9-bb65-2a2ae2dbcce4	Use the Retrieve Connections API request to retrieve the list of connections.	Equinix-assigned connection identifier.

Body Parameters

Parameter	Mandatory	Type	Example Values	Applicable Values	Description
type	yes	string	BGP	BGP DIRECT	Routing protocol type. BGP - Border gateway protocol defining peering between routers on customer and Equinix side. DIRECT - Direct connection specification.
name	no	string	My-BGP-route-1	-	Routing protocol definition name.
directIpv4	yes	object	-	-	Direct routing related IPv4 addressing configuration.
directIpv6	yes	object	-	-	Direct routing related IPv6 addressing configuration.
asOverrideEnabled	no	boolean	true	true, false	Defines the optional AS override policy (defaults to false/off). The policy is applied to one or more IPv4 and/or IPv6 peering sessions as an outbound route map.
directIpv4
equinixIfaceIp	yes	string	192.168.100.1/30	IPv4 address in CIDR notation.	Networking interface IPv4 address on Equinix side. Applicable to DIRECT type routing protocol instances.
directIpv6
equinixIfaceIp	yes	string	2001:7a9::34f4:0:f3dd:1/126	IPv6 address in CIDR notation.	Networking interface IPv6 address on Equinix side. Applicable to DIRECT type routing protocol instances.
bgpIpv4	no	object	-	-	BGP related IPv4 addressing configuration.
bgpIpv6	no	object	-	-	BGP related IPv6 addressing configuration for BGP type routing protocol instances.
customerAsn	yes	integer	65002	Minimum: 1 Maximum: 4294967294 Exclusions: IANA special Purpose: 0, 112, 23456, 64000 - 64495, 64496- 64511, 65535, 65536 - 65551, 4294967295 Equinix reserved: 64600, 4200000000 - 42000000002	Customer's autonomous system number (ASN). Applicable to BGP type routing protocol instances.
bgpAuthKey	no	string	a667d47acc18ea6b	Maximum: 80 characters	Border gateway protocol authentication key for authenticating point-to-point TCP connections between peering routers. Applicable to BGP type routing protocol instances.
bfd	no	object	-	-	Bidirectional failure detection (BFD) configuration settings applicable to Fabric Cloud Router connections. Applicable to BGP type routing protocol instances.
bgpIpv4
customerPeerIp	yes	string	10.1.1.2	IPv4 address.	Customer side BGP peering IPv4 address. Applicable to BGP type routing protocol instances.
enabled	no	boolean	true		Whether bgpIpv4 peering should be enabled or not. True=enabled
outboundASPrependCount	no	integer	1	0,1,3,5	We use outboundASPrependCount to prepend the FCR's ASN toward an IPv4 BGP peer. A value of 0 disables AS Path Prepend.
inboundMED	no	integer	1	1 - 4294967295	The MED value that an AS receives from a neighboring AS and uses to make routing decisions for traffic coming from that AS. It helps the receiving AS choose the preferred path for incoming traffic.
outboundMED	no	integer	1	1 - 4294967295	The MED value that an AS sets and advertises to neighboring AS's to suggest a preferred path for traffic destined to that AS. It helps in influencing the routing decisions of the neighboring AS for traffic going towards the advertising AS.
bgpIpv6
customerPeerIp	yes	string	2001:db8:c59b::1	IPv6 address.	Customer side BGP peering IPv6 address. Applicable to BGP type routing protocol instances.
enabled	no	boolean	true		Whether bgpIpv6 peering should be enabled or not. True=enabled
outboundASPrependCount	no	integer	1	0,1,3,5	We use outboundASPrependCount to prepend the FCR's ASN toward an IPv6 BGP peer. A value of 0 disables AS Path Prepend.
inboundMED	no	integer	1	1 - 4294967295	The MED value that an AS receives from a neighboring AS and uses to make routing decisions for traffic coming from that AS. It helps the receiving AS choose the preferred path for incoming traffic.
outboundMED	no	integer	1	1 - 4294967295	The MED value that an AS sets and advertises to neighboring AS's to suggest a preferred path for traffic destined to that AS. It helps in influencing the routing decisions of the neighboring AS for traffic going towards the advertising AS.
bfd
enabled	no	boolean	true	true false Default: false	Parameter showing whether bidirectional failure detection (BFD) is enabled. Applicable to BGP type routing protocol instances.
interval	no	integer	100	Minimum: 100 Maximum: 1000	Bidirectional failure detection (BFD) keep-alive interval (ms). Applicable to BGP type routing protocol instances.

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric portal access.

Sample response - direct routing instance

{
    "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": {
        "createdDateTime": "2021-07-15T19:30:29.526Z"
    },
    "type": "DIRECT",
    "directIpv4": {
        "equinixIfaceIp": "192.168.100.1/30"
    },
    "directIpv6": {
        "equinixIfaceIp": "2001:7a9::34f4:0:f3dd:1/126"
    }
}

Sample response - BGP

{
    "pagination": {
        "offset": 0,
        "limit": 1,
        "total": 1
    },
    "data": [
        {
            "type": "BGP",
            "bgpIpv4": {
                "customerPeerIp": "192.68.100.2",
                "enabled": true,
                "outboundASPrependCount": 0,
                "operation": {
                    "operationalStatus": "UNKNOWN"
                }
            },
        "bgpIpv6": {
                "customerPeerIp": "2001:7a9::34f4:0:f3dd:1/126",
                "enabled": true,
                "outboundASPrependCount": 0,
                "operation": {
                    "operationalStatus": "UNKNOWN"
                }
            },
            "customerAsn": 20034,
            "bgpAuthKey": "",
            "bfd": {
                "enabled": false,
                "interval": ""
            },
            "href": "http://clouduatapi.equinix.com/fabric/v4/connections/638601e6-929a-46c2-85ca-967a742f51f5/routingProtocols/ad5ae215-6f50-40d1-91db-0afb6537301b",
            "uuid": "ad5ae215-6f50-40d1-91db-0afb6537301b",
            "state": "PROVISIONING",
            "change": {
                "uuid": "5c4efb71-b0ff-40fb-97a6-02faa7d8d4a2",
                "type": "ROUTING_PROTOCOL_CREATION",
                "href": "http://clouduatapi.equinix.com/fabric/v4/connections/638601e6-929a-46c2-85ca-967a742f51f5/routingProtocols/ad5ae215-6f50-40d1-91db-0afb6537301b/changes/5c4efb71-b0ff-40fb-97a6-02faa7d8d4a2"
            },
            "changelog": {
                "createdBy": "jaguser1",
                "createdByEmail": "jaguser1@equinix.com",
                "createdDateTime": "2024-04-24T19:48:30.095Z",
                "updatedBy": "jaguser1",
                "updatedByEmail": "jaguser1@equinix.com",
                "updatedDateTime": "2024-04-24T19:48:30.095Z"
            }
        }
    ]
}

Response payload body description

Parameter	Type	Example values	Description
href	string	https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4/routingProtocols/55cbab42-7e8e-11ec-90d6-0242ac120003	An absolute URL that returns complete specification for the given routing protocol definition.
uuid	string	55cbab42-7e8e-11ec-90d6-0242ac120003	Equinix-assigned routing protocol definition identifier.
state	string	PROVISIONING	Entity lifecycle status.
change	object	-	Details of the latest change.
changeLog	object	-	A permanent record of asset creation, modification, or deletion.
type	string	BGP	Routing protocol type.
name	string	My-BGP-route-1	Routing protocol definition name.
bgpIpv4	object	-	IPv4 addressing configuration.
bgpIpv6	object	-	IPv6 addressing configuration.
asOverrideEnabled	boolean	true	Defines the optional AS override policy (defaults to false/off). The policy is applied to one or more IPv4 and/or IPv6 peering sessions as an outbound route map.
customerAsn	integer	65002	Customer's autonomous system number (ASN).
equinixAsn	integer	65003	Equinix's autonomous system number (ASN).
bgpAuthKey	string	a667d47acc18ea6b	Border gateway protocol authentication key for authenticating point-to-point TCP connections between peering routers.
bfd	object	-	Bidirectional failure detection (BFD) configuration settings applicable to Fabric Cloud Router connections.
change
uuid	string	75cbab42-7e8e-11ec-90d6-0242ac12879	Unique Id of the latest configuration.
href	string	https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170	Link to the latest configuration.
type	string	ROUTING_PROTOCOL_CREATION	Type of change, whether CREATION, UPDATE, or DELETION.
bgpIpv4
customerPeerIp	string	10.1.1.2	Customer side BGP peering IPv4 address.
equinixPeerIp	string	10.1.1.3	Equinix side BGP peering IPv4 address.
enabled	boolean	true	Whether bgpIpv4 peering is enabled or not. True=enabled
outboundASPrependCount	integer	1	The number of times FCR's ASN is prepended toward an IPv4 BGP peer.
inboundMED	integer	1	The MED value that an AS receives from a neighboring AS and uses to make routing decisions for traffic coming from that AS. It helps the receiving AS choose the preferred path for incoming traffic.
outboundMED	integer	1	The MED value that an AS sets and advertises to neighboring AS's to suggest a preferred path for traffic destined to that AS. It helps in influencing the routing decisions of the neighboring AS for traffic going towards the advertising AS.
bgpIpv6
customerPeerIp	string	2001:db8:c59b::1	Customer side BGP peering IPv6 address.
equinixPeerIp	string	2001:db8:c59b::1	Equinix side BGP peering IPv6 address.
enabled	boolean	true	Whether bgpIpv6 peering is enabled or not. True=enabled
outboundASPrependCount	integer	1	The number of times FCR's ASN is prepended toward an IPv6 BGP peer.
inboundMED	integer	1	The MED value that an AS receives from a neighboring AS and uses to make routing decisions for traffic coming from that AS. It helps the receiving AS choose the preferred path for incoming traffic.
outboundMED	integer	1	The MED value that an AS sets and advertises to neighboring AS's to suggest a preferred path for traffic destined to that AS. It helps in influencing the routing decisions of the neighboring AS for traffic going towards the advertising AS.
bfd
enabled	boolean	true	Parameter showing whether bidirectional failure detection (BFD) is enabled.
interval	string	100	Bidirectional failure detection (BFD) keep-alive interval (ms).
changeLog
createdDateTime	string	2021-07-15T19:30:29.526Z	Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
updatedDateTime	string	2022-01-24T10:28:51.024Z	Asset modification timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000

Create Routing Protocol Instances

	POST /fabric/v4/connections/{connectionUuid}/routingProtocols/bulk
Method	POST
URL or Endpoint	/fabric/v4/connections/{connectionUuid}/routingProtocols/bulk
Headers	Authorization, Content-Type
Path Parameters	connectionUuid
Query Parameters	Not applicable
Body Parameters	type, name, directIpv4, directIpv6, bgpIpv4, bgpIpv6, asOverrideEnabled, customerAsn, equinixAsn, bgpAuthKey, bfd

This API request adds routing protocol definitions to a given connection.

Sample curl request - direct routing instance

curl -X
POST 'https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4/routingProtocols/bulk'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "data": [
        {
            "type": "DIRECT",
            "name": "My-Direct-route-1",
            "directIpv4": {
                "equinixIfaceIp": "192.168.100.1/30"
            },
            "directIpv6": {
                "equinixIfaceIp": "2001:7a9::34f4:0:f3dd:1/126"
            }
        }
    ]
}' 

Sample curl request - BGP routing protocol instance

curl -X
POST 'https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4/routingProtocols/bulk'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "data": [
        {
            "type": "BGP",
            "bgpIpv4": {
                "customerPeerIp": "10.1.1.2",
                "enabled": true,
                "outboundASPrependCount": 1
            },
            "bgpIpv6": {
                "customerPeerIp": "2001:db8:c59b::1",
                "enabled": true,
                "outboundASPrependCount": 1
            },
            "customerAsn": 65002,
            "bgpAuthKey": "string",
            "bfd": {
                "enabled": true,
                "interval": 100
            }
        }
    ]
}' 

Sample curl request - direct routing and BGP routing protocol instances

curl -X
POST 'https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4/routingProtocols/bulk'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "data": [
        {
            "type": "BGP",
            "bgpIpv4": {
                "customerPeerIp": "10.1.1.2",
                "enabled": true,
                "outboundASPrependCount": 1

            },
            "bgpIpv6": {
                "customerPeerIp": "2001:db8:c59b::1",
                "enabled": true,
                "outboundASPrependCount": 1
            },
            "customerAsn": 65002,
            "bgpAuthKey": "string",
            "bfd": {
                "enabled": true,
                "interval": 100
            }
        },
        {
            "type": "BGP",
            "bgpIpv4": {
                "customerPeerIp": "10.1.1.2",
                "outboundASPrependCount": 1
            },
            "bgpIpv6": {
                "customerPeerIp": "2001:db8:c59b::1",
                "outboundASPrependCount": 1
            },
            "customerAsn": 65002,
            "bgpAuthKey": "string",
            "bfd": {
                "enabled": true,
                "interval": 100
            }
        }
    ]
}' 

Path parameters

Field Name	Mandatory	Type	Example Values	Applicable Values	Description
connectionUuid	yes	string	557400f8-d360-11e9-bb65-2a2ae2dbcce4	Use the Retrieve Connections API request to retrieve the list of connections.	Equinix-assigned connection identifier.

Body Parameters

Parameter	Mandatory	Type	Example Values	Applicable Values	Description
data	yes	array[object]	-	-	Data array containing search results.
data
type	yes	string	BGP	BGP DIRECT	Routing protocol type. BGP - Border gateway protocol defining peering between routers on customer and Equinix side. DIRECT - Direct connection specification.
name	no	string	My-BGP-route-1	-	Routing protocol definition name.
directIpv4	yes	object	-	-	Direct routing related IPv4 addressing configuration.
directIpv6	yes	object	-	-	Direct routing related IPv6 addressing configuration.
asOverrideEnabled	no	boolean	true	true, false	Defines the optional AS override policy (defaults to false/off). The policy is applied to one or more IPv4 and/or IPv6 peering sessions as an outbound route map.
directIpv4
equinixIfaceIp	yes	string	192.168.100.1/30	IPv4 address in CIDR notation.	Networking interface IPv4 address on Equinix side. Applicable to DIRECT type routing protocol instances.
directIpv6
equinixIfaceIp	yes	string	2001:7a9::34f4:0:f3dd:1/126	IPv6 address in CIDR notation.	Networking interface IPv6 address on Equinix side. Applicable to DIRECT type routing protocol instances.
bgpIpv4	no	object	-	-	BGP related IPv4 addressing configuration.
bgpIpv6	no	object	-	-	BGP related IPv6 addressing configuration for BGP type routing protocol instances.
customerAsn	yes	integer	65002	Minimum: 1 Maximum: 4294967294 Exclusions: IANA special Purpose: 0, 112, 23456, 64000 - 64495, 64496- 64511, 65535, 65536 - 65551, 4294967295 Equinix reserved: 64600, 4200000000 - 42000000002	Customer's autonomous system number (ASN). Applicable to BGP type routing protocol instances.
bgpAuthKey	no	string	a667d47acc18ea6b	Maximum: 80 characters	Border gateway protocol authentication key for authenticating point-to-point TCP connections between peering routers. Applicable to BGP type routing protocol instances.
bfd	no	object	-	-	Bidirectional failure detection (BFD) configuration settings applicable to Fabric Cloud Router connections. Applicable to BGP type routing protocol instances.
bgpIpv4
customerPeerIp	yes	string	10.1.1.2	IPv4 address.	Customer side BGP peering IPv4 address. Applicable to BGP type routing protocol instances.
enabled	no	boolean	true		Whether bgpIpv4 peering should be enabled or not. True=enabled
outboundASPrependCount	no	integer	1	0,1,3,5	We use outboundASPrependCount to prepend the FCR's ASN toward an IPv4 BGP peer. A value of 0 disables AS Path Prepend.
inboundMED	no	integer	1	1 - 4294967295	The MED value that an AS receives from a neighboring AS and uses to make routing decisions for traffic coming from that AS. It helps the receiving AS choose the preferred path for incoming traffic.
outboundMED	no	integer	1	1 - 4294967295	The MED value that an AS sets and advertises to neighboring AS's to suggest a preferred path for traffic destined to that AS. It helps in influencing the routing decisions of the neighboring AS for traffic going towards the advertising AS.
bgpIpv6
customerPeerIp	yes	string	2001:db8:c59b::1	IPv6 address.	Customer side BGP peering IPv6 address. Applicable to BGP type routing protocol instances.
enabled	no	boolean	true		Whether bgpIpv6 peering should be enabled or not. True=enabled
outboundASPrependCount	no	integer	1	0,1,3,5	We use outboundASPrependCount to prepend the FCR's ASN toward an IPv6 BGP peer. A value of 0 disables AS Path Prepend.
inboundMED	no	integer	1	1 - 4294967295	The MED value that an AS receives from a neighboring AS and uses to make routing decisions for traffic coming from that AS. It helps the receiving AS choose the preferred path for incoming traffic.
outboundMED	no	integer	1	1 - 4294967295	The MED value that an AS sets and advertises to neighboring AS's to suggest a preferred path for traffic destined to that AS. It helps in influencing the routing decisions of the neighboring AS for traffic going towards the advertising AS.
bfd
enabled	no	boolean	true	true false Default: false	Parameter showing whether bidirectional failure detection (BFD) is enabled. Applicable to BGP type routing protocol instances.
interval	no	integer	100	Minimum: 100 Maximum: 1000	Bidirectional failure detection (BFD) keep-alive interval (ms). Applicable to BGP type routing protocol instances.

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric portal access.

Sample response - direct routing instance

[
    {
        "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": {
            "createdDateTime": "2021-07-15T19:30:29.526Z"
        },
        "type": "DIRECT",
        "directIpv4": {
            "equinixIfaceIp": "192.168.100.1/30"
        },
        "directIpv6": {
            "equinixIfaceIp": "2001:7a9::34f4:0:f3dd:1/126"
        }
    }
]

Sample response - BGP

{
    "pagination": {
        "offset": 0,
        "limit": 1,
        "total": 1
    },
    "data": [
        {
            "type": "BGP",
            "bgpIpv4": {
                "customerPeerIp": "192.68.100.2",
                "enabled": true,
                "outboundASPrependCount": 0,
                "operation": {
                    "operationalStatus": "UNKNOWN"
                }
            },
        "bgpIpv6": {
                "customerPeerIp": "2001:7a9::34f4:0:f3dd:1/126",
                "enabled": true,
                "outboundASPrependCount": 0,
                "operation": {
                    "operationalStatus": "UNKNOWN"
                }
            },
            "customerAsn": 20034,
            "bgpAuthKey": "",
            "bfd": {
                "enabled": false,
                "interval": ""
            },
            "href": "http://clouduatapi.equinix.com/fabric/v4/connections/638601e6-929a-46c2-85ca-967a742f51f5/routingProtocols/ad5ae215-6f50-40d1-91db-0afb6537301b",
            "uuid": "ad5ae215-6f50-40d1-91db-0afb6537301b",
            "state": "PROVISIONING",
            "change": {
                "uuid": "5c4efb71-b0ff-40fb-97a6-02faa7d8d4a2",
                "type": "ROUTING_PROTOCOL_CREATION",
                "href": "http://clouduatapi.equinix.com/fabric/v4/connections/638601e6-929a-46c2-85ca-967a742f51f5/routingProtocols/ad5ae215-6f50-40d1-91db-0afb6537301b/changes/5c4efb71-b0ff-40fb-97a6-02faa7d8d4a2"
            },
            "changelog": {
                "createdBy": "jaguser1",
                "createdByEmail": "jaguser1@equinix.com",
                "createdDateTime": "2024-04-24T19:48:30.095Z",
                "updatedBy": "jaguser1",
                "updatedByEmail": "jaguser1@equinix.com",
                "updatedDateTime": "2024-04-24T19:48:30.095Z"
            }
        }
    ]
}

Response payload body description

Parameter	Type	Example values	Description
data	array[object]	-	Data array containing search results.
data
href	string	https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4/routingProtocols/55cbab42-7e8e-11ec-90d6-0242ac120003	An absolute URL that returns complete specification for the given routing protocol definition.
uuid	string	55cbab42-7e8e-11ec-90d6-0242ac120003	Equinix-assigned routing protocol definition identifier.
state	string	PROVISIONING	Entity lifecycle status.
change	object	-	Details of the latest change.
changeLog	object	-	A permanent record of asset creation, modification, or deletion.
type	string	BGP	Routing protocol type.
name	string	My-BGP-route-1	Routing protocol definition name.
bgpIpv4	object	-	IPv4 addressing configuration.
bgpIpv6	object	-	IPv6 addressing configuration.
asOverrideEnabled	boolean	true	Defines the optional AS override policy (defaults to false/off). The policy is applied to one or more IPv4 and/or IPv6 peering sessions as an outbound route map.
customerAsn	integer	65002	Customer's autonomous system number (ASN).
equinixAsn	integer	65003	Equinix's autonomous system number (ASN).
bgpAuthKey	string	a667d47acc18ea6b	Border gateway protocol authentication key for authenticating point-to-point TCP connections between peering routers.
bfd	object	-	Bidirectional failure detection (BFD) configuration settings applicable to Fabric Cloud Router connections.
change
uuid	string	75cbab42-7e8e-11ec-90d6-0242ac12879	Unique Id of the latest configuration.
href	string	https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170	Link to the latest configuration.
type	string	ROUTING_PROTOCOL_CREATION	Type of change, whether CREATION, UPDATE, or DELETION.
bgpIpv4
customerPeerIp	string	10.1.1.2	Customer side BGP peering IPv4 address.
enabled	boolean	true	Whether bgpIpv4 peering is enabled or not. True=enabled
equinixPeerIp	string	10.1.1.3	Equinix side BGP peering IPv4 address.
outboundASPrependCount	integer	1	The number of times FCR's ASN is prepended toward an IPv4 BGP peer.
inboundMED	integer	1	The MED value that an AS receives from a neighboring AS and uses to make routing decisions for traffic coming from that AS. It helps the receiving AS choose the preferred path for incoming traffic.
outboundMED	integer	1	The MED value that an AS sets and advertises to neighboring AS's to suggest a preferred path for traffic destined to that AS. It helps in influencing the routing decisions of the neighboring AS for traffic going towards the advertising AS.
bgpIpv6
customerPeerIp	string	2001:db8:c59b::1	Customer side BGP peering IPv6 address.
enabled	boolean	true	Whether bgpIpv6 peering is enabled or not. True=enabled
equinixPeerIp	string	2001:db8:c59b::1	Equinix side BGP peering IPv6 address.
outboundASPrependCount	integer	1	The number of times FCR's ASN is prepended toward an IPv6 BGP peer.
inboundMED	integer	1	The MED value that an AS receives from a neighboring AS and uses to make routing decisions for traffic coming from that AS. It helps the receiving AS choose the preferred path for incoming traffic.
outboundMED	integer	1	The MED value that an AS sets and advertises to neighboring AS's to suggest a preferred path for traffic destined to that AS. It helps in influencing the routing decisions of the neighboring AS for traffic going towards the advertising AS.
bfd
enabled	boolean	true	Parameter showing whether bidirectional failure detection (BFD) is enabled.
interval	string	100	Bidirectional failure detection (BFD) keep-alive interval (ms).
changeLog
createdDateTime	string	2021-07-15T19:30:29.526Z	Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
updatedDateTime	string	2022-01-24T10:28:51.024Z	Asset modification timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000

Get Specified Routing Protocol Instance

	GET /fabric/v4/connections/{connectionUuid}/routingProtocols/{routingProtocolUuid}
Method	GET
URL or Endpoint	/fabric/v4/connections/{connectionUuid}/routingProtocols/{routingProtocolUuid}
Headers	Authorization, Content-Type
Path Parameters	connectionUuid, routingProtocolUuid
Query Parameters	Not applicable
Body Parameters	Not applicable

This API request retrieves details of a specified routing protocol definition associated with a given connection.

Sample cURL request

curl -X
GET 'https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4/routingProtocols/55cbab42-7e8e-11ec-90d6-0242ac120003'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI' 

Path parameters

Field Name	Mandatory	Type	Example Values	Applicable Values	Description
connectionUuid	yes	string	557400f8-d360-11e9-bb65-2a2ae2dbcce4	Use the Retrieve Connections API request to retrieve the list of connections.	Equinix-assigned connection identifier.
routingProtocolUuid	yes	string	557400f8-d360-11e9-bb65-2a2ae2dbcce4	Use the Get All Routing Protocol Instances API request to retrieve the list of routing protocols associated with a given connection.	Equinix-assigned routing protocol definition identifier.

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric portal access.

Sample response - BGP routing protocol instance

{
    "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": {
        "createdDateTime": "2022-01-26T07:42:52.199Z",
        "updatedDateTime": "2022-01-26T07:42:52.199Z"
    },
    "type": "BGP",
    "bgpIpv4": {
        "customerPeerIp": "10.1.1.2",
        "equinixPeerIp": "192.168.100.1",
        "enabled": true,
        "outboundASPrependCount": 1,
        "operation": {
            "operationalStatus": "UNKNOWN"
        }
    },
    "bgpIpv6": {
        "customerPeerIp": "2001:db8:c59b::1",
        "equinixPeerIp": "2001:db8:c59b::1",
        "enabled": true,
        "outboundASPrependCount": 1,
        "operation": {
            "operationalStatus": "UNKNOWN"
        }
    },
    "customerAsn": 0,
    "equinixAsn": 0,
    "bgpAuthKey": "a667d47acc18ea6b",
    "bfd": {
        "enabled": true,
        "interval": 100
    }
}

Sample response - direct routing protocol instance

{
    "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": {
        "createdDateTime": "2021-07-15T19:30:29.526Z"
    },
    "type": "DIRECT",
    "directIpv4": {
        "equinixIfaceIp": "192.168.100.1/30"
    },
    "directIpv6": {
        "equinixIfaceIp": "2001:7a9::34f4:0:f3dd:1/126"
    }
}

Response payload body description

Parameter	Type	Example values	Description
href	string	https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4/routingProtocols/55cbab42-7e8e-11ec-90d6-0242ac120003	An absolute URL that returns complete specification for the given routing protocol definition.
uuid	string	55cbab42-7e8e-11ec-90d6-0242ac120003	Equinix-assigned routing protocol definition identifier.
state	string	PROVISIONED	Entity lifecycle status.
change	object	-	Details of the latest change.
changelog	object	-	A permanent record of asset creation, modification, or deletion.
type	string	BGP	Routing protocol type.
name	string	My-BGP-route-1	Routing protocol definition name.
bgpIpv4	object	-	BGP routing IPv4 addressing configuration.
bgpIpv6	object	-	BGP routing IPv6 addressing configuration.
asOverrideEnabled	boolean	true	Defines the optional AS override policy (defaults to false/off). The policy is applied to one or more IPv4 and/or IPv6 peering sessions as an outbound route map.
operation	object	-	BGP operational state.
directIpv4	object	-	Direct routing IPv4 addressing configuration.
directIpv6	object	-	Direct routing IPv6 addressing configuration.
customerAsn	integer	65002	Customer's autonomous system number (ASN).
equinixAsn	integer	65003	Equinix's autonomous system number (ASN).
bgpAuthKey	string	a667d47acc18ea6b	Border gateway protocol authentication key for authenticating point-to-point TCP connections between peering routers.
bfd	object	-	Bidirectional failure detection (BFD) configuration settings applicable to Fabric Cloud Router connections.
change
uuid	string	75cbab42-7e8e-11ec-90d6-0242ac12879	Unique Id of the latest configuration.
href	string	https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170	Link to the latest configuration.
type	string	ROUTING_PROTOCOL_CREATION	Type of change, whether CREATION, UPDATE, or DELETION.
bgpIpv4
customerPeerIp	string	10.1.1.2	Customer side BGP peering IPv4 address.
equinixPeerIp	string	10.1.1.3	Equinix side BGP peering IPv4 address.
enabled	boolean	true	Whether bgpIpv4 peering is enabled or not. True=enabled
outboundASPrependCount	integer	1	The number of times FCR's ASN is prepended toward an IPv4 BGP peer.
inboundMED	integer	1	The MED value that an AS receives from a neighboring AS and uses to make routing decisions for traffic coming from that AS. It helps the receiving AS choose the preferred path for incoming traffic.
outboundMED	integer	1	The MED value that an AS sets and advertises to neighboring AS's to suggest a preferred path for traffic destined to that AS. It helps in influencing the routing decisions of the neighboring AS for traffic going towards the advertising AS.
operation
operationalStatus	string	UP	BGP operational state. UP, DOWN, or UNKNOWN.
opStatusChangedAt	string	2020-05-21T10:30:00Z	When the bgpIpv4 operational status changed last.
bgpIpv6
customerPeerIp	string	2001:db8:c59b::1	Customer side BGP peering IPv6 address.
equinixPeerIp	string	2001:db8:c59b::1	Equinix side BGP peering IPv6 address.
enabled	boolean	true	Whether bgpIpv6 peering is enabled or not. True=enabled
outboundASPrependCount	integer	1	The number of times FCR's ASN is prepended toward an IPv6 BGP peer.
inboundMED	integer	1	The MED value that an AS receives from a neighboring AS and uses to make routing decisions for traffic coming from that AS. It helps the receiving AS choose the preferred path for incoming traffic.
outboundMED	integer	1	The MED value that an AS sets and advertises to neighboring AS's to suggest a preferred path for traffic destined to that AS. It helps in influencing the routing decisions of the neighboring AS for traffic going towards the advertising AS.
operation
operationalStatus	string	UP	BGP operational state. UP, DOWN, or UNKNOWN.
opStatusChangedAt	string	2020-05-21T10:30:00Z	When the bgpIpv6 operational status changed last.
bfd
enabled	boolean	true	Parameter showing whether bidirectional failure detection (BFD) is enabled.
interval	string	100	Bidirectional failure detection (BFD) keep-alive interval (ms).
directIpv4
equinixIfaceIp	string	192.168.100.1/30	Networking interface IPv4 address on Equinix side.
directIpv6
equinixIfaceIp	string	2001:7a9::34f4:0:f3dd:1/126	Networking interface IPv6 address on Equinix side.
changeLog
createdDateTime	string	2021-07-15T19:30:29.526Z	Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
updatedDateTime	string	2022-01-24T10:28:51.024Z	Asset modification timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000

Get All Routing Protocol Instances

	GET /fabric/v4/connections/{connectionUuid}/routingProtocols
Method	GET
URL or Endpoint	/fabric/v4/connections/{connectionUuid}/routingProtocols
Headers	Authorization, Content-Type
Path Parameters	connectionUuid
Query Parameters	Not applicable
Body Parameters	Not applicable

This API request retrieves routing protocol definitions associated with a specified connection.

Sample curl request

curl -X
GET 'https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4/routingProtocols'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI' 

Path parameters

Field Name	Mandatory	Type	Example Values	Applicable Values	Description
connectionUuid	yes	string	557400f8-d360-11e9-bb65-2a2ae2dbcce4	Use the Retrieve Connections API request to retrieve the list of connections.	Equinix-assigned connection identifier.

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric portal access.

Sample response

{
  "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": {
        "createdDateTime": "2022-01-26T07:42:52.199Z",
        "updatedDateTime": "2022-01-26T07:42:52.199Z"
    },
    "type": "BGP",
    "bgpIpv4": {
      "customerPeerIp": "10.1.1.2",
      "equinixPeerIp": "192.168.100.1",
      "enabled": true,
      "outboundASPrependCount": 1,
      "operation": {
          "operationalStatus": "UNKNOWN"
      }
    },
    "bgpIpv6": {
      "customerPeerIp": "2001:db8:c59b::1",
      "equinixPeerIp": "2001:db8:c59b::1",
      "enabled": true,
      "outboundASPrependCount": 1,
      "operation": {
          "operationalStatus": "UNKNOWN"
      }
    },
    "customerAsn": 0,
    "equinixAsn": 0,
    "bgpAuthKey": "string",
    "bfd": {
      "enabled": true,
      "interval": 100
    }
  },
  {
    "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": {
        "createdDateTime": "2022-01-26T07:42:52.199Z",
        "updatedDateTime": "2022-01-26T07:42:52.199Z"
    },
    "type": "DIRECT",
    "directIpv4": {
      "equinixIfaceIp": "192.168.100.1/30"
    },
    "directIpv6": {
      "equinixIfaceIp": "2001:7a9::34f4:0:f3dd:1/126"
    }
  }
]
}

Response payload body description

Parameter	Type	Example values	Description
pagination	object	-	Search results pagination settings.
pagination
offset	integer	0	Index of the first item returned in the response.
limit	integer	20	Maximum number of items returned per page.
total	integer	99	Total number of items available.
data	array[object]	-	Data array containing search results.
data
href	string	https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4/routingProtocols/55cbab42-7e8e-11ec-90d6-0242ac120003	An absolute URL that returns complete specification for the given routing protocol definition.
uuid	string	55cbab42-7e8e-11ec-90d6-0242ac120003	Equinix-assigned routing protocol definition identifier.
state	string	PROVISIONED	Entity lifecycle status.
change	object	-	Details of the latest change.
changelog	object	-	A permanent record of asset creation, modification, or deletion.
type	string	BGP	Routing protocol type.
name	string	My-BGP-route-1	Routing protocol definition name.
bgpIpv4	object	-	BGP routing IPv4 addressing configuration.
bgpIpv6	object	-	BGP routing IPv6 addressing configuration.
operation	object	-	BGP operational state.
directIpv4	object	-	Direct routing IPv4 addressing configuration.
directIpv6	object	-	Direct routing IPv6 addressing configuration.
asOverrideEnabled	boolean	true	Defines the optional AS override policy (defaults to false/off). The policy is applied to one or more IPv4 and/or IPv6 peering sessions as an outbound route map.
customerAsn	integer	65002	Customer's autonomous system number (ASN).
equinixAsn	integer	65003	Equinix's autonomous system number (ASN).
bgpAuthKey	string	a667d47acc18ea6b	Border gateway protocol authentication key for authenticating point-to-point TCP connections between peering routers.
bfd	object	-	Bidirectional failure detection (BFD) configuration settings applicable to Fabric Cloud Router connections.
change
uuid	string	75cbab42-7e8e-11ec-90d6-0242ac12879	Unique Id of the latest configuration.
href	string	https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170	Link to the latest configuration.
type	string	ROUTING_PROTOCOL_CREATION	Type of change, whether CREATION, UPDATE, or DELETION.
bgpIpv4
customerPeerIp	string	10.1.1.2	Customer side BGP peering IPv4 address.
equinixPeerIp	string	10.1.1.3	Equinix side BGP peering IPv4 address.
enabled	boolean	true	Whether bgpIpv4 peering is enabled or not. True=enabled
outboundASPrependCount	integer	1	The number of times FCR's ASN is prepended toward an IPv4 BGP peer.
inboundMED	integer	1	The MED value that an AS receives from a neighboring AS and uses to make routing decisions for traffic coming from that AS. It helps the receiving AS choose the preferred path for incoming traffic.
outboundMED	integer	1	The MED value that an AS sets and advertises to neighboring AS's to suggest a preferred path for traffic destined to that AS. It helps in influencing the routing decisions of the neighboring AS for traffic going towards the advertising AS.
operation
operationalStatus	string	UP	BGP connection status. UP, DOWN, or UNKNOWN.
opStatusChangedAt	string	2020-05-21T10:30:00Z	When the BGP operational status changed last.
bgpIpv6
customerPeerIp	string	2001:db8:c59b::1	Customer side BGP peering IPv6 address.
equinixPeerIp	string	2001:db8:c59b::1	Equinix side BGP peering IPv6 address.
enabled	boolean	true	Whether bgpIpv6 peering is enabled or not. True=enabled
outboundASPrependCount	integer	1	The number of times FCR's ASN is prepended toward an IPv6 BGP peer.
inboundMED	integer	1	The MED value that an AS receives from a neighboring AS and uses to make routing decisions for traffic coming from that AS. It helps the receiving AS choose the preferred path for incoming traffic.
outboundMED	integer	1	The MED value that an AS sets and advertises to neighboring AS's to suggest a preferred path for traffic destined to that AS. It helps in influencing the routing decisions of the neighboring AS for traffic going towards the advertising AS.
operation
operationalStatus	string	UP	BGP connection status. UP, DOWN, or UNKNOWN.
opStatusChangedAt	string	2020-05-21T10:30:00Z	When the BGP operational status changed last.
bfd
enabled	boolean	true	Parameter showing whether bidirectional failure detection (BFD) is enabled.
interval	string	100	Bidirectional failure detection (BFD) keep-alive interval (ms).
directIpv4
equinixIfaceIp	string	192.168.100.1/30	Networking interface IPv4 address on Equinix side.
directIpv6
equinixIfaceIp	string	2001:7a9::34f4:0:f3dd:1/126	Networking interface IPv6 address on Equinix side.
changeLog
createdDateTime	string	2021-07-15T19:30:29.526Z	Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
updatedDateTime	string	2022-01-24T10:28:51.024Z	Asset modification timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000

Replace Routing Protocol Instance

	PUT /fabric/v4/connections/{connectionUuid}/routingProtocols/{routingProtocolUuid}
Method	PUT
URL or Endpoint	/fabric/v4/connections/{connectionUuid}/routingProtocols/{routingProtocolUuid}
Headers	Authorization, Content-Type
Path Parameters	connectionUuid, routingProtocolUuid
Query Parameters	Not applicable
Body Parameters	type, name, directIpv4, directIpv6, bgpIpv4, bgpIpv6, asOverrideEnabled, customerAsn, bgpAuthKey, bfd

This API request replaces a specified routing protocol definition associated with a given connection.

Sample curl request - DIRECT

curl -X
PUT 'https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4/routingProtocols/c9b8e7a2-f3b1-4576-a4a9-1366a63df170'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "type": "DIRECT",
    "name": "My-updated-DIRECT-route",
    "directIpv4": {
        "equinixIfaceIp": "192.168.100.1/30"
    },
    "directIpv6": {
        "equinixIfaceIp": "2001:7a9::34f4:0:f3dd:1/126"
    }
}'

Sample curl request - BGP

curl -X
PUT 'https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4/routingProtocols/c9b8e7a2-f3b1-4576-a4a9-1366a63df170'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '
{
    "type": "BGP",
    "bgpIpv4": {
        "customerPeerIp": "10.13.13.2",
        "enabled": true,
        "outboundASPrependCount": 1
    },
    "bgpIpv6": {
        "customerPeerIp": "2001:7a9::1111:2",
        "enabled": true,
        "outboundASPrependCount": 3
    },
    "customerAsn": "1000"
}
'

Path parameters

Field Name	Mandatory	Type	Example Values	Applicable Values	Description
connectionUuid	yes	string	557400f8-d360-11e9-bb65-2a2ae2dbcce4	Use the Retrieve Connections API request to retrieve the list of connections.	Equinix-assigned connection identifier.
routingProtocolUuid	yes	string	557400f8-d360-11e9-bb65-2a2ae2dbcce4	Use the Get All Routing Protocol Instances API request to retrieve the list of routing protocols associated with a given connection.	Equinix-assigned routing protocol definition identifier.

Body parameters

Parameter	Mandatory	Type	Example Values	Applicable Values	Description
type	yes	string	BGP	BGP DIRECT	Routing protocol type. BGP - Border gateway protocol defining peering between routers on customer and Equinix side. DIRECT - Direct connection specification.
name	no	string	My-BGP-route-1	-	Routing protocol definition name.
directIpv4	yes	object	-	-	Direct routing related IPv4 addressing configuration.
directIpv6	yes	object	-	-	Direct routing related IPv6 addressing configuration.
asOverrideEnabled	no	boolean	true	true, false	Defines the optional AS override policy (defaults to false/off). The policy is applied to one or more IPv4 and/or IPv6 peering sessions as an outbound route map.
bgpIpv4	no	object	-	-	BGP related IPv4 addressing configuration.
bgpIpv6	no	object	-	-	BGP related IPv6 addressing configuration for BGP type routing protocol instances.
customerAsn	yes	integer	65002	Minimum: 1 Maximum: 4294967294 Exclusions: IANA special Purpose: 0, 112, 23456, 64000 - 64495, 64496- 64511, 65535, 65536 - 65551, 4294967295 Equinix reserved: 64600, 4200000000 - 42000000002	Customer's autonomous system number (ASN). Applicable to BGP type routing protocol instances.
bgpAuthKey	no	string	a667d47acc18ea6b	Maximum: 80 characters	Border gateway protocol authentication key for authenticating point-to-point TCP connections between peering routers. Applicable to BGP type routing protocol instances.
bfd	no	object	-	-	Bidirectional failure detection (BFD) configuration settings applicable to Fabric Cloud Router connections. Applicable to BGP type routing protocol instances.
directIpv4
equinixIfaceIp	yes	string	192.168.100.1/30	IPv4 address in CIDR notation.	Networking interface IPv4 address on Equinix side. Applicable to DIRECT type routing protocol instances.
directIpv6
equinixIfaceIp	yes	string	2001:7a9::34f4:0:f3dd:1/126	IPv6 address in CIDR notation.	Networking interface IPv6 address on Equinix side. Applicable to DIRECT type routing protocol instances.
bgpIpv4
customerPeerIp	yes	string	10.1.1.2	IPv4 address.	Customer side BGP peering IPv4 address. Applicable to BGP type routing protocol instances.
enabled	no	boolean	true		Whether bgpIpv4 peering should be enabled or not. True=enabled
outboundASPrependCount	no	integer	1	0,1,3,5	We use outboundASPrependCount to prepend the FCR's ASN toward an IPv4 BGP peer. A value of 0 disables AS Path Prepend.
inboundMED	no	integer	1	1 - 4294967295	The MED value that an AS receives from a neighboring AS and uses to make routing decisions for traffic coming from that AS. It helps the receiving AS choose the preferred path for incoming traffic.
outboundMED	no	integer	1	1 - 4294967295	The MED value that an AS sets and advertises to neighboring AS's to suggest a preferred path for traffic destined to that AS. It helps in influencing the routing decisions of the neighboring AS for traffic going towards the advertising AS.
bgpIpv6
customerPeerIp	yes	string	2001:db8:c59b::1	IPv6 address.	Customer side BGP peering IPv6 address. Applicable to BGP type routing protocol instances.
enabled	no	boolean	true		Whether bgpIpv6 peering should be enabled or not. True=enabled
outboundASPrependCount	no	integer	1	0,1,3,5	We use outboundASPrependCount to prepend the FCR's ASN toward an IPv6 BGP peer. A value of 0 disables AS Path Prepend.
inboundMED	no	integer	1	1 - 4294967295	The MED value that an AS receives from a neighboring AS and uses to make routing decisions for traffic coming from that AS. It helps the receiving AS choose the preferred path for incoming traffic.
outboundMED	no	integer	1	1 - 4294967295	The MED value that an AS sets and advertises to neighboring AS's to suggest a preferred path for traffic destined to that AS. It helps in influencing the routing decisions of the neighboring AS for traffic going towards the advertising AS.
bfd
enabled	no	boolean	true	true false Default: false	Parameter showing whether bidirectional failure detection (BFD) is enabled. Applicable to BGP type routing protocol instances.
interval	no	integer	100	Minimum: 100 Maximum: 1000	Bidirectional failure detection (BFD) keep-alive interval (ms). Applicable to BGP type routing protocol instances.

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric portal access.

Sample response - DIRECT

{
    "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": "abc@xyz.com",
        "createdByFullName": "abc",
        "createdByEmail": "abc@xyz.com",
        "createdDateTime": "2021-10-30T07:21:39Z",
        "updatedBy": "abc@xyz.com",
        "updatedByFullName": "abc",
        "updatedByEmail": "abc@xyz.com",
        "updatedDateTime": "2021-10-30T07:21:39Z"
    },
    "type": "DIRECT",
    "name": "My-updated-DIRECT-route",
    "directIpv4": {
        "equinixIfaceIp": "192.168.100.1/30"
    },
    "directIpv6": {
        "equinixIfaceIp": "2001:7a9::34f4:0:f3dd:1/126"
    }
}

Sample response - BGP

{
    "type": "BGP",
    "bgpIpv4": {
        "customerPeerIp": "192.68.100.2",
        "equinixPeerIp": "192.68.100.1",
        "enabled": true,
        "outboundASPrependCount": 1,
        "operation": {
            "operationalStatus": "UNKNOWN"
        }
    },
    "customerAsn": 20034,
    "bgpAuthKey": "",
    "bfd": {
        "enabled": false,
        "interval": ""
    },
    "href": "http://clouduatapi.equinix.com/fabric/v4/connections/638601e6-929a-46c2-85ca-967a742f51f5/routingProtocols/ad5ae215-6f50-40d1-91db-0afb6537301b",
    "uuid": "ad5ae215-6f50-40d1-91db-0afb6537301b",
    "state": "REPROVISIONING",
    "change": {
        "uuid": "51f86ed1-1348-47bf-bf79-a49498d3126e",
        "type": "ROUTING_PROTOCOL_UPDATE",
        "href": "http://clouduatapi.equinix.com/fabric/v4/connections/638601e6-929a-46c2-85ca-967a742f51f5/routingProtocols/ad5ae215-6f50-40d1-91db-0afb6537301b/changes/51f86ed1-1348-47bf-bf79-a49498d3126e"
    },
    "changelog": {
        "createdBy": "jaguser1",
        "createdByEmail": "jaguser1@equinix.com",
        "createdDateTime": "2024-04-24T19:48:30.095Z",
        "updatedBy": "jaguser1",
        "updatedByEmail": "jaguser1@equinix.com",
        "updatedDateTime": "2024-04-24T19:59:01.012757Z"
    }
}

Response payload body description

Parameter	Type	Example values	Description
href	string	https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4/routingProtocols/55cbab42-7e8e-11ec-90d6-0242ac120003	An absolute URL that returns complete specification for the given routing protocol definition.
uuid	string	3c9b8e7a2-f3b1-4576-a4a9-1366a63df170	Routing protocol definition identifier.
state	string	REPROVISIONING	Entity lifecycle status.
change	object	-	Routing protocol change request definition.
changelog	object	-	A permanent record of asset creation, modification, or deletion.
type	string	DIRECT	Routing protocol type.
name	string	My-direct-route-1	Routing protocol definition name.
directIpv4	object	-	Direct routing related IPv4 addressing configuration.
directIpv6	object	-	Direct routing related IPv6 addressing configuration.
asOverrideEnabled	boolean	true	Defines the optional AS override policy (defaults to false/off). The policy is applied to one or more IPv4 and/or IPv6 peering sessions as an outbound route map.
change
uuid	string	3c9b8e7a2-f3b1-4576-a4a9-1366a63df170	Routing protocol change request identifier.
href	string	https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170	An absolute URL that returns complete specification for the given routing protocol definition change request.
type	string	ROUTING_PROTOCOL_UPDATE	Routing protocol definition change request type.
directIpv4
equinixIfaceIp	string	192.168.100.1/30	Networking interface IPv4 address on Equinix side. Applicable to DIRECT type routing protocol instances.
directIpv6
equinixIfaceIp	string	2001:7a9::34f4:0:f3dd:1/126	Networking interface IPv6 address on Equinix side. Applicable to DIRECT type routing protocol instances.

Update Routing Protocol

	PATCH /fabric/v4/connections/{connectionUuid}/routingProtocols/{routingProtocolUuid}
Method	PATCH
URL or Endpoint	/fabric/v4/connections/{connectionUuid}/routingProtocols/{routingProtocolUuid}
Headers	Authorization, Content-Type
Path Parameters	connectionUuid, routingProtocolUuid
Query Parameters	Not applicable
Body Parameters	op, path, value

This API enables or disables bgpIpv4 and bgpIpv6 protocols.

Sample curl request

curl -X
PATCH 'https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4/routingProtocols/c9b8e7a2-f3b1-4576-a4a9-1366a63df170'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    [
        {
            "op": "replace",
            "path": "/bgpIpv6/enabled",
            "value": false
        }
    ]

}'

Path parameters

Field Name	Mandatory	Type	Example Values	Applicable Values	Description
connectionUuid	yes	string	557400f8-d360-11e9-bb65-2a2ae2dbcce4	Use the Retrieve Connections API request to retrieve the list of connections.	Equinix-assigned connection identifier.
routingProtocolUuid	yes	string	557400f8-d360-11e9-bb65-2a2ae2dbcce4	Use the Get All Routing Protocol Instances API request to retrieve the list of routing protocols associated with a given connection.	Equinix-assigned routing protocol definition identifier.

Body parameters

Parameter	Mandatory	Type	Example Values	Applicable Values	Description
op	yes	string	replace	replace	Operation to perform. As of now, we only support "replace."
path	yes	string	/bgpIpv6/enabled	/bgpIpv6/enabled, /bgpIpv4/enabled	Specify the parameter you want to update. As of now, we only support bgpIpv4 and bgpIpv6
value	yes	boolean	true	true, false	The new value of the parameter.

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric portal access.

Sample response

{
  "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": "abc@xyz.com",
    "createdByFullName": "abc",
    "createdByEmail": "abc@xyz.com",
    "createdDateTime": "2021-10-30T07:21:39Z",
    "updatedBy": "abc@xyz.com",
    "updatedByFullName": "abc",
    "updatedByEmail": "abc@xyz.com",
    "updatedDateTime": "2021-10-30T07:21:39Z"
  },
  "type": "BGP",
  "bgpIpv4": {
    "enabled": true,
    "customerPeerIp": "10.1.1.3",
    "outboundASPrependCount": 1
  },
  "customerAsn": 10000,
  "equinixAsn": 10001
}

Response payload body description

Parameter	Type	Example values	Description
href	string	https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4/routingProtocols/55cbab42-7e8e-11ec-90d6-0242ac120003	An absolute URL that returns complete specification for the given routing protocol definition.
uuid	string	3c9b8e7a2-f3b1-4576-a4a9-1366a63df170	Routing protocol definition identifier.
state	string	REPROVISIONING	Entity lifecycle status.
change	object	-	Routing protocol change request definition.
changelog	object	-	A permanent record of asset creation, modification, or deletion.
type	string	BGP	Routing protocol type.
customerAsn	number	10000	Customer Asn.
equinixAsn	number	10001	Equinix Asn.
bgpIpv4	object	-	Direct routing related bgpIpv4 addressing configuration.
bgpIpv6	object	-	Direct routing related bgpIpv6 addressing configuration.
change
uuid	string	3c9b8e7a2-f3b1-4576-a4a9-1366a63df170	Routing protocol change request identifier.
href	string	https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170	An absolute URL that returns complete specification for the given routing protocol definition change request.
type	string	ROUTING_PROTOCOL_UPDATE	Routing protocol definition change request type.
changeLog
createdBy	string	abc@xyz.com	Created by.
createdByFullName	string	abc ram	Full name of the creator.
createdByEmail	string	abc@xyz.com	Email of the creator.
createdDateTime	string	"2021-10-30T07:21:39Z"	Time of creation.
updatedBy	string	abc@xyz.com	Updated by.
updatedByFullName	string	abc ram	Full name of the updator.
updatedByEmail	string	abc@xyz.com	Email of the updator.
updatedDateTime	string	"2021-10-30T07:21:39Z"	Time of update.
bgpIpv4
customerPeerIp	string	10.1.1.3	Customer side BGP peering Ipv4 address.
enabled	boolean	true	Whether bgpIpv4 peering is enabled or not. True=enabled.
outboundASPrependCount	integer	1	The number of times FCR's ASN is prepended toward an IPv4 BGP peer.
bgpIpv6
customerPeerIp	string	2001:7a9:34f4:1	Customer side BGP peering Ipv6 address.
enabled	boolean	true	Whether bgpIpv6 peering is enabled or not. True=enabled.
outboundASPrependCount	integer	1	The number of times FCR's ASN is prepended toward an IPv6 BGP peer.

Get All Routing Protocol Change Requests

	GET /fabric/v4/connections/{connectionUuid}/routingProtocols/{routingProtocolUuid}/changes
Method	GET
URL or Endpoint	/fabric/v4/connections/{connectionUuid}/routingProtocols/{routingProtocolUuid}/changes
Headers	Authorization, Content-Type
Path Parameters	connectionUuid, routingProtocolUuid
Query Parameters	Not applicable
Body Parameters	Not applicable

This API request returns all change requests associated with a given routing protocol definition.

Sample curl request

curl -X
GET 'https://api.equinix.com/fabric/v4/connections/2a4fb415-5a7f-436f-bae6-02f5e403deec/routingProtocols/2a4fb415-5a7f-436f-bae6-02f5e403deec/changes'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Field Name	Mandatory	Type	Example Values	Applicable Values	Description
connectionUuid	yes	string	557400f8-d360-11e9-bb65-2a2ae2dbcce4	Use the Retrieve Connections API request to retrieve the list of connections and then use the Get All Routing Protocol Instances to get the list of routing protocol definitions for a given connection.	Equinix-assigned connection identifier.
routingProtocolUuid	yes	string	557400f8-d360-11e9-bb65-2a2ae2dbcce4	Use the Get All Routing Protocol Instances API request to retrieve the list of routing protocols associated with a given connection.	Equinix-assigned routing protocol definition identifier.

Sample response

{
    "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": {
                        "customerPeerIp": "10.1.1.2",
                        "equinixPeerIp": "10.1.1.3",
                        "enabled": true,
                        "outboundASPrependCount": 1
                    },
                    "bgpIpv6": {
                        "customerPeerIp": "2001:db8:c59b::2",
                        "equinixPeerIp": "2001:db8:c59b::1",
                        "enabled": true,
                        "outboundASPrependCount": 1
                    },
                    "customerAsn": 0,
                    "equinixAsn": 0,
                    "bgpAuthKey": "string",
                    "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": {
                        "customerPeerIp": "10.1.1.3",
                        "equinixPeerIp": "10.1.1.4",
                        "enabled": true,
                        "outboundASPrependCount": 1
                    },
                    "bgpIpv6": {
                        "customerPeerIp": "2001:db8:c59b::2",
                        "equinixPeerIp": "2001:db8:c59b::1",
                        "enabled": true,
                        "outboundASPrependCount": 1
                    },
                    "customerAsn": 0,
                    "equinixAsn": 0,
                    "bgpAuthKey": "string",
                    "bfd": {
                        "enabled": true,
                        "interval": "100"
                    }
                }
            }
        }
    ]
}

Response payload body description

Parameter	Type	Example values	Description
pagination	object	-	Search results pagination settings.
data	array[object]	-	Data array containing returned objects.
pagination
offset	integer	0	Index of the first item returned in the response.
limit	integer	20	Maximum number of items returned per page.
total	integer	99	Total number of items available.
data
href	string	https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4/routingProtocols/55cbab42-7e8e-11ec-90d6-0242ac120003	An absolute URL that returns complete specification for the given routing protocol definition.
type	string	ROUTING_PROTOCOL_UPDATE	Routing protocol change request type.
uuid	string	3c9b8e7a2-f3b1-4576-a4a9-1366a63df170	Routing protocol change request identifier.
status	string	COMPLETED	Routing protocol change request status.
createdDateTime	string	2020-05-21T10:30:00Z	Routing protocol change request creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
updatedDateTime	string	2020-05-21T10:30:00Z	Routing protocol change request update timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
data	object	-	Routing protocol change request information.
data.data
op	string	replace	Change request operation.
path	string	/	Parameter path.
value	object	-	Parameter value.
data.data.value
type	string	BGP	Routing protocol type.
name	string	My-BGP-route-1	Routing protocol definition name.
bgpIpv4	object	-	IPv4 addressing configuration.
bgpIpv6	object	-	IPv6 addressing configuration.
customerAsn	integer	65002	Customer's autonomous system number (ASN).
equinixAsn	integer	65003	Equinix's autonomous system number (ASN).
bgpAuthKey	string	a667d47acc18ea6b	Border gateway protocol authentication key for authenticating point-to-point TCP connections between peering routers.
bfd	object	-	Bidirectional failure detection (BFD) configuration settings applicable to Fabric Cloud Router connections.
data.data.value.bgpIpv4
customerPeerIp	string	10.1.1.2	Customer side BGP peering IPv4 address.
equinixPeerIp	string	10.1.1.3	Equinix side BGP peering IPv4 address.
enabled	boolean	true	Whether bgpIpv4 peering is enabled or not. True=enabled
outboundASPrependCount	integer	1	The number of times FCR's ASN is prepended toward an IPv4 BGP peer.
data.data.value.bgpIpv6
customerPeerIp	string	2001:db8:c59b::2	Customer side BGP peering IPv6 address.
equinixPeerIp	string	2001:db8:c59b::1	Equinix side BGP peering IPv6 address.
enabled	boolean	true	Whether bgpIpv6 peering is enabled or not. True=enabled
outboundASPrependCount	integer	1	The number of times FCR's ASN is prepended toward an IPv6 BGP peer.
data.data.value.bfd
enabled	boolean	true	Parameter showing whether bidirectional failure detection (BFD) is enabled.
interval	string	100	Bidirectional failure detection (BFD) keep-alive interval (ms).

Get Specified Routing Protocol Change Request

	GET /fabric/v4/connections/{connectionUuid}/routingProtocols/{routingProtocolUuid}/changes/{changeRequestUuid}
Method	GET
URL or Endpoint	/fabric/v4/connections/{connectionUuid}/routingProtocols/{routingProtocolUuid}/changes/{changeRequestUuid}
Headers	Authorization, Content-Type
Path Parameters	connectionUuid, routingProtocolUuid, changeRequestUuid
Query Parameters	Not applicable
Body Parameters	Not applicable

This API request returns the details of a specified routing protocol change request.

Sample curl request

curl -X
GET 'https://api.equinix.com/fabric/v4/connections/2a4fb415-5a7f-436f-bae6-02f5e403deec/routingProtocols/2a4fb415-5a7f-436f-bae6-02f5e403deec/changes/4b17da68-3d6b-436d-9c8f-2105f3b950d9'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Field Name	Mandatory	Type	Example Values	Applicable Values	Description
connectionUuid	yes	string	557400f8-d360-11e9-bb65-2a2ae2dbcce4	Use the Retrieve Connections API request to retrieve the list of connections and then use the Get All Routing Protocol Instances to get the list of routing protocol definitions for a given connection.	Equinix-assigned connection identifier.
routingProtocolUuid	yes	string	557400f8-d360-11e9-bb65-2a2ae2dbcce4	Use the Get All Routing Protocol Instances API request to retrieve the list of routing protocols associated with a given connection.	Equinix-assigned routing protocol definition identifier.
changeRequestUuid	yes	string	557400f8-d360-11e9-bb65-2a2ae2dbcce4	Use the Get All Routing Protocol Change Requests API request to retrieve the list of change request for a given routing protocol definition.	Equinix-assigned routing protocol definition identifier.

Sample response

{
    "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": {
                "customerPeerIp": "10.1.1.2",
                "equinixPeerIp": "10.1.1.3",
                "enabled": true,
                "outboundASPrependCount": 1
            },
            "bgpIpv6": {
                "customerPeerIp": "2001:db8:c59b::2",
                "equinixPeerIp": "2001:db8:c59b::1",
                "enabled": true,
                "outboundASPrependCount": 1
            },
            "customerAsn": 0,
            "equinixAsn": 0,
            "bgpAuthKey": "string",
            "bfd": {
                "enabled": true,
                "interval": "100"
            }
        }
    }
}

Response payload body description

Parameter	Type	Example values	Description
href	string	https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4/routingProtocols/55cbab42-7e8e-11ec-90d6-0242ac120003/change/4b17da68-3d6b-436d-9c8f-2105f3b950d9	An absolute URL that returns complete specification for the given routing protocol definition.
type	string	ROUTING_PROTOCOL_UPDATE	Routing protocol change request type.
uuid	string	4b17da68-3d6b-436d-9c8f-2105f3b950d9	Routing protocol change request identifier.
status	string	COMPLETED	Routing protocol change request status.
createdDateTime	string	2020-05-21T10:30:00Z	Routing protocol change request creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
updatedDateTime	string	2020-05-21T10:30:00Z	Routing protocol change request update timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
data	object	-	Routing protocol change request information.
data
op	string	replace	Change request operation.
path	string	/	Parameter path.
value	object	-	Parameter value.
data.value
type	string	BGP	Routing protocol type.
name	string	My-BGP-route-1	Routing protocol definition name.
bgpIpv4	object	-	IPv4 addressing configuration.
bgpIpv6	object	-	IPv6 addressing configuration.
customerAsn	integer	65002	Customer's autonomous system number (ASN).
equinixAsn	integer	65003	Equinix's autonomous system number (ASN).
bgpAuthKey	string	a667d47acc18ea6b	Border gateway protocol authentication key for authenticating point-to-point TCP connections between peering routers.
bfd	object	-	Bidirectional failure detection (BFD) configuration settings applicable to Fabric Cloud Router connections.
data.value.bgpIpv4
customerPeerIp	string	10.1.1.2	Customer side BGP peering IPv4 address.
equinixPeerIp	string	10.1.1.3	Equinix side BGP peering IPv4 address.
enabled	boolean	true	Whether bgpIpv4 peering is enabled or not. True=enabled
outboundASPrependCount	integer	1	The number of times FCR's ASN is prepended toward an IPv4 BGP peer.
data.value.bgpIpv6
customerPeerIp	string	2001:db8:c59b::2	Customer side BGP peering IPv6 address.
equinixPeerIp	string	2001:db8:c59b::1	Equinix side BGP peering IPv6 address.
enabled	boolean	true	Whether bgpIpv6 peering is enabled or not. True=enabled
outboundASPrependCount	integer	1	The number of times FCR's ASN is prepended toward an IPv6 BGP peer.
data.value.bfd
enabled	boolean	true	Parameter showing whether bidirectional failure detection (BFD) is enabled.
interval	string	100	Bidirectional failure detection (BFD) keep-alive interval (ms).

Clear or Reset BGP

	POST /fabric/v4/connections/{connectionUuid}/routingProtocols/{routingProtocolId}/actions
Method	POST
URL or Endpoint	/fabric/v4/connections/{connectionUuid}/routingProtocols/{routingProtocolId}/actions
Headers	Authorization, Content-Type
Path Parameters	connectionUuid, routingProtocolId
Query Parameters	Not applicable
Body Parameters	type

Clears or resets the BGP session of a routing protocol

Sample curl request

curl -X
POST 'https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4/routingProtocols/657400f8-d360-11e9-bb65-2a2ae2dbccr5/actions'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "type": "CLEAR_BGPIPV4"
    }'

Path parameters

Parameter	Mandatory	Type	Example Values	Applicable Values	Description
connectionUuid	yes	string	557400f8-d360-11e9-bb65-2a2ae2dbcce4	Use the Retrieve Connections API request to get your list of connections.	Equinix-assigned connection identifier.
routingProtocolId	yes	string	657400f8-d360-11e9-bb65-2a2ae2dbcce5		Equinix-assigned routing-protocol identifier.

Body Parameters

Parameter	Mandatory	Type	Example Values	Description
type	yes	string	CLEAR_BGPIPV4	Possible values: CLEAR_BGPIPV4: soft clear bgp ipv4 session CLEAR_BGPIPV6:soft clear bgp ipv6 session CLEAR_BGPIPV4_INBOUND:soft clear bgp ipv4 session, inbound only CLEAR_BGPIPV6_INBOUND: soft clear bgp ipv6 session, inbound only RESET_BGPIPV4: hard clear bgp ipv4 session RESET_BGPIPV6: hard clear bgp ipv6 session

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric portal access.

Sample response

{
  "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_BGPIPV6",
  "description": "hard reset bgp ipv6 session",
  "state": "PENDING",
  "changeLog": {
    "createdBy": "adminuser",
    "createdByEmail": "adminuser@equinix.com",
    "createdByFullName": "adminuser adminuser",
    "createdDateTime": "2020-05-21T10:30:00Z"
  }
}

Response payload body description

Parameter	Type	Example values	Description
href	string	https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/3f5ed98a-8dba-4651-a317-8ad0234dd157/actions/123ed98a-92ba-9951-bb17-17d0234dd096	URL of the asset.
uuid	string	55cbab42-7e8e-11ec-90d6-0242ac120003	Equinix-assigned action Id.
type	string	RESET_BGPIPV6	Type of reset.
description	string	hard reset bgp ipv6 session	Description of the reset.
state	string	PENDING	State of the reset.
changeLog	object	-	A permanent record of asset creation, modification, or deletion.
changeLog
createdBy	string	admin	Created by.
createdByEmail	string	testuser@equinix.com	Created by email.
createdByFullName	string	testuser testuser	Full name of creator.
createdDateTime	string	2021-07-15T19:30:29.526Z	Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
updatedBy	string	admin	Updated by.
updatedByEmail	string	testuser@equinix.com	Updated by email.
updatedByFullName	string	testuser testuser	Updated by full name.
updatedDateTime	string	2021-07-15T19:30:29.526Z	Asset update timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000

Get BGP Actions

	GET /fabric/v4/connections/{connectionUuid}/routingProtocols/{routingProtocolId}/actions
Method	GET
URL or Endpoint	/fabric/v4/connections/{connectionUuid}/routingProtocols/{routingProtocolId}/actions
Headers	Authorization, Content-Type
Path Parameters	connectionUuid, routingProtocolId
Query Parameters	offset, limit
Body Parameters	Not applicable

Returns BGP actions.

Sample curl request

curl -X
GET 'https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/actions'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI' 

Query parameters

Parameter	Description
offset `integer` OPTIONAL	Index of the first item returned in the response. Minimum: 0 Default value: 0
limit `integer` OPTIONAL	Maximum number of items returned per page. Minimum: 1 Maximum: 100 Default value: 20

Path parameters

Field Name	Mandatory	Type	Example Values	Applicable Values	Description
connectionUuid	yes	string	557400f8-d360-11e9-bb65-2a2ae2dbcce4	Use the Retrieve Connections API request to get your list of connections.	Equinix-assigned connection identifier.
routingProtocolId	yes	string	667400f8-d360-11e9-bb65-2a2ae2dbcce8		Equinix-assigned routing-protocol identifier.

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric portal access.

Sample response

{
  "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",
        "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: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",
        "createdByEmail": "testuser@equinix.com",
        "createdByFullName": "testuser testuser",
        "createdDateTime": "2020-05-21T10:20:00Z",
        "updatedBy": "testuser",
        "updatedByEmail": "testuser@equinix.com",
        "updatedByFullName": "testuser testuser",
        "updatedDateTime": "2020-05-21T10:25:00Z"
      }
    }
  ]
}

Response description

Parameter	Type	Example values	Description
pagination	object	-	Search results pagination settings.
data	array[object]	-	Data array containing returned objects.
pagination
offset	integer	0	Index of the first item returned in the response.
limit	integer	20	Maximum number of items returned per page.
total	integer	99	Total number of items available.
data
href	string	https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/3f5ed98a-8dba-4651-a317-8ad0234dd157/actions/123ed98a-92ba-9951-bb17-17d0234dd096	URL of the asset.
uuid	string	55cbab42-7e8e-11ec-90d6-0242ac120003	Equinix-assigned action Id.
type	string	RESET_BGPIPV6	Type of reset.
description	string	hard reset bgp ipv6 session	Description of the reset.
state	string	PENDING	State of the reset.
changeLog	object	-	A permanent record of asset creation, modification, or deletion.
changeLog
createdBy	string	admin	Created by.
createdByEmail	string	testuser@equinix.com	Created by email.
createdByFullName	string	testuser testuser	Full name of creator.
createdDateTime	string	2021-07-15T19:30:29.526Z	Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
updatedBy	string	admin	Updated by.
updatedByEmail	string	testuser@equinix.com	Updated by email.
updatedByFullName	string	testuser testuser	Updated by full name.
updatedDateTime	string	2021-07-15T19:30:29.526Z	Asset update timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000

Get Specified BGP Action

	GET /fabric/v4/connections/{connectionUuid}/routingProtocols/{routingProtocolId}/actions/{actionId}
Method	GET
URL or Endpoint	/fabric/v4/connections/{connectionUuid}/routingProtocols/{routingProtocolId}/actions/{actionId}
Headers	Authorization, Content-Type
Path Parameters	connectionUuid, routingProtocolId, actionId
Query Parameters	Not applicable
Body Parameters	Not applicable

Returns BGP action for a specific Id.

Sample curl request

curl -X
GET 'https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/actions/857400f8-d360-11e9-bb65-2a2ae2dbcce5'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI' 

Path parameters

Field Name	Mandatory	Type	Example Values	Applicable Values	Description
connectionUuid	yes	string	557400f8-d360-11e9-bb65-2a2ae2dbcce4	Use the Retrieve Connections API request to get your list of connections.	Equinix-assigned connection identifier.
routingProtocolId	yes	string	667400f8-d360-11e9-bb65-2a2ae2dbcce8		Equinix-assigned routing-protocol identifier.
actionId	yes	string	347400f8-d360-11e9-bb65-2a2ae2dbcce9		Equinix-assigned action identifier.

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric portal access.

Sample response

{
  
      "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",
        "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:35:00Z"
    
}

Response description

Parameter	Type	Example values	Description
href	string	https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/3f5ed98a-8dba-4651-a317-8ad0234dd157/actions/123ed98a-92ba-9951-bb17-17d0234dd096	URL of the asset.
uuid	string	55cbab42-7e8e-11ec-90d6-0242ac120003	Equinix-assigned action Id.
type	string	RESET_BGPIPV6	Type of reset.
description	string	hard reset bgp ipv6 session	Description of the reset.
state	string	PENDING	State of the reset.
changeLog	object	-	A permanent record of asset creation, modification, or deletion.
changeLog
createdBy	string	admin	Created by.
createdByEmail	string	testuser@equinix.com	Created by email.
createdByFullName	string	testuser testuser	Full name of creator.
createdDateTime	string	2021-07-15T19:30:29.526Z	Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
updatedBy	string	admin	Updated by.
updatedByEmail	string	testuser@equinix.com	Updated by email.
updatedByFullName	string	testuser testuser	Updated by full name.
updatedDateTime	string	2021-07-15T19:30:29.526Z	Asset update timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000

Delete Routing Protocol Instance

	DELETE /fabric/v4/connections/{connectionUuid}/routingProtocols/{routingProtocolUuid}
Method	DELETE
URL or Endpoint	/fabric/v4/connections/{connectionUuid/routingProtocols/{routingProtocolUuid}
Headers	Authorization, Content-Type
Path Parameters	connectionUuid, routingProtocolUuid
Query Parameters	Not applicable
Body Parameters	Not applicable

This API request deletes a specified routing protocol definition associated with a given connection.

Sample curl request

curl -X
DELETE 'https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4/routingProtocols/c9b8e7a2-f3b1-4576-a4a9-1366a63df170'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI' 

Path parameters

Field Name	Mandatory	Type	Example Values	Applicable Values	Description
connectionUuid	yes	string	557400f8-d360-11e9-bb65-2a2ae2dbcce4	Use the Retrieve Connections API request to retrieve the list of connections.	Equinix-assigned connection identifier.
routingProtocolUuid	yes	string	557400f8-d360-11e9-bb65-2a2ae2dbcce4	Use the Get All Routing Protocol Instances API request to retrieve the list of routing protocols associated with a given connection.	Equinix-assigned routing protocol definition identifier.

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric portal access.

Sample response

{
    "type": "BGP",
    "name": "My-BGP-route-1",
    "bgpIpv4": {
        "customerPeerIp": "10.1.1.2",
        "equinixPeerIp": "10.1.1.3",
        "outboundASPrependCount": 1
    },
    "bgpIpv6": {
        "customerPeerIp": "2001:db8:c59b::1",
        "equinixPeerIp": "2001:db8:c59b::1",
        "outboundASPrependCount": 1
    },
    "customerAsn": 65002,
    "equinixAsn": 65002,
    "bgpAuthKey": "a667d47acc18ea6b",
    "bfd": {
        "enabled": true,
        "interval": "100"
    },
    "href": "string",
    "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_CREATION"
    },
    "changelog": {
        "createdDateTime": "2022-01-26T07:42:52.199Z",
        "updatedDateTime": "2022-01-26T07:42:52.199Z"
    }
}

Response payload body description

Parameter	Type	Example values	Description
type	string	BGP	Routing protocol type.
name	string	My-BGP-route-1	Routing protocol definition name.
bgpIpv4	object	-	IPv4 addressing configuration.
bgpIpv6	object	-	IPv6 addressing configuration.
customerAsn	integer	65002	Customer's autonomous system number (ASN).
equinixAsn	integer	65003	Equinix's autonomous system number (ASN).
bgpAuthKey	string	a667d47acc18ea6b	Border gateway protocol authentication key for authenticating point-to-point TCP connections between peering routers.
bfd	object	-	Bidirectional failure detection (BFD) configuration settings applicable to Fabric Cloud Router connections.
href	string	https://api.equinix.com/fabric/v4/connections/557400f8-d360-11e9-bb65-2a2ae2dbcce4/routingProtocols/55cbab42-7e8e-11ec-90d6-0242ac120003	An absolute URL that returns complete specification for the given routing protocol definition.
uuid	string	55cbab42-7e8e-11ec-90d6-0242ac120003	Equinix-assigned routing protocol definition identifier.
state	string	DEPROVISIONING	Entity lifecycle status.
change	object	-	Details of the latest change.
changelog	object	-	A permanent record of asset creation, modification, or deletion.
bgpIpv4
customerPeerIp	string	10.1.1.2	Customer side BGP peering IPv4 address.
equinixPeerIp	string	10.1.1.3	Equinix side BGP peering IPv4 address.
outboundASPrependCount	integer	1	The number of times FCR's ASN is prepended toward an IPv4 BGP peer.
bgpIpv6
customerPeerIp	string	2001:db8:c59b::1	Customer side BGP peering IPv6 address.
equinixPeerIp	string	2001:db8:c59b::1	Equinix side BGP peering IPv6 address.
outboundASPrependCount	integer	1	The number of times FCR's ASN is prepended toward an IPv6 BGP peer.
bfd
enabled	boolean	true	Parameter showing whether bidirectional failure detection (BFD) is enabled.
interval	string	100	Bidirectional failure detection (BFD) keep-alive interval (ms).
change
uuid	string	75cbab42-7e8e-11ec-90d6-0242ac12879	Unique Id of the latest configuration.
href	string	https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170	Link to the latest configuration.
type	string	ROUTING_PROTOCOL_CREATION	Type of change, whether CREATION, UPDATE, or DELETION.
changeLog
createdDateTime	string	2021-07-15T19:30:29.526Z	Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
updatedDateTime	string	2022-01-24T10:28:51.024Z	Asset modification timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000

Validate Subnet

	POST /fabric/v4/routers/{routerId}/validate
Method	POST
URL or Endpoint	/fabric/v4/routers/{routerId}/validate
Headers	Authorization, Content-Type
Path Parameters	routerId
Query Parameters	Not applicable
Body Parameters	filter

Validates all subnets associated with a connection in the given FCR.

For instructions on how to obtain an authorization token, refer to Requesting Access and Refresh Tokens.

Sample curl request

curl -X POST 'http://api.equinix.com/fabric/v4/routers/{routerId}/validate'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
  "filter": {
    "and": [
      {
        "property": "/directIpv4/equinixIfaceIp",
        "operator": "=",
        "values": [
          "10.1.1.1/30"
        ]
      },
      {
        "property": "/connection/uuid",
        "operator": "=",
        "values": [
          "a96f16d3-e504-44a7-a628-4916b5750008"
        ]
      }
    ]
  }
}'

Body parameters

Parameter	Description
filter `object` REQUIRED	Object containing subnets to validate.
and `array[object]` REQUIRED	Array of objects that have subnets and connection identifiers.
property `string` REQUIRED	Either Ipv4 subnet or Ipv6 subnet is required. Applicable values: /directIpv4/equinixIfaceIp /directIpv6/equinixIfaceIp /connection/uuid
operator `string` REQUIRED	Parameter operator. Applicable values: =
values `array[string]` REQUIRED	Subnet values or connection identifiers. Connection identifiers are not required. However, you must provide either an ipv4 or ipv6 subnet to validate. Example: 10.1.1.1/30

/directIpv4/equinixIfaceIp	Example: "property": "/directIpv4/equinixIfaceIp", "operator": "=", "values": [ "10.1.1.1/30" ]
operator `string`	Search field parameter operator. Applicable values: =
value `array[string]`	Ipv4 subnet value. Example: ["10.1.1.1/30"]

/directIpv6/equinixIfaceIp	Example: "property": "/directIpv6/equinixIfaceIp", "operator": "=", "values": [ "1202:ABCD::20:1::11/30" ]
operator `string`	Search field operator. Applicable values: =
value `array[string]`	Ipv6 subnet value. Example: ["1202:ABCD::20:1::11/30"]

/connection/uuid	Example: "property": "/connection/uuid", "operator": "=", "values": [ "a96f16d3-e504-44a7-a628-4916b5750008" ]
operator `string`	Search field parameter operator. Applicable values: =
value `array[string]`	Unique Id of connections. Example: ["a96f16d3-e504-44a7-a628-4916b5750008"]

Sample response - validate subnet

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

Response payload body description

Parameter	Description
additionalInfo `array[object]`	An array of key-value pair objects containing additional information.
key `string`	Key parameter. Example: message
value `string`	Validation message. Example: There is no overlapping or duplicate subnets in the same Fabric cloud router.

Service Profiles

Create Service Profile

	POST /fabric/v4/serviceProfiles
Method	POST
URL or Endpoint	/fabric/v4/serviceProfiles
Headers	authorization, content-type, ic-version
Path Parameters	Not applicable
Query Parameters	Not applicable
Body Parameters	type, name, description, notifications, visibility, allowedEmails, tags, accessPointTypeConfigs, customFields, marketingInfo, ports

This API request creates a service profile, which enables other Platform Equinix participants to connect and subscribe to your services.

Sample curl request

curl -X
POST 'https://api.equinix.com/fabric/v4/serviceProfiles'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-H 'content-type: application/json'
-H 'ic-version: v4.2'
-d '{
    "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,
            "allowBandwidthAutoApproval": false,
            "allowRemoteConnections": false,
            "connectionLabel": "Connection",
            "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
            ]
        }
    ]
}' 

Header parameters

Parameter	Mandatory	Data Type	Example Values	Applicable Values	Description
authorization	yes	string	Bearer qwErtY8zyW1abcdefGHI	-	API request authorization token.
content-type	yes	string	application/json	application/json	Specifies the resource media type.
ic-version	yes	string	v4.2	v4.2	API version specifier.

Body parameters

Parameter	Type	Mandatory	Example	Applicable values	Description
name	string	yes	A-to-Z	Maximum: 50 characters Allowed characters: alpha-numeric, hyphens ('-'), underscores ('_') and white spaces (' ').	Service profile name.
description	string	yes	A-to-Z services for your daily cloud needs. Han Solo approved.	Maximum: 375 characters	Service description.
type	string	yes	L2_PROFILE	L2_PROFILE L3_PROFILE	Service profile type. L2_PROFILE - layer 2 service profile for establishing connections in layer 2 of the OSI networking model. L3_PROFILE - layer 3 service profile for establishing connections in layer 2 of the OSI networking model.
notifications	object	no	-	-	Notification preferences and a list of recipients.
visibility	string	yes	PRIVATE	PRIVATE PUBLIC	Service profile visibility. PUBLIC - Public service profiles are listed on the Equinix Fabric portal allowing anyone to establish connections to advertised services. PRIVATE - Establishing a connection based on a private service profile requires provider's authorization.
allowedEmails	array[string]	no	["darth@vader.com","han@solo.com"]	-	Email addresses of users allowed to establish connections based on this service profile. Applicable to PRIVATE visibility service profiles.
tags	array[string]	no	SaaS	-	Labels identifying the type of the services advertised by given service profile.
ports	array[object]	no	-	-	Ports associated with the given service profile.
accessPointTypeConfigs	array[object]	yes	-	-	Available access points types.
customFields	array[object]	no	-	-	User-defined fields added to a service profile.
marketingInfo	object	no	-	-	Optional service profile branding, such as the customer's logo.

notifications
emails	array[string]	no	["l3qa1user1@equinix.com"]	-	List of receipients of a given type of notification.
type	string	no	BANDWIDTH_ALERT	BANDWIDTH_ALERT CONNECTION_APPROVAL PROFILE_LIFECYCLE	Notification type. BANDWIDTH_ALERT - Bandwidth alert threshold has been reached. CONNECTION_APPROVAL - Connection request awaiting approval. PROFILE_LIFECYCLE - Service profile lifecycle has changed.

ports
type	string	yes	XF_PORT	COLO VD	Port type.
uuid	string	yes	cecd1039-eadd-add3-31e0-387a5c00aeb9	-	Equinix-assigned port identifier.

accessPointTypeConfigs
type	string	no	COLO	COLO VD	Connection endpoint type. COLO - Colocation space in an IBX data center. VD - Network Edge virtual device.
connectionRedundancyRequired	boolean	no	false	-	Requirement to configure a redundant connection.
allowBandwidthAutoApproval	boolean	no	false	true false	Parameter indicating if bandwidth change requests are approved automatically.
allowRemoteConnections	boolean	no	true	true false	Authorization to establish connections from remote locations.
connectionLabel	string	no	Connection	-	An alternative term for connection in case it's different in your organization.
enableAutoGenerateServiceKey	boolean	no	false	true false	Applicable to Verizon Software Defined Interconnect service profile.
bandwidthAlertThreshold	integer	no	75	Maximum: 100	Send a bandwidth usage alert when the percentage value of the total bandwidth of the ports associated with the given service profile has been consumed by your subscribers.
allowCustomBandwidth	boolean	no	true	true false	Authorization to set a custom connection bandwidth.
apiConfig	object		-	-	API configuration settings and preferences.
authenticationKey	object	no	-	-	Authentication key configuration.
supportedBandwidths	array[integer]	no	[200,500,700,1000]	-	Allowed connection bandwidths (Mbps).

accessPointTypes.apiConfig
apiAvailable	boolean	no	false	true false	Authorization to establish connections with this service profile using API.
equinixManagedPort	boolean	no	false	true false	Setting indicating that the port is managed by Equinix.
equinixManagedVlan	boolean	no	false	true false	Setting indicating that the VLAN is managed by Equinix.
allowOverSubscription	boolean	no	false	true false	Allow services sales to exceed the available network bandwidth.
overSubscriptionLimit	integer	no	1	Minimum: 1 Maximum: 20	Port bandwidth multiplier that determines the total bandwidth that can be allocated to users creating connections to your services. For example, a 10 Gbps port combined with an overSubscriptionLimit parameter value of 10 allows your subscribers to create connections with a total bandwidth of 100 Gbps.
bandwidthFromApi	boolean	no	false	true false	Indicates if the connection bandwidth can be obtained directly from the cloud service provider.

accessPointTypeConfigs.authenticationKey
required	boolean	no	true	true false	Requirement to provide an authentication key.
label	string	no	Cloud Account ID	-	Name of the parameter that must be provided to authorize the connection.
description	string	no	XYZ	-	Description to help subscribers identify their authentication key.

customFields
label	string	yes	ASN	-	Label under which a custom parameter is presented on the Equnix Fabric portal or exposed through an API.
description	string	yes	Excluded ASNs: 0, 13884, 36351, 64512, 64513, 65100, 65201‍–‍65234, 65402‍–‍65433, 65500, and 4201065000‍–‍4201065999.	-	Custom parameter description.
required	boolean	no	true	true false	Indicates if a given custom field is mandatory.
dataType	string	yes	INTEGER	INTEGER STRING	Custom field data type. INTEGER - Integer. STRING - String.
captureInEmail	boolean	no	false	true false	Capture the input value and include it in the email notification.

marketingInfo
promotion	boolean	no	true	true false	Authorization to promote the given service profile on Equinix website and other products.
processSteps	array[object]	no	-	-	A data structure describing the steps necessary to establish connection to the given service provider.

marketingInfo.processSteps
title	string	no	Create Equinix Fabric Connection	-	Step title.
subTitle	string	no	on the Equinix Fabric	-	Step's subtitle.
description	string	no	Some very creative and descriptive description.	-	Details of the actions which must be taken to complete the given step.

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Sample response

{
    "state": "PENDING_APPROVAL",
    "account": {
        "orgId": 91785,
        "globalOrgId": "0016u000003JZ4tAAG"
    },
    "changeLog": {
        "createdDateTime": {}
    },
    "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"
            ]
        }
    ],
    "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,
            "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": {
                "href": "https://api.equinix.com/fabric/v4/metros/SY",
                "metroCode": "SY"
            }
        }
    ],
    "metros": [
        {
            "code": "SY",
            "ibxs": [
                "SY4"
            ]
        }
    ]
}

Response payload body description

Parameter	Type	Example	Description
state	string	PENDING_APPROVAL	Service profile lifecycle stage. ACTIVE - Service profile is active and enables establishing connections. DELETED - Service profile has been deleted. PENDING APPROVAL - Service profile awaiting administrator approval. REJECTED - Service profile has been rejected by the administrator.
account	object	-	Customer account information.
changeLog	object	-	A permanent record of asset creation, modification, or deletion.
href	string	https://api.equinix.com/fabric/v4/serviceProfiles/ 57186196-505d-4075-80f5-60e819e30310	An absolute URL that returns complete specification for the given entity.
uuid	string	57186196-505d-4075-80f5-60e819e30310	Equinix-assigned service profile identifier.
accessPointTypeConfigs	array[object]	-	Available access points types.
ports	array[object]	-	Ports associated with the given service profile.
metros	array[object]	-	Locations where subscribers can access services available through the given service profile.

account
orgId	string	92214	Equinix-assigned organization identifier.
organizationName	string	testBuyer-270001	Equinix-assigned organization name.
globalOrgId	string	0016C00000UlveoQAB	Equinix-assigned top-level organization identifier associated with the specified service profile.
globalOrganizationName	string	Cloud	Equinix-assigned top-level organization name associated with the specified service profile.

changeLog
createdDateTime	string	2022-01-04T13:31:31.814Z	Asset creation timestamp.

accessPointTypeConfigs
uuid	string	f20c49cd-b022-4aeb-b3e4-49db4389aff3	Equinix-assigned access point identifier.

ports
location	object	-	Attributes associated with the specified asset location.

ports.location
href	string	https://api.equinix.com/fabric/v4/metros/SY	An absolute URL that returns complete specification for the given entity.
metroCode	string	SY	Metropolitan area identifier.

metros
code	string	SV	Metropolitan area identifier.
name	string	Silicon Valley	Metropolitan area name.
ibxs	array[string]	["SV5","SV1"]	List of IBX data centers within the given metro where subscribers can access services provided by the given service profile.
displayName	string	Silicon Valley	Metropoiltan area name displayed on the service profile in the Equinix Fabric portal.

Get Service Profiles

	GET /fabric/v4/serviceProfiles
Method	GET
URL or Endpoint	/fabric/v4/serviceProfiles
Headers	authorization, ic-version
Path Parameters	Not applicable
Query Parameters	offset, limit, viewPoint, style
Body Parameters	Not applicable

This API request retrieves service profiles available on Equinix Platform. Service profiles define the services offered by service providers enabling other participants to find and connect to them.

Sample curl request

curl -X
GET 'https://api.equinix.com/fabric/v4/serviceProfiles'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-H 'ic-version: v4.2'

Header parameters

Parameter	Mandatory	Data Type	Example Values	Applicable Values	Description
authorization	yes	string	Bearer qwErtY8zyW1abcdefGHI	-	API request authorization token.
ic-version	yes	string	v4.2	v4.2	API version specifier.

Query parameters

Parameter	Mandatory	Type	Example	Applicable values	Description
offset	no	integer	2	Default: 0	Index of the first item returned in the response.
limit	no	integer	30	Default: 20	Maximum number of items returned per page, starting from the index denoted by the offset item.
viewPoint	no	string	aSide	aSide zSide Default: aSide	Returns service profile data set with parameters relevant to a buyer (aSide) or a seller (zSide).

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Sample response

{
    "data": [
        {
            "state": "ACTIVE",
            "account": {
                "organizationName": "l3-qa-1-270253"
            },
            "changeLog": {
                "createdBy": "l3qa1user1",
                "createdByFullName": "l3qa1user1 l3qa1user1",
                "createdByEmail": "l3qa1user1@equinix.com",
                "createdDateTime": {},
                "updatedBy": "eqx-admin",
                "updatedByFullName": "eqx-admin eqx-admin",
                "updatedByEmail": "eqx-admin@equinix.com",
                "updatedDateTime": {}
            },
            "href": "https://api.equinix.com/fabric/v4/serviceProfiles/c2ba267e-0168-4254-93a2-32487de4ed7c?viewPoint=aSide",
            "type": "L2_PROFILE",
            "name": "E2E-SPHL2Name-060422130614789",
            "uuid": "c2ba267e-0168-4254-93a2-32487de4ed7c",
            "description": "<p>E2E-This is SPH Description With <a href=\"https://qa3fabric.corp.equinix.com/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Hyperlink</a>-060422130617254</p>",
            "tags": [
                "SaaS",
                "IaaS"
            ],
            "visibility": "PUBLIC",
            "accessPointTypeConfigs": [
                {
                    "type": "COLO",
                    "uuid": "d68c95c1-f289-4b52-8aee-7f4e2660e070",
                    "supportedBandwidths": [
                        50,
                        200,
                        500,
                        1000
                    ],
                    "allowRemoteConnections": true,
                    "allowCustomBandwidth": false,
                    "allowBandwidthAutoApproval": false,
                    "linkProtocolConfig": {
                        "encapsulationStrategy": "CTAGED",
                        "reuseVlanSTag": false,
                        "encapsulation": "DOT1Q"
                    },
                    "enableAutoGenerateServiceKey": false,
                    "connectionRedundancyRequired": false,
                    "apiConfig": {
                        "apiAvailable": false,
                        "integrationId": "",
                        "bandwidthFromApi": false
                    },
                    "connectionLabel": "Connection",
                    "authenticationKey": {
                        "required": false
                    }
                }
            ],
            "marketingInfo": {
                "promotion": true
            },
            "metros": [
                {
                    "code": "DA",
                    "name": "Dallas",
                    "ibxs": [
                        "DA1"
                    ],
                    "displayName": "Dallas"
                }
            ],
            "selfProfile": false
        }
    ],
    "pagination": {
        "offset": 0,
        "limit": 1,
        "total": 52,
        "next": "/serviceProfiles?offset=1&limit=1"
    }
}

Response payload body description

Parameter	Type	Example	Description
data	object	-	Data array containing data model entities.
pagination	object	-	An absolute URL that returns the specified connection.

data
state	string	ACTIVE	Service profile lifecycle stage. ACTIVE - Service profile is active and enables establishing connections. DELETED - Service profile has been deleted. PENDING APPROVAL - Service profile awaiting administrator approval. REJECTED - Service profile has been rejected by the administrator.
account	object	-	Customer account information.
changeLog	object	-	A permanent record of asset creation, modification, or deletion.
href	string	https://api.equinix.com/fabric/v4/serviceProfiles/ 57186196-505d-4075-80f5-60e819e30310	An absolute URL that returns complete specification for the given entity.
type	string	L2_PROFILE	Service profile type. L2_PROFILE - layer 2 service profile for establishing connections in layer 2 of the OSI networking model. L3_PROFILE - layer 3 service profile for establishing connections in layer 2 of the OSI networking model.
name	string	E2E-SPHL2Name-040122133102496	Service profile name.
uuid	string	d48daade-4c18-446d-9c4d-92f6e2f93f55	Equinix-assigned service profile identifier.
description	string	E2E-This is SPH Description [...]	Service description.
notifications	object	-	Notification preferences and a list of recipients. Applicable for viewPoint query parameter set to zSide.
tags	array[string]	SaaS	Labels identifying the type of the services advertised by given service profile.
visibility	string	PRIVATE	Service profile visibility. PUBLIC - Public service profiles are listed on the Equinix Fabric portal allowing anyone to establish connections to advertised services. PRIVATE - Establishing a connection based on a private service profile requires provider's authorization.
allowedEmails	array[string]	["darth@vader.com","han@solo.com"]	Email addresses of users allowed to establish connections based on this service profile.
accessPointTypeConfigs	array[object]	-	Available access points types.
customFields	array[object]	-	User-defined fields added to a service profile.
marketingInfo	object	-	Optional service profile branding, such as the customer's logo.
ports	array[object]	-	Ports associated with the given service profile. Applicable for viewPoint query parameter set to zSide.
metros	array[object]	-	Locations where subscribers can access services available through the given service profile.
selfProfile	boolean	true	Indicates if the service profile and the user interacting with the API belong to the same organization. Applicable for viewPoint query parameter set to aSide.

data.account
orgId	string	92214	Equinix-assigned organization identifier. Applicable for viewPoint query parameter set to zSide.
organizationName	string	testBuyer-270001	Equinix-assigned organization name.
globalOrgId	string	0016C00000UlveoQAB	Equinix-assigned top-level organization identifier associated with the specified service profile.
globalOrganizationName	string	Cloud	Equinix-assigned top-level organization name associated with the specified service profile.

data.changeLog
createdBy	string	testBuyer999	Identity of the asset creator.
createdDateTime	string	2022-01-04T13:31:31.814Z	Asset creation timestamp.
updatedBy	string	eqx-admin999	Identity of the person who updated the asset.
updatedDateTime	string	2022-01-04T13:31:45.981Z	Asset update request timestamp.
createdByEmail	string	testBuyer999@equinix.com	Email address of the asset creator.
updatedByEmail	string	eqx-admin999@equinix.com	Email address of the person who updated the asset.
createdByFullName	string	testBuyer999 testBuyer999	First and last name of the asset creator.
updatedByFullName	string	eqx-admin999 eqx-admin999	First and last name of the person who updated the asset.

data.notifications
emails	array[string]	["l3qa1user1@equinix.com"]	List of receipients of a given type of notification.
type	string	BANDWIDTH_ALERT	Notification type. BANDWIDTH_ALERT - Bandwidth alert threshold has been reached. CONNECTION_APPROVAL - Connection request awaiting approval. PROFILE_LIFECYCLE - Service profile lifecycle has changed.

data.accessPointTypeConfigs
type	string	COLO	Access point type. COLO - Colocation space in an IBX data center. VD - Network Edge virtual device.
uuid	string	f1d3b691-09cb-4570-8567-137ce1ca6328	Equinix-assigned access point identifier.
supportedBandwidths	array[integer]	[200,500,700,1000]	Allowed connection bandwidths (Mbps).
allowRemoteConnections	boolean	true	Authorization to establish connections from remote locations.
allowCustomBandwidth	boolean	true	Authorization to set a custom connection bandwidth.
bandwidthAlertThreshold	integer	75	Send a bandwidth usage alert when the percentage value of the total bandwidth of the ports associated with the given service profile has been consumed by your subscribers. Applicable for viewPoint query parameter set to zSide.
allowBandwidthAutoApproval	boolean	false	Parameter indicating if bandwidth change requests are approved automatically.
linkProtocolConfig	object	-	Settings and preferences for the link protocol used at the access point.
enableAutoGenerateServiceKey	boolean	false	Applicable to Verizon Software Defined Interconnect service profile.
connectionRedundancyRequired	boolean	false	Indicates if connecting to the service requires creating a pair of redundant connections.
apiConfig	object	-	API configuration settings and preferences.
connectionLabel	string	Connection	An alternative term for connection in case it's different in your organization.
authenticationKey	object	-	Authentication key configuration.
metadata	object	-	Additional connection information.

data.accessPointTypeConfigs.linkProtocolConfig
encapsulationStrategy	string	CTAGED	Additional tagging information required by the seller profile.
reuseVlanSTag	boolean	false	Automatically accept subsequent DOT1Q to QINQ connections that use the same authentication key. These connections will have the same VLAN S-tag assigned as the initial connection.
encapsulation	string	DOT1Q	Data frames encapsulation standard. UNTAGGED - Untagged encapsulation for EPL connections. DOT1Q - DOT1Q encapsulation standard. QINQ - QINQ encapsulation standard.

data.accessPointTypeConfigs.apiConfig
apiAvailable	boolean	false	Indicates if it's possible to establish connections based on the given service profile using the Equinix Fabric API.
integrationId	string	AWS-DirectConnect-01	A unique identifier issued during onboarding and used to integrate the customer's service profile with the Equinix Fabric API.
equinixManagedPort	boolean	false	Setting indicating that the port is managed by Equinix. Applicable for viewPoint query parameter set to zSide.
equinixManagedVlan	boolean	false	Setting indicating that the VLAN is managed by Equinix. Applicable for viewPoint query parameter set to zSide.
allowOverSubscription	boolean	false	Allow services sales to exceed the available network bandwidth. Applicable for viewPoint query parameter set to zSide.
overSubscriptionLimit	integer	1	Port bandwidth multiplier that determines the total bandwidth that can be allocated to users creating connections to your services. For example, a 10 Gbps port combined with an overSubscriptionLimit parameter value of 10 allows your subscribers to create connections with a total bandwidth of 100 Gbps. Applicable for viewPoint query parameter set to zSide.
bandwidthFromApi	boolean	false	Indicates if the connection bandwidth can be obtained directly from the cloud service provider.

data.accessPointTypeConfigs.authenticationKey
required	boolean	true	Requirement to configure an authentication key.
label	string	Cloud Account ID	Name of the parameter that must be provided to authorize the connection.

data.accessPointTypeConfigs.metadata
allowVcMigration	boolean	true	Indicates if connections established based on the given service profile can be migrated to a different A-side port.

data.customFields
label	string	ASN	Label under which a custom parameter is presented on the Equnix Fabric portal or exposed through an API.
description	string	Excluded ASNs: 0, 13884, 36351, 64512, 64513, 65100, 65201‍–‍65234, 65402‍–‍65433, 65500, and 4201065000‍–‍4201065999.	Custom parameter description.
required	boolean	true	Indicates if a given custom field is mandatory.
dataType	string	INTEGER	Custom field data type. INTEGER - Integer. STRING - String.
captureInEmail	boolean	false	Capture the input value and include it in the email notification.

data.marketingInfo
promotion	boolean	true	Authorization to promote the given service profile on Equinix website and other products.
processSteps	array[object]	-	A data structure describing the steps necessary to establish connection to the given service provider.

data.marketingInfo.processSteps
title	string	Create Equinix Fabric Connection	Step title.
subTitle	string	on the Equinix Fabric	Step's subtitle.
description	string	Some very creative and descriptive description.	Details of the actions which must be taken to complete the given step.

data.ports
type	string	COLO	Port type.
uuid	string	c791f8cb-5c8f-c8f0-8ce0-306a5c00a4ee	Equinix-assigned port identifier.
location	object	-	Attributes associated with the specified asset location.
sellerRegion	string	ap-southeast-2	Seller region where the port is located.

data.ports.location
href	string	https://api.equinix.com/fabric/v4/metros/SV	An absolute URL that returns complete specification for the given entity.
metroCode	string	SV	Metropolitan area identifier.

data.metros
code	string	SV	Metropolitan area identifier.
name	string	Silicon Valley	Metropolitan area name.
ibxs	array[string]	["SV5","SV1"]	List of IBX data centers within the given metro where subscribers can access services provided by the given service profile.
displayName	string	Silicon Valley	Metropoiltan area name displayed on the service profile in the Equinix Fabric portal.

pagination
offset	integer	2	Index of the first item returned in the response.
limit	integer	2	Maximum number of items returned per page.
total	integer	2309	Total number of service profiles.
next	string	/serviceProfiles?offset=4&limit=2	Next data page url.
previous	string	/serviceProfiles?offset=0&limit=2	Previous data page url.

Get Specified Service Profile

	GET /fabric/v4/serviceProfiles/{uuid}
Method	GET
URL or Endpoint	/fabric/v4/serviceProfiles/{uuid}
Headers	Authorization, ic-version
Path Parameters	uuid
Query Parameters	viewPoint, style
Body Parameters	Not applicable

This API request retrieves a specified service profile. Service profiles define the services offered by service providers enabling other participants to find and connect to them.

Sample curl request

curl -X
GET 'https://api.equinix.com/fabric/v4/serviceProfiles/317dcd1c-83ba-4d7c-994a-3e7ddb875026'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-H 'ic-version: v4.2'

Header parameters

Parameter	Mandatory	Data Type	Example Values	Applicable Values	Description
authorization	yes	string	Bearer qwErtY8zyW1abcdefGHI	-	API request authorization token.
ic-version	yes	string	v4.2	v4.2	API version specifier.

Path parameters

Parameter	Mandatory	Data Type	Example Values	Description
uuid	yes	string	13c0f286-1190-480c-8a45-b3df00cad9cf	Equinix-assigned service profile identifier.

Query parameters

Parameter	Mandatory	Data Type	Example Values	Applicable Values	Description
viewPoint	no	string	aSide	aSide zSide Defalt: aSide	Returns service profile data set with parameters relevant to a buyer (aSide) or a seller (zSide).

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Sample response

{
    "state": "ACTIVE",
    "account": {
        "organizationName": "l3-qa-1-270253"
    },
    "changeLog": {
        "createdBy": "l3qa1user1",
        "createdByFullName": "l3qa1user1 l3qa1user1",
        "createdByEmail": "l3qa1user1@equinix.com",
        "createdDateTime": {},
        "updatedBy": "eqx-admin",
        "updatedByFullName": "eqx-admin eqx-admin",
        "updatedByEmail": "eqx-admin@equinix.com",
        "updatedDateTime": {}
    },
    "href": "https://api.equinix.com/fabric/v4/serviceProfiles/c2ba267e-0168-4254-93a2-32487de4ed7c?viewPoint=aSide",
    "type": "L2_PROFILE",
    "name": "E2E-SPHL2Name-060422130614789",
    "uuid": "c2ba267e-0168-4254-93a2-32487de4ed7c",
    "description": "<p>E2E-This is SPH Description With <a href=\"https://qa3fabric.corp.equinix.com/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Hyperlink</a>-060422130617254</p>",
    "tags": [
        "SaaS",
        "IaaS"
    ],
    "visibility": "PUBLIC",
    "accessPointTypeConfigs": [
        {
            "type": "COLO",
            "uuid": "d68c95c1-f289-4b52-8aee-7f4e2660e070",
            "supportedBandwidths": [
                50,
                200,
                500,
                1000
            ],
            "allowRemoteConnections": true,
            "allowCustomBandwidth": false,
            "allowBandwidthAutoApproval": false,
            "linkProtocolConfig": {
                "encapsulationStrategy": "CTAGED",
                "reuseVlanSTag": false,
                "encapsulation": "DOT1Q"
            },
            "enableAutoGenerateServiceKey": false,
            "connectionRedundancyRequired": false,
            "apiConfig": {
                "apiAvailable": false,
                "integrationId": "",
                "bandwidthFromApi": false
            },
            "connectionLabel": "Connection",
            "authenticationKey": {
                "required": false
            }
        }
    ],
    "marketingInfo": {
        "promotion": true
    },
    "metros": [
        {
            "code": "DA",
            "name": "Dallas",
            "ibxs": [
                "DA1"
            ],
            "displayName": "Dallas"
        }
    ],
    "selfProfile": false
}

Response payload body description

Parameter	Type	Example	Description
state	string	ACTIVE	Service profile lifecycle stage. ACTIVE - Service profile is active and enables establishing connections. DELETED - Service profile has been deleted. PENDING APPROVAL - Service profile awaiting administrator approval. REJECTED - Service profile has been rejected by the administrator.
account	object	-	Customer account information.
changeLog	object	-	A permanent record of asset creation, modification, or deletion.
href	string	https://api.equinix.com/fabric/v4/serviceProfiles/ 57186196-505d-4075-80f5-60e819e30310	An absolute URL that returns complete specification for the given entity.
type	string	L2_PROFILE	Service profile type. L2_PROFILE - layer 2 service profile for establishing connections in layer 2 of the OSI networking model. L3_PROFILE - layer 3 service profile for establishing connections in layer 2 of the OSI networking model.
name	string	E2E-SPHL2Name-040122133102496	Service profile name.
uuid	string	d48daade-4c18-446d-9c4d-92f6e2f93f55	Equinix-assigned service profile identifier.
description	string	E2E-This is SPH Description [...]	Service description.
notifications	object	-	Notification preferences and a list of recipients. Applicable for viewPoint query parameter set to zSide.
tags	array[string]	SaaS	Labels identifying the type of the services advertised by given service profile.
visibility	string	PRIVATE	Service profile visibility. PUBLIC - Public service profiles are listed on the Equinix Fabric portal allowing anyone to establish connections to advertised services. PRIVATE - Establishing a connection based on a private service profile requires provider's authorization.
allowedEmails	array[string]	["darth@vader.com","han@solo.com"]	Email addresses of users allowed to establish connections based on this service profile.
accessPointTypeConfigs	array[object]	-	Available access points types.
customFields	array[object]	-	User-defined fields added to a service profile.
marketingInfo	object	-	Optional service profile branding, such as the customer's logo.
ports	array[object]	-	Ports associated with the given service profile. Applicable for viewPoint query parameter set to zSide.
metros	array[object]	-	Locations where subscribers can access services available through the given service profile.
selfProfile	boolean	true	Indicates if the service profile and the user interacting with the API belong to the same organization. Applicable for viewPoint query parameter set to aSide.

account
orgId	string	92214	Equinix-assigned organization identifier. Applicable for viewPoint query parameter set to zSide.
organizationName	string	testBuyer-270001	Equinix-assigned organization name.
globalOrgId	string	0016C00000UlveoQAB	Equinix-assigned top-level organization identifier associated with the specified service profile.
globalOrganizationName	string	Cloud	Equinix-assigned top-level organization name associated with the specified service profile.

changeLog
createdBy	string	testBuyer999	Identity of the asset creator.
createdDateTime	string	2022-01-04T13:31:31.814Z	Asset creation timestamp.
updatedBy	string	eqx-admin999	Identity of the person who updated the asset.
updatedDateTime	string	2022-01-04T13:31:45.981Z	Asset update request timestamp.
createdByEmail	string	testBuyer999@equinix.com	Email address of the asset creator.
updatedByEmail	string	eqx-admin999@equinix.com	Email address of the person who updated the asset.
createdByFullName	string	testBuyer999 testBuyer999	First and last name of the asset creator.
updatedByFullName	string	eqx-admin999 eqx-admin999	First and last name of the person who updated the asset.

notifications
emails	array[string]	["l3qa1user1@equinix.com"]	List of receipients of a given type of notification.
type	string	BANDWIDTH_ALERT	Notification type. BANDWIDTH_ALERT - Bandwidth alert threshold has been reached. CONNECTION_APPROVAL - Connection request awaiting approval. PROFILE_LIFECYCLE - Service profile lifecycle has changed.

accessPointTypeConfigs
type	string	COLO	Access point type. COLO - Colocation space in an IBX data center. VD - Network Edge virtual device.
uuid	string	f1d3b691-09cb-4570-8567-137ce1ca6328	Equinix-assigned access point identifier.
supportedBandwidths	array[integer]	[200,500,700,1000]	Allowed connection bandwidths (Mbps).
allowRemoteConnections	boolean	true	Authorization to establish connections from remote locations.
allowCustomBandwidth	boolean	true	Authorization to set a custom connection bandwidth.
bandwidthAlertThreshold	integer	75	Send a bandwidth usage alert when the percentage value of the total bandwidth of the ports associated with the given service profile has been consumed by your subscribers. Applicable for viewPoint query parameter set to zSide.
allowBandwidthAutoApproval	boolean	false	Parameter indicating if bandwidth change requests are approved automatically.
linkProtocolConfig	object	-	Settings and preferences for the link protocol used at the access point.
enableAutoGenerateServiceKey	boolean	false	Applicable to Verizon Software Defined Interconnect service profile.
connectionRedundancyRequired	boolean	false	Indicates if connecting to the service requires creating a pair of redundant connections.
apiConfig	object	-	API configuration settings and preferences.
connectionLabel	string	Connection	An alternative term for connection in case it's different in your organization.
authenticationKey	object	-	Authentication key configuration.
metadata	object	-	Additional connection information.

accessPointTypeConfigs.linkProtocolConfig
encapsulationStrategy	string	CTAGED	Additional tagging information required by the seller profile.
reuseVlanSTag	boolean	false	Automatically accept subsequent DOT1Q to QINQ connections that use the same authentication key. These connections will have the same VLAN S-tag assigned as the initial connection.
encapsulation	string	DOT1Q	Data frames encapsulation standard. UNTAGGED - Untagged encapsulation for EPL connections. DOT1Q - DOT1Q encapsulation standard. QINQ - QINQ encapsulation standard.

accessPointTypeConfigs.apiConfig
apiAvailable	boolean	false	Indicates if it's possible to establish connections based on the given service profile using the Equinix Fabric API.
integrationId	string	AWS-DirectConnect-01	A unique identifier issued during onboarding and used to integrate the customer's service profile with the Equinix Fabric API.
equinixManagedPort	boolean	false	Setting indicating that the port is managed by Equinix. Applicable for viewPoint query parameter set to zSide.
equinixManagedVlan	boolean	false	Setting indicating that the VLAN is managed by Equinix. Applicable for viewPoint query parameter set to zSide.
allowOverSubscription	boolean	false	Allow services sales to exceed the available network bandwidth. Applicable for viewPoint query parameter set to zSide.
overSubscriptionLimit	integer	1	Port bandwidth multiplier that determines the total bandwidth that can be allocated to users creating connections to your services. For example, a 10 Gbps port combined with an overSubscriptionLimit parameter value of 10 allows your subscribers to create connections with a total bandwidth of 100 Gbps. Applicable for viewPoint query parameter set to zSide.
bandwidthFromApi	boolean	false	Indicates if the connection bandwidth can be obtained directly from the cloud service provider.

accessPointTypeConfigs.authenticationKey
required	boolean	true	Requirement to configure an authentication key.
label	string	Cloud Account ID	Name of the parameter that must be provided to authorize the connection.

accessPointTypeConfigs.metadata
allowVcMigration	boolean	true	Indicates if connections established based on the given service profile can be migrated to a different A-side port.

customFields
label	string	ASN	Label under which a custom parameter is presented on the Equnix Fabric portal or exposed through an API.
description	string	Excluded ASNs: 0, 13884, 36351, 64512, 64513, 65100, 65201‍–‍65234, 65402‍–‍65433, 65500, and 4201065000‍–‍4201065999.	Custom parameter description.
required	boolean	true	Indicates if a given custom field is mandatory.
dataType	string	INTEGER	Custom field data type. INTEGER - Integer. STRING - String.
captureInEmail	boolean	false	Capture the input value and include it in the email notification.

marketingInfo
promotion	boolean	true	Authorization to promote the given service profile on Equinix website and other products.
processSteps	array[object]	-	A data structure describing the steps necessary to establish connection to the given service provider.

marketingInfo.processSteps
title	string	Create Equinix Fabric Connection	Step title.
subTitle	string	on the Equinix Fabric	Step's subtitle.
description	string	Some very creative and descriptive description.	Details of the actions which must be taken to complete the given step.

ports
type	string	COLO	Port type.
uuid	string	c791f8cb-5c8f-c8f0-8ce0-306a5c00a4ee	Equinix-assigned port identifier.
location	object	-	Attributes associated with the specified asset location.
sellerRegion	string	ap-southeast-2	Seller region where the port is located.

ports.location
href	string	https://api.equinix.com/fabric/v4/metros/SV	An absolute URL that returns complete specification for the given entity.
metroCode	string	SV	Metropolitan area identifier.

metros
code	string	SV	Metropolitan area identifier.
name	string	Silicon Valley	Metropolitan area name.
ibxs	array[string]	["SV5","SV1"]	List of IBX data centers within the given metro where subscribers can access services provided by the given service profile.
displayName	string	Silicon Valley	Metropoiltan area name displayed on the service profile in the Equinix Fabric portal.

Retrieve Service Profiles

	POST /fabric/v4/serviceProfiles/search
Method	POST
URL or Endpoint	/fabric/v4/serviceProfiles/search
Headers	authorization, content-type, ic-version
Path Parameters	Not applicable
Query Parameters	Not applicable
Body Parameters	filter, pagination, sort

This API request retrieves service profiles that match provided search criteria.

For instructions on how to obtain an authorization token, refer to Requesting Access and Refresh Tokens.

Sample curl request

curl -X POST 'http: //api.equinix.com/fabric/v4/serviceProfiles/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-H 'ic-version: v4.2'
-d '{
    "filter": {
        "and": [
            {
                "property": "/name",
                "operator": "=",
                "values": [
                    "InterGalacticStorage"
                ]
            },
            {
                "property": "/type",
                "operator": "=",
                "values": [
                    "L2_PROFILE"
                ]
            }
        ]
    },
    "pagination": {
        "offset": 0,
        "limit": 20
    },
    "sort": [
        {
            "direction": "DESC",
            "property": "/changeLog/createdDateTime"
        }
    ]
}'

Header parameters

Parameter	Mandatory	Data Type	Example Values	Applicable Values	Description
authorization	yes	string	Bearer qwErtY8zyW1abcdefGHI	-	API request authorization token.
ic-version	yes	string	v4.2	v4.2	API version specifier.

Body parameters

Parameter	Mandatory	Data Type	Example	Applicable Values	Description
filter	no	object	-	-	Array of objects defining search conditions.
pagination	no	object	-	-	Search results pagination settings.
sort	no	object	-	-	Search results sorting settings.

filter
and	yes	array[object]	-	-	Logical operator.
property	yes	string	/metroCode	/name /uuid /state /metros/code /visibility /type	Search field parameter. Note that the property value determines the list of applicable operators and values.
operator	yes	string	=	= ~*	Search field parameter operator. ~* - Case-insensitive like.
values	yes	array[string]	["SV"]	-	Search field parameter value.

/name	no		"property": "/name", "operator": "=", "values": [ "Service Profile" ]		Service profile name.
operator	yes	string	=	= ~*	Search field parameter operator.
values	yes	array[string]	["HanSolo Inc."]	-	-

/uuid	no		"property": "/uuid", "operator": "=", "values": [ "3a58dd05-f46d-4b1d-a154-2e85c396ea62" ]		Equinix-assigned service profile identifier.
operator	yes	string	=	=	Search field parameter operator.
values	yes	array[string]	["3a58dd05-f46d-4b1d-a154-2e85c396ea62"]	-	-

/state	no		"property": "/state", "operator": "=", "values": [ "ACTIVE" ]		Asstet lifecycle status.
operator	yes	string	=	= ~*	Search field parameter operator.
values	yes	array[string]	["ACTIVE"]	ACTIVE DELETED PENDING_APPROVAL REJECTED	-

/metros/code	no		{ "property": "/metros/code", "operator": "=", "values": [ "SV" ] }		Metropolitan area identifier.
operator	yes	string	=	= ~*	Search field parameter operator.
values	yes	array[string]	["SV"]	Use the Get All Metros API request to retrieve the list of metros.	-

/visibility	no		"property": "/visibility", "operator": "=", "values": [ "PUBLIC" ]		Service profile visibility on Platform Equinix.
operator	yes	string	=	= ~*	Search field parameter operator.
values	yes	array[string]	["PUBLIC"]	PRIVATE PUBLIC	PRIVATE - Establishing connectins based on a private service profile requires service provider's authorization. PUBLIC - Public service profiles are listed on the Equinix Fabric portal allowing anyone to establish connections to advertised services.

/type	no		"property": "/type", "operator": "=", "values": [ "L2_PROFILE" ]		Service profile type.
operator	yes	string	IN	= ~*	Search field parameter operator.
values	yes	array[string]	["L2_PROFILE"]	L2_PROFILE L3_PROFILE	L2_PROFILE - Layer 2 service profile for establishing connections in layer 2 of the OSI networking model. L3_PROFILE - Layer 3 service profile for establishing connections in layer 3 of the OSI networking model.

pagination
offset	no	integer	0	Minimum: 0 Default: 0	Index of the first item returned in the response.
limit	no	integer	20	Minimum: 1 Default: 20	Maximum number of items returned per page.

sort
direction	no	string	DESC	ASC DESC	Search results sorting direction.
property	no	string	/changeLog/updatedDateTime	/name /uuid /state /metros/code /visibility /type Default: /changeLog/updatedDateTime	Search results sorting parameter.

Sample response

{
    "data": [
        {
            "state": "ACTIVE",
            "account": {
                "organizationName": "pmSuveer-270163",
                "globalOrgId": "0016u000003JZ4xAAG"
            },
            "changeLog": {
                "createdBy": "pmSuveer",
                "createdByFullName": "pmSuveer pmSuveer",
                "createdByEmail": "pmSuveer@equinix.com",
                "createdDateTime": "2022-04-05T20:50:36.236Z",
                "updatedBy": "eqx-admin",
                "updatedByFullName": "eqx-admin eqx-admin",
                "updatedByEmail": "eqx-admin@equinix.com",
                "updatedDateTime": "2022-04-05T20:54:15.139Z"
            },
            "href": "https://api.equinix.com/fabric/v4/serviceProfiles/3c5d81c1-4301-4d7a-aba1-3a0bf237f6c1?viewPoint=aSide",
            "type": "L2_PROFILE",
            "name": "NVK-PDS-SP-255",
            "uuid": "3c5d81c1-4301-4d7a-aba1-3a0bf237f6c1",
            "description": "<p>QA3 TEST</p>",
            "visibility": "PUBLIC",
            "accessPointTypeConfigs": [
                {
                    "type": "COLO",
                    "uuid": "c85e5938-988b-494d-8d66-cd03a7883fca",
                    "supportedBandwidths": [
                        50,
                        200,
                        500,
                        1000
                    ],
                    "allowRemoteConnections": true,
                    "allowCustomBandwidth": false,
                    "allowBandwidthAutoApproval": false,
                    "linkProtocolConfig": {
                        "encapsulationStrategy": "CTAGED",
                        "reuseVlanSTag": false,
                        "encapsulation": "QINQ"
                    },
                    "enableAutoGenerateServiceKey": false,
                    "connectionRedundancyRequired": false,
                    "apiConfig": {
                        "apiAvailable": false,
                        "integrationId": "",
                        "bandwidthFromApi": false
                    },
                    "connectionLabel": "Connection",
                    "authenticationKey": {
                        "required": false
                    }
                },
                {
                    "type": "COLO",
                    "uuid": "c85e5938-988b-494d-8d66-cd03a7883fca",
                    "supportedBandwidths": [
                        50,
                        200,
                        500,
                        1000
                    ],
                    "allowRemoteConnections": true,
                    "allowCustomBandwidth": false,
                    "allowBandwidthAutoApproval": false,
                    "linkProtocolConfig": {
                        "encapsulationStrategy": "CTAGED",
                        "reuseVlanSTag": false,
                        "encapsulation": "QINQ"
                    },
                    "enableAutoGenerateServiceKey": false,
                    "connectionRedundancyRequired": false,
                    "apiConfig": {
                        "apiAvailable": false,
                        "integrationId": "",
                        "bandwidthFromApi": false
                    },
                    "connectionLabel": "Connection",
                    "authenticationKey": {
                        "required": false
                    }
                }
            ],
            "marketingInfo": {
                "promotion": true
            },
            "metros": [
                {
                    "code": "SG",
                    "name": "Singapore",
                    "ibxs": [
                        "SG1"
                    ],
                    "displayName": "Singapore"
                },
                {
                    "code": "SY",
                    "name": "Sydney",
                    "ibxs": [
                        "SY4"
                    ],
                    "displayName": "Sydney"
                }
            ],
            "selfProfile": false
        },
        {
            "state": "ACTIVE",
            "account": {
                "organizationName": "testBuyer-270001",
                "globalOrgId": "0016u000003JZ4sAAG"
            },
            "changeLog": {
                "createdBy": "testBuyer",
                "createdByFullName": "testBuyer testBuyer",
                "createdByEmail": "testBuyer@equinix.com",
                "createdDateTime": "2022-04-05T14:03:09.762Z",
                "updatedBy": "eqx-admin",
                "updatedByFullName": "eqx-admin eqx-admin",
                "updatedByEmail": "eqx-admin@equinix.com",
                "updatedDateTime": "2022-04-05T14:03:19.326Z"
            },
            "href": "https://api.equinix.com/fabric/v4/serviceProfiles/bff14ddf-0681-4e01-841b-2e0900ce0117?viewPoint=aSide",
            "type": "L2_PROFILE",
            "name": "E2E-SPHL2Name-050422140237776",
            "uuid": "bff14ddf-0681-4e01-841b-2e0900ce0117",
            "description": "<p>E2E-This is SPH...</p>",
            "tags": [
                "SaaS",
                "IaaS"
            ],
            "visibility": "PUBLIC",
            "accessPointTypeConfigs": [
                {
                    "type": "COLO",
                    "uuid": "573b83c9-8c75-4eb0-8d13-95bca877970f",
                    "supportedBandwidths": [
                        200,
                        500,
                        700,
                        1000
                    ],
                    "allowRemoteConnections": true,
                    "allowCustomBandwidth": true,
                    "allowBandwidthAutoApproval": false,
                    "linkProtocolConfig": {
                        "encapsulationStrategy": "CTAGED",
                        "reuseVlanSTag": false,
                        "encapsulation": "DOT1Q"
                    },
                    "enableAutoGenerateServiceKey": false,
                    "connectionRedundancyRequired": false,
                    "apiConfig": {
                        "apiAvailable": false,
                        "integrationId": "",
                        "bandwidthFromApi": false
                    },
                    "connectionLabel": "Connection",
                    "authenticationKey": {
                        "required": false
                    }
                },
                {
                    "type": "COLO",
                    "uuid": "573b83c9-8c75-4eb0-8d13-95bca877970f",
                    "supportedBandwidths": [
                        200,
                        500,
                        700,
                        1000
                    ],
                    "allowRemoteConnections": true,
                    "allowCustomBandwidth": true,
                    "allowBandwidthAutoApproval": false,
                    "linkProtocolConfig": {
                        "encapsulationStrategy": "CTAGED",
                        "reuseVlanSTag": false,
                        "encapsulation": "DOT1Q"
                    },
                    "enableAutoGenerateServiceKey": false,
                    "connectionRedundancyRequired": false,
                    "apiConfig": {
                        "apiAvailable": false,
                        "integrationId": "",
                        "bandwidthFromApi": false
                    },
                    "connectionLabel": "Connection",
                    "authenticationKey": {
                        "required": false
                    }
                }
            ],
            "marketingInfo": {
                "promotion": true
            },
            "metros": [
                {
                    "code": "DA",
                    "name": "Dallas",
                    "ibxs": [
                        "DA1"
                    ],
                    "displayName": "Dallas"
                }
            ],
            "selfProfile": true
        }
    ],
    "pagination": {
        "offset": 0,
        "limit": 2,
        "total": 51
    }
}

Response payload body description

Parameter	Type	Example	Description
data	object	-	Data array containing data model entities.
pagination	object	-	An absolute URL that returns the specified connection.

data
state	string	ACTIVE	Service profile lifecycle stage. ACTIVE - Service profile is active and enables establishing connections. DELETED - Service profile has been deleted. PENDING APPROVAL - Service profile awaiting administrator approval. REJECTED - Service profile has been rejected by the administrator.
account	object	-	Customer account information.
changeLog	object	-	A permanent record of asset creation, modification, or deletion.
href	string	https://api.equinix.com/fabric/v4/serviceProfiles/ 57186196-505d-4075-80f5-60e819e30310	An absolute URL that returns complete specification for the given entity.
type	string	L2_PROFILE	Service profile type. L2_PROFILE - layer 2 service profile for establishing connections in layer 2 of the OSI networking model. L3_PROFILE - layer 3 service profile for establishing connections in layer 2 of the OSI networking model.
name	string	E2E-SPHL2Name-040122133102496	Service profile name.
uuid	string	d48daade-4c18-446d-9c4d-92f6e2f93f55	Equinix-assigned service profile identifier.
description	string	E2E-This is SPH Description [...]	Service description.
notifications	object	-	Notification preferences and a list of recipients. Applicable for viewPoint query parameter set to zSide.
tags	array[string]	SaaS	Labels identifying the type of the services advertised by given service profile.
visibility	string	PRIVATE	Service profile visibility. PUBLIC - Public service profiles are listed on the Equinix Fabric portal allowing anyone to establish connections to advertised services. PRIVATE - Establishing a connection based on a private service profile requires provider's authorization.
allowedEmails	array[string]	["darth@vader.com","han@solo.com"]	Email addresses of users allowed to establish connections based on this service profile.
accessPointTypeConfigs	array[object]	-	Available access points types.
customFields	array[object]	-	User-defined fields added to a service profile.
marketingInfo	object	-	Optional service profile branding, such as the customer's logo.
ports	array[object]	-	Ports associated with the given service profile. Applicable for viewPoint query parameter set to zSide.
metros	array[object]	-	Locations where subscribers can access services available through the given service profile.
selfProfile	boolean	true	Indicates if the service profile and the user interacting with the API belong to the same organization.

data.account
orgId	string	92214	Equinix-assigned organization identifier. Applicable for viewPoint query parameter set to zSide.
organizationName	string	testBuyer-270001	Equinix-assigned organization name.
globalOrgId	string	0016C00000UlveoQAB	Equinix-assigned top-level organization identifier associated with the specified service profile.
globalOrganizationName	string	Cloud	Equinix-assigned top-level organization name associated with the specified service profile.

data.changeLog
createdBy	string	testBuyer999	Identity of the asset creator.
createdDateTime	string	2022-01-04T13:31:31.814Z	Asset creation timestamp.
updatedBy	string	eqx-admin999	Identity of the person who updated the asset.
updatedDateTime	string	2022-01-04T13:31:45.981Z	Asset update request timestamp.
createdByEmail	string	testBuyer999@equinix.com	Email address of the asset creator.
updatedByEmail	string	eqx-admin999@equinix.com	Email address of the person who updated the asset.
createdByFullName	string	testBuyer999 testBuyer999	First and last name of the asset creator.
updatedByFullName	string	eqx-admin999 eqx-admin999	First and last name of the person who updated the asset.

data.notifications
emails	array[string]	["l3qa1user1@equinix.com"]	List of receipients of a given type of notification.
type	string	BANDWIDTH_ALERT	Notification type. BANDWIDTH_ALERT - Bandwidth alert threshold has been reached. CONNECTION_APPROVAL - Connection request awaiting approval. PROFILE_LIFECYCLE - Service profile lifecycle has changed.

data.accessPointTypeConfigs
type	string	COLO	Access point type. COLO - Colocation space in an IBX data center. VD - Network Edge virtual device.
uuid	string	f1d3b691-09cb-4570-8567-137ce1ca6328	Equinix-assigned access point identifier.
supportedBandwidths	array[integer]	[200,500,700,1000]	Allowed connection bandwidths (Mbps).
allowRemoteConnections	boolean	true	Authorization to establish connections from remote locations.
allowCustomBandwidth	boolean	true	Authorization to set a custom connection bandwidth.
bandwidthAlertThreshold	integer	75	Send a bandwidth usage alert when the percentage value of the total bandwidth of the ports associated with the given service profile has been consumed by your subscribers. Applicable for viewPoint query parameter set to zSide.
allowBandwidthAutoApproval	boolean	false	Parameter indicating if bandwidth change requests are approved automatically.
linkProtocolConfig	object	-	Settings and preferences for the link protocol used at the access point.
enableAutoGenerateServiceKey	boolean	false	Applicable to Verizon Software Defined Interconnect service profile.
connectionRedundancyRequired	boolean	false	Indicates if connecting to the service requires creating a pair of redundant connections.
apiConfig	object	-	API configuration settings and preferences.
connectionLabel	string	Connection	An alternative term for connection in case it's different in your organization.
authenticationKey	object	-	Authentication key configuration.
metadata	object	-	Additional connection information.

data.accessPointTypeConfigs.linkProtocolConfig
encapsulationStrategy	string	CTAGED	Additional tagging information required by the seller profile.
reuseVlanSTag	boolean	false	Automatically accept subsequent DOT1Q to QINQ connections that use the same authentication key. These connections will have the same VLAN S-tag assigned as the initial connection.
encapsulation	string	DOT1Q	Data frames encapsulation standard. UNTAGGED - Untagged encapsulation for EPL connections. DOT1Q - DOT1Q encapsulation standard. QINQ - QINQ encapsulation standard.

data.accessPointTypeConfigs.apiConfig
apiAvailable	boolean	false	Indicates if it's possible to establish connections based on the given service profile using the Equinix Fabric API.
integrationId	string	AWS-DirectConnect-01	A unique identifier issued during onboarding and used to integrate the customer's service profile with the Equinix Fabric API.
equinixManagedPort	boolean	false	Setting indicating that the port is managed by Equinix. Applicable for viewPoint query parameter set to zSide.
equinixManagedVlan	boolean	false	Setting indicating that the VLAN is managed by Equinix. Applicable for viewPoint query parameter set to zSide.
allowOverSubscription	boolean	false	Allow services sales to exceed the available network bandwidth. Applicable for viewPoint query parameter set to zSide.
overSubscriptionLimit	integer	1	Port bandwidth multiplier that determines the total bandwidth that can be allocated to users creating connections to your services. For example, a 10 Gbps port combined with an overSubscriptionLimit parameter value of 10 allows your subscribers to create connections with a total bandwidth of 100 Gbps. Applicable for viewPoint query parameter set to zSide.
bandwidthFromApi	boolean	false	Indicates if the connection bandwidth can be obtained directly from the cloud service provider.

data.accessPointTypeConfigs.authenticationKey
required	boolean	true	Requirement to configure an authentication key.
label	string	Cloud Account ID	Name of the parameter that must be provided to authorize the connection.

data.accessPointTypeConfigs.metadata
allowVcMigration	boolean	true	Indicates if connections established based on the given service profile can be migrated to a different A-side port.

data.customFields
label	string	ASN	Label under which a custom parameter is presented on the Equnix Fabric portal or exposed through an API.
description	string	Excluded ASNs: 0, 13884, 36351, 64512, 64513, 65100, 65201‍–‍65234, 65402‍–‍65433, 65500, and 4201065000‍–‍4201065999.	Custom parameter description.
required	boolean	true	Indicates if a given custom field is mandatory.
dataType	string	INTEGER	Custom field data type. INTEGER - Integer. STRING - String.
captureInEmail	boolean	false	Capture the input value and include it in the email notification.

data.marketingInfo
promotion	boolean	true	Authorization to promote the given service profile on Equinix website and other products.
processSteps	array[object]	-	A data structure describing the steps necessary to establish connection to the given service provider.

data.marketingInfo.processSteps
title	string	Create Equinix Fabric Connection	Step title.
subTitle	string	on the Equinix Fabric	Step's subtitle.
description	string	Some very creative and descriptive description.	Details of the actions which must be taken to complete the given step.

data.ports
type	string	COLO	Port type.
uuid	string	c791f8cb-5c8f-c8f0-8ce0-306a5c00a4ee	Equinix-assigned port identifier.
location	object	-	Attributes associated with the specified asset location.
sellerRegion	string	ap-southeast-2	Seller region where the port is located.

data.ports.location
href	string	https://api.equinix.com/fabric/v4/metros/SV	An absolute URL that returns complete specification for the given entity.
metroCode	string	SV	Metropolitan area identifier.

data.metros
code	string	SV	Metropolitan area identifier.
name	string	Silicon Valley	Metropolitan area name.
ibxs	array[string]	["SV5","SV1"]	List of IBX data centers within the given metro where subscribers can access services provided by the given service profile.
displayName	string	Silicon Valley	Metropoiltan area name displayed on the service profile in the Equinix Fabric portal.

pagination
offset	integer	2	Index of the first item returned in the response.
limit	integer	2	Maximum number of items returned per page.
total	integer	2309	Total number of service profiles.

Update Service Profile

	PATCH /fabric/v4/serviceProfiles/{uuid}
Method	PATCH
URL or Endpoint	/fabric/v4/serviceProfiles/{uuid}
Headers	authorization, content-type, ic-version
Path Parameters	uuid
Query Parameters	Not applicable
Body Parameters	op, path, value

This API modifies a service profile.

Sample curl request

curl -X
PATCH 'https: //api.equinix.com/fabric/v4/serviceProfiles/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-H 'ic-version: v4.2'
-d '[
    {
        "op": "replace",
        "path": "/name",
        "value": "Service Profile 2"
    }
]'

Header parameters

Parameter	Mandatory	Data Type	Example Values	Applicable Values	Description
authorization	yes	string	Bearer qwErtY8zyW1abcdefGHI	-	API request authorization token.
content-type	yes	string	application/json	application/json	Specifies the resource media type.
ic-version	yes	string	v4.2	v4.2	API version specifier.

Path parameters

Parameter	Mandatory	Type	Example Values	Applicable Values	Description
uuid	yes	string	3a58dd05-f46d-4b1d-a154-2e85c396ea62	-	Equinix-assigned service profile identifier.

Body parameters

Parameter	Mandatory	Type	Example Values	Applicable Values	Description
op	yes	string	replace	replace	Update reqest type.
path	yes	string	/name	/name /visibility /description /tags /allowedEmails /customFields	Parameter path.
value	yes	string	Service Profile 2	-	Parameter value.

/name
value	yes	string	Service Profile 2	Maximum: 50 characters Allowed characters: alpha-numeric, hyphens ('-'), underscores ('_') and white spaces (' ').	Service profile name.

/visibility
value	yes	string	PRIVATE	PRIVATE PUBLIC	Service profile accessibility. PUBLIC - Public service profiles are listed on the Equinix Fabric portal allowing anyone to establish connections to advertised services. PRIVATE - Establishing a connection based on a private service profile requires provider's authorization.

/description
value	yes	string	Service profile description.	Maximum: 375 characters.	Service description.

/tags
value	yes	array[string]	["IaaS","SaaS"]	-	Labels identifying the type of the services advertised by given service profile.

/allowedEmails
value	yes	array[string]	["john@equinix.com","jane@equinix.com"]	-	Email addresses of users allowed to establish connections based on this service profile. Applicable to PRIVATE visibility service profiles.

/customFields
value	yes	array[object]	[ { "label": "Global", "description": "Optional ", "required": false, "dataType": "STRING", "captureInEmail": false }, { "label": "ASN", "description": "Number. Mandatory field.", "required": true, "dataType": "NUMBER", "captureInEmail": false } ]		User-defined fields added to a service profile.

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Sample response

{
    "state": "ACTIVE",
    "account": {
        "orgId": 91997,
        "globalOrgId": "0016u000003JZ4sAAG"
    },
    "changeLog": {
        "createdBy": "fusiontestbuyer",
        "createdByFullName": "fusiontestBuyer fusiontestBuyer",
        "createdByEmail": "fusiontestBuyer@equinix.com",
        "createdDateTime": "2022-04-12T12:34:38.381Z",
        "updatedBy": "fusiontestbuyer",
        "updatedByFullName": "fusiontestBuyer fusiontestBuyer",
        "updatedByEmail": "fusiontestBuyer@equinix.com",
        "updatedDateTime": "2022-04-13T09:23:10.214Z"
    },
    "href": "https://api.equinix.com/fabric/v4/serviceProfiles/3a58dd05-f46d-4b1d-a154-2e85c396ea62",
    "type": "L2_PROFILE",
    "name": "Service Profile 2",
    "uuid": "50cee78c-29b8-4596-901d-edbdbc0b8aff",
    "description": "Sample_description",
    "visibility": "PRIVATE",
    "allowedEmails": [
        "test@equinix.com",
        "testagain@equinix.com"
    ],
    "accessPointTypeConfigs": [
        {
            "type": "COLO",
            "uuid": "39ec4e87-47a6-4200-a32d-7fc41da6754a",
            "supportedBandwidths": [
                50,
                200,
                500,
                1000
            ],
            "allowRemoteConnections": true,
            "allowCustomBandwidth": false,
            "bandwidthAlertThreshold": 80,
            "allowBandwidthAutoApproval": false,
            "linkProtocolConfig": {
                "encapsulationStrategy": "CTAGED",
                "reuseVlanSTag": false,
                "encapsulation": "QINQ"
            },
            "enableAutoGenerateServiceKey": false,
            "connectionRedundancyRequired": false,
            "apiConfig": {
                "apiAvailable": false,
                "equinixManagedPort": false,
                "equinixManagedVlan": false,
                "allowOverSubscription": false,
                "overSubscriptionLimit": 1,
                "bandwidthFromApi": false
            },
            "connectionLabel": "Connection",
            "authenticationKey": {
                "required": false
            }
        }
    ],
    "marketingInfo": {
        "promotion": true
    },
    "ports": [
        {
            "type": "XF_PORT",
            "uuid": "cecd1039-eadd-add3-31e0-387a5c00aeb9",
            "location": {
                "href": "https://api.equinix.com/fabric/v4/metros/DC",
                "metroCode": "DC"
            }
        }
    ],
    "metros": [
        {
            "code": "DC",
            "ibxs": [
                "DC6"
            ]
        }
    ]
}

Response payload body description

Parameter	Type	Example	Description
state	string	ACTIVE	Service profile lifecycle stage. ACTIVE - Service profile is active and enables establishing connections. DELETED - Service profile has been deleted. PENDING APPROVAL - Service profile awaiting administrator approval. REJECTED - Service profile has been rejected by the administrator.
account	object	-	Customer account information.
changeLog	object	-	A permanent record of asset creation, modification, or deletion.
href	string	https://api.equinix.com/fabric/v4/serviceProfiles/ 57186196-505d-4075-80f5-60e819e30310	An absolute URL that returns complete specification for the given entity.
type	string	L2_PROFILE	Service profile type. L2_PROFILE - layer 2 service profile for establishing connections in layer 2 of the OSI networking model. L3_PROFILE - layer 3 service profile for establishing connections in layer 2 of the OSI networking model.
name	string	E2E-SPHL2Name-040122133102496	Service profile name.
uuid	string	d48daade-4c18-446d-9c4d-92f6e2f93f55	Equinix-assigned service profile identifier.
description	string	E2E-This is SPH Description [...]	Service description.
notifications	object	-	Notification preferences and a list of recipients. Applicable for viewPoint query parameter set to zSide.
tags	array[string]	SaaS	Labels identifying the type of the services advertised by given service profile.
visibility	string	PRIVATE	Service profile visibility. PUBLIC - Public service profiles are listed on the Equinix Fabric portal allowing anyone to establish connections to advertised services. PRIVATE - Establishing a connection based on a private service profile requires provider's authorization.
allowedEmails	array[string]	["darth@vader.com","han@solo.com"]	Email addresses of users allowed to establish connections based on this service profile.
accessPointTypeConfigs	array[object]	-	Available access points types.
customFields	array[object]	-	User-defined fields added to a service profile.
marketingInfo	object	-	Optional service profile branding, such as the customer's logo.
ports	array[object]	-	Ports associated with the given service profile. Applicable for viewPoint query parameter set to zSide.
metros	array[object]	-	Locations where subscribers can access services available through the given service profile.

account
orgId	string	92214	Equinix-assigned organization identifier. Applicable for viewPoint query parameter set to zSide.
organizationName	string	testBuyer-270001	Equinix-assigned organization name.
globalOrgId	string	0016C00000UlveoQAB	Equinix-assigned top-level organization identifier associated with the specified service profile.
globalOrganizationName	string	Cloud	Equinix-assigned top-level organization name associated with the specified service profile.

changeLog
createdBy	string	testBuyer999	Identity of the asset creator.
createdDateTime	string	2022-01-04T13:31:31.814Z	Asset creation timestamp.
updatedBy	string	eqx-admin999	Identity of the person who updated the asset.
updatedDateTime	string	2022-01-04T13:31:45.981Z	Asset update request timestamp.
createdByEmail	string	testBuyer999@equinix.com	Email address of the asset creator.
updatedByEmail	string	eqx-admin999@equinix.com	Email address of the person who updated the asset.
createdByFullName	string	testBuyer999 testBuyer999	First and last name of the asset creator.
updatedByFullName	string	eqx-admin999 eqx-admin999	First and last name of the person who updated the asset.

notifications
emails	array[string]	["l3qa1user1@equinix.com"]	List of receipients of a given type of notification.
type	string	BANDWIDTH_ALERT	Notification type. BANDWIDTH_ALERT - Bandwidth alert threshold has been reached. CONNECTION_APPROVAL - Connection request awaiting approval. PROFILE_LIFECYCLE - Service profile lifecycle has changed.

accessPointTypeConfigs
type	string	COLO	Access point type. COLO - Colocation space in an IBX data center. VD - Network Edge virtual device.
uuid	string	f1d3b691-09cb-4570-8567-137ce1ca6328	Equinix-assigned access point identifier.
supportedBandwidths	array[integer]	[200,500,700,1000]	Allowed connection bandwidths (Mbps).
allowRemoteConnections	boolean	true	Authorization to establish connections from remote locations.
allowCustomBandwidth	boolean	true	Authorization to set a custom connection bandwidth.
bandwidthAlertThreshold	integer	75	Send a bandwidth usage alert when the percentage value of the total bandwidth of the ports associated with the given service profile has been consumed by your subscribers. Applicable for viewPoint query parameter set to zSide.
allowBandwidthAutoApproval	boolean	false	Parameter indicating if bandwidth change requests are approved automatically.
linkProtocolConfig	object	-	Settings and preferences for the link protocol used at the access point.
enableAutoGenerateServiceKey	boolean	false	Applicable to Verizon Software Defined Interconnect service profile.
connectionRedundancyRequired	boolean	false	Indicates if connecting to the service requires creating a pair of redundant connections.
apiConfig	object	-	API configuration settings and preferences.
connectionLabel	string	Connection	An alternative term for connection in case it's different in your organization.
authenticationKey	object	-	Authentication key configuration.
metadata	object	-	Additional connection information.

accessPointTypeConfigs.linkProtocolConfig
encapsulationStrategy	string	CTAGED	Additional tagging information required by the seller profile.
reuseVlanSTag	boolean	false	Automatically accept subsequent DOT1Q to QINQ connections that use the same authentication key. These connections will have the same VLAN S-tag assigned as the initial connection.
encapsulation	string	DOT1Q	Data frames encapsulation standard. UNTAGGED - Untagged encapsulation for EPL connections. DOT1Q - DOT1Q encapsulation standard. QINQ - QINQ encapsulation standard.

accessPointTypeConfigs.apiConfig
apiAvailable	boolean	false	Indicates if it's possible to establish connections based on the given service profile using the Equinix Fabric API.
integrationId	string	AWS-DirectConnect-01	A unique identifier issued during onboarding and used to integrate the customer's service profile with the Equinix Fabric API.
equinixManagedPort	boolean	false	Setting indicating that the port is managed by Equinix. Applicable for viewPoint query parameter set to zSide.
equinixManagedVlan	boolean	false	Setting indicating that the VLAN is managed by Equinix. Applicable for viewPoint query parameter set to zSide.
allowOverSubscription	boolean	false	Allow services sales to exceed the available network bandwidth. Applicable for viewPoint query parameter set to zSide.
overSubscriptionLimit	integer	1	Port bandwidth multiplier that determines the total bandwidth that can be allocated to users creating connections to your services. For example, a 10 Gbps port combined with an overSubscriptionLimit parameter value of 10 allows your subscribers to create connections with a total bandwidth of 100 Gbps. Applicable for viewPoint query parameter set to zSide.
bandwidthFromApi	boolean	false	Indicates if the connection bandwidth can be obtained directly from the cloud service provider.

accessPointTypeConfigs.authenticationKey
required	boolean	true	Requirement to configure an authentication key.
label	string	Cloud Account ID	Name of the parameter that must be provided to authorize the connection.

accessPointTypeConfigs.metadata
allowVcMigration	boolean	true	Indicates if connections established based on the given service profile can be migrated to a different A-side port.

customFields
label	string	ASN	Label under which a custom parameter is presented on the Equnix Fabric portal or exposed through an API.
description	string	Excluded ASNs: 0, 13884, 36351, 64512, 64513, 65100, 65201‍–‍65234, 65402‍–‍65433, 65500, and 4201065000‍–‍4201065999.	Custom parameter description.
required	boolean	true	Indicates if a given custom field is mandatory.
dataType	string	INTEGER	Custom field data type. INTEGER - Integer. STRING - String.
captureInEmail	boolean	false	Capture the input value and include it in the email notification.

marketingInfo
promotion	boolean	true	Authorization to promote the given service profile on Equinix website and other products.
processSteps	array[object]	-	A data structure describing the steps necessary to establish connection to the given service provider.

marketingInfo.processSteps
title	string	Create Equinix Fabric Connection	Step title.
subTitle	string	on the Equinix Fabric	Step's subtitle.
description	string	Some very creative and descriptive description.	Details of the actions which must be taken to complete the given step.

ports
type	string	COLO	Port type.
uuid	string	c791f8cb-5c8f-c8f0-8ce0-306a5c00a4ee	Equinix-assigned port identifier.
location	object	-	Attributes associated with the specified asset location.
sellerRegion	string	ap-southeast-2	Seller region where the port is located.

ports.location
href	string	https://api.equinix.com/fabric/v4/metros/SV	An absolute URL that returns complete specification for the given entity.
metroCode	string	SV	Metropolitan area identifier.

metros
code	string	SV	Metropolitan area identifier.
name	string	Silicon Valley	Metropolitan area name.
ibxs	array[string]	["SV5","SV1"]	List of IBX data centers within the given metro where subscribers can access services provided by the given service profile.
displayName	string	Silicon Valley	Metropoiltan area name displayed on the service profile in the Equinix Fabric portal.

Replace Service Profile

	PUT /fabric/v4/serviceProfiles/{uuid}
Method	PUT
URL or Endpoint	/fabric/v4/serviceProfiles/{uuid}
Headers	authorization, content-type, ic-version, if-match
Path Parameters	uuid
Query Parameters	Not applicable
Body Parameters	type, name, description, notifications, visibility, allowedEmails, tags, accessPointTypeConfigs, customFields, marketingInfo, ports

This API request replaces a service profile definition.

Sample curl request

curl -X
PUT 'https://api.equinix.com/fabric/v4/serviceProfiles/50cee78c-29b8-4596-901d-edbdbc0b8aff'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-H 'content-type: application/json'
-H 'ic-version: v4.2'
-H 'if-match: 1'
-d '{
    "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,
            "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
            ]
        }
    ]
}' 

Header parameters

Parameter	Mandatory	Data Type	Example Values	Applicable Values	Description
authorization	yes	string	Bearer qwErtY8zyW1abcdefGHI	-	API request authorization token.
content-type	yes	string	application/json	application/json	Specifies the resource media type.
ic-version	yes	string	v4.2	v4.2	API version specifier.
if-match	yes	string	1	-	Entity tag (ETag) value for the given resource.

Path parameters

Parameter	Mandatory	Data Type	Example Values	Description
uuid	yes	string	13c0f286-1190-480c-8a45-b3df00cad9cf	Equinix-assigned service profile identifier.

Body parameters

Parameter	Type	Mandatory	Example	Applicable values	Description
type	string	yes	L2_PROFILE	L2_PROFILE L3_PROFILE	Service profile type. L2_PROFILE - layer 2 service profile for establishing connections in layer 2 of the OSI networking model. L3_PROFILE - layer 3 service profile for establishing connections in layer 2 of the OSI networking model.
name	string	yes	A-to-Z	Maximum: 50 characters Allowed characters: alpha-numeric, hyphens ('-'), underscores ('_') and white spaces (' ').	Service profile name.
description	string	yes	A-to-Z services for your daily cloud needs. Han Solo approved.	Maximum: 375 characters	Service description.
notifications	object	no	-	-	Notification preferences and a list of recipients.
visibility	string	yes	PUBLIC	PRIVATE PUBLIC	Service profile visibility. PUBLIC - Public service profiles are listed on the Equinix Fabric portal allowing anyone to establish connections to advertised services. PRIVATE - Establishing a connection based on a private service profile requires provider's authorization.
allowedEmails	array[string]	no	["darth@vader.com","han@solo.com"]	-	Email addresses of users allowed to establish connections based on this service profile. Applicable to PRIVATE visibility service profiles.
tags	array[string]	no	SaaS	-	Labels identifying the type of the services advertised by given service profile.
accessPointTypeConfigs	array[object]	yes	-	-	Available access points types.
customFields	array[object]	no	-	-	User-defined fields added to a service profile.
marketingInfo	object	no	-	-	Optional service profile branding, such as the customer's logo.
ports	array[object]	no	-	-	Ports associated with the given service profile.

notifications
emails	array[string]	no	["l3qa1user1@equinix.com"]	-	List of receipients of a given type of notification.
type	string	no	BANDWIDTH_ALERT	BANDWIDTH_ALERT CONNECTION_APPROVAL PROFILE_LIFECYCLE	Notification type. BANDWIDTH_ALERT - Bandwidth alert threshold has been reached. CONNECTION_APPROVAL - Connection request awaiting approval. PROFILE_LIFECYCLE - Service profile lifecycle has changed.

accessPointTypeConfigs
type	string	no	COLO	COLO VD	Connection endpoint type. COLO - Colocation space in an IBX data center. VD - Network Edge virtual device.
supportedBandwidths	array[integer]	no	[200,500,700,1000]	-	Allowed connection bandwidths (Mbps).
allowRemoteConnections	boolean	no	true	true false	Authorization to establish connections from remote locations.
allowCustomBandwidth	boolean	no	true	true false	Authorization to set a custom connection bandwidth.
bandwidthAlertThreshold	integer	no	75	Maximum: 100	Send a bandwidth usage alert when the percentage value of the total bandwidth of the ports associated with the given service profile has been consumed by your subscribers.
allowBandwidthAutoApproval	boolean	no	false	true false	Parameter indicating if bandwidth change requests are approved automatically.
linkProtocolConfig	object	no	-	-	Settings and preferences for the link protocol used at the access point.
connectionRedundancyRequired	boolean	no	false	-	Requirement to configure a redundant connection.
connectionLabel	string	no	Connection	-	An alternative term for connection in case it's different in your organization.
authenticationKey	object	no	-	-	Authentication key configuration.
apiConfig	object		-	-	API configuration settings and preferences.

accessPointTypes.apiConfig
apiAvailable	boolean		false		Authorization to establish connections with this service profile using API.
equinixManagedPort	boolean		false		Setting indicating that the port is managed by Equinix.
equinixManagedVlan	boolean		false		Setting indicating that the VLAN is managed by Equinix.
allowOverSubscription	boolean		false		Allow services sales to exceed the available network bandwidth.
overSubscriptionLimit	integer	no	1	Minimum: 1 Maximum: 20	Port bandwidth multiplier that determines the total bandwidth that can be allocated to users creating connections to your services. For example, a 10 Gbps port combined with an overSubscriptionLimit parameter value of 10 allows your subscribers to create connections with a total bandwidth of 100 Gbps.
bandwidthFromApi	boolean		false		Indicates if the connection bandwidth can be obtained directly from the cloud service provider.

accessPointTypeConfigs.linkProtocolConfig
encapsulationStrategy	string	no	CTAGED	CTAGED NAMED BOTH	Additional tagging information required by the seller profile.
reuseVlanSTag	boolean	no	false	-	Automatically accept subsequent DOT1Q to QINQ connections that use the same authentication key. These connections will have the same VLAN S-tag assigned as the initial connection.
encapsulation	string	no	DOT1Q	UNTAGGED DOT1Q QINQ	Data frames encapsulation standard. UNTAGGED - Untagged encapsulation for EPL connections. DOT1Q - DOT1Q encapsulation standard. QINQ - QINQ encapsulation standard.

accessPointTypeConfigs.authenticationKey
required	boolean	no	true	true false	Requirement to configure an authentication key.
label	string	no	Cloud Account ID	-	Name of the parameter that must be provided to authorize the connection.

customFields
label	string	yes	ASN	-	Label under which a custom parameter is presented on the Equnix Fabric portal or exposed through an API.
description	string	yes	Excluded ASNs: 0, 13884, 36351, 64512, 64513, 65100, 65201‍–‍65234, 65402‍–‍65433, 65500, and 4201065000‍–‍4201065999.	-	Custom parameter description.
required	boolean	no	true	true false	Indicates if a given custom field is mandatory.
dataType	string	yes	INTEGER	INTEGER STRING	Custom field data type. INTEGER - Integer. STRING - String.
captureInEmail	boolean	no	false	true false	Capture the input value and include it in the email notification.

marketingInfo
promotion	boolean	no	true	true false	Authorization to promote the given service profile on Equinix website and other products.
processSteps	array[object]	no	-	-	A data structure describing the steps necessary to establish connection to the given service provider.

marketingInfo.processSteps
title	string	no	Create Equinix Fabric Connection	-	Step title.
subTitle	string	no	on the Equinix Fabric	-	Step's subtitle.
description	string	no	Some very creative and descriptive description.	-	Details of the actions which must be taken to complete the given step.

ports
type	string	yes	COLO	COLO VD	Port type.
uuid	string	yes	cecd1039-eadd-add3-31e0-387a5c00aeb9	Use the Get All Ports API request to retrieve the list of procured ports.<	Equinix-assigned port identifier.

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Sample response

{
    "state": "ACTIVE",
    "account": {
        "orgId": 91785,
        "organizationName": "testSeller-270010",
        "globalOrgId": "0016u000003JZ4tAAG"
    },
    "changeLog": {
        "createdBy": "fusiontestseller",
        "createdByFullName": "fusiontestSeller fusiontestSeller",
        "createdByEmail": "fusiontestSeller@equinix.com",
        "createdDateTime": {},
        "updatedDateTime": {}
    },
    "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"
            ]
        }
    ],
    "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,
            "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": {
                "href": "https://api.equinix.com/fabric/v4/metros/SY",
                "metroCode": "SY"
            }
        }
    ],
    "metros": [
        {
            "code": "SY",
            "name": "Sydney",
            "ibxs": [
                "SY4"
            ],
            "displayName": "Sydney"
        }
    ]
}

Response payload body description

Parameter	Type	Example	Description
state	string	ACTIVE	Service profile lifecycle stage. ACTIVE - Service profile is active and enables establishing connections. DELETED - Service profile has been deleted. PENDING APPROVAL - Service profile awaiting administrator approval. REJECTED - Service profile has been rejected by the administrator.
account	object	-	Customer account information.
changeLog	object	-	A permanent record of asset creation, modification, or deletion.
href	string	https://api.equinix.com/fabric/v4/serviceProfiles/ 57186196-505d-4075-80f5-60e819e30310	An absolute URL that returns complete specification for the given entity.
uuid	string	d48daade-4c18-446d-9c4d-92f6e2f93f55	Equinix-assigned service profile identifier.
accessPointTypeConfigs	array[object]	-	Available access points types.
ports	array[object]	-	Ports associated with the given service profile.
metros	array[object]	-	Locations where subscribers can access services available through the given service profile.

account
orgId	string	92214	Equinix-assigned organization identifier.
organizationName	string	testBuyer-270001	Equinix-assigned organization name.
globalOrgId	string	0016C00000UlveoQAB	Equinix-assigned top-level organization identifier associated with the specified service profile.
globalOrganizationName	string	Cloud	Equinix-assigned top-level organization name associated with the specified service profile.

changeLog
createdDateTime	string	2022-01-04T13:31:31.814Z	Asset creation timestamp.

accessPointTypeConfigs
uuid	string	f20c49cd-b022-4aeb-b3e4-49db4389aff3	Equinix-assigned access point identifier.

ports
location	object	-	Attributes associated with the specified asset location.

ports.location
href	string	https://api.equinix.com/fabric/v4/metros/SY	An absolute URL that returns complete specification for the given entity.
metroCode	string	SY	Metropolitan area identifier.

metros
code	string	SV	Metropolitan area identifier.
name	string	Silicon Valley	Metropolitan area name.
ibxs	array[string]	["SV5","SV1"]	List of IBX data centers within the given metro where subscribers can access services provided by the given service profile.
displayName	string	Silicon Valley	Metropoiltan area name displayed on the service profile in the Equinix Fabric portal.

Delete Service Profile

	DELETE /fabric/v4/serviceProfiles/{uuid}
Method	DELETE
URL or Endpoint	/fabric/v4/serviceProfiles/{uuid}
Headers	authorization, ic-version
Path Parameters	uuid
Query Parameters	Not applicable
Body Parameters	Not applicable

This API request deletes a specified service profile.

Deleting a service profile doesn't deprovision already established connections.

Sample curl request

curl -X DELETE 'http://api.equinix.com/fabric/v4/serviceProfiles/13c0f286-1190-480c-8a45-b3df00cad9cf'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-H 'ic-version: v4.2'

Header parameters

Parameter	Mandatory	Data Type	Example Values	Applicable Values	Description
authorization	yes	string	Bearer qwErtY8zyW1abcdefGHI	-	API request authorization token.
ic-version	yes	string	v4.2	v4.2	API version specifier.

Path parameters

Parameter	Mandatory	Data Type	Example	Applicable Values	Description
uuid	yes	string	13c0f286-1190-480c-8a45-b3df00cad9cf	Use the Retrieve Service Profiles API request to identify the service profile you want to delete.	Equinix-assigned service profile identifier.

Sample response

{
    "state": "DELETED",
    "account": {
        "orgId": 91785,
        "organizationName": "testSeller-270010",
        "globalOrgId": "0016u000003JZ4tAAG"
    },
    "changeLog": {
        "createdBy": "fusiontestseller",
        "createdByFullName": "fusiontestSeller fusiontestSeller",
        "createdByEmail": "fusiontestSeller@equinix.com",
        "createdDateTime": {},
        "updatedBy": "fusiontestseller",
        "updatedByFullName": "fusiontestSeller fusiontestSeller",
        "updatedByEmail": "fusiontestSeller@equinix.com",
        "updatedDateTime": {}
    },
    "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,
            "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": {
                "href": "https://api.equinix.com/fabric/v4/metros/SY",
                "metroCode": "SY"
            }
        }
    ],
    "metros": [
        {
            "code": "SY",
            "name": "Sydney",
            "ibxs": [
                "SY4"
            ],
            "displayName": "Sydney"
        }
    ]
}

Response payload body description

Parameter	Type	Example	Description
state	string	ACTIVE	Service profile lifecycle stage. ACTIVE - Service profile is active and enables establishing connections. DELETED - Service profile has been deleted. PENDING APPROVAL - Service profile awaiting administrator approval. REJECTED - Service profile has been rejected by the administrator.
account	object	-	Customer account information.
changeLog	object	-	A permanent record of asset creation, modification, or deletion.
href	string	https://api.equinix.com/fabric/v4/serviceProfiles/ 57186196-505d-4075-80f5-60e819e30310	An absolute URL that returns complete specification for the given entity.
type	string	L2_PROFILE	Service profile type. L2_PROFILE - layer 2 service profile for establishing connections in layer 2 of the OSI networking model. L3_PROFILE - layer 3 service profile for establishing connections in layer 2 of the OSI networking model.
name	string	E2E-SPHL2Name-040122133102496	Service profile name.
uuid	string	d48daade-4c18-446d-9c4d-92f6e2f93f55	Equinix-assigned service profile identifier.
description	string	E2E-This is SPH Description [...]	Service description.
notifications	object	-	Notification preferences and a list of recipients.
tags	array[string]	SaaS	Labels identifying the type of the services advertised by given service profile.
visibility	string	PRIVATE	Service profile visibility. PUBLIC - Public service profiles are listed on the Equinix Fabric portal allowing anyone to establish connections to advertised services. PRIVATE - Establishing a connection based on a private service profile requires provider's authorization.
allowedEmails	array[string]	["darth@vader.com","han@solo.com"]	Email addresses of users allowed to establish connections based on this service profile.
accessPointTypeConfigs	array[object]	-	Available access points types.
customFields	array[object]	-	User-defined fields added to a service profile.
marketingInfo	object	-	Optional service profile branding, such as the customer's logo.
ports	array[object]	-	Ports associated with the given service profile.
metros	array[object]	-	Locations where subscribers can access services available through the given service profile.
selfProfile	boolean	true	Indicates if the service profile and the user interacting with the API belong to the same organization.

account
orgId	string	92214	Equinix-assigned organization identifier.
organizationName	string	testBuyer-270001	Equinix-assigned organization name.
globalOrgId	string	0016C00000UlveoQAB	Equinix-assigned top-level organization identifier associated with the specified service profile.
globalOrganizationName	string	Cloud	Equinix-assigned top-level organization name associated with the specified service profile.

changeLog
createdBy	string	testBuyer999	Identity of the asset creator.
createdDateTime	string	2022-01-04T13:31:31.814Z	Asset creation timestamp.
updatedBy	string	eqx-admin999	Identity of the person who updated the asset.
updatedDateTime	string	2022-01-04T13:31:45.981Z	Asset update request timestamp.
createdByEmail	string	testBuyer999@equinix.com	Email address of the asset creator.
updatedByEmail	string	eqx-admin999@equinix.com	Email address of the person who updated the asset.
createdByFullName	string	testBuyer999 testBuyer999	First and last name of the asset creator.
updatedByFullName	string	eqx-admin999 eqx-admin999	First and last name of the person who updated the asset.

notifications
emails	array[string]	["l3qa1user1@equinix.com"]	List of receipients of a given type of notification.
type	string	BANDWIDTH_ALERT	Notification type. BANDWIDTH_ALERT - Bandwidth alert threshold has been reached. CONNECTION_APPROVAL - Connection request awaiting approval. PROFILE_LIFECYCLE - Service profile lifecycle has changed.

accessPointTypeConfigs
type	string	COLO	Access point type. COLO - Colocation space in an IBX data center. VD - Network Edge virtual device.
uuid	string	f1d3b691-09cb-4570-8567-137ce1ca6328	Equinix-assigned access point identifier.
supportedBandwidths	array[integer]	[200,500,700,1000]	Allowed connection bandwidths (Mbps).
allowRemoteConnections	boolean	true	Authorization to establish connections from remote locations.
allowCustomBandwidth	boolean	true	Authorization to set a custom connection bandwidth.
bandwidthAlertThreshold	integer	75	Send a bandwidth usage alert when the percentage value of the total bandwidth of the ports associated with the given service profile has been consumed by your subscribers.
allowBandwidthAutoApproval	boolean	false	Parameter indicating if bandwidth change requests are approved automatically.
linkProtocolConfig	object	-	Settings and preferences for the link protocol used at the access point.
enableAutoGenerateServiceKey	boolean	false	Applicable to Verizon Software Defined Interconnect service profile.
connectionRedundancyRequired	boolean	false	Indicates if connecting to the service requires creating a pair of redundant connections.
apiConfig	object	-	API configuration settings and preferences.
connectionLabel	string	Connection	An alternative term for connection in case it's different in your organization.
authenticationKey	object	-	Authentication key configuration.
metadata	object	-	Additional connection information.

accessPointTypeConfigs.linkProtocolConfig
encapsulationStrategy	string	CTAGED	Additional tagging information required by the seller profile.
reuseVlanSTag	boolean	false	Automatically accept subsequent DOT1Q to QINQ connections that use the same authentication key. These connections will have the same VLAN S-tag assigned as the initial connection.
encapsulation	string	DOT1Q	Data frames encapsulation standard. UNTAGGED - Untagged encapsulation for EPL connections. DOT1Q - DOT1Q encapsulation standard. QINQ - QINQ encapsulation standard.

accessPointTypeConfigs.apiConfig
apiAvailable	boolean	false	Indicates if it's possible to establish connections based on the given service profile using the Equinix Fabric API.
integrationId	string	AWS-DirectConnect-01	A unique identifier issued during onboarding and used to integrate the customer's service profile with the Equinix Fabric API.
equinixManagedPort	boolean	false	Setting indicating that the port is managed by Equinix.
equinixManagedVlan	boolean	false	Setting indicating that the VLAN is managed by Equinix.
allowOverSubscription	boolean	false	Allow services sales to exceed the available network bandwidth.
overSubscriptionLimit	integer	1	Port bandwidth multiplier that determines the total bandwidth that can be allocated to users creating connections to your services. For example, a 10 Gbps port combined with an overSubscriptionLimit parameter value of 10 allows your subscribers to create connections with a total bandwidth of 100 Gbps. Applicable for viewPoint query parameter set to zSide.
bandwidthFromApi	boolean	false	Indicates if the connection bandwidth can be obtained directly from the cloud service provider.

accessPointTypeConfigs.authenticationKey
required	boolean	true	Requirement to configure an authentication key.
label	string	Cloud Account ID	Name of the parameter that must be provided to authorize the connection.

accessPointTypeConfigs.metadata
allowVcMigration	boolean	true	Indicates if connections established based on the given service profile can be migrated to a different A-side port.

customFields
label	string	ASN	Label under which a custom parameter is presented on the Equnix Fabric portal or exposed through an API.
description	string	Excluded ASNs: 0, 13884, 36351, 64512, 64513, 65100, 65201‍–‍65234, 65402‍–‍65433, 65500, and 4201065000‍–‍4201065999.	Custom parameter description.
required	boolean	true	Indicates if a given custom field is mandatory.
dataType	string	INTEGER	Custom field data type. INTEGER - Integer. STRING - String.
captureInEmail	boolean	false	Capture the input value and include it in the email notification.

marketingInfo
promotion	boolean	true	Authorization to promote the given service profile on Equinix website and other products.
processSteps	array[object]	-	A data structure describing the steps necessary to establish connection to the given service provider.

marketingInfo.processSteps
title	string	Create Equinix Fabric Connection	Step title.
subTitle	string	on the Equinix Fabric	Step's subtitle.
description	string	Some very creative and descriptive description.	Details of the actions which must be taken to complete the given step.

ports
type	string	COLO	Port type.
uuid	string	c791f8cb-5c8f-c8f0-8ce0-306a5c00a4ee	Equinix-assigned port identifier.
location	object	-	Attributes associated with the specified asset location.
sellerRegion	string	ap-southeast-2	Seller region where the port is located.

ports.location
href	string	https://api.equinix.com/fabric/v4/metros/SV	An absolute URL that returns complete specification for the given entity.
metroCode	string	SV	Metropolitan area identifier.

metros
code	string	SV	Metropolitan area identifier.
name	string	Silicon Valley	Metropolitan area name.
ibxs	array[string]	["SV5","SV1"]	List of IBX data centers within the given metro where subscribers can access services provided by the given service profile.
displayName	string	Silicon Valley	Metropoiltan area name displayed on the service profile in the Equinix Fabric portal.

Service Tokens

Create Service Token

	POST /fabric/v4/serviceTokens
Method	POST
URL or Endpoint	/fabric/v4/serviceTokens
Headers	Authorization, Content-Type
Path Parameters	Not applicable
Query Parameters	Not applicable
Body Parameters	type, issuerSide, expirationDateTime, connection, notifications, project

This API request creates a service token. Service tokens authorize creation of connections based on a set of predefined parameters. For more information, see Equinix Fabric: Service Tokens.

To learn how to obtain an authorization token, see Requesting Access and Refresh Tokens under the Getting Access Token section.

Sample curl request - create A-side service token

Create A-side service tokens and share them with your customers to allow them to use your A-side port to establish connections to any destination available on the Equinix Fabric.

curl -X
POST 'https://api.equinix.com/fabric/v4/serviceTokens'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'
-d '{
    "type": "VC_TOKEN",
    "issuerSide": "A_Side",
    "connection": {
        "type": "EVPL_VC",
        "bandwidthLimit": 1000,
        "allowRemoteConnection": true,
        "aSide": {
            "accessPointSelectors": [
                {
                    "type": "COLO",
                    "hideAssetInfo": false,
                    "port": {
                        "uuid": "cecd1039-eadd-add3-31e0-387a5c00aeb9"
                    },
                    "linkProtocol": {
                        "type": "QINQ",
                        "vlanSTag": 1234,
                        "vlanCTag": 2345
                    }
                }
            ]
        }
    },
    "expirationDateTime": "2023-02-20T00:00:00Z",
    "notifications": [
        {
            "type": "NOTIFICATION",
            "emails": [
                "service@subscriber.equinix.com"
            ]
        }
    ],
    "project": {
        "projectId": "377533000114703"
    }
}'

Sample curl request - create Z-side service token

Create a Z-side service token and share them with other Equinix Fabric customers to allow them to connect to your services or ports.

curl -X
POST 'https://api.equinix.com/fabric/v4/serviceTokens'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'
-d '{
    "type": "VC_TOKEN",
    "issuerSide": "Z_Side",
    "connection": {
        "type": "EVPL_VC",
        "allowRemoteConnection": true,
        "allowCustombandwidth": false,
        "supportedBandwidths": [
            50,
            200,
            500,
            1000
        ],
        "zSide": {
            "accessPointSelectors": [
                {
                    "type": "COLO",
                    "hideAssetInfo": false,
                    "port": {
                        "uuid": "b840a1db-5413-413f-97e0-328a5c00a874"
                    },
                    "linkProtocol": {
                        "type": "QINQ",
                        "vlanCTag": 1399,
                        "vlanSTag": 1388
                    }
                }
            ]
        }
    },
    "expiry": 77,
    "notifications": [
        {
            "type": "NOTIFICATION",
            "emails": [
                "service@subscriber.equinix.com"
            ]
        }
    ],
    "project": {
        "projectId": "377533000114703"
    }
}'

Body parameters

Parameter	Description
type `string` REQUIRED	Type of service token. Applicable values: VC_TOKEN - Virtual connection token
issuerSide `string` REQUIRED	Token issuer side. Applicable values: A_Side - A-side service tokens enable your customers to connect to service providers using your shared port. Z_side - Z-side service token enable others to connect to your services based on predefined parameters.
connection `object` REQUIRED	Connection specification.
type `string` REQUIRED	Connection type. Applicable values: EVPL_VC - Ethernet virtual private line connection.
bandwidthLimit `integer` CONDITIONAL	Connection bandwidth limit in Mbps. Applicable to A-side service tokens. Example: 1000
supportedBandwidths `array[integer]` CONDITIONAL	Supported connection bandwidths in Mbps. Applicable to Z-side service tokens. Applicable values: 10 50 200 500 1000 2000 5000 10000
allowRemoteConnection `boolean` REQUIRED	Authorization to establish connection from a different metro. Example: true
aSide `object` CONDITIONAL	A-side port parameters. Applicable to A-side service tokens.
accessPointSelectors `array[object]` REQUIRED	List of available connection endpoints.
type `string` REQUIRED	Connection endpoint type. Applicable values: COLO - Colocation space in an IBX data center.
hideAssetInfo `boolean` OPTIONAL	Hide endpoint details. Default: false
port `object` REQUIRED	Port parameters.
uuid `string` REQUIRED	Equinix-assigned port identifier. Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
linkProtocol `object` REQUIRED	Link protocol configuration.
type `string` REQUIRED	Link protocol type. Applicable values: DOT1Q QINQ VXLAN
vlanTag `integer` CONDITIONAL	DOT1Q protocol VLAN tag. Applicable to DOT1Q link protocol. Applicable values: 2-4094
vlanSTag `integer` CONDITIONAL	QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines. Applicable to QINQ link protocol. Applicable values: 2-4094
vlanCTag `integer` CONDITIONAL	QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines. Applicable to QINQ link protocol. Applicable values: 2-4094
vni `integer` CONDITIONAL	Virtual network identifier. Applicable to VXLAN link protocol. Applicable values: 4097-16777215
zSide `object` CONDITIONAL	Z-side port parameters. Applicable to Z-side service tokens.
accessPointSelectors `array[object]` REQUIRED	List of available connection endpoints.
type `string` REQUIRED	Connection endpoint type. Applicable values: COLO - Colocation space in an IBX data center.
hideAssetInfo `boolean` OPTIONAL	Hide endpoint details. Default: false
port `object` REQUIRED	Endpoint port parameters.
uuid `string` REQUIRED	Equinix-assigned port identifier. Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
linkProtocol `object` REQUIRED	Link protocol configuration.
type `string` REQUIRED	Link protocol type. Applicable values: DOT1Q QINQ VXLAN
vlanTag `integer` CONDITIONAL	DOT1Q protocol VLAN tag. Applicable to DOT1Q link protocol. Applicable values: 2-4094
vlanSTag `integer` CONDITIONAL	QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines. Applicable to QINQ link protocol. Applicable values: 2-4094
vlanCTag `integer` CONDITIONAL	QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines. Applicable to QINQ link protocol. Applicable values: 2-4094
vni `integer` CONDITIONAL	Virtual network identifier. Applicable to VXLAN link protocol. Applicable values: 4097-16777215
expiry `integer` CONDITIONAL	The number of days the service token is valid. Required if `expirationDateTime` isn't provided. Applicable values: Minimum: 1 Maximum: 90
expirationDateTime `string` CONDITIONAL	Service token expiration date timestamp in the IETF ISO 8601 extended date/time format. Required if `expiry` isn't provided. Applicable values: The maximum service token validity is 90 days. Example: 2023-01-20T00:22:11.831Z
notifications `array[object]` REQUIRED	Service token notification settings.
type `string` REQUIRED	Notification messages category. Applicable values: NOTIFICATION
emails `array[string]` REQUIRED	Email addresses of up to 12 service token recipients. Service token is valid for a single use by one of the recipients. Example: ["mike@mspp.com","dwight@dm.com"]
project `object` OPTIONAL	Customer resource hierarchy project information. Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId `string` OPTIONAL	Customer project identifier. Example: 377533000114703

Sample response - create A-side service token

{
    "href": "http://api.equinix.com/fabric/v4/serviceTokens/2025244e-aed0-4d72-b3c7-2b0e52cb3443",
    "type": "VC_TOKEN",
    "uuid": "2025244e-aed0-4d72-b3c7-2b0e52cb3443",
    "state": "INACTIVE",
    "connection": {
        "type": "EVPL_VC",
        "allowRemoteConnection": true,
        "bandwidthLimit": 1000,
        "aSide": {
            "accessPointSelectors": [
                {
                    "type": "COLO",
                    "port": {
                        "uuid": "cecd1039-eadd-add3-31e0-387a5c00aeb9"
                    },
                    "linkProtocol": {
                        "type": "QINQ",
                        "vlanCTag": 2345,
                        "vlanSTag": 1234
                    }
                }
            ]
        }
    },
    "expiry": 89,
    "expirationDateTime": "2023-02-20T00:00:00Z",
    "notifications": [
        {
            "type": "NOTIFICATION",
            "emails": [
                "service@subscriber.equinix.com",
                "service@provider.equinix.com"
            ]
        }
    ],
    "account": {
        "orgId": "91997"
    },
    "changeLog": {
        "createdBy": "902625",
        "createdDateTime": "2022-11-22T12:55:15.037Z"
    },
    "project": {
        "projectId": "377533000114703"
    }
}

Response payload body description

Parameter	Description
href `string`	An absolute URL that returns the specified asset. Example: http://api.equinix.com/fabric/v4/serviceTokens/213ee923-4099-45de-8e97-8e6021ed2761
type `string`	Type of service token. Example: VC_TOKEN - Virtual connection token
uuid `string`	Equinix-assigned service token identifier. Example: 213ee923-4099-45de-8e97-8e6021ed2761
state `string`	Lifecycle stage of a service token. Example: INACTIVE
issuerSide `string`	Token issuer side. Example: Z_side
connection `object`	Connection specification.
type `string`	Connection type. Example: EVPL_VC - Ethernet virtual private line connection.
allowRemoteConnection `boolean`	Authorization to establish connection from a different metro. Example: true
bandwidthLimit `integer`	Connection bandwidth limit in Mbps. Applicable to A-side service tokens. Example: 1000
supportedBandwidths `array[integer]`	Supported connection bandwidths in Mbps. Applicable to Z-side service tokens. Applicable values: 10 50 200 500 1000 2000 5000 10000
aSide `object`	A-side port parameters. Applicable to A-side service tokens.
accessPointSelectors `array[object]`	List of available connection endpoints.
type `string`	Connection endpoint type. Example: COLO - Colocation space in an IBX data center.
hideAssetInfo `boolean`	Hide endpoint details. Example: false
port `object`	Port parameters.
uuid `string`	Equinix-assigned port identifier. Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
linkProtocol `object`	Link protocol configuration.
type `string`	Link protocol type. Example: DOT1Q
vlanTag `integer`	DOT1Q protocol VLAN tag. Applicable to DOT1Q link protocol. Example: 2345
vlanSTag `integer`	QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines. Applicable to QINQ link protocol. Example: 123
vlanCTag `integer`	QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines. Applicable to QINQ link protocol. Example: 456
vni `integer`	Virtual network identifier. Applicable to VXLAN link protocol. Example: 5002
zSide `object`	Z-side port parameters. Applicable to Z-side service tokens.
accessPointSelectors `array[object]`	List of available connection endpoints.
type `string`	Connection endpoint type. Example: COLO - Colocation space in an IBX data center.
hideAssetInfo `boolean`	Hide endpoint details. Example: false
port `object`	Endpoint port parameters.
uuid `string`	Equinix-assigned port identifier. Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
linkProtocol `object`	Link protocol configuration.
type `string`	Link protocol type. Example: QINQ
vlanTag `integer`	DOT1Q protocol VLAN tag. Applicable to DOT1Q link protocol. Example: 123
vlanSTag `integer`	QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines. Applicable to QINQ link protocol. Example: 123
vlanCTag `integer`	QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines. Applicable to QINQ link protocol. Example: 456
vni `integer`	Virtual network identifier. Applicable to VXLAN link protocol. Example: 5002
expiry `integer`	The number of days the service token is valid. Example: 89
expirationDateTime `string`	Service token expiration date timestamp in the IETF ISO 8601 extended date/time format. Example: 2023-01-20T00:22:11.831Z
notifications `array[object]`	Service token notification settings.
type `string`	Notification messages category. Example: NOTIFICATION
emails `array[string]`	Email addresses of up to 12 service token recipients. Service token is valid for a single use by one of the recipients. Example: ["mike@mspp.com","dwight@dm.com"]
account `object`	Customer account information.
orgId `string`	Customer organization identifier. Example: 94513
changeLog `object`	A permanent record of asset creation, modification, or deletion.
createdBy `string`	Identity of the asset creator. Example: AverageJoe
createdDateTime `string`	Asset creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z
project `object`	Customer resource hierarchy project information. Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId `string`	Customer project identifier. Example: 377533000114703

Get All Service Tokens

	GET /fabric/v4/serviceTokens
Method	GET
URL or Endpoint	/fabric/v4/serviceTokens
Headers	Authorization
Path Parameters	Not applicable
Query Parameters	offset, limit
Body Parameters	Not applicable

This API request retrieves all service tokens associated with the user account. Service tokens authorize creation of connections based on a set of predefined parameters. For more information, see Equinix Fabric: Service Tokens.

To learn how to obtain an authorization token, see Requesting Access and Refresh Tokens under the Getting Access Token section.

Sample curl request

curl -X
GET 'https://api.equinix.com/serviceTokens?offset=2&limit=2'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'

Query parameters

Parameter	Description
offset `integer` OPTIONAL	Index of the first item returned in the response. Minimum: 0 Default: 0
limit `integer` OPTIONAL	Maximum number of items returned per page. Minimum: 1 Default: 10

Sample response

{
    "pagination": {
        "offset": 2,
        "limit": 2,
        "total": 511,
        "next": "/serviceTokens?offset=4&limit=2",
        "previous": "/serviceTokens?offset=0&limit=2"
    },
    "data": [
        {
            "href": "http://api.equinix.com/fabric/v4/serviceTokens/c9c67f3a-9fea-4c4a-b7e6-16e4c8c33c04",
            "type": "VC_TOKEN",
            "uuid": "c9c67f3a-9fea-4c4a-b7e6-16e4c8c33c04",
            "state": "INACTIVE",
            "expiry": 30,
            "expirationDateTime": "2021-08-14T18:39:13.866Z",
            "connection": {
                "type": "EVPL_VC",
                "allowRemoteConnection": false,
                "supportedBandwidths": [
                    100,
                    10,
                    108
                ],
                "allowCustomBandwidth": false,
                "zSide": {
                    "accessPointSelectors": [
                        {
                            "type": "COLO",
                            "port": {
                                "uuid": "b840a1db-5758-758f-97e0-328a5c00a874"
                            },
                            "linkProtocol": {
                                "type": "QINQ",
                                "vlanCTag": 1399,
                                "vlanSTag": 1388
                            }
                        }
                    ]
                }
            },
            "notifications": [
                {
                    "type": "NOTIFICATION",
                    "emails": [
                        "provider@example.com",
                        "Falconsvendor1@equinix.com",
                        "customer@example.com"
                    ]
                }
            ],
            "account": {
                "orgId": "111437"
            },
            "changeLog": {
                "createdBy": "849817",
                "createdDateTime": "2021-07-15T18:39:13.866Z"
            },
            "project": {
                "projectId": "377533000114703"
            }
        },
        {
            "href": "http://api.equinix.com/fabric/v4/serviceTokens/b1409597-7a84-4c23-a298-6803c089ecfa",
            "type": "VC_TOKEN",
            "uuid": "b1409597-7a84-4c23-a298-6803c089ecfa",
            "state": "ACTIVE",
            "expiry": 1,
            "expirationDateTime": "2021-07-13T19:34:53.954Z",
            "connection": {
                "type": "EVPL_VC",
                "allowRemoteConnection": true,
                "bandwidthLimit": 500,
                "aSide": {
                    "accessPointSelectors": [
                        {
                            "type": "COLO",
                            "port": {
                                "uuid": "b840a1db-53eb-3ebf-97e0-328a5c00a874"
  "data": [
    {
    "href": "http://api.equinix.com/fabric/v4/serviceTokens/c9c67f3a-9fea-4c4a-b7e6-16e4c8c33c04",
    "type": "VC_TOKEN",
    "uuid": "c9c67f3a-9fea-4c4a-b7e6-16e4c8c33c04",
    "state": "INACTIVE",
    "expiry": 30,
    "expirationDateTime": "2021-08-14T18:39:13.866Z",
    "connection": {
      "type": "EVPL_VC",
      "allowRemoteConnection": false,
      "uuid": "53dc2010-5006-46b6-9e91-995c47415d5b",
      "href": "http://api.equinix.com/fabric/v4/connections/53dc2010-5006-46b6-9e91-995c47415d5b",
      "supportedBandwidths": [
        100,
        10,
        108
        ],
      "allowCustomBandwidth": false,
      "zSide": {
        "accessPointSelectors": [
        {
          "type": "COLO",
          "port": {
            "uuid": "b840a1db-5758-758f-97e0-328a5c00a874"
            },
          "linkProtocol": {
            "type": "QINQ",
            "vlanCTag": 1399,
            "vlanSTag": 1388
            }
          }
        ]
      }
    },
    "notifications": [
      {
        "type": "NOTIFICATION",
        "emails": [
          "provider@example.com",
          "Falconsvendor1@equinix.com",
          "customer@example.com"
          ]
        }
      ],
    "account": {
      "orgId": "111437"
      },
    "changeLog": {
        "createdBy": "849817",
        "createdDateTime": "2021-07-15T18:39:13.866Z"
        }
      },

    {
    "href": "http://api.equinix.com/fabric/v4/serviceTokens/b1409597-7a84-4c23-a298-6803c089ecfa",
    "type": "VC_TOKEN",
    "uuid": "b1409597-7a84-4c23-a298-6803c089ecfa",
    "state": "ACTIVE",
    "expiry": 1,
    "expirationDateTime": "2021-07-13T19:34:53.954Z",
    "connection": {
        "type": "EVPL_VC",
        "allowRemoteConnection": true,
        "uuid": "63dc2010-5006-46b6-9e91-995c47415d5d",
        "href": "http://api.equinix.com/fabric/v4/connections/93dc2010-5006-46b6-9e91-995c47415d5c",
        "bandwidthLimit": 500,
            "aSide": {
                "accessPointSelectors": [
                    {
                    "type": "COLO",
                    "port": {
                        "uuid": "b840a1db-53eb-3ebf-97e0-328a5c00a874"
                            },
                            "linkProtocol": {
                                "type": "DOT1Q",
                                "vlanTag": 1279
                            }
                        }
                    ]
                }
            },
            "notifications": [
                {
                    "type": "NOTIFICATION",
                    "emails": [
                        "provider@example.com",
                        "customer@example.com"
                    ]
                }
            ],
            "account": {
                "orgId": "111437"
            },
            "changeLog": {
                "createdBy": "849817",
                "createdDateTime": "2021-07-12T19:34:53.954Z",
                "updatedDateTime": "2021-07-12T19:35:57.997Z"
            },
            "project": {
                "projectId": "377533000114703"
            }
        }
    ]
}

Response payload body description

Parameter	Description
pagination `object`	Data set pagination settings.
offset `integer`	Index of the first item returned in the response. Example: 20
limit `integer`	Maximum number of items returned per page. Example: 20
total `integer`	Total number of items returned. Example: 1
data `array[object]`	Array containing returned data set.
href `string`	An absolute URL that returns the specified asset. Example: http://api.equinix.com/fabric/v4/serviceTokens/213ee923-4099-45de-8e97-8e6021ed2761
type `string`	Type of service token. Example: VC_TOKEN - Virtual connection token
uuid `string`	Equinix-assigned service token identifier. Example: 213ee923-4099-45de-8e97-8e6021ed2761
state `string`	Lifecycle stage of a service token. Example: INACTIVE
issuerSide `string`	Token issuer side. Example: Z_side
connection `object`	Connection specification.
type `string`	Connection type. Example: EVPL_VC - Ethernet virtual private line connection.
allowRemoteConnection `boolean`	Authorization to establish connection from a different metro. Example: true
bandwidthLimit `integer`	Connection bandwidth limit in Mbps. Applicable to A-side service tokens. Example: 1000
supportedBandwidths `array[integer]`	Supported connection bandwidths in Mbps. Applicable to Z-side service tokens. Applicable values: 10 50 200 500 1000 2000 5000 10000
aSide `object`	A-side port parameters. Applicable to A-side service tokens.
accessPointSelectors `array[object]`	List of available connection endpoints.
type `string`	Connection endpoint type. Example: COLO - Colocation space in an IBX data center.
hideAssetInfo `boolean`	Hide endpoint details. Example: false
port `object`	Port parameters.
uuid `string`	Equinix-assigned port identifier. Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
linkProtocol `object`	Link protocol configuration.
type `string`	Link protocol type. Example: DOT1Q
vlanTag `integer`	DOT1Q protocol VLAN tag. Applicable to DOT1Q link protocol. Example: 2345
vlanSTag `integer`	QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines. Applicable to QINQ link protocol. Example: 123
vlanCTag `integer`	QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines. Applicable to QINQ link protocol. Example: 456
vni `integer`	Virtual network identifier. Applicable to VXLAN link protocol. Example: 5002
zSide `object`	Z-side port parameters. Applicable to Z-side service tokens.
accessPointSelectors `array[object]`	List of available connection endpoints.
type `string`	Connection endpoint type. Example: COLO - Colocation space in an IBX data center.
hideAssetInfo `boolean`	Hide endpoint details. Example: false
port `object`	Endpoint port parameters.
uuid `string`	Equinix-assigned port identifier. Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
linkProtocol `object`	Link protocol configuration.
type `string`	Link protocol type. Example: QINQ
vlanTag `integer`	DOT1Q protocol VLAN tag. Applicable to DOT1Q link protocol. Example: 123
vlanSTag `integer`	QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines. Applicable to QINQ link protocol. Example: 123
vlanCTag `integer`	QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines. Applicable to QINQ link protocol. Example: 456
vni `integer`	Virtual network identifier. Applicable to VXLAN link protocol. Example: 5002
expiry `integer`	The number of days the service token is valid. Example: 89
expirationDateTime `string`	Service token expiration date timestamp in the IETF ISO 8601 extended date/time format. Example: 2023-01-20T00:22:11.831Z
notifications `array[object]`	Service token notification settings.
type `string`	Notification messages category. Example: NOTIFICATION
emails `array[string]`	Email addresses of up to 12 service token recipients. Service token is valid for a single use by one of the recipients. Example: ["mike@mspp.com","dwight@dm.com"]
account `object`	Customer account information.
orgId `string`	Customer organization identifier. Example: 94513
changeLog `object`	A permanent record of asset creation, modification, or deletion.
createdBy `string`	Identity of the asset creator. Example: AverageJoe
createdDateTime `string`	Asset creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z
project `object`	Customer resource hierarchy project information. Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId `string`	Customer project identifier. Example: 377533000114703

If you get an “Access Denied” error, contact your local Equinix Service Desk for help.

Get Specified Service Token

	GET /fabric/v4/serviceTokens/{uuid}
Method	GET
URL or Endpoint	/fabric/v4/serviceTokens/{uuid}
Headers	Authorization
Path Parameters	uuid
Query Parameters	Not applicable
Body Parameters	Not applicable

This API request retrieves a specified service token. Service tokens authorize creation of connections based on a set of predefined parameters. For more information, see Equinix Fabric: Service Tokens.

To obtain an authorization token, see the Getting Access Token section in Requesting Access and Refresh Tokens.

Sample curl request

curl -X
GET 'https://api.equinix.com/fabric/v4/serviceTokens/13c0f286-1190-480c-8a45-b3df00cad9cf'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'

Path parameters

Parameter	Description
uuid `string` REQUIRED	Service token identifier. Example: c9c67f3a-9fea-4c4a-b7e6-16e4c8c33c04

Sample response - A-side service token

{
    "href": "http://api.equinix.com/fabric/v4/serviceTokens/2025244e-aed0-4d72-b3c7-2b0e52cb3443",
    "type": "VC_TOKEN",
    "uuid": "2025244e-aed0-4d72-b3c7-2b0e52cb3443",
    "state": "INACTIVE",
    "connection": {
        "type": "EVPL_VC",
        "allowRemoteConnection": true,
        "bandwidthLimit": 1000,
        "aSide": {
            "accessPointSelectors": [
                {
                    "type": "COLO",
                    "port": {
                        "uuid": "cecd1039-eadd-add3-31e0-387a5c00aeb9"
                    },
                    "linkProtocol": {
                        "type": "QINQ",
                        "vlanCTag": 2345,
                        "vlanSTag": 1234
                    }
                }
            ]
        }
  "href": "http://api.equinix.com/fabric/v4/serviceTokens/13c0f286-1190-480c-8a45-b3df00cad9cf",
  "type": "VC_TOKEN",
  "uuid": "13c0f286-1190-480c-8a45-b3df00cad9cf",
  "state": "INACTIVE",
  "expiry": 30,
  "expirationDateTime": "2021-08-14T20:40:15.330Z",
  "connection": {
    "type": "EVPL_VC",
    "allowRemoteConnection": false,
    "uuid": "53dc2010-5006-46b6-9e91-995c47415d5b",
    "href": "http://api.equinix.com/fabric/v4/connections/53dc2010-5006-46b6-9e91-995c47415d5b",
    "bandwidthLimit": 50,
    "aSide": {
      "accessPointSelectors": [
        {
          "type": "COLO",
          "port": {
            "uuid": "bdd4f4f6-e6f9-6f98-1fe0-36da5c00a3be"
            },
          "linkProtocol": {
            "type": "DOT1Q",
            "vlanTag": 1279
            }
          }
        ]
      }
    },
    "expiry": 89,
    "expirationDateTime": "2023-02-20T00:00:00Z",
    "notifications": [
        {
            "type": "NOTIFICATION",
            "emails": [
                "service@subscriber.equinix.com",
                "service@provider.equinix.com"
            ]
        }
    ],
    "account": {
        "orgId": "91997"
    },
    "changeLog": {
        "createdBy": "902625",
        "createdDateTime": "2022-11-22T12:55:15.037Z"
    },
    "project": {
        "projectId": "377533000114703"
    }
}

Response payload body description

Parameter	Description
href `string`	An absolute URL that returns the specified asset. Example: http://api.equinix.com/fabric/v4/serviceTokens/213ee923-4099-45de-8e97-8e6021ed2761
type `string`	Type of service token. Example: VC_TOKEN - Virtual connection token
uuid `string`	Equinix-assigned service token identifier. Example: 213ee923-4099-45de-8e97-8e6021ed2761
state `string`	Lifecycle stage of a service token. Example: INACTIVE
issuerSide `string`	Token issuer side. Example: Z_side
connection `object`	Connection specification.
type `string`	Connection type. Example: EVPL_VC - Ethernet virtual private line connection.
allowRemoteConnection `boolean`	Authorization to establish connection from a different metro. Example: true
bandwidthLimit `integer`	Connection bandwidth limit in Mbps. Applicable to A-side service tokens. Example: 1000
supportedBandwidths `array[integer]`	Supported connection bandwidths in Mbps. Applicable to Z-side service tokens. Applicable values: 10 50 200 500 1000 2000 5000 10000
aSide `object`	A-side port parameters. Applicable to A-side service tokens.
accessPointSelectors `array[object]`	List of available connection endpoints.
type `string`	Connection endpoint type. Example: COLO - Colocation space in an IBX data center.
hideAssetInfo `boolean`	Hide endpoint details. Example: false
port `object`	Port parameters.
uuid `string`	Equinix-assigned port identifier. Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
linkProtocol `object`	Link protocol configuration.
type `string`	Link protocol type. Example: DOT1Q
vlanTag `integer`	DOT1Q protocol VLAN tag. Applicable to DOT1Q link protocol. Example: 2345
vlanSTag `integer`	QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines. Applicable to QINQ link protocol. Example: 123
vlanCTag `integer`	QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines. Applicable to QINQ link protocol. Example: 456
vni `integer`	Virtual network identifier. Applicable to VXLAN link protocol. Example: 5002
zSide `object`	Z-side port parameters. Applicable to Z-side service tokens.
accessPointSelectors `array[object]`	List of available connection endpoints.
type `string`	Connection endpoint type. Example: COLO - Colocation space in an IBX data center.
hideAssetInfo `boolean`	Hide endpoint details. Example: false
port `object`	Endpoint port parameters.
uuid `string`	Equinix-assigned port identifier. Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
linkProtocol `object`	Link protocol configuration.
type `string`	Link protocol type. Example: QINQ
vlanTag `integer`	DOT1Q protocol VLAN tag. Applicable to DOT1Q link protocol. Example: 123
vlanSTag `integer`	QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines. Applicable to QINQ link protocol. Example: 123
vlanCTag `integer`	QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines. Applicable to QINQ link protocol. Example: 456
vni `integer`	Virtual network identifier. Applicable to VXLAN link protocol. Example: 5002
expiry `integer`	The number of days the service token is valid. Example: 89
expirationDateTime `string`	Service token expiration date timestamp in the IETF ISO 8601 extended date/time format. Example: 2023-01-20T00:22:11.831Z
notifications `array[object]`	Service token notification settings.
type `string`	Notification messages category. Example: NOTIFICATION
emails `array[string]`	Email addresses of up to 12 service token recipients. Service token is valid for a single use by one of the recipients. Example: ["mike@mspp.com","dwight@dm.com"]
account `object`	Customer account information.
orgId `string`	Customer organization identifier. Example: 94513
changeLog `object`	A permanent record of asset creation, modification, or deletion.
createdBy `string`	Identity of the asset creator. Example: AverageJoe
createdDateTime `string`	Asset creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z
project `object`	Customer resource hierarchy project information. Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId `string`	Customer project identifier. Example: 377533000114703

If you get an “Access Denied” error, contact your local Equinix Service Desk for help.

Update Service Token

	PATCH /fabric/v4/serviceTokens/{uuid}
Method	PATCH
URL or Endpoint	/fabric/v4/serviceTokens/{uuid}
Headers	Authorization, Content-Type
Path Parameters	uuid
Query Parameters	Not applicable
Body Parameters	op, path, value

This API request modifies a service token.

Sample curl request - update expiration date

curl -X
PATCH 'https://api.equinix.com/fabric/v4/serviceTokens/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '[
    {
        "op": "replace",
        "path": "/expirationDateTime",
        "value": "2023-01-20T18:50:34.696Z"
    }
]'

Sample curl request - update Z-side service token supported connection bandwidths

curl -X
PATCH 'https://api.equinix.com/fabric/v4/serviceTokens/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '[
    {
        "op": "replace",
        "path": "/connection/supportedBandwidths",
        "value": [
            50,
            1000
        ]
    }
]'

Sample curl request - update A-side service token maximum bandwidth

curl -X
PATCH 'https://api.equinix.com/fabric/v4/serviceTokens/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '[
    {
        "op": "replace",
        "path": "/connection/bandwidthLimit",
        "value": 10
    }
]'

Sample curl request - update notification recipients

curl -X
PATCH 'https://api.equinix.com/fabric/v4/serviceTokens/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '[
    {
        "op": "replace",
        "path": "/notifications/emails",
        "value": [
            "test1@equinix.com",
            "test2@equinix.com"
        ]
    }
]'

Path parameters

Parameter	Description
uuid `string` REQUIRED	Equinix-assigned service token identifier. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

Body parameters

Parameter	Description
op `string` REQUIRED	Update reqest type. Applicable values: replace add remove
path `string` REQUIRED	Parameter path. Applicable values: /expirationDateTime /notifications/emails /connection/supportedBandwidths /connection/bandwidthLimit
value `string` REQUIRED	New parameter value.

/connection/expirationDateTime
value `string` REQUIRED	Service token expiration date. Example: 2023-01-20T18:50:34.696Z

/connection/supportedBandwidths
value `array[integer]` REQUIRED	Z-side service token allowed connection bandwidth. Example: [200, 500, 1000]

/connection/bandwidthLimit
value `integer` REQUIRED	A-side service token bandwidth limit. Example: 1000

/notifications/emails
value `array[string]` REQUIRED	Email addresses of up to 12 service token recipients. Example: ["mike@mspp.com","dwight@dm.com"]

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Sample response - A-side service token

{
    "href": "http://api.equinix.com/fabric/v4/serviceTokens/2025244e-aed0-4d72-b3c7-2b0e52cb3443",
    "type": "VC_TOKEN",
    "uuid": "2025244e-aed0-4d72-b3c7-2b0e52cb3443",
    "state": "INACTIVE",
    "connection": {
        "type": "EVPL_VC",
        "allowRemoteConnection": true,
        "bandwidthLimit": 1000,
        "aSide": {
            "accessPointSelectors": [
                {
                    "type": "COLO",
                    "port": {
                        "uuid": "cecd1039-eadd-add3-31e0-387a5c00aeb9"
                    },
                    "linkProtocol": {
                        "type": "QINQ",
                        "vlanCTag": 2345,
                        "vlanSTag": 1234
                    }
                }
            ]
        }
    },
    "expiry": 89,
    "expirationDateTime": "2023-02-20T00:00:00Z",
    "notifications": [
        {
            "type": "NOTIFICATION",
            "emails": [
                "service@subscriber.equinix.com",
                "service@provider.equinix.com"
            ]
        }
    ],
    "account": {
        "orgId": "91997"
    },
    "changeLog": {
        "createdBy": "902625",
        "createdDateTime": "2022-11-22T12:55:15.037Z",
        "updatedBy": "904885",
        "updatedDateTime": "2022-11-25T10:59:39.560Z"
    },
    "project": {
        "projectId": "377533000114703"
    }
}

Response payload body description

Parameter	Description
href `string`	An absolute URL that returns the specified asset. Example: http://api.equinix.com/fabric/v4/serviceTokens/213ee923-4099-45de-8e97-8e6021ed2761
type `string`	Type of service token. Example: VC_TOKEN - Virtual connection token
uuid `string`	Equinix-assigned service token identifier. Example: 213ee923-4099-45de-8e97-8e6021ed2761
state `string`	Lifecycle stage of a service token. Example: INACTIVE
issuerSide `string`	Token issuer side. Example: Z_side
connection `object`	Connection specification.
type `string`	Connection type. Example: EVPL_VC - Ethernet virtual private line connection.
allowRemoteConnection `boolean`	Authorization to establish connection from a different metro. Example: true
bandwidthLimit `integer`	Connection bandwidth limit in Mbps. Applicable to A-side service tokens. Example: 1000
supportedBandwidths `array[integer]`	Supported connection bandwidths in Mbps. Applicable to Z-side service tokens. Applicable values: 10 50 200 500 1000 2000 5000 10000
aSide `object`	A-side port parameters. Applicable to A-side service tokens.
accessPointSelectors `array[object]`	List of available connection endpoints.
type `string`	Connection endpoint type. Example: COLO - Colocation space in an IBX data center.
hideAssetInfo `boolean`	Hide endpoint details. Example: false
port `object`	Port parameters.
uuid `string`	Equinix-assigned port identifier. Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
linkProtocol `object`	Link protocol configuration.
type `string`	Link protocol type. Example: DOT1Q
vlanTag `integer`	DOT1Q protocol VLAN tag. Applicable to DOT1Q link protocol. Example: 2345
vlanSTag `integer`	QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines. Applicable to QINQ link protocol. Example: 123
vlanCTag `integer`	QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines. Applicable to QINQ link protocol. Example: 456
vni `integer`	Virtual network identifier. Applicable to VXLAN link protocol. Example: 5002
zSide `object`	Z-side port parameters. Applicable to Z-side service tokens.
accessPointSelectors `array[object]`	List of available connection endpoints.
type `string`	Connection endpoint type. Example: COLO - Colocation space in an IBX data center.
hideAssetInfo `boolean`	Hide endpoint details. Example: false
port `object`	Endpoint port parameters.
uuid `string`	Equinix-assigned port identifier. Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
linkProtocol `object`	Link protocol configuration.
type `string`	Link protocol type. Example: QINQ
vlanTag `integer`	DOT1Q protocol VLAN tag. Applicable to DOT1Q link protocol. Example: 123
vlanSTag `integer`	QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines. Applicable to QINQ link protocol. Example: 123
vlanCTag `integer`	QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines. Applicable to QINQ link protocol. Example: 456
vni `integer`	Virtual network identifier. Applicable to VXLAN link protocol. Example: 5002
expiry `integer`	The number of days the service token is valid. Example: 89
expirationDateTime `string`	Service token expiration date timestamp in the IETF ISO 8601 extended date/time format. Example: 2023-01-20T00:22:11.831Z
notifications `array[object]`	Service token notification settings.
type `string`	Notification messages category. Example: NOTIFICATION
emails `array[string]`	Email addresses of up to 12 service token recipients. Service token is valid for a single use by one of the recipients. Example: ["mike@mspp.com","dwight@dm.com"]
account `object`	Customer account information.
orgId `string`	Customer organization identifier. Example: 94513
changeLog `object`	A permanent record of asset creation, modification, or deletion.
createdBy `string`	Identity of the asset creator. Example: AverageJoe
createdDateTime `string`	Asset creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z
updatedBy `string`	Identity of the person who updated the asset. Example: AverageJoe
updatedDateTime `string`	Asset update timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z
project `object`	Customer resource hierarchy project information. Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId `string`	Customer project identifier. Example: 377533000114703

Delete Service Token

	DELETE /fabric/v4/serviceTokens/{uuid}
Method	DELETE
URL or Endpoint	/fabric/v4/serviceTokens/{uuid}
Headers	Authorization
Path Parameters	uuid
Query Parameters	Not applicable
Body Parameters	Not applicable

This API request deletes a specified service token. Service tokens authorize creation of connections based on a set of predefined parameters. For more information, see Equinix Fabric: Service Tokens.

To learn how to obtain an authorization token, see Requesting Access and Refresh Tokens under the Getting Access Token section.

Path parameters

Parameter	Description
uuid `string` REQUIRED	Service token identifier. Example: c9c67f3a-9fea-4c4a-b7e6-16e4c8c33c04

Sample curl request

curl -X
DELETE 'https://api.equinix.com/fabric/v4/serviceTokens/50f5dd9e-5aa0-4dca-9b80-2bbf91aca27'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'

Sample response

{
    "href": "http://api.equinix.com/fabric/v4/serviceTokens/2025244e-aed0-4d72-b3c7-2b0e52cb3443",
    "type": "VC_TOKEN",
    "uuid": "2025244e-aed0-4d72-b3c7-2b0e52cb3443",
    "state": "DELETED",
    "connection": {
        "type": "EVPL_VC",
        "allowRemoteConnection": true,
        "bandwidthLimit": 1000,
        "aSide": {
            "accessPointSelectors": [
                {
                    "type": "COLO",
                    "port": {
                        "uuid": "cecd1039-eadd-add3-31e0-387a5c00aeb9"
                    },
                    "linkProtocol": {
                        "type": "QINQ",
                        "vlanCTag": 2345,
                        "vlanSTag": 1234
                    }
                }
            ]
        }
    },
    "expiry": 89,
    "expirationDateTime": "2023-02-20T00:00:00Z",
    "notifications": [
        {
            "type": "NOTIFICATION",
            "emails": [
                "service@subscriber.equinix.com",
                "service@provider.equinix.com"
            ]
        }
    ],
    "account": {
        "orgId": "91997"
    },
    "changeLog": {
        "createdBy": "902625",
        "createdDateTime": "2022-11-22T12:55:15.037Z",
        "updatedBy": "904885",
        "updatedDateTime": "2022-11-25T10:59:39.560Z"
    },
    "project": {
        "projectId": "377533000114703"
    }
}

Response payload body description

Parameter	Description
href `string`	An absolute URL that returns the specified asset. Example: http://api.equinix.com/fabric/v4/serviceTokens/213ee923-4099-45de-8e97-8e6021ed2761
type `string`	Type of service token. Example: VC_TOKEN - Virtual connection token
uuid `string`	Equinix-assigned service token identifier. Example: 213ee923-4099-45de-8e97-8e6021ed2761
state `string`	Lifecycle stage of a service token. Example: DELETED
issuerSide `string`	Token issuer side. Example: Z_side
connection `object`	Connection specification.
type `string`	Connection type. Example: EVPL_VC - Ethernet virtual private line connection.
allowRemoteConnection `boolean`	Authorization to establish connection from a different metro. Example: true
bandwidthLimit `integer`	Connection bandwidth limit in Mbps. Applicable to A-side service tokens. Example: 1000
supportedBandwidths `array[integer]`	Supported connection bandwidths in Mbps. Applicable to Z-side service tokens. Applicable values: 10 50 200 500 1000 2000 5000 10000
aSide `object`	A-side port parameters. Applicable to A-side service tokens.
accessPointSelectors `array[object]`	List of available connection endpoints.
type `string`	Connection endpoint type. Example: COLO - Colocation space in an IBX data center.
hideAssetInfo `boolean`	Hide endpoint details. Example: false
port `object`	Port parameters.
uuid `string`	Equinix-assigned port identifier. Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
linkProtocol `object`	Link protocol configuration.
type `string`	Link protocol type. Example: DOT1Q
vlanTag `integer`	DOT1Q protocol VLAN tag. Applicable to DOT1Q link protocol. Example: 2345
vlanSTag `integer`	QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines. Applicable to QINQ link protocol. Example: 123
vlanCTag `integer`	QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines. Applicable to QINQ link protocol. Example: 456
vni `integer`	Virtual network identifier. Applicable to VXLAN link protocol. Example: 5002
zSide `object`	Z-side port parameters. Applicable to Z-side service tokens.
accessPointSelectors `array[object]`	List of available connection endpoints.
type `string`	Connection endpoint type. Example: COLO - Colocation space in an IBX data center.
hideAssetInfo `boolean`	Hide endpoint details. Example: false
port `object`	Endpoint port parameters.
uuid `string`	Equinix-assigned port identifier. Example: 195eb264-9c10-408e-ae54-92e2d58f92fe
linkProtocol `object`	Link protocol configuration.
type `string`	Link protocol type. Example: QINQ
vlanTag `integer`	DOT1Q protocol VLAN tag. Applicable to DOT1Q link protocol. Example: 123
vlanSTag `integer`	QINQ protocol, inner virtual local area network (VLAN) customer frame tag used to identify packets as they traverse trunk lines. Applicable to QINQ link protocol. Example: 123
vlanCTag `integer`	QINQ protocol, outer virtual local area network (VLAN) service frame tag used to identify packets as they traverse trunk lines. Applicable to QINQ link protocol. Example: 456
vni `integer`	Virtual network identifier. Applicable to VXLAN link protocol. Example: 5002
expiry `integer`	The number of days the service token is valid. Example: 89
expirationDateTime `string`	Service token expiration date timestamp in the IETF ISO 8601 extended date/time format. Example: 2023-01-20T00:22:11.831Z
notifications `array[object]`	Service token notification settings.
type `string`	Notification messages category. Example: NOTIFICATION
emails `array[string]`	Email addresses of up to 12 service token recipients. Service token is valid for a single use by one of the recipients. Example: ["mike@mspp.com","dwight@dm.com"]
account `object`	Customer account information.
orgId `string`	Customer organization identifier. Example: 94513
changeLog `object`	A permanent record of asset creation, modification, or deletion.
createdBy `string`	Identity of the asset creator. Example: AverageJoe
createdDateTime `string`	Asset creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z
updatedBy `string`	Identity of the person who updated the asset. Example: AverageJoe
updatedDateTime `string`	Asset update timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z
project `object`	Customer resource hierarchy project information. Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId `string`	Customer project identifier. Example: 377533000114703

If you get an “Access Denied” error, contact your local Equinix Service Desk for help.

Search for Service Tokens

	POST /fabric/v4/serviceTokens/search
Method	POST
URL or Endpoint	/fabric/v4/serviceTokens/search
Headers	Authorization
Path Parameters	Not applicable
Query Parameters	offset, limit
Body Parameters	Not applicable

Finds all service tokens for a search criteria.

Service tokens authorize you to access protected resources and services. They remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. You can distribute the tokens to trusted partners and vendors, allowing them to work directly with Equinix network assets.

To learn how to obtain an authorization token, see Requesting Access and Refresh Tokens under the Getting Access Token section.

Sample curl request

curl --location --request POST 'https://api.equinix.com/serviceTokens/search?offset=10&limit=10' \
--header 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'\
-d '{
  "filter": {
    "and": [
      {
        "property": "/uuid",
        "operator": "=",
        "values": [
          "407f8239-254c-4fe2-a378-458f197e17c4"
        ]
      }
    ]
  }
}
'

Query parameters

Parameter Name	Mandatory	Type	Example	Applicable Values	Description
offset	no	integer	?offset=<integer>	?offset=2	Index of the first item returned in the response. The value must be >=0. The default is 0.
limit	no	integer	?limit=<integer>	?limit=2	Maximum number of search results returned per page. Number must be between 1 and 100. The default is 10.

Body parameters

Parameter Name	Mandatory	Data Type	Example Values	Description
property	yes	string	/uuid	The property you want to filter by: projectId, uuid, state
operator	yes	string	=	Operator of the filtering criterion.
values	yes	string	407f8239-254c-4fe2-a378-458f197e17c4	Value of the property.

Sample response

{
  "pagination": {
    "offset": 2,
    "limit": 2,
    "total": 511,
    "next": "/serviceTokens/search?offset=4&limit=2",
    "previous": "/serviceTokens/search?offset=0&limit=2"
    },
  "data": [
    {
    "href": "http://api.equinix.com/fabric/v4/serviceTokens/c9c67f3a-9fea-4c4a-b7e6-16e4c8c33c04",
    "type": "VC_TOKEN",
    "uuid": "c9c67f3a-9fea-4c4a-b7e6-16e4c8c33c04",
    "state": "INACTIVE",
    "expiry": 30,
    "expirationDateTime": "2021-08-14T18:39:13.866Z",
    "connection": {
      "type": "EVPL_VC",
      "allowRemoteConnection": false,
      "uuid": "53dc2010-5006-46b6-9e91-995c47415d5b",
      "href": "http://api.equinix.com/fabric/v4/connections/53dc2010-5006-46b6-9e91-995c47415d5b",
      "supportedBandwidths": [
        100,
        10,
        108
        ],
      "allowCustomBandwidth": false,
      "zSide": {
        "accessPointSelectors": [
        {
          "type": "COLO",
          "port": {
            "uuid": "b840a1db-5758-758f-97e0-328a5c00a874"
            },
          "linkProtocol": {
            "type": "QINQ",
            "vlanCTag": 1399,
            "vlanSTag": 1388
            }
          }
        ]
      }
    },
    "notifications": [
      {
        "type": "NOTIFICATION",
        "emails": [
          "provider@example.com",
          "Falconsvendor1@equinix.com",
          "customer@example.com"
          ]
        }
      ],
    "account": {
      "orgId": "111437"
      },
    "changeLog": {
        "createdBy": "849817",
        "createdDateTime": "2021-07-15T18:39:13.866Z"
        }
      },

    {
    "href": "http://api.equinix.com/fabric/v4/serviceTokens/b1409597-7a84-4c23-a298-6803c089ecfa",
    "type": "VC_TOKEN",
    "uuid": "b1409597-7a84-4c23-a298-6803c089ecfa",
    "state": "ACTIVE",
    "expiry": 1,
    "expirationDateTime": "2021-07-13T19:34:53.954Z",
    "connection": {
        "type": "EVPL_VC",
        "allowRemoteConnection": true,
        "uuid": "63dc2010-5006-46b6-9e91-995c47415d5d",
        "href": "http://api.equinix.com/fabric/v4/connections/93dc2010-5006-46b6-9e91-995c47415d5c",
        "bandwidthLimit": 500,
            "aSide": {
                "accessPointSelectors": [
                    {
                    "type": "COLO",
                    "port": {
                        "uuid": "b840a1db-53eb-3ebf-97e0-328a5c00a874"
                            },
                        "linkProtocol": {
                            "type": "DOT1Q",
                            "vlanTag": 1279
                            }
                         }
                      ]
                    }
                 },
    "notifications": [
        {
        "type": "NOTIFICATION",
        "emails": [
            "provider@example.com",
            "customer@example.com"
            ]
          }
        ],
    "account": {
      "orgId": "111437"
      },
    "changeLog": {
      "createdBy": "849817",
      "createdDateTime": "2021-07-12T19:34:53.954Z",
      "updatedDateTime": "2021-07-12T19:35:57.997Z"
      }
    }
  ]
}

Response Body Description

pagination

Parameter Name	Data Type	Example Values	Description
offset	integer	?offset=2	Index of the first item returned in the response. The value must be >=0, and the default is 0.
limit	integer	?limit=2	Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 10.
total	integer	511	Total number of elements returned.
next	string	/serviceTokens?offset=4&limit=2	URL relative to the next item in the response.
previous	string	/serviceTokens?offset=0&limit=2	URL relative to the previous item in the response.

data

Parameter Name	Data Type	Example Values	Description
href	string	http://api.equinix.com/fabric/v4/serviceTokens/c9c67f3a-9fea-4c4a-b7e6-16e4c8c33c04	An absolute URL that is the subject of the link's context.
type	string	VC_TOKEN	Type of service token: VC, virtual connection
uuid	string	c9c67f3a-9fea-4c4a-b7e6-16e4c8c33c04	Equinix-assigned service token uuid, a 128-bit namespace identifier.
state	string	INACTIVE	Lifecycle stage of the service token. ACTIVE - A service token has been used to establish a connection. INACTIVE - A valid service token that hasn't been used yet. EXPIRED - A service token has reached its expiration date. DELETED - The connection established through a given service token has been deleted or the service token itself has been deleted.
expiry	integer	30	Lifespan (in days) of the service token.
expirationDateTime	string	2021-08-14T18:39:13.866Z	Expiration date and time of the service token. Use IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000 or YYYY-MM-DDTHH:MM:SSZ
connection	object	—	Specifications for establishing a data connection.
notifications	array	—	Preferences for notification of changes in service token configuration or status.
account	object	—	Your account data.
changeLog	object	—	A permanent record of service token creation, modification, or deletion.

data.connection

Parameter Name	Data Type	Example Values	Description
type	string	EVPL_VC	Type of connection: EVPL_VC, ethernet virtual private line‒virtual connection
allowRemoteConnection	boolean	false	Authorization to connect remotely.
uuid	string	53dc2010-5006-46b6-9e91-995c47415d5b	Unique Id of the connection.
href	string	http://api.equinix.com/fabric/v4/connections/53dc2010-5006-46b6-9e91-995c47415d5b	URL of the connection.
supportedBandwidths	array[integers]	100, 10, 108	List of permitted bandwidths.
allowCustomBandwidth	boolean	false	Permission to use a bandwidth not otherwise allowed or supported.
zSide	object	—	A zSide (subscriber) connection configuration.

connection.zSide

Parameter Name	Data Type	Example Values	Description
accessPointSelectors	array	—	List of criteria for selecting network access points with optimal efficiency, security, compatibility, and availability.

zSide.accessPointSelectors

Parameter Name	Data Type	Example Values	Description
type	string	COLO	Type of access point: COLO, colocation
port	object	—	Configuration details for the port used at the access point.
linkProtocol	object	—	Link protocol configuration.

zSide.accessPointSelectors.port

Parameter Name	Data Type	Example Values	Description
uuid	string	b840a1db-5758-758f-97e0-328a5c00a874	The uuid of the port used at the access point.

zSide.accessPointSelectors.linkProtocol

Parameter Name	Data Type	Example Values	Description
type	string	QINQ	Type of link protocol. Possible values: QINQ DOT1Q VXLAN
vlanTag	integer	1279	VLAN frame tag used to identify packets as they traverse trunk lines. DOT1Q protocol requires only a vlanTag.
vlanCTag	integer	1399	Virtual local area network (VLAN) inner "C" (customer) frame tag. QINQ protocol requires both a vlanCTag and a vlanSTag.
vlanSTag	integer	1388	Outer VLAN "S" (service) frame tag. QINQ protocol requires both a vlanCTag and a vlanSTag.
vni	integer	5002	Virtual network identifier. Applicable to VXLAN link protocol.

notifications

Parameter Name	Data Type	Example Values	Description
type	string	NOTIFICATION	Type of service token notifications you'd like to receive. Choosing NOTIFICATION means you'll receive service token details by email.
emails	array[string]	customer@example.com provider@example.com	Email addresses of notification recipients.

account

Parameter Name	Data Type	Example Values	Description
orgId	string	111437	Equinix-assigned organization ID.

changeLog

Parameter Name	Data Type	Example Values	Description
createdBy	string	849817	ID of the asset creator.
createdDateTime	string	2021-07-15T19:30:29.526Z	Date created. Use IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000 or YYYY-MM-DDTHH:MM:SSZ

Parameter Name	Data Type	Example Values	Description
href	string	http://api.equinix.com/fabric/v4/serviceTokens/b1409597-7a84-4c23-a298-6803c089ecfa	An absolute URL that is the subject of the link's context.
type	string	VC_TOKEN	Type of service token: VC, virtual connection
uuid	string	b1409597-7a84-4c23-a298-6803c089ecfa	Equinix-assigned service token uuid, a 128-bit namespace identifier.
state	string	ACTIVE	Lifecycle stage of the service token. ACTIVE - A service token has been used to establish a connection. INACTIVE - A valid service token that hasn't been used yet. EXPIRED - A service token has reached its expiration date. DELETED - The connection established through a given service token has been deleted or the service token itself has been deleted.
expiry	integer	1	Lifespan (in days) of the service token.
expirationDateTime	string	2021-07-13T19:34:53.954Z	Expiration date and time of the service token. Use IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000 or YYYY-MM-DDTHH:MM:SSZ
connection	object	—	Specifications for establishing a data connection.
notifications	array	—	Preferences for notification of changes in service token configuration or status.
account	object	—	Your account data.
changeLog	object	—	A permanent record of service token creation, modification, or deletion.

connection

Parameter Name	Data Type	Example Values	Description
type	string	EVPL_VC	Type of connection: EVPL_VC, ethernet virtual private line‒virtual connection
allowRemoteConnection	boolean	true	Authorization to connect remotely.
uuid	string	63dc2010-5006-46b6-9e91-995c47415d5c	Unique Id of the connection.
href	string	http://api.equinix.com/fabric/v4/connections/93dc2010-5006-46b6-9e91-995c47415d50	URL of the connection.
bandwidthLimit	integer	500	Permission to use a bandwidth not otherwise allowed or supported.
aSide	object	—	An aSide (provider) connection configuration.

connection.aSide

Parameter Name	Data Type	Example Values	Description
accessPointSelectors	array	—	Criteria for selecting network access points with optimal efficiency, security, compatibility, and availability.

aSide.accessPointSelectors

Parameter Name	Data Type	Example Values	Description
type	string	COLO	Type of access point: COLO, colocation
port	object	—	Configuration details for the port used at the access point.
linkProtocol	object	—	Link protocol configuration.

aSide.accessPointSelectors.port

Parameter Name	Data Type	Example Values	Description
uuid	string	b840a1db-5758-758f-97e0-328a5c00a874	The uuid of the port used at the access point.

aSide.accessPointSelectors.linkProtocol

Parameter Name	Data Type	Example Values	Description
type	string	DOT1Q	Type of link protocol. Possible values: QINQ DOT1Q VXLAN
vlanTag	integer	1279	VLAN frame tag used to identify packets as they traverse trunk lines. DOT1Q protocol requires only a vlanTag.
vlanCTag	integer	1399	Virtual local area network (VLAN) inner "C" (customer) frame tag. QINQ protocol requires both a vlanCTag and a vlanSTag.
vlanSTag	integer	1388	Outer VLAN "S" (service) frame tag. QINQ protocol requires both a vlanCTag and a vlanSTag.
vni	integer	5002	Virtual network identifier. Applicable to VXLAN link protocol.

notifications

Parameter Name	Data Type	Example Values	Description
type	string	NOTIFICATION	Type of service token notifications you'd like to receive. Choosing NOTIFICATION means you'll receive service token details by email.
emails	array[string]	customer@example.com provider@example.com	Email addresses of notification recipients.

account

Parameter Name	Data Type	Example Values	Description
orgId	string	111437	Equinix-assigned organization ID.

changeLog

Parameter Name	Data Type	Example Values	Description
createdBy	string	849817	ID of the asset creator.
createdDateTime	string	2021-07-15T19:30:29.526Z	Date created. Use IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000 or YYYY-MM-DDTHH:MM:SSZ

If you get an “Access Denied” error, contact your local Equinix Service Desk for help.

Statistics

Get Specified Port Statistics

	GET /fabric/v4/ports/{uuid}/stats
Method	GET
URL or Endpoint	/fabric/v4/ports/{uuid}/stats
Headers	Authorization, Content-Type
Path Parameters	uuid
Query Parameters	startDateTime, endDateTime
Body Parameters	Not applicable

This API request retrieves bandwidth utilization statistics for a specified port. This information is essential for managing service subscription sizing and bandwidth.

For instructions on how to obtain an authorization token, see Requesting Access and Refresh tokens.

Sample curl request

curl -X GET 'https://api.equinix.com/fabric/v4/ports/66I01dbf-87e8-4c1a-999c-28991799611c/stats?startDateTime=2021-01-07T19:26:22Z&endDateTime=2021-01-26T19:55:22Z'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter Name	Mandatory	Data Type	Example	Applicable Values	Description
uuid	yes	string	16c71cc5-be29-4130-8e4c-2db248bb3d5b	-	Equinix-assigned port identifier.

Query parameters

Parameter	Mandatory	Type	Example	Applicable Values	Description
startDateTime	yes	string	2021-01-07T19:26:22Z	(ISO-8601 standard date-time stamp)	Specifies start date and time of the duration for when statistics are calculated. Format of the value is YYYY-MM-DDThh:mm:ssZ.
endDateTime	yes	string	2021-01-26T19:55:22Z	(ISO-8601 standard date-time stamp)	Specifies end date and time of the duration for when statistics are calculated. Format of the value is YYYY-MM-DDThh:mm:ssZ.

Response payload

{
  "type": "XF_PORT",
  "uuid": "xxxxx191-xx70-xxxx-xx04-xxxxxxxa37xx",
  "name": "Equinix-EM-CX-xxx-L-Dot1q-BO-100G-PRI-xx",

  "bandwidth": 10000,
  "stats": {
    "startDateTime": "2021-02-24T16:00:00Z",
    "endDateTime": "2021-02-25T23:59:44Z",
    "bandwidthUtilization": {
      "unit": "Mbps",
      "metricInterval": "PT5M",
      "inbound": {
        "max": 36.46022222224523,
        "mean": 12.681258259259257,
        "lastPolled": 24.67873548,
        "metrics": [
          {
            "intervalEndDateTime": "2021-02-24T16:00:00Z",
            "max": 24.197777777777777,
            "mean": 9.460203703703565
          },
          {
            "intervalEndDateTime": "2021-02-24T16:05:00Z",
            "max": 29.237066666666667,
            "mean": 11.487487592592595
          },
          {
            "intervalEndDateTime": "2021-02-24T16:10:00Z",
            "max": 31.2726757889999,
            "mean": 11.77661203703704
          },
          {
            "intervalEndDateTime": "2021-03-04T16:15:00Z",
            "max": 28.179666666666666,
            "mean": 7.414631481481509
          },
          {
            "intervalEndDateTime": "2021-03-15T16:20:00Z",
            "max": 29.29311111111111,
            "mean": 6.247431481481508
          }
        ]
      },
      "outbound": {
        "max": 60.33548888888889,
        "mean": 41.22711543985719,
        "lastPolled": 55.14977777777778,
        "metrics": [
          {
            "intervalEndDateTime": "2021-02-24T16:00:00Z",
            "max": 53.790333333333336,
            "mean": 39.80057592592591
          },
          {
            "intervalEndDateTime": "2021-02-24T16:05:00Z",
            "max": 57.353,
            "mean": 38.678568800295
          },
          {
            "intervalEndDateTime": "2021-02-24T16:10:00Z",
            "max": 59.32777777777778,
            "mean": 35.08689444444445
          },
          {
            "intervalEndDateTime": "2021-02-24T16:15:00Z",
            "max": 537274933333333300,
            "mean": 23.855259259259284
          },
          {
            "intervalEndDateTime: "2021-02-24T16:20:00Z",
            "max": 57.75604444444444,
            "mean": 41.36731129629629
          }
        ]
      }
    }
  }
}

Response payload body description

Parameter	Data Type	Example	Description
type	string	XF_PORT	The type of port.
uuid	string	66I01dbf-87e8-4c1a-999c-28991799611c	The unique identifier of the port.
name	string	Admin-STATS-123-Abc	User-assigned name of the port.
stats	object	-	Object container for fields that detail the port statistics.

stats
startDateTime	string	2021-01-10T20:05:08Z	Start date and time of the duration for calculating statistics. Format of the value is YYYY-MM-DDThh:mm:ssZ.
endDateTime	string	2021-01-10T21:05:08Z	End date and time of the duration for calculating statistics. Format of the value is YYYY-MM-DDThh:mm:ssZ.
bandwidth	integer	10000	Port bandwidth (10000 Mbps, for example, is equal to 10 Gbps).
bandwidthUtilization	object		Object container for the fields that detail bandwidth utilization (counter is octet-based).

stats.bandwidthUtilization
unit	string	Mbps	Unit of bandwidth speed for the response. Can be either Mbps or Gbps.
metricInterval	string	PT5M	Duration from the start time to the end time for the time interval of each reported statistic. This value is in the P[n]Y[n]M[n]DT[n]H[n]M[n]S format of the ISO 8601 standard.
inbound	object		Property that indicates that the port statistics are calculated based on either traffic from the A-Side Equinix Fabric router to the buyer edge router or traffic from the Z-side Equinix Fabric router to the cloud service provider edge router, depending on the role associated with the user of the port.
outbound	object		Property that indicates that the port statistics are calculated based on either traffic from the buyer edge router to the A-side Equinix Fabric router or traffic from the cloud service provider edge router to the Z-side Equinix Fabric router, depending on the role associated with the user of the port.

stats.bandwidthUtilization.inbound
max	integer	68.38641687333333	Highest bandwidth utilization of the port among all time intervals reported in the response. The value is in either Mbps or Gbps, depending on the definition of the unit field.
mean	integer	39.96267986650665	Mean bandwidth utilization of the port among all time intervals reported in the response. The value is in either Mbps or Gbps, depending on the definition of the unit field.
lastPolled	integer	41.00905623111112	Bandwidth utilization of the last measured time interval.
metrics	array[object]		Array of objects that provide bandwidth utilization statistics for each separate time interval.

stats.bandwidthUtilization.inbound.metrics
intervalEndDateTime	string	2021-01-10T20:10:00Z	End time of a calculated interval. Format of the value is YYYY-MM-DDThh:mm:ssZ.
max	integer	42.56065261666111	Highest bandwidth utilization of a particular time interval.
mean	integer	31.52464373892222	Mean bandwidth utilization of a particular time interval.

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Get Ports Statistics

	GET /fabric/v4/ports/stats
Method	GET
URL or Endpoint	/fabric/v4/ports/stats
Headers	Authorization, Content-Type
Path Parameters	Not Applicable
Query Parameters	sort, top, duration, direction, metricInterval, metros, projectId
Body Parameters	Not applicable

This API request returns traffic statistics for ports in a specified metro.

For instructions on how to obtain an authorization token, see Requesting Access and Refresh tokens.

Sample curl request

curl -X GET 'https://api.equinix.com/fabric/v4/ports/stats?sort=bandwidthutilization&top=5&direction=inbound&metros=SV,GV&duration=P3M'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'

Query parameters

Parameter	Mandatory	Type	Example	Applicable Values	Desccription
sort	no	string	-bandwidthUtilization	-bandwidthUtilization	Key or set of keys that organizes the search payload by property (such as bandwidthUtilization) or by direction. Ascending (ASC) is the default value. The "‒" prefix indicates descending (DESC) order.
top	no	integer	5	Minimum: 1 Maximum: 10 Default: 5	Filter returning only the specified number of most heavily trafficked ports.
duration	no	string	P3M	P7D P1M P3M	Duration of statistical analysis period. Format according to IETF ISO 8601 standards: P[n]Y[n]M[n]DT[n]H[n]M[n]S P, period; Y, years; M, months; DT, dateTime; H, hours; M, minutes; S, seconds; [n] represents values.
direction	no	string	inbound	inbound outbound	Direction of traffic from the requester's viewpoint. The default is outbound.
metricInterval	no	string	P7D	P7D	An interval-formatted value indicating the time period the metric objects within the response represent. The default is P7D.
metros	yes	array[string]	SV,GV	SV,GV	Two-letter prefix indicating the metropolitan area in which a specified Equinix asset is located.
projectId	no	array[string]	2607	-	Project identifier in customer resource hierarchy.

Sample Response Body

{
    "pagination": {
        "offset": 0,
        "limit": 5,
        "total": 5
    },
    "data": [
        {
            "href": "http://api.equinix.com/fabric/v4/ports/xxxxx191-xx70-xxxx-xx04-xxxxxxxa37xx",
            "type": "XF_PORT",
            "uuid": "xxxxx191-xx70-xxxx-xx04-xxxxxxxa37xx",
            "name": "testUser-CX-SV2-NL-Dot1Q-BO-1G-PRI-JP-15",
            "bandwidth": 10000,
            "stats": {
                "startDateTime": "2020-05-21T08:00:00.000Z",
                "endDateTime": "2020-05-28T10:30:00.000Z",
                "bandwidthUtilization": {
                    "unit": "Mbps",
                    "metricInterval": "PT5M",
                    "inbound": {
                        "max": 1913400000,
                        "mean": 474960.24489120545,
                        "lastPolled": 53.333333333333336,
                        "metrics": [
                            {
                                "intervalEndDateTime": {},
                                "max": 53.333333333333336,
                                "mean": 53.333333333333336
                            },
                            {
                                "intervalEndDateTime": {},
                                "max": 53.333333333333336,
                                "mean": 53.333333333333336
                            },
                            {
                                "intervalEndDateTime": {},
                                "max": 53.333333333333336,
                                "mean": 53.333333333333336
                            },
                            {
                                "intervalEndDateTime": {},
                                "max": 53.333333333333336,
                                "mean": 53.333333333333336
                            }
                        ]
                    }
                }
            }
        },
        {
            "href": "http://api.equinix.com/fabric/v4/ports/xxxxx191-xx70-xxxx-xx04-xxxxxxxa37xx",
            "type": "XF_PORT",
            "uuid": "xxxxx191-xx70-xxxx-xx04-xxxxxxxa37xx",
            "name": "testUser-CX-SV2-NL-Dot1Q-BO-1G-PRI-JP-15",
            "bandwidth": 10000,
            "stats": {
                "startDateTime": "2020-06-21T08:00:00.000Z",
                "endDateTime": "2020-06-28T10:30:00.000Z",
                "bandwidthUtilization": {
                    "unit": "Mbps",
                    "metricInterval": "PT5M",
                    "inbound": {}
                }
            }
        },
        {
            "href": "http://api.equinix.com/fabric/v4/ports/xxxxx191-xx70-xxxx-xx04-xxxxxxxa37xx",
            "type": "XF_PORT",
            "uuid": "xxxxx191-xx70-xxxx-xx04-xxxxxxxa37xx",
            "name": "testUser-CX-SV2-NL-Dot1Q-BO-1G-PRI-JP-15",
            "bandwidth": 10000,
            "stats": {
                "startDateTime": "2020-07-21T08:00:00.000Z",
                "endDateTime": "2020-07-28T10:30:00.000Z",
                "bandwidthUtilization": {
                    "unit": "Mbps",
                    "metricInterval": "PT5M",
                    "inbound": {}
                }
            }
        },
        {
            "href": "http://api.equinix.com/fabric/v4/ports/xxxxx191-xx70-xxxx-xx04-xxxxxxxa37xx",
            "type": "XF_PORT",
            "uuid": "xxxxx191-xx70-xxxx-xx04-xxxxxxxa37xx",
            "name": "testUser-CX-SV2-NL-Dot1Q-BO-1G-PRI-JP-15",
            "bandwidth": 10000,
            "stats": {
                "startDateTime": "2020-08-21T08:00:00.000Z",
                "endDateTime": "2020-08-28T10:30:00.000Z",
                "bandwidthUtilization": {
                    "unit": "Mbps",
                    "metricInterval": "PT5M",
                    "inbound": {}
                }
            }
        },
        {
            "href": "http://api.equinix.com/fabric/v4/ports/xxxxx191-xx70-xxxx-xx04-xxxxxxxa37xx",
            "type": "XF_PORT",
            "uuid": "xxxxx191-xx70-xxxx-xx04-xxxxxxxa37xx",
            "name": "testUser-CX-SV2-NL-Dot1Q-BO-1G-PRI-JP-15",
            "bandwidth": 10000,
            "stats": {
                "startDateTime": "2020-09-21T08:00:00.000Z",
                "endDateTime": "2020-09-28T10:30:00.000Z",
                "bandwidthUtilization": {
                    "unit": "Mbps",
                    "metricInterval": "PT5M",
                    "inbound": {}
                }
            }
        }
    ]
}

Response Body Description

Parameter	Data Type	Example	Description
pagination	object	-	Data set pagination settings.
data	array[object]	-	Data array containing statistics for a set of ports determined by query parameters.

pagination
offset	integer	0	Index of the first item returned in the response.
limit	integer	20	Maximum number of items returned per page.
total	integer	44	Total number of items returned.

data[]
type	string	XF_PORT	The type of port.
uuid	string	66I01dbf-87e8-4c1a-999c-28991799611c	The unique identifier of the port.
name	string	Admin-STATS-123-Abc	User-assigned name of the port.
stats	object	-	Object container for fields that detail the port statistics.

data[].stats
startDateTime	string	2021-01-10T20:05:08Z	Start date and time of the duration for calculating statistics. Format of the value is YYYY-MM-DDThh:mm:ssZ.
endDateTime	string	2021-01-10T21:05:08Z	End date and time of the duration for calculating statistics. Format of the value is YYYY-MM-DDThh:mm:ssZ.
bandwidth	integer	10000	Port bandwidth (10000 Mbps, for example, is equal to 10 Gbps).
bandwidthUtilization	object	-	Object container for the fields that detail bandwidth utilization (counter is octet-based).

data[].stats.bandwidthUtilization
unit	string	Mbps	Unit of bandwidth speed for the response. Can be either Mbps or Gbps.
metricInterval	string	PT5M	Duration from the start time to the end time for the time interval of each reported statistic. This value is in the P[n]Y[n]M[n]DT[n]H[n]M[n]S format of the ISO 8601 standard.
inbound	object	-	Property that indicates that the port statistics are calculated based on either traffic from the A-Side Equinix Fabric router to the buyer edge router or traffic from the Z-side Equinix Fabric router to the cloud service provider edge router, depending on the role associated with the user of the port.
outbound	object	-	Property that indicates that the port statistics are calculated based on either traffic from the buyer edge router to the A-side Equinix Fabric router or traffic from the cloud service provider edge router to the Z-side Equinix Fabric router, depending on the role associated with the user of the port.

data[].stats.bandwidthUtilization.inbound/outound
max	integer	68.38641687333333	Highest bandwidth utilization of the port among all time intervals reported in the response. The value is in either Mbps or Gbps, depending on the definition of the unit field.
mean	integer	39.96267986650665	Mean bandwidth utilization of the port among all time intervals reported in the response. The value is in either Mbps or Gbps, depending on the definition of the unit field.
lastPolled	integer	41.00905623111112	Bandwidth utilization of the last measured time interval.
metrics	array[object]	-	Array of objects that provide bandwidth utilization statistics for each separate time interval.

data[].stats.bandwidthUtilization.inbound.metrics
intervalEndDateTime	string	2021-01-10T20:10:00Z	End time of a calculated interval. Format of the value is YYYY-MM-DDThh:mm:ssZ.
max	integer	42.56065261666111	Highest bandwidth utilization of a particular time interval.
mean	integer	31.52464373892222	Mean bandwidth utilization of a particular time interval.

If you get an “Access Denied” error, contact your local Equinix Service Desk for help.

Get Connection Statistics

	GET /fabric/v4/connections/{uuid}/stats
Method	GET
URL or Endpoint	/fabric/v4/connections/{uuid}/stats
Headers	Authorization, Content-Type
Path Parameters	uuid
Query Parameters	startDateTime, endDateTime, viewPoint
Body Parameters	Not applicable

The API for virtual connection (VC) statistics provides service-level traffic metrics so that you can gather key information required to manage service subscription sizing and capacity.

For an overview of how Fabric integrates different network nodes and gateways, see Virtual Connections.

Running the VC statistics API retrieves bandwidth utilization statistics about a specified virtual connection.

Buyers can view utilization data on all outgoing connections.
Sellers can view utilization data about all incoming connections.

The diagram below shows the connection infrastructure, with traffic direction, that the VC statistics API can capture as performance statistics.

VC_Stats_Flow_Chart_New

To learn how to obtain an authorization token, see Requesting Access and Refresh tokens under the Getting Access Token section.

Sample curl request

curl -X
GET "https://api.equinix.com/fabric/v4/connections/
97d1850f-4df0-468c-9281-fa7b0dfa2096/
stats?startDateTime=2021-01-07T19:26:22Z&endDateTime=2021-01-26T19:55:22Z&viewPoint=aSide"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI" 

Path parameters

Parameter Name	Mandatory	Type	Example	Applicable Values	Description
uuid	yes	string	97d1850f-4df0-468c-9281-fa7b0dfa2096		Unique identifier of the virtual connection.

Query parameters

Parameter Name	Mandatory	Type	Example	Applicable Values	Description
startDateTime	yes	string	2021-01-07T19:26:22Z	(ISO-8601 standard date-time stamp)	Specifies start date and time of the duration for when statistics are calculated. Format of the value is YYYY-MM-DDThh:mm:ssZ.
endDateTime	yes	string	2021-01-26T19:55:22Z	(ISO-8601 standard date-time stamp)	Specifies end date and time of the duration for when statistics are calculated. Format of the value is YYYY-MM-DDThh:mm:ssZ.
viewPoint	no	string	aSide	aSide zSide Default: aSide	Outgoing connection statistics are calculated based on traffic from the Equinix Fabric router (A-Side) to the customer edge router and traffic to the Equinix Fabric router (A-Side) from the customer edge router. Incoming connection statistics are calculated based on traffic from the Equinix Fabric router (Z-Side) to the provider edge router and traffic to the Equinix Fabric router (Z-Side) from the provider edge router.

Sample response

{
  "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
          }
        ]
      }
    }
  }
}

Response payload body description

Field	Data Type	Example	Description
href	string	https://api.equinix.com/fabric/v4/connections/97d1850f-4df0-468c-9281-fa7b0dfa2096	URL for virtual connection details pertaining to the uuid.
type	string	EVPL_VC	Connection type.
uuid	string	97d1850f-4df0-468c-9281-fa7b0dfa2096	The unique identifier of the connection.
name	string	Admin-STATS-123-Abc	User-assigned name to the connection.
stats	object		Object container for fields that detail the virtual connection statistics.
stats object
stats	object		Object container for fields that detail the virtual connection statistics.
startDateTime	string	2021-01-10T20:05:08Z	Start date and time of the duration for calculating statistics. Format of the value is YYYY-MM-DDThh:mm:ssZ.
endDateTime	string	2021-01-10T21:05:08Z	End date and time of the duration for calculating statistics. Format of the value is YYYY-MM-DDThh:mm:ssZ.
viewPoint	string	aSide	Point of view for connection metrics.
bandwidthUtilization	object		Object container for the fields that detail bandwidth utilization (counter is octet-based).
stats.bandwidthUtilization object
bandwidthUtilization	object		Object container for the fields that detail bandwidth utilization (counter is octet-based).
unit	string	Mbps	Unit of bandwidth speed for the response. Can be either Mbps or Gbps
metricInterval	string	PT5M	Duration from the start time to the end time for the time interval of each reported statistic. This value is in the P[n]Y[n]M[n]DT[n]H[n]M[n]S format of the ISO 8601 standard.
inbound	object		Property that indicates that the connection statistics are calculated based on either traffic from the A-Side Equinix Fabric router to the buyer edge router or traffic from the Z-side Equinix Fabric router to the cloud service provider edge router, depending on the role associated with the user of the connection.
outbound	object		Property that indicates that the connection statistics are calculated based on either traffic from the buyer edge router to the A-side Equinix Fabric router or traffic from the cloud service provider edge router to the Z-side Equinix Fabric router, depending on the role associated with the user of the connection.
stats.bandwidthUtilization.inbound object
inbound	object		Property that indicates that the connection statistics are calculated based on either traffic from the A-Side Equinix Fabric router to the buyer edge router or traffic from the Z-side Equinix Fabric router to the cloud service provider edge router, depending on the role associated with the user of the connection.
max	double	68.38641687333333	Highest bandwidth utilization of the connection among all time intervals reported in the response. The value is in either Mbps or Gbps, depending on the definition of the unit field.
mean	double	39.96267986650665	Mean bandwidth utilization of the connection among all time intervals reported in the response. The value is in either Mbps or Gbps, depending on the definition of the unit field.
lastPolled	double	41.00905623111112	Bandwidth utilization of the last measured time interval.
metrics	array[object]		Array of objects that provide bandwidth utilization statistics for each separate time interval.
stats.bandwidthUtilization.inbound.metrics object
metrics	array[object]		Array of objects that provide bandwidth utilization statistics for each separate time interval.
intervalEndDateTime	string	2021-01-10T20:10:00Z	End time of a calculated interval. Format of the value is YYYY-MM-DDThh:mm:ssZ.
max	double	42.56065261666111	Highest bandwidth utilization of a particular time interval.
mean	double	31.52464373892222	Mean bandwidth utilization of a particular time interval.

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Fabric Networks

Fabric network enables creating port-based or a VLAN-based Layer 2 Ethernet multipoint to multipoint networks that connect your assets deployed across Equinix IBX data centers.

Create Fabric Network

	POST /fabric/v4/networks
Method	POST
URL or Endpoint	/fabric/v4/networks
Headers	Authorization, Content-Type
Path Parameters	Not applicable
Query Parameters	Not applicable
Body Parameters	type, name, scope, project, notifications

This API request creates a Fabric network instance.

To obtain an authorization token, see the Getting Access Token section under Requesting Access and Refresh Tokens.

Sample curl request - regional network

curl -X POST 'https://api.equinix.com/fabric/v4/networks'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'
-d '{
    "type": "IPVPN",
    "name": "My-Network-1",
    "scope": "REGIONAL",
    "location": {
        "region": "EMEA"
    },
    "project": {
        "projectId": "1234567"
    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "test@equinix.com"
            ]
        }
    ]
}'

Body parameters

Parameter	Description
type `string` REQUIRED	Network type. Applicable values: EVPLAN - For connecting to DOT1Q ports or virtual devices. EPLAN - For connecting to EPL ports. IPVPN - For connecting to Fabric Cloud Routers.
name `string` REQUIRED	Network name. Example: myEmeaNetwork
scope `string` REQUIRED	Network geographic scope. Applicable values: LOCAL - within a metro REGIONAL - within a region GLOBAL - across all regions/metros
location `object` CONDITIONAL	Geographic attributes of the network. Applicable to regional networks.
region `string` REQUIRED	Broad geographic region. Example: EMEA
project `object` OPTIONAL	Customer resource hierarchy project information. Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId `string` OPTIONAL	Customer project identifier. Example: 567
notifications `array[object]` REQUIRED	Notification settings for messages related to the asset configuration or its status.
type `string` REQUIRED	Notification messages category. Applicable values: ALL
emails `array[string]` REQUIRED	Email addresses of up to 12 recipients. Example: ["mike@mspp.com","dwight@dm.com"]

Sample response

{
    "href": "https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784",
    "type": "IPVPN",
    "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_CREATION"
    },
    "location": {
        "region": "EMEA"
    },
    "scope": "REGIONAL",
    "connectionsCount": 0,
    "project": {
        "projectId": "123456"
    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "test@equinix.com"
            ]
        }
    ],
    "operation": {
        "equinixStatus": "PROVISIONING"
    },
    "changeLog": {
        "createdBy": "testuser",
        "createdDateTime": "2020-05-21T10:30:00Z",
        "createdByEmail": "testuser@equinix.com",
        "createdByFullName": "testuser testuser"
    }
}

Response payload body description

Parameter	Description
href `string`	Absolute URL that returns the specified asset. Example: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784
type `string`	Network type. Possible values: EVPLAN - For connecting to DOT1Q ports or virtual devices. EPLAN - For connecting to EPL ports. IPVPN - For connecting to Fabric Cloud Routers.
uuid `string`	Network instance identifier. Example: 92dc376a-a932-43aa-a6a2-c806dedbd784
name `string`	Network name. Example: myEmeaNetwork
state `string`	Network lifecycle stage. Example: INACTIVE
change `object`	Information on asset change operation.
href `string`	Absolute URL that returns asset change operation. Example: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784/changes/6d500177-9404-41f2-99e8-2bf1a84d8db5
uuid `string`	Asset change operation identifier. Example: 6d500177-9404-41f2-99e8-2bf1a84d8db5
type `string`	Asset change operation type. Example: NETWORK_CREATION
location `object`	Geographic attributes of the network. Applicable to regional networks.
region `string`	Broad geographic region. Example: EMEA
scope `string`	Network geographic scope. Possible values: LOCAL - within a metro REGIONAL - within a region GLOBAL - across all regions/metros
connectionsCount `integer`	Number of connections associated with this network. Example: 0
project `object`	Customer resource hierarchy project information. Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId `string`	Customer project identifier. Example: 567
notifications `array[object]`	Notification settings for messages related to the asset configuration or its status.
type `string`	Notification messages category. Possible values: ALL
emails `array[string]`	Email addresses of up to 12 recipients. Example: ["mike@mspp.com","dwight@dm.com"]
operation `object`	Network operational status.
equinixStatus `string`	Progress towards provisioning a given asset. Example: PROVISIONING
changeLog `object`	A permanent record of asset creation, modification, or deletion.
createdBy `string`	Identity of the asset creator. Example: AverageJoe
createdByFullName `string`	First and last name of the asset creator. Example: Joe Average
createdByEmail `string`	Email address of the asset creator. Example: joe@average.org
createdDateTime `string`	Asset creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z

Get Specified Fabric Network

	GET /fabric/v4/networks/{uuid}
Method	GET
URL or Endpoint	/fabric/v4/networks/{uuid}
Headers	Authorization
Path Parameters	uuid
Query Parameters	Not applicable
Body Parameters	Not applicable

This API request returns details for the specified Fabric network instance.

To obtain an authorization token, see the Getting Access Token section under Requesting Access and Refresh Tokens.

Sample curl request

curl -X GET 'https://api.equinix.com/fabric/v4/networks/13c0f286-1190-480c-8a45-b3df00cad9cf'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'

Path parameters

Parameter	Description
uuid `string` REQUIRED	Fabric network instance identifier.

Sample response

{
    "href": "https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784",
    "type": "IPVPN",
    "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",
        "createdByEmail": "testuser@equinix.com",
        "createdByFullName": "testuser testuser",
        "updatedBy": "testuser",
        "updatedDateTime": "2020-05-21T10:30:00Z",
        "updatedByEmail": "testuser@equinix.com",
        "updatedByFullName": "testuser testuser"
    },
    "links": [
        {
            "href": "https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784/connections",
            "rel": "getConnectionsByNetworkUuid",
            "method": "GET",
            "contentType": "application/json",
            "authenticate": true
        }
    ]
}

Response payload body description

Parameter	Description
href `string`	Absolute URL that returns the specified asset. Example: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784
type `string`	Network type. Possible values: EVPLAN - For connecting to DOT1Q ports or virtual devices. EPLAN - For connecting to EPL ports. IPVPN - For connecting to Fabric Cloud Routers.
uuid `string`	Network instance identifier. Example: 92dc376a-a932-43aa-a6a2-c806dedbd784
name `string`	Network name. Example: myEmeaNetwork
state `string`	Network lifecycle stage. Example: ACTIVE
change `object`	Information on asset change operation.
href `string`	Absolute URL that returns asset change operation. Example: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784/changes/6d500177-9404-41f2-99e8-2bf1a84d8db5
uuid `string`	Asset change operation identifier. Example: 6d500177-9404-41f2-99e8-2bf1a84d8db5
type `string`	Asset change operation type. Example: NETWORK_CREATION
location `object`	Geographic attributes of the network. Applicable to regional networks.
region `string`	Broad geographic region. Example: EMEA
scope `string`	Network geographic scope. Possible values: LOCAL - within a metro REGIONAL - within a region GLOBAL - across all regions/metros
connectionsCount `integer`	Number of connections associated with this network. Example: 0
project `object`	Customer resource hierarchy project information. Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId `string`	Customer project identifier. Example: 567
notifications `array[object]`	Notification settings for messages related to the asset configuration or its status.
type `string`	Notification messages category. Possible values: ALL
emails `array[string]`	Email addresses of up to 12 recipients. Example: ["mike@mspp.com","dwight@dm.com"]
operation `object`	Network operational status.
equinixStatus `string`	Progress towards provisioning a given asset. Example: PROVISIONED
changeLog `object`	A permanent record of asset creation, modification, or deletion.
createdBy `string`	Identity of the asset creator. Example: AverageJoe
createdByFullName `string`	First and last name of the asset creator. Example: Joe Average
createdByEmail `string`	Email address of the asset creator. Example: joe@average.org
createdDateTime `string`	Asset creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z
links `object`	HATEOAS links specifying possible follow-up interactions.

If you get an “Access Denied” error, contact your local Equinix Service Desk for help.

Update Fabric Network

	PATCH /fabric/v4/networks/{uuid}
Method	PATCH
URL or Endpoint	/fabric/v4/networks/{uuid}
Headers	Authorization, Content-Type
Path Parameters	uuid
Query Parameters	Not applicable
Body Parameters	op, path, value

This API request updates a Fabric network instance.

To obtain an authorization token, see the Getting Access Token section under Requesting Access and Refresh Tokens.

Sample curl request

curl -X PATCH 'https://api.equinix.com/fabric/v4/networks/13c0f286-1190-480c-8a45-b3df00cad9cf'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'
-d '[
    {
        "op": "replace",
        "path": "/name",
        "value": "evenBetterName"
    }
]'

Path parameters

Parameter	Description
uuid `string` REQUIRED	Fabric network instance identifier.

Body parameters

Parameter	Description
op `string` REQUIRED	Update request type. Applicable values: replace add remove
path `string` REQUIRED	Parameter path. Applicable values: /name
value `string` REQUIRED	Parameter value.

Sample response

{
    "href": "https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784",
    "type": "IPVPN",
    "uuid": "92dc376a-a932-43aa-a6a2-c806dedbd784",
    "name": "evenBetterName",
    "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",
        "createdByEmail": "testuser@equinix.com",
        "createdByFullName": "testuser testuser",
        "updatedBy": "testuser",
        "updatedDateTime": "2020-05-21T10:30:00Z",
        "updatedByEmail": "testuser@equinix.com",
        "updatedByFullName": "testuser testuser"
    },
    "links": [
        {
            "href": "https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784/connections",
            "rel": "getConnectionsByNetworkUuid",
            "method": "GET",
            "contentType": "application/json",
            "authenticate": true
        }
    ]
}

Response payload body description

Parameter	Description
href `string`	Absolute URL that returns the specified asset. Example: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784
type `string`	Network type. Possible values: EVPLAN - For connecting to DOT1Q ports or virtual devices. EPLAN - For connecting to EPL ports. IPVPN - For connecting to Fabric Cloud Routers.
uuid `string`	Network instance identifier. Example: 92dc376a-a932-43aa-a6a2-c806dedbd784
name `string`	Network name. Example: evenBetterName
state `string`	Network lifecycle stage. Example: ACTIVE
change `object`	Information on asset change operation.
href `string`	Absolute URL that returns asset change operation. Example: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784/changes/6d500177-9404-41f2-99e8-2bf1a84d8db5
uuid `string`	Asset change operation identifier. Example: 6d500177-9404-41f2-99e8-2bf1a84d8db5
type `string`	Asset change operation type. Example: NETWORK_UPDATE
location `object`	Geographic attributes of the network. Applicable to regional networks.
region `string`	Broad geographic region. Example: EMEA
scope `string`	Network geographic scope. Possible values: LOCAL - within a metro REGIONAL - within a region GLOBAL - across all regions/metros
connectionsCount `integer`	Number of connections associated with this network. Example: 0
project `object`	Customer resource hierarchy project information. Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId `string`	Customer project identifier. Example: 567
notifications `array[object]`	Notification settings for messages related to the asset configuration or its status.
type `string`	Notification messages category. Possible values: ALL
emails `array[string]`	Email addresses of up to 12 recipients. Example: ["mike@mspp.com","dwight@dm.com"]
operation `object`	Network operational status.
equinixStatus `string`	Progress towards provisioning a given asset. Example: PROVISIONED
changeLog `object`	A permanent record of asset creation, modification, or deletion.
createdBy `string`	Username of the asset creator. Example: AverageJoe
createdByFullName `string`	First and last name of the asset creator. Example: Joe Average
createdByEmail `string`	Email address of the asset creator. Example: joe@average.org
createdDateTime `string`	Asset creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z
updatedBy `string`	Username of the user that modified the asset. Example: AverageJoe
updatedByFullName `string`	First and last name of the user that modified the asset. Example: Joe Average
updatedByEmail `string`	Email address of the user that modified the asset. Example: joe@average.org
updatedDateTime `string`	Asset update timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z
links `object`	HATEOAS links specifying possible follow-up interactions.

If you get an “Access Denied” error, contact your local Equinix Service Desk for help.

Retrieve Fabric Networks

	POST /fabric/v4/networks/search
Method	POST
URL or Endpoint	/fabric/v4/networks/search
Headers	Authorization, Content-Type
Path Parameters	Not applicable
Query Parameters	Not applicable
Body Parameters	type, name, scope, project, notifications

This API request returns Fabric network instances that match the specified criteria.

To obtain an authorization token, see the Getting Access Token section under Requesting Access and Refresh Tokens.

Sample curl request

curl -X POST 'https://api.equinix.com/fabric/v4/networks/search'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'
-d '{
    "filter": {
        "and": [
            {
                "property": "/state",
                "operator": "=",
                "values": [
                    "ACTIVE"
                ]
            }
        ]
    },
    "pagination": {
        "offset": 0,
        "limit": 20
    },
    "sort": [
        {
            "direction": "DESC",
            "property": "/changeLog/createdDateTime"
        }
    ]
}'

Body parameters

Parameter	Description
filter `object` REQUIRED	Object defining search conditions.
and `array[object]` REQUIRED	Array of up to eight search parameters.
property `string` REQUIRED	Search parameter. Applicable values: /name /uuid /state /scope /location/region /project/projectId /* - All categories search.
operator `string` REQUIRED	Search parameter operator. Applicable values: = != > >= < <= BETWEEN NOT BETWEEN LIKE NOT LIKE IN NOT IN ~* - Case insensitive like.
values `string` REQUIRED	Search field parameter value. Example: ACTIVE
pagination `object` OPTIONAL	Search results pagination settings.
offset `integer` OPTIONAL	Index of the first item returned in the response. Minimum: 0 Default value: 0
limit `integer` OPTIONAL	Maximum number of items returned per page. Minimum: 1 Maximum: 100 Default value: 20
sort `object` OPTIONAL	Search results sorting settings.
direction `string` OPTIONAL	Search results sorting direction. Applicable values: ASC DESC
property `string` OPTIONAL	Search results sorting parameter. Applicable values: /name /uuid /scope /location/region /project/projectId /changeLog/createdDateTime /changeLog/updatedDateTime Default value: /changeLog/updatedDateTime

Sample response

{
    "pagination": {
        "offset": 0,
        "limit": 0,
        "total": 0,
        "next": "string",
        "previous": "string"
    },
    "data": [
        {
            "href": "https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784",
            "type": "IPVPN",
            "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_CREATION"
            },
            "location": {
                "region": "EMEA"
            },
            "scope": "REGIONAL",
            "connectionsCount": 0,
            "project": {
                "projectId": "123456"
            },
            "notifications": [
                {
                    "type": "ALL",
                    "emails": [
                        "test@equinix.com"
                    ]
                }
            ],
            "operation": {
                "equinixStatus": "PROVISIONING"
            },
            "changeLog": {
                "createdBy": "testuser",
                "createdDateTime": "2020-05-21T10:30:00Z",
                "createdByEmail": "testuser@equinix.com",
                "createdByFullName": "testuser testuser"
            }
        }
    ],
    "sort": [
        {
            "property": "/changeLog/updatedDateTime",
            "direction": "DESC"
        }
    ]
}

Response payload body description

Parameter	Description
pagination `object`	Search results pagination settings.
offset `integer`	Index of the first item returned in the response. Example: 20
limit `integer`	Maximum number of items returned per page. Example: 20
total `integer`	Total number of items returned. Example: 1
data `array[object]`	Data array containing search results.
href `string`	Absolute URL that returns the specified asset. Example: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784
type `string`	Network type. Possible values: EVPLAN - For connecting to DOT1Q ports or virtual devices. EPLAN - For connecting to EPL ports. IPVPN - For connecting to Fabric Cloud Routers.
uuid `string`	Network instance identifier. Example: 92dc376a-a932-43aa-a6a2-c806dedbd784
name `string`	Network name. Example: myEmeaNetwork
state `string`	Network lifecycle stage. Example: INACTIVE
change `object`	Information on asset change operation.
href `string`	Absolute URL that returns asset change operation. Example: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784/changes/6d500177-9404-41f2-99e8-2bf1a84d8db5
uuid `string`	Asset change operation identifier. Example: 6d500177-9404-41f2-99e8-2bf1a84d8db5
type `string`	Asset change operation type. Example: NETWORK_CREATION
location `object`	Geographic attributes of the network. Applicable to regional networks.
region `string`	Broad geographic region. Example: EMEA
scope `string`	Network geographic scope. Possible values: LOCAL - within a metro REGIONAL - within a region GLOBAL - across all regions/metros
connectionsCount `integer`	Number of connections associated with this network. Example: 0
project `object`	Customer resource hierarchy project information. Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId `string`	Customer project identifier. Example: 567
notifications `array[object]`	Notification settings for messages related to the asset configuration or its status.
type `string`	Notification messages category. Possible values: ALL
emails `array[string]`	Email addresses of up to 12 recipients. Example: ["mike@mspp.com","dwight@dm.com"]
operation `object`	Network operational status.
equinixStatus `string`	Progress towards provisioning a given asset. Example: PROVISIONING
changeLog `object`	A permanent record of asset creation, modification, or deletion.
createdBy `string`	Identity of the asset creator. Example: AverageJoe
createdByFullName `string`	First and last name of the asset creator. Example: Joe Average
createdByEmail `string`	Email address of the asset creator. Example: joe@average.org
createdDateTime `string`	Asset creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z

Delete Fabric Network

	DELETE /fabric/v4/networks/{uuid}
Method	DELETE
URL or Endpoint	/fabric/v4/networks/{uuid}
Headers	Authorization
Path Parameters	uuid
Query Parameters	Not applicable
Body Parameters	Not applicable

This API request deletes a given Fabric network instance.

To obtain an authorization token, see the Getting Access Token section under Requesting Access and Refresh Tokens.

Sample curl request

curl -X DELETE 'https://api.equinix.com/fabric/v4/networks/13c0f286-1190-480c-8a45-b3df00cad9cf'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'

Path parameters

Parameter	Description
uuid `string` REQUIRED	Fabric network instance identifier.

Sample response

{
    "href": "https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784",
    "type": "IPVPN",
    "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",
    "connectionsCount": 0,
    "project": {
        "projectId": "123456"
    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "test@equinix.com"
            ]
        }
    ],
    "operation": {
        "equinixStatus": "DEPROVISIONING"
    },
    "changeLog": {
        "createdBy": "testuser",
        "createdDateTime": "2020-05-21T10:30:00Z",
        "createdByEmail": "testuser@equinix.com",
        "createdByFullName": "testuser testuser",
        "deletedBy": "testuser1",
        "deletedDateTime": "2020-05-21T10:30:00Z",
        "deletedByEmail": "testuser@equinix.com",
        "deletedByFullName": "testuser testuser"
    }
}

Response payload body description

Parameter	Description
href `string`	Absolute URL that returns the specified asset. Example: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784
type `string`	Network type. Possible values: EVPLAN - For connecting to DOT1Q ports or virtual devices. EPLAN - For connecting to EPL ports. IPVPN - For connecting to Fabric Cloud Routers.
uuid `string`	Network instance identifier. Example: 92dc376a-a932-43aa-a6a2-c806dedbd784
name `string`	Network name. Example: myEmeaNetwork
state `string`	Network lifecycle stage. Example: INACTIVE
change `object`	Information on asset change operation.
href `string`	Absolute URL that returns asset change operation. Example: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784/changes/6d500177-9404-41f2-99e8-2bf1a84d8db5
uuid `string`	Asset change operation identifier. Example: 6d500177-9404-41f2-99e8-2bf1a84d8db5
type `string`	Asset change operation type. Example: NETWORK_DELETION
location `object`	Geographic attributes of the network. Applicable to regional networks.
region `string`	Broad geographic region. Example: EMEA
scope `string`	Network geographic scope. Possible values: LOCAL - within a metro REGIONAL - within a region GLOBAL - across all regions/metros
connectionsCount `integer`	Number of connections associated with this network. Example: 0
project `object`	Customer resource hierarchy project information. Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId `string`	Customer project identifier. Example: 567
notifications `array[object]`	Notification settings for messages related to the asset configuration or its status.
type `string`	Notification messages category. Possible values: ALL
emails `array[string]`	Email addresses of up to 12 recipients. Example: ["mike@mspp.com","dwight@dm.com"]
operation `object`	Network operational status.
equinixStatus `string`	Progress towards provisioning a given asset. Example: DEPROVISIONING
changeLog `object`	A permanent record of asset creation, modification, or deletion.
createdBy `string`	Identity of the asset creator. Example: AverageJoe
createdByFullName `string`	First and last name of the asset creator. Example: Joe Average
createdByEmail `string`	Email address of the asset creator. Example: joe@average.org
createdDateTime `string`	Asset creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z
deletedBy `string`	Usernamen of the user that deleted the asset. Example: AverageJoe
deletedByFullName `string`	First and last name of the user that deleted the asset. Example: Joe Average
deletedByEmail `string`	Email address of the user that deleted the asset. Example: joe@average.org
deletedDateTime `string`	Asset deletion timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z

If you get an “Access Denied” error, contact your local Equinix Service Desk for help.

Get Connections Associated With Specified Fabric Network

	GET /fabric/v4/networks/{uuid}/connections
Method	GET
URL or Endpoint	/fabric/v4/networks/{uuid}/connections
Headers	Authorization
Path Parameters	uuid
Query Parameters	Not applicable
Body Parameters	Not applicable

This API request returns connections associated with the specified Fabric network instance.

To obtain an authorization token, see the Getting Access Token section under Requesting Access and Refresh Tokens.

Sample curl request

curl -X GET 'https://api.equinix.com/fabric/v4/networks/13c0f286-1190-480c-8a45-b3df00cad9cf/connections'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'

Path parameters

Parameter	Description
uuid `string` REQUIRED	Fabric network instance identifier.

Sample response

{
    "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"
        }
    ]
}

Response payload body description

Parameter	Description
pagination `object`	Search results pagination settings.
offset `integer`	Index of the first item returned in the response. Example: 20
limit `integer`	Maximum number of items returned per page. Example: 20
total `integer`	Total number of items returned. Example: 1
data `array[object]`	Data array containing search results.
href `string`	Absolute URL that returns the specified asset. Example: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784
type `string`	Connection type. Example: IP_VC
uuid `string`	Connection identifier. Example: 38a1eb68-4daf-4ef0-bd7f-6970727b6fc1

If you get an “Access Denied” error, contact your local Equinix Service Desk for help.

Get Fabric Network Changes

	GET /fabric/v4/networks/{uuid}/changes
Method	GET
URL or Endpoint	/fabric/v4/networks/{uuid}/changes
Headers	Authorization
Path Parameters	uuid
Query Parameters	Not applicable
Body Parameters	Not applicable

This API request returns change log for a specified Fabric network instance.

To obtain an authorization token, see the Getting Access Token section under Requesting Access and Refresh Tokens.

Sample curl request

curl -X GET 'https://api.equinix.com/fabric/v4/networks/13c0f286-1190-480c-8a45-b3df00cad9cf/changes'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'

Path parameters

Parameter	Description
uuid `string` REQUIRED	Fabric network instance identifier.

Sample response

{
    "pagination": {
        "offset": 0,
        "limit": 20,
        "total": 2
    },
    "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"
        }
    ]
}

Response payload body description

Parameter	Description
pagination `object`	Search results pagination settings.
offset `integer`	Index of the first item returned in the response. Example: 20
limit `integer`	Maximum number of items returned per page. Example: 20
total `integer`	Total number of items returned. Example: 2
data `array[object]`	Data array containing search results.
href `string`	Absolute URL that returns the details of the given change. Example: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784
type `string`	Asset instance change request type. Example: NETWORK_CREATION
uuid `string`	Asset change request identifier. Example: 38a1eb68-4daf-4ef0-bd7f-6970727b6fc1
status `string`	Asset change request status. Example: COMPLETED
createdDateTime `string`	Change request creation timestamp in the IETF ISO 8601 extended date/time format. Example: 2021-07-15T19:30:29.526Z
updatedDateTime `string`	Change request update timestamp in the IETF ISO 8601 extended date/time format. Example: 2021-07-15T19:30:29.526Z

If you get an “Access Denied” error, contact your local Equinix Service Desk for help.

Get Specified Fabric Network Change

	GET /fabric/v4/networks/{networkUuid}/changes/{changeUuid}
Method	GET
URL or Endpoint	/fabric/v4/networks/{networkUuid}/changes/{changeUuid}
Headers	Authorization
Path Parameters	uuid
Query Parameters	Not applicable
Body Parameters	Not applicable

This API request returns a specified changelog item for a given Fabric network instance.

To obtain an authorization token, see the Getting Access Token section under Requesting Access and Refresh Tokens.

Sample curl request

curl -X GET 'https://api.equinix.com/fabric/v4/networks/13c0f286-1190-480c-8a45-b3df00cad9cf/changes/4b17da68-3d6b-436d-9c8f-2105f3b950d9'
-H 'Authorization: Bearer 000aI9YU3IRxFjQsuSyVhBSvfQAo'

Path parameters

Parameter	Description
networkUuid `string` REQUIRED	Fabric network instance identifier.
changeUuid `string` REQUIRED	Changelog item identifier.

Sample response

{
    "pagination": {
        "offset": 0,
        "limit": 20,
        "total": 2
    },
    "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"
        }
    ]
}

Response payload body description

Parameter	Description
href `string`	Absolute URL that returns the details of the given change. Example: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784
type `string`	Asset instance change request type. Example: NETWORK_CREATION
uuid `string`	Asset change request identifier. Example: 38a1eb68-4daf-4ef0-bd7f-6970727b6fc1
status `string`	Asset change request status. Example: COMPLETED
createdDateTime `string`	Change request creation timestamp in the IETF ISO 8601 extended date/time format. Example: 2021-07-15T19:30:29.526Z
updatedDateTime `string`	Change request update timestamp in the IETF ISO 8601 extended date/time format. Example: 2021-07-15T19:30:29.526Z

If you get an “Access Denied” error, contact your local Equinix Service Desk for help.

Precision Time

Get Time Service

	GET /fabric/v4/timeServices/{serviceId}
Method	GET
URL or Endpoint	/fabric/v4/timeServices/{serviceId}
Headers	Authorization
Path Parameters	serviceId
Query Parameters	Not applicable
Body Parameters	Not applicable

Returns precision time service details.

For instructions on how to obtain an authorization token, refer to Requesting Access and Refresh Tokens.

Sample curl request

curl -X
GET 'https://api.equinix.com/fabric/v4/timeServices/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter	Description
uuid `string` REQUIRED	Equinix-assigned service Id.

Sample response

{
  "href": "https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011",
  "uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
  "name": "EPT-Single-Service",
  "type": "NTP",
  "state": "PROVISIONING",
  "connections": [
    {
      "href": "https://api.equinix.com/fabric/v4/connections/a8ba52de-faae-43b5-b0b1-6904d37ee011",
      "uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0"
    }
  ],
  "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.240",
    "defaultGateway": "192.168.0.1"
  },
  "account": {
    "accountNumber": 123456
  }
}

Response payload body description

Parameter	Description
href `string`	An absolute URL that has the location of the EPT service. Example: https://api.equinix.com/fabric/v4/timeServices/3a58dd05-f46d-4b1d-a154-2e85c396ea62
uuid `string`	Equinix-assigned time service identifier. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
name `string`	Time service name. Example: EPT-Single-Service
type `string`	Type of time service. Example: NTP. PTP
state `string`	State of the time service. Example: PROVISIONED. PROVISIONING, PROVISIONING_FAILED, CONFIGURING, CANCELLED, DEPROVISIONING_FAILED, PENDING_CONFIGURATION, DEPROVISIONED, CONFIGURING_FAILED, DEPROVISIONING
connections `array`	An array of connection objects.
href `string`	An absolute URL that has the location of the connection. Example: https://api.equinix.com/fabric/v4/connections/4a58dd05-f46d-4b1d-a154-2e85c396ea54
uuid `string`	Unique identifier of the connection. Example: 06dbb0e3-e55d-4090-8aff-fc5654abaad0
package `object`	Package details.
href `string`	An absolute URL that has the location of the package. Example: https://api.equinix.com/fabric/v4/timeServicePackages/NTP_STANDARD
code `string`	Cloud router package code. Example: NTP_STANDARD
ipv4 `object`	EPT service network information.
primary `string`	Primary ipv4. Example: 192.168.0.2
secondary `string`	Secondary ipv4. Example: 192.168.0.3
networkMask `string`	Network mask. Example: 255.255.255.240
defaultGateway `string`	Default gateway. Example: 192.168.0.1
account `object`	Customer account information.
accountNumber `integer`	Equinix-assigned account number. Example: 270106

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Delete Time Service

	DELETE /fabric/v4/timeServices/{serviceId}
Method	DELETE
URL or Endpoint	/fabric/v4/timeServices/{serviceId}
Headers	Authorization
Path Parameters	serviceId
Query Parameters	Not applicable
Body Parameters	Not applicable

Deletes precision time service by its unique identifier.

For instructions on how to obtain an authorization token, refer to Requesting Access and Refresh Tokens.

Sample curl request

curl -X
DELETE 'https://api.equinix.com/fabric/v4/timeServices/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter	Description
uuid `string` REQUIRED	Equinix-assigned service Id.

Sample response

{
  "href": "https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011",
  "uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
  "name": "EPT-Single-Service",
  "type": "NTP",
  "state": "PROVISIONING",
  "connections": [
    {
      "href": "https://api.equinix.com/fabric/v4/connections/a8ba52de-faae-43b5-b0b1-6904d37ee011",
      "uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0"
    }
  ],
  "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.240",
    "defaultGateway": "192.168.0.1"
  },
  "account": {
    "accountNumber": 123456
  }
}

Refer to the response of Get Time Service for the field descriptions.

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Patch Time Service

	PATCH /fabric/v4/timeServices/{serviceId}
Method	PATCH
URL or Endpoint	/fabric/v4/timeServices/{serviceId}
Headers	Authorization
Path Parameters	serviceId
Query Parameters	Not applicable
Body Parameters	op, path, value

Updates time service parameters by ihe unique identifier of the service.

For instructions on how to obtain an authorization token, refer to Requesting Access and Refresh Tokens.

Sample curl request

curl -X
PATCH 'https: //api.equinix.com/fabric/v4/timeServices/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '[
    {
        "op": "replace",
        "path": "/name",
        "value": "EPT-Single-Service"
    }
]'

Path parameters

Parameter	Description
uuid `string` REQUIRED	Equinix-assigned service identifier. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

Body parameters

Parameter	Description
op `string` REQUIRED	Request type. Applicable values: replace add remove
path `string` REQUIRED	The field you wish to replace. Applicable values: /name /ipv4 /advanceConfiguration/ntp /advanceConfiguration/ptp /package
value `string` REQUIRED	New field value.

Sample response

{
  "href": "https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011",
  "uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
  "name": "EPT-Single-Service",
  "type": "NTP",
  "state": "PROVISIONING",
  "connections": [
    {
      "href": "https://api.equinix.com/fabric/v4/connections/a8ba52de-faae-43b5-b0b1-6904d37ee011",
      "uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0"
    }
  ],
  "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.240",
    "defaultGateway": "192.168.0.1"
  },
  "account": {
    "accountNumber": 123456
  }
}

Refer to the response of Get Time Service for the field descriptions.

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Create Time Service

	POST /fabric/v4/timeServices
Method	POST
URL or Endpoint	/fabric/v4/timeServices
Headers	Authorization, Content-Type
Path Parameters	Not applicable
Query Parameters	Not applicable
Body Parameters	type, name, connections, package, ipv4, advanceConfiguration

Creates a time service.

Sample curl request - create an NTP Standard Service

curl -X
POST 'https://api.equinix.com/fabric/v4/timeServices'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
  "name": "EPT-Single-Service",
  "type": "NTP",
  "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.240",
    "defaultGateway": "192.168.0.1"
  }
}
'

Sample curl request - create a PTP Standard Service

curl -X
POST 'https://api.equinix.com/fabric/v4/timeServices'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
  "name": "EPT-Single-Service",
  "type": "PTP",
  "connections": [
    {
      "uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0"
    }
  ],
  "package": {
    "code": "PTP_STANDARD"
  },
  "ipv4": {
    "primary": "192.168.0.2",
    "secondary": "192.168.0.3",
    "networkMask": "255.255.255.240",
    "defaultGateway": "192.168.0.1"
  }
}
'

Sample curl request - create a PTP service with advanced configuration

curl -X
POST 'https://api.equinix.com/fabric/v4/timeServices'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
  "name": "EPT-Single-Service",
  "type": "PTP",
  "connections": [
    {
      "uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0"
    }
  ],
  "package": {
    "code": "PTP_STANDARD"
  },
  "ipv4": {
    "primary": "192.168.0.2",
    "secondary": "192.168.0.3",
    "networkMask": "255.255.255.240",
    "defaultGateway": "192.168.0.1"
  },
  "advanceConfiguration": {
    "ptp": {
      "tailScale": true,
      "domain": 10,
      "priority1": 5,
      "priority2": 7,
      "logAnnounceInterval": 0,
      "logSyncInterval": 0,
      "logDelayReqInterval": 0
    }
  }
}'

Body parameters

Parameter	Description
type `string` REQUIRED	Type of service. Applicable values: PTP NTP
name `string` REQUIRED	Name of time service. Applicable values: Maximum: 24 characters Allowed characters: alpha-numeric, hyphens ('-') and underscores ('_') Example: EPT-Single-Service
connections `array` REQUIRED	An array of objects with unique identifiers of connections.
uuid `string` REQUIRED	Unique identifier of connection. Example: 06dbb0e3-e55d-4090-8aff-fc5654abaad
package `object` REQUIRED	An object that has the package code.
code `string` REQUIRED	Package code. Applicable values: NTP_STANDARD NTP_ENTERPRISE PTP_STANDARD PTP_ENTERPRISE
ipv4 `object` REQUIRED	An object that has Network IP Configurations for Timing Master Servers.
primary `string` REQUIRED	IPv4 address for the Primary Timing Master Server. Example: 192.168.0.2
secondary `string` REQUIRED	IPv4 address for the Secondary Timing Master Server. Example: 192.168.0.3
networkMask `string` REQUIRED	IPv4 address that defines the range of consecutive subnets in the network. Example: 255.255.255.240
defaultGateway `string` REQUIRED	IPv4 address that establishes the Routing Interface where traffic is directed. It serves as the next hop in the Network. Example: 192.168.0.1
advanceConfiguration `object` OPTIONAL	An object that has advanced configuration options.
ptp `object` OPTIONAL	An object that has advanced PTP configuration.
tailScale `boolean` OPTIONAL	Time scale value. ARB denotes Arbitrary, and PTP denotes Precision Time Protocol.
domain `integer` OPTIONAL	Represents the domain number associated with the PTP profile. This is used to differentiate multiple PTP networks within a single physical network.
priority1 `integer` OPTIONAL	Specifies the priority level 1 for the clock. The value helps in determining the best clock in the PTP network. Lower values are considered higher priority.
priority2 `integer` OPTIONAL	Specifies the priority level 2 for the clock. It acts as a tie-breaker if multiple clocks have the same priority 1 value. Lower values are considered higher priority.
logAnnounceInterval `integer` OPTIONAL	Represents the log2 interval between consecutive PTP announce messages. For example, a value of 0 implies an interval of 2^0 = 1 second.
logSyncInterval `integer` OPTIONAL	Represents the log2 interval between consecutive PTP synchronization messages. A value of 0 implies an interval of 2^0 = 1 second.
logDelayReqInterval `integer` OPTIONAL	Represents the log2 interval between consecutive PTP delay request messages. A value of 0 implies an interval of 2^0 = 1 second.

Sample response

{
  "href": "https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011",
  "uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
  "name": "EPT-Single-Service",
  "type": "NTP",
  "state": "PROVISIONING",
  "connections": [
    {
      "href": "https://api.equinix.com/fabric/v4/connections/a8ba52de-faae-43b5-b0b1-6904d37ee011",
      "uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0"
    }
  ],
  "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.240",
    "defaultGateway": "192.168.0.1"
  },
  "account": {
    "accountNumber": 123456
  }
}

Refer to the response of Get Time Service for the field descriptions.

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Route Filters

Create Route Filter

	POST /fabric/v4/routeFilters
Method	POST
URL or Endpoint	/fabric/v4/routeFilters
Headers	Authorization, Content-Type
Path Parameters	Not applicable
Query Parameters	Not applicable
Body Parameters	type, name, description, project

Creates a Route Filter

Sample curl request

curl -X
POST 'https: //api.equinix.com/fabric/v4/routeFilters'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '
   {
  "type": "BGP_IPv4_PREFIX_FILTER",
  "name": "My-route-filter-v4",
  "description": "Test filter",
  "project": {
    "projectId": 567
  }
}
'

Body parameters

Parameter	Description
type `string` REQUIRED	Route filter type. BGP_IPv4_PREFIX_FILTER BGP_IPv6_PREFIX_FILTER
name `string` OPTIONAL	Name. Example: My-direct-route-1
description `string` OPTIONAL	Connection description. Example:Test filter
project `object` REQUIRED	An object that has the project Id.
projectId `string` REQUIRED	Project Id. Example: 567

Sample response

 {
  "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": 567
  },
  "changeLog": {
    "createdBy": "testuser",
    "createdByEmail": "testuser@equinix.com",
    "createdByFullName": "testuser testuser",
    "createdDateTime": "2020-05-21T10:30:00Z"
  }
}

Response description

Parameter	Description
href `string`	Route filter URI. Example: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d
type `string`	Route filter type. BGP_IPv4_PREFIX_FILTER BGP_IPv6_PREFIX_FILTER
uuid `string`	Route filter Id. Example: 65b025ef-022b-4180-85cf-82cfc1ab655b
name `string`	Name. Example: My-direct-route-1
description `string`	Route filter description. Example: Test filter
state `string`	Route filter state. Example: PROVISIONING REPROVISIONING DEPROVISIONING PROVISIONED DEPROVISIONED NOT_PROVISIONED NOT_DEPROVISIONED
change `object`	An object that has the previous change.
href `string`	Route Filter Change URI. Example: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3
type `string`	Type of change. 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
uuid `string`	Uniquely identifies a change. Example: 65b025ef-022b-4180-85cf-82cfc1ab655b
notMatchedRuleAction `string`	Not matched rule action. Example: DENY ALLOW
connectionsCount `integer`	Connections count. Example: 0
project `object`	An object that has the project Id.
projectId `string`	Project Id. Example: 567
href `string`	URI of the project. Example: https://api.equinix.com/resourceManager/v1/projects/567
changeLog `object`	A permanent record of asset creation, modification, or deletion.
createdBy `string`	Identity of the asset creator. Example: AverageJoe
createdByFullName `string`	First and last name of the asset creator. Example: Joe Average
createdByEmail `string`	Email address of the asset creator. Example: joe@average.org
createdDateTime `string`	Asset creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z

Get Route Filter

	GET /fabric/v4/routeFilters/{routeFilterId}
Method	GET
URL or Endpoint	/fabric/v4/routeFilters/{routeFilterId}
Headers	Authorization, Content-Type
Path Parameters	routeFilterId
Query Parameters	Not applicable
Body Parameters	Not applicable

Returns a Route Filter by its unique Id.

Sample curl request

curl -X
GET 'https: //api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter	Description
routeFilterId `string` REQUIRED	Unique Id of a Route Filter. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

Sample response

{
  "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": "PROVISIONED",
  "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": 567
  },
  "changeLog": {
    "createdBy": "testuser",
    "createdByEmail": "testuser@equinix.com",
    "createdByFullName": "testuser testuser",
    "createdDateTime": "2020-05-21T10:30:00Z"
  }
}

Response description

For a detailed description of the response, refer to the response of Create Route Filter.

Search Route Filters

	POST /fabric/v4/routeFilters/search
Method	POST
URL or Endpoint	/fabric/v4/routeFilters/search
Headers	Authorization, Content-Type
Path Parameters	Not applicable
Query Parameters	Not applicable
Body Parameters	filter, pagination, sort

Returns Route Filters that match the provided search criteria.

For instructions on how to obtain an authorization token, refer to Requesting Access and Refresh Tokens.

Sample curl request

curl -X POST 'http://api.equinix.com/fabric/v4/routeFilters/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
  "filter": {
    "and": [
      {
        "property": "/type",
        "operator": "=",
        "values": [
          "BGP_IPv4_PREFIX_FILTER"
        ]
      },
      {
        "property": "/name",
        "operator": "like",
        "values": [
          "%Route_Filter_Demo%"
        ]
      },
      {
        "property": "/project/projectId",
        "operator": "=",
        "values": [
          "567"
        ]
      }
    ]
  },
  "pagination": {
    "limit": 25,
    "offset": 0,
    "total": 0
  },
  "sort": [
    {
      "property": "/changeLog/updatedDateTime",
      "direction": "DESC"
    }
  ]
}'

Body parameters

Parameter	Description
filter `object` REQUIRED	Object defining search conditions.
and `array[object]` REQUIRED	Array of search parameters.
property `string` REQUIRED	Search parameter. Applicable values: /type /name /project/projectId /uuid /state
operator `string` REQUIRED	Search parameter operator. Applicable values: = LIKE
values `string` REQUIRED	Search parameter value. Example: BGP_IPv4_PREFIX_FILTER
pagination `object` OPTIONAL	Pagination settings.
offset `integer` OPTIONAL	Index of the first item returned in the response. Minimum: 0 Default value: 0
limit `integer` OPTIONAL	Maximum number of items returned per page. Minimum: 1 Maximum: 100 Default value: 20
sort `object` OPTIONAL	Sorting settings.
direction `string` OPTIONAL	Sorting direction. Applicable values: ASC DESC
property `string` OPTIONAL	Sorting parameter. Applicable values: /type /name /project/projectId /uuid /state

/type	Example: "property": "/type", "operator": "=", "values": [ "BGP_IPv4_PREFIX_FILTER" ]
operator `string` REQUIRED	Search parameter. Applicable values: =
value `array[string]` REQUIRED	Route Filter type. Example: BGP_IPv4_PREFIX_FILTER BGP_IPv6_PREFIX_FILTER

/name	Example: "property": "/name", "operator": "LIKE", "values": [ "%Route_filter_demo%" ]
operator `string` REQUIRED	Search parameter . Applicable values: = LIKE
value `array[string]` REQUIRED	Route Filter name. Example: ["%Route_filter_demo%"]

/project/projectId	Example: "property": "/project/projectId", "operator": "=", "values": [ "567 ]
operator `string` REQUIRED	Search parameter. Applicable values: =
value `array[string]` REQUIRED	Project Id. Example: ["567"]

/uuid	Example: "property": "/uuid", "operator": "=", "values": [ "3a58dd05-f46d-4b1d-a154-2e85c396ea62 ]
operator `string` REQUIRED	Search parameter. Applicable values: =
value `array[string]` REQUIRED	Route Filter Id. Example: ["3a58dd05-f46d-4b1d-a154-2e85c396ea62"]

/state	Example: "property": "/state", "operator": "=", "values": [ PROVISIONING ]
operator `string` REQUIRED	Search parameter. Applicable values: =
value `array[integer]` REQUIRED	Route filter state. Example: PROVISIONING REPROVISIONING DEPROVISIONING PROVISIONED DEPROVISIONED NOT_PROVISIONED NOT_DEPROVISIONED

Sample response

{
  "pagination": {
    "offset": 0,
    "limit": 20,
    "total": 2,
    "next": null,
    "previous": null
  },
  "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": 567
      },
      "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": 567
      },
      "changeLog": {
        "createdBy": "testuser",
        "createdByEmail": "testuser@equinix.com",
        "createdByFullName": "testuser testuser",
        "createdDateTime": "2020-05-21T10:30:00Z"
      }
    }
  ]
}

Response payload body description

For a detailed description of the response, refer to the response of Create Route Filter.

Patch Route Filter

	PATCH /fabric/v4/routeFilters/{routeFilterId}
Method	PATCH
URL or Endpoint	/fabric/v4/routeFilters/{routeFilterId}
Headers	Authorization, Content-Type
Path Parameters	routeFilterId
Query Parameters	Not applicable
Body Parameters	op, path, value

Updates a Route Filter partially.

Sample curl request

curl -X
PATCH 'https: //api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '
[
  {
    "op": "replace",
    "path": "/name",
    "value": "My-route-filter-v4-updated"
  }
]
'

Path parameters

Parameter	Description
routeFilterId `string` REQUIRED	Unique Id of a Route Filter. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

Body parameters

Parameter	Description
op `string` REQUIRED	Update request type. Example: replace
path `string` REQUIRED	Parameter path. Example: /name
value `string` REQUIRED	New parameter value. Example: My-route-filter-updated

Sample response

{
  "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": "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_CREATION",
    "uuid": "04af0d37-9160-43d8-97ef-9da9786996a3"
  },
  "notMatchedRuleAction": "DENY",
  "connectionsCount": 0,
  "project": {
    "href": "https://api.equinix.com/resourceManager/v1/projects/567",
    "projectId": 567
  },
  "changeLog": {
    "createdBy": "testuser",
    "createdByEmail": "testuser@equinix.com",
    "createdByFullName": "testuser testuser",
    "createdDateTime": "2020-05-21T10:30:00Z"
  }
}

Response description

For a detailed description of the response, refer to the response of Create Route Filter.

Delete Route Filter

	DELETE /fabric/v4/routeFilters/{routeFilterId}
Method	DELETE
URL or Endpoint	/fabric/v4/routeFilters/{routeFilterId}
Headers	Authorization, Content-Type
Path Parameters	routeFilterId
Query Parameters	Not applicable
Body Parameters	Not applicable

Deletes a Route Filter by its unique Id.

Sample curl request

curl -X
DELETE 'https: //api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter	Description
routeFilterId `string` REQUIRED	Unique Id of a Route Filter. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

Sample response

{
  "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/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": 567
  },
  "changeLog": {
    "createdBy": "testuser",
    "createdByEmail": "testuser@equinix.com",
    "createdByFullName": "testuser testuser",
    "createdDateTime": "2020-05-21T10:30:00Z"
  }
}

Response description

For a detailed description of the response, refer to the response of Create Route Filter.

Attach Route Filter To Connection

	PUT /fabric/v4/connections/{connectionId}/routeFilters/{routeFilterId}
Method	PUT
URL or Endpoint	/fabric/v4/connections/{connectionId}/routeFilters/{routeFilterId}
Headers	Authorization, Content-Type
Path Parameters	connectionId, routeFilterId
Query Parameters	Not applicable
Body Parameters	Not applicable

Attaches a Route Filter to a Connection.

Sample curl request

curl -X
PUT 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '
{
  "direction": "INBOUND"
}
'

Path parameters

Parameter	Description
connectionId `string` REQUIRED	Unique Id of a connection. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
routeFilterId `string` REQUIRED	Unique Id of a Route Filter. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

Body parameters

Parameter	Description
direction `string` REQUIRED	Direction of the connection. INBOUND OUTBOUND

Sample response

  {
      "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"
  }

Response description

For a detailed description of the response, refer to the response of Get Route Filter With Connection.

Detach Route Filter From Connection

	DELETE /fabric/v4/connections/{connectionId}/routeFilters/{routeFilterId}
Method	DELETE
URL or Endpoint	/fabric/v4/connections/{connectionId}/routeFilters/{routeFilterId}
Headers	Authorization, Content-Type
Path Parameters	connectionId, routeFilterId
Query Parameters	Not applicable
Body Parameters	Not applicable

Deletes a Route Filter attached to a connection.

Sample curl request

curl -X
DELETE 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter	Description
connectionId `string` REQUIRED	Unique Id of a connection. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
routeFilterId `string` REQUIRED	Unique Id of a Route Filter. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

Sample response

  {
      "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"
  }

Response description

For a detailed description of the response, refer to the response of Get Route Filter.

Get Route Filter With Connection

	GET /fabric/v4/connections/{connectionId}/routeFilters/{routeFilterId}
Method	GET
URL or Endpoint	/fabric/v4/connections/{connectionId}/routeFilters/{routeFilterId}
Headers	Authorization, Content-Type
Path Parameters	connectionId, routeFilterId
Query Parameters	Not applicable
Body Parameters	Not applicable

Returns a Route Filter attached to a connection.

Sample curl request

curl -X
GET 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter	Description
connectionId `string` REQUIRED	Unique Id of a connection. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
routeFilterId `string` REQUIRED	Unique Id of a Route Filter. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

Sample response

  {
      "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": "ATTACHED",
      "direction": "INBOUND"
  }

Response description

Parameter	Description
href `string`	Route filter URI. Example: https://api.equinix.com/fabric/v4/connections/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilters/81331c52-04c0-4656-a4a7-18c52669348f
type `string`	Route filter type. BGP_IPv4_PREFIX_FILTER BGP_IPv6_PREFIX_FILTER
uuid `string`	Route filter Id. Example: 65b025ef-022b-4180-85cf-82cfc1ab655b
attachmentStatus `string`	Attachment status. ATTACHING ATTACHED DETACHED DETACHING FAILED
direction `string`	Direction. INBOUND OUTBOUND

Get Route Filters With Connection

	GET /fabric/v4/connections/{connectionId}/routeFilters
Method	GET
URL or Endpoint	/fabric/v4/connections/{connectionId}/routeFilters
Headers	Authorization, Content-Type
Path Parameters	connectionId
Query Parameters	offset, limit
Body Parameters	Not applicable

Returns all Route Filters attached to a connection.

Sample curl request

curl -X
GET 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62/routeFilters'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter	Description
connectionId `string` REQUIRED	Unique Id of a connection. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

Query parameters

Parameter	Description
offset `integer` OPTIONAL	Index of the first item returned in the response. Minimum: 0 Default: 0
limit `integer` OPTIONAL	Maximum number of items returned per data page. Minimum: 1 Default: 20

Sample response

{
  "pagination": {
    "offset": 0,
    "limit": 20,
    "total": 4,
    "next": null,
    "previous": null
  },
  "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/65d74639-8f48-4e10-9684-45d364645e97",
      "type": "BGP_IPv6_PREFIX_FILTER",
      "uuid": "65d74639-8f48-4e10-9684-45d364645e97",
      "attachmentStatus": "ATTACHED",
      "direction": "OUTBOUND"
    }
  ]
}

Response description

Parameter	Description
pagination `object`	Pagination settings.
offset `integer`	Index of the first item returned. Example: 0
limit `integer`	Maximum number of items returned per page. Example: 20
total `integer`	Total number of items returned. Example: 10
next `string`	Next data page URL. Example: /search?offset=40&limit=20
previous `string`	Previous data page URL. Example: /search?offset=0&limit=20
data `array[object]`	List of Route Filters attached to the connection.
href `string`	Route filter URI. Example: https://api.equinix.com/fabric/v4/connections/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilters/81331c52-04c0-4656-a4a7-18c52669348f
type `string`	Route filter type. BGP_IPv4_PREFIX_FILTER BGP_IPv6_PREFIX_FILTER
uuid `string`	Route filter Id. Example: 65b025ef-022b-4180-85cf-82cfc1ab655b
attachmentStatus `string`	Attachment status. ATTACHING ATTACHED DETACHED DETACHING FAILED
direction `string`	Direction. INBOUND OUTBOUND

Get Connections Of Route Filter

	GET /fabric/v4/routeFilters/{routeFilterId}/connections
Method	GET
URL or Endpoint	/fabric/v4/routeFilters/{routeFilterId}/connections
Headers	Authorization, Content-Type
Path Parameters	routeFilterId
Query Parameters	Not applicable
Body Parameters	Not applicable

Returns connections of a Route Filter Id.

Sample curl request

curl -X
GET 'https: //api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/connections'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter	Description
routeFilterId `string` REQUIRED	Unique Id of a Route Filter. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

Sample response

{
  "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"
  }
}

Response description

Parameter	Description
pagination `object`	Pagination settings.
offset `integer`	Index of the first item returned. Example: 0
limit `integer`	Maximum number of items returned per page. Example: 20
total `integer`	Total number of items returned. Example: 10
next `string`	Next data page URL. Example: /search?offset=40&limit=20
previous `string`	Previous data page URL. Example: /search?offset=0&limit=20
data `array[object]`	List of connections of the Route Filter Id.
href `string`	Connection URI. Example: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f
type `string`	Connection type. IP_VC IPWAN_VC
uuid `string`	Route filter Id. Example: 65b025ef-022b-4180-85cf-82cfc1ab655b
name `string`	Connection name. Example Connection-1

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Route Filter Rules

Create Route Filter Rule

	POST /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules
Method	POST
URL or Endpoint	/fabric/v4/routeFilters/{routeFilterId}/routeFilterRules
Headers	Authorization, Content-Type
Path Parameters	routeFilterId
Query Parameters	Not applicable
Body Parameters	Name, description, prefix, prefixMatch

Creates a Route Filter Rule.

Sample curl request

curl -X
POST 'https: //api.equinix.com/fabric/v4/routeFilters/3a58dd05-f46d-4b1d-a154-2e85c396ea62/routeFilterRules'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '
    {
        "name": "Private-subnet-filter",
        "description": "Test rule",
        "prefix": "192.168.0.0/24",
        "prefixMatch": "exact"
    }
'

Path parameters

Parameter	Description
routeFilterId `string` REQUIRED	Route Filter Id. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

Body parameters

Parameter	Description
name `string` OPTIONAL	Name. Example: Private-subnet-filter-2
description `string` OPTIONAL	Filter rule description. Example: Test-rule
prefix `string` REQUIRED	Prefix. Example: 192.168.10.0/24
prefixMatch `string` OPTIONAL	Prefix matching operator. Default: "orlonger" Example: exact

Sample response

{
  "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",
  "state": "PROVISIONING",
  "name": "Private-subnet-filter",
  "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"
  }
}

Response description

Parameter	Description
href `string`	Route filter rules URI. Example: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/65b025ef-022b-4180-85cf-82cfc1ab655b
type `string`	Route filter type. BGP_IPv4_PREFIX_FILTER_RULE BGP_IPv6_PREFIX_FILTER_RULE
uuid `string`	Route filter rule Id. Example: 65b025ef-022b-4180-85cf-82cfc1ab655b
state `string`	Route filter rule state. Example: PROVISIONED PROVISIONING REPROVISIONING DEPROVISIONING NOT_PROVISIONED NOT_DEPROVISIONED DEPROVISIONED
name `string`	Name. Example: Private-subnet-filter-2
description `string`	Filter rule description. Example: Test-rule
prefixMatch `string`	Prefix matching operator. Example: exact orlonger
action `string`	Action. Example: PERMIT
prefix `string`	Prefix. Example: 192.168.10.0/24
change `object`	An object that has the previous change.
href `string`	Route Filter Change URI. Example: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/65b025ef-022b-4180-85cf-82cfc1ab655b
type `string`	Type of change. BGP_IPv4_PREFIX_FILTER_RULE BGP_IPv6_PREFIX_FILTER_RULE
uuid `string`	Uniquely identifies a change. Example: 65b025ef-022b-4180-85cf-82cfc1ab655b
changeLog `object`	A permanent record of asset creation, modification, or deletion.
createdBy `string`	Identity of the asset creator. Example: AverageJoe
createdByFullName `string`	First and last name of the asset creator. Example: Joe Average
createdByEmail `string`	Email address of the asset creator. Example: joe@average.org
createdDateTime `string`	Asset creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z

Create Route Filter Rules

	POST /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/bulk
Method	POST
URL or Endpoint	/fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/bulk
Headers	Authorization, Content-Type
Path Parameters	routeFilterId
Query Parameters	Not applicable
Body Parameters	Name, description, prefix, prefixMatch

Creates Route Filter Rules in bulk.

Sample curl request

curl -X
POST 'https: //api.equinix.com/fabric/v4/routeFilters/3a58dd05-f46d-4b1d-a154-2e85c396ea62/routeFilterRules/bulk'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '
    {
  "data": [
    {
      "name": "Private-subnet-filter",
      "description": "string",
      "prefix": "192.168.0.0/24",
      "prefixMatch": "orlonger"
    }
  ]
}
'

Path parameters

Parameter	Description
routeFilterId `string` REQUIRED	Route Filter Id. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

Body parameters

Parameter	Description
data `array` REQUIRED	An array of Route Filter Rules.
name `string` OPTIONAL	Name. Example: Private-subnet-filter-2
description `string` OPTIONAL	Filter rule description. Example: Test-rule
prefix `string` REQUIRED	Prefix. Example: 192.168.10.0/24
prefixMatch `string` OPTIONAL	Prefix matching operator. Default: orlonger. Example: exact orlonger

Sample response

{
  "pagination": {
    "offset": 0,
    "limit": 20,
    "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",
      "state": "PROVISIONING",
      "name": "Private-subnet-filter-2",
      "description": "Test rule",
      "prefixMatch": "exact",
      "action": "PERMIT",
      "prefix": "192.168.10.0/24",
      "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": "IPv4_BGP_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"
      }
    }
  ]
}

Response description

Parameter	Description
pagination `object`	Search results pagination settings.
offset `integer`	Index of the first item returned in the response. Example: 0
limit `integer`	Maximum number of items returned per page. Example: 20
total `integer`	Total number of items returned. Example: 10
next `string`	Next data page URL. Example: /search?offset=40&limit=20
previous `string`	Previous data page URL. Example: /search?offset=0&limit=20
data `array[object]`	Data array containing objects that match the provided search criteria.
href `string`	Route filter rules URI. Example: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/65b025ef-022b-4180-85cf-82cfc1ab655b
type `string`	Route filter type. BGP_IPv4_PREFIX_FILTER_RULE BGP_IPv6_PREFIX_FILTER_RULE
uuid `string`	Route filter rule Id. Example: 65b025ef-022b-4180-85cf-82cfc1ab655b
state `string`	Route filter rule state. Example: PROVISIONED PROVISIONING REPROVISIONING DEPROVISIONING NOT_PROVISIONED NOT_DEPROVISIONED DEPROVISIONED
name `string`	Name. Example: Private-subnet-filter-2
description `string`	Filter rule description. Example: Test-rule
prefixMatch `string`	Prefix matching operator. Example: exact orlonger
action `string`	Action. Example: PERMIT
prefix `string`	Prefix. Example: 192.168.10.0/24
change `object`	An object that has the previous change.
href `string`	Route Filter Change URI. Example: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/65b025ef-022b-4180-85cf-82cfc1ab655b
type `string`	Type of change. BGP_IPv4_PREFIX_FILTER_RULE BGP_IPv6_PREFIX_FILTER_RULE
uuid `string`	Uniquely identifies a change. Example: 65b025ef-022b-4180-85cf-82cfc1ab655b
changeLog `object`	A permanent record of asset creation, modification, or deletion.
createdBy `string`	Identity of the asset creator. Example: AverageJoe
createdByFullName `string`	First and last name of the asset creator. Example: Joe Average
createdByEmail `string`	Email address of the asset creator. Example: joe@average.org
createdDateTime `string`	Asset creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z

Get Route Filter Rule

	GET /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/{routeFilterRuleId}
Method	GET
URL or Endpoint	/fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/{routeFilterRuleId}
Headers	Authorization, Content-Type
Path Parameters	routeFilterId, routeFilterRuleId
Query Parameters	Not applicable
Body Parameters	Not applicable

Returns a specific Route Filter Rule by its unique Id.

Sample curl request

curl -X
GET 'https: //api.equinix.com/fabric/v4/routeFilters/3a58dd05-f46d-4b1d-a154-2e85c396ea62/routeFilterRules/8b58dd05-f46d-4b1d-a154-2e85c396ea56'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter	Description
routeFilterId `string` REQUIRED	Route Filter Id. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
routeFilterRuleId `string` REQUIRED	Route Filter Rule Id. Example: 7658dd05-f46d-4b1d-a154-2e85c396ea94

Response description

For a detailed description of the response, refer to the response of Create Route Filter Rule.

Get Route Filter Rules

	GET /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules
Method	GET
URL or Endpoint	/fabric/v4/routeFilters/{routeFilterId}/routeFilterRules
Headers	Authorization, Content-Type
Path Parameters	routeFilterId
Query Parameters	offset, limit
Body Parameters	Not applicable

Returns all Route Filter Rules for Fabric.

Sample curl request

curl -X
GET 'https: //api.equinix.com/fabric/v4/routeFilters/3a58dd05-f46d-4b1d-a154-2e85c396ea62/routeFilterRules'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter	Description
routeFilterId `string` REQUIRED	Route Filter Id. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

Query parameters

Parameter	Description
offset `integer` OPTIONAL	Index of the first item returned in the response. Minimum: 0 Default: 0
limit `integer` OPTIONAL	Maximum number of items returned per data page. Minimum: 1 Default: 20

Response description

For a detailed description of the response, refer to the response of Create Route Filter Rules.

Patch Route Filter Rule

	PATCH /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/{routeFilterRuleId}
Method	PATCH
URL or Endpoint	/fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/{routeFilterRuleId}
Headers	Authorization, Content-Type
Path Parameters	routeFilterId, routeFilterRuleId
Query Parameters	Not applicable
Body Parameters	op, path, value

Partially updates a Route Filter Rule.

Sample curl request

curl -X
PATCH 'https: //api.equinix.com/fabric/v4/routeFilters/3a58dd05-f46d-4b1d-a154-2e85c396ea62/routeFilterRules/8b58dd05-f46d-4b1d-a154-2e85c396ea56'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '
[
  {
    "op": "replace",
    "path": "/prefixMatch",
    "value": "orlonger"
  }
]
'

Path parameters

Parameter	Description
routeFilterId `string` REQUIRED	Route Filter Id. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
routeFilterRuleId `string` REQUIRED	Route Filter Rule Id. Example: 7658dd05-f46d-4b1d-a154-2e85c396ea94

Body parameters

Parameter	Description
op `string` REQUIRED	Update request type. Example: replace
path `string` REQUIRED	Parameter path. Example: /prefixMatch
value `string` REQUIRED	New parameter value. Example: orlonger

Sample response

{
  "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"
  }
}

Response description

For a detailed description of the response, refer to the response of Create Route Filter Rule.

Replace Route Filter Rule

	PUT /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/{routeFilterRuleId}
Method	PUT
URL or Endpoint	/fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/{routeFilterRuleId}
Headers	Authorization, Content-Type
Path Parameters	routeFilterId, routeFilterRuleId
Query Parameters	Not applicable
Body Parameters	name, description, prefix, prefixMatch

Completely updates a Route Filter Rule.

Sample curl request

curl -X
PUT 'https: //api.equinix.com/fabric/v4/routeFilters/3a58dd05-f46d-4b1d-a154-2e85c396ea62/routeFilterRules/8b58dd05-f46d-4b1d-a154-2e85c396ea56'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '
{
  "name": "Private-subnet-filter-update",
  "description": "Test rule",
  "prefix": "192.168.0.0/24",
  "prefixMach": "exact"
}
'

Path parameters

Parameter	Description
routeFilterId `string` REQUIRED	Route Filter Id. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
routeFilterRuleId `string` REQUIRED	Route Filter Rule Id. Example: 7658dd05-f46d-4b1d-a154-2e85c396ea94

Body parameters

Parameter	Description
name `string` OPTIONAL	Name. Example: Private-subnet-filter-2
description `string` OPTIONAL	Filter rule description. Example: Test-rule
prefix `string` REQUIRED	Prefix. Example: 192.168.10.0/24
prefixMatch `string` OPTIONAL	Prefix matching operator. Default: orlonger. Example: exact

Sample response

{
  "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"
  }
}

Response description

For a detailed description of the response, refer to the response of Create Route Filter Rule.

Delete Route Filter Rule

	DELETE /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/{routeFilterRuleId}
Method	DELETE
URL or Endpoint	/fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/{routeFilterRuleId}
Headers	Authorization, Content-Type
Path Parameters	routeFilterId, routeFilterRuleId
Query Parameters	Not applicable
Body Parameters	Not applicable

Deletes a Route Filter Rule by its unique Id.

Sample curl request

curl -X
DELETE 'https: //api.equinix.com/fabric/v4/routeFilters/3a58dd05-f46d-4b1d-a154-2e85c396ea62/routeFilterRules/8b58dd05-f46d-4b1d-a154-2e85c396ea56'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter	Description
routeFilterId `string` REQUIRED	Route Filter Id. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
routeFilterRuleId `string` REQUIRED	Route Filter Rule Id. Example: 7658dd05-f46d-4b1d-a154-2e85c396ea94

Sample response

{
  "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"
  }
}

Response description

For a detailed description of the response, refer to the response of Create Route Filter Rule.

If you get an “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Connections​

Create Connection​

Get Specified Connection​

Retrieve Connections​

Update Connection​

Manage Connection​

Delete Connection​

Validate Connection Authorization Key​

Fabric Cloud Routers​

Create Fabric Cloud Router​

Get Specified Fabric Cloud Router​

Update Fabric Cloud Router​

Manage Routing Tables​

Get Routing Tables Management Requests​

Retrieve Fabric Cloud Routers​

Delete Fabric Cloud Router​

Get All Fabric Cloud Router Packages​

Get Specified Fabric Cloud Router Package​

Metros​

Get All Metros​

Get Metros by Metro Code​

Get All Subscriber Metros​

Ports​

Create Port​

Create Pair of Redundant Ports​

Add Physical Ports to Virtual Port​

Get All Ports​

Get Specified Port​

Delete Specified Port​

Get Used Vlans​

Search Ports​

Prices​

Retrieve Pricing​

Routing Table Entries​

Retrieve Routing Tables Entries​

Routing Protocols​

Create Routing Protocol Instance​

Create Routing Protocol Instances​

Get Specified Routing Protocol Instance​

Get All Routing Protocol Instances​

Replace Routing Protocol Instance​

Update Routing Protocol​

Get All Routing Protocol Change Requests​

Get Specified Routing Protocol Change Request​

Clear or Reset BGP​

Get BGP Actions​

Get Specified BGP Action​

Delete Routing Protocol Instance​

Validate Subnet​

Service Profiles​

Create Service Profile​

Get Service Profiles​

Get Specified Service Profile​

Retrieve Service Profiles​

Update Service Profile​

Replace Service Profile​

Delete Service Profile​

Service Tokens​

Create Service Token​

Get All Service Tokens​

Get Specified Service Token​

Update Service Token​

Delete Service Token​

Search for Service Tokens​

Statistics​

Get Specified Port Statistics​

Get Ports Statistics​

Get Connection Statistics​

Fabric Networks​

Create Fabric Network​

Get Specified Fabric Network​

Update Fabric Network​

Retrieve Fabric Networks​

Delete Fabric Network​

Get Connections Associated With Specified Fabric Network​

Get Fabric Network Changes​

Get Specified Fabric Network Change​

Precision Time​

Get Time Service​

Delete Time Service​

Connections

Create Connection

Get Specified Connection

Retrieve Connections

Update Connection

Manage Connection

Delete Connection

Validate Connection Authorization Key

Fabric Cloud Routers

Create Fabric Cloud Router

Get Specified Fabric Cloud Router

Update Fabric Cloud Router

Manage Routing Tables

Get Routing Tables Management Requests

Retrieve Fabric Cloud Routers

Delete Fabric Cloud Router

Get All Fabric Cloud Router Packages

Get Specified Fabric Cloud Router Package

Metros

Get All Metros

Get Metros by Metro Code

Get All Subscriber Metros

Ports

Create Port

Create Pair of Redundant Ports

Add Physical Ports to Virtual Port

Get All Ports

Get Specified Port

Delete Specified Port

Get Used Vlans

Search Ports

Prices

Retrieve Pricing

Routing Table Entries

Retrieve Routing Tables Entries

Routing Protocols

Create Routing Protocol Instance

Create Routing Protocol Instances

Get Specified Routing Protocol Instance

Get All Routing Protocol Instances

Replace Routing Protocol Instance

Update Routing Protocol

Get All Routing Protocol Change Requests

Get Specified Routing Protocol Change Request

Clear or Reset BGP

Get BGP Actions

Get Specified BGP Action

Delete Routing Protocol Instance

Validate Subnet

Service Profiles

Create Service Profile

Get Service Profiles

Get Specified Service Profile

Retrieve Service Profiles

Update Service Profile

Replace Service Profile

Delete Service Profile

Service Tokens

Create Service Token

Get All Service Tokens

Get Specified Service Token

Update Service Token

Delete Service Token

Search for Service Tokens

Statistics

Get Specified Port Statistics

Get Ports Statistics

Get Connection Statistics

Fabric Networks

Create Fabric Network

Get Specified Fabric Network

Update Fabric Network

Retrieve Fabric Networks

Delete Fabric Network

Get Connections Associated With Specified Fabric Network

Get Fabric Network Changes

Get Specified Fabric Network Change

Precision Time

Get Time Service

Delete Time Service