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 Service:_PostgreSQL API

The Service:_PostgreSQL API from Aiven — 9 operation(s) for service:_postgresql.

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

This API exposes 10 operations across 9 paths, and defines 16 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.

10 operations 9 paths 16 schemas 1 DELETE2 GET6 POST1 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 Service:_PostgreSQL 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 10

Across 9 paths, the API surfaces 10 operations — 1 DELETE, 2 GET, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Service:_PostgreSQL 10
POST
/account/{account_id}/pg/query/optimize
Get query optimization recommendations for a query
PGAccountQueryOptimize 1 param body → 200400404
GET
/project/{project}/service/{service_name}/pg/available-extensions
List PostgreSQL extensions that can be loaded with CREATE EXTENSION in this service
PGServiceAvailableExtensions 2 params → 200
GET
/pg/database-metadata-query
Get the query used to retrieve schema metadata
PGServiceDatabaseMetadataQuery → 200
POST
/pg/query/metadata-validate
Validate schema metadata structure and statistics
PGServiceMetadataValidate body → 200400
POST
/project/{project}/service/{service_name}/pg/query/stats
Fetch PostgreSQL service query statistics
PGServiceQueryStatistics 2 params body → 200
POST
/project/{project}/service/{service_name}/query/statsdeprecated
Fetch PostgreSQL service query statistics (DEPRECATED: Use /project/$project/service/$service/pg/query/stats instead)
PGServiceQueryStatisticsDeprecated 2 params → 200
POST
/pg/query/validate
Validate SQL query syntax
PGServiceQueryValidate body → 200400
POST
/project/{project}/service/{service_name}/connection_pool
Create a new connection pool for service
ServicePGBouncerCreate 2 params body → 200
DELETE
/project/{project}/service/{service_name}/connection_pool/{pool_name}
Delete a connection pool
ServicePGBouncerDelete 3 params → 200
PUT
/project/{project}/service/{service_name}/connection_pool/{pool_name}
Update a connection pool
ServicePGBouncerUpdate 3 params body → 200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are ServicePGBouncerCreateRequestBody (5 properties), PGAccountQueryOptimizeRequestBody (5 properties), ServicePGBouncerUpdateRequestBody (4 properties), PGServiceQueryStatisticsDeprecatedResponse (3 properties). Each schema is shown below with its type and property counts.

PGServiceMetadataValidateRequestBody
object
PGServiceMetadataValidateRequestBody
2 properties 2 required
ServicePGBouncerCreateRequestBody
object
ServicePGBouncerCreateRequestBody
5 properties 2 required
PGServiceQueryStatisticsResponse
object
PGServiceQueryStatisticsResponse
3 properties 1 required
PGServiceMetadataValidateResponse
object
PGServiceMetadataValidateResponse
1 property 1 required
PGAccountQueryOptimizeResponse
object
PGAccountQueryOptimizeResponse
1 property 1 required
PGServiceDatabaseMetadataQueryResponse
object
PGServiceDatabaseMetadataQueryResponse
1 property 1 required
PGServiceQueryStatisticsDeprecatedResponse
object
PGServiceQueryStatisticsDeprecatedResponse
3 properties 1 required
ServicePGBouncerUpdateRequestBody
object
ServicePGBouncerUpdateRequestBody
4 properties
PGServiceQueryValidateResponse
object
PGServiceQueryValidateResponse
1 property 1 required
ServicePGBouncerCreateResponse
object
ServicePGBouncerCreateResponse
2 properties
PGServiceQueryValidateRequestBody
object
PGServiceQueryValidateRequestBody
2 properties 1 required
PGAccountQueryOptimizeRequestBody
object
PGAccountQueryOptimizeRequestBody
5 properties 3 required
ServicePGBouncerDeleteResponse
object
ServicePGBouncerDeleteResponse
2 properties
PGServiceAvailableExtensionsResponse
object
PGServiceAvailableExtensionsResponse
3 properties 1 required
PGServiceQueryStatisticsRequestBody
object
PGServiceQueryStatisticsRequestBody
3 properties
ServicePGBouncerUpdateResponse
object
ServicePGBouncerUpdateResponse
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aiven-service-postgresql-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 Service:_PostgreSQL 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.