Database_

Properties

Name	Type	Description
	string	Database ID.
	string	Database name.
	string	Database creation date in ISO 8601 format.
	string	Database update date in ISO 8601 format.
	boolean	If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.
	DatabaseType	Database type.
	DatabaseStatus	Dedicated database lifecycle status. Null when the database has no valid dedicated backing.
	string	Underlying engine of the dedicated backing: postgresql, mysql, or mongodb. A managed product (tablesdb, documentsdb, vectorsdb) reports the engine it runs on, so its type and engine can differ. Null when the database has no dedicated backing.
	string	Compute specification identifier of the dedicated backing, e.g. s-2vcpu-2gb. Null when the database has no dedicated backing.
	integer	Number of secondary high availability replicas, excluding the primary. Null when backing configuration is unavailable.
	string	Error message when the dedicated backing failed. Null when the database has no dedicated backing or has not failed.
	string	Container status of the dedicated backing: active, inactive, or failed (a wake was declined because the backing namespace is gone). Null when the database has no dedicated backing or the runtime has not reported one.
	string	Idle-lifecycle state of the dedicated backing: active, warm, cold, or hibernated. Null when the database has no dedicated backing or the runtime has not reported one.
	arrayof backup	Database backup policies.
	arrayof Archive	Database backup archives.

Was this page helpful?

Share what worked or what we should fix. Once approved, our agents automatically apply suggested updates to the docs.