Skip to content
Hyphae Cloud

Catalog rows in one bucket, sorted by key.

GET
/v0/projects/{id}/storage/objects
curl --request GET \
  --url 'https://infra-hyphae.run/v0/projects/example/storage/objects?bucket=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}$/

Query Parameters

Section titled “Query Parameters”
bucket
required

S3-compatible bucket name so the same name works on every backend.

string
/^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$/

Responses

Section titled “ Responses ”

200

Section titled “200”

Objects (pending rows included, with state).

Media typeapplication/json
object
bucket
required

S3-compatible bucket name so the same name works on every backend.

string
/^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$/
objects
required
Array<object>

Catalog row. etag and size are the blob store’s (S3/MinIO ETag, or SHA-256 hex on the filesystem backend); the Cloud computes nothing else about the bytes. Native is not involved.

object
id
required
string
/^obj_[0-9a-f]{16}$/
project
required
string
/^prj_[0-9a-f]{16}$/
bucket
required

S3-compatible bucket name so the same name works on every backend.

string
/^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$/
key
required
string
>= 1 characters <= 1024 characters
size
required
integer
etag
required
string
content_type
required
string
backend
required
string
Allowed values: fs s3
state
required
string
Allowed values: pending stored
created_at
required

RFC 3339, UTC.

string format: date-time
updated_at
required

RFC 3339, UTC.

string format: date-time
Example
{
  "objects": [
    {
      "backend": "fs",
      "state": "pending"
    }
  ]
}

400

Section titled “400”

Malformed or out-of-bounds input (invalid_request).

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"
  }
}

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"
  }
}