How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Aiven

Aiven Service API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Aiven Service API is one of 34 APIs that Aiven publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 8 JSON Schema definitions.

Tagged areas include Service. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 8 JSON Schemas.

This API exposes 48 operations across 34 paths, and defines 67 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.aiven.io/v1.

48 operations 34 paths 67 schemas 5 DELETE18 GET2 PATCH14 POST9 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.aiven.io/v1
Authentication
HTTP Bearer, OAuth 2.0
Contact
Aiven support team
Resource Areas
1

Authentication & Security 2

Aiven Service API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (tokenAuth). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 34 scopes.

  • tokenAuth — Header should be of the format authorization: aivenv1 . Tokens can be obtained from [your Aiven profile page](https://console.aiven.io/profile/auth)
  • oauth2 — OAuth2 security scheme

Paths & Operations 48

Across 34 paths, the API surfaces 48 operations — 5 DELETE, 18 GET, 2 PATCH, 14 POST, 9 PUT. Each is listed below with its method, path, parameters, and response codes.

Service 48
GET
/project/{project}/service_types
List service types for a project
ListProjectServiceTypes 1 param → 200
GET
/service_types
List publicly available service types
ListPublicServiceTypes → 200
GET
/service_versions
List service versions
ListServiceVersions → 200
GET
/tenants/{tenant}/os-available-plugins
List OpenSearch plugins available for this tenant grouped by OpenSearch version
OsAvailablePlugins 1 param → 200500
GET
/tenants/{tenant}/pg-available-extensions
List PostgreSQL extensions available for this tenant grouped by PG version
PgAvailableExtensions 1 param → 200
POST
/project/{project}/service/{service_name}/logs
Get service log entries
ProjectGetServiceLogs 2 params body → 200
GET
/project/{project}/service/{service_name}/tags
List all tags attached to the service
ProjectServiceTagsList 2 params → 200
PUT
/project/{project}/service/{service_name}/tags
Replace all project tags with a new set of tags, deleting old ones
ProjectServiceTagsReplace 2 params body → 200
PATCH
/project/{project}/service/{service_name}/tags
Update one or more tags, creating ones that don't exist, and deleting ones given NULL value
ProjectServiceTagsUpdate 2 params body → 200
GET
/project/{project}/service/{service_name}/alerts
List active alerts for service
ServiceAlertsList 2 params → 200
POST
/project/{project}/service/{service_name}/backup_to_another_region/report
Get service's backup to another region information
ServiceBackupToAnotherRegionReport 2 params body → 200
GET
/project/{project}/service/{service_name}/backups
Get service backup information
ServiceBackupsGet 2 params → 200
POST
/project/{project}/service/{service_name}/query/cancel
Cancel specified query from service
ServiceCancelQuery 2 params body → 200
POST
/project/{project}/service
Create a service
ServiceCreate 1 param body → 200
GET
/project/{project}/service
List services
ServiceList 2 params → 200
POST
/project/{project}/service/{service_name}/rotate-internal-secrets
Rotate DataHub internal authentication secrets
ServiceDataHubRotateInternalSecrets 2 params → 200404409
POST
/project/{project}/service/{service_name}/db
Create a new logical database for service
ServiceDatabaseCreate 2 params body → 200
GET
/project/{project}/service/{service_name}/db
List service databases
ServiceDatabaseList 2 params → 200
DELETE
/project/{project}/service/{service_name}/db/{dbname}
Delete a logical database
ServiceDatabaseDelete 3 params → 200
DELETE
/project/{project}/service/{service_name}
Terminate a service
ServiceDelete 2 params → 200
GET
/project/{project}/service/{service_name}
Get service information
ServiceGet 3 params → 200
PUT
/project/{project}/service/{service_name}
Update service configuration
ServiceUpdate 3 params body → 200
POST
/project/{project}/service/{service_name}/enable-writes
Temporarily enable writes for a service in read-only mode. Will only work if disk usage is lower than 99.0%
ServiceEnableWrites 2 params → 200
GET
/project/{project}/service/{service_name}/migration
Get migration status
ServiceGetMigrationStatus 2 params → 200
PUT
/project/{project}/service/{service_name}/maintenance/start
Start maintenance updates
ServiceMaintenanceStart 2 params → 200
POST
/project/{project}/service/{service_name}/metrics
Fetch service metrics
ServiceMetricsFetch 2 params body → 200
GET
/project/{project}/service/{service_name}/privatelink/aws/connections
List VPC Endpoint connections for an AWS Privatelink Endpoint Service
ServicePrivatelinkAWSConnectionList 2 params → 200
POST
/project/{project}/service/{service_name}/privatelink/aws
Create an AWS Privatelink Endpoint Service
ServicePrivatelinkAWSCreate 2 params body → 200
DELETE
/project/{project}/service/{service_name}/privatelink/aws
Delete an AWS Privatelink Endpoint Service
ServicePrivatelinkAWSDelete 2 params → 200
GET
/project/{project}/service/{service_name}/privatelink/aws
Get AWS Privatelink Endpoint Service information
ServicePrivatelinkAWSGet 2 params → 200
PUT
/project/{project}/service/{service_name}/privatelink/aws
Update an AWS Privatelink Endpoint Service
ServicePrivatelinkAWSUpdate 2 params body → 200
POST
/project/{project}/service/{service_name}/privatelink/azure/connections/{privatelink_connection_id}/approve
Approve an Azure private endpoint connection pending user approval
ServicePrivatelinkAzureConnectionApproval 3 params → 200
GET
/project/{project}/service/{service_name}/privatelink/azure/connections
List private endpoint connections for an Azure Privatelink Service
ServicePrivatelinkAzureConnectionList 2 params → 200
PUT
/project/{project}/service/{service_name}/privatelink/azure/connections/{privatelink_connection_id}
Update a private endpoint connection for an Azure Privatelink Service
ServicePrivatelinkAzureConnectionUpdate 3 params body → 200
POST
/project/{project}/service/{service_name}/privatelink/azure
Create an Azure Privatelink Service
ServicePrivatelinkAzureCreate 2 params body → 200
DELETE
/project/{project}/service/{service_name}/privatelink/azure
Delete an Azure Privatelink Service
ServicePrivatelinkAzureDelete 2 params → 200
GET
/project/{project}/service/{service_name}/privatelink/azure
Get Azure Privatelink Service information
ServicePrivatelinkAzureGet 2 params → 200
PUT
/project/{project}/service/{service_name}/privatelink/azure
Update an Azure Privatelink Service
ServicePrivatelinkAzureUpdate 2 params body → 200
POST
/project/{project}/service/{service_name}/query/activity
Fetch current queries for the service
ServiceQueryActivity 2 params body → 200
PUT
/project/{project}/service/{service_name}/query/stats/reset
Reset service's query statistics
ServiceQueryStatisticsReset 2 params → 200
PATCH
/project/{project}/service/{service_name}/service_type
Update the service type of a service
ServiceServiceTypeUpdate 2 params body → 200400404409
POST
/project/{project}/service/{service_name}/task
Create a new task for service
ServiceTaskCreate 2 params body → 200
GET
/project/{project}/service/{service_name}/task/{task_id}
Get task result
ServiceTaskGet 3 params → 200
POST
/project/{project}/service/{service_name}/user
Create a new (sub) user for service
ServiceUserCreate 2 params body → 200
PUT
/project/{project}/service/{service_name}/user/{service_username}
Modify service user credentials
ServiceUserCredentialsModify 3 params body → 200
DELETE
/project/{project}/service/{service_name}/user/{service_username}
Delete a service user
ServiceUserDelete 3 params → 200
GET
/project/{project}/service/{service_name}/user/{service_username}
Get details for a single user
ServiceUserGet 4 params → 200
PUT
/project/{project}/service/{service_name}/user/{service_username}/credentials/reset
Reset service user credentials
ServiceUserCredentialsReset 3 params → 200

Schemas 67

The contract defines 67 schemas that model the data the API accepts and returns. The most detailed are ServiceCreateRequestBody (16 properties), ServiceUpdateRequestBody (13 properties), ServiceTaskCreateRequestBody (7 properties), ServicePrivatelinkAzureUpdateResponse (6 properties). Each schema is shown below with its type and property counts.

ServiceUpdateResponse
object
ServiceUpdateResponse
3 properties 1 required
ProjectGetServiceLogsRequestBody
object
ProjectGetServiceLogsRequestBody
4 properties
ServiceServiceTypeUpdateResponse
object
ServiceServiceTypeUpdateResponse
3 properties 1 required
ListPublicServiceTypesResponse
object
ListPublicServiceTypesResponse
3 properties 1 required
ServiceQueryActivityResponse
object
ServiceQueryActivityResponse
3 properties 1 required
ServicePrivatelinkAWSUpdateRequestBody
object
ServicePrivatelinkAWSUpdateRequestBody
1 property 1 required
ServiceListResponse
object
ServiceListResponse
3 properties 1 required
ServiceMaintenanceStartResponse
object
ServiceMaintenanceStartResponse
2 properties
ServiceGetMigrationStatusResponse
object
ServiceGetMigrationStatusResponse
4 properties 1 required
ServicePrivatelinkAWSUpdateResponse
object
ServicePrivatelinkAWSUpdateResponse
6 properties 2 required
ServicePrivatelinkAWSDeleteResponse
object
ServicePrivatelinkAWSDeleteResponse
6 properties 2 required
ServicePrivatelinkAWSGetResponse
object
ServicePrivatelinkAWSGetResponse
6 properties 2 required
ServiceMetricsFetchRequestBody
object
ServiceMetricsFetchRequestBody
2 properties
ServicePrivatelinkAzureGetResponse
object
ServicePrivatelinkAzureGetResponse
6 properties 2 required
ServiceTaskGetResponse
object
ServiceTaskGetResponse
3 properties 1 required
ProjectServiceTagsUpdateRequestBody
object
ProjectServiceTagsUpdateRequestBody
1 property 1 required
ServicePrivatelinkAzureConnectionUpdateResponse
object
ServicePrivatelinkAzureConnectionUpdateResponse
6 properties 3 required
ServiceQueryActivityRequestBody
object
ServiceQueryActivityRequestBody
3 properties
ServiceServiceTypeUpdateRequestBody
object
ServiceServiceTypeUpdateRequestBody
1 property 1 required
ServiceTaskCreateResponse
object
ServiceTaskCreateResponse
3 properties 1 required
ServiceDatabaseListResponse
object
ServiceDatabaseListResponse
3 properties 1 required
ServicePrivatelinkAWSCreateRequestBody
object
ServicePrivatelinkAWSCreateRequestBody
1 property 1 required
ListProjectServiceTypesResponse
object
ListProjectServiceTypesResponse
3 properties 1 required
ServiceCreateResponse
object
ServiceCreateResponse
3 properties 1 required
ServicePrivatelinkAWSConnectionListResponse
object
ServicePrivatelinkAWSConnectionListResponse
3 properties 1 required
ServiceEnableWritesResponse
object
ServiceEnableWritesResponse
3 properties 1 required
PgAvailableExtensionsResponse
object
PgAvailableExtensionsResponse
3 properties
ServiceDataHubRotateInternalSecretsResponse
object
ServiceDataHubRotateInternalSecretsResponse
3 properties 2 required
ProjectServiceTagsUpdateResponse
object
ProjectServiceTagsUpdateResponse
2 properties
ProjectGetServiceLogsResponse
object
ProjectGetServiceLogsResponse
5 properties 3 required
ServiceMetricsFetchResponse
object
ServiceMetricsFetchResponse
3 properties 1 required
ServiceDatabaseCreateResponse
object
ServiceDatabaseCreateResponse
2 properties
ProjectServiceTagsListResponse
object
ProjectServiceTagsListResponse
3 properties
ProjectServiceTagsReplaceRequestBody
object
ProjectServiceTagsReplaceRequestBody
1 property 1 required
ServiceGetResponse
object
ServiceGetResponse
3 properties 1 required
ServicePrivatelinkAzureConnectionUpdateRequestBody
object
ServicePrivatelinkAzureConnectionUpdateRequestBody
1 property 1 required
ServicePrivatelinkAzureCreateRequestBody
object
ServicePrivatelinkAzureCreateRequestBody
1 property 1 required
ServicePrivatelinkAzureConnectionApprovalResponse
object
ServicePrivatelinkAzureConnectionApprovalResponse
6 properties 3 required
ServiceDatabaseCreateRequestBody
object
ServiceDatabaseCreateRequestBody
3 properties 1 required
ServiceAlertsListResponse
object
ServiceAlertsListResponse
3 properties 1 required
ServiceUserDeleteResponse
object
ServiceUserDeleteResponse
2 properties
ServiceDatabaseDeleteResponse
object
ServiceDatabaseDeleteResponse
2 properties
ServiceCancelQueryRequestBody
object
ServiceCancelQueryRequestBody
2 properties
ServiceTaskCreateRequestBody
object
ServiceTaskCreateRequestBody
7 properties 1 required
ServiceUserCredentialsModifyResponse
object
ServiceUserCredentialsModifyResponse
3 properties 1 required
ServicePrivatelinkAWSCreateResponse
object
ServicePrivatelinkAWSCreateResponse
6 properties 2 required
ProjectServiceTagsReplaceResponse
object
ProjectServiceTagsReplaceResponse
2 properties
ServiceUserCreateResponse
object
ServiceUserCreateResponse
3 properties 1 required
ServiceCancelQueryResponse
object
ServiceCancelQueryResponse
3 properties 1 required
ServicePrivatelinkAzureUpdateResponse
object
ServicePrivatelinkAzureUpdateResponse
6 properties 2 required
ServiceQueryStatisticsResetResponse
object
ServiceQueryStatisticsResetResponse
3 properties 1 required
ServiceDeleteResponse
object
ServiceDeleteResponse
2 properties
ServiceBackupToAnotherRegionReportResponse
object
ServiceBackupToAnotherRegionReportResponse
3 properties 1 required
ServicePrivatelinkAzureCreateResponse
object
ServicePrivatelinkAzureCreateResponse
6 properties 2 required
ServiceUpdateRequestBody
object
ServiceUpdateRequestBody
13 properties
ListServiceVersionsResponse
object
ListServiceVersionsResponse
3 properties 1 required
ServicePrivatelinkAzureUpdateRequestBody
object
ServicePrivatelinkAzureUpdateRequestBody
1 property 1 required
ServiceUserGetResponse
object
ServiceUserGetResponse
3 properties 1 required
ServiceBackupsGetResponse
object
ServiceBackupsGetResponse
6 properties 1 required
OsAvailablePluginsResponse
object
OsAvailablePluginsResponse
3 properties
ServiceBackupToAnotherRegionReportRequestBody
object
ServiceBackupToAnotherRegionReportRequestBody
2 properties
ServicePrivatelinkAzureDeleteResponse
object
ServicePrivatelinkAzureDeleteResponse
6 properties 2 required
ServicePrivatelinkAzureConnectionListResponse
object
ServicePrivatelinkAzureConnectionListResponse
3 properties 1 required
ServiceUserCredentialsResetResponse
object
ServiceUserCredentialsResetResponse
3 properties 1 required
ServiceUserCredentialsModifyRequestBody
object
ServiceUserCredentialsModifyRequestBody
4 properties 1 required
ServiceCreateRequestBody
object
ServiceCreateRequestBody
16 properties 3 required
ServiceUserCreateRequestBody
object
ServiceUserCreateRequestBody
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aiven-service-api-openapi.yml Raw ↑

Other APIs Aiven publishes across the network.

Aiven Account API
AE Profile APIs.io
Aiven Application_Users API
AE Profile APIs.io
Aiven Authentication_Methods API
AE Profile APIs.io
Aiven Billing API
AE Profile APIs.io
Aiven BillingGroup API
AE Profile APIs.io
Aiven Cloud_platforms API
AE Profile APIs.io
Aiven Custom_Cloud API
AE Profile APIs.io
Aiven Domains API
AE Profile APIs.io
Aiven Groups API
AE Profile APIs.io
Aiven Organization_Vpc API
AE Profile APIs.io
Aiven OrganizationBillingGroup API
AE Profile APIs.io
Aiven OrganizationEmissions API
AE Profile APIs.io
#Service
← Back to A APIs
API Details
ID
aiven:aiven-service-api
Base URL
https://api.aiven.io/v1
Docs
https://aiven.io/docs/tools/api
Provider
Aiven
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=aiven-service-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/aiven-service-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Aiven Service API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.