ByCloud Docs
GuidesCLIAPISDK
get/v1/database-instances

List database instances

List all database instances in the current organization

Query Parameters

limit

integeroptional

query

Maximum number of items to return

Default: 20

Example: 20

marker

string<uuid>optional

query

ID of the last item from the previous page (for pagination)

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

name

stringoptional

query

Filter by name (exact match or prefix with *)

Example: "web-*"

status

stringoptional

query

Filter by status

Example: "ACTIVE"

datastore_type

stringoptional

query

Filter by datastore type

Enum: "mysql", "mariadb", "postgresql", "mongodb", "redis", "cassandra"

Responses

200

List of database instances

Content-Type: application/json

database_instances

arrayoptional

meta

objectoptional

links

objectoptional
401

Authentication required or token invalid

Content-Type: application/json

error

objectrequired
500

Internal server error

Content-Type: application/json

error

objectrequired
curl -X GET "https://api.spo1.mycloud.com/v1/database-instances" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

Response

List of database instances

{
  "database_instances": [
    {
      "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"
    }
  ],
  "meta": {
    "total": 150,
    "limit": 20,
    "marker": "550e8400-e29b-41d4-a716-446655440000",
    "has_more": true
  },
  "links": {
    "self": "https://api.spo1.mycloud.com/v1/instances?limit=20",
    "next": "https://api.spo1.mycloud.com/v1/instances?limit=20&marker=550e8400-e29b-41d4-a716-446655440000",
    "previous": "https://api.spo1.mycloud.com/v1/instances?limit=20&marker=440e8400-e29b-41d4-a716-446655440000"
  }
}