Equinix Route Aggregations API

openapi: 3.0.1
info:
  title: Equinix API Authentication Route Aggregations 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 Aggregations
  description: Route Aggregations
paths:
  /fabric/v4/connections/{connectionId}/routeAggregations:
    get:
      tags:
      - Route Aggregations
      summary: Get All Aggregations
      description: This API provides capability to view all Route Aggregations attached to a Connection
      operationId: getConnectionRouteAggregations
      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/GetAllConnectionRouteAggregationsResponse'
              examples:
                ConnectionRouteAggregationsResponse:
                  $ref: '#/components/examples/ConnectionRouteAggregationsGetAll'
        '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 Aggregation 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}/routeAggregations/{routeAggregationId}:
    get:
      tags:
      - Route Aggregations
      summary: Get Aggregation
      description: This API provides capability to view a specific Route Aggregation attached to a Connection
      operationId: getConnectionRouteAggregationByUuid
      parameters:
      - name: routeAggregationId
        in: path
        description: Route Aggregations Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteAggregationId'
      - 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/ConnectionRouteAggregationData'
              examples:
                ConnectionRouteAggregationAttachResponse:
                  $ref: '#/components/examples/AttachConnectionRouteAggregationsResponse'
        '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 Aggregation 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 Aggregations
      summary: Attach Aggregation
      description: This API provides capability to attach a Route Aggregation to a Connection
      operationId: attachConnectionRouteAggregation
      parameters:
      - name: routeAggregationId
        in: path
        description: Route Aggregations Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteAggregationId'
      - 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/ConnectionRouteAggregationData'
              examples:
                ConnectionRouteAggregationAttachResponse:
                  $ref: '#/components/examples/AttachConnectionRouteAggregationsResponse'
        '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 Aggregation 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 Aggregations
      summary: Detach Aggregation
      description: This API provides capability to detach a Route Aggregation from a Connection
      operationId: detachConnectionRouteAggregation
      parameters:
      - name: routeAggregationId
        in: path
        description: Route Aggregations Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteAggregationId'
      - 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/ConnectionRouteAggregationData'
              examples:
                ConnectionRouteAggregationDetachResponse:
                  $ref: '#/components/examples/DetachConnectionRouteAggregationResponse'
        '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 Aggregation 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/routeAggregations:
    post:
      tags:
      - Route Aggregations
      summary: Create Aggregations
      description: This API provides capability to create a Route Aggregation
      operationId: createRouteAggregation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RouteAggregationsBase'
            examples:
              RouteAggregationBgpIpv4Prefix:
                $ref: '#/components/examples/RouteAggregationCreateBgpIpv4Prefix'
        required: true
      responses:
        '202':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteAggregationsData'
              examples:
                GetSpecificRouteAggregationResponse:
                  $ref: '#/components/examples/RouteAggregationCreateBgpIpv4PrefixResponse'
        '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 Aggregation 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/routeAggregations/{routeAggregationId}:
    get:
      tags:
      - Route Aggregations
      summary: Get Aggregation
      description: This API provides capability to view a Route Aggregation by UUID
      operationId: getRouteAggregationByUuid
      parameters:
      - name: routeAggregationId
        in: path
        description: Route Aggregations Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteAggregationId'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteAggregationsData'
              examples:
                GetSpecificRouteAggregationResponse:
                  $ref: '#/components/examples/RouteAggregationCreateBgpIpv4PrefixResponse'
        '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 Aggregation 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 Aggregations
      summary: Delete Aggregation
      description: This API provides capability to delete a Route Aggregation
      operationId: deleteRouteAggregationByUuid
      parameters:
      - name: routeAggregationId
        in: path
        description: Route Aggregations Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteAggregationId'
      responses:
        '202':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteAggregationsData'
              examples:
                RouteAggregationDeleteBgpIpv4PrefixResponse:
                  $ref: '#/components/examples/RouteAggregationDeleteBgpIpv4PrefixResponse'
        '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 Aggregation 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 Aggregations
      summary: Patch Aggregation
      description: This API provides capability to partially update a Route Aggregation
      operationId: patchRouteAggregationByUuid
      parameters:
      - name: routeAggregationId
        in: path
        description: Route Aggregations Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteAggregationId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RouteAggregationsPatchRequest'
            examples:
              RouteAggregationNamePatchExample:
                $ref: '#/components/examples/PatchRouteAggregationName'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/RouteAggregationsPatchRequest'
            examples:
              RouteAggregationNamePatchExample:
                $ref: '#/components/examples/PatchRouteAggregationName'
        required: true
      responses:
        '202':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteAggregationsData'
              examples:
                RouteAggregationNamePatchResponse:
                  $ref: '#/components/examples/RouteAggregationNamePatchResponse'
        '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 Aggregation 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/routeAggregations/{routeAggregationId}/changes:
    get:
      tags:
      - Route Aggregations
      summary: Get All Changes
      description: This API provides capability to retrieve all of a Route Aggregation's Changes
      operationId: getRouteAggregationChanges
      parameters:
      - name: routeAggregationId
        in: path
        description: Route Aggregations Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteAggregationId'
      - 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 Aggregation Change object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteAggregationChangeDataResponse'
              examples:
                RouteAggregationChangesResponse:
                  $ref: '#/components/examples/RouteAggregationGetAllChangesResponseExample'
        '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 Aggregation 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/routeAggregations/{routeAggregationId}/changes/{changeId}:
    get:
      tags:
      - Route Aggregations
      summary: Get Change By ID
      description: This API provides capability to retrieve a specific Route Aggregation's Changes
      operationId: getRouteAggregationChangeByUuid
      parameters:
      - name: routeAggregationId
        in: path
        description: Route Aggregations Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteAggregationId'
      - name: changeId
        in: path
        description: Routing Protocol Change UUID
        required: true
        schema:
          $ref: '#/components/schemas/ChangeId_3'
      responses:
        '200':
          description: Fabric Route Aggregation Change object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteAggregationChangeData'
              examples:
                RouteAggregationChangeResponse:
                  $ref: '#/components/examples/RouteAggregationGetChangeResponseExample'
        '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 Aggregation 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/routeAggregations/{routeAggregationId}/connections:
    get:
      tags:
      - Route Aggregations
      summary: Get All Connections on Route Aggregation
      description: This API provides capability to view all Connections using the Route Aggregation
      operationId: getRouteAggregationConnections
      parameters:
      - name: routeAggregationId
        in: path
        description: Route Aggregations Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteAggregationId'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRouteAggregationGetConnectionsResponse'
              examples:
                RouteAggregationGetConnectionsResponse:
                  $ref: '#/components/examples/RouteAggregationGetConnectionsResponse'
        '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 Aggregation 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/routeAggregations/search:
    post:
      tags:
      - Route Aggregations
      summary: Search Aggregations
      description: This API provides capability to search Route Aggregations
      operationId: searchRouteAggregations
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RouteAggregationsSearchBase'
            examples:
              searchRouteAggregationsRequest:
                $ref: '#/components/examples/SearchRouteAggregationsRequest'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteAggregationsSearchResponse'
              examples:
                SearchRouteAggregationsResponse:
                  $ref: '#/components/examples/SearchRouteAggregationsResponse'
        '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/ErrorLi

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