Equinix Fabric API v4 | Equinix Product Documentation

Search Commands

Request

This API provides capability to search commands

Security

BearerAuth

Path

routerIdstring, (uuid)required

Router UUID

Example:557400f8-d360-11e9-bb65-2a2ae2dbcce4

Bodyapplication/jsonrequired

filterobject(CloudRouterCommandSearchFilters)

paginationobject(PaginationRequest)

Pagination request information

sortArray of objects(CloudRouterCommandSearchSortCriteria)

Payload

{
  "filter": {
    "and": [ … ]
  },
  "pagination": {
    "offset": 0,
    "limit": 20
  },
  "sort": [
    { … }
  ]
}

Responses

Successful operation

Bodyapplication/json

paginationobject(Pagination)

Pagination response information

dataArray of objects(CloudRouterCommand)

Data returned from the API call.

Response

{
  "pagination": {
    "offset": 20,
    "limit": 20,
    "total": 100,
    "next": "/search?offset=40&limit=20",
    "previous": "/search?offset=0&limit=20"
  },
  "data": [
    { … }
  ]
}