Query DB for IPSEC Profiles (v2.0)
Query the DB for limit number of tenant level IPsec profiles that match the query parameters.
Path Parameters
- tenant_id string required
The ID of the tenant.
- application/json
Request Body
Query Details for IPSECProfile
aggregate Aggregate
The aggregate number of IPsec profiles that match the query parameters.
field stringThe field value.
operator stringPossible values: [
max
,count
,min
,avg
,sum
]The operator values.
- dest_page int32
The destination page.
- getDeleted boolean
The number of IPsec profiles deleted for a time frame.
- group_by string[]
Group the IPsec profiles for the query.
- id string
Lists the IPsec profiles 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
- retrieved_fields string[]
Retrieve information from a field.
- retrieved_fields_mask boolean
List the fields to query.
- sort_params object
- total_count int64
The total number of query parameters.
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- count int32
The count of the query list.
- deleted_count int64
The deleted number of queries.
- deleted_ids string[]
The deleted query IDs.
- description
Description of the query. Max size = 256.
- id string
The ID.
- next_query object
Details of the next query.
- tenant_id string
- total_count int64
Total number of queries.
items SiteIPFixPrefixAssociation[]
Array [id stringThe ID of the IPFIX prefix.
ipv4_prefixes string[]The individual IP address.
prefix_id stringThe prefix ID that associates with a site.
tags string[]A information field that can be added to identify the prefix. Maximum 10 unique tags of length 1024 each are allowed.
]
{
"count": 0,
"deleted_count": 0,
"deleted_ids": [
"string"
],
"id": "string",
"next_query": {},
"tenant_id": "string",
"total_count": 0,
"items": [
{
"id": "string",
"ipv4_prefixes": [
"string"
],
"prefix_id": "string",
"tags": [
"string"
]
}
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
_error ErrorResponse[]
Array [code stringmessage string]
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "BAD_QUERY_REQUEST"
}
]
}
}