About Validio API

Validio has two APIs:

• The GraphQL API is built using GraphQL and enables interaction with the Validio platform through any GraphQL client. It exposes the same functionality as the Validio UI, so you can read, create, update, and delete resources programmatically.
• The CSV Export API is a set of read-only REST endpoints that return Validio data as CSV, for reporting, archival, and ingestion into BI tools or data warehouses.

​

Which API to use

Use the GraphQL API by default. It covers the whole platform, and it’s the only option for changes, such as creating a source, updating a validator’s threshold, or muting an incident. Use the CSV Export API when you want rows rather than objects: to feed a BI tool, to archive incident or activity history beyond your retention window, or to hand data to someone who works in spreadsheets. The same endpoints back the Export buttons in the Validio UI.

​

Endpoints

Both APIs are served from your Validio instance. The base URL, written https://your-validio-instance on these pages, is the URL you use to access Validio. An installation that Validio hosts is on a validio.io address, while a VPC installation uses your own domain. When you configure the Validio SDK or CLI, you give the base URL, and the client adds the /api path.

​

Authentication

Both APIs use the same Authorization header, with the value <access-key>:<access-secret>. For how to create an API key, and how the CLI and SDK find credentials, see Authentication.

​

Working with the GraphQL API

These pages cover the concepts that apply to GraphQL API requests:

• GraphQL basics: The GraphQL concepts to know before you start.
• Namespaces: Target the namespace your resources live in.
• API integration patterns: Synchronize data quality information with the rest of your stack.
• Pagination and rate limits: Page through large result sets, and stay within the request budget.
• API errors: The stable error codes to branch on.

​

Query examples

By inspecting the GraphQL schema, you can find the data you’re interested in and how to get, create, or update it. For how the schema is organized, see the Validio GraphQL API reference. For common operations and how to use them, see the SDK recipes.