Query APIs

Creating new queries, interacting with saved queries, and running query specs

The Query Builder APIs enable programmatic creation, execution, and management of assessment queries, using the Veza the Query Builder. You can use these operations to develop your own tools and integrate Veza search with external services and automation.

Queries created with these endpoints can define risks and have rules and alerts associated with them. Even if you and your team create and manage queries primarily from the user interface, this documentation may still be of interest for learning how queries are constructed and handled within Veza.

You can use these methods to:

• List saved queries

• Save a query

• Get a saved query

• Update a query

• Delete a query

• Get query destination nodes

• Get query nodes

• Get query result

• Get query spec destination nodes

• Get query spec nodes

• Get query spec results

For more information about query options, see Query Builder Parameters.

Base URL

These endpoints are available under {{VezaURL}}/api/v1/. You must use the appropriate prefix when calling the API, for example:

curl -x GET 'https://your-org.vezacloud.com/api/v1/assessments/queries'

Authentication

You can create and manage API tokens for your user account from Administration > API Keys. Each API call must include the API key in the request header, passed as a bearer authentication token.

Getting started

The Usage Examples page consolidates some sample requests and responses.

An understanding of Veza's usage of graph terminology may be helpful. To learn more about the query object and options, see here. For more information about how to interpret the query response body, see Query Builder Results.

You can start working with pre-built and saved queries using the /assessments/queries endpoint. When you are ready to try running your own queries, see the /assessments/query_spec operations to run test queries without saving them.