Documentation for API Endpoints

Class Method HTTP request Parameters Description
BucketsApi httpbckdelete DELETE /v1/buckets/{bucket-name} provider, namespace, keep_bck_md Delete a bucket or delete/evict objects within a bucket
BucketsApi httpbckget GET /v1/buckets/{bucket-name} provider, namespace List buckets or list objects within a bucket
BucketsApi httpbckhead HEAD /v1/buckets/{bucket-name}/ presence, bsumm_remote, dont_add_remote_bck_md Get bucket metadata and properties with additional preparsing step to support api.GetBucketInfo prefix (e.g. ‘ais ls ais://nnn --summary --prefix=aaa/bbb’)
BucketsApi httpbckpatch PATCH /v1/buckets/{bucket-name} provider, namespace Update bucket properties and settings
BucketsApi httpbckpost POST /v1/buckets/{bucket-name} provider, namespace, bck_to, dont_head_remote_bck Create buckets or perform bucket operations (copy, move, etc.)
BucketsApi httpbckput PUT /v1/buckets/{bucket-name} provider, namespace Perform actions on a bucket (like archiving)
DaemonApi httpdaeget GET /v1/daemon what Retrieve various cluster and node information based on the ‘what’ query parameter. Supports multiple types: BMD (bucket metadata), NodeStatsAndStatus, SysInfo, Smap (cluster map), and more. (compare w/ httpcluget)
DaemonApi httpdaepost POST /v1/daemon can, prp Admin operations like joining cluster or forcing primary selection
DaemonApi httpdaeput PUT /v1/daemon frc Configure daemon settings and perform daemon operations
DownloadApi httpdladm GET /v1/download None Get download status/list or abort/remove download jobs
DownloadApi httpdladmdeleteabort DELETE /v1/download/abort None Get download status/list or abort/remove download jobs
DownloadApi httpdladmdeleteremove DELETE /v1/download/remove None Get download status/list or abort/remove download jobs
DownloadApi httpdlpost POST /v1/download None Start a new download job to fetch external data into AIStore buckets
EcApi httpecpost POST /v1/ec/open-ec-streams None Enable or disable erasure coding and shared data management
EcApi httpecpostpostcloseecstreams POST /v1/ec/close-ec-streams None Enable or disable erasure coding and shared data management
EcApi httpecpostpostcloseshareddm POST /v1/ec/close-shared-dm None Enable or disable erasure coding and shared data management
EcApi httpecpostpostopenshareddm POST /v1/ec/open-shared-dm None Enable or disable erasure coding and shared data management
EtlApi httpetldel DELETE /v1/etl/{etl-name} None Delete and remove an ETL job by name
EtlApi httpetlget GET /v1/etl/{etl-name} None List ETL jobs or get information, logs, health, and metrics for specific ETL jobs
EtlApi httpetlgetgethealth GET /v1/etl/{etl-name}/health None List ETL jobs or get information, logs, health, and metrics for specific ETL jobs
EtlApi httpetlgetgetlogs GET /v1/etl/{etl-name}/logs None List ETL jobs or get information, logs, health, and metrics for specific ETL jobs
EtlApi httpetlgetgetmetrics GET /v1/etl/{etl-name}/metrics None List ETL jobs or get information, logs, health, and metrics for specific ETL jobs
EtlApi httpetlpost POST /v1/etl/{etl-name}/start None Start or stop ETL jobs by name
EtlApi httpetlpostpoststop POST /v1/etl/{etl-name}/stop None Start or stop ETL jobs by name
EtlApi httpetlput PUT /v1/etl None Create and initialize a new ETL job to transform data during transfers. Request body: etl.InitMsg (JSON) Returns: ETL UUID on success.
HealthApi healthHandler GET /v1/health prr, cii, apr Get cluster and node health status
MetasyncApi metasyncHandler PUT /v1/metasync None Internal metadata synchronization between cluster nodes (compare with p.recvCluMeta and t.metasyncHandlerPut)
MlApi httpmlget GET /v1/ml/moss/{bucket} tid Machine Learning endpoint for batch processing of objects using MOSS (Multi-Object Streaming Service)
ObjectsApi httpobjdelete DELETE /v1/objects/{bucket-name}/{object-name} provider, namespace Delete an object with the given uname
ObjectsApi httpobjget GET /v1/objects/{bucket-name}/{object-name} provider, namespace, original_url, latest-ver Retrieve the object content with the given uname
ObjectsApi httpobjhead HEAD /v1/objects/{bucket-name}/{object-name} provider, namespace, sln Get object metadata and properties
ObjectsApi httpobjpatch PATCH /v1/objects/{bucket-name}/{object-name} provider, namespace Update object metadata and custom properties
ObjectsApi httpobjpost POST /v1/objects/{bucket-name}/{object-name} provider, namespace Perform actions on objects (rename, promote, blob download, check lock)
ObjectsApi httpobjput PUT /v1/objects/{bucket-name}/{object-name} append_type, append_handle Create a new object with the given uname
SortApi dsortHandler POST /v1/sort None Start, monitor, abort, or remove distributed sort (dsort) jobs
SortApi dsortHandlerdeleteabort DELETE /v1/sort/abort None Start, monitor, abort, or remove distributed sort (dsort) jobs
SortApi dsortHandlerdeletesort DELETE /v1/sort None Start, monitor, abort, or remove distributed sort (dsort) jobs
SortApi dsortHandlergetsort GET /v1/sort None Start, monitor, abort, or remove distributed sort (dsort) jobs

Documentation for Models

💡 Note: All models only represent the expected value field in the final body payload for the corresponding action. The complete JSON body should look like: 

{
  "action": "selected action",
  "value": "the model",
  "name": "specify if needed for the selected action"
}
Model Description
apc.BlobMsg Model definition for apc.BlobMsg
apc.ListRange Model definition for apc.ListRange
apc.MossIn Model definition for apc.MossIn
apc.MossReq Model definition for apc.MossReq
apc.PromoteArgs Model definition for apc.PromoteArgs
apc.TCBMsg Model definition for apc.TCBMsg
cmn.Bck Model definition for cmn.Bck
cmn.DsortConf Model definition for cmn.DsortConf
cmn.Ns Model definition for cmn.Ns
dsort.Algorithm Model definition for dsort.Algorithm
dsort.RequestSpec Model definition for dsort.RequestSpec