List saved queries

ListAssessmentQueries retrieves a list of all built-in and user-created queries.

By default, this endpoint returns only the queries that are currently enabled. When the risks_only parameter is set to true, it will only return queries with a risk level.

get
Authorizations
AuthorizationstringRequired

Veza API key for authentication. Generate keys in Administration > API Keys.

Query parameters
include_inactive_queriesbooleanOptional
violations_onlybooleanOptionalDeprecated
risks_onlybooleanOptional
include_resultsbooleanOptional
include_natural_languagebooleanOptional
include_risk_statisticsbooleanOptional
filterstringOptional
order_bystringOptional
rules_filterinteger ยท enumOptional
query_variant_filterinteger ยท enumOptional
page_sizeinteger ยท int32Optional

The maximum number of results to be returned. Fewer results may be returned even when more pages exist.

page_tokenstringOptional

The token specifying the specific page of results to retrieve.

Responses
chevron-right
200

OK

application/json
next_page_tokenstringOptional

The pagination token to retrieve the next page of results.

has_morebooleanOptional

If true, more results are available.

get
/api/v1/assessments/queries

Sample request

Sample response:

See Parameters for more information about the saved query object.

Last updated

Was this helpful?