Base URL
All API requests should be made to:Common use cases
The Aiven API is commonly used for:- Continuous integration: Create services during test runs and tear them down automatically
- Infrastructure automation: Deploy and manage services as part of your existing automation workflows
- Scheduled operations: Deploy and tear down development or demo platforms on a schedule
- Dynamic scaling: Scale your disks or service plans based on specific events or metrics
- Multi-cloud management: Manage services across different cloud providers from a single interface
API characteristics
- RESTful design: Uses standard HTTP methods (GET, POST, PUT, DELETE)
- JSON format: All requests and responses use JSON
- Token authentication: Secure access using personal or application tokens
- Versioned endpoints: API version is included in the URL path (
/v1) - Idempotent operations: Safe to retry failed requests
Getting started
- Create an authentication token
- Include the token in the
Authorizationheader with your requests - Start making API calls to manage your resources
Quick example
List all your projects:Try the API
You can explore and test the Aiven API using:- Postman workspace: Fork the Aiven collection
- Full API reference: Complete documentation
- Aiven CLI: Command-line interface built on the API
Rate limiting
The Aiven API implements rate limiting to ensure fair usage. If you exceed the rate limit, you’ll receive a429 Too Many Requests response. Implement exponential backoff in your client code to handle rate limiting gracefully.
API stability
Aiven maintains backward compatibility within API versions. The current stable version isv1. Breaking changes will be introduced in new API versions with advance notice.
Next steps
Authentication
Learn how to authenticate your API requests
Error Handling
Understand error codes and responses
Projects
Manage projects and organizations
Services
Create and manage Aiven services