Route Filters

Create Route Filter

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

Creates a Route Filter

Sample curl request

Copy

curl -X
POST 'https: //api.equinix.com/fabric/v4/routeFilters'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '
   {
  "type": "BGP_IPv4_PREFIX_FILTER",
  "name": "My-route-filter-v4",
  "description": "Test filter",
  "project": {
    "projectId": 567
  }
}
'

Body parameters

Parameter	Description
type `string` REQUIRED	Route filter type. BGP_IPv4_PREFIX_FILTER BGP_IPv6_PREFIX_FILTER
name `string` OPTIONAL	Name. Example: My-direct-route-1
description `string` OPTIONAL	Connection description. Example:Test filter
project `object` REQUIRED	An object that has the project Id.
projectId `string` REQUIRED	Project Id. Example: 567

Sample response

Copy


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

Response description

Parameter	Description
href `string`	Route filter URI. Example: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d
type `string`	Route filter type. BGP_IPv4_PREFIX_FILTER BGP_IPv6_PREFIX_FILTER
uuid `string`	Route filter Id. Example: 65b025ef-022b-4180-85cf-82cfc1ab655b
name `string`	Name. Example: My-direct-route-1
description `string`	Route filter description. Example: Test filter
state `string`	Route filter state. Example: PROVISIONING REPROVISIONING DEPROVISIONING PROVISIONED DEPROVISIONED NOT_PROVISIONED NOT_DEPROVISIONED
change `object`	An object that has the previous change.
href `string`	Route Filter Change URI. Example: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3
type `string`	Type of change. BGP_IPv4_PREFIX_FILTER_UPDATE BGP_IPv4_PREFIX_FILTER_CREATION BGP_IPv4_PREFIX_FILTER_DELETION BGP_IPv6_PREFIX_FILTER_UPDATE BGP_IPv6_PREFIX_FILTER_CREATION BGP_IPv6_PREFIX_FILTER_DELETION
uuid `string`	Uniquely identifies a change. Example: 65b025ef-022b-4180-85cf-82cfc1ab655b
notMatchedRuleAction `string`	Not matched rule action. Example: DENY ALLOW
connectionsCount `integer`	Connections count. Example: 0
project `object`	An object that has the project Id.
projectId `string`	Project Id. Example: 567
href `string`	URI of the project. Example: https://api.equinix.com/resourceManager/v1/projects/567
changeLog `object`	A permanent record of asset creation, modification, or deletion.
createdBy `string`	Identity of the asset creator. Example: AverageJoe
createdByFullName `string`	First and last name of the asset creator. Example: Joe Average
createdByEmail `string`	Email address of the asset creator. Example: joe@average.org
createdDateTime `string`	Asset creation timestamp in the IETF ISO 8601 extended date/time format: `YYYY-MM-DDTHH:MM:SS.000+0000` Example: 2021-07-15T19:30:29.526Z

Get Route Filter

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

Returns a Route Filter by its unique Id.

Sample curl request

Copy

curl -X
GET 'https: //api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

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

Sample response

Copy


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

Response description

For a detailed description of the response, refer to the response of Create Route Filter.

Search Route Filters

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

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/routeFilters/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
  "filter": {
    "and": [
      {
        "property": "/type",
        "operator": "=",
        "values": [
          "BGP_IPv4_PREFIX_FILTER"
        ]
      },
      {
        "property": "/name",
        "operator": "like",
        "values": [
          "%Route_Filter_Demo%"
        ]
      },
      {
        "property": "/project/projectId",
        "operator": "=",
        "values": [
          "567"
        ]
      }
    ]
  },
  "pagination": {
    "limit": 25,
    "offset": 0,
    "total": 0
  },
  "sort": [
    {
      "property": "/changeLog/updatedDateTime",
      "direction": "DESC"
    }
  ]
}'

Body parameters

Parameter	Description
filter `object` REQUIRED	Object defining search conditions.
and `array[object]` REQUIRED	Array of search parameters.
property `string` REQUIRED	Search parameter. Applicable values: /type /name /project/projectId /uuid /state
operator `string` REQUIRED	Search parameter operator. Applicable values: = LIKE
values `string` REQUIRED	Search parameter value. Example: BGP_IPv4_PREFIX_FILTER
pagination `object` OPTIONAL	Pagination settings.
offset `integer` OPTIONAL	Index of the first item returned in the response. Minimum: 0 Default value: 0
limit `integer` OPTIONAL	Maximum number of items returned per page. Minimum: 1 Maximum: 100 Default value: 20
sort `object` OPTIONAL	Sorting settings.
direction `string` OPTIONAL	Sorting direction. Applicable values: ASC DESC
property `string` OPTIONAL	Sorting parameter. Applicable values: /type /name /project/projectId /uuid /state

/type	Example: "property": "/type", "operator": "=", "values": [ "BGP_IPv4_PREFIX_FILTER" ]
operator `string` REQUIRED	Search parameter. Applicable values: =
value `array[string]` REQUIRED	Route Filter type. Example: BGP_IPv4_PREFIX_FILTER BGP_IPv6_PREFIX_FILTER

/name	Example: "property": "/name", "operator": "LIKE", "values": [ "%Route_filter_demo%" ]
operator `string` REQUIRED	Search parameter . Applicable values: = LIKE
value `array[string]` REQUIRED	Route Filter name. Example: ["%Route_filter_demo%"]

/project/projectId	Example: "property": "/project/projectId", "operator": "=", "values": [ "567 ]
operator `string` REQUIRED	Search parameter. Applicable values: =
value `array[string]` REQUIRED	Project Id. Example: ["567"]

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

/state	Example: "property": "/state", "operator": "=", "values": [ PROVISIONING ]
operator `string` REQUIRED	Search parameter. Applicable values: =
value `array[integer]` REQUIRED	Route filter state. Example: PROVISIONING REPROVISIONING DEPROVISIONING PROVISIONED DEPROVISIONED NOT_PROVISIONED NOT_DEPROVISIONED

Sample response

Copy


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

Response payload body description

For a detailed description of the response, refer to the response of Create Route Filter.

Patch Route Filter

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

Updates a Route Filter partially.

Sample curl request

Copy

curl -X
PATCH 'https: //api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '
[
    {
    "op": "replace",
    "path": "/name",
    "value": "My-route-filter-v4-updated"
    }
]
'

Path parameters

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

Body parameters

Parameter	Description
op `string` REQUIRED	Update request type. Example: replace
path `string` REQUIRED	Parameter path. Example: /name
value `string` REQUIRED	New parameter value. Example: My-route-filter-updated

Sample response

Copy


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

Response description

For a detailed description of the response, refer to the response of Create Route Filter .

Delete Route Filter

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

Deletes a Route Filter by its unique Id.

Sample curl request

Copy

curl -X
DELETE 'https:  //api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

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

Sample response

Copy


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

Response description

For a detailed description of the response, refer to the response of Create Route Filter .

Attach Route Filter To Connection

	PUT /fabric/v4/connections/{connectionId}/routeFilters/{routeFilterId}
Method	PUT
URL or Endpoint	/fabric/v4/connections/{connectionId}/routeFilters/{routeFilterId}
Headers	Authorization, Content-Type
Path Parameters	connectionId, routeFilterId
Query Parameters	Not applicable
Body Parameters	Not applicable

Attaches a Route Filter to a Connection.

Sample curl request

Copy

curl -X
POST 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '
{
    "direction": "INBOUND"
}
'

Path parameters

Parameter	Description
connectionId `string` REQUIRED	Unique Id of a connection. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
routeFilterId `string` REQUIRED	Unique Id of a Route Filter. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

Body parameters

Parameter	Description
direction `string` REQUIRED	Direction of the connection. INBOUND OUTBOUND

Sample response

Copy


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

Response description

For a detailed description of the response, refer to the response of Get Route Filter With Connection.

Detach Route Filter From Connection

	DELETE /fabric/v4/connections/{connectionId}/routeFilters/{routeFilterId}
Method	DELETE
URL or Endpoint	/fabric/v4/connections/{connectionId}/routeFilters/{routeFilterId}
Headers	Authorization, Content-Type
Path Parameters	connectionId, routeFilterId
Query Parameters	Not applicable
Body Parameters	Not applicable

Deletes a Route Filter attached to a connection.

Sample curl request

Copy

curl -X
DELETE 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter	Description
connectionId `string` REQUIRED	Unique Id of a connection. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
routeFilterId `string` REQUIRED	Unique Id of a Route Filter. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

Sample response

Copy


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

Response description

For a detailed description of the response, refer to the response of Get Route Filter.

Get Route Filter With Connection

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

Returns a Route Filter attached to a connection.

Sample response

Copy

curl -X
GET 'https: //api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter	Description
connectionId `string` REQUIRED	Unique Id of a connection. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
routeFilterId `string` REQUIRED	Unique Id of a Route Filter. Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

Sample response

Copy


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

Response description

Parameter	Description
href `string`	Route filter URI. Example: https://api.equinix.com/fabric/v4/connections/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilters/81331c52-04c0-4656-a4a7-18c52669348f
type `string`	Route filter type. BGP_IPv4_PREFIX_FILTER BGP_IPv6_PREFIX_FILTER
uuid `string`	Route filter Id. Example: 65b025ef-022b-4180-85cf-82cfc1ab655b
attachmentStatus `string`	Attachment status. ATTACHING ATTACHED DETACHED DETACHING FAILED
direction `string`	Direction. INBOUND OUTBOUND

Get Route Filters With Connection

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

Returns all Route Filters attached to a connection.

Sample curl request

Copy

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

Path parameters

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

Query parameters

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

Sample response

Copy

{
"pagination": {
    "offset": 0,
    "limit": 20,
    "total": 4,
    "next": null,
    "previous": null
},
"data": [
    {
    "href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
    "type": "BGP_IPv4_PREFIX_FILTER",
    "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
    "attachmentStatus": "DETACHING",
    "direction": "INBOUND"
    },
    {
    "href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeFilters/65d74639-8f48-4e10-9684-45d364645e97",
    "type": "BGP_IPv6_PREFIX_FILTER",
    "uuid": "65d74639-8f48-4e10-9684-45d364645e97",
    "attachmentStatus": "ATTACHED",
    "direction": "OUTBOUND"
    }
]
}

Response description

Parameter	Description
pagination `object`	Pagination settings.
offset `integer`	Index of the first item returned. Example: 0
limit `integer`	Maximum number of items returned per page. Example: 20
total `integer`	Total number of items returned. Example: 10
next `string`	Next data page URL. Example: /search?offset=40&limit=20
previous `string`	Previous data page URL. Example: /search?offset=0&limit=20
data `array[object]`	List of Route Filters attached to the connection.
href `string`	Route filter URI. Example: https://api.equinix.com/fabric/v4/connections/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilters/81331c52-04c0-4656-a4a7-18c52669348f
type `string`	Route filter type. BGP_IPv4_PREFIX_FILTER BGP_IPv6_PREFIX_FILTER
uuid `string`	Route filter Id. Example: 65b025ef-022b-4180-85cf-82cfc1ab655b
attachmentStatus `string`	Attachment status. ATTACHING ATTACHED DETACHED DETACHING FAILED
direction `string`	Direction. INBOUND OUTBOUND

Get Connections Of Route Filter

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

Returns connections of a Route Filter Id.

Sample curl request

Copy

curl -X
GET 'https: //api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/connections'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

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

Sample response

Copy


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

Response description

Parameter	Description
pagination `object`	Pagination settings.
offset `integer`	Index of the first item returned. Example: 0
limit `integer`	Maximum number of items returned per page. Example: 20
total `integer`	Total number of items returned. Example: 10
next `string`	Next data page URL. Example: /search?offset=40&limit=20
previous `string`	Previous data page URL. Example: /search?offset=0&limit=20
data `array[object]`	List of connections of the Route Filter Id.
href `string`	Connection URI. Example: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f
type `string`	Connection type. IP_VC IPWAN_VC
uuid `string`	Route filter Id. Example: 65b025ef-022b-4180-85cf-82cfc1ab655b
name `string`	Connection name. Example Connection-1

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

Create Route Filter

Get Route Filter

Search Route Filters

Patch Route Filter

Delete Route Filter

Attach Route Filter To Connection

Detach Route Filter From Connection

Get Route Filter With Connection

Get Route Filters With Connection

Get Connections Of Route Filter

Was this documentation helpful?