hosting

GET /v1/storage/buckets/{bucketId}

One bucket.

Tutti gli endpoint hosting

Autenticazione

Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione storage.view; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

curl -X GET https://api.zinndigital.com/v1/storage/buckets/{bucketId} \
  -H "Authorization: Bearer zdk_live_…"

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

One bucket belonging to this organisation. Requires `storage.view`.

Parametri

NomeTipoObbligatorioChe cos'è
bucketId (path)stringThe bucket's id.

Risposta

NomeTipoObbligatorioChe cos'è
idstring
namestringThe customer's own label, not the bucket's name at the vendor.
ownershipstring<zinn, customer>`zinn` is storage we operate and bill for; `customer` is the organisation's own bucket, which costs us nothing and is not metered against their allowance.
vendorstring<r2, s3, b2, bunny, gcore, minio>
statusstring<pending, active, suspended, failed>
bucket_namestring
endpointstringNo
regionstringNo
public_base_urlstringNoWhere a public object is readable. Empty means the bucket is private and its objects are reachable only through a presigned URL.
bytes_storedintegerNo
objects_storedintegerNo
usage_measured_atstringNoWhen the size above was last measured against the vendor. `null` means it has not been measured yet — which is not the same as empty.
has_credentialbooleanWhether a stored key exists. The key and the Vault path it lives at are deliberately absent from this payload.
meteredbooleanWhether this bucket's bytes count against `object_storage_gb`.
created_atstringNo

Errori che questo endpoint può restituire

401 · 403 · 404 · 429