Routing Table Entries

Retrieve Routing Tables Entries

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

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

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

Sample curl request - AND logical operator

Copy

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

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

Copy

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

Path parameters

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

Body parameters

Parameter	Mandatory	Type	Example	Applicable Values	Description
filter	no	object	-	-	Array of objects defining search conditions.
pagination	no	object	-	-	Search results pagination settings.
sort	no	object	-	-	Search results sorting settings.
filter
and	yes	array[object]	-	-	Logical operator.
property	yes	string	/type	/nextHop /prefix /status /type /*	Search field parameter. Note that the property value determines the list of applicable operators and values. /nextHop - The IP address of the next router through which a packet must pass on the way to its destination. /prefix -Subscriber subnet prefix. /type - Routing table entries type. /status - Routing table entry status. /* - All categories search.
operator	yes	string	=	= != > >= < <= LIKE IN NOT LIKE NOT IN ~*	Search field parameter operator. ~* - Case-insensitive all-category like.
values	yes	array[string]	["IPv4_BGP_ROUTE"]	-	Search field parameter value.
/nextHop	no		"property": "/nextHop", "operator": "=", "values": [ "10.10.10.5" ]		The IP address of the next router through which a packet must pass on the way to its destination.
operator	yes	string	=	= != LIKE IN NOT LIKE NOT IN ~*	Search field parameter operator.
values	yes	array[string]	["10.10.10.5"]	-	-
/state	no		"property": "/state", "operator": "=", "values": [ "ACTIVE" ]		Routing table entry status.
operator	yes	string	=	= != LIKE IN NOT LIKE NOT IN ~*	Search field parameter operator.
values	yes	array[string]	["ACTIVE"]	ACTIVE INACTIVE	ACTIVE - Routing trable entry represents an active route. INACTIVE - Routing trable entry represents an inactive route.
/prefix	no		{ "property": "/prefix", "operator": "=", "values": [ "10.203.1.0/30" ] }		Subscriber subnet prefix.
operator	yes	string	=	= != LIKE IN NOT LIKE NOT IN ~*	Search field parameter operator.
values	yes	array[string]	["10.203.1.0/30"]	-	-
/type	no		"property": "/type", "operator": "=", "values": [ "IPv4_BGP_ROUTE" ]		Routing table entry type.
operator	yes	string	LIKE	= != LIKE IN NOT LIKE NOT IN ~*	Search field parameter operator.
values	yes	array[string]	["IPv4_BGP_ROUTE"]	IPv4_BGP_ROUTE IPv6_BGP_ROUTE	IPv4_BGP_ROUTE - IPv4 BGP protocol routing entry. IPv6_BGP_ROUTE - IPv6 BGP protocol routing entry.
/*	no		"property": "/*", "operator": "LIKE", "values": [ "IPv4" ]		All category search.
operator	yes	string	LIKE	= != LIKE IN NOT LIKE NOT IN ~*	Search field parameter operator.
values	yes	array[string]	["IPv4"]	-	-
or
or	no	array[objects]	-	Maximum: 3 array elements	Array of objects defining search criteria. Refer to filtering parameters for information on available search options.
pagination
offset	no	integer	0	Minimum: 0 Default: 0	Index of the first item returned in the response.
limit	no	integer	20	Minimum: 1 Default: 20	Maximum number of items returned per page.
sort
direction	no	string	DESC	ASC DESC	Search results sorting direction.
property	no	string	/changeLog/updatedDateTime	/prefix /changeLog/createdDateTime Default:/changeLog/createdDateTime	Search results sorting parameter.

Sample response - AND logical operator

Copy

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

Response payload body description

Parameter	Type	Example values	Description
pagination	object	-	Search results pagination settings.
data	array[object]	-	Data array containing search results.
changeLog	object	-	A permanent record of asset creation, modification, or deletion.
connection	object	-	An object that has connection details.
pagination
offset	integer	0	Index of the first item returned in the response.
limit	integer	20	Maximum number of items returned per page.
total	integer	1	Total number of items returned.
data
type	string	IPv4_BGP_ROUTE	Routing table entry type. IPv4_BGP_ROUTE - IPv4 BGP protocol routing entry. IPv6_BGP_ROUTE - IPv6 BGP protocol routing entry.
state	string	ACTIVE	Routing table entry status. ACTIVE - Routing trable entry represents an active route. INACTIVE - Routing trable entry represents an inactive route.
age	string	PT5M30S	The time that has passed since the entry has been added to the routing table, in ISO 8601 date and time format.
prefix	string	192.168.10.0/24	Subscriber subnet prefix.
nextHop	string	10.10.10.5	The IP address of the next router through which a packet must pass on the way to its destination.
metric	integer	5	The minimum number of hops it takes to reach the destination.
localPreference	integer	200	Local preference value determining the best path for outbound traffic.
asPath	array[integer]	[66008,12672]	The list of autonomous systems that must be traversed to reach a given destination.
connection
uuid	string	81331c52-04c0-4656-a4a7-18c52669348f	Equinix-assigned connection identifier.
name	string	My-Connection	Connection name.
changeLog
createdDateTime	string	2021-07-15T19:30:29.526Z	Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
updatedDateTime	string	2021-07-15T19:30:29.526Z	Asset update timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000

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

Search Received Routes for Connection

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

Searches Received Routes, both active and inactive routes, for connection.

Sample curl request - AND logical operator

Path parameters

Parameter	Mandatory	Type	Example	Applicable Values	Description
uuid	yes	string	638895bc-4458-4627-9a3d-02c76ab362d7	-	Equinix-assigned connection Id.

To check the descriptions of Body parameters, see the body parameters of Retrieve Routing Table Entries.

 

Sample response - AND logical operator

Response payload body description

Parameter	Type	Example values	Description
pagination	object	-	Pagination settings.
data	array[object]	-	Data array containing search results.
changeLog	object	-	A permanent record of asset creation, modification, or deletion.
pagination
offset	integer	0	Index of the first item returned in the response.
limit	integer	20	Maximum number of items returned per page.
total	integer	1	Total number of items returned.
data
type	string	IPv4_BGP_ROUTE	Routing table entry type. IPv4_BGP_ROUTE - IPv4 BGP protocol routing entry. IPv6_BGP_ROUTE - IPv6 BGP protocol routing entry.
state	string	ACTIVE	Routing table entry status. ACTIVE - Routing trable entry represents an active route. INACTIVE - Routing trable entry represents an inactive route.
prefix	string	192.168.10.0/24	Subscriber subnet prefix.
nextHop	string	10.10.10.5	The IP address of the next router through which a packet must pass on the way to its destination.
MED	integer	5	The minimum number of hops it takes to reach the destination.
localPreference	integer	200	Local preference value determining the best path for outbound traffic.
asPath	array[integer]	[66008,12672]	The list of autonomous systems that must be traversed to reach a given destination.
changeLog
createdDateTime	string	2021-07-15T19:30:29.526Z	Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
updatedDateTime	string	2021-07-15T19:30:29.526Z	Asset update timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000

Search Advertised Routes for Connection

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

Searches Advertised Routes for connection.

Sample curl request - AND logical operator

Path parameters

Parameter	Mandatory	Type	Example	Applicable Values	Description
uuid	yes	string	638895bc-4458-4627-9a3d-02c76ab362d7	-	Equinix-assigned connection Id.

To check the descriptions of Body parameters, see the body parameters of Retrieve Routing Table Entries.

 

Sample response - AND logical operator

To check the descriptions of response parameters, see the response parameters of Search Received Routes for Connection.