These endpoints allow you to communicate with Immuta the same way you would with S3, making Immuta easy to integrate with tools you may already be using to work with S3. In this integration, Immuta implements a single bucket (with data sources broken up as sub-directories under that bucket), since some S3 tools only support the new virtual-hosted style requests.
The endpoints outlined below support basic AWS functionality; the requests and responses for each are identical to those in S3.
Additional fields may be included in some responses you receive; however, these attributes are for internal purposes and are therefore undocumented.
GET /s3p
Return constant bucket that all data sources are grouped under.
| Attribute | Description |
|---|---|
The following request returns the bucket all data sources are grouped under for the organization.
The following response lists the bucket immuta.
GET /s3p/{bucket}
Return the contents of a given bucket (data sources or data source blobs).
The following request returns a list of data sources in the bucket immuta.
The following response lists the data source blob immuta.
GET /s3p/{bucket}/{dataSource}/{key}
Return a specific blob.
The following request returns the contents of the single file that exists in the requested directory in immuta.
The following response lists the size, storage class, owner, and the last date of modification of the single file.
| Attribute | Description | Required |
|---|---|---|
| Attribute | Description |
|---|---|
| Attribute | Description | Required |
|---|---|---|
| Attribute | Description |
|---|---|
body
string Lists the bucket, organization, and owner of the bucket.
bucket
string Name of the bucket (this should match the bucket name in configuration).
Yes
prefix
string The prefix to start a search under.
No
max-keys
number Max number of content objects to return.
No
delimiter
string The terminating character for a search.
No
marker
string When provided, only prefixes after this marker will be returned.
No
location
string If provided, will instead return the bucket location.
No
encoding-type
string Encoding type for content keys.
No
list-type
integer If set to 2, will use v2 of the API response.
No
fetch-owner
boolean When true, will return owner field in v2 API response.
No
start-after
string Only prefixes after this marker will be returned. (This is the v2 API version of marker).
No
body
string Lists the data sources and/or data source blobs in the bucket.
bucket
string Name of the bucket (this should match the bucket name in configuration).
Yes
dataSource
string Immuta S3 Folder to search in.
Yes
key
string Key path to search for the specified file.
Yes
body
string Lists the data sources and/or data source blobs in the bucket.