Get Machines of Tenant (v2.5)

GET 
/sdwan/v2.5/api/machines

Get all the machines of a tenant.

Responses

200

Successful Operation

application/json

Schema

Schema

items undefined[]
aggregate Aggregate

The aggregate number of machines that match the query parameters.

data AggregateData[]

The details of the aggregate data.

Array [

value number

Value of the aggregate data.

view object

View the aggregate date.

]

field string

The field value.

name string

The name of the query response.

operator string

Possible values: [max, count, min, avg, sum]

The operator values.

statistic string

The aggregate statistics.

unit string

The unit.

dest_page int32

The destination page.

getDeleted boolean

The number machines deleted for a time frame.

group_by string[]

Group the machines for the query.

id string

List the machines by ID.

last_query_ts int64

Return the ID of a specified query in the current session.

limit int32

The query limit.

next_query object

The limit.

query_params object

Query using query parameters.

retrieved_fields string[]

Retrieve information from a field.

retrieved_fields_mask boolean

List the fields to query.

sort_params object

Specify the order in which you want the search criteria to display.

total_count int64

The total number of query parameters.

Example (from schema)

{
  "aggregate": {
    "data": [
      {
        "value": 0,
        "view": {}
      }
    ],
    "field": "string",
    "name": "string",
    "operator": "max",
    "statistic": "string",
    "unit": "string"
  },
  "dest_page": 0,
  "getDeleted": true,
  "group_by": [
    "string"
  ],
  "id": "string",
  "last_query_ts": 0,
  "limit": 0,
  "next_query": {},
  "query_params": {},
  "retrieved_fields": [
    "string"
  ],
  "retrieved_fields_mask": true,
  "sort_params": {},
  "total_count": 0,
  "items": [
    null
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "TENANT_REGION_ASSOCIATION_NOT_FOUND"
      },
      {
        "code": "MACHINE_UNKNOWN"
      }
    ]
  }
}

404

Machines not found

Loading...