Skip to main content

Query DB for Security Zones (v2.0)

POST 

/v2.0/api/tenants/:tenant_id/securityzones/query

Query the DB for limit number of security zones that match query parameters.

Request

Path Parameters

    tenant_id stringrequired

    The tenant ID.

Body

Query details for security zones

    aggregate Aggregate

    The aggregate number of security zones that match the query parameters.

    field string

    Field

    operator string

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

    Operator

    dest_page int32

    The destination page.

    getDeleted boolean

    The number of security zones deleted for a time frame.

    group_by string[]

    Group the security zones for the query.

    id string

    Lists the security zones 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.

Responses

Successful Operation

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.

    tenant_id string

    The tenant ID.

    total_count int64

    Total number.

    items SecurityZoneQueryFilter[]
  • Array [
  • description

    The description of the security zone. Max size = 256.

    id string

    The security zone ID.

    name string

    The name of the zone. Max size = 128.

  • ]
Loading...