{ "opencollection": "1.0.0", "info": { "name": "Aiven API Documentation Account Service API", "version": "v1" }, "items": [ { "info": { "name": "Service", "type": "folder" }, "items": [ { "info": { "name": "List service types for a project", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/project/:project/service_types", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List service types for a project" }, { "info": { "name": "List publicly available service types", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/service_types" }, "docs": "List publicly available service types" }, { "info": { "name": "List service versions", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/service_versions" }, "docs": "List service versions" }, { "info": { "name": "List OpenSearch plugins available for this tenant grouped by OpenSearch version", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/tenants/:tenant/os-available-plugins", "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Aiven tenant ID" } ] }, "docs": "List OpenSearch plugins available for this tenant grouped by OpenSearch version" }, { "info": { "name": "List PostgreSQL extensions available for this tenant grouped by PG version", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/tenants/:tenant/pg-available-extensions", "params": [ { "name": "tenant", "value": "", "type": "path", "description": "Aiven tenant ID" } ] }, "docs": "List PostgreSQL extensions available for this tenant grouped by PG version" }, { "info": { "name": "Get service log entries", "type": "http" }, "http": { "method": "POST", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/logs", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get service log entries" }, { "info": { "name": "List all tags attached to the service", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/tags", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List all tags attached to the service" }, { "info": { "name": "Replace all project tags with a new set of tags, deleting old ones", "type": "http" }, "http": { "method": "PUT", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/tags", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Replace all project tags with a new set of tags, deleting old ones" }, { "info": { "name": "Update one or more tags, creating ones that don't exist, and deleting ones given NULL value", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/tags", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update one or more tags, creating ones that don't exist, and deleting ones given NULL value" }, { "info": { "name": "List active alerts for service", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/alerts", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List active alerts for service" }, { "info": { "name": "Get service's backup to another region information", "type": "http" }, "http": { "method": "POST", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/backup_to_another_region/report", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get service's backup to another region information" }, { "info": { "name": "Get service backup information", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/backups", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get service backup information" }, { "info": { "name": "Cancel specified query from service", "type": "http" }, "http": { "method": "POST", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/query/cancel", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Cancel specified query from service" }, { "info": { "name": "List services", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/project/:project/service", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "include_secrets", "value": "", "type": "query", "description": "Explicitly indicates that the client wants to read secrets that might be returned by this endpoint." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List services" }, { "info": { "name": "Create a service", "type": "http" }, "http": { "method": "POST", "url": "https://api.aiven.io/v1/project/:project/service", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a service" }, { "info": { "name": "Rotate DataHub internal authentication secrets", "type": "http" }, "http": { "method": "POST", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/rotate-internal-secrets", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "

Generates fresh values for DATAHUB_SECRET (Play session signing key) and DATAHUB_SYSTEM_CLIENT_SECRET (system OAuth client secret), updates every DataHub app child accordingly, and triggers a coordinated restart so the new values take effect everywhere simultaneously. USER-VISIBLE SIDE EFFECT: every active browser session is invalidated -- all currently logged-in users will be signed out and must re-login after the coordinated restart. Inter-service calls may briefly return 401 errors while t" }, { "info": { "name": "List service databases", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/db", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List service databases" }, { "info": { "name": "Create a new logical database for service", "type": "http" }, "http": { "method": "POST", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/db", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new logical database for service" }, { "info": { "name": "Delete a logical database", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/db/:dbname", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" }, { "name": "dbname", "value": "", "type": "path", "description": "DatabaseName" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a logical database" }, { "info": { "name": "Get service information", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/project/:project/service/:service_name", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" }, { "name": "include_secrets", "value": "", "type": "query", "description": "Explicitly indicates that the client wants to read secrets that might be returned by this endpoint." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get service information" }, { "info": { "name": "Update service configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.aiven.io/v1/project/:project/service/:service_name", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" }, { "name": "allow_unclean_poweroff", "value": "", "type": "query", "description": "Allows or disallows powering off a service if some WAL segments are not available for a future restoration of the service, which might result in data loss when powering the service back on" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update service configuration" }, { "info": { "name": "Terminate a service", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.aiven.io/v1/project/:project/service/:service_name", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Terminate a service" }, { "info": { "name": "Temporarily enable writes for a service in read-only mode. Will only work if disk usage is lower than 99.0%", "type": "http" }, "http": { "method": "POST", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/enable-writes", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Temporarily enable writes for a service in read-only mode. Will only work if disk usage is lower than 99.0%" }, { "info": { "name": "Get migration status", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/migration", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get migration status" }, { "info": { "name": "Start maintenance updates", "type": "http" }, "http": { "method": "PUT", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/maintenance/start", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Start maintenance updates" }, { "info": { "name": "Fetch service metrics", "type": "http" }, "http": { "method": "POST", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/metrics", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch service metrics" }, { "info": { "name": "List VPC Endpoint connections for an AWS Privatelink Endpoint Service", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/privatelink/aws/connections", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List VPC Endpoint connections for an AWS Privatelink Endpoint Service" }, { "info": { "name": "Get AWS Privatelink Endpoint Service information", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/privatelink/aws", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get AWS Privatelink Endpoint Service information" }, { "info": { "name": "Create an AWS Privatelink Endpoint Service", "type": "http" }, "http": { "method": "POST", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/privatelink/aws", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create an AWS Privatelink Endpoint Service" }, { "info": { "name": "Update an AWS Privatelink Endpoint Service", "type": "http" }, "http": { "method": "PUT", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/privatelink/aws", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an AWS Privatelink Endpoint Service" }, { "info": { "name": "Delete an AWS Privatelink Endpoint Service", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/privatelink/aws", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete an AWS Privatelink Endpoint Service" }, { "info": { "name": "Approve an Azure private endpoint connection pending user approval", "type": "http" }, "http": { "method": "POST", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/privatelink/azure/connections/:privatelink_connection_id/approve", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" }, { "name": "privatelink_connection_id", "value": "", "type": "path", "description": "Privatelink connection ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Approve an Azure private endpoint connection pending user approval" }, { "info": { "name": "List private endpoint connections for an Azure Privatelink Service", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/privatelink/azure/connections", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List private endpoint connections for an Azure Privatelink Service" }, { "info": { "name": "Update a private endpoint connection for an Azure Privatelink Service", "type": "http" }, "http": { "method": "PUT", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/privatelink/azure/connections/:privatelink_connection_id", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" }, { "name": "privatelink_connection_id", "value": "", "type": "path", "description": "Privatelink connection ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update a private endpoint connection for an Azure Privatelink Service" }, { "info": { "name": "Get Azure Privatelink Service information", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/privatelink/azure", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Azure Privatelink Service information" }, { "info": { "name": "Create an Azure Privatelink Service", "type": "http" }, "http": { "method": "POST", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/privatelink/azure", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create an Azure Privatelink Service" }, { "info": { "name": "Update an Azure Privatelink Service", "type": "http" }, "http": { "method": "PUT", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/privatelink/azure", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an Azure Privatelink Service" }, { "info": { "name": "Delete an Azure Privatelink Service", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/privatelink/azure", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete an Azure Privatelink Service" }, { "info": { "name": "Fetch current queries for the service", "type": "http" }, "http": { "method": "POST", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/query/activity", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch current queries for the service" }, { "info": { "name": "Reset service's query statistics", "type": "http" }, "http": { "method": "PUT", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/query/stats/reset", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Reset service's query statistics" }, { "info": { "name": "Update the service type of a service", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/service_type", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update the service type of a service" }, { "info": { "name": "Create a new task for service", "type": "http" }, "http": { "method": "POST", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/task", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new task for service" }, { "info": { "name": "Get task result", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/task/:task_id", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" }, { "name": "task_id", "value": "", "type": "path", "description": "Service task" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get task result" }, { "info": { "name": "Create a new (sub) user for service", "type": "http" }, "http": { "method": "POST", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/user", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new (sub) user for service" }, { "info": { "name": "Get details for a single user", "type": "http" }, "http": { "method": "GET", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/user/:service_username", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" }, { "name": "service_username", "value": "", "type": "path", "description": "Service username" }, { "name": "include_secrets", "value": "", "type": "query", "description": "Explicitly indicates that the client wants to read secrets that might be returned by this endpoint." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get details for a single user" }, { "info": { "name": "Modify service user credentials", "type": "http" }, "http": { "method": "PUT", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/user/:service_username", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" }, { "name": "service_username", "value": "", "type": "path", "description": "Service username" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Modify service user credentials" }, { "info": { "name": "Delete a service user", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/user/:service_username", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" }, { "name": "service_username", "value": "", "type": "path", "description": "Service username" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a service user" }, { "info": { "name": "Reset service user credentials", "type": "http" }, "http": { "method": "PUT", "url": "https://api.aiven.io/v1/project/:project/service/:service_name/user/:service_username/credentials/reset", "params": [ { "name": "project", "value": "", "type": "path", "description": "Project name" }, { "name": "service_name", "value": "", "type": "path", "description": "Service name" }, { "name": "service_username", "value": "", "type": "path", "description": "Service username" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Reset service user credentials" } ] } ], "bundled": true }