Snapshot of database
GET /snapshot/:hash/database/:vendor
Snapshot of the database table for one vendor. A vendor without rows in the table gets empty arrays.
Snapshots let you read several tables from the same version of the database:
every file of one {hash} comes from the same database, so references between them
always resolve, e.g. every price's server is in the server snapshot of that hash.
Pin database_hash from /healthcheck at the start of a refresh, and fetch every file
with it. /snapshot/{hash} lists the files with checksums, so you can skip the ones
that didn't change since your last refresh.
Contents:
- Only available records: status
active or planned-for-retirement. Inactive and retired records are left out, and so are rows that reference them (e.g. the prices of a retired server, or of an inactive zone).
- Every column of the table except
observed_at: the hash already identifies the data version. For per-row timestamps, use /table/*.
- Sorted by the table's primary key.
- Columnar JSONJSON: JavaScript Object NotationA text format for structured data, built from objects (key-value pairs), arrays, strings, numbers, booleans, and null. Most languages and tools read and write it, which makes it a common format for API responses and benchmark output.JSONGlossary: one array per column, with one element per row, all arrays of the same length.
The response is immutable for a hash, requires an APIAPI: Application Programming InterfaceA defined set of requests and responses through which one program uses another, such as a web service's HTTP endpoints or a library's functions.WikipediaGlossary key, and is sent gzipped only:
send Accept-Encoding: gzip (e.g. curl --compressed), or you get a 406. A 503 of
type /problems/snapshot-preparing means the replica is still downloading or building
the hash: retry the same request after Retry-After seconds (for about a minute at
most). A 404 of type /problems/snapshot-not-available means the hash isn't
available: switch to the current hash in the response body, and fetch again the files
you already fetched. A 404 of type /problems/not-found is an unknown table, vendor
or id: don't retry.
Request
hash (path parameter, required): Database hash, e.g. `database_hash` of `/healthcheck`. vendor (path parameter, required): Vendor id, e.g. `aws`.
Hash not available (problem type /problems/snapshot-not-available), or unknown table, vendor or malformed id (/problems/not-found).
The request doesn't accept gzip.
The hash is being prepared on this replica (problem type /problems/snapshot-preparing): retry the same request after Retry-After seconds.
200: Successful Response. vendor_id: Reference to the Vendor. database_id: Unique identifier, as called at the Vendor. name: Human-friendly name. api_reference: How this resource is referenced in the vendor API calls. This is usually either the id or name of the resource, depending on the vendor and actual API endpoint. api_reference_object: How this resource is referenced in the vendor API calls, including the parameter name(s). display_name: Human-friendly reference (usually the id or name) of the resource. description: Short description. family: Broad workload class of the database in the vendor's own naming, e.g. General Purpose or Memory Optimized. series: Hardware line and generation of the database, matching the series of the server it runs on, where known. server_id: Reference to the underlying cloud server's identifier. vcpus: Number of virtual CPU cores allocated to the database server instance. memory_amount: Amount of RAM (MiB) provisioned for the instance. engine: Managed database engine running on the instance. Values: postgresql. wire_protocol: Network protocol used for client connections. Values: postgresql. engine_versions: Major database engine versions supported. auto_upgrade_versions: Auto-upgrade between minor database engine versions. ha: Ordered HA levels supported, highest tier first. Values: none, single-zone, multi-zone, multi-region. ha_strategy: Ordered HA strategies supported, highest tier first. Values: none, passive-standby, readable-cluster, multi-master. max_read_replicas: Maximum number of read-only replica nodes supported to scale read workloads. custom_config: Whether database engine parameters/flags can be customized. custom_extensions: Support for custom database engine extensions/plugins. storage_size: Bundled storage capacity included in the database (GB). storage_extra_min: Minimum custom storage size (in GB) that can be attached to the instance. storage_extra_max: Maximum storage limit (in GB) supported by the instance or storage tier. storage_extra_autosize: Whether storage capacity can automatically expand as disk usage grows. compatible_storage_ids: List of database_storage_ids that can be attached to the database as extra storage. disk_encryption: Indicates whether underlying storage drives are encrypted at rest. scheduled_backups: Support for automated snapshot schedules and backup retention management. continuous_backups: Maximum point-in-time recovery (PITR) log retention window expressed in days (0 if unsupported). connection_pool: Managed connection proxy support. system_monitoring: Availability of host-level CPU, RAM, and disk metrics dashboards. database_monitoring: Database engine performance insights (slow queries, locks, execution plans). autotuning_advice: Analyzes workload and generates actionable performance tuning advice. autotuning_apply: System automatically executes performance fixes (e.g., index creation, parameter tuning) without operator intervention. sla: Service level agreement as a percentage, e.g. 99.95. security_features: Security capabilities supported by DBaaS providers. Values: ip-filtering, private-network, network-peering, identity-based-auth, client-cert-auth, enforced-tls, customer-managed-keys, audit-logging. status: Status of the resource (active or inactive). Values: active, inactive, planned-for-retirement, retired. 401: No API key. 404: Hash not available (problem type `/problems/snapshot-not-available`), or unknown table, vendor or malformed id (`/problems/not-found`). 406: The request doesn't accept gzip. 422: Validation Error. detail: Detail. loc: Location. msg: Message. type: Error Type. input: Input. ctx: Context. 503: The hash is being prepared on this replica (problem type `/problems/snapshot-preparing`): retry the same request after `Retry-After` seconds.