Skip to main content
Projects help you organize your Aiven services and centrally configure settings. Use these endpoints to create, list, update, and delete projects.

List projects

Retrieve all projects you have access to across your organizations.
GET /v1/project

Request example

curl -X GET "https://api.aiven.io/v1/project" \
  -H "Authorization: aivenv1 YOUR_TOKEN"

Response

projects
array
List of project objects
project_membership
object
Map of project names to member roles

Response example

{
  "project_membership": {
    "my-project": "admin",
    "demo-project": "developer"
  },
  "projects": [
    {
      "account_id": "a225dad8d3c4",
      "account_name": "My Organization",
      "available_credits": "0.00",
      "billing_currency": "USD",
      "billing_group_id": "588a8e63-fda7-4ff7-9bff-577debfee604",
      "billing_group_name": "Default Billing Group",
      "default_cloud": "google-europe-west3",
      "estimated_balance": "4.11",
      "payment_method": "card",
      "project_name": "my-project",
      "country_code": "US",
      "vat_id": ""
    }
  ]
}

Get project details

Retrieve detailed information about a specific project.
GET /v1/project/{project}
project
string
required
Project name

Request example

curl -X GET "https://api.aiven.io/v1/project/my-project" \
  -H "Authorization: aivenv1 YOUR_TOKEN"

Response

project
object
Project details (same structure as list projects response)

Create project

Create a new project in your organization.
POST /v1/project

Request body

project
string
required
Name for the new project (3-63 characters, lowercase letters, numbers, and hyphens)
account_id
string
Account/organization ID to create the project in
billing_group_id
string
Billing group ID to assign to the project
cloud
string
Default cloud region for services (e.g., google-europe-west3)
copy_from_project
string
Copy settings from an existing project

Request example

curl -X POST "https://api.aiven.io/v1/project" \
  -H "Authorization: aivenv1 YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "project": "new-project",
    "cloud": "google-europe-west3",
    "billing_group_id": "588a8e63-fda7-4ff7-9bff-577debfee604"
  }'

Response

project
object
The newly created project object

Update project

Update project settings.
PUT /v1/project/{project}
project
string
required
Project name

Request body

account_id
string
Move project to a different account/organization
billing_group_id
string
Change billing group
cloud
string
Update default cloud region
billing_address
string
Billing address
billing_currency
string
Billing currency code
billing_emails
array
Email addresses for billing notifications
tech_emails
array
Email addresses for technical notifications
country_code
string
Two-letter country code

Request example

curl -X PUT "https://api.aiven.io/v1/project/my-project" \
  -H "Authorization: aivenv1 YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "cloud": "aws-eu-west-1",
    "tech_emails": ["[email protected]"]
  }'

Response

project
object
The updated project object

Delete project

Delete a project. All services in the project must be deleted first.
DELETE /v1/project/{project}
project
string
required
Project name
This operation is irreversible. All project data and configuration will be permanently deleted.

Request example

curl -X DELETE "https://api.aiven.io/v1/project/my-project" \
  -H "Authorization: aivenv1 YOUR_TOKEN"

Response

Returns 200 OK with an empty response body on success.

List cloud regions

Get a list of available cloud regions. This endpoint does not require authentication.
GET /v1/clouds

Request example

curl -X GET "https://api.aiven.io/v1/clouds"

Response

clouds
array
List of available cloud regions

Response example

{
  "clouds": [
    {
      "cloud_description": "Europe, Finland - Google Cloud: Finland",
      "cloud_name": "google-europe-north1",
      "geo_latitude": 60.5693,
      "geo_longitude": 27.1878,
      "geo_region": "europe"
    },
    {
      "cloud_description": "Europe, Belgium - Google Cloud: Belgium",
      "cloud_name": "google-europe-west1",
      "geo_latitude": 50.4501,
      "geo_longitude": 3.8196,
      "geo_region": "europe"
    }
  ]
}

Build docs developers (and LLMs) love