Veza APIs
Overview of Veza APIs and developer resources
Last updated
Was this helpful?
Overview of Veza APIs and developer resources
Last updated
Was this helpful?
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 and collections. See the following list of endpoints for more details.
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:
For more information about API keys, see Authentication.
These endpoints are available under {{VEZA_URL}}/api/v1/ and {{VEZA_URL}}/api/preview/.
You must use the appropriate prefix when calling the API, for example:
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.
/v1 APIsThe v1 namespace is intended for production use. These operations are fully supported by Veza, and changes are compatible with earlier versions:
Run and save searches constructed with the Query Builder:
Push entity and authorization metadata to the Veza data catalog, to integrate data sources that aren't natively supported:
Custom Application template
Custom Identity Provider template
Add, change, and monitor configurations for Veza integrations:
Create, apply, and remove Veza Tags:
/preview APIsThe preview namespace is reserved for functionality that 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.
Get platform events and activity logs:
Customize templates for Email Notifications and Reminders emails:
Get results and make decisions on certifications, and customize settings and templates:
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 and exploring the examples and documentation.