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

Bearer token authentication using a Veza Personal API key.

Header Format: Authorization: Bearer <your-api-key>

Creating an API Key:

  1. Log into your Veza tenant
  2. Navigate to Administration โ†’ API Keys
  3. Generate a new API key and save the value securely
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
200

OK

application/json
get
/api/v1/assessments/queries

Sample request

Sample response:

See Parameters for more information about the saved query object.

Last updated

Was this helpful?