ByCloud Docs
GuidesCLIAPISDK
post/v1/database-instances

Create database instance

Create a new database instance

Request Body

required

Content-Type: application/json

name

stringrequired

flavor_id

string<uuid>required

datastore

objectrequired

volume

objectrequired

networks

arrayoptional

databases

arrayoptional

Initial databases to create

users

arrayoptional

Initial users to create

configuration_id

string<uuid>optional

replica_of

string<uuid>optional

Source instance ID (for read replicas)

replica_count

integeroptional

Number of read replicas to create

public_access

booleanoptional

Default: false

ssl_enabled

booleanoptional

Default: true

backup_schedule

objectoptional

Responses

202

Database instance creation 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
403

Insufficient permissions

Content-Type: application/json

error

objectrequired
500

Internal server error

Content-Type: application/json

error

objectrequired
curl -X POST "https://api.spo1.mycloud.com/v1/database-instances" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "production-db",
    "flavor_id": "550e8400-e29b-41d4-a716-446655440000",
    "datastore": {
      "type": "postgresql",
      "version": "15.4"
    },
    "volume": {
      "size": 1,
      "type": "string"
    },
    "networks": [
      {
        "network_id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "databases": [
      {
        "name": "myapp",
        "character_set": "utf8mb4",
        "collation": "utf8mb4_unicode_ci"
      }
    ],
    "users": [
      {
        "name": "app_user",
        "password": "string",
        "host": "%",
        "databases": [
          {
            "name": "string"
          }
        ]
      }
    ],
    "configuration_id": "550e8400-e29b-41d4-a716-446655440000",
    "replica_of": "550e8400-e29b-41d4-a716-446655440000",
    "replica_count": 1,
    "public_access": false,
    "ssl_enabled": true,
    "backup_schedule": {
      "enabled": true,
      "time": "03:00",
      "retention_days": 7
    }
  }'

Response

Database instance creation initiated

{
  "database_instance": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "crn": "crn:spo1:database:instance:550e8400-e29b-41d4-a716-446655440000",
    "name": "production-db",
    "status": "ACTIVE",
    "operating_status": "string",
    "datastore": {
      "type": "postgresql",
      "version": "15.4",
      "version_id": "550e8400-e29b-41d4-a716-446655440000"
    },
    "flavor": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "db.m1.medium"
    },
    "volume": {
      "size": 50,
      "type": "ssd",
      "used": 0
    },
    "region": "spo1",
    "addresses": [
      {
        "address": "192.168.1.50",
        "type": "private",
        "network": "string"
      }
    ],
    "hostname": "550e8400.db.spo1.mycloud.com",
    "ip": [
      "string"
    ],
    "replicas": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "string"
      }
    ],
    "replica_of": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "string"
    },
    "configuration": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "string"
    },
    "public_access": false,
    "ssl_enabled": true,
    "backup_schedule": {
      "enabled": true,
      "time": "03:00",
      "retention_days": 7
    },
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}