Use the Aiven API to programmatically perform any task that you can do through the web interface. This is an ideal way to automate tasks involving Aiven at every stage of your workflow.
Common use cases for the Aiven API:
Use with CI (Continuous Integration) to spin up data platforms on Aiven for use during test runs.
Integrate with other parts of your existing automation setup to achieve complex tasks.
Deploy and tear down development or demo platforms on a schedule.
We make the API available to all Aiven users. It is also the engine behind the Aiven Console, so you should find that all operations are also available through the API.
Postman: Try Aiven on Postman and start working with your data platform programmatically.
API documentation: Check the API documentation and OpenAPI description to work with the API directly.
Examples: See the API in action with some API examples.
Most (but not all) endpoints require authentication. You’ll need an authentication token from the profile section of your Aiven console.
Send this token in the header, using a structure like this, and replacing
TOKEN with your actual API token:
Authorization: aivenv1 TOKEN
Read more about Authentication tokens.
Handling JSON responses#
The Aiven API returns information in JSON format, sometimes a lot of
information. This is perfect for machines but not ideal for humans. Try a tool
jq (https://stedolan.github.io/jq/) to make things easier to read and
Here are some more resources for you:
Some API examples on the Aiven blog. This post also includes information about importing our OpenAPI description into Postman.
Learn more about the Aiven CLI.