S3API

S3Api

Method	HTTP request	Description
bckNamesFromBMD	GET /s3	List all buckets from the bucket metadata
delMultipleObjs	DELETE /s3/{bucket-name}	Delete a list of objects from an S3 bucket
delObjS3	DELETE /s3/{bucket-name}/{object-name}	Delete an S3 object
getBckVersioningS3	GET /s3/{bucket-name}	Get S3 bucket versioning configuration
getObjS3	GET /s3/{bucket-name}/{object-name}	Download an S3 object or list multipart uploads
handleMptUpload	POST /s3/{bucket-name}/{object-name}	Handle S3 multipart upload operations
headBckS3	HEAD /s3/{bucket-name}	Check if S3 bucket exists and retrieve metadata
headObjS3	HEAD /s3/{bucket-name}/{object-name}	Retrieve S3 object metadata and headers
putBckVersioningS3	PUT /s3/{bucket-name}	Configure S3 bucket versioning settings
putObjS3	PUT /s3/{bucket-name}/{object-name}	Upload or copy an S3 object

bckNamesFromBMD

Object bckNamesFromBMD()

List all buckets from the bucket metadata

Example: Get Request

curl -i -L -X GET \
  'AIS_ENDPOINT/s3'

Parameters

Return type

Object

HTTP request headers

• Content-Type: Not defined
• Accept: /

delMultipleObjs

Object delMultipleObjs(delete)

Delete a list of objects from an S3 bucket

Example: Delete {bucket-name}

curl -i -L -X DELETE \
  -H 'Content-Type: application/xml' \
  -d '<?xml version="1.0" encoding="UTF-8"?><Delete><Object><Key>file1.txt</Key></Object><Object><Key>file2.txt</Key></Object></Delete>' \
  'AIS_ENDPOINT/s3/{bucket-name}?delete=<value>'

Parameters

Name	Type	Description
delete	String	Delete multiple objects in a single request

Return type

Object

HTTP request headers

• Content-Type: Not defined
• Accept: /

delObjS3

Object delObjS3()

Delete an S3 object

Example: Delete {bucket-name}

curl -i -L -X DELETE \
  'AIS_ENDPOINT/s3/{bucket-name}/{object-name}'

Parameters

Return type

Object

HTTP request headers

• Content-Type: Not defined
• Accept: /

getBckVersioningS3

Object getBckVersioningS3(versioning)

Get S3 bucket versioning configuration

Example: Get {bucket-name}

curl -i -L -X GET \
  'AIS_ENDPOINT/s3/{bucket-name}?versioning=<value>'

Parameters

Name	Type	Description
versioning	String	Configure or retrieve bucket versioning settings

Return type

Object

HTTP request headers

• Content-Type: Not defined
• Accept: /

getObjS3

Object getObjS3()

Download an S3 object or list multipart uploads

Example: Get {bucket-name}

curl -i -L -X GET \
  'AIS_ENDPOINT/s3/{bucket-name}/{object-name}'

Parameters

Return type

Object

HTTP request headers

• Content-Type: Not defined
• Accept: /

handleMptUpload

Object handleMptUpload(uploads, uploadId)

Handle S3 multipart upload operations

Example: Post {bucket-name}

curl -i -L -X POST \
  'AIS_ENDPOINT/s3/{bucket-name}/{object-name}?uploads=<value>&uploadId=<value>'

Parameters

Name	Type	Description
uploads	String	Start multipart upload or list active uploads
uploadId	String	Complete, abort, or list parts of specific multipart upload

Return type

Object

HTTP request headers

• Content-Type: Not defined
• Accept: /

headBckS3

Object headBckS3()

Check if S3 bucket exists and retrieve metadata

Example: Head {bucket-name}

curl -i -L -X HEAD \
  'AIS_ENDPOINT/s3/{bucket-name}'

Parameters

Return type

Object

HTTP request headers

• Content-Type: Not defined
• Accept: /

headObjS3

Object headObjS3()

Retrieve S3 object metadata and headers

Example: Head {bucket-name}

curl -i -L -X HEAD \
  'AIS_ENDPOINT/s3/{bucket-name}/{object-name}'

Parameters

Return type

Object

HTTP request headers

• Content-Type: Not defined
• Accept: /

putBckVersioningS3

Object putBckVersioningS3(versioning)

Configure S3 bucket versioning settings

Example: Put {bucket-name}

curl -i -L -X PUT \
  -H 'Content-Type: application/xml' \
  -d '<VersioningConfiguration><Status>Enabled</Status></VersioningConfiguration>' \
  'AIS_ENDPOINT/s3/{bucket-name}?versioning=<value>'

Parameters

Name	Type	Description
versioning	String	Configure or retrieve bucket versioning settings

Return type

Object

HTTP request headers

• Content-Type: Not defined
• Accept: /

putObjS3

Object putObjS3()

Upload or copy an S3 object

Example: Put {bucket-name}

curl -i -L -X PUT \
  'AIS_ENDPOINT/s3/{bucket-name}/{object-name}'

Parameters

Return type

Object

HTTP request headers

• Content-Type: Not defined
• Accept: /