Exoscale APIv2 API documentation

Update a DBaaS Kafka service

PUT /dbaas-kafka/{name}

Update a DBaaS Kafka service

Path parameters

name string Required

Body Required

authentication-methods object

Kafka authentication methods
- certificate boolean
  
  Enable certificate/SSL authentication
- sasl boolean
  
  Enable SASL authentication
kafka-rest-enabled boolean

Enable Kafka-REST service
kafka-connect-enabled boolean

Allow clients to connect to kafka_connect from the public internet for service nodes that are in a project VPC or another type of private network
ip-filter array[string]

Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'
schema-registry-settings object

Schema Registry configuration
kafka-rest-settings object

Kafka REST configuration
termination-protection boolean

Service is protected against termination and powering off
kafka-connect-settings object

Kafka Connect configuration values
maintenance object

Automatic maintenance settings
- dow string Required
  
  Day of week for installing updates
  
  Values are saturday, tuesday, never, wednesday, sunday, friday, monday, or thursday.
- time string Required
  
  Time for installing updates, UTC
  
  Minimum length is 8, maximum length is 8.
kafka-settings object

Kafka-specific settings
schema-registry-enabled boolean

Enable Schema-Registry service
plan string

Subscription plan

Minimum length is 1, maximum length is 128.

Responses

• 200 object

200
- id string(uuid)
  
  Operation ID
- reason string
  
  Operation failure reason
  
  Values are incorrect, unknown, unavailable, forbidden, busy, fault, partial, not-found, interrupted, unsupported, or conflict.
- reference object
  
  Related resource reference
  id string(uuid)
  
  Reference ID
  
  link string
  
  Link to the referenced resource
  
  command string
  
  Command name
- message string
  
  Operation message
- state string
  
  Operation status
  
  Values are failure, pending, success, or timeout.

PUT /dbaas-kafka/{name}

curl \
 -X PUT https://api-ch-gva-2.exoscale.com/v2/dbaas-kafka/{name} \
 -H "Content-Type: application/json" \
 -d '{"authentication-methods":{"certificate":true,"sasl":true},"kafka-rest-enabled":true,"kafka-connect-enabled":true,"ip-filter":["string"],"schema-registry-settings":{},"kafka-rest-settings":{},"termination-protection":true,"kafka-connect-settings":{},"maintenance":{"dow":"saturday","time":"string"},"kafka-settings":{},"schema-registry-enabled":true,"plan":"string"}'

Request example

{
  "authentication-methods": {
    "certificate": true,
    "sasl": true
  },
  "kafka-rest-enabled": true,
  "kafka-connect-enabled": true,
  "ip-filter": [
    "string"
  ],
  "schema-registry-settings": {},
  "kafka-rest-settings": {},
  "termination-protection": true,
  "kafka-connect-settings": {},
  "maintenance": {
    "dow": "saturday",
    "time": "string"
  },
  "kafka-settings": {},
  "schema-registry-enabled": true,
  "plan": "string"
}

Response example (200)

{
  "id": "string",
  "reason": "incorrect",
  "reference": {
    "id": "string",
    "link": "string",
    "command": "string"
  },
  "message": "string",
  "state": "failure"
}