🌐Veza APIs

Overview of Veza APIs and developer resources

Veza's REST APIs introduce ways to programmatically interact with core Veza functionality. Developers can use these operations to build applications that integrate with platform features including:

• Access Visibility: Construct and run queries, and apply tags to entities

• Access Reviews: Automate Workflow and Certification actions

• Platform: Export Veza system events and activity logs

• Integrations: Manage and configure providers and data sources

APIs are also available for customizing notification and remediation templates, and configuring platform behavior such as access reviewer assignments.

This section includes reference documentation and usage examples for each service in the /v1 and /preview collections. See the following list of endpoints for more details.

Getting Started

Authentication

You will need an API key associated with your Veza user account to make requests. To generate one, navigate to Administration > API Keys as a Veza administrator.

Include the key as a bearer token in the header of your requests, for example:

curl -X GET 'HTTPS://{{VEZA_URL}}/API/v1/providers/custom' \
-H 'Authorization: Bearer {{ACCESS_TOKEN}}'

For more information about API keys, see Authentication.

Base URL

These endpoints are available under {{VEZA_URL}}/api/v1/ and {{VEZA_URL}}/api/preview/ (for experimental features).

You must use the appropriate prefix when calling the API, for example:

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

Error messages

The response will indicate when there is an issue with a request. Error details are contained within a field_violations array. See Troubleshooting for possible response codes and a sample error message.

Custom integrations

If you are interested in building your own connector for a data source that Veza does not natively support, you can get started by downloading the official oaaclient and exploring the examples and documentation.

/v1 APIs

The v1 namespace is intended for production use. These operations are fully supported by Veza, and changes are compatible with earlier versions:

Assessment Queries

Run and save searches constructed with the Query Builder:

• Concepts:

  • Quick Start

  • Query Builder Terminology

  • Query Builder Parameters

  • Query Builder Results

• Operations

  • List saved queries

  • Save a query

  • Get a saved query

  • Update a query

  • Delete a query

  • Get query node destinations

  • Get query nodes

  • Get query result

  • Get query spec node destinations

  • Get query spec nodes

  • Get query spec results

Custom Providers (Open Authorization API)

Push entity and authorization metadata to the Veza data catalog, to integrate data sources that aren't natively supported:

• Open Authorization API

• Core Concepts

• OAA Push API

• OAA Operations

• Custom Application template

• Custom Identity Provider template

Data Source Management

Add, change, and monitor configurations for Veza integrations:

• Cloud Platforms and Data Providers

• Identity Providers

• Data Sources

• Sync and Parse Status

Entity Tagging

Create, apply, and remove Veza Tags:

• https://github.com/cookieai-jar/cookie-docs/blob/main/docs/developers/api/query-builder/tags/README.md

• Create, Add, Remove Tag

/preview APIs

The preview namespace is reserved for experimental functionality and is subject to change over time. These endpoints have undergone a review process and are generally consistent with each other and v1 APIs. However, future updates may not be compatible with earlier versions, and documentation and examples may be limited.

Audit Logs and Events

Get platform events and activity logs:

• System Audit Logs

• System Events

Email Notification Templates

Customize templates for Orchestration Actions and Reminders emails:

• Notification Templates

• Notification Templates API

Workflows

Get results and make decisions on certifications, and customize settings and templates:

• List Workflows

• List Certifications

• List Certification Results

• Get Certification Result

• Update Certification Result

• Get Access Graph

• Manage Reviewer Deny List

• Delegate Reviewers

• Quick Filters

• Help Page Templates

• Remediation Templates

• Workflow Parameters Reference