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

Get database instance

Get details of a specific database instance

Path Parameters

database_instance_id

string<uuid>required

path

Database Instance ID

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

Responses

200

Database instance details

Content-Type: application/json

database_instance

objectoptional
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 GET "https://api.spo1.mycloud.com/v1/database-instances/550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json"

Response

Database instance details

{
"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"
}
}