Query Vff License Tokens (v2.0)

POST 
/sdwan/v2.0/api/vfflicenses/tokens/query

Query all the tenant Vff license tokens.

Request

application/json

Body

aggregate Aggregate

The aggregate number of vff tokens 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 of vff tokens deleted for a time frame.

group_by string[]

Group the vff tokens for the query.

id string

List the vff tokens 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.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

deleted_count int64

The deleted number.

deleted_ids string[]

The deleted IDs.

description

Description of the query. Max size = 256.

id string

The ID.

next_query object

Details of the next query.

total_count int64

Total number.

items VffTokenQueryFilter[]
Array [
id string
The ID of the vff token.
ion_key string
The ION key.
is_expired boolean
Is vff token expired. True or False.
is_multiuse boolean
Is the vff token multiuse. True or False.
is_revoked boolean
Can the vff token be revoked. True or False.
is_used boolean
Is the vff token in use. True or False.
secret_key string
The secret key.
valid_till_secs int64
The token valid time in seconds.
vfflicense_id string
The vff license ID.
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "total_count": 0,
  "items": [
    {
      "id": "string",
      "ion_key": "string",
      "is_expired": true,
      "is_multiuse": true,
      "is_revoked": true,
      "is_used": true,
      "secret_key": "string",
      "valid_till_secs": 0,
      "vfflicense_id": "string"
    }
  ]
}

Loading...