Equinix Fabric API v4 | Equinix Product Documentation

Create Route Filter

Request

This API provides capability to create a Route Filter

Security

BearerAuth

Bodyapplication/jsonrequired

typestringrequired

Route Filter type

Enum:"BGP_IPv4_PREFIX_FILTER""BGP_IPv6_PREFIX_FILTER"

namestringrequired

Example:"My-direct-route-1"

descriptionstring

Customer-provided connection description

projectobject(Project)required

Payload

{
  "type": "BGP_IPv4_PREFIX_FILTER",
  "name": "My-route-filter-v4",
  "description": "Test filter",
  "project": {
    "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
  }
}

Responses

Successful operation

Bodyapplication/json

hrefstring, (uri)

Route filter URI

Example:"https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d"

typestring

Route Filter type

Enum:"BGP_IPv4_PREFIX_FILTER""BGP_IPv6_PREFIX_FILTER"

uuidstring, (uuid)

Route filter identifier

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

namestring

Example:"My-direct-route-1"

descriptionstring

Customer-provided connection description

changeobject(RouteFiltersChange)

Current state of latest route filter change

notMatchedRuleActionstring

Enum:"ALLOW""DENY"

connectionsCountinteger

Example:0

rulesCountinteger

Example:0

projectobject

changelogobject(Changelog)

Change log

Response

{
  "href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
  "type": "BGP_IPv4_PREFIX_FILTER",
  "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
  "name": "My-prefix-filter-v4",
  "description": "Test filter",
  "state": "PROVISIONING",
  "change": {
    "href": "https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3",
    "type": "BGP_IPv4_PREFIX_FILTER_CREATION",
    "uuid": "04af0d37-9160-43d8-97ef-9da9786996a3"
  },
  "notMatchedRuleAction": "DENY",
  "connectionsCount": 0,
  "project": {
    "href": "https://api.equinix.com/resourceManager/v1/projects/567",
    "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
  },
  "changelog": {
    "createdBy": "testuser",
    "createdByEmail": "testuser@equinix.com",
    "createdByFullName": "testuser testuser",
    "createdDateTime": "2020-05-21T10:30:00Z"
  }
}