hosting

GET /v1/storage/buckets/{bucketId}

One bucket.

Todos os endpoints de hosting

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão storage.view; uma chave sem ela é recusada com 403, e não 404.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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

Parâmetros

NomeTipoObrigatórioO que é
bucketId (path)stringSimThe bucket's id.

Resposta

NomeTipoObrigatórioO que é
idstringSim
namestringSimThe customer's own label, not the bucket's name at the vendor.
ownershipstring<zinn, customer>Sim`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>Sim
statusstring<pending, active, suspended, failed>Sim
bucket_namestringSim
endpointstringNão
regionstringNão
public_base_urlstringNãoWhere a public object is readable. Empty means the bucket is private and its objects are reachable only through a presigned URL.
bytes_storedintegerNão
objects_storedintegerNão
usage_measured_atstringNãoWhen 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_credentialbooleanSimWhether a stored key exists. The key and the Vault path it lives at are deliberately absent from this payload.
meteredbooleanSimWhether this bucket's bytes count against `object_storage_gb`.
created_atstringNão

Erros que este endpoint pode retornar

401 · 403 · 404 · 429