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

Aiven Project API

The Project API from Aiven — 27 operation(s) for project.

Aiven Project 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 Project. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 8 JSON Schemas.

This API exposes 35 operations across 27 paths, and defines 43 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.

35 operations 27 paths 43 schemas 7 DELETE17 GET1 PATCH6 POST4 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
Resource Areas
1

Authentication & Security 2

Aiven Project 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 35

Across 27 paths, the API surfaces 35 operations — 7 DELETE, 17 GET, 1 PATCH, 6 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Project 35
GET
/project/{project}/vpc-peering-connection-types
List VPC peering connection types for a project
ListProjectVpcPeeringConnectionTypes 1 param → 200
GET
/project/{project}/alerts
List active alerts for a project
ProjectAlertsList 1 param → 200
POST
/project
Create a project
ProjectCreate body → 200409
GET
/projectdeprecated
List projects
ProjectList → 200
DELETE
/project/{project}deprecated
Delete project
ProjectDelete 1 param → 200
GET
/project/{project}deprecated
Get project details
ProjectGet 1 param → 200
PUT
/project/{project}deprecated
Update project
ProjectUpdate 1 param body → 200
GET
/project/{project}/download-sbom/{file_format}/{download_cookie}
Download SBOM report
ProjectDownloadSBOMReport 3 params → 200
GET
/project/{project}/generate-sbom-download-url/{file_format}
Generate SBOM for project
ProjectGenerateSbomDownloadUrl 2 params → 200
GET
/project/{project}/events
Get project event log entries
ProjectGetEventLogs 1 param → 200
POST
/project/{project}/invitedeprecated
Send project membership invitation
ProjectInvite 1 param body → 200
POST
/project/{project}/invite/{invite_verification_code}deprecated
Confirm project invite
ProjectInviteAccept 2 params → 200
DELETE
/project/{project}/invite/{invited_email}deprecated
Delete an invitation to a project
ProjectInviteDelete 2 params → 200
GET
/project/{project}/privatelink-availability
List Privatelink cloud availability and prices for a project
ProjectPrivatelinkAvailabilityList 1 param → 200
GET
/project/{project}/service-types/{service_type}/plans
List service plans
ProjectServicePlanList 2 params → 200
GET
/project/{project}/pricing/service-types/{service_type}/plans/{service_plan}/clouds/{cloud}
Get plan pricing
ProjectServicePlanPriceGet 4 params → 200
GET
/project/{project}/service-types/{service_type}/plans/{service_plan}
Get service plan details
ProjectServicePlanSpecsGet 3 params → 200
GET
/project/{project}/service-types/{service_type}
Get service type details
ProjectServiceTypesGet 2 params → 200
GET
/project/{project}/service-types
List service types
ProjectServiceTypesList 1 param → 200
GET
/project/{project}/tags
List all tags attached to this project
ProjectTagsList 1 param → 200
PUT
/project/{project}/tags
Replace all project tags with a new set of tags, deleting old ones
ProjectTagsReplace 1 param body → 200
PATCH
/project/{project}/tags
Update one or more tags, creating ones that don't exist, and deleting ones given NULL value
ProjectTagsUpdate 1 param body → 200
GET
/project/{project}/usersdeprecated
List users with access to the project. May contain same user multiple times if they belong to multiple teams associated to the project
ProjectUserList 1 param → 200
DELETE
/project/{project}/user/{user_email}deprecated
Remove user from the project
ProjectUserRemove 2 params → 200
PUT
/project/{project}/user/{user_email}deprecated
Update a project user
ProjectUserUpdate 2 params body → 200
POST
/project/{project}/vpcs
Create a VPC in a cloud for the project
VpcCreate 1 param body → 200
GET
/project/{project}/vpcs
List VPCs for a project
VpcList 1 param → 200
DELETE
/project/{project}/vpcs/{project_vpc_id}
Delete a project VPC
VpcDelete 2 params → 200
GET
/project/{project}/vpcs/{project_vpc_id}
Get VPC information
VpcGet 2 params → 200
POST
/project/{project}/vpcs/{project_vpc_id}/peering-connections
Create a peering connection for a project VPC
VpcPeeringConnectionCreate 2 params body → 200
DELETE
/project/{project}/vpcs/{project_vpc_id}/peering-connections/peer-accounts/{peer_cloud_account}/peer-vpcs/{peer_vpc}
Delete a peering connection for a project VPC
VpcPeeringConnectionDelete 4 params → 200
PUT
/project/{project}/vpcs/{project_vpc_id}/user-peer-network-cidrs
Update user-defined peer network CIDRs for a project VPC
VpcPeeringConnectionUpdate 2 params body → 200
DELETE
/project/{project}/vpcs/{project_vpc_id}/peering-connections/peer-accounts/{peer_cloud_account}/peer-vpcs/{peer_vpc}/peer-regions/{peer_region}
Delete a peering connection for a project VPC
VpcPeeringConnectionWithRegionDelete 5 params → 200
DELETE
/project/{project}/vpcs/{project_vpc_id}/peering-connections/peer-accounts/{peer_cloud_account}/peer-resource-groups/{peer_resource_group}/peer-vpcs/{peer_vpc}
Delete a peering connection for a project VPC
VpcPeeringConnectionWithResourceGroupDelete 5 params → 200
POST
/project/{project}/vpcs/{project_vpc_id}/peering-connections/refresh
Check if the state of peering connections in the cloud has changed
VpcPeeringConnectionsRefresh 2 params → 200

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are ProjectCreateRequestBody (23 properties), ProjectUpdateRequestBody (19 properties), ProjectServiceTypesListResponse (16 properties), VpcPeeringConnectionWithRegionDeleteResponse (15 properties). Each schema is shown below with its type and property counts.

VpcPeeringConnectionUpdateResponse
object
VpcPeeringConnectionUpdateResponse
10 properties 7 required
VpcDeleteResponse
object
VpcDeleteResponse
10 properties 7 required
ProjectTagsUpdateRequestBody
object
ProjectTagsUpdateRequestBody
1 property 1 required
ProjectTagsReplaceResponse
object
ProjectTagsReplaceResponse
2 properties
ProjectInviteRequestBody
object
ProjectInviteRequestBody
2 properties 1 required
ProjectInviteAcceptResponse
object
ProjectInviteAcceptResponse
3 properties 1 required
VpcPeeringConnectionsRefreshResponse
object
VpcPeeringConnectionsRefreshResponse
10 properties 7 required
VpcListResponse
object
VpcListResponse
3 properties 1 required
ProjectUserRemoveResponse
object
ProjectUserRemoveResponse
2 properties
ProjectGetResponse
object
ProjectGetResponse
3 properties 1 required
VpcCreateRequestBody
object
VpcCreateRequestBody
3 properties 3 required
ProjectGetEventLogsResponse
object
ProjectGetEventLogsResponse
3 properties 1 required
ProjectCreateResponse
object
ProjectCreateResponse
3 properties 1 required
VpcPeeringConnectionUpdateRequestBody
object
VpcPeeringConnectionUpdateRequestBody
2 properties
ProjectServicePlanListResponse
object
ProjectServicePlanListResponse
3 properties 1 required
VpcPeeringConnectionWithRegionDeleteResponse
object
VpcPeeringConnectionWithRegionDeleteResponse
15 properties 11 required
ProjectListResponse
object
ProjectListResponse
5 properties 3 required
ProjectInviteResponse
object
ProjectInviteResponse
2 properties
ProjectServicePlanPriceGetResponse
object
ProjectServicePlanPriceGetResponse
8 properties 4 required
ProjectGenerateSbomDownloadUrlResponse
object
ProjectGenerateSbomDownloadUrlResponse
3 properties 1 required
ProjectInviteDeleteResponse
object
ProjectInviteDeleteResponse
2 properties
VpcPeeringConnectionCreateRequestBody
object
VpcPeeringConnectionCreateRequestBody
7 properties 2 required
ProjectTagsUpdateResponse
object
ProjectTagsUpdateResponse
2 properties
VpcPeeringConnectionDeleteResponse
object
VpcPeeringConnectionDeleteResponse
15 properties 11 required
VpcPeeringConnectionCreateResponse
object
VpcPeeringConnectionCreateResponse
15 properties 11 required
ProjectUserUpdateResponse
object
ProjectUserUpdateResponse
2 properties
VpcPeeringConnectionWithResourceGroupDeleteResponse
object
VpcPeeringConnectionWithResourceGroupDeleteResponse
15 properties 11 required
ProjectUpdateRequestBody
object
ProjectUpdateRequestBody
19 properties
ProjectPrivatelinkAvailabilityListResponse
object
ProjectPrivatelinkAvailabilityListResponse
3 properties 1 required
ProjectDeleteResponse
object
ProjectDeleteResponse
2 properties
ProjectServiceTypesGetResponse
object
ProjectServiceTypesGetResponse
6 properties 2 required
ProjectUserUpdateRequestBody
object
ProjectUserUpdateRequestBody
1 property 1 required
ListProjectVpcPeeringConnectionTypesResponse
object
ListProjectVpcPeeringConnectionTypesResponse
3 properties 1 required
ProjectUpdateResponse
object
ProjectUpdateResponse
3 properties 1 required
VpcGetResponse
object
VpcGetResponse
10 properties 7 required
ProjectTagsListResponse
object
ProjectTagsListResponse
3 properties
ProjectUserListResponse
object
ProjectUserListResponse
5 properties 3 required
ProjectTagsReplaceRequestBody
object
ProjectTagsReplaceRequestBody
1 property 1 required
VpcCreateResponse
object
VpcCreateResponse
10 properties 7 required
ProjectServiceTypesListResponse
object
ProjectServiceTypesListResponse
16 properties
ProjectServicePlanSpecsGetResponse
object
ProjectServicePlanSpecsGetResponse
12 properties 5 required
ProjectCreateRequestBody
object
ProjectCreateRequestBody
23 properties 1 required
ProjectAlertsListResponse
object
ProjectAlertsListResponse
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aiven-project-api-openapi.yml Raw ↑

Other APIs Aiven publishes across the network.

Aiven Account API
Aiven Application_Users API
Aiven Authentication_Methods API
Aiven Billing API
Aiven BillingGroup API
Aiven Cloud_platforms API
Aiven Custom_Cloud API
Aiven Domains API
Aiven Groups API
Aiven Organization_Vpc API
Aiven OrganizationBillingGroup API
Aiven OrganizationEmissions API
Where this information came from

This is an independent, third-party profile of Aiven Project 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.