Service

Update service configuration

Changed on
put/project/{project}/service/{service_name}

Request

  • Base URL
    https://api.aiven.io/v1
  • URL
    https://api.aiven.io/v1/project/{project}/service/{service_name}
  • Auth
    HTTP bearer and OAuth 2
    Authorization code: https://console.aiven.io/oauth/authorize
    Token URL: https://api.aiven.io/v1/oauth2/token scopes: services:write

Path parameters

projectstring required

Project name

service_namestring required

Service name

Query parameters

allow_unclean_poweroffboolean

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. Note: defaults to false for PostgreSQL services.

Request body

cloudstring

Target cloud

cmk_idstring

Customer Managed Key identifier (CMK ID)

disk_space_mbinteger

Megabytes of disk space for data storage

group_namestring

Service group name (DEPRECATED: do not use)

karapaceboolean

Switch the service to use Karapace for schema registry and REST proxy

planstring

Subscription plan

poweredboolean

Power-on the service (true) or power-off (false)

project_vpc_idstring

Project VPC ID

schema_registry_authzboolean

Enable or disable Schema Registry authorization

termination_protectionboolean

Service is protected against termination and powering off

user_configobject

Service type-specific settings

Response

Response

messagestring

Printable result of the request

Changes

  • 1bd2f4e9caa9Revision changes
    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

  • 8bc631e52c97Revision changes
    • info

      added the optional property / to the response with the status