Project Management

Manage Aiven projects via the REST API

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

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

import requests

headers = {"Authorization": "aivenv1 YOUR_TOKEN"}
response = requests.get(
    "https://api.aiven.io/v1/project",
    headers=headers
)

projects = response.json()
for project in projects["projects"]:
    print(f"{project['project_name']}: {project['cloud_name']}")

const response = await fetch('https://api.aiven.io/v1/project', {
  headers: {
    'Authorization': 'aivenv1 YOUR_TOKEN'
  }
});

const data = await response.json();
console.log(data.projects);

Response

projects · array

List of project objects

Show child attributes

project_name · string

Name of the project

account_id · string

Account identifier

account_name · string

Account name

default_cloud · string

Default cloud region for new services (e.g., google-europe-west3)

billing_currency · string

Currency code (e.g., USD, EUR)

billing_group_id · string

Billing group identifier

billing_group_name · string

Billing group name

estimated_balance · string

Current estimated balance

payment_method · string

Payment method type

available_credits · string

Available credits amount

country_code · string

Two-letter country code

vat_id · string

VAT identification number

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

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

import requests

project_name = "my-project"
headers = {"Authorization": "aivenv1 YOUR_TOKEN"}

response = requests.get(
    f"https://api.aiven.io/v1/project/{project_name}",
    headers=headers
)

project = response.json()["project"]
print(f"Project: {project['project_name']}")
print(f"Cloud: {project['default_cloud']}")

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

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"
  }'

import requests

headers = {
    "Authorization": "aivenv1 YOUR_TOKEN",
    "Content-Type": "application/json"
}

data = {
    "project": "new-project",
    "cloud": "google-europe-west3",
    "billing_group_id": "588a8e63-fda7-4ff7-9bff-577debfee604"
}

response = requests.post(
    "https://api.aiven.io/v1/project",
    headers=headers,
    json=data
)

project = response.json()["project"]
print(f"Created project: {project['project_name']}")

const response = await fetch('https://api.aiven.io/v1/project', {
  method: 'POST',
  headers: {
    'Authorization': 'aivenv1 YOUR_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    project: 'new-project',
    cloud: 'google-europe-west3',
    billing_group_id: '588a8e63-fda7-4ff7-9bff-577debfee604'
  })
});

const data = await response.json();
console.log('Created project:', data.project.project_name);

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

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": ["[e-mail]"]
  }'

import requests

project_name = "my-project"
headers = {
    "Authorization": "aivenv1 YOUR_TOKEN",
    "Content-Type": "application/json"
}

data = {
    "cloud": "aws-eu-west-1",
    "tech_emails": ["[e-mail]"]
}

response = requests.put(
    f"https://api.aiven.io/v1/project/{project_name}",
    headers=headers,
    json=data
)

print(f"Updated project: {response.json()['project']['project_name']}")

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

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

import requests

project_name = "my-project"
headers = {"Authorization": "aivenv1 YOUR_TOKEN"}

response = requests.delete(
    f"https://api.aiven.io/v1/project/{project_name}",
    headers=headers
)

if response.status_code == 200:
    print(f"Project {project_name} deleted successfully")

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

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

import requests

response = requests.get("https://api.aiven.io/v1/clouds")
clouds = response.json()["clouds"]

for cloud in clouds:
    print(f"{cloud['cloud_name']}: {cloud['cloud_description']}")

Response

clouds · array

List of available cloud regions

Show child attributes

cloud_name · string

Cloud region identifier (e.g., google-europe-west3)

cloud_description · string

Human-readable description

geo_latitude · number

Geographic latitude

geo_longitude · number

Geographic longitude

geo_region · string

Geographic region (e.g., europe, north-america)

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"
    }
  ]
}

Related resources

• Manage projects in Console
• Services API
• Full API reference