openapi: 3.0.1 info: contact: email: support@aiven.io name: Aiven support team url: https://aiven.io/support-services title: Aiven API Documentation Account 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\n\n[Direct link to openapi.json](https://api.aiven.io/doc/openapi.json) for use with external tools\n\n[Aiven](https://aiven.io) is a modern fully-managed open source data platform for streaming, storing, and analyzing data on any public cloud. On Aiven Platform, you can operate your data infrastructure with a few devops tools: [Aiven Console](https://console.aiven.io/), [Aiven Terraform Provider](https://aiven.io/docs/tools/terraform), [Aiven CLI](https://github.com/aiven/aiven-client), and [Aiven Operator for Kubernetes](https://github.com/aiven/aiven-operator). All of them are built on an open secure powerful REST API for integration with custom tooling.\n\nThe Aiven [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer) API\nprovides programmatic access to Aiven.io services. To call the Aiven API, you can use either CLI tools (for example, `cURL` or [Aiven CLI client](https://aiven.io/docs/tools/cli)) or GUI tools, such as the [Aiven public API Postman collection](https://www.postman.com/aiven-apis).\n\nThis Aiven API documentation will help you operate your Aiven organization, projects, or services programmatically by integrating your applications and processes with Aiven.\n\n# Description\n\nAiven's APIs ([Application Programming Interfaces](https://en.wikipedia.org/wiki/API)) power its platform for data management. Aiven has a number of REST APIs that can help you build strong and robust data infrastructure for your applications.\n\nThe Aiven API is organized around core resources. Each core resource has multiple endpoints, which can be interacted with using different HTTP methods.\n\n## Core resources\n\n### Platform APIs\n\n
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 the rotation is in flight. DATAHUB_SYSTEM_CLIENT_ID is the fixed identifier "__datahub_system" and is intentionally left untouched.
' parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceDataHubRotateInternalSecretsResponse' '404': description: Resource not found content: application/json: schema: type: object properties: message: type: string title: Human readable error message errors: type: array title: List of error details. Typically there is only one element items: type: object properties: message: type: string title: Human readable error message error_code: type: string enum: - service_not_found title: Machine processable error code. Clients must be prepared to handle new codes. description: 'service_not_found: Service not found' '409': description: Request conflict content: application/json: schema: type: object properties: message: type: string title: Human readable error message errors: type: array title: List of error details. Typically there is only one element items: type: object properties: message: type: string title: Human readable error message error_code: type: string enum: - service_type_not_allowed title: Machine processable error code. Clients must be prepared to handle new codes. description: 'service_type_not_allowed: Service type not allowed' security: - tokenAuth: [] oauth2: - services:write /project/{project}/service/{service_name}/db: post: summary: Create a new logical database for service tags: - Service operationId: ServiceDatabaseCreate parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceDatabaseCreateRequestBody' example: database: testdb lc_collate: en_US.UTF-8 lc_ctype: en_US.UTF-8 responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceDatabaseCreateResponse' security: - tokenAuth: [] oauth2: - services:write get: summary: List service databases tags: - Service operationId: ServiceDatabaseList parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceDatabaseListResponse' security: - tokenAuth: [] oauth2: - services:read /project/{project}/service/{service_name}/db/{dbname}: delete: summary: Delete a logical database tags: - Service operationId: ServiceDatabaseDelete parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/dbname' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceDatabaseDeleteResponse' security: - tokenAuth: [] oauth2: - services:write /project/{project}/service/{service_name}: delete: summary: Terminate a service tags: - Service operationId: ServiceDelete parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceDeleteResponse' security: - tokenAuth: [] oauth2: - services:write get: summary: Get service information tags: - Service operationId: ServiceGet parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/serviceget_include_secrets' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceGetResponse' security: - tokenAuth: [] oauth2: - services:read put: summary: Update service configuration tags: - Service operationId: ServiceUpdate parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/serviceupdate_allow_unclean_poweroff' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceUpdateRequestBody' example: cloud: aws-eu-central-1 cmk_id: 12345678-1234-1234-1234-12345678abcd disk_space_mb: 65536 group_name: mygroup karapace: true maintenance: dow: sunday time: '12:30:00' plan: hobbyist powered: true project_vpc_id: 1007a317-aa2a-4fb4-9056-93924c5ee46f schema_registry_authz: true tech_emails: - email: jane@example.com termination_protection: true user_config: {} responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceUpdateResponse' security: - tokenAuth: [] oauth2: - services:write /project/{project}/service/{service_name}/enable-writes: post: summary: Temporarily enable writes for a service in read-only mode. Will only work if disk usage is lower than 99.0% tags: - Service operationId: ServiceEnableWrites parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceEnableWritesResponse' security: - tokenAuth: [] oauth2: - services:write /project/{project}/service/{service_name}/migration: get: summary: Get migration status tags: - Service operationId: ServiceGetMigrationStatus parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceGetMigrationStatusResponse' security: - tokenAuth: [] oauth2: - services:read /project/{project}/service/{service_name}/maintenance/start: put: summary: Start maintenance updates tags: - Service operationId: ServiceMaintenanceStart parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceMaintenanceStartResponse' security: - tokenAuth: [] oauth2: - services:write /project/{project}/service/{service_name}/metrics: post: summary: Fetch service metrics tags: - Service operationId: ServiceMetricsFetch parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceMetricsFetchRequestBody' example: kafka_topic_name: customer_accounts_topic period: hour responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceMetricsFetchResponse' security: - tokenAuth: [] oauth2: - services:write /project/{project}/service/{service_name}/privatelink/aws/connections: get: summary: List VPC Endpoint connections for an AWS Privatelink Endpoint Service tags: - Service operationId: ServicePrivatelinkAWSConnectionList parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServicePrivatelinkAWSConnectionListResponse' security: - tokenAuth: [] oauth2: - privatelink:read /project/{project}/service/{service_name}/privatelink/aws: post: summary: Create an AWS Privatelink Endpoint Service tags: - Service operationId: ServicePrivatelinkAWSCreate parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServicePrivatelinkAWSCreateRequestBody' example: principals: - arn:aws:iam::012345678901:root responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServicePrivatelinkAWSCreateResponse' security: - tokenAuth: [] oauth2: - privatelink:write delete: summary: Delete an AWS Privatelink Endpoint Service tags: - Service operationId: ServicePrivatelinkAWSDelete parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServicePrivatelinkAWSDeleteResponse' security: - tokenAuth: [] oauth2: - privatelink:write get: summary: Get AWS Privatelink Endpoint Service information tags: - Service operationId: ServicePrivatelinkAWSGet parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServicePrivatelinkAWSGetResponse' security: - tokenAuth: [] oauth2: - privatelink:read put: summary: Update an AWS Privatelink Endpoint Service tags: - Service operationId: ServicePrivatelinkAWSUpdate parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServicePrivatelinkAWSUpdateRequestBody' example: principals: - arn:aws:iam::012345678901:root responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServicePrivatelinkAWSUpdateResponse' security: - tokenAuth: [] oauth2: - privatelink:write /project/{project}/service/{service_name}/privatelink/azure/connections/{privatelink_connection_id}/approve: post: summary: Approve an Azure private endpoint connection pending user approval tags: - Service operationId: ServicePrivatelinkAzureConnectionApproval parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/privatelink_connection_id' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServicePrivatelinkAzureConnectionApprovalResponse' security: - tokenAuth: [] oauth2: - privatelink:write /project/{project}/service/{service_name}/privatelink/azure/connections: get: summary: List private endpoint connections for an Azure Privatelink Service tags: - Service operationId: ServicePrivatelinkAzureConnectionList parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServicePrivatelinkAzureConnectionListResponse' security: - tokenAuth: [] oauth2: - privatelink:read /project/{project}/service/{service_name}/privatelink/azure/connections/{privatelink_connection_id}: put: summary: Update a private endpoint connection for an Azure Privatelink Service tags: - Service operationId: ServicePrivatelinkAzureConnectionUpdate parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/privatelink_connection_id' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServicePrivatelinkAzureConnectionUpdateRequestBody' example: user_ip_address: 10.20.30.40 responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServicePrivatelinkAzureConnectionUpdateResponse' security: - tokenAuth: [] oauth2: - privatelink:write /project/{project}/service/{service_name}/privatelink/azure: post: summary: Create an Azure Privatelink Service tags: - Service operationId: ServicePrivatelinkAzureCreate parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServicePrivatelinkAzureCreateRequestBody' example: user_subscription_ids: - adcf7194-d877-4505-a47a-91fefd96e3b8 responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServicePrivatelinkAzureCreateResponse' security: - tokenAuth: [] oauth2: - privatelink:write delete: summary: Delete an Azure Privatelink Service tags: - Service operationId: ServicePrivatelinkAzureDelete parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServicePrivatelinkAzureDeleteResponse' security: - tokenAuth: [] oauth2: - privatelink:write get: summary: Get Azure Privatelink Service information tags: - Service operationId: ServicePrivatelinkAzureGet parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServicePrivatelinkAzureGetResponse' security: - tokenAuth: [] oauth2: - privatelink:read put: summary: Update an Azure Privatelink Service tags: - Service operationId: ServicePrivatelinkAzureUpdate parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServicePrivatelinkAzureUpdateRequestBody' example: user_subscription_ids: - adcf7194-d877-4505-a47a-91fefd96e3b8 responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServicePrivatelinkAzureUpdateResponse' security: - tokenAuth: [] oauth2: - privatelink:write /project/{project}/service/{service_name}/query/activity: post: summary: Fetch current queries for the service tags: - Service operationId: ServiceQueryActivity parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceQueryActivityRequestBody' example: limit: 100 offset: 100 order_by: client_id:desc responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceQueryActivityResponse' security: - tokenAuth: [] oauth2: - services:read /project/{project}/service/{service_name}/query/stats/reset: put: summary: Reset service's query statistics tags: - Service operationId: ServiceQueryStatisticsReset parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceQueryStatisticsResetResponse' security: - tokenAuth: [] oauth2: - services:write /project/{project}/service/{service_name}/service_type: patch: summary: Update the service type of a service tags: - Service operationId: ServiceServiceTypeUpdate parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceServiceTypeUpdateRequestBody' example: service_type: pg responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceServiceTypeUpdateResponse' '400': description: Invalid request parameters content: application/json: schema: type: object properties: message: type: string title: Human readable error message errors: type: array title: List of error details. Typically there is only one element items: type: object properties: message: type: string title: Human readable error message error_code: type: string enum: - service_type_not_allowed title: Machine processable error code. Clients must be prepared to handle new codes. description: 'service_type_not_allowed: Service type not allowed' '404': description: Resource not found content: application/json: schema: type: object properties: message: type: string title: Human readable error message errors: type: array title: List of error details. Typically there is only one element items: type: object properties: message: type: string title: Human readable error message error_code: type: string enum: - service_not_found title: Machine processable error code. Clients must be prepared to handle new codes. description: 'service_not_found: Service not found' '409': description: Request conflict content: application/json: schema: type: object properties: message: type: string title: Human readable error message errors: type: array title: List of error details. Typically there is only one element items: type: object properties: message: type: string title: Human readable error message error_code: type: string enum: - service_maintenance_required title: Machine processable error code. Clients must be prepared to handle new codes. description: 'service_maintenance_required: The service does not support the functionality. A maintenance update is required.' security: - tokenAuth: [] oauth2: - services:write /project/{project}/service/{service_name}/task: post: summary: Create a new task for service tags: - Service operationId: ServiceTaskCreate parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceTaskCreateRequestBody' example: create_searchable_snapshot: indices: my-index create_user_backup: backup_name: influxdb-backup dataset_import: dataset_name: pagila migration_check: ignore_dbs: db1,db2 ignore_roles: role1,role2 method: dump source_project_name: myproject source_service_name: db123 source_service_uri: mysql://user:pass@host:port/db target_version: '18' task_type: upgrade_check upgrade_check: async: true target_version: '18' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceTaskCreateResponse' security: - tokenAuth: [] oauth2: - services:write /project/{project}/service/{service_name}/task/{task_id}: get: summary: Get task result tags: - Service operationId: ServiceTaskGet parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/task_id' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceTaskGetResponse' security: - tokenAuth: [] oauth2: - services:read /project/{project}/service/{service_name}/user: post: summary: Create a new (sub) user for service tags: - Service operationId: ServiceUserCreate parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceUserCreateRequestBody' example: access_control: dragonfly_acl_categories: - +@all dragonfly_acl_commands: - -acl dragonfly_acl_keys: - prefix_* pg_allow_replication: true redis_acl_categories: - +@all redis_acl_channels: - some*chan redis_acl_commands: - -acl redis_acl_keys: - prefix_* valkey_acl_categories: - +@all valkey_acl_channels: - some*chan valkey_acl_commands: - -acl valkey_acl_keys: - prefix_* authentication: caching_sha2_password username: testuser responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceUserCreateResponse' security: - tokenAuth: [] oauth2: - services:write /project/{project}/service/{service_name}/user/{service_username}: put: summary: Modify service user credentials tags: - Service operationId: ServiceUserCredentialsModify parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/service_username' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceUserCredentialsModifyRequestBody' example: access_control: dragonfly_acl_categories: - +@all dragonfly_acl_commands: - -acl dragonfly_acl_keys: - prefix_* pg_allow_replication: true redis_acl_categories: - +@all redis_acl_channels: - some*chan redis_acl_commands: - -acl redis_acl_keys: - prefix_* valkey_acl_categories: - +@all valkey_acl_channels: - some*chan valkey_acl_commands: - -acl valkey_acl_keys: - prefix_* authentication: caching_sha2_password new_password: password12345 operation: acknowledge-renewal responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceUserCredentialsModifyResponse' security: - tokenAuth: [] oauth2: - services:write delete: summary: Delete a service user tags: - Service operationId: ServiceUserDelete parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/service_username' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceUserDeleteResponse' security: - tokenAuth: [] oauth2: - services:write get: summary: Get details for a single user tags: - Service operationId: ServiceUserGet parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/service_username' - $ref: '#/components/parameters/serviceuserget_include_secrets' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceUserGetResponse' security: - tokenAuth: [] oauth2: - services:read /project/{project}/service/{service_name}/user/{service_username}/credentials/reset: put: summary: Reset service user credentials tags: - Service operationId: ServiceUserCredentialsReset parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/service_username' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceUserCredentialsResetResponse' security: - tokenAuth: [] oauth2: - services:write components: schemas: ServicePrivatelinkAzureConnectionListResponse: type: object description: ServicePrivatelinkAzureConnectionListResponse properties: connections: type: array description: Private endpoint connection list items: type: object properties: private_endpoint_id: type: string description: Azure private endpoint ID privatelink_connection_id: type: string description: Privatelink connection ID state: type: string description: The Aiven connection state. The Azure connection status has a separate value title: Privatelink connection state enum: - pending-user-approval - user-approved - connected - active user_ip_address: type: string maxLength: 15 description: (Private) IP address of Privatelink endpoint required: - private_endpoint_id - state - user_ip_address errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request required: - connections ServiceDataHubRotateInternalSecretsResponse: type: object description: ServiceDataHubRotateInternalSecretsResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request rotation: type: object description: DatahubSecretRotationGroup properties: group: type: string description: Rotated secret group required: - group required: - message - rotation ServiceDatabaseCreateResponse: type: object description: ServiceDatabaseCreateResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request ServicePrivatelinkAzureUpdateResponse: type: object description: ServicePrivatelinkAzureUpdateResponse properties: azure_service_alias: type: string description: Azure Privatelink service alias azure_service_id: type: string description: Azure Privatelink service ID errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request state: type: string description: Privatelink resource state enum: - creating - active - deleting user_subscription_ids: type: array maxItems: 16 description: IDs of Azure subscriptions allowed to connect to the service title: Subscription ID allowlist items: type: string required: - state - user_subscription_ids ServiceDatabaseDeleteResponse: type: object description: ServiceDatabaseDeleteResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request ServiceUserCredentialsModifyRequestBody: type: object description: ServiceUserCredentialsModifyRequestBody properties: access_control: type: object description: Service type specific access control rules for user. Currently only used for configuring user ACLs for Redis version 6 and above. title: Service specific access controls for user properties: dragonfly_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string dragonfly_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string dragonfly_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string pg_allow_replication: type: boolean description: Enable REPLICATION role option redis_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string redis_acl_channels: type: array maxItems: 256 description: Glob-style patterns defining which pub/sub channels can be accessed. If array is not defined, the default policy is used (allchannels). title: Permitted pub/sub channel patterns items: type: string redis_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string redis_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string valkey_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string valkey_acl_channels: type: array maxItems: 256 description: Glob-style patterns defining which pub/sub channels can be accessed. If array is not defined, the default policy is used (allchannels). title: Permitted pub/sub channel patterns items: type: string valkey_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string valkey_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string authentication: type: string description: Service specific authentication details. Currently only used for MySQL where accepted options are 'mysql_native_password' and 'caching_sha2_password', latter being default when this is not explicitly set. title: Authentication details enum: - 'null' - caching_sha2_password - mysql_native_password new_password: type: string minLength: 8 maxLength: 256 description: New password operation: type: string description: Operation type enum: - acknowledge-renewal - reset-credentials - set-access-control required: - operation ServiceBackupToAnotherRegionReportResponse: type: object description: ServiceBackupToAnotherRegionReportResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request metrics: type: object description: Service metrics in Google chart compatible format properties: {} required: - metrics PgAvailableExtensionsResponse: type: object description: PgAvailableExtensionsResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request pg: type: array description: Supported PostgreSQL versions items: type: object properties: extensions: type: array description: Extensions available for loading with CREATE EXTENSION in this service items: type: object properties: default_version: type: string description: Default version name: type: string description: Extension name versions: type: array description: Extension versions available items: type: string required: - name version: type: string description: PostgreSQL version required: - extensions - version ServicePrivatelinkAzureUpdateRequestBody: type: object description: ServicePrivatelinkAzureUpdateRequestBody properties: user_subscription_ids: type: array maxItems: 16 description: IDs of Azure subscriptions allowed to connect to the service title: Subscription ID allowlist items: type: string required: - user_subscription_ids ServicePrivatelinkAzureConnectionApprovalResponse: type: object description: ServicePrivatelinkAzureConnectionApprovalResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request private_endpoint_id: type: string description: Azure private endpoint ID privatelink_connection_id: type: string description: Privatelink connection ID state: type: string description: The Aiven connection state. The Azure connection status has a separate value title: Privatelink connection state enum: - pending-user-approval - user-approved - connected - active user_ip_address: type: string maxLength: 15 description: (Private) IP address of Privatelink endpoint required: - private_endpoint_id - state - user_ip_address ServiceQueryActivityResponse: type: object description: ServiceQueryActivityResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request queries: type: array description: List of currently running queries and open connections items: type: object properties: active_channel_subscriptions: type: integer description: Currently active channel subscriptions active_database: type: string description: Selected database active_pattern_matching_channel_subscriptions: type: integer description: Currently active channel subscriptions using pattern matching application_name: type: string description: Application name when set backend_start: type: string maxLength: 36 description: Timestamp in ISO 8601 format, always in UTC backend_type: type: string description: Backend type backend_xid: type: integer description: XID for current backend backend_xmin: type: integer description: xmin for current backend client_addr: type: string description: IP address:port pair. Not always available due to load balancers client_hostname: type: string description: Client hostname client_port: type: integer maximum: 65536 description: Client port, -1 is unknown connection_age_seconds: type: number description: Connection age in seconds connection_idle_seconds: type: number description: Connection idle time in seconds datid: type: integer description: Database ID datname: type: string description: Database name flags: type: array description: Connection state flags items: type: string flags_raw: type: string description: Raw connection flags string id: type: string description: Unique connection ID leader_pid: type: integer minimum: 0 description: Leader process ID multi_exec_commands: type: integer description: Number of MULTI/EXEC comands name: type: string description: Connection name, if specified output_buffer: type: integer description: Output buffer length (disabled if 0) output_buffer_memory: type: integer description: Output buffer memory output_list_length: type: integer description: Output list, overflow for output buffering pid: type: integer minimum: 0 description: Connection process ID query: type: string description: Last/current query running on this connection query_buffer: type: integer description: Query buffer length (disabled if 0) query_buffer_free: type: integer description: Free bytes in query buffer, if enabled query_duration: type: number description: Duration of the last/current query in seconds query_id: type: integer description: Hash code to identify identical normalized queries. query_start: type: string maxLength: 36 description: Timestamp in ISO 8601 format, always in UTC state: type: string description: Connection state state_change: type: string maxLength: 36 description: Timestamp in ISO 8601 format, always in UTC usename: type: string description: Username usesysid: type: integer description: User ID wait_event: type: string description: Connection wait event wait_event_type: type: string description: Connection wait event type waiting: type: boolean description: Query is waiting xact_start: type: string maxLength: 36 description: Timestamp in ISO 8601 format, always in UTC required: - queries ServiceBackupsGetResponse: type: object description: ServiceBackupsGetResponse properties: backup_progress: type: string description: Scheduled time for the next backup backups: type: array description: List of backups for the service items: type: object properties: additional_regions: type: array description: Additional backup regions, if available items: type: object properties: cloud: type: string maxLength: 256 description: Target cloud pause_reason: type: string description: Reason for pausing the backup synchronization paused: type: boolean description: Indicates additional backup synchronization is paused region: type: string description: Cloud storage region name required: - cloud backup_name: type: string description: Internal name of this backup backup_time: type: string maxLength: 36 description: Backup timestamp (ISO 8601) data_size: type: integer description: Backup's original size before compression incremental: type: boolean description: Indicates if this backup is a full or an incremental one (available only for MySQL) storage_location: type: string description: Location where this backup is stored tiered_storage_data_size: type: integer description: The amount of tiered storage data in bytes referenced by this backup. required: - backup_name - backup_time - data_size errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request pitr: type: object description: Point-in-time-recovery metadata for the service. If not set, service type does not support PITR. title: Backup PITR metadata properties: additional_regions: type: array description: Empty array if BTAR is not enabled or BTAR+PITR is not supported. title: Backup PITR metadata for additional backup regions items: type: object properties: cloud: type: string maxLength: 256 description: Target cloud pitr_range_end: type: string maxLength: 36 description: Latest timestamp usable for PITR (ISO 8601) (always set) pitr_range_start: type: string maxLength: 36 description: Earliest timestamp usable for PITR (ISO 8601) (always set) region: type: string description: Cloud storage region name required: - cloud - pitr_range_end - pitr_range_start - region primary_region: type: object description: Point-in-time-recovery metadata related to the primary backup location of the service. title: Backup PITR metadata primary properties: pitr_range_end: type: string maxLength: 36 description: Latest timestamp usable for PITR (ISO 8601) (null means current time) pitr_range_start: type: string maxLength: 36 description: Earliest timestamp usable for PITR (ISO 8601) (null means no available backup for PITR) required: - pitr_range_end - pitr_range_start required: - additional_regions - primary_region scheduled_backup_time: type: object description: Scheduled time and frequency of service backups properties: backup_hour: type: integer minimum: 0 maximum: 23 description: The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. backup_interval_hours: type: integer description: Service backup interval in hours backup_minute: type: integer minimum: 0 maximum: 59 description: The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. required: - backups ProjectGetServiceLogsRequestBody: type: object description: ProjectGetServiceLogsRequestBody properties: limit: type: integer minimum: 1 maximum: 500 description: How many log entries to receive at most default: 100 offset: type: string maxLength: 128 description: Opaque offset identifier severity: type: string description: Filter to entries with severity at least as severe as this value enum: - emerg - alert - crit - err - warning - notice - info - debug sort_order: type: string description: Sort order for log messages default: desc enum: - desc - asc ServiceTaskGetResponse: type: object description: ServiceTaskGetResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request task: type: object description: Task info properties: create_time: type: string maxLength: 36 description: Timestamp in ISO 8601 format, always in UTC result: type: string description: Task result result_codes: type: array description: List of result codes items: type: object properties: code: type: string description: Machine-readable key code, which represents the result of the task dbname: type: string description: Database which related to the result code required: - code success: type: boolean description: Task success task_id: type: string description: Unique identifier for the task task_type: type: string description: Task type required: - create_time - result - success - task_id - task_type required: - task ListProjectServiceTypesResponse: type: object description: ListProjectServiceTypesResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request service_types: type: object description: Service plans by service type properties: clickhouse: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema dragonfly: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema elasticsearch: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema flink: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema grafana: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema kafka: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema kafka_connect: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema kafka_mirrormaker: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema mysql: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema opensearch: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema pg: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema redis: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema thanos: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema valkey: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema required: - service_types ServiceServiceTypeUpdateResponse: type: object description: ServiceServiceTypeUpdateResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request service: type: object description: Service information properties: acl: type: array description: List of Aiven ACL entries for Kafka service items: type: object properties: id: type: string maxLength: 40 description: ID permission: type: string description: Kafka permission enum: - admin - read - readwrite - write topic: type: string minLength: 1 maxLength: 249 description: Topic name pattern username: type: string minLength: 1 maxLength: 64 description: Username required: - permission - topic - username backups: type: array description: List of backups for the service items: type: object properties: additional_regions: type: array description: Additional backup regions, if available items: type: object properties: cloud: type: string maxLength: 256 description: Target cloud pause_reason: type: string description: Reason for pausing the backup synchronization paused: type: boolean description: Indicates additional backup synchronization is paused region: type: string description: Cloud storage region name required: - cloud backup_name: type: string description: Internal name of this backup backup_time: type: string maxLength: 36 description: Backup timestamp (ISO 8601) data_size: type: integer description: Backup's original size before compression incremental: type: boolean description: Indicates if this backup is a full or an incremental one (available only for MySQL) storage_location: type: string description: Location where this backup is stored tiered_storage_data_size: type: integer description: The amount of tiered storage data in bytes referenced by this backup. required: - backup_name - backup_time - data_size cloud_description: type: string description: Cloud provider and location cloud_name: type: string maxLength: 256 description: Target cloud cmk_id: type: string description: Active Customer Managed Key identifier (CMK ID) components: type: array description: Service component information objects items: type: object properties: component: type: string description: Service component name host: type: string description: DNS name for connecting to the service component kafka_authentication_method: type: string description: Kafka authentication method. This is a value specific to the 'kafka' service component enum: - certificate - sasl kafka_ssl_ca: type: string description: Specifies if this port uses Project CA or Letsencrypt. If not specified, the default is using Project CA.This is a value specific to the 'kafka' service component. enum: - project_ca - letsencrypt path: type: string description: Path component of the service URL (useful only if service component is HTTP or HTTPS endpoint) port: type: integer minimum: 0 maximum: 65535 description: Port number for connecting to the service component privatelink_connection_id: type: string description: Privatelink connection ID route: type: string description: Network access route enum: - dynamic - public - private - privatelink ssl: type: boolean description: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted andthis property is only included for service components that may disable encryption. usage: type: string description: DNS usage name enum: - disaster_recovery - primary - replica - ha_replica required: - component - host - port - route - usage connection_info: type: object description: Service-specific connection information properties properties: {} connection_pools: type: array description: PostgreSQL PGBouncer connection pools items: type: object properties: connection_uri: type: string description: Connection URI for the DB pool database: type: string maxLength: 63 description: Database name pool_mode: type: string description: PGBouncer pool mode enum: - session - transaction - statement pool_name: type: string maxLength: 63 description: Connection pool name pool_size: type: integer minimum: 1 maximum: 10000 description: Size of PGBouncer's PostgreSQL side connection pool username: type: string maxLength: 64 description: Pool username required: - connection_uri - database - pool_mode - pool_name - pool_size create_time: type: string maxLength: 36 description: Service creation timestamp (ISO 8601) databases: type: array description: List of service's user database names items: type: string disk_space_mb: type: integer minimum: 0 description: Megabytes of disk space for data storage features: type: object description: Feature flags properties: {} group_list: type: array description: List of service groups the service belongs to. This field is deprecated. It is always set to single element with value 'default' items: type: string is_cluster_plan: type: boolean description: True when the service uses a cluster plan with dedicated node groups kafka_acl: type: array description: List of Kafka-native ACL entries items: type: object properties: host: type: string minLength: 0 maxLength: 256 description: the host or * for all hosts id: type: string maxLength: 40 description: ID operation: type: string description: Kafka ACL operation represents an operation which an ACL grants or denies permission to perform enum: - All - Alter - AlterConfigs - ClusterAction - Create - CreateTokens - Delete - Describe - DescribeConfigs - DescribeTokens - IdempotentWrite - Read - Write pattern_type: type: string description: Kafka ACL pattern type of resource name enum: - LITERAL - PREFIXED permission_type: type: string description: Kafka ACL permission type enum: - ALLOW - DENY principal: type: string minLength: 0 maxLength: 256 description: principal is in 'principalType:name' format resource_name: type: string minLength: 0 maxLength: 256 description: Resource pattern used to match specified resources resource_type: type: string description: Kafka ACL resource type represents a type of resource which an ACL can be applied to enum: - Cluster - DelegationToken - Group - Topic - TransactionalId - User required: - host - id - operation - pattern_type - permission_type - principal - resource_name - resource_type maintenance: type: object description: Automatic maintenance settings properties: controlled_switchover: type: object description: Controlled switchover status properties: completed_at: type: string description: Time when the switchover completed, if it has completed enabled: type: boolean description: Controlled switchover configured and enabled scheduled_start_time: type: string description: Scheduled start time of the switchover window, if enabled and active state: type: string description: Controlled switchover state enum: - INACTIVE - PENDING - SCHEDULED - RUNNING - COMPLETED - COMPLETED_EARLY termination_reason: type: string description: Reason for switchover termination required: - enabled - scheduled_start_time - state dow: type: string description: Day of week for installing updates enum: - monday - tuesday - wednesday - thursday - friday - saturday - sunday - never enabled: type: boolean description: Service maintenance enabled time: type: string minLength: 8 maxLength: 8 description: Time for installing updates, UTC updates: type: array description: List of updates waiting to be installed items: type: object properties: deadline: type: string description: Deadline for installing the update description: type: string description: Description of the update documentation_link: type: string description: Optional link impact: type: string description: Impact statement of the update impact_portable_text: type: string description: Impact statement in portable text format start_after: type: string description: The earliest time the update will be automatically applied start_at: type: string description: The time when the update will be automatically applied required: - dow - enabled - time - updates metadata: type: object description: Service type specific metadata properties: {} node_count: type: integer description: Number of service nodes in the active plan node_cpu_count: type: integer description: Number of CPUs for each node node_memory_mb: type: number description: Megabytes of memory for each node node_states: type: array description: State of individual service nodes items: type: object properties: availability_zone: type: string description: The availability zone in which the node is place. If there is no availability zone available this field will be missing. name: type: string description: Name of the service node progress_updates: type: array description: Extra information regarding the progress for current state items: type: object properties: completed: type: boolean description: Indicates whether this phase has been completed or not current: type: integer description: Current progress for this phase. May be missing or null. max: type: integer description: Maximum progress value for this phase. May be missing or null. May change. min: type: integer description: Minimum progress value for this phase. May be missing or null. phase: type: string description: Key identifying this phase enum: - prepare - basebackup - basebackup_prepare - stream - finalize unit: type: string description: Unit for current/min/max values. New units may be added. If null should be treated as generic unit enum: - binlogs - bytes_compressed - bytes_uncompressed - prepare_percent - wal_lsn required: - completed - phase role: type: string description: Role of this node. Only returned for a subset of service types enum: - master - standby - read-replica roles: type: string description: 'A role string indicating the node''s roles in the OpenSearch cluster. Only populated for OpenSearch services using cluster plans. Format: first character is ''*'' (elected cluster manager) or ''-'' (not elected), followed by role letters: ''d'' (data), ''i'' (ingest), ''m'' (cluster_manager eligible), ''c'' (coordinating), ''L'' (ML), ''D'' (Dashboards). Example: ''*mc'' means elected cluster manager with cluster_manager and coordinating roles.' title: Roles of this node. Only returned for OpenSearch services with cluster plans shard: type: object description: Shard of this node. Only returned for a subset of service types properties: name: type: string description: Name of the shard. position: type: integer description: Position of this shard within the service state: type: string description: Current state of the service node enum: - leaving - running - setting_up_vm - syncing_data - timing_out - unknown required: - availability_zone - name - state plan: type: string maxLength: 128 description: Subscription plan project_vpc_id: type: string minLength: 36 maxLength: 36 description: Project VPC ID schema_registry_acl: type: array description: List of Schema Registry ACL entries items: type: object properties: id: type: string maxLength: 40 description: ID permission: type: string description: ACL entry for Schema Registry enum: - schema_registry_read - schema_registry_write resource: type: string minLength: 1 maxLength: 249 description: Schema Registry ACL entry resource name pattern username: type: string minLength: 1 maxLength: 64 description: Username required: - permission - resource - username server_group: type: object description: Service IaaS server group properties: enabled: type: boolean description: Flag set if server group is in use for the service type: type: string description: IaaS server group type service_integrations: type: array description: Integrations with other services items: type: object properties: active: type: boolean description: True when integration is active description: type: string description: Description of the integration dest_endpoint: type: string description: Destination endpoint name dest_endpoint_id: type: string description: Destination endpoint id dest_project: type: string maxLength: 63 description: Project name dest_service: type: string description: Destination service name dest_service_type: type: string maxLength: 64 description: Service type code enabled: type: boolean description: True when integration is enabled integration_status: type: object description: Integration status properties: state: type: object description: Service integration state properties: errors: type: array description: Errors items: type: string likely_error_cause: type: string description: Most likely cause of the errors enum: - 'null' - destination - integration - source - unknown nodes: type: object description: Nodes properties: {} status: type: string description: Service integration status enum: - failed - inactive - running - starting - unknown required: - errors - nodes - status status_user_desc: type: string description: Integration status description required: - state - status_user_desc integration_type: type: string description: Type of the integration service_integration_id: type: string description: Integration ID source_endpoint: type: string description: Source endpoint name source_endpoint_id: type: string description: Source endpoint ID source_project: type: string maxLength: 63 description: Project name source_service: type: string description: Source service name source_service_type: type: string maxLength: 64 description: Service type code user_config: type: object description: Service integration settings properties: {} required: - active - description - dest_project - dest_service_type - enabled - integration_type - service_integration_id - source_project - source_service - source_service_type service_name: type: string minLength: 1 maxLength: 64 description: Service name service_notifications: type: array description: Service notifications items: type: object properties: level: type: string description: Notification level enum: - notice - warning message: type: string maxLength: 1024 description: Human notification message metadata: type: object description: Notification metadata properties: end_of_life_help_article_url: type: string description: Link to the help article end_of_life_policy_url: type: string description: Link to the help article service_end_of_life_time: type: string maxLength: 36 description: Timestamp in ISO 8601 format, always in UTC upgrade_to_service_type: type: string maxLength: 64 description: If the customer takes no action, the service is updated to this service type when end of life is reached on the Aiven platform. If it is the same as the service type, the platform only upgrades the version. upgrade_to_version: type: string maxLength: 32 description: The version to which the service will be updated at the end of life on the Aiven platform if the user does not take any action type: type: string description: Notification type enum: - service_end_of_life - service_powered_off_removal required: - level - message - metadata - type service_type: type: string maxLength: 64 description: Service type code service_type_description: type: string description: Single line description of the service service_uri: type: string description: URI for connecting to the service (may be null) service_uri_params: type: object description: service_uri parameterized into key-value pairs properties: {} state: type: string description: State of the service enum: - POWEROFF - REBALANCING - REBUILDING - RUNNING tags: type: object description: Set of resource tags properties: {} tech_emails: type: array maxItems: 10 description: List of service technical email addresses items: type: object properties: email: type: string maxLength: 254 description: User email address required: - email termination_protection: type: boolean description: Service is protected against termination and powering off topics: type: array description: 'Kafka topics. DEPRECATED: Use /project/$project/service/$service/topic instead' items: type: object properties: cleanup_policy: type: string maxLength: 64 description: The retention policy to use on old segments. Possible values include 'delete', 'compact', or a comma-separated list of them. The default policy ('delete') will discard old segments when their retention time or size limit has been reached. The 'compact' setting will enable log compaction on the topic. title: cleanup.policy min_insync_replicas: type: integer minimum: 1 description: When a producer sets acks to 'all' (or '-1'), this configuration specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. If this minimum cannot be met, then the producer will raise an exception (either NotEnoughReplicas or NotEnoughReplicasAfterAppend). When used together, min.insync.replicas and acks allow you to enforce greater durability guarantees. A typical scenario would be to create a topic with a replication factor of 3, set min.insync.replicas to 2, and produce with acks of 'all'. This will ensure that the producer raises an exception if a majority of replicas do not receive a write. title: min.insync.replicas partitions: type: integer minimum: 1 maximum: 1000000 description: Number of partitions replication: type: integer minimum: 1 description: Number of replicas retention_bytes: type: integer description: This configuration controls the maximum size a partition (which consists of log segments) can grow to before we will discard old log segments to free up space if we are using the 'delete' retention policy. By default there is no size limit only a time limit. Since this limit is enforced at the partition level, multiply it by the number of partitions to compute the topic retention in bytes. title: retention.bytes retention_hours: type: integer maximum: 2562047788015 description: Retention period (hours) state: type: string description: Topic state enum: - ACTIVE - CONFIGURING - DELETING topic_name: type: string minLength: 1 maxLength: 249 description: Topic name required: - cleanup_policy - min_insync_replicas - partitions - replication - retention_bytes - retention_hours - topic_name update_time: type: string maxLength: 36 description: Service last update timestamp (ISO 8601) user_config: type: object description: Service type-specific settings properties: {} users: type: array description: List of service users items: type: object properties: access_cert: type: string description: Access certificate for TLS client authentication access_cert_not_valid_after_time: type: string description: Validity end time (ISO8601) for the current access certificate access_control: type: object description: Service type specific access control rules for user. Currently only used for configuring user ACLs for Redis version 6 and above. title: Service specific access controls for user properties: dragonfly_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string dragonfly_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string dragonfly_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string pg_allow_replication: type: boolean description: Enable REPLICATION role option redis_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string redis_acl_channels: type: array maxItems: 256 description: Glob-style patterns defining which pub/sub channels can be accessed. If array is not defined, the default policy is used (allchannels). title: Permitted pub/sub channel patterns items: type: string redis_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string redis_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string valkey_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string valkey_acl_channels: type: array maxItems: 256 description: Glob-style patterns defining which pub/sub channels can be accessed. If array is not defined, the default policy is used (allchannels). title: Permitted pub/sub channel patterns items: type: string valkey_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string valkey_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string access_key: type: string description: Access key for TLS client authentication authentication: type: string description: Service specific authentication details. Currently only used for MySQL where accepted options are 'mysql_native_password' and 'caching_sha2_password', latter being default when this is not explicitly set. title: Authentication details enum: - 'null' - caching_sha2_password - mysql_native_password expiring_cert_not_valid_after_time: type: string description: When the existing certificate is nearing expiration and a new certificate has been generated, the validity end time (ISO8601) for the expiring certificate title: Validity end time (ISO8601) for the expiring access certificate password: type: string description: Account password. A null value indicates a user overridden password. password_updated_time: type: string description: Timestamp (ISO8601) of the last time this password was set. type: type: string description: Account type username: type: string description: Account username required: - password - type - username required: - cloud_name - create_time - group_list - plan - project_vpc_id - service_integrations - service_name - service_type - service_uri - state - termination_protection - update_time - user_config required: - service ServiceUserCreateRequestBody: type: object description: ServiceUserCreateRequestBody properties: access_control: type: object description: Service type specific access control rules for user. Currently only used for configuring user ACLs for Redis version 6 and above. title: Service specific access controls for user properties: dragonfly_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string dragonfly_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string dragonfly_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string pg_allow_replication: type: boolean description: Enable REPLICATION role option redis_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string redis_acl_channels: type: array maxItems: 256 description: Glob-style patterns defining which pub/sub channels can be accessed. If array is not defined, the default policy is used (allchannels). title: Permitted pub/sub channel patterns items: type: string redis_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string redis_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string valkey_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string valkey_acl_channels: type: array maxItems: 256 description: Glob-style patterns defining which pub/sub channels can be accessed. If array is not defined, the default policy is used (allchannels). title: Permitted pub/sub channel patterns items: type: string valkey_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string valkey_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string authentication: type: string description: Service specific authentication details. Currently only used for MySQL where accepted options are 'mysql_native_password' and 'caching_sha2_password', latter being default when this is not explicitly set. title: Authentication details enum: - 'null' - caching_sha2_password - mysql_native_password username: type: string maxLength: 64 description: Service username required: - username ServiceCreateResponse: type: object description: ServiceCreateResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request service: type: object description: Service information properties: acl: type: array description: List of Aiven ACL entries for Kafka service items: type: object properties: id: type: string maxLength: 40 description: ID permission: type: string description: Kafka permission enum: - admin - read - readwrite - write topic: type: string minLength: 1 maxLength: 249 description: Topic name pattern username: type: string minLength: 1 maxLength: 64 description: Username required: - permission - topic - username backups: type: array description: List of backups for the service items: type: object properties: additional_regions: type: array description: Additional backup regions, if available items: type: object properties: cloud: type: string maxLength: 256 description: Target cloud pause_reason: type: string description: Reason for pausing the backup synchronization paused: type: boolean description: Indicates additional backup synchronization is paused region: type: string description: Cloud storage region name required: - cloud backup_name: type: string description: Internal name of this backup backup_time: type: string maxLength: 36 description: Backup timestamp (ISO 8601) data_size: type: integer description: Backup's original size before compression incremental: type: boolean description: Indicates if this backup is a full or an incremental one (available only for MySQL) storage_location: type: string description: Location where this backup is stored tiered_storage_data_size: type: integer description: The amount of tiered storage data in bytes referenced by this backup. required: - backup_name - backup_time - data_size cloud_description: type: string description: Cloud provider and location cloud_name: type: string maxLength: 256 description: Target cloud cmk_id: type: string description: Active Customer Managed Key identifier (CMK ID) components: type: array description: Service component information objects items: type: object properties: component: type: string description: Service component name host: type: string description: DNS name for connecting to the service component kafka_authentication_method: type: string description: Kafka authentication method. This is a value specific to the 'kafka' service component enum: - certificate - sasl kafka_ssl_ca: type: string description: Specifies if this port uses Project CA or Letsencrypt. If not specified, the default is using Project CA.This is a value specific to the 'kafka' service component. enum: - project_ca - letsencrypt path: type: string description: Path component of the service URL (useful only if service component is HTTP or HTTPS endpoint) port: type: integer minimum: 0 maximum: 65535 description: Port number for connecting to the service component privatelink_connection_id: type: string description: Privatelink connection ID route: type: string description: Network access route enum: - dynamic - public - private - privatelink ssl: type: boolean description: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted andthis property is only included for service components that may disable encryption. usage: type: string description: DNS usage name enum: - disaster_recovery - primary - replica - ha_replica required: - component - host - port - route - usage connection_info: type: object description: Service-specific connection information properties properties: {} connection_pools: type: array description: PostgreSQL PGBouncer connection pools items: type: object properties: connection_uri: type: string description: Connection URI for the DB pool database: type: string maxLength: 63 description: Database name pool_mode: type: string description: PGBouncer pool mode enum: - session - transaction - statement pool_name: type: string maxLength: 63 description: Connection pool name pool_size: type: integer minimum: 1 maximum: 10000 description: Size of PGBouncer's PostgreSQL side connection pool username: type: string maxLength: 64 description: Pool username required: - connection_uri - database - pool_mode - pool_name - pool_size create_time: type: string maxLength: 36 description: Service creation timestamp (ISO 8601) databases: type: array description: List of service's user database names items: type: string disk_space_mb: type: integer minimum: 0 description: Megabytes of disk space for data storage features: type: object description: Feature flags properties: {} group_list: type: array description: List of service groups the service belongs to. This field is deprecated. It is always set to single element with value 'default' items: type: string is_cluster_plan: type: boolean description: True when the service uses a cluster plan with dedicated node groups kafka_acl: type: array description: List of Kafka-native ACL entries items: type: object properties: host: type: string minLength: 0 maxLength: 256 description: the host or * for all hosts id: type: string maxLength: 40 description: ID operation: type: string description: Kafka ACL operation represents an operation which an ACL grants or denies permission to perform enum: - All - Alter - AlterConfigs - ClusterAction - Create - CreateTokens - Delete - Describe - DescribeConfigs - DescribeTokens - IdempotentWrite - Read - Write pattern_type: type: string description: Kafka ACL pattern type of resource name enum: - LITERAL - PREFIXED permission_type: type: string description: Kafka ACL permission type enum: - ALLOW - DENY principal: type: string minLength: 0 maxLength: 256 description: principal is in 'principalType:name' format resource_name: type: string minLength: 0 maxLength: 256 description: Resource pattern used to match specified resources resource_type: type: string description: Kafka ACL resource type represents a type of resource which an ACL can be applied to enum: - Cluster - DelegationToken - Group - Topic - TransactionalId - User required: - host - id - operation - pattern_type - permission_type - principal - resource_name - resource_type maintenance: type: object description: Automatic maintenance settings properties: controlled_switchover: type: object description: Controlled switchover status properties: completed_at: type: string description: Time when the switchover completed, if it has completed enabled: type: boolean description: Controlled switchover configured and enabled scheduled_start_time: type: string description: Scheduled start time of the switchover window, if enabled and active state: type: string description: Controlled switchover state enum: - INACTIVE - PENDING - SCHEDULED - RUNNING - COMPLETED - COMPLETED_EARLY termination_reason: type: string description: Reason for switchover termination required: - enabled - scheduled_start_time - state dow: type: string description: Day of week for installing updates enum: - monday - tuesday - wednesday - thursday - friday - saturday - sunday - never enabled: type: boolean description: Service maintenance enabled time: type: string minLength: 8 maxLength: 8 description: Time for installing updates, UTC updates: type: array description: List of updates waiting to be installed items: type: object properties: deadline: type: string description: Deadline for installing the update description: type: string description: Description of the update documentation_link: type: string description: Optional link impact: type: string description: Impact statement of the update impact_portable_text: type: string description: Impact statement in portable text format start_after: type: string description: The earliest time the update will be automatically applied start_at: type: string description: The time when the update will be automatically applied required: - dow - enabled - time - updates metadata: type: object description: Service type specific metadata properties: {} node_count: type: integer description: Number of service nodes in the active plan node_cpu_count: type: integer description: Number of CPUs for each node node_memory_mb: type: number description: Megabytes of memory for each node node_states: type: array description: State of individual service nodes items: type: object properties: availability_zone: type: string description: The availability zone in which the node is place. If there is no availability zone available this field will be missing. name: type: string description: Name of the service node progress_updates: type: array description: Extra information regarding the progress for current state items: type: object properties: completed: type: boolean description: Indicates whether this phase has been completed or not current: type: integer description: Current progress for this phase. May be missing or null. max: type: integer description: Maximum progress value for this phase. May be missing or null. May change. min: type: integer description: Minimum progress value for this phase. May be missing or null. phase: type: string description: Key identifying this phase enum: - prepare - basebackup - basebackup_prepare - stream - finalize unit: type: string description: Unit for current/min/max values. New units may be added. If null should be treated as generic unit enum: - binlogs - bytes_compressed - bytes_uncompressed - prepare_percent - wal_lsn required: - completed - phase role: type: string description: Role of this node. Only returned for a subset of service types enum: - master - standby - read-replica roles: type: string description: 'A role string indicating the node''s roles in the OpenSearch cluster. Only populated for OpenSearch services using cluster plans. Format: first character is ''*'' (elected cluster manager) or ''-'' (not elected), followed by role letters: ''d'' (data), ''i'' (ingest), ''m'' (cluster_manager eligible), ''c'' (coordinating), ''L'' (ML), ''D'' (Dashboards). Example: ''*mc'' means elected cluster manager with cluster_manager and coordinating roles.' title: Roles of this node. Only returned for OpenSearch services with cluster plans shard: type: object description: Shard of this node. Only returned for a subset of service types properties: name: type: string description: Name of the shard. position: type: integer description: Position of this shard within the service state: type: string description: Current state of the service node enum: - leaving - running - setting_up_vm - syncing_data - timing_out - unknown required: - availability_zone - name - state plan: type: string maxLength: 128 description: Subscription plan project_vpc_id: type: string minLength: 36 maxLength: 36 description: Project VPC ID schema_registry_acl: type: array description: List of Schema Registry ACL entries items: type: object properties: id: type: string maxLength: 40 description: ID permission: type: string description: ACL entry for Schema Registry enum: - schema_registry_read - schema_registry_write resource: type: string minLength: 1 maxLength: 249 description: Schema Registry ACL entry resource name pattern username: type: string minLength: 1 maxLength: 64 description: Username required: - permission - resource - username server_group: type: object description: Service IaaS server group properties: enabled: type: boolean description: Flag set if server group is in use for the service type: type: string description: IaaS server group type service_integrations: type: array description: Integrations with other services items: type: object properties: active: type: boolean description: True when integration is active description: type: string description: Description of the integration dest_endpoint: type: string description: Destination endpoint name dest_endpoint_id: type: string description: Destination endpoint id dest_project: type: string maxLength: 63 description: Project name dest_service: type: string description: Destination service name dest_service_type: type: string maxLength: 64 description: Service type code enabled: type: boolean description: True when integration is enabled integration_status: type: object description: Integration status properties: state: type: object description: Service integration state properties: errors: type: array description: Errors items: type: string likely_error_cause: type: string description: Most likely cause of the errors enum: - 'null' - destination - integration - source - unknown nodes: type: object description: Nodes properties: {} status: type: string description: Service integration status enum: - failed - inactive - running - starting - unknown required: - errors - nodes - status status_user_desc: type: string description: Integration status description required: - state - status_user_desc integration_type: type: string description: Type of the integration service_integration_id: type: string description: Integration ID source_endpoint: type: string description: Source endpoint name source_endpoint_id: type: string description: Source endpoint ID source_project: type: string maxLength: 63 description: Project name source_service: type: string description: Source service name source_service_type: type: string maxLength: 64 description: Service type code user_config: type: object description: Service integration settings properties: {} required: - active - description - dest_project - dest_service_type - enabled - integration_type - service_integration_id - source_project - source_service - source_service_type service_name: type: string minLength: 1 maxLength: 64 description: Service name service_notifications: type: array description: Service notifications items: type: object properties: level: type: string description: Notification level enum: - notice - warning message: type: string maxLength: 1024 description: Human notification message metadata: type: object description: Notification metadata properties: end_of_life_help_article_url: type: string description: Link to the help article end_of_life_policy_url: type: string description: Link to the help article service_end_of_life_time: type: string maxLength: 36 description: Timestamp in ISO 8601 format, always in UTC upgrade_to_service_type: type: string maxLength: 64 description: If the customer takes no action, the service is updated to this service type when end of life is reached on the Aiven platform. If it is the same as the service type, the platform only upgrades the version. upgrade_to_version: type: string maxLength: 32 description: The version to which the service will be updated at the end of life on the Aiven platform if the user does not take any action type: type: string description: Notification type enum: - service_end_of_life - service_powered_off_removal required: - level - message - metadata - type service_type: type: string maxLength: 64 description: Service type code service_type_description: type: string description: Single line description of the service service_uri: type: string description: URI for connecting to the service (may be null) service_uri_params: type: object description: service_uri parameterized into key-value pairs properties: {} state: type: string description: State of the service enum: - POWEROFF - REBALANCING - REBUILDING - RUNNING tags: type: object description: Set of resource tags properties: {} tech_emails: type: array maxItems: 10 description: List of service technical email addresses items: type: object properties: email: type: string maxLength: 254 description: User email address required: - email termination_protection: type: boolean description: Service is protected against termination and powering off topics: type: array description: 'Kafka topics. DEPRECATED: Use /project/$project/service/$service/topic instead' items: type: object properties: cleanup_policy: type: string maxLength: 64 description: The retention policy to use on old segments. Possible values include 'delete', 'compact', or a comma-separated list of them. The default policy ('delete') will discard old segments when their retention time or size limit has been reached. The 'compact' setting will enable log compaction on the topic. title: cleanup.policy min_insync_replicas: type: integer minimum: 1 description: When a producer sets acks to 'all' (or '-1'), this configuration specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. If this minimum cannot be met, then the producer will raise an exception (either NotEnoughReplicas or NotEnoughReplicasAfterAppend). When used together, min.insync.replicas and acks allow you to enforce greater durability guarantees. A typical scenario would be to create a topic with a replication factor of 3, set min.insync.replicas to 2, and produce with acks of 'all'. This will ensure that the producer raises an exception if a majority of replicas do not receive a write. title: min.insync.replicas partitions: type: integer minimum: 1 maximum: 1000000 description: Number of partitions replication: type: integer minimum: 1 description: Number of replicas retention_bytes: type: integer description: This configuration controls the maximum size a partition (which consists of log segments) can grow to before we will discard old log segments to free up space if we are using the 'delete' retention policy. By default there is no size limit only a time limit. Since this limit is enforced at the partition level, multiply it by the number of partitions to compute the topic retention in bytes. title: retention.bytes retention_hours: type: integer maximum: 2562047788015 description: Retention period (hours) state: type: string description: Topic state enum: - ACTIVE - CONFIGURING - DELETING topic_name: type: string minLength: 1 maxLength: 249 description: Topic name required: - cleanup_policy - min_insync_replicas - partitions - replication - retention_bytes - retention_hours - topic_name update_time: type: string maxLength: 36 description: Service last update timestamp (ISO 8601) user_config: type: object description: Service type-specific settings properties: {} users: type: array description: List of service users items: type: object properties: access_cert: type: string description: Access certificate for TLS client authentication access_cert_not_valid_after_time: type: string description: Validity end time (ISO8601) for the current access certificate access_control: type: object description: Service type specific access control rules for user. Currently only used for configuring user ACLs for Redis version 6 and above. title: Service specific access controls for user properties: dragonfly_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string dragonfly_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string dragonfly_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string pg_allow_replication: type: boolean description: Enable REPLICATION role option redis_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string redis_acl_channels: type: array maxItems: 256 description: Glob-style patterns defining which pub/sub channels can be accessed. If array is not defined, the default policy is used (allchannels). title: Permitted pub/sub channel patterns items: type: string redis_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string redis_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string valkey_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string valkey_acl_channels: type: array maxItems: 256 description: Glob-style patterns defining which pub/sub channels can be accessed. If array is not defined, the default policy is used (allchannels). title: Permitted pub/sub channel patterns items: type: string valkey_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string valkey_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string access_key: type: string description: Access key for TLS client authentication authentication: type: string description: Service specific authentication details. Currently only used for MySQL where accepted options are 'mysql_native_password' and 'caching_sha2_password', latter being default when this is not explicitly set. title: Authentication details enum: - 'null' - caching_sha2_password - mysql_native_password expiring_cert_not_valid_after_time: type: string description: When the existing certificate is nearing expiration and a new certificate has been generated, the validity end time (ISO8601) for the expiring certificate title: Validity end time (ISO8601) for the expiring access certificate password: type: string description: Account password. A null value indicates a user overridden password. password_updated_time: type: string description: Timestamp (ISO8601) of the last time this password was set. type: type: string description: Account type username: type: string description: Account username required: - password - type - username required: - cloud_name - create_time - group_list - plan - project_vpc_id - service_integrations - service_name - service_type - service_uri - state - termination_protection - update_time - user_config required: - service ServiceBackupToAnotherRegionReportRequestBody: type: object description: ServiceBackupToAnotherRegionReportRequestBody properties: kafka_topic_name: type: string maxLength: 249 description: Metrics at Kafka service topic level period: type: string description: Metrics time period default: hour enum: - hour - day - week - month - year ServiceCreateRequestBody: type: object description: ServiceCreateRequestBody properties: cloud: type: string maxLength: 256 description: Target cloud cmk_id: type: string minLength: 36 maxLength: 36 description: Customer Managed Key identifier (CMK ID) copy_tags: type: boolean description: If this is a forked service, copy tags from the source service. If request contains additional tags, the tags copied from source are updated with them. default: false disk_space_mb: type: integer minimum: 0 description: Megabytes of disk space for data storage group_name: type: string maxLength: 256 description: 'Service group name (DEPRECATED: do not use)' maintenance: type: object description: Automatic maintenance settings properties: dow: type: string description: Day of week for installing updates enum: - monday - tuesday - wednesday - thursday - friday - saturday - sunday time: type: string minLength: 8 maxLength: 8 description: Time for installing updates, UTC plan: type: string maxLength: 128 description: Subscription plan project_vpc_id: type: string minLength: 36 maxLength: 36 description: Project VPC ID service_integrations: type: array maxItems: 64 description: Service integrations to enable for the service. Some integration types affect how a service is created and they must be provided as part of the creation call instead of being defined later. items: type: object properties: dest_endpoint_id: type: string maxLength: 36 description: Integration destination endpoint ID dest_project: type: string maxLength: 63 description: Defaults to project in the request path title: Destination project name dest_service: type: string maxLength: 64 description: Destination service name integration_type: type: string description: Service integration type enum: - alertmanager - application_service_credential - autoscaler - autoscaler_service - caching - clickhouse_credentials - clickhouse_kafka - clickhouse_postgresql - dashboard - datadog - datahub_metadata_ingestion - datasource - disaster_recovery - external_aws_cloudwatch_logs - external_aws_cloudwatch_metrics - external_elasticsearch_logs - external_google_cloud_logging - external_opensearch_logs - flink - flink_external_bigquery - flink_external_kafka - flink_external_postgresql - internal_connectivity - jolokia - kafka_connect - kafka_connect_postgresql - kafka_inkless_postgresql - kafka_logs - kafka_mirrormaker - logs - metrics - opensearch_cross_cluster_replication - opensearch_cross_cluster_search - prometheus - read_replica - rsyslog - schema_registry_proxy - service_composition - stresstester - thanos_distributed_query - thanos_migrate - thanos_object_storage - thanoscompactor - thanosquery - thanosruler - thanosstore - vector - vmalert source_endpoint_id: type: string maxLength: 36 description: Integration source endpoint ID source_project: type: string maxLength: 63 description: Defaults to project in the request path title: Source project name source_service: type: string maxLength: 64 description: Source service name user_config: type: object description: Service type-specific settings properties: {} required: - integration_type service_name: type: string minLength: 1 maxLength: 64 description: Service name service_type: type: string maxLength: 64 description: Service type code static_ips: type: array maxItems: 128 description: Static IP addresses to associate with the service items: type: string tags: type: object description: Set of resource tags properties: {} tech_emails: type: array maxItems: 10 description: List of service technical email addresses items: type: object properties: email: type: string maxLength: 254 description: User email address required: - email termination_protection: type: boolean description: Service is protected against termination and powering off user_config: type: object description: Service type-specific settings properties: {} required: - plan - service_name - service_type ServicePrivatelinkAWSConnectionListResponse: type: object description: ServicePrivatelinkAWSConnectionListResponse properties: connections: type: array description: AWS Privatelink VPC Endpoint connection list items: type: object properties: dns_name: type: string description: The VPC Endpoint DNS name that the Aiven privatelink access route DNS name is using as the value for itsCNAME record. This DNS name resolves to the private IP addresses of the VPC Endpoint's NICs in all configured subnets title: AWS VPC Endpoint DNS name privatelink_connection_id: type: string description: Privatelink connection ID state: type: string description: The Aiven connection state. The AWS VPC endpoint state is always available for listed connections title: Privatelink connection state enum: - pending-user-approval - user-approved - connected - active vpc_endpoint_id: type: string description: AWS VPC Endpoint ID required: - dns_name - state - vpc_endpoint_id errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request required: - connections ServiceCancelQueryRequestBody: type: object description: ServiceCancelQueryRequestBody properties: pid: type: integer minimum: 0 description: Database server connection ID terminate: type: boolean description: Request immediate termination instead of soft cancel default: false ServiceDeleteResponse: type: object description: ServiceDeleteResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request ServiceQueryStatisticsResetResponse: type: object description: ServiceQueryStatisticsResetResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request queries: type: array description: List of query statistics items: type: object properties: {} required: - queries ServicePrivatelinkAzureDeleteResponse: type: object description: ServicePrivatelinkAzureDeleteResponse properties: azure_service_alias: type: string description: Azure Privatelink service alias azure_service_id: type: string description: Azure Privatelink service ID errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request state: type: string description: Privatelink resource state enum: - creating - active - deleting user_subscription_ids: type: array maxItems: 16 description: IDs of Azure subscriptions allowed to connect to the service title: Subscription ID allowlist items: type: string required: - state - user_subscription_ids ServicePrivatelinkAWSDeleteResponse: type: object description: ServicePrivatelinkAWSDeleteResponse properties: aws_service_id: type: string description: AWS VPC endpoint service ID aws_service_name: type: string description: AWS VPC endpoint service name errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request principals: type: array minItems: 1 maxItems: 16 description: ARNs of principals allowed connecting to the service title: ARN allowlist items: type: string state: type: string description: Privatelink resource state enum: - creating - active - deleting required: - principals - state ServicePrivatelinkAWSCreateRequestBody: type: object description: ServicePrivatelinkAWSCreateRequestBody properties: principals: type: array minItems: 1 maxItems: 16 description: ARNs of principals allowed connecting to the service title: ARN allowlist items: type: string required: - principals ServiceUserGetResponse: type: object description: ServiceUserGetResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request user: type: object description: Service user account properties: access_cert: type: string description: Access certificate for TLS client authentication access_cert_not_valid_after_time: type: string description: Validity end time (ISO8601) for the current access certificate access_control: type: object description: Service type specific access control rules for user. Currently only used for configuring user ACLs for Redis version 6 and above. title: Service specific access controls for user properties: dragonfly_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string dragonfly_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string dragonfly_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string pg_allow_replication: type: boolean description: Enable REPLICATION role option redis_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string redis_acl_channels: type: array maxItems: 256 description: Glob-style patterns defining which pub/sub channels can be accessed. If array is not defined, the default policy is used (allchannels). title: Permitted pub/sub channel patterns items: type: string redis_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string redis_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string valkey_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string valkey_acl_channels: type: array maxItems: 256 description: Glob-style patterns defining which pub/sub channels can be accessed. If array is not defined, the default policy is used (allchannels). title: Permitted pub/sub channel patterns items: type: string valkey_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string valkey_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string access_key: type: string description: Access key for TLS client authentication authentication: type: string description: Service specific authentication details. Currently only used for MySQL where accepted options are 'mysql_native_password' and 'caching_sha2_password', latter being default when this is not explicitly set. title: Authentication details enum: - 'null' - caching_sha2_password - mysql_native_password expiring_cert_not_valid_after_time: type: string description: When the existing certificate is nearing expiration and a new certificate has been generated, the validity end time (ISO8601) for the expiring certificate title: Validity end time (ISO8601) for the expiring access certificate password: type: string description: Account password. A null value indicates a user overridden password. password_updated_time: type: string description: Timestamp (ISO8601) of the last time this password was set. type: type: string description: Account type username: type: string description: Account username required: - password - type - username required: - user ServicePrivatelinkAWSCreateResponse: type: object description: ServicePrivatelinkAWSCreateResponse properties: aws_service_id: type: string description: AWS VPC endpoint service ID aws_service_name: type: string description: AWS VPC endpoint service name errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request principals: type: array minItems: 1 maxItems: 16 description: ARNs of principals allowed connecting to the service title: ARN allowlist items: type: string state: type: string description: Privatelink resource state enum: - creating - active - deleting required: - principals - state ProjectServiceTagsReplaceResponse: type: object description: ProjectServiceTagsReplaceResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request ServicePrivatelinkAzureCreateResponse: type: object description: ServicePrivatelinkAzureCreateResponse properties: azure_service_alias: type: string description: Azure Privatelink service alias azure_service_id: type: string description: Azure Privatelink service ID errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request state: type: string description: Privatelink resource state enum: - creating - active - deleting user_subscription_ids: type: array maxItems: 16 description: IDs of Azure subscriptions allowed to connect to the service title: Subscription ID allowlist items: type: string required: - state - user_subscription_ids ServiceQueryActivityRequestBody: type: object description: ServiceQueryActivityRequestBody properties: limit: type: integer minimum: 1 maximum: 5000 description: Limit for number of results default: 100 offset: type: integer minimum: 0 description: Offset for retrieved results based on sort order default: 0 order_by: type: string maxLength: 256 description: 'Sort order can be either asc or desc and multiple comma separated columns with their own order can be specified: :asc,:desc.' title: Order in which to sort retrieved results default: client_id:desc ServiceServiceTypeUpdateRequestBody: type: object description: ServiceServiceTypeUpdateRequestBody properties: service_type: type: string maxLength: 64 description: Service type code required: - service_type ServicePrivatelinkAzureGetResponse: type: object description: ServicePrivatelinkAzureGetResponse properties: azure_service_alias: type: string description: Azure Privatelink service alias azure_service_id: type: string description: Azure Privatelink service ID errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request state: type: string description: Privatelink resource state enum: - creating - active - deleting user_subscription_ids: type: array maxItems: 16 description: IDs of Azure subscriptions allowed to connect to the service title: Subscription ID allowlist items: type: string required: - state - user_subscription_ids ServiceTaskCreateRequestBody: type: object description: ServiceTaskCreateRequestBody properties: create_searchable_snapshot: type: object description: Move indices to a searchable snaphshot properties: indices: type: string maxLength: 1000 description: The indices to move to a searchable snapshot. Use , to create a list of indexes, * to specify an index pattern, and - to exclude certain indexes. required: - indices create_user_backup: type: object description: Payload to be used with create_user_backup properties: backup_name: type: string maxLength: 256 description: The output file name. required: - backup_name dataset_import: type: object description: Payload to be used with dataset_import properties: dataset_name: type: string description: Name of the dataset to import to PostgreSQL database. Used with dataset_import. enum: - pagila required: - dataset_name migration_check: type: object description: Payload to be used with migration_check properties: ignore_dbs: type: string maxLength: 2048 description: Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment) ignore_roles: type: string maxLength: 2048 description: Comma-separated list of database roles, which should be ignored during migration (supported by PostgreSQL only at the moment) method: type: string description: The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types) enum: - dump - replication source_project_name: type: string maxLength: 63 description: Project name source_service_name: type: string minLength: 1 maxLength: 64 description: Service name source_service_uri: type: string maxLength: 512 description: Service URI of the source MySQL or PostgreSQL database with admin credentials. Used with migration_check. target_version: type: string maxLength: 32 description: Deprecated! Use 'upgrade_check' field title: Target version used with upgrade_check task_type: type: string description: Service task type enum: - upgrade_check - migration_check - dataset_import - create_user_backup - create_searchable_snapshot upgrade_check: type: object description: Payload to be used with upgrade_check properties: async: type: boolean description: Run task asynchronously and return immediately default: true target_version: type: string maxLength: 32 description: Target version used with upgrade_check required: - target_version required: - task_type ServiceUserCreateResponse: type: object description: ServiceUserCreateResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request user: type: object description: Service user account properties: access_cert: type: string description: Access certificate for TLS client authentication access_cert_not_valid_after_time: type: string description: Validity end time (ISO8601) for the current access certificate access_control: type: object description: Service type specific access control rules for user. Currently only used for configuring user ACLs for Redis version 6 and above. title: Service specific access controls for user properties: dragonfly_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string dragonfly_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string dragonfly_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string pg_allow_replication: type: boolean description: Enable REPLICATION role option redis_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string redis_acl_channels: type: array maxItems: 256 description: Glob-style patterns defining which pub/sub channels can be accessed. If array is not defined, the default policy is used (allchannels). title: Permitted pub/sub channel patterns items: type: string redis_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string redis_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string valkey_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string valkey_acl_channels: type: array maxItems: 256 description: Glob-style patterns defining which pub/sub channels can be accessed. If array is not defined, the default policy is used (allchannels). title: Permitted pub/sub channel patterns items: type: string valkey_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string valkey_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string access_key: type: string description: Access key for TLS client authentication authentication: type: string description: Service specific authentication details. Currently only used for MySQL where accepted options are 'mysql_native_password' and 'caching_sha2_password', latter being default when this is not explicitly set. title: Authentication details enum: - 'null' - caching_sha2_password - mysql_native_password expiring_cert_not_valid_after_time: type: string description: When the existing certificate is nearing expiration and a new certificate has been generated, the validity end time (ISO8601) for the expiring certificate title: Validity end time (ISO8601) for the expiring access certificate password: type: string description: Account password. A null value indicates a user overridden password. password_updated_time: type: string description: Timestamp (ISO8601) of the last time this password was set. type: type: string description: Account type username: type: string description: Account username required: - password - type - username required: - user ServicePrivatelinkAWSGetResponse: type: object description: ServicePrivatelinkAWSGetResponse properties: aws_service_id: type: string description: AWS VPC endpoint service ID aws_service_name: type: string description: AWS VPC endpoint service name errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request principals: type: array minItems: 1 maxItems: 16 description: ARNs of principals allowed connecting to the service title: ARN allowlist items: type: string state: type: string description: Privatelink resource state enum: - creating - active - deleting required: - principals - state ServiceUpdateResponse: type: object description: ServiceUpdateResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request service: type: object description: Service information properties: acl: type: array description: List of Aiven ACL entries for Kafka service items: type: object properties: id: type: string maxLength: 40 description: ID permission: type: string description: Kafka permission enum: - admin - read - readwrite - write topic: type: string minLength: 1 maxLength: 249 description: Topic name pattern username: type: string minLength: 1 maxLength: 64 description: Username required: - permission - topic - username backups: type: array description: List of backups for the service items: type: object properties: additional_regions: type: array description: Additional backup regions, if available items: type: object properties: cloud: type: string maxLength: 256 description: Target cloud pause_reason: type: string description: Reason for pausing the backup synchronization paused: type: boolean description: Indicates additional backup synchronization is paused region: type: string description: Cloud storage region name required: - cloud backup_name: type: string description: Internal name of this backup backup_time: type: string maxLength: 36 description: Backup timestamp (ISO 8601) data_size: type: integer description: Backup's original size before compression incremental: type: boolean description: Indicates if this backup is a full or an incremental one (available only for MySQL) storage_location: type: string description: Location where this backup is stored tiered_storage_data_size: type: integer description: The amount of tiered storage data in bytes referenced by this backup. required: - backup_name - backup_time - data_size cloud_description: type: string description: Cloud provider and location cloud_name: type: string maxLength: 256 description: Target cloud cmk_id: type: string description: Active Customer Managed Key identifier (CMK ID) components: type: array description: Service component information objects items: type: object properties: component: type: string description: Service component name host: type: string description: DNS name for connecting to the service component kafka_authentication_method: type: string description: Kafka authentication method. This is a value specific to the 'kafka' service component enum: - certificate - sasl kafka_ssl_ca: type: string description: Specifies if this port uses Project CA or Letsencrypt. If not specified, the default is using Project CA.This is a value specific to the 'kafka' service component. enum: - project_ca - letsencrypt path: type: string description: Path component of the service URL (useful only if service component is HTTP or HTTPS endpoint) port: type: integer minimum: 0 maximum: 65535 description: Port number for connecting to the service component privatelink_connection_id: type: string description: Privatelink connection ID route: type: string description: Network access route enum: - dynamic - public - private - privatelink ssl: type: boolean description: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted andthis property is only included for service components that may disable encryption. usage: type: string description: DNS usage name enum: - disaster_recovery - primary - replica - ha_replica required: - component - host - port - route - usage connection_info: type: object description: Service-specific connection information properties properties: {} connection_pools: type: array description: PostgreSQL PGBouncer connection pools items: type: object properties: connection_uri: type: string description: Connection URI for the DB pool database: type: string maxLength: 63 description: Database name pool_mode: type: string description: PGBouncer pool mode enum: - session - transaction - statement pool_name: type: string maxLength: 63 description: Connection pool name pool_size: type: integer minimum: 1 maximum: 10000 description: Size of PGBouncer's PostgreSQL side connection pool username: type: string maxLength: 64 description: Pool username required: - connection_uri - database - pool_mode - pool_name - pool_size create_time: type: string maxLength: 36 description: Service creation timestamp (ISO 8601) databases: type: array description: List of service's user database names items: type: string disk_space_mb: type: integer minimum: 0 description: Megabytes of disk space for data storage features: type: object description: Feature flags properties: {} group_list: type: array description: List of service groups the service belongs to. This field is deprecated. It is always set to single element with value 'default' items: type: string is_cluster_plan: type: boolean description: True when the service uses a cluster plan with dedicated node groups kafka_acl: type: array description: List of Kafka-native ACL entries items: type: object properties: host: type: string minLength: 0 maxLength: 256 description: the host or * for all hosts id: type: string maxLength: 40 description: ID operation: type: string description: Kafka ACL operation represents an operation which an ACL grants or denies permission to perform enum: - All - Alter - AlterConfigs - ClusterAction - Create - CreateTokens - Delete - Describe - DescribeConfigs - DescribeTokens - IdempotentWrite - Read - Write pattern_type: type: string description: Kafka ACL pattern type of resource name enum: - LITERAL - PREFIXED permission_type: type: string description: Kafka ACL permission type enum: - ALLOW - DENY principal: type: string minLength: 0 maxLength: 256 description: principal is in 'principalType:name' format resource_name: type: string minLength: 0 maxLength: 256 description: Resource pattern used to match specified resources resource_type: type: string description: Kafka ACL resource type represents a type of resource which an ACL can be applied to enum: - Cluster - DelegationToken - Group - Topic - TransactionalId - User required: - host - id - operation - pattern_type - permission_type - principal - resource_name - resource_type maintenance: type: object description: Automatic maintenance settings properties: controlled_switchover: type: object description: Controlled switchover status properties: completed_at: type: string description: Time when the switchover completed, if it has completed enabled: type: boolean description: Controlled switchover configured and enabled scheduled_start_time: type: string description: Scheduled start time of the switchover window, if enabled and active state: type: string description: Controlled switchover state enum: - INACTIVE - PENDING - SCHEDULED - RUNNING - COMPLETED - COMPLETED_EARLY termination_reason: type: string description: Reason for switchover termination required: - enabled - scheduled_start_time - state dow: type: string description: Day of week for installing updates enum: - monday - tuesday - wednesday - thursday - friday - saturday - sunday - never enabled: type: boolean description: Service maintenance enabled time: type: string minLength: 8 maxLength: 8 description: Time for installing updates, UTC updates: type: array description: List of updates waiting to be installed items: type: object properties: deadline: type: string description: Deadline for installing the update description: type: string description: Description of the update documentation_link: type: string description: Optional link impact: type: string description: Impact statement of the update impact_portable_text: type: string description: Impact statement in portable text format start_after: type: string description: The earliest time the update will be automatically applied start_at: type: string description: The time when the update will be automatically applied required: - dow - enabled - time - updates metadata: type: object description: Service type specific metadata properties: {} node_count: type: integer description: Number of service nodes in the active plan node_cpu_count: type: integer description: Number of CPUs for each node node_memory_mb: type: number description: Megabytes of memory for each node node_states: type: array description: State of individual service nodes items: type: object properties: availability_zone: type: string description: The availability zone in which the node is place. If there is no availability zone available this field will be missing. name: type: string description: Name of the service node progress_updates: type: array description: Extra information regarding the progress for current state items: type: object properties: completed: type: boolean description: Indicates whether this phase has been completed or not current: type: integer description: Current progress for this phase. May be missing or null. max: type: integer description: Maximum progress value for this phase. May be missing or null. May change. min: type: integer description: Minimum progress value for this phase. May be missing or null. phase: type: string description: Key identifying this phase enum: - prepare - basebackup - basebackup_prepare - stream - finalize unit: type: string description: Unit for current/min/max values. New units may be added. If null should be treated as generic unit enum: - binlogs - bytes_compressed - bytes_uncompressed - prepare_percent - wal_lsn required: - completed - phase role: type: string description: Role of this node. Only returned for a subset of service types enum: - master - standby - read-replica roles: type: string description: 'A role string indicating the node''s roles in the OpenSearch cluster. Only populated for OpenSearch services using cluster plans. Format: first character is ''*'' (elected cluster manager) or ''-'' (not elected), followed by role letters: ''d'' (data), ''i'' (ingest), ''m'' (cluster_manager eligible), ''c'' (coordinating), ''L'' (ML), ''D'' (Dashboards). Example: ''*mc'' means elected cluster manager with cluster_manager and coordinating roles.' title: Roles of this node. Only returned for OpenSearch services with cluster plans shard: type: object description: Shard of this node. Only returned for a subset of service types properties: name: type: string description: Name of the shard. position: type: integer description: Position of this shard within the service state: type: string description: Current state of the service node enum: - leaving - running - setting_up_vm - syncing_data - timing_out - unknown required: - availability_zone - name - state plan: type: string maxLength: 128 description: Subscription plan project_vpc_id: type: string minLength: 36 maxLength: 36 description: Project VPC ID schema_registry_acl: type: array description: List of Schema Registry ACL entries items: type: object properties: id: type: string maxLength: 40 description: ID permission: type: string description: ACL entry for Schema Registry enum: - schema_registry_read - schema_registry_write resource: type: string minLength: 1 maxLength: 249 description: Schema Registry ACL entry resource name pattern username: type: string minLength: 1 maxLength: 64 description: Username required: - permission - resource - username server_group: type: object description: Service IaaS server group properties: enabled: type: boolean description: Flag set if server group is in use for the service type: type: string description: IaaS server group type service_integrations: type: array description: Integrations with other services items: type: object properties: active: type: boolean description: True when integration is active description: type: string description: Description of the integration dest_endpoint: type: string description: Destination endpoint name dest_endpoint_id: type: string description: Destination endpoint id dest_project: type: string maxLength: 63 description: Project name dest_service: type: string description: Destination service name dest_service_type: type: string maxLength: 64 description: Service type code enabled: type: boolean description: True when integration is enabled integration_status: type: object description: Integration status properties: state: type: object description: Service integration state properties: errors: type: array description: Errors items: type: string likely_error_cause: type: string description: Most likely cause of the errors enum: - 'null' - destination - integration - source - unknown nodes: type: object description: Nodes properties: {} status: type: string description: Service integration status enum: - failed - inactive - running - starting - unknown required: - errors - nodes - status status_user_desc: type: string description: Integration status description required: - state - status_user_desc integration_type: type: string description: Type of the integration service_integration_id: type: string description: Integration ID source_endpoint: type: string description: Source endpoint name source_endpoint_id: type: string description: Source endpoint ID source_project: type: string maxLength: 63 description: Project name source_service: type: string description: Source service name source_service_type: type: string maxLength: 64 description: Service type code user_config: type: object description: Service integration settings properties: {} required: - active - description - dest_project - dest_service_type - enabled - integration_type - service_integration_id - source_project - source_service - source_service_type service_name: type: string minLength: 1 maxLength: 64 description: Service name service_notifications: type: array description: Service notifications items: type: object properties: level: type: string description: Notification level enum: - notice - warning message: type: string maxLength: 1024 description: Human notification message metadata: type: object description: Notification metadata properties: end_of_life_help_article_url: type: string description: Link to the help article end_of_life_policy_url: type: string description: Link to the help article service_end_of_life_time: type: string maxLength: 36 description: Timestamp in ISO 8601 format, always in UTC upgrade_to_service_type: type: string maxLength: 64 description: If the customer takes no action, the service is updated to this service type when end of life is reached on the Aiven platform. If it is the same as the service type, the platform only upgrades the version. upgrade_to_version: type: string maxLength: 32 description: The version to which the service will be updated at the end of life on the Aiven platform if the user does not take any action type: type: string description: Notification type enum: - service_end_of_life - service_powered_off_removal required: - level - message - metadata - type service_type: type: string maxLength: 64 description: Service type code service_type_description: type: string description: Single line description of the service service_uri: type: string description: URI for connecting to the service (may be null) service_uri_params: type: object description: service_uri parameterized into key-value pairs properties: {} state: type: string description: State of the service enum: - POWEROFF - REBALANCING - REBUILDING - RUNNING tags: type: object description: Set of resource tags properties: {} tech_emails: type: array maxItems: 10 description: List of service technical email addresses items: type: object properties: email: type: string maxLength: 254 description: User email address required: - email termination_protection: type: boolean description: Service is protected against termination and powering off topics: type: array description: 'Kafka topics. DEPRECATED: Use /project/$project/service/$service/topic instead' items: type: object properties: cleanup_policy: type: string maxLength: 64 description: The retention policy to use on old segments. Possible values include 'delete', 'compact', or a comma-separated list of them. The default policy ('delete') will discard old segments when their retention time or size limit has been reached. The 'compact' setting will enable log compaction on the topic. title: cleanup.policy min_insync_replicas: type: integer minimum: 1 description: When a producer sets acks to 'all' (or '-1'), this configuration specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. If this minimum cannot be met, then the producer will raise an exception (either NotEnoughReplicas or NotEnoughReplicasAfterAppend). When used together, min.insync.replicas and acks allow you to enforce greater durability guarantees. A typical scenario would be to create a topic with a replication factor of 3, set min.insync.replicas to 2, and produce with acks of 'all'. This will ensure that the producer raises an exception if a majority of replicas do not receive a write. title: min.insync.replicas partitions: type: integer minimum: 1 maximum: 1000000 description: Number of partitions replication: type: integer minimum: 1 description: Number of replicas retention_bytes: type: integer description: This configuration controls the maximum size a partition (which consists of log segments) can grow to before we will discard old log segments to free up space if we are using the 'delete' retention policy. By default there is no size limit only a time limit. Since this limit is enforced at the partition level, multiply it by the number of partitions to compute the topic retention in bytes. title: retention.bytes retention_hours: type: integer maximum: 2562047788015 description: Retention period (hours) state: type: string description: Topic state enum: - ACTIVE - CONFIGURING - DELETING topic_name: type: string minLength: 1 maxLength: 249 description: Topic name required: - cleanup_policy - min_insync_replicas - partitions - replication - retention_bytes - retention_hours - topic_name update_time: type: string maxLength: 36 description: Service last update timestamp (ISO 8601) user_config: type: object description: Service type-specific settings properties: {} users: type: array description: List of service users items: type: object properties: access_cert: type: string description: Access certificate for TLS client authentication access_cert_not_valid_after_time: type: string description: Validity end time (ISO8601) for the current access certificate access_control: type: object description: Service type specific access control rules for user. Currently only used for configuring user ACLs for Redis version 6 and above. title: Service specific access controls for user properties: dragonfly_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string dragonfly_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string dragonfly_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string pg_allow_replication: type: boolean description: Enable REPLICATION role option redis_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string redis_acl_channels: type: array maxItems: 256 description: Glob-style patterns defining which pub/sub channels can be accessed. If array is not defined, the default policy is used (allchannels). title: Permitted pub/sub channel patterns items: type: string redis_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string redis_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string valkey_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string valkey_acl_channels: type: array maxItems: 256 description: Glob-style patterns defining which pub/sub channels can be accessed. If array is not defined, the default policy is used (allchannels). title: Permitted pub/sub channel patterns items: type: string valkey_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string valkey_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string access_key: type: string description: Access key for TLS client authentication authentication: type: string description: Service specific authentication details. Currently only used for MySQL where accepted options are 'mysql_native_password' and 'caching_sha2_password', latter being default when this is not explicitly set. title: Authentication details enum: - 'null' - caching_sha2_password - mysql_native_password expiring_cert_not_valid_after_time: type: string description: When the existing certificate is nearing expiration and a new certificate has been generated, the validity end time (ISO8601) for the expiring certificate title: Validity end time (ISO8601) for the expiring access certificate password: type: string description: Account password. A null value indicates a user overridden password. password_updated_time: type: string description: Timestamp (ISO8601) of the last time this password was set. type: type: string description: Account type username: type: string description: Account username required: - password - type - username required: - cloud_name - create_time - group_list - plan - project_vpc_id - service_integrations - service_name - service_type - service_uri - state - termination_protection - update_time - user_config required: - service ServiceMetricsFetchRequestBody: type: object description: ServiceMetricsFetchRequestBody properties: kafka_topic_name: type: string maxLength: 249 description: Metrics at Kafka service topic level period: type: string description: Metrics time period default: hour enum: - hour - day - week - month - year ServicePrivatelinkAzureConnectionUpdateResponse: type: object description: ServicePrivatelinkAzureConnectionUpdateResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request private_endpoint_id: type: string description: Azure private endpoint ID privatelink_connection_id: type: string description: Privatelink connection ID state: type: string description: The Aiven connection state. The Azure connection status has a separate value title: Privatelink connection state enum: - pending-user-approval - user-approved - connected - active user_ip_address: type: string maxLength: 15 description: (Private) IP address of Privatelink endpoint required: - private_endpoint_id - state - user_ip_address ServiceUserDeleteResponse: type: object description: ServiceUserDeleteResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request ServiceMetricsFetchResponse: type: object description: ServiceMetricsFetchResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request metrics: type: object description: Service metrics in Google chart compatible format properties: {} required: - metrics ServiceUpdateRequestBody: type: object description: ServiceUpdateRequestBody properties: cloud: type: string maxLength: 256 description: Target cloud cmk_id: type: string minLength: 36 maxLength: 36 description: Customer Managed Key identifier (CMK ID) disk_space_mb: type: integer minimum: 0 description: Megabytes of disk space for data storage group_name: type: string maxLength: 256 description: 'Service group name (DEPRECATED: do not use)' karapace: type: boolean description: Switch the service to use Karapace for schema registry and REST proxy maintenance: type: object description: Automatic maintenance settings properties: dow: type: string description: Day of week for installing updates enum: - monday - tuesday - wednesday - thursday - friday - saturday - sunday time: type: string minLength: 8 maxLength: 8 description: Time for installing updates, UTC plan: type: string maxLength: 128 description: Subscription plan powered: type: boolean description: Power-on the service (true) or power-off (false) project_vpc_id: type: string minLength: 36 maxLength: 36 description: Project VPC ID schema_registry_authz: type: boolean description: Enable or disable Schema Registry authorization tech_emails: type: array maxItems: 10 description: List of service technical email addresses items: type: object properties: email: type: string maxLength: 254 description: User email address required: - email termination_protection: type: boolean description: Service is protected against termination and powering off user_config: type: object description: Service type-specific settings properties: {} ServiceDatabaseListResponse: type: object description: ServiceDatabaseListResponse properties: databases: type: array description: List of databases items: type: object properties: database_name: type: string description: Database name or ID required: - database_name errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request required: - databases ServiceMaintenanceStartResponse: type: object description: ServiceMaintenanceStartResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request ServiceUserCredentialsModifyResponse: type: object description: ServiceUserCredentialsModifyResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request service: type: object description: Service information properties: acl: type: array description: List of Aiven ACL entries for Kafka service items: type: object properties: id: type: string maxLength: 40 description: ID permission: type: string description: Kafka permission enum: - admin - read - readwrite - write topic: type: string minLength: 1 maxLength: 249 description: Topic name pattern username: type: string minLength: 1 maxLength: 64 description: Username required: - permission - topic - username backups: type: array description: List of backups for the service items: type: object properties: additional_regions: type: array description: Additional backup regions, if available items: type: object properties: cloud: type: string maxLength: 256 description: Target cloud pause_reason: type: string description: Reason for pausing the backup synchronization paused: type: boolean description: Indicates additional backup synchronization is paused region: type: string description: Cloud storage region name required: - cloud backup_name: type: string description: Internal name of this backup backup_time: type: string maxLength: 36 description: Backup timestamp (ISO 8601) data_size: type: integer description: Backup's original size before compression incremental: type: boolean description: Indicates if this backup is a full or an incremental one (available only for MySQL) storage_location: type: string description: Location where this backup is stored tiered_storage_data_size: type: integer description: The amount of tiered storage data in bytes referenced by this backup. required: - backup_name - backup_time - data_size cloud_description: type: string description: Cloud provider and location cloud_name: type: string maxLength: 256 description: Target cloud cmk_id: type: string description: Active Customer Managed Key identifier (CMK ID) components: type: array description: Service component information objects items: type: object properties: component: type: string description: Service component name host: type: string description: DNS name for connecting to the service component kafka_authentication_method: type: string description: Kafka authentication method. This is a value specific to the 'kafka' service component enum: - certificate - sasl kafka_ssl_ca: type: string description: Specifies if this port uses Project CA or Letsencrypt. If not specified, the default is using Project CA.This is a value specific to the 'kafka' service component. enum: - project_ca - letsencrypt path: type: string description: Path component of the service URL (useful only if service component is HTTP or HTTPS endpoint) port: type: integer minimum: 0 maximum: 65535 description: Port number for connecting to the service component privatelink_connection_id: type: string description: Privatelink connection ID route: type: string description: Network access route enum: - dynamic - public - private - privatelink ssl: type: boolean description: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted andthis property is only included for service components that may disable encryption. usage: type: string description: DNS usage name enum: - disaster_recovery - primary - replica - ha_replica required: - component - host - port - route - usage connection_info: type: object description: Service-specific connection information properties properties: {} connection_pools: type: array description: PostgreSQL PGBouncer connection pools items: type: object properties: connection_uri: type: string description: Connection URI for the DB pool database: type: string maxLength: 63 description: Database name pool_mode: type: string description: PGBouncer pool mode enum: - session - transaction - statement pool_name: type: string maxLength: 63 description: Connection pool name pool_size: type: integer minimum: 1 maximum: 10000 description: Size of PGBouncer's PostgreSQL side connection pool username: type: string maxLength: 64 description: Pool username required: - connection_uri - database - pool_mode - pool_name - pool_size create_time: type: string maxLength: 36 description: Service creation timestamp (ISO 8601) databases: type: array description: List of service's user database names items: type: string disk_space_mb: type: integer minimum: 0 description: Megabytes of disk space for data storage features: type: object description: Feature flags properties: {} group_list: type: array description: List of service groups the service belongs to. This field is deprecated. It is always set to single element with value 'default' items: type: string is_cluster_plan: type: boolean description: True when the service uses a cluster plan with dedicated node groups kafka_acl: type: array description: List of Kafka-native ACL entries items: type: object properties: host: type: string minLength: 0 maxLength: 256 description: the host or * for all hosts id: type: string maxLength: 40 description: ID operation: type: string description: Kafka ACL operation represents an operation which an ACL grants or denies permission to perform enum: - All - Alter - AlterConfigs - ClusterAction - Create - CreateTokens - Delete - Describe - DescribeConfigs - DescribeTokens - IdempotentWrite - Read - Write pattern_type: type: string description: Kafka ACL pattern type of resource name enum: - LITERAL - PREFIXED permission_type: type: string description: Kafka ACL permission type enum: - ALLOW - DENY principal: type: string minLength: 0 maxLength: 256 description: principal is in 'principalType:name' format resource_name: type: string minLength: 0 maxLength: 256 description: Resource pattern used to match specified resources resource_type: type: string description: Kafka ACL resource type represents a type of resource which an ACL can be applied to enum: - Cluster - DelegationToken - Group - Topic - TransactionalId - User required: - host - id - operation - pattern_type - permission_type - principal - resource_name - resource_type maintenance: type: object description: Automatic maintenance settings properties: controlled_switchover: type: object description: Controlled switchover status properties: completed_at: type: string description: Time when the switchover completed, if it has completed enabled: type: boolean description: Controlled switchover configured and enabled scheduled_start_time: type: string description: Scheduled start time of the switchover window, if enabled and active state: type: string description: Controlled switchover state enum: - INACTIVE - PENDING - SCHEDULED - RUNNING - COMPLETED - COMPLETED_EARLY termination_reason: type: string description: Reason for switchover termination required: - enabled - scheduled_start_time - state dow: type: string description: Day of week for installing updates enum: - monday - tuesday - wednesday - thursday - friday - saturday - sunday - never enabled: type: boolean description: Service maintenance enabled time: type: string minLength: 8 maxLength: 8 description: Time for installing updates, UTC updates: type: array description: List of updates waiting to be installed items: type: object properties: deadline: type: string description: Deadline for installing the update description: type: string description: Description of the update documentation_link: type: string description: Optional link impact: type: string description: Impact statement of the update impact_portable_text: type: string description: Impact statement in portable text format start_after: type: string description: The earliest time the update will be automatically applied start_at: type: string description: The time when the update will be automatically applied required: - dow - enabled - time - updates metadata: type: object description: Service type specific metadata properties: {} node_count: type: integer description: Number of service nodes in the active plan node_cpu_count: type: integer description: Number of CPUs for each node node_memory_mb: type: number description: Megabytes of memory for each node node_states: type: array description: State of individual service nodes items: type: object properties: availability_zone: type: string description: The availability zone in which the node is place. If there is no availability zone available this field will be missing. name: type: string description: Name of the service node progress_updates: type: array description: Extra information regarding the progress for current state items: type: object properties: completed: type: boolean description: Indicates whether this phase has been completed or not current: type: integer description: Current progress for this phase. May be missing or null. max: type: integer description: Maximum progress value for this phase. May be missing or null. May change. min: type: integer description: Minimum progress value for this phase. May be missing or null. phase: type: string description: Key identifying this phase enum: - prepare - basebackup - basebackup_prepare - stream - finalize unit: type: string description: Unit for current/min/max values. New units may be added. If null should be treated as generic unit enum: - binlogs - bytes_compressed - bytes_uncompressed - prepare_percent - wal_lsn required: - completed - phase role: type: string description: Role of this node. Only returned for a subset of service types enum: - master - standby - read-replica roles: type: string description: 'A role string indicating the node''s roles in the OpenSearch cluster. Only populated for OpenSearch services using cluster plans. Format: first character is ''*'' (elected cluster manager) or ''-'' (not elected), followed by role letters: ''d'' (data), ''i'' (ingest), ''m'' (cluster_manager eligible), ''c'' (coordinating), ''L'' (ML), ''D'' (Dashboards). Example: ''*mc'' means elected cluster manager with cluster_manager and coordinating roles.' title: Roles of this node. Only returned for OpenSearch services with cluster plans shard: type: object description: Shard of this node. Only returned for a subset of service types properties: name: type: string description: Name of the shard. position: type: integer description: Position of this shard within the service state: type: string description: Current state of the service node enum: - leaving - running - setting_up_vm - syncing_data - timing_out - unknown required: - availability_zone - name - state plan: type: string maxLength: 128 description: Subscription plan project_vpc_id: type: string minLength: 36 maxLength: 36 description: Project VPC ID schema_registry_acl: type: array description: List of Schema Registry ACL entries items: type: object properties: id: type: string maxLength: 40 description: ID permission: type: string description: ACL entry for Schema Registry enum: - schema_registry_read - schema_registry_write resource: type: string minLength: 1 maxLength: 249 description: Schema Registry ACL entry resource name pattern username: type: string minLength: 1 maxLength: 64 description: Username required: - permission - resource - username server_group: type: object description: Service IaaS server group properties: enabled: type: boolean description: Flag set if server group is in use for the service type: type: string description: IaaS server group type service_integrations: type: array description: Integrations with other services items: type: object properties: active: type: boolean description: True when integration is active description: type: string description: Description of the integration dest_endpoint: type: string description: Destination endpoint name dest_endpoint_id: type: string description: Destination endpoint id dest_project: type: string maxLength: 63 description: Project name dest_service: type: string description: Destination service name dest_service_type: type: string maxLength: 64 description: Service type code enabled: type: boolean description: True when integration is enabled integration_status: type: object description: Integration status properties: state: type: object description: Service integration state properties: errors: type: array description: Errors items: type: string likely_error_cause: type: string description: Most likely cause of the errors enum: - 'null' - destination - integration - source - unknown nodes: type: object description: Nodes properties: {} status: type: string description: Service integration status enum: - failed - inactive - running - starting - unknown required: - errors - nodes - status status_user_desc: type: string description: Integration status description required: - state - status_user_desc integration_type: type: string description: Type of the integration service_integration_id: type: string description: Integration ID source_endpoint: type: string description: Source endpoint name source_endpoint_id: type: string description: Source endpoint ID source_project: type: string maxLength: 63 description: Project name source_service: type: string description: Source service name source_service_type: type: string maxLength: 64 description: Service type code user_config: type: object description: Service integration settings properties: {} required: - active - description - dest_project - dest_service_type - enabled - integration_type - service_integration_id - source_project - source_service - source_service_type service_name: type: string minLength: 1 maxLength: 64 description: Service name service_notifications: type: array description: Service notifications items: type: object properties: level: type: string description: Notification level enum: - notice - warning message: type: string maxLength: 1024 description: Human notification message metadata: type: object description: Notification metadata properties: end_of_life_help_article_url: type: string description: Link to the help article end_of_life_policy_url: type: string description: Link to the help article service_end_of_life_time: type: string maxLength: 36 description: Timestamp in ISO 8601 format, always in UTC upgrade_to_service_type: type: string maxLength: 64 description: If the customer takes no action, the service is updated to this service type when end of life is reached on the Aiven platform. If it is the same as the service type, the platform only upgrades the version. upgrade_to_version: type: string maxLength: 32 description: The version to which the service will be updated at the end of life on the Aiven platform if the user does not take any action type: type: string description: Notification type enum: - service_end_of_life - service_powered_off_removal required: - level - message - metadata - type service_type: type: string maxLength: 64 description: Service type code service_type_description: type: string description: Single line description of the service service_uri: type: string description: URI for connecting to the service (may be null) service_uri_params: type: object description: service_uri parameterized into key-value pairs properties: {} state: type: string description: State of the service enum: - POWEROFF - REBALANCING - REBUILDING - RUNNING tags: type: object description: Set of resource tags properties: {} tech_emails: type: array maxItems: 10 description: List of service technical email addresses items: type: object properties: email: type: string maxLength: 254 description: User email address required: - email termination_protection: type: boolean description: Service is protected against termination and powering off topics: type: array description: 'Kafka topics. DEPRECATED: Use /project/$project/service/$service/topic instead' items: type: object properties: cleanup_policy: type: string maxLength: 64 description: The retention policy to use on old segments. Possible values include 'delete', 'compact', or a comma-separated list of them. The default policy ('delete') will discard old segments when their retention time or size limit has been reached. The 'compact' setting will enable log compaction on the topic. title: cleanup.policy min_insync_replicas: type: integer minimum: 1 description: When a producer sets acks to 'all' (or '-1'), this configuration specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. If this minimum cannot be met, then the producer will raise an exception (either NotEnoughReplicas or NotEnoughReplicasAfterAppend). When used together, min.insync.replicas and acks allow you to enforce greater durability guarantees. A typical scenario would be to create a topic with a replication factor of 3, set min.insync.replicas to 2, and produce with acks of 'all'. This will ensure that the producer raises an exception if a majority of replicas do not receive a write. title: min.insync.replicas partitions: type: integer minimum: 1 maximum: 1000000 description: Number of partitions replication: type: integer minimum: 1 description: Number of replicas retention_bytes: type: integer description: This configuration controls the maximum size a partition (which consists of log segments) can grow to before we will discard old log segments to free up space if we are using the 'delete' retention policy. By default there is no size limit only a time limit. Since this limit is enforced at the partition level, multiply it by the number of partitions to compute the topic retention in bytes. title: retention.bytes retention_hours: type: integer maximum: 2562047788015 description: Retention period (hours) state: type: string description: Topic state enum: - ACTIVE - CONFIGURING - DELETING topic_name: type: string minLength: 1 maxLength: 249 description: Topic name required: - cleanup_policy - min_insync_replicas - partitions - replication - retention_bytes - retention_hours - topic_name update_time: type: string maxLength: 36 description: Service last update timestamp (ISO 8601) user_config: type: object description: Service type-specific settings properties: {} users: type: array description: List of service users items: type: object properties: access_cert: type: string description: Access certificate for TLS client authentication access_cert_not_valid_after_time: type: string description: Validity end time (ISO8601) for the current access certificate access_control: type: object description: Service type specific access control rules for user. Currently only used for configuring user ACLs for Redis version 6 and above. title: Service specific access controls for user properties: dragonfly_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string dragonfly_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string dragonfly_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string pg_allow_replication: type: boolean description: Enable REPLICATION role option redis_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string redis_acl_channels: type: array maxItems: 256 description: Glob-style patterns defining which pub/sub channels can be accessed. If array is not defined, the default policy is used (allchannels). title: Permitted pub/sub channel patterns items: type: string redis_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string redis_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string valkey_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string valkey_acl_channels: type: array maxItems: 256 description: Glob-style patterns defining which pub/sub channels can be accessed. If array is not defined, the default policy is used (allchannels). title: Permitted pub/sub channel patterns items: type: string valkey_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string valkey_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string access_key: type: string description: Access key for TLS client authentication authentication: type: string description: Service specific authentication details. Currently only used for MySQL where accepted options are 'mysql_native_password' and 'caching_sha2_password', latter being default when this is not explicitly set. title: Authentication details enum: - 'null' - caching_sha2_password - mysql_native_password expiring_cert_not_valid_after_time: type: string description: When the existing certificate is nearing expiration and a new certificate has been generated, the validity end time (ISO8601) for the expiring certificate title: Validity end time (ISO8601) for the expiring access certificate password: type: string description: Account password. A null value indicates a user overridden password. password_updated_time: type: string description: Timestamp (ISO8601) of the last time this password was set. type: type: string description: Account type username: type: string description: Account username required: - password - type - username required: - cloud_name - create_time - group_list - plan - project_vpc_id - service_integrations - service_name - service_type - service_uri - state - termination_protection - update_time - user_config required: - service ServicePrivatelinkAzureCreateRequestBody: type: object description: ServicePrivatelinkAzureCreateRequestBody properties: user_subscription_ids: type: array maxItems: 16 description: IDs of Azure subscriptions allowed to connect to the service title: Subscription ID allowlist items: type: string required: - user_subscription_ids ServiceUserCredentialsResetResponse: type: object description: ServiceUserCredentialsResetResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request service: type: object description: Service information properties: acl: type: array description: List of Aiven ACL entries for Kafka service items: type: object properties: id: type: string maxLength: 40 description: ID permission: type: string description: Kafka permission enum: - admin - read - readwrite - write topic: type: string minLength: 1 maxLength: 249 description: Topic name pattern username: type: string minLength: 1 maxLength: 64 description: Username required: - permission - topic - username backups: type: array description: List of backups for the service items: type: object properties: additional_regions: type: array description: Additional backup regions, if available items: type: object properties: cloud: type: string maxLength: 256 description: Target cloud pause_reason: type: string description: Reason for pausing the backup synchronization paused: type: boolean description: Indicates additional backup synchronization is paused region: type: string description: Cloud storage region name required: - cloud backup_name: type: string description: Internal name of this backup backup_time: type: string maxLength: 36 description: Backup timestamp (ISO 8601) data_size: type: integer description: Backup's original size before compression incremental: type: boolean description: Indicates if this backup is a full or an incremental one (available only for MySQL) storage_location: type: string description: Location where this backup is stored tiered_storage_data_size: type: integer description: The amount of tiered storage data in bytes referenced by this backup. required: - backup_name - backup_time - data_size cloud_description: type: string description: Cloud provider and location cloud_name: type: string maxLength: 256 description: Target cloud cmk_id: type: string description: Active Customer Managed Key identifier (CMK ID) components: type: array description: Service component information objects items: type: object properties: component: type: string description: Service component name host: type: string description: DNS name for connecting to the service component kafka_authentication_method: type: string description: Kafka authentication method. This is a value specific to the 'kafka' service component enum: - certificate - sasl kafka_ssl_ca: type: string description: Specifies if this port uses Project CA or Letsencrypt. If not specified, the default is using Project CA.This is a value specific to the 'kafka' service component. enum: - project_ca - letsencrypt path: type: string description: Path component of the service URL (useful only if service component is HTTP or HTTPS endpoint) port: type: integer minimum: 0 maximum: 65535 description: Port number for connecting to the service component privatelink_connection_id: type: string description: Privatelink connection ID route: type: string description: Network access route enum: - dynamic - public - private - privatelink ssl: type: boolean description: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted andthis property is only included for service components that may disable encryption. usage: type: string description: DNS usage name enum: - disaster_recovery - primary - replica - ha_replica required: - component - host - port - route - usage connection_info: type: object description: Service-specific connection information properties properties: {} connection_pools: type: array description: PostgreSQL PGBouncer connection pools items: type: object properties: connection_uri: type: string description: Connection URI for the DB pool database: type: string maxLength: 63 description: Database name pool_mode: type: string description: PGBouncer pool mode enum: - session - transaction - statement pool_name: type: string maxLength: 63 description: Connection pool name pool_size: type: integer minimum: 1 maximum: 10000 description: Size of PGBouncer's PostgreSQL side connection pool username: type: string maxLength: 64 description: Pool username required: - connection_uri - database - pool_mode - pool_name - pool_size create_time: type: string maxLength: 36 description: Service creation timestamp (ISO 8601) databases: type: array description: List of service's user database names items: type: string disk_space_mb: type: integer minimum: 0 description: Megabytes of disk space for data storage features: type: object description: Feature flags properties: {} group_list: type: array description: List of service groups the service belongs to. This field is deprecated. It is always set to single element with value 'default' items: type: string is_cluster_plan: type: boolean description: True when the service uses a cluster plan with dedicated node groups kafka_acl: type: array description: List of Kafka-native ACL entries items: type: object properties: host: type: string minLength: 0 maxLength: 256 description: the host or * for all hosts id: type: string maxLength: 40 description: ID operation: type: string description: Kafka ACL operation represents an operation which an ACL grants or denies permission to perform enum: - All - Alter - AlterConfigs - ClusterAction - Create - CreateTokens - Delete - Describe - DescribeConfigs - DescribeTokens - IdempotentWrite - Read - Write pattern_type: type: string description: Kafka ACL pattern type of resource name enum: - LITERAL - PREFIXED permission_type: type: string description: Kafka ACL permission type enum: - ALLOW - DENY principal: type: string minLength: 0 maxLength: 256 description: principal is in 'principalType:name' format resource_name: type: string minLength: 0 maxLength: 256 description: Resource pattern used to match specified resources resource_type: type: string description: Kafka ACL resource type represents a type of resource which an ACL can be applied to enum: - Cluster - DelegationToken - Group - Topic - TransactionalId - User required: - host - id - operation - pattern_type - permission_type - principal - resource_name - resource_type maintenance: type: object description: Automatic maintenance settings properties: controlled_switchover: type: object description: Controlled switchover status properties: completed_at: type: string description: Time when the switchover completed, if it has completed enabled: type: boolean description: Controlled switchover configured and enabled scheduled_start_time: type: string description: Scheduled start time of the switchover window, if enabled and active state: type: string description: Controlled switchover state enum: - INACTIVE - PENDING - SCHEDULED - RUNNING - COMPLETED - COMPLETED_EARLY termination_reason: type: string description: Reason for switchover termination required: - enabled - scheduled_start_time - state dow: type: string description: Day of week for installing updates enum: - monday - tuesday - wednesday - thursday - friday - saturday - sunday - never enabled: type: boolean description: Service maintenance enabled time: type: string minLength: 8 maxLength: 8 description: Time for installing updates, UTC updates: type: array description: List of updates waiting to be installed items: type: object properties: deadline: type: string description: Deadline for installing the update description: type: string description: Description of the update documentation_link: type: string description: Optional link impact: type: string description: Impact statement of the update impact_portable_text: type: string description: Impact statement in portable text format start_after: type: string description: The earliest time the update will be automatically applied start_at: type: string description: The time when the update will be automatically applied required: - dow - enabled - time - updates metadata: type: object description: Service type specific metadata properties: {} node_count: type: integer description: Number of service nodes in the active plan node_cpu_count: type: integer description: Number of CPUs for each node node_memory_mb: type: number description: Megabytes of memory for each node node_states: type: array description: State of individual service nodes items: type: object properties: availability_zone: type: string description: The availability zone in which the node is place. If there is no availability zone available this field will be missing. name: type: string description: Name of the service node progress_updates: type: array description: Extra information regarding the progress for current state items: type: object properties: completed: type: boolean description: Indicates whether this phase has been completed or not current: type: integer description: Current progress for this phase. May be missing or null. max: type: integer description: Maximum progress value for this phase. May be missing or null. May change. min: type: integer description: Minimum progress value for this phase. May be missing or null. phase: type: string description: Key identifying this phase enum: - prepare - basebackup - basebackup_prepare - stream - finalize unit: type: string description: Unit for current/min/max values. New units may be added. If null should be treated as generic unit enum: - binlogs - bytes_compressed - bytes_uncompressed - prepare_percent - wal_lsn required: - completed - phase role: type: string description: Role of this node. Only returned for a subset of service types enum: - master - standby - read-replica roles: type: string description: 'A role string indicating the node''s roles in the OpenSearch cluster. Only populated for OpenSearch services using cluster plans. Format: first character is ''*'' (elected cluster manager) or ''-'' (not elected), followed by role letters: ''d'' (data), ''i'' (ingest), ''m'' (cluster_manager eligible), ''c'' (coordinating), ''L'' (ML), ''D'' (Dashboards). Example: ''*mc'' means elected cluster manager with cluster_manager and coordinating roles.' title: Roles of this node. Only returned for OpenSearch services with cluster plans shard: type: object description: Shard of this node. Only returned for a subset of service types properties: name: type: string description: Name of the shard. position: type: integer description: Position of this shard within the service state: type: string description: Current state of the service node enum: - leaving - running - setting_up_vm - syncing_data - timing_out - unknown required: - availability_zone - name - state plan: type: string maxLength: 128 description: Subscription plan project_vpc_id: type: string minLength: 36 maxLength: 36 description: Project VPC ID schema_registry_acl: type: array description: List of Schema Registry ACL entries items: type: object properties: id: type: string maxLength: 40 description: ID permission: type: string description: ACL entry for Schema Registry enum: - schema_registry_read - schema_registry_write resource: type: string minLength: 1 maxLength: 249 description: Schema Registry ACL entry resource name pattern username: type: string minLength: 1 maxLength: 64 description: Username required: - permission - resource - username server_group: type: object description: Service IaaS server group properties: enabled: type: boolean description: Flag set if server group is in use for the service type: type: string description: IaaS server group type service_integrations: type: array description: Integrations with other services items: type: object properties: active: type: boolean description: True when integration is active description: type: string description: Description of the integration dest_endpoint: type: string description: Destination endpoint name dest_endpoint_id: type: string description: Destination endpoint id dest_project: type: string maxLength: 63 description: Project name dest_service: type: string description: Destination service name dest_service_type: type: string maxLength: 64 description: Service type code enabled: type: boolean description: True when integration is enabled integration_status: type: object description: Integration status properties: state: type: object description: Service integration state properties: errors: type: array description: Errors items: type: string likely_error_cause: type: string description: Most likely cause of the errors enum: - 'null' - destination - integration - source - unknown nodes: type: object description: Nodes properties: {} status: type: string description: Service integration status enum: - failed - inactive - running - starting - unknown required: - errors - nodes - status status_user_desc: type: string description: Integration status description required: - state - status_user_desc integration_type: type: string description: Type of the integration service_integration_id: type: string description: Integration ID source_endpoint: type: string description: Source endpoint name source_endpoint_id: type: string description: Source endpoint ID source_project: type: string maxLength: 63 description: Project name source_service: type: string description: Source service name source_service_type: type: string maxLength: 64 description: Service type code user_config: type: object description: Service integration settings properties: {} required: - active - description - dest_project - dest_service_type - enabled - integration_type - service_integration_id - source_project - source_service - source_service_type service_name: type: string minLength: 1 maxLength: 64 description: Service name service_notifications: type: array description: Service notifications items: type: object properties: level: type: string description: Notification level enum: - notice - warning message: type: string maxLength: 1024 description: Human notification message metadata: type: object description: Notification metadata properties: end_of_life_help_article_url: type: string description: Link to the help article end_of_life_policy_url: type: string description: Link to the help article service_end_of_life_time: type: string maxLength: 36 description: Timestamp in ISO 8601 format, always in UTC upgrade_to_service_type: type: string maxLength: 64 description: If the customer takes no action, the service is updated to this service type when end of life is reached on the Aiven platform. If it is the same as the service type, the platform only upgrades the version. upgrade_to_version: type: string maxLength: 32 description: The version to which the service will be updated at the end of life on the Aiven platform if the user does not take any action type: type: string description: Notification type enum: - service_end_of_life - service_powered_off_removal required: - level - message - metadata - type service_type: type: string maxLength: 64 description: Service type code service_type_description: type: string description: Single line description of the service service_uri: type: string description: URI for connecting to the service (may be null) service_uri_params: type: object description: service_uri parameterized into key-value pairs properties: {} state: type: string description: State of the service enum: - POWEROFF - REBALANCING - REBUILDING - RUNNING tags: type: object description: Set of resource tags properties: {} tech_emails: type: array maxItems: 10 description: List of service technical email addresses items: type: object properties: email: type: string maxLength: 254 description: User email address required: - email termination_protection: type: boolean description: Service is protected against termination and powering off topics: type: array description: 'Kafka topics. DEPRECATED: Use /project/$project/service/$service/topic instead' items: type: object properties: cleanup_policy: type: string maxLength: 64 description: The retention policy to use on old segments. Possible values include 'delete', 'compact', or a comma-separated list of them. The default policy ('delete') will discard old segments when their retention time or size limit has been reached. The 'compact' setting will enable log compaction on the topic. title: cleanup.policy min_insync_replicas: type: integer minimum: 1 description: When a producer sets acks to 'all' (or '-1'), this configuration specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. If this minimum cannot be met, then the producer will raise an exception (either NotEnoughReplicas or NotEnoughReplicasAfterAppend). When used together, min.insync.replicas and acks allow you to enforce greater durability guarantees. A typical scenario would be to create a topic with a replication factor of 3, set min.insync.replicas to 2, and produce with acks of 'all'. This will ensure that the producer raises an exception if a majority of replicas do not receive a write. title: min.insync.replicas partitions: type: integer minimum: 1 maximum: 1000000 description: Number of partitions replication: type: integer minimum: 1 description: Number of replicas retention_bytes: type: integer description: This configuration controls the maximum size a partition (which consists of log segments) can grow to before we will discard old log segments to free up space if we are using the 'delete' retention policy. By default there is no size limit only a time limit. Since this limit is enforced at the partition level, multiply it by the number of partitions to compute the topic retention in bytes. title: retention.bytes retention_hours: type: integer maximum: 2562047788015 description: Retention period (hours) state: type: string description: Topic state enum: - ACTIVE - CONFIGURING - DELETING topic_name: type: string minLength: 1 maxLength: 249 description: Topic name required: - cleanup_policy - min_insync_replicas - partitions - replication - retention_bytes - retention_hours - topic_name update_time: type: string maxLength: 36 description: Service last update timestamp (ISO 8601) user_config: type: object description: Service type-specific settings properties: {} users: type: array description: List of service users items: type: object properties: access_cert: type: string description: Access certificate for TLS client authentication access_cert_not_valid_after_time: type: string description: Validity end time (ISO8601) for the current access certificate access_control: type: object description: Service type specific access control rules for user. Currently only used for configuring user ACLs for Redis version 6 and above. title: Service specific access controls for user properties: dragonfly_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string dragonfly_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string dragonfly_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string pg_allow_replication: type: boolean description: Enable REPLICATION role option redis_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string redis_acl_channels: type: array maxItems: 256 description: Glob-style patterns defining which pub/sub channels can be accessed. If array is not defined, the default policy is used (allchannels). title: Permitted pub/sub channel patterns items: type: string redis_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string redis_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string valkey_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string valkey_acl_channels: type: array maxItems: 256 description: Glob-style patterns defining which pub/sub channels can be accessed. If array is not defined, the default policy is used (allchannels). title: Permitted pub/sub channel patterns items: type: string valkey_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string valkey_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string access_key: type: string description: Access key for TLS client authentication authentication: type: string description: Service specific authentication details. Currently only used for MySQL where accepted options are 'mysql_native_password' and 'caching_sha2_password', latter being default when this is not explicitly set. title: Authentication details enum: - 'null' - caching_sha2_password - mysql_native_password expiring_cert_not_valid_after_time: type: string description: When the existing certificate is nearing expiration and a new certificate has been generated, the validity end time (ISO8601) for the expiring certificate title: Validity end time (ISO8601) for the expiring access certificate password: type: string description: Account password. A null value indicates a user overridden password. password_updated_time: type: string description: Timestamp (ISO8601) of the last time this password was set. type: type: string description: Account type username: type: string description: Account username required: - password - type - username required: - cloud_name - create_time - group_list - plan - project_vpc_id - service_integrations - service_name - service_type - service_uri - state - termination_protection - update_time - user_config required: - service ServicePrivatelinkAWSUpdateRequestBody: type: object description: ServicePrivatelinkAWSUpdateRequestBody properties: principals: type: array minItems: 1 maxItems: 16 description: ARNs of principals allowed connecting to the service title: ARN allowlist items: type: string required: - principals ServicePrivatelinkAWSUpdateResponse: type: object description: ServicePrivatelinkAWSUpdateResponse properties: aws_service_id: type: string description: AWS VPC endpoint service ID aws_service_name: type: string description: AWS VPC endpoint service name errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request principals: type: array minItems: 1 maxItems: 16 description: ARNs of principals allowed connecting to the service title: ARN allowlist items: type: string state: type: string description: Privatelink resource state enum: - creating - active - deleting required: - principals - state ServiceGetMigrationStatusResponse: type: object description: ServiceGetMigrationStatusResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request migration: type: object description: Service migration info properties: error: type: string description: Error message in case that migration has failed master_last_io_seconds_ago: type: integer description: 'Redis only: how many seconds since last I/O with redis master' master_link_status: type: string description: 'Redis only: replication master link status' enum: - up - down method: type: string description: The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types) enum: - '' - dump - mysqldump - pg_dump - replication - scan status: type: string description: Migration status enum: - done - failed - running - syncing - waiting required: - method - status migration_detail: type: array description: Migration status per database items: type: object properties: dbname: type: string description: Migrated db name (PG, MySQL) or number (Redis, Dragonfly) dump_tool: type: string description: Tool used to perform the initial dump of a database to migrate (when method is replication), or just the dump-reload of the database (when method is dump). enum: - mysqldump - mydumper error: type: string description: Error message in case that migration has failed method: type: string description: The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types) enum: - '' - dump - mysqldump - pg_dump - replication - scan status: type: string description: Migration status enum: - done - failed - running - syncing - waiting required: - dbname - method - status required: - migration ServiceListResponse: type: object description: ServiceListResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request services: type: array description: List of services under the project items: type: object properties: acl: type: array description: List of Aiven ACL entries for Kafka service items: type: object properties: id: type: string maxLength: 40 description: ID permission: type: string description: Kafka permission enum: - admin - read - readwrite - write topic: type: string minLength: 1 maxLength: 249 description: Topic name pattern username: type: string minLength: 1 maxLength: 64 description: Username required: - permission - topic - username backups: type: array description: List of backups for the service items: type: object properties: additional_regions: type: array description: Additional backup regions, if available items: type: object properties: cloud: type: string maxLength: 256 description: Target cloud pause_reason: type: string description: Reason for pausing the backup synchronization paused: type: boolean description: Indicates additional backup synchronization is paused region: type: string description: Cloud storage region name required: - cloud backup_name: type: string description: Internal name of this backup backup_time: type: string maxLength: 36 description: Backup timestamp (ISO 8601) data_size: type: integer description: Backup's original size before compression incremental: type: boolean description: Indicates if this backup is a full or an incremental one (available only for MySQL) storage_location: type: string description: Location where this backup is stored tiered_storage_data_size: type: integer description: The amount of tiered storage data in bytes referenced by this backup. required: - backup_name - backup_time - data_size cloud_description: type: string description: Cloud provider and location cloud_name: type: string maxLength: 256 description: Target cloud cmk_id: type: string description: Active Customer Managed Key identifier (CMK ID) components: type: array description: Service component information objects items: type: object properties: component: type: string description: Service component name host: type: string description: DNS name for connecting to the service component kafka_authentication_method: type: string description: Kafka authentication method. This is a value specific to the 'kafka' service component enum: - certificate - sasl kafka_ssl_ca: type: string description: Specifies if this port uses Project CA or Letsencrypt. If not specified, the default is using Project CA.This is a value specific to the 'kafka' service component. enum: - project_ca - letsencrypt path: type: string description: Path component of the service URL (useful only if service component is HTTP or HTTPS endpoint) port: type: integer minimum: 0 maximum: 65535 description: Port number for connecting to the service component privatelink_connection_id: type: string description: Privatelink connection ID route: type: string description: Network access route enum: - dynamic - public - private - privatelink ssl: type: boolean description: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted andthis property is only included for service components that may disable encryption. usage: type: string description: DNS usage name enum: - disaster_recovery - primary - replica - ha_replica required: - component - host - port - route - usage connection_info: type: object description: Service-specific connection information properties properties: {} connection_pools: type: array description: PostgreSQL PGBouncer connection pools items: type: object properties: connection_uri: type: string description: Connection URI for the DB pool database: type: string maxLength: 63 description: Database name pool_mode: type: string description: PGBouncer pool mode enum: - session - transaction - statement pool_name: type: string maxLength: 63 description: Connection pool name pool_size: type: integer minimum: 1 maximum: 10000 description: Size of PGBouncer's PostgreSQL side connection pool username: type: string maxLength: 64 description: Pool username required: - connection_uri - database - pool_mode - pool_name - pool_size create_time: type: string maxLength: 36 description: Service creation timestamp (ISO 8601) databases: type: array description: List of service's user database names items: type: string disk_space_mb: type: integer minimum: 0 description: Megabytes of disk space for data storage features: type: object description: Feature flags properties: {} group_list: type: array description: List of service groups the service belongs to. This field is deprecated. It is always set to single element with value 'default' items: type: string is_cluster_plan: type: boolean description: True when the service uses a cluster plan with dedicated node groups kafka_acl: type: array description: List of Kafka-native ACL entries items: type: object properties: host: type: string minLength: 0 maxLength: 256 description: the host or * for all hosts id: type: string maxLength: 40 description: ID operation: type: string description: Kafka ACL operation represents an operation which an ACL grants or denies permission to perform enum: - All - Alter - AlterConfigs - ClusterAction - Create - CreateTokens - Delete - Describe - DescribeConfigs - DescribeTokens - IdempotentWrite - Read - Write pattern_type: type: string description: Kafka ACL pattern type of resource name enum: - LITERAL - PREFIXED permission_type: type: string description: Kafka ACL permission type enum: - ALLOW - DENY principal: type: string minLength: 0 maxLength: 256 description: principal is in 'principalType:name' format resource_name: type: string minLength: 0 maxLength: 256 description: Resource pattern used to match specified resources resource_type: type: string description: Kafka ACL resource type represents a type of resource which an ACL can be applied to enum: - Cluster - DelegationToken - Group - Topic - TransactionalId - User required: - host - id - operation - pattern_type - permission_type - principal - resource_name - resource_type maintenance: type: object description: Automatic maintenance settings properties: controlled_switchover: type: object description: Controlled switchover status properties: completed_at: type: string description: Time when the switchover completed, if it has completed enabled: type: boolean description: Controlled switchover configured and enabled scheduled_start_time: type: string description: Scheduled start time of the switchover window, if enabled and active state: type: string description: Controlled switchover state enum: - INACTIVE - PENDING - SCHEDULED - RUNNING - COMPLETED - COMPLETED_EARLY termination_reason: type: string description: Reason for switchover termination required: - enabled - scheduled_start_time - state dow: type: string description: Day of week for installing updates enum: - monday - tuesday - wednesday - thursday - friday - saturday - sunday - never enabled: type: boolean description: Service maintenance enabled time: type: string minLength: 8 maxLength: 8 description: Time for installing updates, UTC updates: type: array description: List of updates waiting to be installed items: type: object properties: deadline: type: string description: Deadline for installing the update description: type: string description: Description of the update documentation_link: type: string description: Optional link impact: type: string description: Impact statement of the update impact_portable_text: type: string description: Impact statement in portable text format start_after: type: string description: The earliest time the update will be automatically applied start_at: type: string description: The time when the update will be automatically applied required: - dow - enabled - time - updates metadata: type: object description: Service type specific metadata properties: {} node_count: type: integer description: Number of service nodes in the active plan node_cpu_count: type: integer description: Number of CPUs for each node node_memory_mb: type: number description: Megabytes of memory for each node node_states: type: array description: State of individual service nodes items: type: object properties: availability_zone: type: string description: The availability zone in which the node is place. If there is no availability zone available this field will be missing. name: type: string description: Name of the service node progress_updates: type: array description: Extra information regarding the progress for current state items: type: object properties: completed: type: boolean description: Indicates whether this phase has been completed or not current: type: integer description: Current progress for this phase. May be missing or null. max: type: integer description: Maximum progress value for this phase. May be missing or null. May change. min: type: integer description: Minimum progress value for this phase. May be missing or null. phase: type: string description: Key identifying this phase enum: - prepare - basebackup - basebackup_prepare - stream - finalize unit: type: string description: Unit for current/min/max values. New units may be added. If null should be treated as generic unit enum: - binlogs - bytes_compressed - bytes_uncompressed - prepare_percent - wal_lsn required: - completed - phase role: type: string description: Role of this node. Only returned for a subset of service types enum: - master - standby - read-replica roles: type: string description: 'A role string indicating the node''s roles in the OpenSearch cluster. Only populated for OpenSearch services using cluster plans. Format: first character is ''*'' (elected cluster manager) or ''-'' (not elected), followed by role letters: ''d'' (data), ''i'' (ingest), ''m'' (cluster_manager eligible), ''c'' (coordinating), ''L'' (ML), ''D'' (Dashboards). Example: ''*mc'' means elected cluster manager with cluster_manager and coordinating roles.' title: Roles of this node. Only returned for OpenSearch services with cluster plans shard: type: object description: Shard of this node. Only returned for a subset of service types properties: name: type: string description: Name of the shard. position: type: integer description: Position of this shard within the service state: type: string description: Current state of the service node enum: - leaving - running - setting_up_vm - syncing_data - timing_out - unknown required: - availability_zone - name - state plan: type: string maxLength: 128 description: Subscription plan project_vpc_id: type: string minLength: 36 maxLength: 36 description: Project VPC ID schema_registry_acl: type: array description: List of Schema Registry ACL entries items: type: object properties: id: type: string maxLength: 40 description: ID permission: type: string description: ACL entry for Schema Registry enum: - schema_registry_read - schema_registry_write resource: type: string minLength: 1 maxLength: 249 description: Schema Registry ACL entry resource name pattern username: type: string minLength: 1 maxLength: 64 description: Username required: - permission - resource - username server_group: type: object description: Service IaaS server group properties: enabled: type: boolean description: Flag set if server group is in use for the service type: type: string description: IaaS server group type service_integrations: type: array description: Integrations with other services items: type: object properties: active: type: boolean description: True when integration is active description: type: string description: Description of the integration dest_endpoint: type: string description: Destination endpoint name dest_endpoint_id: type: string description: Destination endpoint id dest_project: type: string maxLength: 63 description: Project name dest_service: type: string description: Destination service name dest_service_type: type: string maxLength: 64 description: Service type code enabled: type: boolean description: True when integration is enabled integration_status: type: object description: Integration status properties: state: type: object description: Service integration state properties: errors: type: array description: Errors items: type: string likely_error_cause: type: string description: Most likely cause of the errors enum: - 'null' - destination - integration - source - unknown nodes: type: object description: Nodes properties: {} status: type: string description: Service integration status enum: - failed - inactive - running - starting - unknown required: - errors - nodes - status status_user_desc: type: string description: Integration status description required: - state - status_user_desc integration_type: type: string description: Type of the integration service_integration_id: type: string description: Integration ID source_endpoint: type: string description: Source endpoint name source_endpoint_id: type: string description: Source endpoint ID source_project: type: string maxLength: 63 description: Project name source_service: type: string description: Source service name source_service_type: type: string maxLength: 64 description: Service type code user_config: type: object description: Service integration settings properties: {} required: - active - description - dest_project - dest_service_type - enabled - integration_type - service_integration_id - source_project - source_service - source_service_type service_name: type: string minLength: 1 maxLength: 64 description: Service name service_notifications: type: array description: Service notifications items: type: object properties: level: type: string description: Notification level enum: - notice - warning message: type: string maxLength: 1024 description: Human notification message metadata: type: object description: Notification metadata properties: end_of_life_help_article_url: type: string description: Link to the help article end_of_life_policy_url: type: string description: Link to the help article service_end_of_life_time: type: string maxLength: 36 description: Timestamp in ISO 8601 format, always in UTC upgrade_to_service_type: type: string maxLength: 64 description: If the customer takes no action, the service is updated to this service type when end of life is reached on the Aiven platform. If it is the same as the service type, the platform only upgrades the version. upgrade_to_version: type: string maxLength: 32 description: The version to which the service will be updated at the end of life on the Aiven platform if the user does not take any action type: type: string description: Notification type enum: - service_end_of_life - service_powered_off_removal required: - level - message - metadata - type service_type: type: string maxLength: 64 description: Service type code service_type_description: type: string description: Single line description of the service service_uri: type: string description: URI for connecting to the service (may be null) service_uri_params: type: object description: service_uri parameterized into key-value pairs properties: {} state: type: string description: State of the service enum: - POWEROFF - REBALANCING - REBUILDING - RUNNING tags: type: object description: Set of resource tags properties: {} tech_emails: type: array maxItems: 10 description: List of service technical email addresses items: type: object properties: email: type: string maxLength: 254 description: User email address required: - email termination_protection: type: boolean description: Service is protected against termination and powering off topics: type: array description: 'Kafka topics. DEPRECATED: Use /project/$project/service/$service/topic instead' items: type: object properties: cleanup_policy: type: string maxLength: 64 description: The retention policy to use on old segments. Possible values include 'delete', 'compact', or a comma-separated list of them. The default policy ('delete') will discard old segments when their retention time or size limit has been reached. The 'compact' setting will enable log compaction on the topic. title: cleanup.policy min_insync_replicas: type: integer minimum: 1 description: When a producer sets acks to 'all' (or '-1'), this configuration specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. If this minimum cannot be met, then the producer will raise an exception (either NotEnoughReplicas or NotEnoughReplicasAfterAppend). When used together, min.insync.replicas and acks allow you to enforce greater durability guarantees. A typical scenario would be to create a topic with a replication factor of 3, set min.insync.replicas to 2, and produce with acks of 'all'. This will ensure that the producer raises an exception if a majority of replicas do not receive a write. title: min.insync.replicas partitions: type: integer minimum: 1 maximum: 1000000 description: Number of partitions replication: type: integer minimum: 1 description: Number of replicas retention_bytes: type: integer description: This configuration controls the maximum size a partition (which consists of log segments) can grow to before we will discard old log segments to free up space if we are using the 'delete' retention policy. By default there is no size limit only a time limit. Since this limit is enforced at the partition level, multiply it by the number of partitions to compute the topic retention in bytes. title: retention.bytes retention_hours: type: integer maximum: 2562047788015 description: Retention period (hours) state: type: string description: Topic state enum: - ACTIVE - CONFIGURING - DELETING topic_name: type: string minLength: 1 maxLength: 249 description: Topic name required: - cleanup_policy - min_insync_replicas - partitions - replication - retention_bytes - retention_hours - topic_name update_time: type: string maxLength: 36 description: Service last update timestamp (ISO 8601) user_config: type: object description: Service type-specific settings properties: {} users: type: array description: List of service users items: type: object properties: access_cert: type: string description: Access certificate for TLS client authentication access_cert_not_valid_after_time: type: string description: Validity end time (ISO8601) for the current access certificate access_control: type: object description: Service type specific access control rules for user. Currently only used for configuring user ACLs for Redis version 6 and above. title: Service specific access controls for user properties: dragonfly_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string dragonfly_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string dragonfly_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string pg_allow_replication: type: boolean description: Enable REPLICATION role option redis_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string redis_acl_channels: type: array maxItems: 256 description: Glob-style patterns defining which pub/sub channels can be accessed. If array is not defined, the default policy is used (allchannels). title: Permitted pub/sub channel patterns items: type: string redis_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string redis_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string valkey_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string valkey_acl_channels: type: array maxItems: 256 description: Glob-style patterns defining which pub/sub channels can be accessed. If array is not defined, the default policy is used (allchannels). title: Permitted pub/sub channel patterns items: type: string valkey_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string valkey_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string access_key: type: string description: Access key for TLS client authentication authentication: type: string description: Service specific authentication details. Currently only used for MySQL where accepted options are 'mysql_native_password' and 'caching_sha2_password', latter being default when this is not explicitly set. title: Authentication details enum: - 'null' - caching_sha2_password - mysql_native_password expiring_cert_not_valid_after_time: type: string description: When the existing certificate is nearing expiration and a new certificate has been generated, the validity end time (ISO8601) for the expiring certificate title: Validity end time (ISO8601) for the expiring access certificate password: type: string description: Account password. A null value indicates a user overridden password. password_updated_time: type: string description: Timestamp (ISO8601) of the last time this password was set. type: type: string description: Account type username: type: string description: Account username required: - password - type - username required: - cloud_name - create_time - group_list - plan - project_vpc_id - service_integrations - service_name - service_type - service_uri - state - termination_protection - update_time - user_config required: - services ProjectServiceTagsReplaceRequestBody: type: object description: ProjectServiceTagsReplaceRequestBody properties: tags: type: object description: Set of resource tags properties: {} required: - tags ServiceEnableWritesResponse: type: object description: ServiceEnableWritesResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request until: type: string description: Writes enabled until required: - message ServiceDatabaseCreateRequestBody: type: object description: ServiceDatabaseCreateRequestBody properties: database: type: string maxLength: 40 description: Service database name lc_collate: type: string maxLength: 128 description: Default string sort order (LC_COLLATE) for PostgreSQL database default: en_US.UTF-8 lc_ctype: type: string maxLength: 128 description: Default character classification (LC_CTYPE) for PostgreSQL database default: en_US.UTF-8 required: - database ServiceCancelQueryResponse: type: object description: ServiceCancelQueryResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request success: type: boolean description: Status reported by the database server required: - success ProjectServiceTagsListResponse: type: object description: ProjectServiceTagsListResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request tags: type: object description: Set of resource tags properties: {} ProjectGetServiceLogsResponse: type: object description: ProjectGetServiceLogsResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status first_log_offset: type: string description: Opaque offset identifier of the first received log message. A null value is returned when there are no logs at all. logs: type: array description: List of log entries items: type: object properties: msg: type: string description: Log message severity: type: string description: Log severity level time: type: string maxLength: 36 description: Timestamp in ISO 8601 format, always in UTC unit: type: string description: SystemD unit name required: - msg message: type: string description: Printable result of the request offset: type: string description: Opaque offset identifier. A null value is returned when there are no logs at all. required: - first_log_offset - logs - offset ServiceGetResponse: type: object description: ServiceGetResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request service: type: object description: Service information properties: acl: type: array description: List of Aiven ACL entries for Kafka service items: type: object properties: id: type: string maxLength: 40 description: ID permission: type: string description: Kafka permission enum: - admin - read - readwrite - write topic: type: string minLength: 1 maxLength: 249 description: Topic name pattern username: type: string minLength: 1 maxLength: 64 description: Username required: - permission - topic - username backups: type: array description: List of backups for the service items: type: object properties: additional_regions: type: array description: Additional backup regions, if available items: type: object properties: cloud: type: string maxLength: 256 description: Target cloud pause_reason: type: string description: Reason for pausing the backup synchronization paused: type: boolean description: Indicates additional backup synchronization is paused region: type: string description: Cloud storage region name required: - cloud backup_name: type: string description: Internal name of this backup backup_time: type: string maxLength: 36 description: Backup timestamp (ISO 8601) data_size: type: integer description: Backup's original size before compression incremental: type: boolean description: Indicates if this backup is a full or an incremental one (available only for MySQL) storage_location: type: string description: Location where this backup is stored tiered_storage_data_size: type: integer description: The amount of tiered storage data in bytes referenced by this backup. required: - backup_name - backup_time - data_size cloud_description: type: string description: Cloud provider and location cloud_name: type: string maxLength: 256 description: Target cloud cmk_id: type: string description: Active Customer Managed Key identifier (CMK ID) components: type: array description: Service component information objects items: type: object properties: component: type: string description: Service component name host: type: string description: DNS name for connecting to the service component kafka_authentication_method: type: string description: Kafka authentication method. This is a value specific to the 'kafka' service component enum: - certificate - sasl kafka_ssl_ca: type: string description: Specifies if this port uses Project CA or Letsencrypt. If not specified, the default is using Project CA.This is a value specific to the 'kafka' service component. enum: - project_ca - letsencrypt path: type: string description: Path component of the service URL (useful only if service component is HTTP or HTTPS endpoint) port: type: integer minimum: 0 maximum: 65535 description: Port number for connecting to the service component privatelink_connection_id: type: string description: Privatelink connection ID route: type: string description: Network access route enum: - dynamic - public - private - privatelink ssl: type: boolean description: Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted andthis property is only included for service components that may disable encryption. usage: type: string description: DNS usage name enum: - disaster_recovery - primary - replica - ha_replica required: - component - host - port - route - usage connection_info: type: object description: Service-specific connection information properties properties: {} connection_pools: type: array description: PostgreSQL PGBouncer connection pools items: type: object properties: connection_uri: type: string description: Connection URI for the DB pool database: type: string maxLength: 63 description: Database name pool_mode: type: string description: PGBouncer pool mode enum: - session - transaction - statement pool_name: type: string maxLength: 63 description: Connection pool name pool_size: type: integer minimum: 1 maximum: 10000 description: Size of PGBouncer's PostgreSQL side connection pool username: type: string maxLength: 64 description: Pool username required: - connection_uri - database - pool_mode - pool_name - pool_size create_time: type: string maxLength: 36 description: Service creation timestamp (ISO 8601) databases: type: array description: List of service's user database names items: type: string disk_space_mb: type: integer minimum: 0 description: Megabytes of disk space for data storage features: type: object description: Feature flags properties: {} group_list: type: array description: List of service groups the service belongs to. This field is deprecated. It is always set to single element with value 'default' items: type: string is_cluster_plan: type: boolean description: True when the service uses a cluster plan with dedicated node groups kafka_acl: type: array description: List of Kafka-native ACL entries items: type: object properties: host: type: string minLength: 0 maxLength: 256 description: the host or * for all hosts id: type: string maxLength: 40 description: ID operation: type: string description: Kafka ACL operation represents an operation which an ACL grants or denies permission to perform enum: - All - Alter - AlterConfigs - ClusterAction - Create - CreateTokens - Delete - Describe - DescribeConfigs - DescribeTokens - IdempotentWrite - Read - Write pattern_type: type: string description: Kafka ACL pattern type of resource name enum: - LITERAL - PREFIXED permission_type: type: string description: Kafka ACL permission type enum: - ALLOW - DENY principal: type: string minLength: 0 maxLength: 256 description: principal is in 'principalType:name' format resource_name: type: string minLength: 0 maxLength: 256 description: Resource pattern used to match specified resources resource_type: type: string description: Kafka ACL resource type represents a type of resource which an ACL can be applied to enum: - Cluster - DelegationToken - Group - Topic - TransactionalId - User required: - host - id - operation - pattern_type - permission_type - principal - resource_name - resource_type maintenance: type: object description: Automatic maintenance settings properties: controlled_switchover: type: object description: Controlled switchover status properties: completed_at: type: string description: Time when the switchover completed, if it has completed enabled: type: boolean description: Controlled switchover configured and enabled scheduled_start_time: type: string description: Scheduled start time of the switchover window, if enabled and active state: type: string description: Controlled switchover state enum: - INACTIVE - PENDING - SCHEDULED - RUNNING - COMPLETED - COMPLETED_EARLY termination_reason: type: string description: Reason for switchover termination required: - enabled - scheduled_start_time - state dow: type: string description: Day of week for installing updates enum: - monday - tuesday - wednesday - thursday - friday - saturday - sunday - never enabled: type: boolean description: Service maintenance enabled time: type: string minLength: 8 maxLength: 8 description: Time for installing updates, UTC updates: type: array description: List of updates waiting to be installed items: type: object properties: deadline: type: string description: Deadline for installing the update description: type: string description: Description of the update documentation_link: type: string description: Optional link impact: type: string description: Impact statement of the update impact_portable_text: type: string description: Impact statement in portable text format start_after: type: string description: The earliest time the update will be automatically applied start_at: type: string description: The time when the update will be automatically applied required: - dow - enabled - time - updates metadata: type: object description: Service type specific metadata properties: {} node_count: type: integer description: Number of service nodes in the active plan node_cpu_count: type: integer description: Number of CPUs for each node node_memory_mb: type: number description: Megabytes of memory for each node node_states: type: array description: State of individual service nodes items: type: object properties: availability_zone: type: string description: The availability zone in which the node is place. If there is no availability zone available this field will be missing. name: type: string description: Name of the service node progress_updates: type: array description: Extra information regarding the progress for current state items: type: object properties: completed: type: boolean description: Indicates whether this phase has been completed or not current: type: integer description: Current progress for this phase. May be missing or null. max: type: integer description: Maximum progress value for this phase. May be missing or null. May change. min: type: integer description: Minimum progress value for this phase. May be missing or null. phase: type: string description: Key identifying this phase enum: - prepare - basebackup - basebackup_prepare - stream - finalize unit: type: string description: Unit for current/min/max values. New units may be added. If null should be treated as generic unit enum: - binlogs - bytes_compressed - bytes_uncompressed - prepare_percent - wal_lsn required: - completed - phase role: type: string description: Role of this node. Only returned for a subset of service types enum: - master - standby - read-replica roles: type: string description: 'A role string indicating the node''s roles in the OpenSearch cluster. Only populated for OpenSearch services using cluster plans. Format: first character is ''*'' (elected cluster manager) or ''-'' (not elected), followed by role letters: ''d'' (data), ''i'' (ingest), ''m'' (cluster_manager eligible), ''c'' (coordinating), ''L'' (ML), ''D'' (Dashboards). Example: ''*mc'' means elected cluster manager with cluster_manager and coordinating roles.' title: Roles of this node. Only returned for OpenSearch services with cluster plans shard: type: object description: Shard of this node. Only returned for a subset of service types properties: name: type: string description: Name of the shard. position: type: integer description: Position of this shard within the service state: type: string description: Current state of the service node enum: - leaving - running - setting_up_vm - syncing_data - timing_out - unknown required: - availability_zone - name - state plan: type: string maxLength: 128 description: Subscription plan project_vpc_id: type: string minLength: 36 maxLength: 36 description: Project VPC ID schema_registry_acl: type: array description: List of Schema Registry ACL entries items: type: object properties: id: type: string maxLength: 40 description: ID permission: type: string description: ACL entry for Schema Registry enum: - schema_registry_read - schema_registry_write resource: type: string minLength: 1 maxLength: 249 description: Schema Registry ACL entry resource name pattern username: type: string minLength: 1 maxLength: 64 description: Username required: - permission - resource - username server_group: type: object description: Service IaaS server group properties: enabled: type: boolean description: Flag set if server group is in use for the service type: type: string description: IaaS server group type service_integrations: type: array description: Integrations with other services items: type: object properties: active: type: boolean description: True when integration is active description: type: string description: Description of the integration dest_endpoint: type: string description: Destination endpoint name dest_endpoint_id: type: string description: Destination endpoint id dest_project: type: string maxLength: 63 description: Project name dest_service: type: string description: Destination service name dest_service_type: type: string maxLength: 64 description: Service type code enabled: type: boolean description: True when integration is enabled integration_status: type: object description: Integration status properties: state: type: object description: Service integration state properties: errors: type: array description: Errors items: type: string likely_error_cause: type: string description: Most likely cause of the errors enum: - 'null' - destination - integration - source - unknown nodes: type: object description: Nodes properties: {} status: type: string description: Service integration status enum: - failed - inactive - running - starting - unknown required: - errors - nodes - status status_user_desc: type: string description: Integration status description required: - state - status_user_desc integration_type: type: string description: Type of the integration service_integration_id: type: string description: Integration ID source_endpoint: type: string description: Source endpoint name source_endpoint_id: type: string description: Source endpoint ID source_project: type: string maxLength: 63 description: Project name source_service: type: string description: Source service name source_service_type: type: string maxLength: 64 description: Service type code user_config: type: object description: Service integration settings properties: {} required: - active - description - dest_project - dest_service_type - enabled - integration_type - service_integration_id - source_project - source_service - source_service_type service_name: type: string minLength: 1 maxLength: 64 description: Service name service_notifications: type: array description: Service notifications items: type: object properties: level: type: string description: Notification level enum: - notice - warning message: type: string maxLength: 1024 description: Human notification message metadata: type: object description: Notification metadata properties: end_of_life_help_article_url: type: string description: Link to the help article end_of_life_policy_url: type: string description: Link to the help article service_end_of_life_time: type: string maxLength: 36 description: Timestamp in ISO 8601 format, always in UTC upgrade_to_service_type: type: string maxLength: 64 description: If the customer takes no action, the service is updated to this service type when end of life is reached on the Aiven platform. If it is the same as the service type, the platform only upgrades the version. upgrade_to_version: type: string maxLength: 32 description: The version to which the service will be updated at the end of life on the Aiven platform if the user does not take any action type: type: string description: Notification type enum: - service_end_of_life - service_powered_off_removal required: - level - message - metadata - type service_type: type: string maxLength: 64 description: Service type code service_type_description: type: string description: Single line description of the service service_uri: type: string description: URI for connecting to the service (may be null) service_uri_params: type: object description: service_uri parameterized into key-value pairs properties: {} state: type: string description: State of the service enum: - POWEROFF - REBALANCING - REBUILDING - RUNNING tags: type: object description: Set of resource tags properties: {} tech_emails: type: array maxItems: 10 description: List of service technical email addresses items: type: object properties: email: type: string maxLength: 254 description: User email address required: - email termination_protection: type: boolean description: Service is protected against termination and powering off topics: type: array description: 'Kafka topics. DEPRECATED: Use /project/$project/service/$service/topic instead' items: type: object properties: cleanup_policy: type: string maxLength: 64 description: The retention policy to use on old segments. Possible values include 'delete', 'compact', or a comma-separated list of them. The default policy ('delete') will discard old segments when their retention time or size limit has been reached. The 'compact' setting will enable log compaction on the topic. title: cleanup.policy min_insync_replicas: type: integer minimum: 1 description: When a producer sets acks to 'all' (or '-1'), this configuration specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. If this minimum cannot be met, then the producer will raise an exception (either NotEnoughReplicas or NotEnoughReplicasAfterAppend). When used together, min.insync.replicas and acks allow you to enforce greater durability guarantees. A typical scenario would be to create a topic with a replication factor of 3, set min.insync.replicas to 2, and produce with acks of 'all'. This will ensure that the producer raises an exception if a majority of replicas do not receive a write. title: min.insync.replicas partitions: type: integer minimum: 1 maximum: 1000000 description: Number of partitions replication: type: integer minimum: 1 description: Number of replicas retention_bytes: type: integer description: This configuration controls the maximum size a partition (which consists of log segments) can grow to before we will discard old log segments to free up space if we are using the 'delete' retention policy. By default there is no size limit only a time limit. Since this limit is enforced at the partition level, multiply it by the number of partitions to compute the topic retention in bytes. title: retention.bytes retention_hours: type: integer maximum: 2562047788015 description: Retention period (hours) state: type: string description: Topic state enum: - ACTIVE - CONFIGURING - DELETING topic_name: type: string minLength: 1 maxLength: 249 description: Topic name required: - cleanup_policy - min_insync_replicas - partitions - replication - retention_bytes - retention_hours - topic_name update_time: type: string maxLength: 36 description: Service last update timestamp (ISO 8601) user_config: type: object description: Service type-specific settings properties: {} users: type: array description: List of service users items: type: object properties: access_cert: type: string description: Access certificate for TLS client authentication access_cert_not_valid_after_time: type: string description: Validity end time (ISO8601) for the current access certificate access_control: type: object description: Service type specific access control rules for user. Currently only used for configuring user ACLs for Redis version 6 and above. title: Service specific access controls for user properties: dragonfly_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string dragonfly_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string dragonfly_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string pg_allow_replication: type: boolean description: Enable REPLICATION role option redis_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string redis_acl_channels: type: array maxItems: 256 description: Glob-style patterns defining which pub/sub channels can be accessed. If array is not defined, the default policy is used (allchannels). title: Permitted pub/sub channel patterns items: type: string redis_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string redis_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string valkey_acl_categories: type: array maxItems: 256 description: Command category rules items: type: string valkey_acl_channels: type: array maxItems: 256 description: Glob-style patterns defining which pub/sub channels can be accessed. If array is not defined, the default policy is used (allchannels). title: Permitted pub/sub channel patterns items: type: string valkey_acl_commands: type: array maxItems: 256 description: Rules for individual commands items: type: string valkey_acl_keys: type: array maxItems: 256 description: Key access rules items: type: string access_key: type: string description: Access key for TLS client authentication authentication: type: string description: Service specific authentication details. Currently only used for MySQL where accepted options are 'mysql_native_password' and 'caching_sha2_password', latter being default when this is not explicitly set. title: Authentication details enum: - 'null' - caching_sha2_password - mysql_native_password expiring_cert_not_valid_after_time: type: string description: When the existing certificate is nearing expiration and a new certificate has been generated, the validity end time (ISO8601) for the expiring certificate title: Validity end time (ISO8601) for the expiring access certificate password: type: string description: Account password. A null value indicates a user overridden password. password_updated_time: type: string description: Timestamp (ISO8601) of the last time this password was set. type: type: string description: Account type username: type: string description: Account username required: - password - type - username required: - cloud_name - create_time - group_list - plan - project_vpc_id - service_integrations - service_name - service_type - service_uri - state - termination_protection - update_time - user_config required: - service ServiceAlertsListResponse: type: object description: ServiceAlertsListResponse properties: alerts: type: array description: List of active alerts for the service items: type: object properties: create_time: type: string maxLength: 36 description: Event creation timestamp (ISO 8601) event: type: string description: Name of the alerting event node_name: type: string description: Name of the service node project_name: type: string maxLength: 63 description: Project name service_name: type: string minLength: 1 maxLength: 64 description: Service name service_type: type: string maxLength: 64 description: Service type code severity: type: string description: Severity of the event required: - create_time - event - project_name - severity errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request required: - alerts ServicePrivatelinkAzureConnectionUpdateRequestBody: type: object description: ServicePrivatelinkAzureConnectionUpdateRequestBody properties: user_ip_address: type: string maxLength: 15 description: (Private) IP address of Privatelink endpoint required: - user_ip_address ServiceTaskCreateResponse: type: object description: ServiceTaskCreateResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request task: type: object description: Task info properties: create_time: type: string maxLength: 36 description: Timestamp in ISO 8601 format, always in UTC result: type: string description: Task result result_codes: type: array description: List of result codes items: type: object properties: code: type: string description: Machine-readable key code, which represents the result of the task dbname: type: string description: Database which related to the result code required: - code success: type: boolean description: Task success task_id: type: string description: Unique identifier for the task task_type: type: string description: Task type required: - create_time - result - success - task_id - task_type required: - task ProjectServiceTagsUpdateResponse: type: object description: ProjectServiceTagsUpdateResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request ListServiceVersionsResponse: type: object description: ListServiceVersionsResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request service_versions: type: array description: Service versions items: type: object properties: aiven_end_of_life_time: type: string maxLength: 36 description: Aiven end-of-life timestamp (ISO 8601) availability_end_time: type: string maxLength: 36 description: Availability end timestamp (ISO 8601) availability_start_time: type: string maxLength: 36 description: Availability start timestamp (ISO 8601) end_of_life_help_article_url: type: string description: Link to the help article major_version: type: string maxLength: 32 description: Service version service_type: type: string maxLength: 64 description: Service type code state: type: string description: Service state enum: - available - eol - preview - terminated - unavailable termination_time: type: string maxLength: 36 description: Termination timestamp (ISO 8601) upgrade_to_service_type: type: string maxLength: 64 description: If the customer takes no action, the service is updated to this service type when end of life is reached on the Aiven platform. If it is the same as the service type, the platform only upgrades the version. upgrade_to_version: type: string maxLength: 32 description: The version to which the service will be updated at the end of life on the Aiven platform if the user does not take any action upstream_end_of_life_time: type: string maxLength: 36 description: Upstream end-of-life timestamp (ISO 8601) required: - service_versions OsAvailablePluginsResponse: type: object description: OsAvailablePluginsResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request opensearch: type: array description: Supported OpenSearch versions items: type: object properties: plugins: type: array description: Plugins available for this OpenSearch version items: type: object properties: description: type: string description: Plugin description name: type: string description: Plugin name url: type: string description: Plugin URL version: type: string description: Plugin version required: - description - name - url - version version: type: string description: OpenSearch version required: - plugins - version ProjectServiceTagsUpdateRequestBody: type: object description: ProjectServiceTagsUpdateRequestBody properties: tags: type: object description: Set of resource tags properties: {} required: - tags ListPublicServiceTypesResponse: type: object description: ListPublicServiceTypesResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request service_types: type: object description: Service plans by service type properties: clickhouse: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema dragonfly: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema elasticsearch: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema flink: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema grafana: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema kafka: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema kafka_connect: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema kafka_mirrormaker: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema mysql: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema opensearch: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema pg: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema redis: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema thanos: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema valkey: type: object description: Service type information properties: default_version: type: string description: Default version of the service if no explicit version is defined description: type: string description: Single line description of the service latest_available_version: type: string description: Latest available version of the service service_plans: type: array description: List of plans available for this type of service items: type: object properties: backup_config: type: object description: Backup configuration for this service plan properties: frequent_interval_minutes: type: integer minimum: 0 description: Interval of taking a frequent backup in service types supporting different backup schedules frequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest frequent backup in service types supporting different backup schedules infrequent_interval_minutes: type: integer minimum: 0 description: Interval of taking an infrequent backup in service types supporting different backup schedules infrequent_oldest_age_minutes: type: integer minimum: 0 description: Maximum age of the oldest infrequent backup in service types supporting different backup schedules interval: type: integer minimum: 0 description: The interval, in hours, at which backups are generated. For some services, like PostgreSQL, this is the interval at which full snapshots are taken and continuous incremental backup stream is maintained in addition to that. max_count: type: integer minimum: 0 description: Maximum number of backups to keep. Zero when no backups are created. recovery_mode: type: string description: Mechanism how backups can be restored. 'basic' means a backup is restored as is so that the system is restored to the state it was when the backup was generated. 'pitr' means point-in-time-recovery, which allows restoring the system to any state since the first available full snapshot. enum: - basic - pitr required: - interval - max_count - recovery_mode is_cluster_plan: type: boolean description: True when the plan is a cluster plan with dedicated node groups max_memory_percent: type: integer minimum: 0 maximum: 100 description: Maximum amount of system memory as a percentage (0-100) the service can actually use after taking into account management overhead. This is relevant for memory bound services for which some service management operations require allocating proportional amount of memory on top the basic load. node_count: type: integer minimum: 1 maximum: 100 description: Number of nodes in this service plan primary_count: type: integer minimum: 1 description: Number of primary nodes in this Valkey cluster service plan regions: type: object description: Service plan hourly price per cloud region properties: {} service_plan: type: string maxLength: 128 description: Subscription plan service_type: type: string maxLength: 64 description: Service type code shard_count: type: integer minimum: 1 description: Number of shards in this service plan required: - backup_config - service_plan - service_type user_config_schema: type: object description: JSON-Schema for the 'user_config' properties properties: {} required: - description - service_plans - user_config_schema required: - service_types parameters: tenant: in: path name: tenant description: Aiven tenant ID schema: type: string required: true serviceuserget_include_secrets: in: query name: include_secrets description: Explicitly indicates that the client wants to read secrets that might be returned by this endpoint. schema: type: boolean required: false project: in: path name: project description: Project name schema: type: string required: true serviceget_include_secrets: in: query name: include_secrets description: Explicitly indicates that the client wants to read secrets that might be returned by this endpoint. schema: type: boolean required: false dbname: in: path name: dbname description: DatabaseName schema: type: string required: true service_name: in: path name: service_name description: Service name schema: type: string required: true privatelink_connection_id: in: path name: privatelink_connection_id description: Privatelink connection ID schema: type: string required: true servicelist_include_secrets: in: query name: include_secrets description: Explicitly indicates that the client wants to read secrets that might be returned by this endpoint. schema: type: boolean required: false service_username: in: path name: service_username description: Service username schema: type: string required: true serviceupdate_allow_unclean_poweroff: in: query name: allow_unclean_poweroff 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 schema: type: boolean default: true required: false task_id: in: path name: task_id description: Service task schema: type: string required: true securitySchemes: tokenAuth: description: 'Header should be of the format `authorization: aivenv1