Project Management

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"

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

array

List of project objects

Show child attributes

string

Name of the project

string

Account identifier

string

Account name

string

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

string

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

string

Billing group identifier

string

Billing group name

string

Current estimated balance

string

Payment method type

string

Available credits amount

string

Two-letter country code

string

VAT identification number

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}

string

required

Project name

Request example

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

object

Project details (same structure as list projects response)

Create project

Create a new project in your organization.

POST /v1/project

Request body

string

required

Name for the new project (3-63 characters, lowercase letters, numbers, and hyphens)

string

Account/organization ID to create the project in

string

Billing group ID to assign to the project

string

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

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

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

object

The newly created project object

Update project

Update project settings.

PUT /v1/project/{project}

string

required

Project name

Request body

string

Move project to a different account/organization

string

Change billing group

string

Update default cloud region

string

Billing address

string

Billing currency code

array

Email addresses for billing notifications

array

Email addresses for technical notifications

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": ["devops@example.com"]
  }'

import requests

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

data = {
    "cloud": "aws-eu-west-1",
    "tech_emails": ["devops@example.com"]
}

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

object

The updated project object

Delete project

Delete a project. All services in the project must be deleted first.

DELETE /v1/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"

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 -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

array

List of available cloud regions

Show child attributes

string

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

string

Human-readable description

number

Geographic latitude

number

Geographic longitude

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

Getting Started

Endpoints

Project Management

List projects

Request example

Response

Response example

Get project details

Request example

Response

Create project

Request body

Request example

Response

Update project

Request body

Request example

Response

Delete project

Request example

Response

List cloud regions

Request example

Response

Response example

​List projects

​Request example

​Response

​Response example

​Get project details

​Request example

​Response

​Create project

​Request body

​Request example

​Response

​Update project

​Request body

​Request example

​Response

​Delete project

​Request example

​Response

​List cloud regions

​Request example

​Response

​Response example

​Related resources

List projects

Request example

Response

Response example

Get project details

Request example

Response

Create project

Request body

Request example

Response

Update project

Request body

Request example

Response

Delete project

Request example

Response

List cloud regions

Request example

Response

Response example

Related resources