Skip to content
Hyphae Cloud

One snapshot.

GET
/v0/projects/{id}/snapshots/{sid}
curl --request GET \
  --url https://infra-hyphae.run/v0/projects/example/snapshots/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
id
required
string
/^prj_[0-9a-f]{16}$/
sid
required
string
/^snap_[0-9a-f]{16}$/

Responses

Section titled “ Responses ”

200

Section titled “200”

Snapshot.

Media typeapplication/json
object
id
required
string
/^snap_[0-9a-f]{16}$/
project
required
string
/^prj_[0-9a-f]{16}$/
label
string | null
created_at
required

RFC 3339, UTC.

string format: date-time
engine_version
required
string
Allowed value: 3.0.0
source_data_dir
required
string
backup_dir
required

Native backup directory (NATIVE_BACKUP.json + data/), under the snapshot root.

string
lineage
required

The snapshot object printed by hyphae status --data-dir. Field names are Native’s.

object
catalog_version
required
integer
directory_lineage
required
string
logical_time_micros
required
integer
root_digest
required
string
visible_csn
required
integer
backup
required

Output of hyphae backup create / backup verify. Field names are Native’s.

object
backup_path
required
string
checkpoint_digest
required
string
file_count
required
integer
total_bytes
required
integer
status
required
string
Allowed values: created verified
visible_csn
required
integer
Example
{
  "engine_version": "3.0.0",
  "backup": {
    "status": "created"
  }
}

401

Section titled “401”

Missing, malformed, duplicate, or unknown credential (authentication_required).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid_request authentication_required authorization_denied not_found conflict payload_too_large not_implemented tenant_not_running tenant_running function_runtime_missing function_timeout function_bad_output function_busy orchestrator_unavailable upstream_unavailable internal
message
required
string
Example
{
  "error": {
    "code": "invalid_request"
  }
}

Headers

Section titled “Headers”
WWW-Authenticate
string
Allowed value: Bearer realm="hyphae-cloud"

404

Section titled “404”

Unknown route, or a project the caller does not own (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid_request authentication_required authorization_denied not_found conflict payload_too_large not_implemented tenant_not_running tenant_running function_runtime_missing function_timeout function_bad_output function_busy orchestrator_unavailable upstream_unavailable internal
message
required
string
Example
{
  "error": {
    "code": "invalid_request"
  }
}