Object API

Object API

ListObjectsV2

List all objects contained in a given bucket.

https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html
SecuritybearerAuth
Request
path Parameters
bucketName
required
string [ 4 .. 64 ] characters

The name of the bucket.

query Parameters
list-type
integer
Value: 2
Responses
200

Success

Response Schema: text/xml
Array of objects
Name
string
404

Bucket does not exist.

get/{bucketName}
Request samples 
DeleteObjects
Deletes one or multiple objects from a given bucket.


https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html
SecuritybearerAuth 
Request 
path Parameters
bucketName
required
string
The bucket name.


 
query Parameters
delete
required
boolean
 Value: true  
Request Body schema: text/xml
required
 Array 
Key
string
 
Responses 
200
Success


Response Schema: text/xml
object (DeleteObjectsResponse) 
 
post/{bucketName}
Request samples 
DeleteObject
Delete an object from a given bucket.


https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html
SecuritybearerAuth 
Request 
path Parameters
bucketName
required
string
The bucket name.


 
objectName
required
string  non-empty 
The object name.


 
Responses 
204
Success


delete/{bucketName}/{objectName}
Request samples 
GetObject
Retrieves an object from a given bucket.


https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
SecuritybearerAuth 
Request 
path Parameters
bucketName
required
string
The bucket name.


 
objectName
required
string  non-empty 
The object name.


 
query Parameters
uploadId
string
 
Responses 
200
Success


Response Schema: */*
string <binary> 
 
404
ObjectNotFound


get/{bucketName}/{objectName}
Request samples 
HeadObject
Retrieves metadata from an object without returning the object itself.


https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html
SecuritybearerAuth 
Request 
path Parameters
bucketName
required
string
The bucket name.


 
objectName
required
string  non-empty 
The object name.


 
Responses 
200
Success


 Response Headers 
Date
string <date-time> 
 
Last-Modified
string <date-time> 
 
Content-Length
integer
 
404
ObjectNotFound


head/{bucketName}/{objectName}
Request samples 
PutObject
Add an object to a bucket.


https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
SecuritybearerAuth 
Request 
path Parameters
bucketName
required
string
The bucket name.


 
objectName
required
string  non-empty 
The object name.


 
query Parameters
partNumber
string
 
uploadId
string
 
header Parameters
Content-type
string
 
Request Body schema: */*
required
string <binary> 
 
Responses 
200
Success


put/{bucketName}/{objectName}
Request samples