ByCloud Docs
GuidesCLIAPISDK
patch/v1/database-instances/{database_instance_id}

Update database instance

Update a database instance

Path Parameters

database_instance_id

string<uuid>required

path

Database Instance ID

Example: "550e8400-e29b-41d4-a716-446655440000"

Request Body

required

Content-Type: application/json

name

stringoptional

configuration_id

string<uuid>optional

nullable

public_access

booleanoptional

backup_schedule

objectoptional

Responses

202

Database instance update initiated

Content-Type: application/json

database_instance

objectoptional
400

Invalid request parameters

Content-Type: application/json

error

objectrequired
401

Authentication required or token invalid

Content-Type: application/json

error

objectrequired
404

Resource not found

Content-Type: application/json

error

objectrequired
500

Internal server error

Content-Type: application/json

error

objectrequired
curl -X PATCH "https://api.spo1.mycloud.com/v1/database-instances/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "configuration_id": "550e8400-e29b-41d4-a716-446655440000",
    "public_access": true,
    "backup_schedule": {
      "enabled": true,
      "time": "string",
      "retention_days": 1
    }
  }'