Aiven

Aiven Service API

The Service API from Aiven — 34 operation(s) for service.

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 48

GET /project/{project}/service_types List service types for a project #
GET /service_types List publicly available service types #
GET /service_versions List service versions #
GET /tenants/{tenant}/os-available-plugins List OpenSearch plugins available for this tenant grouped by OpenSearch version #
GET /tenants/{tenant}/pg-available-extensions List PostgreSQL extensions available for this tenant grouped by PG version #
POST /project/{project}/service/{service_name}/logs Get service log entries #
GET /project/{project}/service/{service_name}/tags List all tags attached to the service #
PUT /project/{project}/service/{service_name}/tags Replace all project tags with a new set of tags, deleting old ones #
PATCH /project/{project}/service/{service_name}/tags Update one or more tags, creating ones that don't exist, and deleting ones… #
GET /project/{project}/service/{service_name}/alerts List active alerts for service #
POST /project/{project}/service/{service_name}/backup_to_another_region/report Get service's backup to another region information #
GET /project/{project}/service/{service_name}/backups Get service backup information #
POST /project/{project}/service/{service_name}/query/cancel Cancel specified query from service #
POST /project/{project}/service Create a service #
GET /project/{project}/service List services #
POST /project/{project}/service/{service_name}/rotate-internal-secrets Rotate DataHub internal authentication secrets #
POST /project/{project}/service/{service_name}/db Create a new logical database for service #
GET /project/{project}/service/{service_name}/db List service databases #
DELETE /project/{project}/service/{service_name}/db/{dbname} Delete a logical database #
DELETE /project/{project}/service/{service_name} Terminate a service #
GET /project/{project}/service/{service_name} Get service information #
PUT /project/{project}/service/{service_name} Update service configuration #
POST /project/{project}/service/{service_name}/enable-writes Temporarily enable writes for a service in read-only mode. #
GET /project/{project}/service/{service_name}/migration Get migration status #
PUT /project/{project}/service/{service_name}/maintenance/start Start maintenance updates #
POST /project/{project}/service/{service_name}/metrics Fetch service metrics #
GET /project/{project}/service/{service_name}/privatelink/aws/connections List VPC Endpoint connections for an AWS Privatelink Endpoint Service #
POST /project/{project}/service/{service_name}/privatelink/aws Create an AWS Privatelink Endpoint Service #
DELETE /project/{project}/service/{service_name}/privatelink/aws Delete an AWS Privatelink Endpoint Service #
GET /project/{project}/service/{service_name}/privatelink/aws Get AWS Privatelink Endpoint Service information #
PUT /project/{project}/service/{service_name}/privatelink/aws Update an AWS Privatelink Endpoint Service #
POST /project/{project}/service/{service_name}/privatelink/azure/connections/{privatelink_connection_id}/approve Approve an Azure private endpoint connection pending user approval #
GET /project/{project}/service/{service_name}/privatelink/azure/connections List private endpoint connections for an Azure Privatelink Service #
PUT /project/{project}/service/{service_name}/privatelink/azure/connections/{privatelink_connection_id} Update a private endpoint connection for an Azure Privatelink Service #
POST /project/{project}/service/{service_name}/privatelink/azure Create an Azure Privatelink Service #
DELETE /project/{project}/service/{service_name}/privatelink/azure Delete an Azure Privatelink Service #
GET /project/{project}/service/{service_name}/privatelink/azure Get Azure Privatelink Service information #
PUT /project/{project}/service/{service_name}/privatelink/azure Update an Azure Privatelink Service #
POST /project/{project}/service/{service_name}/query/activity Fetch current queries for the service #
PUT /project/{project}/service/{service_name}/query/stats/reset Reset service's query statistics #
PATCH /project/{project}/service/{service_name}/service_type Update the service type of a service #
POST /project/{project}/service/{service_name}/task Create a new task for service #
GET /project/{project}/service/{service_name}/task/{task_id} Get task result #
POST /project/{project}/service/{service_name}/user Create a new (sub) user for service #
PUT /project/{project}/service/{service_name}/user/{service_username} Modify service user credentials #
DELETE /project/{project}/service/{service_name}/user/{service_username} Delete a service user #
GET /project/{project}/service/{service_name}/user/{service_username} Get details for a single user #
PUT /project/{project}/service/{service_name}/user/{service_username}/credentials/reset Reset service user credentials #

Documentation

📖
Documentation
https://aiven.io/docs/tools/api
📖
Authentication
https://aiven.io/docs/platform/howto/create_authentication_token

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/openapi/aiven-service-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/json-schema/aiven-service-create.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/json-schema/aiven-service-list.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/json-schema/aiven-project-create.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/json-schema/aiven-account-auth.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/json-schema/aiven-billing-group.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/json-schema/aiven-organization-create.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/json-schema/aiven-vpc-create.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/json-schema/aiven-user-info.json

Other Resources

🔗
Examples
https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/examples/aiven-create-project.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/examples/aiven-create-kafka-service.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/examples/aiven-create-postgresql-service.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/examples/aiven-list-services.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/aiven-service-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

aiven-service-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: support@aiven.io
    name: Aiven support team
    url: https://aiven.io/support-services
  title: Aiven API Documentation Service API
  version: v1
  x-logo:
    altText: Aiven logo
    backgroundColor: '#fafafa'
    href: https://api.aiven.io/doc
    url: https://aiven.io/assets/img/aiven-logo.png
  description: '# Introduction


    Direct link to openapi.json for use with external tools


    Aiven is a modern fully-managed open source data platform for streaming, storing, and analyzing data on any public cloud.'
servers:
- url: https://api.aiven.io/v1
tags:


# --- truncated at 32 KB (573 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aiven/refs/heads/main/openapi/aiven-service-api-openapi.yml