Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Equinix Route Aggregation Rules API

Route Aggregation Rules

Equinix Route Aggregation Rules API is one of 74 APIs that Equinix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Route Aggregation Rules. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 10 operations across 6 paths, and defines 30 schemas. It is described by OpenAPI 3.0.1, at version 1.2.

Requests are made against a single base URL, https://api.equinix.com.

10 operations 6 paths 30 schemas 1 DELETE4 GET1 PATCH3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.2
Base URL
https://api.equinix.com
Terms of Service
Resource Areas
1

Paths & Operations 10

Across 6 paths, the API surfaces 10 operations — 1 DELETE, 4 GET, 1 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Route Aggregation Rules 10

Route Aggregation Rules

GET
/fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules
GetRARules
getRouteAggregationRules 3 params → 200400401403404500
POST
/fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules
Create RARule
createRouteAggregationRule 1 param body → 202400401403404415500
GET
/fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}
GetRARule By UUID
getRouteAggregationRuleByUuid 2 params → 202400401403404415500
PUT
/fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}
ReplaceRARule
replaceRouteAggregationRuleByUuid 2 params body → 202400401403404415500
DELETE
/fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}
DeleteRARule
deleteRouteAggregationRuleByUuid 2 params → 202400401403404415500
PATCH
/fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}
PatchRARule
patchRouteAggregationRuleByUuid 2 params body → 202400401403404415500
GET
/fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}/changes
Get All Changes
getRouteAggregationRuleChanges 4 params → 200400401403404500
GET
/fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}/changes/{changeId}
Get Change By ID
getRouteAggregationRuleChangeByUuid 3 params → 200400401403404500
POST
/fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/bulk
Bulk RARules
createRouteAggregationRulesInBulk 1 param body → 202400401403404415500
POST
/fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/search
Search Route Aggregation Rules
searchRouteAggregationRules 1 param body → 200400401403404415500

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are Changelog (12 properties), RouteAggregationRulesData (9 properties), RouteAggregationRulesChangeData (6 properties), Error (6 properties). Each schema is shown below with its type and property counts.

RouteAggregationRuleSortBy
string
Possible field names to use on sorting
PriceError_additionalInfo
object
2 properties
RouteAggregationId
string
Route Aggregations UUID
RouteAggregationRulesData
object
9 properties
RouteAggregationRulesPatchRequestItem
object
Route Aggregation Rule change operation data
3 properties 3 required
RouteAggregationRulesSearchResponse
object
2 properties
RouteAggregationRulesFilter
Top-level filter that can be either an AND expression or OR expression
Pagination
object
Pagination response information
5 properties 2 required
RouteAggregationRulesChangeData
object
Current state of latest Route Aggregation Rules change
6 properties
ErrorList
array
List of Error Message
Changelog
object
Change log
12 properties
RouteAggregationRulesChangeDataResponse
object
List of Route Aggregation Rule changes
2 properties
RouteAggregationRuleId
string
Route Aggregation Rule UUID
RouteAggregationRuleAndExpression
object
AND expression containing multiple filter expressions
1 property
RouteAggregationRuleSortCriteria
object
2 properties
RouteAggregationRulesChangeOperation
object
Route Aggregation Rule change operation data
3 properties 3 required
RouteAggregationRuleState
string
Route Aggregation Rule status
RouteAggregationRuleExpression
Filter expression that can be AND, OR, or a simple expression
RouteAggregationRulesPatchRequest
array
Patch Route Aggregations Rule request
RouteAggregationRulesBase
object
3 properties 1 required
GetRouteAggregationRulesResponse
object
2 properties
RouteAggregationRuleSortDirection
string
Sorting direction
RouteAggregationRulesSearchRequest
object
Search route aggregation rules
3 properties
RouteAggregationRulesPostRequest
object
Create Route Aggregation Rule POST request
1 property
RouteAggregationRuleOrExpression
object
OR expression containing multiple filter expressions
1 property
RouteAggregationRulesChange
object
Current state of latest Route Aggregation Rule change
3 properties 2 required
Error
object
Error Response with details
6 properties 2 required
ChangeId_4
string
Route Aggregation Rule Change UUID
RouteAggregationRuleSimpleExpression
object
Simple filter expression with property, operator, and values
3 properties
PaginationRequest
object
Pagination request information
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

equinix-route-aggregation-rules-api-openapi.yml Raw ↑

Other APIs Equinix publishes across the network.

Equinix Agent Templates API
Equinix Agents API
Equinix Authentication API
Equinix availability API
Equinix Batches API
Equinix BGP API
Equinix Capacity API
Equinix Cloud Events API
Equinix Cloud Routers API
Equinix Company Profiles API
Equinix Connections API
Equinix Console Log Details API