Equinix Fabric API v4 | Equinix Product Documentation

Create Route Aggregation Rule

Request

This API provides capability to create a Route Aggregation Rule

Security

BearerAuth

Path

routeAggregationIdstringrequired

Route Aggregations Id

Example:695a8471-6595-4ac6-a2f4-b3d96ed3a59d

Bodyapplication/jsonrequired

namestring

Example:"Private-subnet-Aggregation"

descriptionstring

Customer-provided Route Aggregation Rule description

prefixstringrequired

Example:"192.168.0.0/24"

Payload

{
  "name": "Private-subnet-aggregation",
  "description": "Test rule",
  "prefix": "192.168.0.0/24"
}

Responses

Successful operation

Bodyapplication/json

hrefstring, (uri)

Route Aggregation Rules URI

Example:"https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/65b025ef-022b-4180-85cf-82cfc1ab655b"

typestring

Route Aggregation type

Value:"BGP_IPv4_PREFIX_AGGREGATION_RULE"

uuidstring, (uuid)

Route Aggregation Rule identifier

Example:"65b025ef-022b-4180-85cf-82cfc1ab655b"

namestring

Example:"Private-subnet-aggregation-2"

descriptionstring

Customer-provided Route Aggregation Rule description

statestring(RouteAggregationRuleState)

Route Aggregation Rule status

Enum:"PROVISIONING""REPROVISIONING""DEPROVISIONING""PROVISIONED""DEPROVISIONED""NOT_PROVISIONED""NOT_DEPROVISIONED"

changeobject(RouteAggregationRulesChange)

Current state of latest Route Aggregation Rule change

prefixstring

Example:"192.168.0.0/24"

changeLogobject(Changelog)

Change log

Response

{
  "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403",
  "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
  "uuid": "9890d520-1579-4489-8003-154b34b8f403",
  "name": "Private-subnet-aggregation",
  "state": "PROVISIONING",
  "description": "Test rule",
  "change": {
    "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/ff9653dc-88c5-47b5-b552-8a08d2f73f7e",
    "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION",
    "uuid": "ff9653dc-88c5-47b5-b552-8a08d2f73f7e"
  },
  "prefix": "192.168.0.0/24",
  "changeLog": {
    "createdBy": "testuser",
    "createdByEmail": "testuser@equinix.com",
    "createdByFullName": "testuser testuser",
    "createdDateTime": "2020-05-21T10:30:00Z",
    "updatedBy": "testuser",
    "updatedByEmail": "testuser@equinix.com",
    "updatedByFullName": "testuser testuser",
    "updatedDateTime": "2020-05-21T10:30:00Z"
  }
}