OBJECTSAPI

ObjectsApi

Method	HTTP request	Description
httpobjdelete	DELETE /v1/objects/{bucket-name}/{object-name}	Delete an object with the given uname
httpobjget	GET /v1/objects/{bucket-name}/{object-name}	Retrieve the object content with the given uname
httpobjhead	HEAD /v1/objects/{bucket-name}/{object-name}	Get object metadata and properties
httpobjpatch	PATCH /v1/objects/{bucket-name}/{object-name}	Update object metadata and custom properties
httpobjpost	POST /v1/objects/{bucket-name}/{object-name}	Perform actions on objects (rename, promote, blob download, check lock)
httpobjput	PUT /v1/objects/{bucket-name}/{object-name}	Create a new object with the given uname

httpobjdelete

Object httpobjdelete(provider, namespace)

Delete an object with the given uname

Example: Delete objects

curl -i -L -X DELETE \
  'AIS_ENDPOINT/v1/objects/{bucket-name}/{object-name}?provider=<value>&namespace=<value>'

Parameters

Name	Type	Description
provider	String	Backend provider type (ais, s3, gcp, azure, etc.)
namespace	String	Namespace for remote buckets and cross-cluster operations

Return type

Object

HTTP request headers

• Content-Type: Not defined
• Accept: /

httpobjget

Object httpobjget(provider, namespace, original_url, latest-ver)

Retrieve the object content with the given uname

Example: Get objects

curl -i -L -X GET \
  'AIS_ENDPOINT/v1/objects/{bucket-name}/{object-name}?provider=<value>&namespace=<value>&original_url=<value>&latest-ver=<value>'

Parameters

Name	Type	Description
provider	String	Backend provider type (ais, s3, gcp, azure, etc.)
namespace	String	Namespace for remote buckets and cross-cluster operations
original_url	String	Original URL for HTTP bucket objects
latest-ver	Boolean	Get latest version of objects from remote backend

Return type

Object

HTTP request headers

• Content-Type: Not defined
• Accept: /

httpobjhead

Object httpobjhead(provider, namespace, sln)

Get object metadata and properties

Example: Head objects

curl -i -L -X HEAD \
  'AIS_ENDPOINT/v1/objects/{bucket-name}/{object-name}?provider=<value>&namespace=<value>&sln=<value>'

Parameters

Name	Type	Description
provider	String	Backend provider type (ais, s3, gcp, azure, etc.)
namespace	String	Namespace for remote buckets and cross-cluster operations
sln	Boolean	Suppress error logging and warnings

Return type

Object

HTTP request headers

• Content-Type: Not defined
• Accept: /

httpobjpatch

Object httpobjpatch(provider, namespace)

Update object metadata and custom properties

Example: Patch objects

curl -i -L -X PATCH \
  'AIS_ENDPOINT/v1/objects/{bucket-name}/{object-name}?provider=<value>&namespace=<value>'

Parameters

Name	Type	Description
provider	String	Backend provider type (ais, s3, gcp, azure, etc.)
namespace	String	Namespace for remote buckets and cross-cluster operations

Return type

Object

HTTP request headers

• Content-Type: Not defined
• Accept: /

httpobjpost

Object httpobjpost(request, provider, namespace)

Perform actions on objects (rename, promote, blob download, check lock)

Supported actions: promote, blob-download

Example: promote

curl -i -L -X POST \
  -H 'Content-Type: application/json' \
  -d '{"action": "promote", "name": "/user/dir", "value": {"target": "234ed78", "trim_prefix": "/user/", "recurs": true, "keep": true}}' \
  'AIS_ENDPOINT/v1/objects/{bucket-name}/{object-name}?provider=<value>&namespace=<value>'

Example: blob-download

curl -i -L -X POST \
  -H 'Content-Type: application/json' \
  -d '{"action": "blob-download", "value": {"chunk-size": 10485760, "num-workers": 4}}' \
  'AIS_ENDPOINT/v1/objects/{bucket-name}/{object-name}?provider=<value>&namespace=<value>'

Parameters

provider	String	Backend provider type (ais, s3, gcp, azure, etc.)
namespace	String	Namespace for remote buckets and cross-cluster operations

Return type

Object

HTTP request headers

• Content-Type: Not defined
• Accept: /

httpobjput

Object httpobjput(append_type, append_handle)

Create a new object with the given uname

Example: Put objects

curl -i -L -X PUT \
  'AIS_ENDPOINT/v1/objects/{bucket-name}/{object-name}?append_type=<value>&append_handle=<value>'

Parameters

Name	Type	Description
append_type	String	Type of append operation (append, flush)
append_handle	String	Handle for ongoing append operations

Return type

Object

HTTP request headers

• Content-Type: Not defined
• Accept: /