Provisioning is asynchronous: the database is created in status pending and moves through deploying to running. Poll GET /api/v1/databases/{database_id} for progress. A free PostgreSQL or MySQL database is usually running within seconds. With public_access: true, running means the public address already accepts connections.
Networking
Databases live on private VPC networking by default. Set vpc_id to place the private endpoint ({database_id}.db.raffusercloud.com) inside an existing VPC, or attach a VPC later via POST /api/v1/databases/{database_id}/vpc. Public access is optional and off by default. TLS is always required.
Engines
PostgreSQL: pooled endpoint on port 6432 (PgBouncer, transaction mode) plus a direct endpoint on 5432. Nightly base backup with continuous WAL archiving for point-in-time restore.
MySQL: TLS endpoint on port 3306. Nightly backups plus on-demand backups.
Valkey: single TLS endpoint on port 6379. Nightly RDB snapshots plus on-demand snapshots. No read replicas; high availability adds a standby with automatic Sentinel failover.
ClickHouse and Kafka: see the engine catalog for versions. Kafka clients must trust the ca_cert returned by the connection endpoint.
Pricing
The plan sets the base price. High availability adds 70% of the plan price for PostgreSQL, Valkey and ClickHouse, 210% for MySQL and 140% for Kafka. Each PostgreSQL read replica costs the plan price. Storage above the plan’s included storage is $0.15/GB/month. The same numbers are in GET /api/v1/databases/plans and, without authentication, GET /api/v1/public/pricing/database.
Errors
409: the name is taken in this project, or the account already has a free database.
412: ha_enabled on a plan that has no room for high availability right now (MySQL; see ha_available in GET /api/v1/databases/plans). Nothing is created or charged: pick a smaller plan, or create the database without high availability.
402: a paid plan on a monthly account without a card that can be charged automatically. The response links to the dashboard to add one.
403: the account’s billing status or your role does not allow creating databases.
Billing
Free plan: no charge and no card needed. One free database per account.
Paid plan: a monthly subscription, the same as buying the database in the dashboard. The account needs a card that can be charged automatically, or the create is refused with 402 and a link to add one. The first month is charged within seconds of the create, from the account balance first and then the card.
Accounts on pay-as-you-go billing are billed by the hour instead.
API key for authentication. Each key is bound to a specific account.
Headers
X-Project-ID
string<uuid>
required
Project ID. Required for all mutating operations (create, delete, power actions, resize).
Body
application/json
name
string
required
Display name, unique within the project across all engines. Lowercase letters, digits and hyphens work everywhere.
Example:
"orders-db"
plan_id
integer
required
Pricing plan ID from GET /api/v1/databases/plans
Example:
5
engine
enum<string>
Database engine identifier. Defaults to postgres on create; the live catalog (including availability and versions) is GET /api/v1/databases/engines.
Available options:
postgres,
mysql,
valkey,
clickhouse,
kafka
Example:
"postgres"
engine_version
string
Engine major version from the engine catalog. Omit for the default version.
Example:
"16"
storage_gb
integer
Storage in GB. Omit to use the plan's included storage; storage above it is billed per GB per month ($0.15 today). Fixed on the free plan.
ha_enabled
boolean
default:false
Enable high availability (+70% of the plan price for PostgreSQL, Valkey and ClickHouse, +210% for MySQL, +140% for Kafka). Not available on the free plan.
replica_count
integer
default:0
Read replicas, PostgreSQL only. Each costs the same as the plan. Not available on the free plan.
region
enum<string>
default:us-east
Data center region
Available options:
us-east
vpc_id
string<uuid>
VPC to place the private endpoint in. Omit to create without VPC connectivity and attach one later via POST /api/v1/databases/{database_id}/vpc.
public_access
boolean
default:false
Give the database a public address (TLS required) as soon as it is created. If the public address cannot be set up, the database is still created, without it; check public_access in the response of GET /api/v1/databases/{database_id}. Kafka is private only.
engine_config
object
Engine settings you can choose at create. Anything else is refused with 400.
Valkey maxmemory-policy: noeviction (default; nothing is ever removed, writes fail when memory is full; for queues and data you cannot lose) or allkeys-lru (the least recently used keys are removed when memory is full; for caches).
Show child attributes
Example:
{ "maxmemory-policy": "allkeys-lru" }
extensions
string[]
PostgreSQL only. Extensions to turn on before the database is marked running, so it is ready for them the moment you connect. Allowed: vector (AI embeddings), postgis, pg_cron, pg_trgm, pg_stat_statements, hstore, uuid-ossp, citext, ltree, pgcrypto, unaccent. Other engines or other names are refused with 400. Any other extension the image ships can be turned on later with the extensions endpoint.
Example:
["vector"]
Response
Database created (status pending while provisioning)
success
boolean
database
object
A managed database instance. The private endpoint {database_id}.db.raffusercloud.com lives inside the attached VPC; public access is optional. TLS is always required.
Show child attributes
Last modified on October 5, 2026
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Raff","colors":{"primary":"#E43D12","light":"#f15e3a","dark":"#b32f0d"},"logo":{"light":"https://mintcdn.com/rafftechnologiesllc/-fGNhyEGXJeJV5ed/logo/light.svg?fit=max\u0026auto=format\u0026n=-fGNhyEGXJeJV5ed\u0026q=85\u0026s=0e81ca868d348265df3068ed9c0d9769","dark":"https://mintcdn.com/rafftechnologiesllc/-fGNhyEGXJeJV5ed/logo/dark.svg?fit=max\u0026auto=format\u0026n=-fGNhyEGXJeJV5ed\u0026q=85\u0026s=449e6e79f98b68b6f313c524bc66dc76"},"favicon":"https://mintcdn.com/rafftechnologiesllc/W-SRe3pyhI_9M9ss/favicon.ico?fit=max\u0026auto=format\u0026n=W-SRe3pyhI_9M9ss\u0026q=85\u0026s=108c3e7250ef83b8d547d35e00467418","api":{"playground":{}},"navbar":{"links":[{"href":"mailto:support@rafftechnologies.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.rafftechnologies.com"}},"footer":{"socials":{"x":"https://x.com/rafftechnologies","instagram":"https://instagram.com/rafftechnologies","linkedin":"https://linkedin.com/company/rafftechnologies","reddit":"https://www.reddit.com/user/rafftechnologies","github":"https://github.com/rafftechnologies"},"links":[{"header":"Company","items":[{"label":"About","href":"https://rafftechnologies.com/about-us"},{"label":"Blog","href":"https://rafftechnologies.com/blog"},{"label":"Pricing","href":"https://rafftechnologies.com/pricing"},{"label":"Status","href":"https://rafftechnologies.com/status"}]},{"header":"Docs","items":[{"label":"Docs Home","href":"/introduction"},{"label":"API Reference","href":"/api-reference/endpoints"},{"label":"CLI","href":"/reference/cli/introduction"},{"label":"Terraform Provider","href":"https://registry.terraform.io/providers/RaffTechnologies/raff/latest"},{"label":"Quickstart","href":"/quickstart"},{"label":"Products","href":"/products"}]},{"header":"Application","items":[{"label":"Dashboard","href":"https://app.rafftechnologies.com"},{"label":"Sign in","href":"https://app.rafftechnologies.com/auth/sign-in"},{"label":"Sign up","href":"https://app.rafftechnologies.com/auth/sign-up"},{"label":"Marketplace","href":"https://marketplace.rafftechnologies.com"}]},{"header":"Support","items":[{"label":"Tickets","href":"https://help.rafftechnologies.com"},{"label":"Contact","href":"mailto:support@rafftechnologies.com"},{"label":"FAQ","href":"https://rafftechnologies.com/faq"},{"label":"Terms of Service","href":"https://app.rafftechnologies.com/legal"},{"label":"Privacy Policy","href":"https://app.rafftechnologies.com/legal"},{"label":"SLA","href":"https://app.rafftechnologies.com/legal"}]}]},"seo":{"metatags":{"og:site_name":"Raff","og:image":"https://rafftechnologies.com/images/og.jpg","twitter:card":"summary_large_image","twitter:site":"@rafftechnologies"},"indexing":"all"},"metadata":{"timestamp":true},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Changelog","icon":"clock-rotate-left","href":"/api-reference/changelog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"rafftechnologiesllc","hasAudioNarration":false,"actualSubdomain":"rafftechnologiesllc","customDomains":["docs.rafftechnologies.com"],"gitSource":{"type":"github","owner":"rafftechnologies","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":false},"entitlements":{},"buildId":"6afee8fb5246eb87f3600aeb","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"Reference","count":289},{"language":"default","tag":"REST API","count":236},{"language":"default","tag":"Products","count":232},{"language":"default","tag":"Build","count":109},{"language":"default","tag":"Quickstart \u0026 guides","count":95},{"language":"default","tag":"Raff Apps","count":72},{"language":"default","tag":"Virtual Machines","count":70},{"language":"default","tag":"Concepts","count":62},{"language":"default","tag":"Managed Databases","count":60},{"language":"default","tag":"Kubernetes","count":52}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/databases/create-database","slug":"/api-reference/databases/create-database","pageMetadata":{"title":"Create database","openapi":"POST /api/v1/databases","description":"Create a managed database.\n\n\u003cNote>\nBefore creating a database, you need:\n- A **plan ID** from [List database plans](/api-reference/databases/list-database-plans). The free plan is marked `is_free_tier`; one free database per account.\n- Optionally an **engine version** from [List database engines](/api-reference/databases/list-database-engines). Omit it for the newest.\n- A **project ID** in `X-Project-ID` from [List projects](/api-reference/projects/list-projects).\n- Optionally a **VPC ID** for a private endpoint.\n\u003c/Note>\n\nProvisioning is asynchronous: the database is created in status `pending` and moves through `deploying` to `running`. Poll `GET /api/v1/databases/{database_id}` for progress. A free PostgreSQL or MySQL database is usually `running` within seconds. With `public_access: true`, `running` means the public address already accepts connections.\n\n## Networking\n\nDatabases live on private VPC networking by default. Set `vpc_id` to place the private endpoint (`{database_id}.db.raffusercloud.com`) inside an existing VPC, or attach a VPC later via `POST /api/v1/databases/{database_id}/vpc`. Public access is optional and off by default. TLS is always required.\n\n## Engines\n\n- **PostgreSQL**: pooled endpoint on port 6432 (PgBouncer, transaction mode) plus a direct endpoint on 5432. Nightly base backup with continuous WAL archiving for point-in-time restore.\n- **MySQL**: TLS endpoint on port 3306. Nightly backups plus on-demand backups.\n- **Valkey**: single TLS endpoint on port 6379. Nightly RDB snapshots plus on-demand snapshots. No read replicas; high availability adds a standby with automatic Sentinel failover.\n- **ClickHouse** and **Kafka**: see the engine catalog for versions. Kafka clients must trust the `ca_cert` returned by the connection endpoint.\n\n## Pricing\n\nThe plan sets the base price. High availability adds 70% of the plan price for PostgreSQL, Valkey and ClickHouse, 210% for MySQL and 140% for Kafka. Each PostgreSQL read replica costs the plan price. Storage above the plan's included storage is $0.15/GB/month. The same numbers are in `GET /api/v1/databases/plans` and, without authentication, `GET /api/v1/public/pricing/database`.\n\n## Errors\n\n- `409`: the name is taken in this project, or the account already has a free database.\n- `412`: `ha_enabled` on a plan that has no room for high availability right now (MySQL; see `ha_available` in `GET /api/v1/databases/plans`). Nothing is created or charged: pick a smaller plan, or create the database without high availability.\n- `402`: a paid plan on a monthly account without a card that can be charged automatically. The response links to the dashboard to add one.\n- `403`: the account's billing status or your role does not allow creating databases.\n\n## Billing\n\n- **Free plan**: no charge and no card needed. One free database per account.\n- **Paid plan**: a monthly subscription, the same as buying the database in the dashboard. The account needs a card that can be charged automatically, or the create is refused with `402` and a link to add one. The first month is charged within seconds of the create, from the account balance first and then the card.\n- Accounts on pay-as-you-go billing are billed by the hour instead.\n","href":"/api-reference/databases/create-database"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n h2: \"h2\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n }, {Note} = _components;\n if (!Note) _missingMdxReference(\"Note\", true);\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Create a managed database.\"\n }), \"\\n\", _jsxs(Note, {\n children: [_jsx(_components.p, {\n children: \"Before creating a database, you need:\"\n }), _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"A \", _jsx(_components.strong, {\n children: \"plan ID\"\n }), \" from \", _jsx(_components.a, {\n href: \"/api-reference/databases/list-database-plans\",\n children: \"List database plans\"\n }), \". The free plan is marked \", _jsx(_components.code, {\n children: \"is_free_tier\"\n }), \"; one free database per account.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Optionally an \", _jsx(_components.strong, {\n children: \"engine version\"\n }), \" from \", _jsx(_components.a, {\n href: \"/api-reference/databases/list-database-engines\",\n children: \"List database engines\"\n }), \". Omit it for the newest.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"A \", _jsx(_components.strong, {\n children: \"project ID\"\n }), \" in \", _jsx(_components.code, {\n children: \"X-Project-ID\"\n }), \" from \", _jsx(_components.a, {\n href: \"/api-reference/projects/list-projects\",\n children: \"List projects\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Optionally a \", _jsx(_components.strong, {\n children: \"VPC ID\"\n }), \" for a private endpoint.\"]\n }), \"\\n\"]\n })]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Provisioning is asynchronous: the database is created in status \", _jsx(_components.code, {\n children: \"pending\"\n }), \" and moves through \", _jsx(_components.code, {\n children: \"deploying\"\n }), \" to \", _jsx(_components.code, {\n children: \"running\"\n }), \". Poll \", _jsx(_components.code, {\n children: \"GET /api/v1/databases/{database_id}\"\n }), \" for progress. A free PostgreSQL or MySQL database is usually \", _jsx(_components.code, {\n children: \"running\"\n }), \" within seconds. With \", _jsx(_components.code, {\n children: \"public_access: true\"\n }), \", \", _jsx(_components.code, {\n children: \"running\"\n }), \" means the public address already accepts connections.\"]\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Networking\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Databases live on private VPC networking by default. Set \", _jsx(_components.code, {\n children: \"vpc_id\"\n }), \" to place the private endpoint (\", _jsx(_components.code, {\n children: \"{database_id}.db.raffusercloud.com\"\n }), \") inside an existing VPC, or attach a VPC later via \", _jsx(_components.code, {\n children: \"POST /api/v1/databases/{database_id}/vpc\"\n }), \". Public access is optional and off by default. TLS is always required.\"]\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Engines\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"PostgreSQL\"\n }), \": pooled endpoint on port 6432 (PgBouncer, transaction mode) plus a direct endpoint on 5432. Nightly base backup with continuous WAL archiving for point-in-time restore.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"MySQL\"\n }), \": TLS endpoint on port 3306. Nightly backups plus on-demand backups.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Valkey\"\n }), \": single TLS endpoint on port 6379. Nightly RDB snapshots plus on-demand snapshots. No read replicas; high availability adds a standby with automatic Sentinel failover.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"ClickHouse\"\n }), \" and \", _jsx(_components.strong, {\n children: \"Kafka\"\n }), \": see the engine catalog for versions. Kafka clients must trust the \", _jsx(_components.code, {\n children: \"ca_cert\"\n }), \" returned by the connection endpoint.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Pricing\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The plan sets the base price. High availability adds 70% of the plan price for PostgreSQL, Valkey and ClickHouse, 210% for MySQL and 140% for Kafka. Each PostgreSQL read replica costs the plan price. Storage above the plan’s included storage is $0.15/GB/month. The same numbers are in \", _jsx(_components.code, {\n children: \"GET /api/v1/databases/plans\"\n }), \" and, without authentication, \", _jsx(_components.code, {\n children: \"GET /api/v1/public/pricing/database\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Errors\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"409\"\n }), \": the name is taken in this project, or the account already has a free database.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"412\"\n }), \": \", _jsx(_components.code, {\n children: \"ha_enabled\"\n }), \" on a plan that has no room for high availability right now (MySQL; see \", _jsx(_components.code, {\n children: \"ha_available\"\n }), \" in \", _jsx(_components.code, {\n children: \"GET /api/v1/databases/plans\"\n }), \"). Nothing is created or charged: pick a smaller plan, or create the database without high availability.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"402\"\n }), \": a paid plan on a monthly account without a card that can be charged automatically. The response links to the dashboard to add one.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"403\"\n }), \": the account’s billing status or your role does not allow creating databases.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Billing\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Free plan\"\n }), \": no charge and no card needed. One free database per account.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Paid plan\"\n }), \": a monthly subscription, the same as buying the database in the dashboard. The account needs a card that can be charged automatically, or the create is refused with \", _jsx(_components.code, {\n children: \"402\"\n }), \" and a link to add one. The first month is charged within seconds of the create, from the account balance first and then the card.\"]\n }), \"\\n\", _jsx(_components.li, {\n children: \"Accounts on pay-as-you-go billing are billed by the hour instead.\"\n }), \"\\n\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\nfunction _missingMdxReference(id, component) {\n throw new Error(\"Expected \" + (component ? \"component\" : \"object\") + \" `\" + id + \"` to be defined: you likely forgot to import, pass, or provide it.\");\n}\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create database","openapi":"POST /api/v1/databases","description":"Create a managed database.\n\n\u003cNote>\nBefore creating a database, you need:\n- A **plan ID** from [List database plans](/api-reference/databases/list-database-plans). The free plan is marked `is_free_tier`; one free database per account.\n- Optionally an **engine version** from [List database engines](/api-reference/databases/list-database-engines). Omit it for the newest.\n- A **project ID** in `X-Project-ID` from [List projects](/api-reference/projects/list-projects).\n- Optionally a **VPC ID** for a private endpoint.\n\u003c/Note>\n\nProvisioning is asynchronous: the database is created in status `pending` and moves through `deploying` to `running`. Poll `GET /api/v1/databases/{database_id}` for progress. A free PostgreSQL or MySQL database is usually `running` within seconds. With `public_access: true`, `running` means the public address already accepts connections.\n\n## Networking\n\nDatabases live on private VPC networking by default. Set `vpc_id` to place the private endpoint (`{database_id}.db.raffusercloud.com`) inside an existing VPC, or attach a VPC later via `POST /api/v1/databases/{database_id}/vpc`. Public access is optional and off by default. TLS is always required.\n\n## Engines\n\n- **PostgreSQL**: pooled endpoint on port 6432 (PgBouncer, transaction mode) plus a direct endpoint on 5432. Nightly base backup with continuous WAL archiving for point-in-time restore.\n- **MySQL**: TLS endpoint on port 3306. Nightly backups plus on-demand backups.\n- **Valkey**: single TLS endpoint on port 6379. Nightly RDB snapshots plus on-demand snapshots. No read replicas; high availability adds a standby with automatic Sentinel failover.\n- **ClickHouse** and **Kafka**: see the engine catalog for versions. Kafka clients must trust the `ca_cert` returned by the connection endpoint.\n\n## Pricing\n\nThe plan sets the base price. High availability adds 70% of the plan price for PostgreSQL, Valkey and ClickHouse, 210% for MySQL and 140% for Kafka. Each PostgreSQL read replica costs the plan price. Storage above the plan's included storage is $0.15/GB/month. The same numbers are in `GET /api/v1/databases/plans` and, without authentication, `GET /api/v1/public/pricing/database`.\n\n## Errors\n\n- `409`: the name is taken in this project, or the account already has a free database.\n- `412`: `ha_enabled` on a plan that has no room for high availability right now (MySQL; see `ha_available` in `GET /api/v1/databases/plans`). Nothing is created or charged: pick a smaller plan, or create the database without high availability.\n- `402`: a paid plan on a monthly account without a card that can be charged automatically. The response links to the dashboard to add one.\n- `403`: the account's billing status or your role does not allow creating databases.\n\n## Billing\n\n- **Free plan**: no charge and no card needed. One free database per account.\n- **Paid plan**: a monthly subscription, the same as buying the database in the dashboard. The account needs a card that can be charged automatically, or the create is refused with `402` and a link to add one. The first month is charged within seconds of the create, from the account balance first and then the card.\n- Accounts on pay-as-you-go billing are billed by the hour instead.\n","href":"/api-reference/databases/create-database"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Managed Databases"],"summary":"Create database","description":"Create a managed database.\n\n\u003cNote>\nBefore creating a database, you need:\n- A **plan ID** from [List database plans](/api-reference/databases/list-database-plans). The free plan is marked `is_free_tier`; one free database per account.\n- Optionally an **engine version** from [List database engines](/api-reference/databases/list-database-engines). Omit it for the newest.\n- A **project ID** in `X-Project-ID` from [List projects](/api-reference/projects/list-projects).\n- Optionally a **VPC ID** for a private endpoint.\n\u003c/Note>\n\nProvisioning is asynchronous: the database is created in status `pending` and moves through `deploying` to `running`. Poll `GET /api/v1/databases/{database_id}` for progress. A free PostgreSQL or MySQL database is usually `running` within seconds. With `public_access: true`, `running` means the public address already accepts connections.\n\n## Networking\n\nDatabases live on private VPC networking by default. Set `vpc_id` to place the private endpoint (`{database_id}.db.raffusercloud.com`) inside an existing VPC, or attach a VPC later via `POST /api/v1/databases/{database_id}/vpc`. Public access is optional and off by default. TLS is always required.\n\n## Engines\n\n- **PostgreSQL**: pooled endpoint on port 6432 (PgBouncer, transaction mode) plus a direct endpoint on 5432. Nightly base backup with continuous WAL archiving for point-in-time restore.\n- **MySQL**: TLS endpoint on port 3306. Nightly backups plus on-demand backups.\n- **Valkey**: single TLS endpoint on port 6379. Nightly RDB snapshots plus on-demand snapshots. No read replicas; high availability adds a standby with automatic Sentinel failover.\n- **ClickHouse** and **Kafka**: see the engine catalog for versions. Kafka clients must trust the `ca_cert` returned by the connection endpoint.\n\n## Pricing\n\nThe plan sets the base price. High availability adds 70% of the plan price for PostgreSQL, Valkey and ClickHouse, 210% for MySQL and 140% for Kafka. Each PostgreSQL read replica costs the plan price. Storage above the plan's included storage is $0.15/GB/month. The same numbers are in `GET /api/v1/databases/plans` and, without authentication, `GET /api/v1/public/pricing/database`.\n\n## Errors\n\n- `409`: the name is taken in this project, or the account already has a free database.\n- `412`: `ha_enabled` on a plan that has no room for high availability right now (MySQL; see `ha_available` in `GET /api/v1/databases/plans`). Nothing is created or charged: pick a smaller plan, or create the database without high availability.\n- `402`: a paid plan on a monthly account without a card that can be charged automatically. The response links to the dashboard to add one.\n- `403`: the account's billing status or your role does not allow creating databases.\n\n## Billing\n\n- **Free plan**: no charge and no card needed. One free database per account.\n- **Paid plan**: a monthly subscription, the same as buying the database in the dashboard. The account needs a card that can be charged automatically, or the create is refused with `402` and a link to add one. The first month is charged within seconds of the create, from the account balance first and then the card.\n- Accounts on pay-as-you-go billing are billed by the hour instead.\n","operationId":"createDatabase","parameters":["df285507-b522-47d6-b300-d4584c4a4a71"],"requestBody":"fb78240c-b7d7-411c-820b-af6ddab0642a","responses":{"201":"7cd2e5e8-d48e-4315-be9d-145827514e64","400":"c77ee2aa-2436-456f-9862-f9b42020ee52","401":"412f9ccd-d5c2-427b-bba3-ea6a6ae1fc29","402":"a5ced37c-c215-4911-b09e-fa7adffa0b36","403":"45a68486-bec0-41a3-9b17-f6307a17bdaa","409":"4491ee94-b022-4f88-9c4b-6c0791235014"},"method":"post","type":"path","servers":["6789a6e5-e415-4c99-8fcb-6cd793ffdcee"],"security":["326ac752-5310-476b-a513-6351e014d53d"],"path":"/api/v1/databases","baseUrlOptions":["https://api.rafftechnologies.com"],"title":"Create database","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"df285507-b522-47d6-b300-d4584c4a4a71":{"name":"X-Project-ID","in":"header","required":true,"description":"Project ID. Required for all mutating operations (create, delete, power actions, resize).","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Project ID. Required for all mutating operations (create, delete, power actions, resize).","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","plan_id"],"properties":{"name":{"type":"string","description":"Display name, unique within the project across all engines. Lowercase letters, digits and hyphens work everywhere.","example":"orders-db","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"plan_id":{"type":"integer","description":"Pricing plan ID from `GET /api/v1/databases/plans`","example":5,"isRequired":true,"uniqueKey":"plan_id","typeLabel":"integer"},"engine":{"type":"string","enum":["postgres","mysql","valkey","clickhouse","kafka"],"description":"Database engine identifier. Defaults to `postgres` on create; the live catalog (including availability and versions) is `GET /api/v1/databases/engines`.","example":"postgres","uniqueKey":"engine","typeLabel":"enum\u003cstring>"},"engine_version":{"type":"string","description":"Engine major version from the engine catalog. Omit for the default version.","example":"16","uniqueKey":"engine_version","typeLabel":"string"},"storage_gb":{"type":"integer","description":"Storage in GB. Omit to use the plan's included storage; storage above it is billed per GB per month ($0.15 today). Fixed on the free plan.","uniqueKey":"storage_gb","typeLabel":"integer"},"ha_enabled":{"type":"boolean","default":false,"description":"Enable high availability (+70% of the plan price for PostgreSQL, Valkey and ClickHouse, +210% for MySQL, +140% for Kafka). Not available on the free plan.","uniqueKey":"ha_enabled","typeLabel":"boolean"},"replica_count":{"type":"integer","default":0,"description":"Read replicas, PostgreSQL only. Each costs the same as the plan. Not available on the free plan.","uniqueKey":"replica_count","typeLabel":"integer"},"region":{"type":"string","enum":["us-east"],"default":"us-east","description":"Data center region","uniqueKey":"region","typeLabel":"enum\u003cstring>"},"vpc_id":{"type":"string","format":"uuid","description":"VPC to place the private endpoint in. Omit to create without VPC connectivity and attach one later via `POST /api/v1/databases/{database_id}/vpc`.","uniqueKey":"vpc_id","typeLabel":"string\u003cuuid>"},"public_access":{"type":"boolean","default":false,"description":"Give the database a public address (TLS required) as soon as it is created. If the public address cannot be set up, the database is still created, without it; check `public_access` in the response of `GET /api/v1/databases/{database_id}`. Kafka is private only.","uniqueKey":"public_access","typeLabel":"boolean"},"engine_config":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"engine_config.additionalProperties","typeLabel":"string"},"description":"Engine settings you can choose at create. Anything else is refused with 400.\n- Valkey `maxmemory-policy`: `noeviction` (default; nothing is ever removed, writes fail when memory is full; for queues and data you cannot lose) or `allkeys-lru` (the least recently used keys are removed when memory is full; for caches).\n","example":{"maxmemory-policy":"allkeys-lru"},"uniqueKey":"engine_config","typeLabel":"object"},"extensions":{"type":"array","items":{"type":"string","uniqueKey":"extensions.items.[INDEX]","typeLabel":"string"},"description":"PostgreSQL only. Extensions to turn on before the database is marked running, so it is ready for them the moment you connect. Allowed: `vector` (AI embeddings), `postgis`, `pg_cron`, `pg_trgm`, `pg_stat_statements`, `hstore`, `uuid-ossp`, `citext`, `ltree`, `pgcrypto`, `unaccent`. Other engines or other names are refused with 400. Any other extension the image ships can be turned on later with the extensions endpoint.\n","example":["vector"],"uniqueKey":"extensions","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"orders-db","plan_id":5,"engine":"postgres","engine_version":"16","storage_gb":123,"ha_enabled":false,"replica_count":0,"region":"us-east","vpc_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","public_access":false,"engine_config":{"maxmemory-policy":"allkeys-lru"},"extensions":["vector"]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"7cd2e5e8-d48e-4315-be9d-145827514e64":{"description":"Database created (status `pending` while provisioning)","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"database":{"type":"object","description":"A managed database instance. The private endpoint `{database_id}.db.raffusercloud.com` lives inside the attached VPC; public access is optional. TLS is always required.\n","properties":{"id":{"type":"string","format":"uuid","description":"Unique database identifier","uniqueKey":"database.id","typeLabel":"string\u003cuuid>"},"database_id":{"type":"string","description":"Short reference id used in URLs and DNS hostnames, e.g. `a1b2c3d4`","uniqueKey":"database.database_id","typeLabel":"string"},"project_id":{"type":"string","format":"uuid","description":"Project this database belongs to","uniqueKey":"database.project_id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Display name","example":"orders-db","uniqueKey":"database.name","typeLabel":"string"},"engine":{"type":"string","enum":["postgres","mysql","valkey","clickhouse","kafka"],"description":"Database engine identifier. Defaults to `postgres` on create; the live catalog (including availability and versions) is `GET /api/v1/databases/engines`.","example":"postgres","uniqueKey":"database.engine","typeLabel":"enum\u003cstring>"},"engine_version":{"type":"string","description":"Engine major version","example":"16","uniqueKey":"database.engine_version","typeLabel":"string"},"server_version":{"type":"string","description":"Full version the running server reports, refreshed every few minutes. Empty until the first reading after creation.","example":"16.10","uniqueKey":"database.server_version","typeLabel":"string"},"status":{"type":"string","enum":["pending","deploying","running","warning","resizing","restoring","moving","suspended","failed","deleting","deleted"],"description":"Lifecycle status.\n\n- Creation: `pending`, then `deploying`, then `running`. A database with public access reports `running` only once its public address accepts connections.\n- `warning`: running with a problem (a component down, storage full). When the database stopped answering, `down_since` is set.\n- `resizing`: a plan, storage, high availability or replica change is being applied (a short restart, not an outage).\n- `restoring`: an in-place restore is in progress.\n- `moving`: Raff is moving the database to other hardware for maintenance.\n- `suspended`: a free database paused after 7 days without connections. Data is kept; resume with `POST /api/v1/databases/{database_id}/resume`.\n- `failed`: provisioning did not complete.\n- `deleting`, `deleted`: being deleted, deleted.\n","uniqueKey":"database.status","typeLabel":"enum\u003cstring>"},"status_message":{"type":"string","description":"Plain-words detail for `warning`, `resizing` and `failed`","uniqueKey":"database.status_message","typeLabel":"string"},"region":{"type":"string","enum":["us-east"],"description":"Data center region","example":"us-east","uniqueKey":"database.region","typeLabel":"enum\u003cstring>"},"plan_id":{"type":"integer","description":"Pricing plan ID (see `GET /api/v1/databases/plans`)","example":5,"uniqueKey":"database.plan_id","typeLabel":"integer"},"storage_gb":{"type":"integer","description":"Provisioned storage in GB. Storage above the plan's included storage is billed per GB per month (`storage_pricing` in `GET /api/v1/databases/plans`, $0.15 today).","example":25,"uniqueKey":"database.storage_gb","typeLabel":"integer"},"ha_enabled":{"type":"boolean","description":"High availability: copies on separate servers that take over automatically on failure. PostgreSQL and Valkey run a primary and a standby, ClickHouse two replicas, MySQL a 3-node cluster, Kafka 3 brokers. Adds 70% of the plan price for PostgreSQL, Valkey and ClickHouse, 140% for MySQL and Kafka (`ha_pricing` in `GET /api/v1/databases/plans`).\n","uniqueKey":"database.ha_enabled","typeLabel":"boolean"},"replica_count":{"type":"integer","description":"Number of read replicas (PostgreSQL only; 0 for other engines). Each costs the same as the plan.","example":0,"uniqueKey":"database.replica_count","typeLabel":"integer"},"vpc_id":{"type":"string","description":"VPC the private endpoint is attached to (empty if not yet connected)","uniqueKey":"database.vpc_id","typeLabel":"string"},"public_access":{"type":"boolean","description":"Whether public access is enabled","uniqueKey":"database.public_access","typeLabel":"boolean"},"connection_host":{"type":"string","description":"Private endpoint hostname, resolvable inside the attached VPC. Use it only when `vpc_id` is set; without a VPC the database has no private address you can reach.","example":"a1b2c3d4.db.raffusercloud.com","uniqueKey":"database.connection_host","typeLabel":"string"},"connection_port":{"type":"integer","description":"Private endpoint port. PostgreSQL: 5432 direct; the pooler (PgBouncer, transaction mode) is on 6432 of the same host. MySQL: 3306. Valkey: 6379. ClickHouse: 8443 (HTTPS), 9440 (native). Kafka: 9092. Use TLS: databases created from October 13, 2026 refuse unencrypted connections.","example":5432,"uniqueKey":"database.connection_port","typeLabel":"integer"},"billing_type":{"type":"string","enum":["payg","subscription"],"description":"Billing type for this database","example":"payg","uniqueKey":"database.billing_type","typeLabel":"enum\u003cstring>"},"subscription_id":{"type":"string","description":"Subscription ID if billing_type is subscription (empty otherwise)","uniqueKey":"database.subscription_id","typeLabel":"string"},"price_per_hour":{"type":"number","description":"Hourly billing rate in USD","example":0.010945,"uniqueKey":"database.price_per_hour","typeLabel":"number"},"monthly_price":{"type":"number","description":"Monthly price in USD","example":7.99,"uniqueKey":"database.monthly_price","typeLabel":"number"},"public_port":{"type":"integer","description":"The database's own public port on `public_dns_hostname`; `0` when public access is off. For PostgreSQL and ClickHouse, `public_port` and `public_port + 1` (PostgreSQL: pooled and direct; ClickHouse: HTTPS and native). PostgreSQL is also reachable on the standard ports 6543 (pooled) and 5432 (direct), routed by the hostname the client sends over TLS; use `public_port` for old clients that do not send it. The port stays the same when public access is turned off and on again.\n","example":20104,"uniqueKey":"database.public_port","typeLabel":"integer"},"public_dns_hostname":{"type":"string","description":"Public endpoint hostname (empty when public access is off)","example":"a1b2c3d4.public.db.raffusercloud.com","uniqueKey":"database.public_dns_hostname","typeLabel":"string"},"public_allowlist":{"type":"array","items":{"type":"string","uniqueKey":"database.public_allowlist.items.[INDEX]","typeLabel":"string"},"description":"Source CIDRs allowed on the public endpoint. Empty = allow all sources.","example":["203.0.113.0/24"],"uniqueKey":"database.public_allowlist","typeLabel":"string[]"},"is_free":{"type":"boolean","description":"True for a free-tier database. Free databases pause after 7 days without connections.","uniqueKey":"database.is_free","typeLabel":"boolean"},"suspended_at":{"type":"string","description":"When a free-tier database was paused for idleness, RFC 3339 (empty when not paused)","uniqueKey":"database.suspended_at","typeLabel":"string"},"down_since":{"type":"string","description":"When the database stopped answering, RFC 3339 (empty while it answers). Set with status `warning`.","uniqueKey":"database.down_since","typeLabel":"string"},"metrics":{"oneOf":[{"type":"object","description":"Latest live numbers, sampled every minute. `null` until the first sample.","properties":{"connections_active":{"type":"integer","uniqueKey":"database.metrics.oneOf.0.connections_active","typeLabel":"integer"},"connections_max":{"type":"integer","uniqueKey":"database.metrics.oneOf.0.connections_max","typeLabel":"integer"},"pooled_connections_active":{"type":"integer","description":"PostgreSQL pooler","uniqueKey":"database.metrics.oneOf.0.pooled_connections_active","typeLabel":"integer"},"pooled_connections_max":{"type":"integer","description":"PostgreSQL pooler","uniqueKey":"database.metrics.oneOf.0.pooled_connections_max","typeLabel":"integer"},"storage_used_bytes":{"type":"integer","uniqueKey":"database.metrics.oneOf.0.storage_used_bytes","typeLabel":"integer"},"storage_capacity_bytes":{"type":"integer","uniqueKey":"database.metrics.oneOf.0.storage_capacity_bytes","typeLabel":"integer"},"ops_per_sec":{"type":"number","description":"Transactions (PostgreSQL), queries (MySQL, ClickHouse) or commands (Valkey) per second","uniqueKey":"database.metrics.oneOf.0.ops_per_sec","typeLabel":"number"},"cache_hit_pct":{"type":"number","uniqueKey":"database.metrics.oneOf.0.cache_hit_pct","typeLabel":"number"},"metrics_updated_at":{"type":"string","description":"When the numbers were sampled, RFC 3339","uniqueKey":"database.metrics.oneOf.0.metrics_updated_at","typeLabel":"string"}},"uniqueKey":"database.metrics.oneOf.0","typeLabel":"object"},{"type":"null","description":"Latest live numbers, sampled every minute. `null` until the first sample.","properties":{"connections_active":{"type":"integer"},"connections_max":{"type":"integer"},"pooled_connections_active":{"type":"integer","description":"PostgreSQL pooler"},"pooled_connections_max":{"type":"integer","description":"PostgreSQL pooler"},"storage_used_bytes":{"type":"integer"},"storage_capacity_bytes":{"type":"integer"},"ops_per_sec":{"type":"number","description":"Transactions (PostgreSQL), queries (MySQL, ClickHouse) or commands (Valkey) per second"},"cache_hit_pct":{"type":"number"},"metrics_updated_at":{"type":"string","description":"When the numbers were sampled, RFC 3339"}},"uniqueKey":"database.metrics.oneOf.1","typeLabel":"null"}],"uniqueKey":"database.metrics","typeLabel":"object | null"},"created_at":{"type":"string","format":"date-time","uniqueKey":"database.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"database.updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"database","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"database":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","database_id":"\u003cstring>","project_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"orders-db","engine":"postgres","engine_version":"16","server_version":"16.10","status":"pending","status_message":"\u003cstring>","region":"us-east","plan_id":5,"storage_gb":25,"ha_enabled":true,"replica_count":0,"vpc_id":"\u003cstring>","public_access":true,"connection_host":"a1b2c3d4.db.raffusercloud.com","connection_port":5432,"billing_type":"payg","subscription_id":"\u003cstring>","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"],"is_free":true,"suspended_at":"\u003cstring>","down_since":"\u003cstring>","metrics":{"connections_active":123,"connections_max":123,"pooled_connections_active":123,"pooled_connections_max":123,"storage_used_bytes":123,"storage_capacity_bytes":123,"ops_per_sec":123,"cache_hit_pct":123,"metrics_updated_at":"\u003cstring>"},"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"c77ee2aa-2436-456f-9862-f9b42020ee52":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"412f9ccd-d5c2-427b-bba3-ea6a6ae1fc29":{"description":"Authentication required","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"a5ced37c-c215-4911-b09e-fa7adffa0b36":{"description":"Account balance is insufficient for this operation. Top up the balance and retry.\n","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"Payment Required","message":"Insufficient balance for subscription"},"examples":{"Example":{"title":"Example","value":{"error":"Payment Required","message":"Insufficient balance for subscription"}}},"exampleType":"examples"}},"exampleType":"examples"},"45a68486-bec0-41a3-9b17-f6307a17bdaa":{"description":"Billing validation failed. The account is not in good standing.\nCheck the `reason` field:\n- `banned` — account suspended\n- `failed` — last payment failed; top up the account balance\n- `no_billing_customer` — billing not set up\n","content":{"application/json":{"schema":{"type":"object","description":"Billing validation error response. Returned when the account is not in good standing for paid operations.","required":["error","reason"],"properties":{"error":{"type":"string","example":"Billing validation failed","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"reason":{"type":"string","description":"Machine-readable reason code:\n- `banned` — account has been suspended\n- `failed` — last payment failed; balance top-up needed\n- `no_billing_customer` — billing has not been set up for this account\n","enum":["banned","failed","no_billing_customer"],"isRequired":true,"uniqueKey":"reason","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"Payment failed. Please update your payment method.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Billing validation failed","reason":"banned","message":"Payment failed. Please update your payment method."}}},"exampleType":"generated"}},"exampleType":"generated"},"4491ee94-b022-4f88-9c4b-6c0791235014":{"description":"Conflicts with what exists, for example a name already in use","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"326ac752-5310-476b-a513-6351e014d53d":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key for authentication. Each key is bound to a specific account.","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"6789a6e5-e415-4c99-8fcb-6cd793ffdcee":{"url":"https://api.rafftechnologies.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key for authentication. Each key is bound to a specific account.","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"X-API-Key","type":"string","description":"API key for authentication. Each key is bound to a specific account.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-API-Key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"rafftechnologiesllc","siteName":"Raff","title":"Create database - Raff","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T17:27:18.289Z","gitLastModified":"2026-10-05T15:04:14.000Z","originalFileLocation":"api-reference/databases/create-database.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create a managed database. Before creating a database, you need: - A plan ID from List database plans. The free plan is marked is_free_tier; one free database per account. - Optionally an engine version from List database engines. Omit it for the newest. - A project ID in X-Project-ID from List projects. - Optionally a VPC ID for a private endpoint. Provisioning is asynchronous: the database is created in status pending and moves through deploying to running. Poll GET /api/v1/databases/{database_id} for progress. A free PostgreSQL or MySQL database is usually running within seconds. With public_access: true, running means the public address already accepts connections. ## Networking Databases live on private VPC networking by default. Set vpc_id to place the private endpoint ({database_id}.db.raffusercloud.com) inside an existing VPC, or attach a VPC later via POST /api/v1/databases/{database_id}/vpc. Public access is optional and off by default. TLS is always required. ## Engines - PostgreSQL: pooled endpoint on port 6432 (PgBouncer, transaction mode) plus a direct endpoint on 5432. Nightly base backup with continuous WAL archiving for point-in-time restore. - MySQL: TLS endpoint on port 3306. Nightly backups plus on-demand backups. - Valkey: single TLS endpoint on port 6379. Nightly RDB snapshots plus on-demand snapshots. No read replicas; high availability adds a standby with automatic Sentinel failover. - ClickHouse and Kafka: see the engine catalog for versions. Kafka clients must trust the ca_cert returned by the connection endpoint. ## Pricing The plan sets the base price. High availability adds 70% of the plan price for PostgreSQL, Valkey and ClickHouse, 210% for MySQL and 140% for Kafka. Each PostgreSQL read replica costs the plan price. Storage above the plan\u0026#x27;s included storage is $0.15/GB/month. The same numbers are in GET /api/v1/databases/plans and, without authentication, GET /api/v1/public/pricing/database. ## Errors - 409: the name is taken in this project, or the account already has a free database. - 412: ha_enabled on a plan that has no room for high availability right now (MySQL; see ha_available in GET /api/v1/databases/plans). Nothing is created or charged: pick a smaller plan, or create the database without high availability. - 402: a paid plan on a monthly account without a card that can be charged automatically. The response links to the dashboard to add one. - 403: the account\u0026#x27;s billing status or your role does not allow creating databases. ## Billing - Free plan: no charge and no card needed. One free database per account. - Paid plan: a monthly subscription, the same as buying the database in the dashboard. The account needs a card that can be charged automatically, or the create is refused with 402 and a link to add one. The first month is charged within seconds of the create, from the account balance first and then the card. - Accounts on pay-as-you-go billing are billed by the hour instead.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Raff\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/rafftechnologiesllc/81XTCmJ0Yt4lOC7_/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/rafftechnologiesllc/81XTCmJ0Yt4lOC7_/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/rafftechnologiesllc/81XTCmJ0Yt4lOC7_/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/rafftechnologiesllc/81XTCmJ0Yt4lOC7_/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/rafftechnologiesllc/81XTCmJ0Yt4lOC7_/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/rafftechnologiesllc/81XTCmJ0Yt4lOC7_/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/rafftechnologiesllc/81XTCmJ0Yt4lOC7_/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/rafftechnologiesllc/81XTCmJ0Yt4lOC7_/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/rafftechnologiesllc/81XTCmJ0Yt4lOC7_/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create database - Raff\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a managed database. Before creating a database, you need: - A plan ID from List database plans. The free plan is marked is_free_tier; one free database per account. - Optionally an engine version from List database engines. Omit it for the newest. - A project ID in X-Project-ID from List projects. - Optionally a VPC ID for a private endpoint. Provisioning is asynchronous: the database is created in status pending and moves through deploying to running. Poll GET /api/v1/databases/{database_id} for progress. A free PostgreSQL or MySQL database is usually running within seconds. With public_access: true, running means the public address already accepts connections. ## Networking Databases live on private VPC networking by default. Set vpc_id to place the private endpoint ({database_id}.db.raffusercloud.com) inside an existing VPC, or attach a VPC later via POST /api/v1/databases/{database_id}/vpc. Public access is optional and off by default. TLS is always required. ## Engines - PostgreSQL: pooled endpoint on port 6432 (PgBouncer, transaction mode) plus a direct endpoint on 5432. Nightly base backup with continuous WAL archiving for point-in-time restore. - MySQL: TLS endpoint on port 3306. Nightly backups plus on-demand backups. - Valkey: single TLS endpoint on port 6379. Nightly RDB snapshots plus on-demand snapshots. No read replicas; high availability adds a standby with automatic Sentinel failover. - ClickHouse and Kafka: see the engine catalog for versions. Kafka clients must trust the ca_cert returned by the connection endpoint. ## Pricing The plan sets the base price. High availability adds 70% of the plan price for PostgreSQL, Valkey and ClickHouse, 210% for MySQL and 140% for Kafka. Each PostgreSQL read replica costs the plan price. Storage above the plan\u0026#x27;s included storage is $0.15/GB/month. The same numbers are in GET /api/v1/databases/plans and, without authentication, GET /api/v1/public/pricing/database. ## Errors - 409: the name is taken in this project, or the account already has a free database. - 412: ha_enabled on a plan that has no room for high availability right now (MySQL; see ha_available in GET /api/v1/databases/plans). Nothing is created or charged: pick a smaller plan, or create the database without high availability. - 402: a paid plan on a monthly account without a card that can be charged automatically. The response links to the dashboard to add one. - 403: the account\u0026#x27;s billing status or your role does not allow creating databases. ## Billing - Free plan: no charge and no card needed. One free database per account. - Paid plan: a monthly subscription, the same as buying the database in the dashboard. The account needs a card that can be charged automatically, or the create is refused with 402 and a link to add one. The first month is charged within seconds of the create, from the account balance first and then the card. - Accounts on pay-as-you-go billing are billed by the hour instead.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Raff\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.rafftechnologies.com/api-reference/databases/create-database\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://rafftechnologies.com/images/og.jpg\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create database - Raff\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a managed database. Before creating a database, you need: - A plan ID from List database plans. The free plan is marked is_free_tier; one free database per account. - Optionally an engine version from List database engines. Omit it for the newest. - A project ID in X-Project-ID from List projects. - Optionally a VPC ID for a private endpoint. Provisioning is asynchronous: the database is created in status pending and moves through deploying to running. Poll GET /api/v1/databases/{database_id} for progress. A free PostgreSQL or MySQL database is usually running within seconds. With public_access: true, running means the public address already accepts connections. ## Networking Databases live on private VPC networking by default. Set vpc_id to place the private endpoint ({database_id}.db.raffusercloud.com) inside an existing VPC, or attach a VPC later via POST /api/v1/databases/{database_id}/vpc. Public access is optional and off by default. TLS is always required. ## Engines - PostgreSQL: pooled endpoint on port 6432 (PgBouncer, transaction mode) plus a direct endpoint on 5432. Nightly base backup with continuous WAL archiving for point-in-time restore. - MySQL: TLS endpoint on port 3306. Nightly backups plus on-demand backups. - Valkey: single TLS endpoint on port 6379. Nightly RDB snapshots plus on-demand snapshots. No read replicas; high availability adds a standby with automatic Sentinel failover. - ClickHouse and Kafka: see the engine catalog for versions. Kafka clients must trust the ca_cert returned by the connection endpoint. ## Pricing The plan sets the base price. High availability adds 70% of the plan price for PostgreSQL, Valkey and ClickHouse, 210% for MySQL and 140% for Kafka. Each PostgreSQL read replica costs the plan price. Storage above the plan\u0026#x27;s included storage is $0.15/GB/month. The same numbers are in GET /api/v1/databases/plans and, without authentication, GET /api/v1/public/pricing/database. ## Errors - 409: the name is taken in this project, or the account already has a free database. - 412: ha_enabled on a plan that has no room for high availability right now (MySQL; see ha_available in GET /api/v1/databases/plans). Nothing is created or charged: pick a smaller plan, or create the database without high availability. - 402: a paid plan on a monthly account without a card that can be charged automatically. The response links to the dashboard to add one. - 403: the account\u0026#x27;s billing status or your role does not allow creating databases. ## Billing - Free plan: no charge and no card needed. One free database per account. - Paid plan: a monthly subscription, the same as buying the database in the dashboard. The account needs a card that can be charged automatically, or the create is refused with 402 and a link to add one. The first month is charged within seconds of the create, from the account balance first and then the card. - Accounts on pay-as-you-go billing are billed by the hour instead.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://rafftechnologies.com/images/og.jpg\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/rafftechnologiesllc/81XTCmJ0Yt4lOC7_/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Raff\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#E43D12\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.rafftechnologies.com/api-reference/databases/create-database\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/databases/create-database.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.rafftechnologies.com/#organization\",\"name\":\"Raff\",\"url\":\"https://docs.rafftechnologies.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/rafftechnologiesllc/-fGNhyEGXJeJV5ed/logo/light.svg?fit=max\u0026auto=format\u0026n=-fGNhyEGXJeJV5ed\u0026q=85\u0026s=0e81ca868d348265df3068ed9c0d9769\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.rafftechnologies.com#website\",\"name\":\"Raff\",\"url\":\"https://docs.rafftechnologies.com\",\"publisher\":{\"@id\":\"https://docs.rafftechnologies.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.rafftechnologies.com/api-reference/databases/create-database#webpage\",\"url\":\"https://docs.rafftechnologies.com/api-reference/databases/create-database\",\"name\":\"Create database\",\"description\":\"Create a managed database. Before creating a database, you need: - A plan ID from List database plans. The free plan is marked is_free_tier; one free database per account. - Optionally an engine version from List database engines. Omit it for the newest. - A project ID in X-Project-ID from List projects. - Optionally a VPC ID for a private endpoint. Provisioning is asynchronous: the database is created in status pending and moves through deploying to running. Poll GET /api/v1/databases/{database_id} for progress. A free PostgreSQL or MySQL database is usually running within seconds. With public_access: true, running means the public address already accepts connections. ## Networking Databases live on private VPC networking by default. Set vpc_id to place the private endpoint ({database_id}.db.raffusercloud.com) inside an existing VPC, or attach a VPC later via POST /api/v1/databases/{database_id}/vpc. Public access is optional and off by default. TLS is always required. ## Engines - PostgreSQL: pooled endpoint on port 6432 (PgBouncer, transaction mode) plus a direct endpoint on 5432. Nightly base backup with continuous WAL archiving for point-in-time restore. - MySQL: TLS endpoint on port 3306. Nightly backups plus on-demand backups. - Valkey: single TLS endpoint on port 6379. Nightly RDB snapshots plus on-demand snapshots. No read replicas; high availability adds a standby with automatic Sentinel failover. - ClickHouse and Kafka: see the engine catalog for versions. Kafka clients must trust the ca_cert returned by the connection endpoint. ## Pricing The plan sets the base price. High availability adds 70% of the plan price for PostgreSQL, Valkey and ClickHouse, 210% for MySQL and 140% for Kafka. Each PostgreSQL read replica costs the plan price. Storage above the plan's included storage is $0.15/GB/month. The same numbers are in GET /api/v1/databases/plans and, without authentication, GET /api/v1/public/pricing/database. ## Errors - 409: the name is taken in this project, or the account already has a free database. - 412: ha_enabled on a plan that has no room for high availability right now (MySQL; see ha_available in GET /api/v1/databases/plans). Nothing is created or charged: pick a smaller plan, or create the database without high availability. - 402: a paid plan on a monthly account without a card that can be charged automatically. The response links to the dashboard to add one. - 403: the account's billing status or your role does not allow creating databases. ## Billing - Free plan: no charge and no card needed. One free database per account. - Paid plan: a monthly subscription, the same as buying the database in the dashboard. The account needs a card that can be charged automatically, or the create is refused with 402 and a link to add one. The first month is charged within seconds of the create, from the account balance first and then the card. - Accounts on pay-as-you-go billing are billed by the hour instead.\",\"dateModified\":\"2026-10-05T15:04:14.000Z\",\"isPartOf\":{\"@id\":\"https://docs.rafftechnologies.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.rafftechnologies.com/api-reference/databases/create-database#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.rafftechnologies.com/api-reference/databases/create-database#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"REST API\",\"item\":\"https://docs.rafftechnologies.com/api-reference/endpoints\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Managed Databases\",\"item\":\"https://docs.rafftechnologies.com/api-reference/databases/list-database-engines\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Databases\",\"item\":\"https://docs.rafftechnologies.com/api-reference/databases/list-database-engines\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Create database\",\"item\":\"https://docs.rafftechnologies.com/api-reference/databases/create-database\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.rafftechnologies.com/api-reference/databases/create-database#apireference\",\"headline\":\"Create database\",\"name\":\"Create database\",\"description\":\"Create a managed database. Before creating a database, you need: - A plan ID from List database plans. The free plan is marked is_free_tier; one free database per account. - Optionally an engine version from List database engines. Omit it for the newest. - A project ID in X-Project-ID from List projects. - Optionally a VPC ID for a private endpoint. Provisioning is asynchronous: the database is created in status pending and moves through deploying to running. Poll GET /api/v1/databases/{database_id} for progress. A free PostgreSQL or MySQL database is usually running within seconds. With public_access: true, running means the public address already accepts connections. ## Networking Databases live on private VPC networking by default. Set vpc_id to place the private endpoint ({database_id}.db.raffusercloud.com) inside an existing VPC, or attach a VPC later via POST /api/v1/databases/{database_id}/vpc. Public access is optional and off by default. TLS is always required. ## Engines - PostgreSQL: pooled endpoint on port 6432 (PgBouncer, transaction mode) plus a direct endpoint on 5432. Nightly base backup with continuous WAL archiving for point-in-time restore. - MySQL: TLS endpoint on port 3306. Nightly backups plus on-demand backups. - Valkey: single TLS endpoint on port 6379. Nightly RDB snapshots plus on-demand snapshots. No read replicas; high availability adds a standby with automatic Sentinel failover. - ClickHouse and Kafka: see the engine catalog for versions. Kafka clients must trust the ca_cert returned by the connection endpoint. ## Pricing The plan sets the base price. High availability adds 70% of the plan price for PostgreSQL, Valkey and ClickHouse, 210% for MySQL and 140% for Kafka. Each PostgreSQL read replica costs the plan price. Storage above the plan's included storage is $0.15/GB/month. The same numbers are in GET /api/v1/databases/plans and, without authentication, GET /api/v1/public/pricing/database. ## Errors - 409: the name is taken in this project, or the account already has a free database. - 412: ha_enabled on a plan that has no room for high availability right now (MySQL; see ha_available in GET /api/v1/databases/plans). Nothing is created or charged: pick a smaller plan, or create the database without high availability. - 402: a paid plan on a monthly account without a card that can be charged automatically. The response links to the dashboard to add one. - 403: the account's billing status or your role does not allow creating databases. ## Billing - Free plan: no charge and no card needed. One free database per account. - Paid plan: a monthly subscription, the same as buying the database in the dashboard. The account needs a card that can be charged automatically, or the create is refused with 402 and a link to add one. The first month is charged within seconds of the create, from the account balance first and then the card. - Accounts on pay-as-you-go billing are billed by the hour instead.\",\"url\":\"https://docs.rafftechnologies.com/api-reference/databases/create-database\",\"mainEntityOfPage\":{\"@id\":\"https://docs.rafftechnologies.com/api-reference/databases/create-database#webpage\"},\"image\":\"https://rafftechnologies.com/images/og.jpg\",\"dateModified\":\"2026-10-05T15:04:14.000Z\",\"publisher\":{\"@id\":\"https://docs.rafftechnologies.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.rafftechnologies.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Raff\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Raff\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/databases/create-database.md","siteName":"Raff","nav":{"global":{"anchors":[{"anchor":"Changelog","icon":"clock-rotate-left","href":"/api-reference/changelog"}]},"tabs":[{"tab":"Products","pages":[{"title":"Products","href":"/products"}]},{"tab":"Reference","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Quickstart","href":"/quickstart"},{"title":"Authentication","href":"/authentication"}]},{"group":"Guides","pages":[{"title":"Create Your First VM","href":"/guides/create-your-first-vm"}]},{"group":"REST API","pages":[{"title":"All Endpoints","href":"/api-reference/endpoints"},{"group":"Catalog","pages":[{"title":"List Regions","openapi":"GET /api/v1/public/regions","href":"/api-reference/catalog/list-regions"},{"title":"List OS Templates","openapi":"GET /api/v1/public/templates","href":"/api-reference/catalog/list-templates"},{"title":"List VM Pricing","openapi":"GET /api/v1/public/pricing/vm","href":"/api-reference/catalog/list-vm-pricing"},{"title":"Get Volume Pricing","openapi":"GET /api/v1/public/pricing/volume","href":"/api-reference/catalog/list-volume-pricing"},{"title":"Get Snapshot Pricing","openapi":"GET /api/v1/public/pricing/snapshot","href":"/api-reference/catalog/list-snapshot-pricing"},{"title":"Get Backup Pricing","openapi":"GET /api/v1/public/pricing/backup","href":"/api-reference/catalog/list-backup-pricing"},{"title":"Get IP Pricing","openapi":"GET /api/v1/public/pricing/ip","href":"/api-reference/catalog/list-ip-pricing"},{"title":"Get VPN Pricing","openapi":"GET /api/v1/public/pricing/vpn","href":"/api-reference/catalog/list-vpn-pricing"},{"title":"List Database Pricing","openapi":"GET /api/v1/public/pricing/database","href":"/api-reference/catalog/list-database-pricing"},{"title":"List Kubernetes Pricing","openapi":"GET /api/v1/public/pricing/kubernetes","href":"/api-reference/catalog/list-kubernetes-pricing"}]},{"group":"Projects","pages":[{"title":"List Projects","openapi":"GET /api/v1/projects","href":"/api-reference/projects/list-projects"},{"title":"Create Project","openapi":"POST /api/v1/projects","href":"/api-reference/projects/create-project"},{"title":"Get Project","openapi":"GET /api/v1/projects/{id}","href":"/api-reference/projects/get-project"},{"title":"Update Project","openapi":"PUT /api/v1/projects/{id}","href":"/api-reference/projects/update-project"},{"title":"Delete Project","openapi":"DELETE /api/v1/projects/{id}","href":"/api-reference/projects/delete-project"}]},{"group":"Virtual Machines","pages":[{"group":"Lifecycle","pages":[{"title":"List VMs","openapi":"GET /api/v1/vms","href":"/api-reference/endpoint/list-vms"},{"title":"Create VM","openapi":"POST /api/v1/vms","href":"/api-reference/endpoint/create-vm"},{"title":"Get VM","openapi":"GET /api/v1/vms/{id}","href":"/api-reference/endpoint/get-vm"},{"title":"Delete VM","openapi":"DELETE /api/v1/vms/{id}","href":"/api-reference/endpoint/delete-vm"},{"title":"Bulk Delete VMs","openapi":"DELETE /api/v1/vms/bulk","href":"/api-reference/endpoint/bulk-delete-vms"}]},{"group":"Power \u0026 state","pages":[{"title":"Start VM","openapi":"POST /api/v1/vms/{id}/start","href":"/api-reference/endpoint/start-vm"},{"title":"Stop VM","openapi":"POST /api/v1/vms/{id}/stop","href":"/api-reference/endpoint/stop-vm"},{"title":"Reboot VM","openapi":"POST /api/v1/vms/{id}/reboot","href":"/api-reference/endpoint/reboot-vm"},{"title":"Hard reboot VM","openapi":"POST /api/v1/vms/{id}/reboot-hard","href":"/api-reference/endpoint/hard-reboot-vm"},{"title":"Rename VM","openapi":"PATCH /api/v1/vms/{id}/rename","href":"/api-reference/endpoint/rename-vm"},{"title":"Set console access policy","openapi":"PATCH /api/v1/vms/{id}/console-policy","href":"/api-reference/endpoint/set-vm-console-policy"},{"title":"Reset VM Password","openapi":"POST /api/v1/vms/{id}/reset-password","href":"/api-reference/endpoint/reset-vm-password"},{"title":"Reinstall VM","openapi":"POST /api/v1/vms/{id}/reinstall","href":"/api-reference/endpoint/reinstall-vm"},{"title":"Factory Reset VM","openapi":"POST /api/v1/vms/{id}/factory-reset","href":"/api-reference/endpoint/factory-reset-vm"}]},{"group":"SSH keys","pages":[{"title":"List SSH Keys on a VM","openapi":"GET /api/v1/vms/{id}/ssh-keys","href":"/api-reference/endpoint/list-vm-ssh-keys"},{"title":"Add an SSH Key to a VM","openapi":"POST /api/v1/vms/{id}/ssh-keys","href":"/api-reference/endpoint/add-vm-ssh-key"},{"title":"Remove an SSH Key from a VM","openapi":"DELETE /api/v1/vms/{id}/ssh-keys/{fingerprint}","href":"/api-reference/endpoint/remove-vm-ssh-key"}]},{"group":"Resize \u0026 images","pages":[{"title":"Resize VM","openapi":"POST /api/v1/vms/{id}/resize","href":"/api-reference/endpoint/resize-vm"},{"title":"Resize VM Disk","openapi":"POST /api/v1/vms/{id}/disk/resize","href":"/api-reference/endpoint/resize-vm-disk"},{"title":"Save VM disk as custom image","openapi":"POST /api/v1/vms/{id}/save-image","href":"/api-reference/endpoint/save-vm-disk-as-image"}]},{"group":"Tags","pages":[{"title":"List tags","openapi":"GET /api/v1/tags","href":"/api-reference/endpoint/list-tags"},{"title":"Create tag","openapi":"POST /api/v1/tags","href":"/api-reference/endpoint/create-tag"},{"title":"Update tag","openapi":"PATCH /api/v1/tags/{id}","href":"/api-reference/endpoint/update-tag"},{"title":"Delete tag","openapi":"DELETE /api/v1/tags/{id}","href":"/api-reference/endpoint/delete-tag"},{"title":"Add tag to VM","openapi":"POST /api/v1/vms/{id}/tags","href":"/api-reference/endpoint/add-vm-tag"},{"title":"Update VM tag","openapi":"PATCH /api/v1/vms/{id}/tags/{tagId}","href":"/api-reference/endpoint/update-vm-tag"},{"title":"Remove VM tag","openapi":"DELETE /api/v1/vms/{id}/tags/{tagId}","href":"/api-reference/endpoint/remove-vm-tag"},{"title":"Get VM tag firewall","openapi":"GET /api/v1/vms/{id}/tag-firewall","href":"/api-reference/endpoint/get-vm-tag-firewall"}]},{"group":"Notes","pages":[{"title":"Get VM notes","openapi":"GET /api/v1/vms/{id}/notes","href":"/api-reference/endpoint/get-vm-notes"},{"title":"Upsert VM note","openapi":"PUT /api/v1/vms/{id}/notes/{type}","href":"/api-reference/endpoint/upsert-vm-note"},{"title":"Update VM note","openapi":"PATCH /api/v1/vms/{id}/notes/{type}","href":"/api-reference/endpoint/update-vm-note"},{"title":"Append to VM note","openapi":"POST /api/v1/vms/{id}/notes/{type}/append","href":"/api-reference/endpoint/append-vm-note"}]}]},{"group":"Managed Databases","pages":[{"group":"Databases","pages":[{"title":"List database engines","openapi":"GET /api/v1/databases/engines","href":"/api-reference/databases/list-database-engines"},{"title":"List database plans","openapi":"GET /api/v1/databases/plans","href":"/api-reference/databases/list-database-plans"},{"title":"List databases","openapi":"GET /api/v1/databases","description":"List the managed databases of the account, or of one project with `X-Project-ID`.\n\nEach database includes its live numbers in `metrics` (connections, storage, operations per second), sampled every minute; `metrics` is `null` until the first sample.\n","href":"/api-reference/databases/list-databases"},{"title":"Create database","openapi":"POST /api/v1/databases","href":"/api-reference/databases/create-database"},{"title":"Get database","openapi":"GET /api/v1/databases/{database_id}","description":"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`.\n","href":"/api-reference/databases/get-database"},{"title":"Rename database","openapi":"PATCH /api/v1/databases/{database_id}","href":"/api-reference/databases/update-database"},{"title":"Delete database","openapi":"DELETE /api/v1/databases/{database_id}","href":"/api-reference/databases/delete-database"},{"title":"Scale database","openapi":"POST /api/v1/databases/{database_id}/scale","href":"/api-reference/databases/scale-database"},{"title":"Resume a paused database","openapi":"POST /api/v1/databases/{database_id}/resume","href":"/api-reference/databases/resume-database"}]},{"group":"Connect \u0026 access","pages":[{"title":"Get connection details","openapi":"GET /api/v1/databases/{database_id}/connection","href":"/api-reference/databases/get-database-connection"},{"title":"Rotate credentials","openapi":"POST /api/v1/databases/{database_id}/credentials/rotate","href":"/api-reference/databases/rotate-database-credentials"},{"title":"Connect database to VPC","openapi":"POST /api/v1/databases/{database_id}/vpc","href":"/api-reference/databases/connect-database-v-p-c"},{"title":"Disconnect database from VPC","openapi":"DELETE /api/v1/databases/{database_id}/vpc","href":"/api-reference/databases/disconnect-database-v-p-c"},{"title":"Set public access","openapi":"POST /api/v1/databases/{database_id}/public-access","href":"/api-reference/databases/set-database-public-access"},{"title":"List database users","openapi":"GET /api/v1/databases/{database_id}/users","href":"/api-reference/databases/list-database-users"},{"title":"Create database user","openapi":"POST /api/v1/databases/{database_id}/users","href":"/api-reference/databases/create-database-user"},{"title":"Rotate database user password","openapi":"POST /api/v1/databases/{database_id}/users/{name}/rotate","href":"/api-reference/databases/rotate-database-user"},{"title":"Get database user password","openapi":"GET /api/v1/databases/{database_id}/users/{name}/credential","href":"/api-reference/databases/get-database-user-credential"},{"title":"Delete database user","openapi":"DELETE /api/v1/databases/{database_id}/users/{name}","href":"/api-reference/databases/delete-database-user"}]},{"group":"Query \u0026 data","pages":[{"title":"Run a query","openapi":"POST /api/v1/databases/{database_id}/console","href":"/api-reference/databases/run-database-query"},{"title":"Browse schemas, tables, and keys","openapi":"POST /api/v1/databases/{database_id}/browse","href":"/api-reference/databases/browse-database"},{"title":"List saved queries","openapi":"GET /api/v1/databases/{database_id}/saved-queries","href":"/api-reference/databases/list-database-saved-queries"},{"title":"Save a query","openapi":"PUT /api/v1/databases/{database_id}/saved-queries","href":"/api-reference/databases/save-database-saved-query"},{"title":"Delete a saved query","openapi":"DELETE /api/v1/databases/{database_id}/saved-queries/{name}","href":"/api-reference/databases/delete-database-saved-query"}]},{"group":"Backups \u0026 restore","pages":[{"title":"List backups","openapi":"GET /api/v1/databases/{database_id}/backups","href":"/api-reference/databases/list-database-backups"},{"title":"Create backup","openapi":"POST /api/v1/databases/{database_id}/backups","href":"/api-reference/databases/create-database-backup"},{"title":"Restore database","openapi":"POST /api/v1/databases/{database_id}/restore","href":"/api-reference/databases/restore-database"}]},{"group":"Observability","pages":[{"title":"Get metrics","openapi":"GET /api/v1/databases/{database_id}/metrics","href":"/api-reference/databases/get-database-metrics"},{"title":"Get metrics history","openapi":"GET /api/v1/databases/{database_id}/metrics/history","href":"/api-reference/databases/get-database-metrics-history"},{"title":"Get traffic by client","openapi":"GET /api/v1/databases/{database_id}/metrics/clients","href":"/api-reference/databases/get-database-client-traffic"},{"title":"Get slow queries","openapi":"GET /api/v1/databases/{database_id}/slow-queries","href":"/api-reference/databases/get-database-slow-queries"},{"title":"Get logs","openapi":"GET /api/v1/databases/{database_id}/logs","href":"/api-reference/databases/get-database-logs"}]},{"group":"Configuration","pages":[{"title":"List extensions","openapi":"GET /api/v1/databases/{database_id}/extensions","href":"/api-reference/databases/list-database-extensions"},{"title":"Enable or disable extension","openapi":"POST /api/v1/databases/{database_id}/extensions","href":"/api-reference/databases/set-database-extension"},{"title":"List engine parameters","openapi":"GET /api/v1/databases/{database_id}/parameters","href":"/api-reference/databases/list-database-parameters"},{"title":"List apps and functions using the database","openapi":"GET /api/v1/databases/{database_id}/consumers","href":"/api-reference/databases/list-database-consumers"}]}]},{"group":"Raff Apps","pages":[{"group":"Services","pages":[{"title":"List app services","openapi":"GET /api/v1/apps/services","href":"/api-reference/apps/list-app-services"},{"title":"Create app service","openapi":"POST /api/v1/apps/services","href":"/api-reference/apps/create-app-service"},{"title":"Get app service","openapi":"GET /api/v1/apps/services/{service_id}","href":"/api-reference/apps/get-app-service"},{"title":"Update app service","openapi":"PATCH /api/v1/apps/services/{service_id}","href":"/api-reference/apps/update-app-service"},{"title":"Delete app service","openapi":"DELETE /api/v1/apps/services/{service_id}","href":"/api-reference/apps/delete-app-service"},{"title":"Pause app service","openapi":"POST /api/v1/apps/services/{service_id}/pause","href":"/api-reference/apps/pause-app-service"},{"title":"Resume app service","openapi":"POST /api/v1/apps/services/{service_id}/resume","href":"/api-reference/apps/resume-app-service"},{"title":"Scale app service","openapi":"POST /api/v1/apps/services/{service_id}/scale","href":"/api-reference/apps/scale-app-service"},{"title":"List app templates","openapi":"GET /api/v1/apps/templates","href":"/api-reference/apps/list-app-templates"},{"title":"List GitHub connections","openapi":"GET /api/v1/apps/github/installations","href":"/api-reference/apps/list-app-github-connections"}]},{"group":"Deployments","pages":[{"title":"Request source upload URL","openapi":"POST /api/v1/apps/services/{service_id}/source-upload","href":"/api-reference/apps/request-app-source-upload"},{"title":"List deployments","openapi":"GET /api/v1/apps/services/{service_id}/deployments","href":"/api-reference/apps/list-app-deployments"},{"title":"Create deployment","openapi":"POST /api/v1/apps/services/{service_id}/deployments","href":"/api-reference/apps/create-app-deployment"},{"title":"Get deployment","openapi":"GET /api/v1/apps/deployments/{deployment_id}","href":"/api-reference/apps/get-app-deployment"},{"title":"Get deployment build logs","openapi":"GET /api/v1/apps/deployments/{deployment_id}/logs","href":"/api-reference/apps/get-app-deployment-logs"},{"title":"Roll back to a deployment","openapi":"POST /api/v1/apps/services/{service_id}/rollback","href":"/api-reference/apps/rollback-app-service"}]},{"group":"Observability","pages":[{"title":"List runtime logs","openapi":"GET /api/v1/apps/services/{service_id}/logs","href":"/api-reference/apps/list-app-logs"},{"title":"Get service metrics","openapi":"GET /api/v1/apps/services/{service_id}/metrics","href":"/api-reference/apps/get-app-service-metrics"},{"title":"List app events","openapi":"GET /api/v1/apps/services/{service_id}/events","href":"/api-reference/apps/list-app-events"},{"title":"List app instances","openapi":"GET /api/v1/apps/services/{service_id}/instances","href":"/api-reference/apps/list-app-instances"}]},{"group":"Environment variables","pages":[{"title":"List environment variables","openapi":"GET /api/v1/apps/services/{service_id}/env","href":"/api-reference/apps/list-app-env-vars"},{"title":"List environment variables with values","openapi":"GET /api/v1/apps/services/{service_id}/env/reveal","href":"/api-reference/apps/reveal-app-env-vars"},{"title":"Set environment variable","openapi":"PUT /api/v1/apps/services/{service_id}/env","href":"/api-reference/apps/set-app-env-var"},{"title":"Bulk set environment variables","openapi":"PUT /api/v1/apps/services/{service_id}/env/bulk","href":"/api-reference/apps/bulk-set-app-env-vars"},{"title":"Delete environment variable","openapi":"DELETE /api/v1/apps/services/{service_id}/env/{key}","href":"/api-reference/apps/delete-app-env-var"}]},{"group":"Custom domains","pages":[{"title":"List custom domains","openapi":"GET /api/v1/apps/services/{service_id}/domains","href":"/api-reference/apps/list-app-custom-domains"},{"title":"Add custom domain","openapi":"POST /api/v1/apps/services/{service_id}/domains","href":"/api-reference/apps/add-app-custom-domain"},{"title":"Delete custom domain","openapi":"DELETE /api/v1/apps/domains/{domain_id}","href":"/api-reference/apps/delete-app-custom-domain"},{"title":"Retry domain verification","openapi":"POST /api/v1/apps/domains/{domain_id}/retry","href":"/api-reference/apps/retry-app-domain-verification"}]},{"group":"Database links","pages":[{"title":"List database links","openapi":"GET /api/v1/apps/services/{service_id}/bindings","href":"/api-reference/apps/list-app-bindings"},{"title":"Link a database to an app","openapi":"POST /api/v1/apps/services/{service_id}/bindings","href":"/api-reference/apps/create-app-binding"},{"title":"Unlink a database","openapi":"DELETE /api/v1/apps/bindings/{binding_id}","href":"/api-reference/apps/delete-app-binding"},{"title":"Rotate a link's password","openapi":"POST /api/v1/apps/bindings/{binding_id}/rotate","href":"/api-reference/apps/rotate-app-binding"}]},{"group":"Previews","pages":[{"title":"List pull request previews","openapi":"GET /api/v1/apps/services/{service_id}/previews","href":"/api-reference/apps/list-app-previews"},{"title":"Delete a preview","openapi":"DELETE /api/v1/apps/previews/{preview_id}","href":"/api-reference/apps/delete-app-preview"},{"title":"Redeploy a preview","openapi":"POST /api/v1/apps/previews/{preview_id}/redeploy","href":"/api-reference/apps/redeploy-app-preview"}]},{"group":"Jobs","pages":[{"title":"Trigger a manual job run","openapi":"POST /api/v1/apps/services/{service_id}/jobs/run","href":"/api-reference/apps/run-app-job"},{"title":"List job runs","openapi":"GET /api/v1/apps/services/{service_id}/jobs/runs","href":"/api-reference/apps/list-app-job-runs"},{"title":"Cancel a job run","openapi":"POST /api/v1/apps/jobs/runs/{run_id}/cancel","href":"/api-reference/apps/cancel-app-job-run"}]},{"group":"Billing \u0026 tiers","pages":[{"title":"List Apps tiers","openapi":"GET /api/v1/apps/tiers","href":"/api-reference/apps/list-app-tiers"},{"title":"Get Apps usage","openapi":"GET /api/v1/apps/usage","href":"/api-reference/apps/get-apps-usage"},{"title":"Get spend cap settings","openapi":"GET /api/v1/apps/spend-settings","href":"/api-reference/apps/get-app-spend-settings"},{"title":"Update spend cap settings","openapi":"PATCH /api/v1/apps/spend-settings","href":"/api-reference/apps/update-app-spend-settings"}]}]},{"group":"Networking","pages":[{"group":"VPCs","pages":[{"title":"List VPCs","openapi":"GET /api/v1/vpcs","href":"/api-reference/endpoint/list-vpcs"},{"title":"Create VPC","openapi":"POST /api/v1/vpcs","href":"/api-reference/endpoint/create-vpc"},{"title":"Get VPC","openapi":"GET /api/v1/vpcs/{id}","href":"/api-reference/endpoint/get-vpc"},{"title":"Update VPC","openapi":"PUT /api/v1/vpcs/{id}","href":"/api-reference/endpoint/update-vpc"},{"title":"Delete VPC","openapi":"DELETE /api/v1/vpcs/{id}","href":"/api-reference/endpoint/delete-vpc"},{"title":"Suggest CIDR blocks for new VPCs","openapi":"GET /api/v1/vpcs/cidr-suggestions","href":"/api-reference/endpoint/list-vpc-cidr-suggestions"}]},{"group":"Public IPs","pages":[{"title":"List floating IPs","openapi":"GET /api/v1/ips","href":"/api-reference/endpoint/list-ips"},{"title":"Reserve a floating IP","openapi":"POST /api/v1/ips/reserve","href":"/api-reference/endpoint/reserve-ip"},{"title":"Get floating IP","openapi":"GET /api/v1/ips/{id}","href":"/api-reference/endpoint/get-ip"},{"title":"Release a reserved IP","openapi":"DELETE /api/v1/ips/{id}/reserve","href":"/api-reference/endpoint/release-ip"},{"title":"Change reserved IP","openapi":"POST /api/v1/ips/{id}/change","href":"/api-reference/endpoint/change-ip"}]},{"group":"Firewall","pages":[{"title":"List firewalls","openapi":"GET /api/v1/security-groups","href":"/api-reference/endpoint/list-firewalls"},{"title":"Create firewall","openapi":"POST /api/v1/security-groups","href":"/api-reference/endpoint/create-firewall"},{"title":"List firewall templates","openapi":"GET /api/v1/security-groups/templates","href":"/api-reference/endpoint/list-firewall-templates"},{"title":"Get firewall","openapi":"GET /api/v1/security-groups/{id}","href":"/api-reference/endpoint/get-firewall"},{"title":"Update firewall","openapi":"PUT /api/v1/security-groups/{id}","href":"/api-reference/endpoint/update-firewall"},{"title":"Delete firewall","openapi":"DELETE /api/v1/security-groups/{id}","href":"/api-reference/endpoint/delete-firewall"},{"title":"Get firewall tags","openapi":"GET /api/v1/security-groups/{id}/tags","href":"/api-reference/endpoint/get-firewall-tags"},{"title":"Set firewall tags","openapi":"PUT /api/v1/security-groups/{id}/tags","href":"/api-reference/endpoint/set-firewall-tags"}]},{"group":"VM network attachments","pages":[{"title":"List VM network interfaces","openapi":"GET /api/v1/vms/{id}/networks","href":"/api-reference/endpoint/list-vm-networks"},{"title":"Attach VM to VPC","openapi":"POST /api/v1/vms/{id}/vpc","href":"/api-reference/endpoint/attach-vm-to-vpc"},{"title":"Detach VM from VPC","openapi":"DELETE /api/v1/vms/{id}/vpc/{nic_id}","href":"/api-reference/endpoint/detach-vm-from-vpc"},{"title":"Attach floating IP to VM","openapi":"POST /api/v1/vms/{id}/ip","href":"/api-reference/endpoint/attach-vm-ip"},{"title":"Detach floating IP from VM","openapi":"DELETE /api/v1/vms/{id}/ip/{nic_id}","href":"/api-reference/endpoint/detach-vm-ip"},{"title":"Attach firewall to VM NIC","openapi":"POST /api/v1/vms/{id}/security-groups","href":"/api-reference/endpoint/attach-vm-firewall"},{"title":"Detach firewall from VM NIC","openapi":"DELETE /api/v1/vms/{id}/security-groups/{sg_id}/{nic_id}","href":"/api-reference/endpoint/detach-vm-firewall"}]}]},{"group":"Volumes","pages":[{"title":"List Volumes","openapi":"GET /api/v1/volumes","href":"/api-reference/volumes/list-volumes"},{"title":"Create Volume","openapi":"POST /api/v1/volumes","href":"/api-reference/volumes/create-volume"},{"title":"Get Volume","openapi":"GET /api/v1/volumes/{id}","href":"/api-reference/volumes/get-volume"},{"title":"Delete Volume","openapi":"DELETE /api/v1/volumes/{id}","href":"/api-reference/volumes/delete-volume"},{"title":"Attach Volume","openapi":"POST /api/v1/volumes/{id}/attach","href":"/api-reference/volumes/attach-volume"},{"title":"Detach Volume","openapi":"POST /api/v1/volumes/{id}/detach","href":"/api-reference/volumes/detach-volume"},{"title":"Resize Volume","openapi":"PATCH /api/v1/volumes/{id}","href":"/api-reference/volumes/resize-volume"}]},{"group":"Kubernetes","pages":[{"group":"Clusters","pages":[{"title":"List Kubernetes Clusters","openapi":"GET /api/v1/k8s/clusters","href":"/api-reference/kubernetes/list-clusters"},{"title":"Create Kubernetes Cluster","openapi":"POST /api/v1/k8s/clusters","href":"/api-reference/kubernetes/create-cluster"},{"title":"Get Kubernetes Cluster","openapi":"GET /api/v1/k8s/clusters/{cluster_id}","href":"/api-reference/kubernetes/get-cluster"},{"title":"Rename Kubernetes Cluster","openapi":"PATCH /api/v1/k8s/clusters/{cluster_id}","href":"/api-reference/kubernetes/rename-cluster"},{"title":"Delete Kubernetes Cluster","openapi":"DELETE /api/v1/k8s/clusters/{cluster_id}","href":"/api-reference/kubernetes/delete-cluster"},{"title":"Get Kubeconfig","openapi":"GET /api/v1/k8s/clusters/{cluster_id}/kubeconfig","href":"/api-reference/kubernetes/get-kubeconfig"},{"title":"Upgrade to HA Control Plane","openapi":"POST /api/v1/k8s/clusters/{cluster_id}/ha","href":"/api-reference/kubernetes/upgrade-to-ha"},{"title":"List Available Version Upgrades","openapi":"GET /api/v1/k8s/clusters/{cluster_id}/upgrades","href":"/api-reference/kubernetes/get-cluster-upgrades"},{"title":"Upgrade Kubernetes Version","openapi":"POST /api/v1/k8s/clusters/{cluster_id}/upgrade","href":"/api-reference/kubernetes/upgrade-cluster-version"},{"title":"Set Upgrade Mode and Maintenance Window","openapi":"PATCH /api/v1/k8s/clusters/{cluster_id}/maintenance","href":"/api-reference/kubernetes/update-cluster-maintenance"},{"title":"List Kubernetes Versions","openapi":"GET /api/v1/k8s/versions","href":"/api-reference/kubernetes/list-kubernetes-versions"},{"title":"List Kubernetes Node Plans","openapi":"GET /api/v1/k8s/node-plans","href":"/api-reference/kubernetes/list-node-plans"}]},{"group":"Node pools","pages":[{"title":"List Node Pools","openapi":"GET /api/v1/k8s/clusters/{cluster_id}/pools","href":"/api-reference/kubernetes/list-node-pools"},{"title":"Add Node Pool","openapi":"POST /api/v1/k8s/clusters/{cluster_id}/pools","href":"/api-reference/kubernetes/add-node-pool"},{"title":"Update Node Pool","openapi":"PATCH /api/v1/k8s/clusters/{cluster_id}/pools/{pool_id}","href":"/api-reference/kubernetes/update-node-pool"},{"title":"Scale Node Pool","openapi":"POST /api/v1/k8s/clusters/{cluster_id}/pools/{pool_id}/scale","href":"/api-reference/kubernetes/scale-node-pool"},{"title":"Delete Node Pool","openapi":"DELETE /api/v1/k8s/clusters/{cluster_id}/pools/{pool_id}","href":"/api-reference/kubernetes/delete-node-pool"}]},{"group":"Observability","pages":[{"title":"List Cluster Nodes","openapi":"GET /api/v1/k8s/clusters/{cluster_id}/nodes","href":"/api-reference/kubernetes/list-cluster-nodes"},{"title":"List Cluster Events","openapi":"GET /api/v1/k8s/clusters/{cluster_id}/events","href":"/api-reference/kubernetes/list-cluster-events"},{"title":"Get Cluster Metrics","openapi":"GET /api/v1/k8s/clusters/{cluster_id}/metrics","href":"/api-reference/kubernetes/get-cluster-metrics"},{"title":"Get Cluster Utilization Stats","openapi":"GET /api/v1/k8s/clusters/stats","href":"/api-reference/kubernetes/get-cluster-stats"}]},{"group":"Networking","pages":[{"title":"Get Cluster Firewall","openapi":"GET /api/v1/k8s/clusters/{cluster_id}/firewall","href":"/api-reference/kubernetes/get-cluster-firewall"},{"title":"Assign Cluster Firewall","openapi":"POST /api/v1/k8s/clusters/{cluster_id}/firewall","href":"/api-reference/kubernetes/assign-cluster-firewall"},{"title":"Reset Cluster Firewall","openapi":"DELETE /api/v1/k8s/clusters/{cluster_id}/firewall","href":"/api-reference/kubernetes/reset-cluster-firewall"},{"title":"Get MetalLB Address Pool","openapi":"GET /api/v1/k8s/clusters/{cluster_id}/metallb-pool","href":"/api-reference/kubernetes/get-metallb-pool"},{"title":"Resize MetalLB Address Pool","openapi":"PUT /api/v1/k8s/clusters/{cluster_id}/metallb-pool","href":"/api-reference/kubernetes/update-metallb-pool"},{"title":"List TCP Port Forwards","openapi":"GET /api/v1/k8s/clusters/{cluster_id}/tcp-ports","href":"/api-reference/kubernetes/list-tcp-ports"},{"title":"Delete TCP Port Forward","openapi":"DELETE /api/v1/k8s/clusters/{cluster_id}/tcp-ports/{port}","href":"/api-reference/kubernetes/delete-tcp-port"}]}]},{"group":"Snapshots","pages":[{"title":"List Snapshots","openapi":"GET /api/v1/snapshots","href":"/api-reference/snapshots/list-snapshots"},{"title":"Create Snapshot","openapi":"POST /api/v1/snapshots","href":"/api-reference/snapshots/create-snapshot"},{"title":"Get Snapshot","openapi":"GET /api/v1/snapshots/{id}","href":"/api-reference/snapshots/get-snapshot"},{"title":"Delete Snapshot","openapi":"DELETE /api/v1/snapshots/{id}","href":"/api-reference/snapshots/delete-snapshot"},{"title":"Restore Snapshot","openapi":"POST /api/v1/snapshots/{id}/restore","href":"/api-reference/snapshots/restore-snapshot"},{"title":"Rename Snapshot","openapi":"PATCH /api/v1/snapshots/{id}/rename","href":"/api-reference/snapshots/rename-snapshot"}]},{"group":"Backups","pages":[{"group":"Backups","pages":[{"title":"List Backups","openapi":"GET /api/v1/backups","href":"/api-reference/backups/list-backups"},{"title":"Create Backup","openapi":"POST /api/v1/backups","href":"/api-reference/backups/create-backup"},{"title":"Get Backup","openapi":"GET /api/v1/backups/{id}","href":"/api-reference/backups/get-backup"},{"title":"Delete Backup","openapi":"DELETE /api/v1/backups/{id}","href":"/api-reference/backups/delete-backup"},{"title":"Delete Backup Series","openapi":"DELETE /api/v1/backups/{id}/chain","href":"/api-reference/backups/delete-backup-chain"},{"title":"Restore Backup","openapi":"POST /api/v1/backups/{id}/restore","href":"/api-reference/backups/restore-backup"},{"title":"Reset Backup Series","openapi":"POST /api/v1/vms/{id}/backups/reset-chain","href":"/api-reference/backups/reset-backup-chain"}]},{"group":"Schedules","pages":[{"title":"List Backup Schedules","openapi":"GET /api/v1/backup-schedules","href":"/api-reference/backups/schedules/list-backup-schedules"},{"title":"Create Backup Schedule","openapi":"POST /api/v1/backup-schedules","href":"/api-reference/backups/schedules/create-backup-schedule"},{"title":"Get Backup Schedule","openapi":"GET /api/v1/backup-schedules/{id}","href":"/api-reference/backups/schedules/get-backup-schedule"},{"title":"Update Backup Schedule","openapi":"PATCH /api/v1/backup-schedules/{id}","href":"/api-reference/backups/schedules/update-backup-schedule"},{"title":"Delete Backup Schedule","openapi":"DELETE /api/v1/backup-schedules/{id}","href":"/api-reference/backups/schedules/delete-backup-schedule"}]}]},{"group":"SSH Keys","pages":[{"title":"List SSH Keys","openapi":"GET /api/v1/ssh-keys","href":"/api-reference/ssh-keys/list-ssh-keys"},{"title":"Create SSH Key","openapi":"POST /api/v1/ssh-keys","href":"/api-reference/ssh-keys/create-ssh-key"},{"title":"Get SSH Key","openapi":"GET /api/v1/ssh-keys/{id}","href":"/api-reference/ssh-keys/get-ssh-key"},{"title":"Update SSH Key","openapi":"PUT /api/v1/ssh-keys/{id}","href":"/api-reference/ssh-keys/update-ssh-key"},{"title":"Delete SSH Key","openapi":"DELETE /api/v1/ssh-keys/{id}","href":"/api-reference/ssh-keys/delete-ssh-key"}]},{"group":"Team \u0026 Projects","pages":[{"group":"Members","pages":[{"title":"List Members","openapi":"GET /api/v1/members","href":"/api-reference/members/list-members"},{"title":"Add Member","openapi":"POST /api/v1/members","href":"/api-reference/members/add-member"},{"title":"Get Member","openapi":"GET /api/v1/members/{id}","href":"/api-reference/members/get-member"},{"title":"Update Member","openapi":"PATCH /api/v1/members/{id}","href":"/api-reference/members/update-member"},{"title":"Remove Member","openapi":"DELETE /api/v1/members/{id}","href":"/api-reference/members/remove-member"}]},{"group":"Project Members","pages":[{"title":"List Project Members","openapi":"GET /api/v1/projects/{id}/members","href":"/api-reference/project-members/list-project-members"},{"title":"Add Project Member","openapi":"POST /api/v1/projects/{id}/members","href":"/api-reference/project-members/add-project-member"},{"title":"Get Project Member","openapi":"GET /api/v1/projects/{id}/members/{member_id}","href":"/api-reference/project-members/get-project-member"},{"title":"Update Project Member","openapi":"PATCH /api/v1/projects/{id}/members/{member_id}","href":"/api-reference/project-members/update-project-member"},{"title":"Remove Project Member","openapi":"DELETE /api/v1/projects/{id}/members/{member_id}","href":"/api-reference/project-members/remove-project-member"}]},{"group":"Roles","pages":[{"title":"List Roles","openapi":"GET /api/v1/roles","href":"/api-reference/roles/list-roles"},{"title":"Create Role","openapi":"POST /api/v1/roles","href":"/api-reference/roles/create-role"},{"title":"Get Role","openapi":"GET /api/v1/roles/{id}","href":"/api-reference/roles/get-role"},{"title":"Update Role","openapi":"PATCH /api/v1/roles/{id}","href":"/api-reference/roles/update-role"},{"title":"Delete Role","openapi":"DELETE /api/v1/roles/{id}","href":"/api-reference/roles/delete-role"}]},{"group":"Permissions","pages":[{"title":"List Permissions","openapi":"GET /api/v1/permissions","href":"/api-reference/permissions/list-permissions"}]},{"group":"API Keys","pages":[{"title":"List API Keys","openapi":"GET /api/v1/api-keys","href":"/api-reference/api-keys/list-api-keys"},{"title":"Create API Key","openapi":"POST /api/v1/api-keys","href":"/api-reference/api-keys/create-api-key"},{"title":"Get API Key","openapi":"GET /api/v1/api-keys/{id}","href":"/api-reference/api-keys/get-api-key"},{"title":"Update API Key","openapi":"PATCH /api/v1/api-keys/{id}","href":"/api-reference/api-keys/update-api-key"},{"title":"Revoke API Key","openapi":"DELETE /api/v1/api-keys/{id}","href":"/api-reference/api-keys/revoke-api-key"},{"title":"Regenerate API Key","openapi":"POST /api/v1/api-keys/{id}/regenerate","href":"/api-reference/api-keys/regenerate-api-key"}]},{"group":"Invitations","pages":[{"title":"Create Account Invitation","openapi":"POST /api/v1/invitations","href":"/api-reference/invitations/create-account-invitation"},{"title":"Create Project Invitation","openapi":"POST /api/v1/projects/{id}/invitations","href":"/api-reference/invitations/create-project-invitation"},{"title":"Cancel Invitation","openapi":"DELETE /api/v1/invitations/{id}","href":"/api-reference/invitations/cancel-invitation"}]}]}]},{"group":"CLI","pages":[{"title":"Raff CLI","href":"/reference/cli/introduction"},{"title":"Installing raff","href":"/reference/cli/install"},{"title":"raff configure","href":"/reference/cli/configure"},{"title":"raff vm","href":"/reference/cli/vm"},{"title":"raff kubernetes","href":"/reference/cli/kubernetes"},{"title":"raff database","href":"/reference/cli/database"},{"title":"raff apps","href":"/reference/cli/app"},{"title":"raff volume","href":"/reference/cli/volume"},{"title":"raff snapshot","href":"/reference/cli/snapshot"},{"title":"raff backup","href":"/reference/cli/backup"},{"title":"raff vpc","href":"/reference/cli/vpc"},{"title":"raff ip","href":"/reference/cli/ip"},{"title":"raff security-group","href":"/reference/cli/security-group"},{"title":"raff tag","href":"/reference/cli/tag"},{"title":"raff ssh-key","href":"/reference/cli/ssh-key"},{"title":"raff api-key","href":"/reference/cli/api-key"},{"title":"raff project","href":"/reference/cli/project"},{"title":"raff member","href":"/reference/cli/member"},{"title":"raff role","href":"/reference/cli/role"},{"title":"raff permission","href":"/reference/cli/permission"},{"title":"raff invitation","href":"/reference/cli/invitation"},{"title":"raff region","href":"/reference/cli/region"},{"title":"raff template","href":"/reference/cli/template"},{"title":"raff pricing","href":"/reference/cli/pricing"}]},{"group":"Terraform","pages":[{"title":"Raff Terraform Provider","href":"/reference/terraform/introduction"},{"title":"Install the Raff Terraform Provider","href":"/reference/terraform/install"},{"title":"raff_project","href":"/reference/terraform/raff_project"},{"title":"raff_vm","href":"/reference/terraform/raff_vm"},{"title":"raff_volume","href":"/reference/terraform/raff_volume"},{"title":"raff_snapshot","href":"/reference/terraform/raff_snapshot"},{"title":"raff_backup","href":"/reference/terraform/raff_backup"},{"title":"raff_backup_schedule","href":"/reference/terraform/raff_backup_schedule"},{"title":"raff_vpc","href":"/reference/terraform/raff_vpc"},{"title":"raff_ip","href":"/reference/terraform/raff_ip"},{"title":"raff_security_group","href":"/reference/terraform/raff_security_group"},{"title":"raff_tag","href":"/reference/terraform/raff_tag"},{"title":"raff_ssh_key","href":"/reference/terraform/raff_ssh_key"},{"title":"raff_api_key","href":"/reference/terraform/raff_api_key"},{"title":"raff_role","href":"/reference/terraform/raff_role"},{"title":"raff_member","href":"/reference/terraform/raff_member"},{"title":"raff_project_member","href":"/reference/terraform/raff_project_member"},{"title":"raff_k8s_cluster","href":"/reference/terraform/raff_k8s_cluster"},{"title":"raff_k8s_node_pool","href":"/reference/terraform/raff_k8s_node_pool"},{"title":"raff_database","href":"/reference/terraform/raff_database"},{"title":"raff_database_user","href":"/reference/terraform/raff_database_user"},{"title":"raff_app_service","href":"/reference/terraform/raff_app_service"},{"title":"raff_app_custom_domain","href":"/reference/terraform/raff_app_custom_domain"},{"title":"raff_app_database_link","href":"/reference/terraform/raff_app_database_link"},{"title":"Catalog data sources","href":"/reference/terraform/data-sources"}]}]}]},"basePath":"","title":"Create database - Raff","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js","Markdown-CwtoSfEf.js","AssistantPageLink-CTqa3eoi.js","dist-DIfYWxfm.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}