Equinix Fabric API v4 | Equinix Product Documentation

Create Route Filter Rule

Request

This API provides capability to create a Route Filter Rule

Security

BearerAuth

Path

routeFilterIdstringrequired

Route Filters Id

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

Bodyapplication/jsonrequired

namestring

Example:"Private-subnet-filter"

descriptionstring

Customer-provided Route Filter Rule description

prefixstringrequired

Example:"192.168.0.0/24"

prefixMatchstring

Default:"orlonger"

Example:"orlonger, exact"

Payload

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

Responses

Successful operation

Bodyapplication/json

hrefstring, (uri)

Route Filter Rules URI

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

typestring

Route filter type

Enum:"BGP_IPv4_PREFIX_FILTER_RULE""BGP_IPv6_PREFIX_FILTER_RULE"

uuidstring, (uuid)

Route Filter Rule identifier

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

namestring

Example:"Private-subnet-filter-2"

descriptionstring

Customer-provided Route Filter Rule description

statestring(RouteFilterRuleState)

Route filter rule status

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

prefixMatchstring

prefix matching operator

Default:"orlonger"

Example:"exact"

changeobject(RouteFilterRulesChange)

Current state of latest route filter rule change

actionstring

Enum:"PERMIT""DENY"

prefixstring

Example:"192.168.0.0/24"

changelogobject(Changelog)

Change log

Response

{
  "href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403",
  "type": "BGP_IPv4_PREFIX_FILTER_RULE",
  "uuid": "9890d520-1579-4489-8003-154b34b8f403",
  "name": "Private-subnet-filter",
  "state": "PROVISIONING",
  "description": "Test rule",
  "change": {
    "href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/ff9653dc-88c5-47b5-b552-8a08d2f73f7e",
    "type": "BGP_IPv4_PREFIX_FILTER_RULE_CREATION",
    "uuid": "ff9653dc-88c5-47b5-b552-8a08d2f73f7e"
  },
  "action": "PERMIT",
  "prefix": "192.168.0.0/24",
  "prefixMatch": "exact",
  "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"
  }
}