Equinix

Equinix Route Aggregation Rules API

Route Aggregation Rules

Documentation GitHub OpenAPI

Operations 10

GET /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules GetRARules #

POST /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules Create RARule #

GET /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId} GetRARule By UUID #

PUT /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId} ReplaceRARule #

DELETE /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId} DeleteRARule #

PATCH /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId} PatchRARule #

GET /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}/changes Get All Changes #

GET /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}/changes/{changeId} Get Change By ID #

POST /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/bulk Bulk RARules #

POST /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/search Search Route Aggregation Rules #

Documentation

📖

Documentation

https://developer.equinix.com/catalog/fabricv4

📖

Documentation

https://deploy.equinix.com/developers/api/metal/

📖

Documentation

https://developer.equinix.com/catalog/eiav2

📖

Documentation

https://developer.equinix.com/catalog/lookupv2

📖

Documentation

https://developer.equinix.com/catalog/ordersv2

📖

Documentation

https://developer.equinix.com/catalog/orderhistoryv1

📖

Documentation

https://developer.equinix.com/catalog/securecabinetv1

📖

Documentation

https://developer.equinix.com/catalog/smarthandsv1

📖

Documentation

https://developer.equinix.com/catalog/accesstokenv1

📖

Documentation

https://developer.equinix.com/catalog/stsv1alpha

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/equinix/refs/heads/main/openapi/equinix-route-aggregation-rules-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/equinix-route-aggregation-rules-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Equinix Fabric API v4 Route Aggregation Rules API
  description: 'Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to: </br> 1. Cloud Service Providers - Clouds, network and other service providers.  </br> 2. Enterprises - Other Equinix customers, vendors and partners.  </br> 3. Myself - Another customer instance deployed at Equinix. </br> </br> <b>Integrations (SDKs, Tools) links:</b> </br> <a href="https://github.com/equinix/equinix-sdk-java">Fabric Java SDK</a> </br> <a href="https://github.com/equinix/equinix-sdk-go">Fabric Go SDK</a> </br> <a href="https://github.com/equinix/equinix-sdk-python">Fabric Python SDK</a> </br> <a href="https://registry.terraform.io/providers/equinix/equinix/latest/docs">Equinix Terraform Provider</a> </br> <a href="https://registry.terraform.io/modules/equinix/fabric/equinix/latest">Fabric Terraform Modules</a> </br> <a href="https://www.pulumi.com/registry/packages/equinix/">Equinix Pulumi Provider</a> </br>'
  termsOfService: https://www.equinix.com/about/legal/terms
  contact:
    name: Equinix API Support
    url: https://docs.equinix.com/api-support.htm
  license:
    name: Equinix Inc
    url: https://developer.equinix.com/agreement
  version: '4.28'
servers:
- url: https://api.equinix.com
  description: Equinix Inc
security:
- BearerAuth: []
tags:
- name: Route Aggregation Rules
  description: Route Aggregation Rules
paths:
  /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules:
    get:
      tags:
      - Route Aggregation Rules
      summary: GetRARules
      description: This API provides capability to get all Route Aggregations Rules for Fabric
      operationId: getRouteAggregationRules
      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: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRouteAggregationRulesResponse'
              examples:
                getAllRouteAggregationRules:
                  $ref: '#/components/examples/RouteAggregationRulesGetAll'
        '400':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/404_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 Rule ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/500_internal_error'
    post:
      tags:
      - Route Aggregation Rules
      summary: Create RARule
      description: This API provides capability to create a Route Aggregation Rule
      operationId: createRouteAggregationRule
      parameters:
      - name: routeAggregationId
        in: path
        description: Route Aggregations Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteAggregationId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RouteAggregationRulesBase'
            examples:
              RouteAggregationRuleBgpIpv4Prefix:
                $ref: '#/components/examples/RouteAggregationRuleCreateBgpIpv4Prefix'
        required: true
      responses:
        '202':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteAggregationRulesData'
              examples:
                GetSpecificRouteAggregationRuleIpv4Response:
                  $ref: '#/components/examples/RouteAggregationRuleCreateBgpIpv4PrefixResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                InvalidType:
                  $ref: '#/components/examples/400_bad_request'
                InvalidId:
                  $ref: '#/components/examples/404_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 Rule ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
        '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}/routeAggregationRules/{routeAggregationRuleId}:
    get:
      tags:
      - Route Aggregation Rules
      summary: GetRARule By UUID
      description: This API provides capability to view a Route Aggregation Rule by UUID
      operationId: getRouteAggregationRuleByUuid
      parameters:
      - name: routeAggregationId
        in: path
        description: Route Aggregations Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteAggregationId'
      - name: routeAggregationRuleId
        in: path
        description: Route Aggregation Rules Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteAggregationRuleId'
      responses:
        '202':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteAggregationRulesData'
              examples:
                GetSpecificRouteAggregationRuleIpv4Response:
                  $ref: '#/components/examples/RouteAggregationRuleCreateBgpIpv4PrefixResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                InvalidType:
                  $ref: '#/components/examples/400_bad_request'
                InvalidId:
                  $ref: '#/components/examples/404_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 Aggregation Rules
      summary: ReplaceRARule
      description: This API provides capability to replace a Route Aggregation Rule completely
      operationId: replaceRouteAggregationRuleByUuid
      parameters:
      - name: routeAggregationId
        in: path
        description: Route Aggregations Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteAggregationId'
      - name: routeAggregationRuleId
        in: path
        description: Route Aggregation Rules Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteAggregationRuleId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RouteAggregationRulesBase'
            examples:
              RouteaggregationIpv4ReplaceExample:
                $ref: '#/components/examples/UpdateRouteAggregationRuleIPv4'
        required: true
      responses:
        '202':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteAggregationRulesData'
              examples:
                RouteAggregationRuleIpv4ReplaceResponse:
                  $ref: '#/components/examples/RouteAggregationRuleReplaceIpv4Response'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                InvalidType:
                  $ref: '#/components/examples/400_bad_request'
                InvalidId:
                  $ref: '#/components/examples/404_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 Aggregation Rules
      summary: DeleteRARule
      description: This API provides capability to delete a Route aggregation Rule
      operationId: deleteRouteAggregationRuleByUuid
      parameters:
      - name: routeAggregationId
        in: path
        description: Route Aggregations Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteAggregationId'
      - name: routeAggregationRuleId
        in: path
        description: Route Aggregation Rules Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteAggregationRuleId'
      responses:
        '202':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteAggregationRulesData'
              examples:
                RouteAggregationDeleteBgpIpv4PrefixResponse:
                  $ref: '#/components/examples/RouteAggregationRuleDeleteBgpIpv4PrefixResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/400_transient_aggregation'
        '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 Aggregation Rules
      summary: PatchRARule
      description: This API provides capability to partially update a Route Aggregation Rule
      operationId: patchRouteAggregationRuleByUuid
      parameters:
      - name: routeAggregationId
        in: path
        description: Route Aggregations Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteAggregationId'
      - name: routeAggregationRuleId
        in: path
        description: Route Aggregation Rules Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteAggregationRuleId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RouteAggregationRulesPatchRequest'
            examples:
              RouteaggregationRuleName:
                $ref: '#/components/examples/PatchRouteAggregationRuleName'
              RouteaggregationRulePrefix:
                $ref: '#/components/examples/PatchRouteAggregationRulePrefix'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/RouteAggregationRulesPatchRequest'
            examples:
              RouteaggregationRuleName:
                $ref: '#/components/examples/PatchRouteAggregationRuleName'
              RouteaggregationRulePrefix:
                $ref: '#/components/examples/PatchRouteAggregationRulePrefix'
        required: true
      responses:
        '202':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteAggregationRulesData'
              examples:
                RouteAggregationRuleIpv4ReplaceResponse:
                  $ref: '#/components/examples/RouteAggregationRuleReplaceIpv4Response'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                InvalidType:
                  $ref: '#/components/examples/400_bad_request'
                InvalidId:
                  $ref: '#/components/examples/404_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/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}/changes:
    get:
      tags:
      - Route Aggregation Rules
      summary: Get All Changes
      description: This API provides capability to retrieve all of a Route Aggregation Rule's Changes
      operationId: getRouteAggregationRuleChanges
      parameters:
      - name: routeAggregationId
        in: path
        description: Route Aggregations Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteAggregationId'
      - name: routeAggregationRuleId
        in: path
        description: Route Aggregation Rules Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteAggregationRuleId'
      - 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 Rule Change object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteAggregationRulesChangeDataResponse'
              examples:
                RouteAggregationRuleChangesResponse:
                  $ref: '#/components/examples/RouteAggregationRulesGetAllChangesResponseExample'
        '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}/routeAggregationRules/{routeAggregationRuleId}/changes/{changeId}:
    get:
      tags:
      - Route Aggregation Rules
      summary: Get Change By ID
      description: This API provides capability to retrieve a specific Route Aggregation Rule's Changes
      operationId: getRouteAggregationRuleChangeByUuid
      parameters:
      - name: routeAggregationId
        in: path
        description: Route Aggregations Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteAggregationId'
      - name: routeAggregationRuleId
        in: path
        description: Route Aggregation Rules Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteAggregationRuleId'
      - name: changeId
        in: path
        description: Route Aggregation Rule Change UUID
        required: true
        schema:
          $ref: '#/components/schemas/ChangeId_4'
      responses:
        '200':
          description: Fabric Route Aggregation Change object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteAggregationRulesChangeData'
              examples:
                RouteAggregationChangeResponse:
                  $ref: '#/components/examples/RouteAggregationRuleGetChangeResponseExample'
        '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}/routeAggregationRules/bulk:
    post:
      tags:
      - Route Aggregation Rules
      summary: Bulk RARules
      description: This API provides capability to create bulk route aggregation rules
      operationId: createRouteAggregationRulesInBulk
      parameters:
      - name: routeAggregationId
        in: path
        description: Route Aggregations Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteAggregationId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RouteAggregationRulesPostRequest'
        required: true
      responses:
        '202':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRouteAggregationRulesResponse'
              examples:
                getAllRouteAggregationRules:
                  $ref: '#/components/examples/RouteAggregationRulesBulkResponse'
        '400':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/404_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: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              examples:
                example:
                  $ref: '#/components/examples/400'
        '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}/routeAggregationRules/search:
    post:
      tags:
      - Route Aggregation Rules
      summary: Search Route Aggregation Rules
      description: This API provides capability to search Route Aggregation Rules
      operationId: searchRouteAggregationRules
      parameters:
      - name: routeAggregationId
        in: path
        description: Route Aggregations Id
        required: true
        schema:
          $ref: '#/components/schemas/RouteAggregationId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RouteAggregationRulesSearchRequest'
            examples:
              SearchRouteAggregationRulesAndRequest:
                $ref: '#/components/examples/SearchRouteAggregationRulesAndRequest'
              SearchRouteAggregationRulesOrRequest:
                $ref: '#/components/examples/SearchRouteAggregationRulesOrRequest'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteAggregationRulesSearchResponse'
              examples:
                SearchRouteAggregationRulesResponse:
                  $ref: '#/components/examples/SearchRouteAggregationRulesResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
        '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 Rule ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
        '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'
components:
  examples:
    400_transient_aggregation:
      value:
      - errorCode: EQ-3044415
        errorMessage: Cannot delete route aggregation rule, route aggregation in transient state
        correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515
        details: Cannot delete route aggregation rule, route aggregation is in transient state
    RouteAggregationRuleCreateBgpIpv4Prefix:
      value:
        name: Private-subnet-aggregation
        description: Test rule
        prefix: 192.168.0.0/24
    UpdateRouteAggregationRuleIPv4:
      value:
        name: Private-subnet-aggregation-update
        description: Test rule
        prefix: 192.168.0.0/24
    PatchRouteAggregationRuleName:
      value:
      - op: replace
        path: /name
        value: test-route-aggregation-name-patch
    400_bad_request:
      value:
      - errorCode: EQ-3044013
        errorMessage: Invalid argument value passed
        property: prefixMatch
        correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec
    RouteAggregationRulesBulkResponse:
      value:
        pagination:
          offset: 0
          limit: 32
          total: 2
          next: null
          previous: null
        data:
        - href: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/65b025ef-022b-4180-85cf-82cfc1ab655b
          type: BGP_IPv4_PREFIX_AGGREGATION_RULE
          uuid: 65b025

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