Skip to main content
GET
{documentUrl}
/
internal
/
storage
/
buckets
curl -X GET '{{documentUrl}}/internal/storage/buckets' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Cache-Control: no-cache' \
  -H 'Accept: */*' \
  -H 'Accept-Encoding: gzip, deflate, br'
This endpoint returns a comprehensive list of all storage buckets available in the document management system. Use this endpoint to discover available storage containers before performing operations like listing objects or uploading files.
Storage buckets are logical containers that organize and group related files. Each bucket has unique permissions and configuration settings.

​
Authentication

This endpoint requires Bearer Token authentication. Include your API token in the Authorization header.
​
Authorization
string
required
Bearer token for API authentication. Format: Bearer YOUR_API_TOKEN

​
URL Parameters

​
documentUrl
string
required
The base URL of the document storage service where buckets are managed.Example: https://document-service.your-domain.com
​
internal
string
required
Path segment indicating this is an internal API call within the document service. This distinguishes internal system operations from external public APIs.
​
storage
string
required
Path segment specifying that this endpoint operates on storage resources. This groups all storage-related operations under a common path.
​
buckets
string
required
Path segment identifying the specific storage resource type being accessed. This endpoint targets bucket-level operations for listing available storage containers.

​
Headers

​
Cache-Control
string
default:"no-cache"
Cache control directive. Use no-cache to ensure fresh bucket data.
​
Accept
string
default:"*/*"
Content type that the client can accept. Supports */* for all types.
​
Accept-Encoding
string
default:"gzip, deflate, br"
Acceptable encoding methods for response compression. Supports gzip, deflate, br.

​
Request Examples

curl -X GET '{{documentUrl}}/internal/storage/buckets' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Cache-Control: no-cache' \
  -H 'Accept: */*' \
  -H 'Accept-Encoding: gzip, deflate, br'

const response = await fetch('{{documentUrl}}/internal/storage/buckets', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Cache-Control': 'no-cache',
    'Accept': '*/*'
  }
});

const buckets = await response.json();
⌘I