RArafftechnologies
Managed Databases

Get database

Changed on

Get one managed database: status, plan, storage, high availability, networking, price and live metrics. Poll it after create, scale or restore until status is running.

get/api/v1/databases/{database_id}

Request

  • Base URL
    https://api.rafftechnologies.com
  • URL
    https://api.rafftechnologies.com/api/v1/databases/{database_id}
  • Auth
    API key in header X-API-Key

Path parameters

database_idstring required

Database ID (UUID) or short id (the database_id field, e.g. a1b2c3d4)

Response

Database details

successboolean

Example response

{
  "database": {
    "name": "orders-db",
    "engine": "postgres",
    "engine_version": "16",
    "region": "us-east",
    "plan_id": 5,
    "storage_gb": 25,
    "connection_host": "a1b2c3d4.db.raffusercloud.com",
    "connection_port": 5432,
    "billing_type": "payg",
    "price_per_hour": 0.010945,
    "monthly_price": 7.99,
    "public_port": 20104,
    "public_dns_hostname": "a1b2c3d4.public.db.raffusercloud.com",
    "public_allowlist": [
      "203.0.113.0/24"
    ]
  }
}

Changes

  • 89ec42a2108bRevision changes
    • warning

      added the new moving enum value to the / response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 26292956c4b3Revision changes
    • breaking

      the / response's property format changed from uuid to no format for status

    • breaking

      the / response's property format changed from uuid to no format for status

    • warning

      added the new resizing enum value to the / response property for the response status

    • warning

      added the new restoring enum value to the / response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status