databases

POST `/v1/databases/{databaseId}/upgrade`

Move the database to a newer PostgreSQL major.

प्रमाणीकरण

एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। यो इन्डपोइन्टले विशिष्ट अनुमति खुलाएको छैन, त्यसैले अनुमान गर्नुको सट्टा आफ्नो कुञ्जीलाई आवश्यक पर्ने न्यूनतम अधिकार दिनुहोस् र प्रतिक्रिया जाँच गर्नुहोस्।

यो इन्डपोइन्टले कुनै संस्थाको आइडी लिँदैन। तपाईंको कुञ्जीले यस अन्तर्गत पर्ने संस्थालाई पहिल्यै पहिचान गर्छ, र प्रतिक्रिया त्यसैमा सीमित हुन्छ।

प्रयास गर्नुहोस्

कोणीय कोष्ठकभित्र भएका जुनसुकै कुरालाई आफ्नो मानहरूद्वारा बदल्नुहोस्, र मुख्य स्थानहोल्डरलाई तपाईंको ड्यासबोर्डको कुञ्जीद्वारा बदल्नुहोस्।

curl -X POST https://api.zinndigital.com/v1/databases/{databaseId}/upgrade \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "engine_version": <string> }'

लगइन गर्नुभएको छ? तपाईंको ड्यासबोर्डमा रहेको API कन्सोलले तपाईंको वास्तविक संस्थाको आईडी र आफ्नै कुञ्जी भरिदिन्छ, र लाइभ API विरुद्ध अनुरोध चलाउँछ ताकि तपाईंले वास्तविक प्रतिक्रिया हेर्न सक्नुहोस्। यो एन्डपोइन्टलाई API कन्सोलमा खोल्नुहोस्

विवरणहरू

Gated on `databases.manage`. Returns `202` — the upgrade runs as a durable workflow because the operator rolls the primary over to an upgraded replica, which takes minutes and must survive a deploy or the customer closing the tab. ⛔ Refused with 422 when the target is not a major we run, when it is not newer than the current one (downgrading is not possible), and — importantly — when **the database has never been backed up**: if a switchover goes wrong the way back is a restore, and a restore with no backup is not a way back.

प्यारामिटरहरू

नाम	प्रकार	आवश्यक	यो के हो
`databaseId (path)`	`string`	हुन्छ	—

अनुरोध बडी

नाम	प्रकार	आवश्यक	यो के हो
`engine_version`	`string`	हुन्छ	The engine major to move to. Must be one this platform offers for the database's own engine, and newer than its current one. ⛔ Compared as version numbers, not as text: `"9.7" <…

प्रतिक्रिया

नाम	प्रकार	आवश्यक	यो के हो
`id`	`string`	हुन्छ	—
`label`	`string`	हुन्छ	The customer's own name for it. Never sent to the infrastructure.
`engine`	`string<postgres, mysql>`	हुन्छ	Which engine this database runs (`docs/497`). Modelled as a field from the start, which is why MySQL was additive rather than a migration of every row.
`engine_version`	`string`	हुन्छ	The engine's major — `"18"`, `"8.4"`. The patch level is ours to keep current and is deliberately not customer-selectable: choosing your own patch level means choosing to ru…
`engine_label`	`string`	हैन	The engine and version as a customer sees them — "PostgreSQL 18", "MySQL 8.4". Assembled by the API so three frontends cannot disagree about a product name.
`size`	`string`	हुन्छ	A code from `GET /v1/databases/catalogue`.
`status`	`string<provisioning, available, failed, suspended, deleting, deleted>`	हुन्छ	—
`status_detail`	`string`	हैन	Why a `failed` instance failed. Empty otherwise.
`host`	`string`	हैन	Empty until the instance is `available`.
`port`	`integer`	हुन्छ	—
`database_name`	`string`	हुन्छ	—
`username`	`string`	हुन्छ	—
`high_availability`	`boolean`	हुन्छ	Whether a standby replica is held with automatic failover. The property customers actually choose on — stated rather than inferred from the size, because an inference goes w…
`vcpu`	`integer`	हैन	—
`ram_gb`	`integer`	हैन	—
`storage_gb`	`integer`	हैन	—
`tls_required`	`boolean`	हुन्छ	Always true. TLS is a precondition of selling a publicly reachable database, not a feature that can be turned off.
`created_at`	`string`	हुन्छ	—
`last_backup_at`	`string`	हैन	When a backup last completed. `null` means none has ever run.
`order_line_id`	`object`	हैन	The paid basket line this database fulfils, or `null` for one that predates the purchase path or that staff tooling created. The subscription that bills it carries the same id.
`billing`	`ManagedDatabaseBilling`	हैन	The subscription paying for this database — what it costs, and when it next renews. ⛔ `null` means no subscription pays for it, which is a real state (a row created before d…
`restore_verified_at`	`string`	हैन	When a backup of this database was last proved restorable by restoring it and reading a row back over a client connection. ⛔ Deliberately separate from `last_backup_at`: a b…

यो इन्डपोइन्टले फर्काउन सक्ने त्रुटिहरू

401 · 403 · 404 · 422

POST /v1/databases/{databaseId}/upgrade