S3 · Buckets
HeadBucket
/{bucket}Checks that a bucket exists and that the key can read it.
Returns 200 with no body when the key may read the bucket. Use it to check access before other calls.
- Role
- Viewer or higher
- Support
- Supported
- Finds an active or offline bucket, and returns the signing region.
Path parameters
The bucket name.
Headers
The workspace ID that must own the bucket. Another owner returns 403 AccessDenied.
Responses
200OK
The bucket exists, and the key may read it.
Response headers
x-amz-bucket-regionstringThe signing region, us-east-1.
x-graphon-bucket-idstringThe bucket ID. The Storage JSON API uses this ID in its paths.
This response has no body.
Errors
Select an error in the response example to see its XML body. Any request can also get the common errors, such as SignatureDoesNotMatch.
- 404NoSuchBucket
No bucket has this name, or the bucket was deleted.
What to do: Check the bucket name. ListBuckets shows the buckets of the workspace.
- 403AccessDenied
The key does not have the role for this operation, or the bucket is in another workspace.
What to do: Use a key of the workspace that owns the bucket, with the role above.