Equinix Fabric API v4 | Equinix Product Documentation

Search Ports

Request

The API provides capability to get list of user's virtual ports using search criteria, including optional filtering, pagination and sorting

Security

BearerAuth

Bodyapplication/jsonrequired

filterobject(PortExpression)required

Either use 'and' for AND operations, 'or' for OR operations, or specify 'property', 'operator', and 'values' for field filtering. Only one of these patterns should be used at a time.

paginationobject(PaginationRequest)

Pagination request information

sortArray of objects(PortSortCriteria)

Payload

{
  "filter": {
    "or": [ … ]
  },
  "pagination": {
    "limit": 1000,
    "offset": 0
  },
  "sort": [
    { … }
  ]
}

Responses

Successful operation

Bodyapplication/json

paginationobject(Pagination)

Pagination response information

dataArray of objects(Port)

GET All User Port Across Fabric Metros

Response

{
  "pagination": {
    "offset": 0,
    "limit": 1000,
    "total": 2
  },
  "data": [
    { … },
    { … }
  ]
}