Skip to content

S3 Schemas

Auto-generated from source — always in sync with the backend.

s3

S3 request/response schemas.

CreateBucketRequest

Request body for creating a new S3 bucket.

BucketInfo

Information about a single S3 bucket.

OwnerInfo

S3 bucket or object owner.

ListBucketsResponse

Response for listing all S3 buckets.

ObjectInfo

Information about a single S3 object.

ListObjectsResponse

Response for listing objects in a bucket.

CountObjectsResponse

Response for counting objects at a prefix.

StatsTaskResponse

Response for a stats counting task.

UploadObjectResponse

Response for uploading an object.

HeadObjectResponse

Object metadata returned by HEAD.

CopyObjectRequest

Request body for copying an object.

DeleteObjectsRequest

Request body for bulk deleting objects.

BulkDownloadRequest

Request body for bulk downloading objects as ZIP.

ZipTaskResponse

Response for a ZIP download task.

BulkPresignRequest

Request body for generating bulk presigned URLs.

BulkPresignItem

A single presigned URL entry.

BulkPresignResponse

Response containing bulk presigned URLs.

BucketVersioningResponse

Bucket versioning configuration.

AclPolicy

S3 ACL policy for buckets and objects.

AclResponse

Response for GET bucket/object ACL.

CorsRule

A single CORS rule for a bucket.

CorsConfiguration

S3 bucket CORS configuration.

CorsResponse

Response for GET bucket CORS.

MultipartUploadInfo

Information about an in-progress multipart upload.

ListMultipartUploadsResponse

Response for listing in-progress multipart uploads.

CreateFolderRequest

Request body for creating a folder.

CreateFolderResponse

Response for folder creation.

BucketMutationResponse

Response for bucket create/delete.

VersioningMutationResponse

Response for PUT bucket versioning.

ObjectMutationResponse

Response for object copy/delete.

DeleteObjectsResponse

Response for bulk delete.

PresignedUrlRequest

Request body for generating a presigned URL.

PresignedUrlResponse

Response containing the generated presigned URL.

PresignedMultipartRequest

Request body for presigned multipart upload.

PresignedPartUrl

A single presigned URL for uploading one part.

PresignedMultipartResponse

Response containing presigned URLs for multipart upload.

S3CredentialsResponse

S3 credentials for the authenticated user.