Equinix Route Filters API

openapi: 3.0.1
info:
  title: Equinix API Authentication Route Filters API
  description: 'Equinix APIs use the OAuth 2.0 for authentication and authorization. Equinix supports the resource owner password and the client credentials flow.

    To begin, obtain OAuth 2.0 client credentials from the Equinix Developer Console under "My Apps". Then your client application  requests an access token from the Equinix API Authorization endpoint, extracts the access_token from the response, and sends the Bearer token to the API that you want to access'
  termsOfService: https://www.equinix.com/about/legal/terms
  contact:
    name: Equinix API Support
    url: https://docs.equinix.com/api-support.htm
  version: '1.2'
servers:
- url: https://api.equinix.com
tags:
- name: Route Filters
  description: Route Filters
paths:
  /fabric/v4/connections/{connectionId}/routeFilters:
    get:
      tags:
      - Route Filters
      summary: Get All Route Filters
      description: This API provides capability to view all Route Filters attached to a Connection
      operationId: getConnectionRouteFilters
      parameters:
      - name: connectionId
        in: path
        description: Connection Id
        required: true
        schema:
          $ref: '#/components/schemas/ConnectionId'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllConnectionRouteFiltersResponse'
              examples:
                ConnectionRouteFiltersResponse:
                  $ref: '#/components/examples/ConnectionRouteFiltersGetAll'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                InvalidInput:
                  $ref: '#/components/examples/400_invalid_input'
                InvalidId:
                  $ref: '#/components/examples/400_Invalid_id'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/403'
        '404':
          description: Route Filter ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/404_invalid_id'
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/415'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/500_internal_error'
  /fabric/v4/connections/{connectionId}/routeFilters/{routeFilterId}:
    get:
      tags:
      - Route Filters
      summary: Get Route Filter
      description: This API provides capability to view a specific Route Filter attached to a Connection
      operationId: getConnectionRouteFilterByUuid
      parameters:
      - name: routeFilterId
        in: path
        description: Route Filters Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteFilterId'
      - name: connectionId
        in: path
        description: Connection Id
        required: true
        schema:
          $ref: '#/components/schemas/ConnectionId'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionRouteFilterData'
              examples:
                ConnectionRouteFilterAttachResponse:
                  $ref: '#/components/examples/AttachConnectionRouteFiltersResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                InvalidInput:
                  $ref: '#/components/examples/400_invalid_input'
                InvalidId:
                  $ref: '#/components/examples/400_Invalid_id'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/403'
        '404':
          description: Route Filter ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/404_invalid_id'
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/415'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/500_internal_error'
    put:
      tags:
      - Route Filters
      summary: Attach Route Filter
      description: This API provides capability to attach a Route Filter to a Connection
      operationId: attachConnectionRouteFilter
      parameters:
      - name: routeFilterId
        in: path
        description: Route Filters Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteFilterId'
      - name: connectionId
        in: path
        description: Connection Id
        required: true
        schema:
          $ref: '#/components/schemas/ConnectionId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectionRouteFiltersBase'
            examples:
              ConnectionRouteFilterAttachInboundExample:
                $ref: '#/components/examples/AttachConnectionRouteFilterInbound'
              ConnectionRouteFilterAttachOutboundExample:
                $ref: '#/components/examples/AttachConnectionRouteFilterOutbound'
        required: true
      responses:
        '202':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionRouteFilterData'
              examples:
                ConnectionRouteFilterAttachResponse:
                  $ref: '#/components/examples/AttachConnectionRouteFiltersResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                InvalidDirection:
                  $ref: '#/components/examples/400_invalid_direction'
                TransientState:
                  $ref: '#/components/examples/400_transient_state'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/403'
        '404':
          description: Route Filter ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/404_invalid_id'
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/415'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/500_internal_error'
    delete:
      tags:
      - Route Filters
      summary: Detach Route Filter
      description: This API provides capability to detach a Route Filter from a Connection
      operationId: detachConnectionRouteFilter
      parameters:
      - name: routeFilterId
        in: path
        description: Route Filters Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteFilterId'
      - name: connectionId
        in: path
        description: Connection Id
        required: true
        schema:
          $ref: '#/components/schemas/ConnectionId'
      responses:
        '202':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionRouteFilterData'
              examples:
                ConnectionRouteFilterDetachInboundResponse:
                  $ref: '#/components/examples/DetachConnectionRouteFilterInboundResponse'
                ConnectionRouteFilterDetachOutboundResponse:
                  $ref: '#/components/examples/DetachConnectionRouteFilterOutboundResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/400_transient_state'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/403'
        '404':
          description: Route Filter ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/404_invalid_id'
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/415'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/500_internal_error'
  /fabric/v4/routeFilters:
    post:
      tags:
      - Route Filters
      summary: Create Route Filters
      description: This API provides capability to create a Route Filter
      operationId: createRouteFilter
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RouteFiltersBase'
            examples:
              RouteFilterBgpIpv4Prefix:
                $ref: '#/components/examples/RouteFilterCreateBgpIpv4Prefix'
              RouteFilterBgpIpv6Prefix:
                $ref: '#/components/examples/RouteFilterCreateBgpIpv6Prefix'
        required: true
      responses:
        '202':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteFiltersData'
              examples:
                GetSpecificRouteFilterResponse:
                  $ref: '#/components/examples/RouteFilterCreateBgpIpv4PrefixResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                TransientState:
                  $ref: '#/components/examples/400_transient_state'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/403'
        '404':
          description: Route Filter ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/404_invalid_id'
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/415'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/500_internal_error'
  /fabric/v4/routeFilters/{routeFilterId}:
    get:
      tags:
      - Route Filters
      summary: Get Route Filter By UUID
      description: This API provides capability to view a Route Filter by UUID
      operationId: getRouteFilterByUuid
      parameters:
      - name: routeFilterId
        in: path
        description: Route Filters Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteFilterId'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteFiltersData'
              examples:
                GetSpecificRouteFilterResponse:
                  $ref: '#/components/examples/RouteFilterCreateBgpIpv4PrefixResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                InvalidInput:
                  $ref: '#/components/examples/400_invalid_input'
                InvalidId:
                  $ref: '#/components/examples/400_Invalid_id'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/403'
        '404':
          description: Route Filter ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/404_invalid_id'
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/415'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/500_internal_error'
    delete:
      tags:
      - Route Filters
      summary: Delete Route Filter
      description: This API provides capability to delete a Route Filter
      operationId: deleteRouteFilterByUuid
      parameters:
      - name: routeFilterId
        in: path
        description: Route Filters Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteFilterId'
      responses:
        '202':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteFiltersData'
              examples:
                RouteFilterDeleteBgpIpv4PrefixResponse:
                  $ref: '#/components/examples/RouteFilterDeleteBgpIpv4PrefixResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/400_attached_connection'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/403'
        '404':
          description: Route Filter ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/404_invalid_id'
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/415'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/500_internal_error'
    patch:
      tags:
      - Route Filters
      summary: Patch Route Filter
      description: This API provides capability to partially update a Route Filter
      operationId: patchRouteFilterByUuid
      parameters:
      - name: routeFilterId
        in: path
        description: Route Filters Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteFilterId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RouteFiltersPatchRequest'
            examples:
              RouteFilterNamePatchExample:
                $ref: '#/components/examples/PatchRouteFilterName'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/RouteFiltersPatchRequest'
            examples:
              RouteFilterNamePatchExample:
                $ref: '#/components/examples/PatchRouteFilterName'
        required: true
      responses:
        '202':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteFiltersData'
              examples:
                RouteFilterNamePatchResponse:
                  $ref: '#/components/examples/RouteFilterNamePatchResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/400_invalid_operation'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/403'
        '404':
          description: Route Filter ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/404_invalid_id'
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/415'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/500_internal_error'
  /fabric/v4/routeFilters/{routeFilterId}/changes:
    get:
      tags:
      - Route Filters
      summary: Get All Changes
      description: This API provides capability to retrieve all of a Route Filter's Changes
      operationId: getRouteFilterChanges
      parameters:
      - name: routeFilterId
        in: path
        description: Route Filters Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteFilterId'
      - name: offset
        in: query
        description: offset
        required: false
        schema:
          type: integer
        example: 1
      - name: limit
        in: query
        description: number of records to fetch
        required: false
        schema:
          type: integer
        example: 10
      responses:
        '200':
          description: Fabric Route Filter Change object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteFilterChangeDataResponse'
              examples:
                RouteFilterChangesResponse:
                  $ref: '#/components/examples/RouteFilterGetAllChangesResponseExample'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                InvalidInput:
                  $ref: '#/components/examples/400_invalid_input'
                InvalidId:
                  $ref: '#/components/examples/400_Invalid_id'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/403'
        '404':
          description: Route Filter ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/404_invalid_id'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/500_internal_error'
  /fabric/v4/routeFilters/{routeFilterId}/changes/{changeId}:
    get:
      tags:
      - Route Filters
      summary: Get Change By ID
      description: This API provides capability to retrieve a specific Route Filter's Changes
      operationId: getRouteFilterChangeByUuid
      parameters:
      - name: routeFilterId
        in: path
        description: Route Filters Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteFilterId'
      - name: changeId
        in: path
        description: Routing Protocol Change UUID
        required: true
        schema:
          $ref: '#/components/schemas/ChangeId_1'
      responses:
        '200':
          description: Fabric Route Filter Change object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteFilterChangeData'
              examples:
                RouteFilterChangeResponse:
                  $ref: '#/components/examples/RouteFilterGetChangeResponseExample'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                InvalidInput:
                  $ref: '#/components/examples/400_invalid_input'
                InvalidId:
                  $ref: '#/components/examples/400_Invalid_id'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/403'
        '404':
          description: Route Filter ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/404_invalid_id'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/500_internal_error'
  /fabric/v4/routeFilters/{routeFilterId}/connections:
    get:
      tags:
      - Route Filters
      summary: Get All Connections on Route Filter
      description: This API provides capability to view all Connections using the Route Filter
      operationId: getRouteFilterConnections
      parameters:
      - name: routeFilterId
        in: path
        description: Route Filters Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteFilterId'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRouteFilterGetConnectionsResponse'
              examples:
                RouteFilterGetConnectionsResponse:
                  $ref: '#/components/examples/RouteFilterGetConnectionsResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                InvalidInput:
                  $ref: '#/components/examples/400_invalid_input'
                InvalidId:
                  $ref: '#/components/examples/400_Invalid_id'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/403'
        '404':
          description: Route Filter ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/404_invalid_id'
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/415'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/500_internal_error'
  /fabric/v4/routeFilters/search:
    post:
      tags:
      - Route Filters
      summary: Search Route Filters
      description: This API provides capability to search Route Filters
      operationId: searchRouteFilters
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RouteFiltersSearchBase'
            examples:
              searchRouteFiltersRequest:
                $ref: '#/components/examples/SearchRouteFiltersRequest'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteFiltersSearchResponse'
              examples:
                SearchRouteFiltersResponse:
                  $ref: '#/components/examples/SearchRouteFiltersResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                InvalidInput:
                  $ref: '#/components/examples/400_invalid_input'
                InvalidId:
                  $ref: '#/components/examples/400_Invalid_

# --- truncated at 32 KB (69 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/equinix/refs/heads/main/openapi/equinix-route-filters-api-openapi.yml