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

Copy

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

Copy

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

Copy

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

Copy

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 ConnectionsAPI 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.
routesMax	no	integer	1		The maximum number of IPv4 prefixes received from a BGP peer on a connection. Min possible: 1 Max possible: 50 for Lab 1000 for Standard 4000 for Advanced 10000 for Premium
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 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.
routesMax	no	integer	1		The maximum number of IPv6 prefixes received from a BGP peer on a connection. Min possible: 1 Max possible: 50 for Lab 100 for Standard 250 for Advanced 500 for Premium
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

Copy

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

Copy

{
    "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.
routesMax	integer	1	The maximum number of IPv4 prefixes received from a BGP peer on a connection. Min possible: 1 Max possible: 50 for Lab 1000 for Standard 4000 for Advanced 10000 for Premium
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.
routesMax	integer	1	The maximum number of IPv6 prefixes received from a BGP peer on a connection. Min possible: 1 Max possible: 50 for Lab 100 for Standard 250 for Advanced 500 for Premium
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

Copy

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

Copy

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

Copy

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.
routesMax	no	integer	1		The maximum number of IPv4 prefixes received from a BGP peer on a connection. Min possible: 1 Max possible: 50 for Lab 1000 for Standard 4000 for Advanced 10000 for Premium
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 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.
routesMax	no	integer	1		The maximum number of IPv6 prefixes received from a BGP peer on a connection. Min possible: 1 Max possible: 50 for Lab 1000 for Standard 4000 for Advanced 10000 for Premium
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

Copy

[
    {
        "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

Copy

{
    "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.
routesMax	integer	1	The maximum number of IPv4 prefixes received from a BGP peer on a connection. Min possible: 1 Max possible: 50 for Lab 1000 for Standard 4000 for Advanced 10000 for Premium
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.
routesMax	integer	1	The maximum number of IPv6 prefixes received from a BGP peer on a connection. Min possible: 1 Max possible: 50 for Lab 100 for Standard 250 for Advanced 500 for Premium
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

Copy

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

Copy

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

Copy

{
    "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.
routesMax	integer	1	The maximum number of IPv4 prefixes received from a BGP peer on a connection. Min possible: 1 Max possible: 50 for Lab 1000 for Standard 4000 for Advanced 10000 for Premium
operation
operationalStatus	string	UP	BGP connection state. 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.
routesMax	integer	1	The maximum number of IPv6 prefixes received from a BGP peer on a connection. Min possible: 1 Max possible: 50 for Lab 100 for Standard 250 for Advanced 500 for Premium
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

Copy

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

Copy

{
    "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.
routesMax	integer	1	The maximum number of IPv4 prefixes received from a BGP peer on a connection. Min possible: 1 Max possible: 50 for Lab 1000 for Standard 4000 for Advanced 10000 for Premium
operation
operationalStatus	string	UP	BGP connection state. 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.
routesMax	integer	1	The maximum number of IPv6 prefixes received from a BGP peer on a connection. Min possible: 1 Max possible: 50 for Lab 100 for Standard 250 for Advanced 500 for Premium
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

Copy

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

Copy

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.
routesMax	no	integer	1		The maximum number of IPv4 prefixes received from a BGP peer on a connection. Min possible: 1 Max possible: 50 for Lab 1000 for Standard 4000 for Advanced 10000 for Premium
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 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.
routesMax	no	integer	1		The maximum number of IPv6 prefixes received from a BGP peer on a connection. Min possible: 1 Max possible: 50 for Lab 100 for Standard 250 for Advanced 500 for Premium
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

Copy

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

Copy

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

Sample curl request

Copy

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

Copy

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

Copy

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

Copy

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

Copy

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

Copy

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

Copy

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

Copy

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

Copy

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

Copy

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

Copy

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

Copy

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

Copy

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

Copy

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

Copy

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

Copy

{
    "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.

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

Was this documentation helpful?