s3

Manage S3 access.
get /s3/users

List of S3 users.

Parameters
uid array query
string
pagination string query
Responses
200 successful operation
RgwUserResponse array
RgwUserResponse object 
[
  {
    "uid": "string",
    "name": "string",
    "email": "string",
    "subusers": [
      {
        "subuser": "string",
        "permissions": "full-control"
      }
    ],
    "suspended": true,
    "userQuota": {
      "enabled": true,
      "maxSize": 0,
      "maxObjects": 0,
      "max_objects": 0,
      "max_size_kb": 0,
      "maxSizeFormatted": "string",
      "maxObjectsFormatted": "string"
    },
    "bucketQuota": {
      "enabled": true,
      "maxSize": 0,
      "maxObjects": 0,
      "max_objects": 0,
      "max_size_kb": 0,
      "maxSizeFormatted": "string",
      "maxObjectsFormatted": "string"
    },
    "defaultPlacement": "string",
    "subusersFormatted": "string",
    "defaultStorageClass": "string"
  }
]
post /s3/users
Parameters
body object 
{
  "uid": "string",
  "name": "string",
  "email": "string",
  "defaultPlacement": "string",
  "defaultStorageClass": "string"
}
Responses
default successful operation
get /s3/buckets

List of all buckets.

Parameters
pagination string query
Responses
200 successful operation
RgwBucketResponse array
RgwBucketResponse object 
[
  {
    "id": "string",
    "owner": "string",
    "quota": {
      "enabled": true,
      "maxSize": 0,
      "maxObjects": 0,
      "max_objects": 0,
      "max_size_kb": 0,
      "maxSizeFormatted": "string",
      "maxObjectsFormatted": "string"
    },
    "usage": {
      "additionalProp1": {
        "sizeKiB": 0,
        "size_kb": 0,
        "numObjects": 0,
        "num_objects": 0,
        "sizeFormatted": "string",
        "sizeKiBActual": 0,
        "size_kb_actual": 0
      },
      "additionalProp2": {
        "sizeKiB": 0,
        "size_kb": 0,
        "numObjects": 0,
        "num_objects": 0,
        "sizeFormatted": "string",
        "sizeKiBActual": 0,
        "size_kb_actual": 0
      },
      "additionalProp3": {
        "sizeKiB": 0,
        "size_kb": 0,
        "numObjects": 0,
        "num_objects": 0,
        "sizeFormatted": "string",
        "sizeKiBActual": 0,
        "size_kb_actual": 0
      }
    },
    "bucket": "string",
    "tenant": "string",
    "modified": 0,
    "usageSum": {
      "sizeKiB": 0,
      "size_kb": 0,
      "numObjects": 0,
      "num_objects": 0,
      "sizeFormatted": "string",
      "sizeKiBActual": 0,
      "size_kb_actual": 0
    },
    "zonegroup": "string",
    "placement_rule": "string"
  }
]
get /s3/placements

List all available placement policies in all zones.

Parameters
pagination string query
Responses
200 successful operation
RgwPlacementResponse object 
{
  "data": [
    {
      "name": "string",
      "default": true,
      "dataPool": "string",
      "indexPool": "string",
      "storageClass": "string",
      "dataExtraPool": "string"
    }
  ],
  "after": 0,
  "limit": 0,
  "total": 0,
  "placements": [
    {
      "name": "string",
      "default": true,
      "dataPool": "string",
      "indexPool": "string",
      "storageClass": "string",
      "dataExtraPool": "string"
    }
  ],
  "defaultStorageClass": "string",
  "defaultPlacementRule": "string"
}
get /s3/user-names
Responses
200 successful operation
array
string 
[
  "string"
]
post /s3/users/{uid}
Parameters
uid string path Required
body object 
{
  "subuser": "string",
  "permissions": "full-control"
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "question": {
    "token": "string",
    "message": "string",
    "timeout": 0,
    "priority": "Standard",
    "timeLeft": 0,
    "defaultResponse": "string",
    "responseOptions": [
      "string"
    ]
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0,
  "interactive": true
}
patch /s3/users/{uid}
Parameters
uid string path Required
body object 
{
  "name": "string",
  "email": "string",
  "suspended": true,
  "defaultPlacement": "string",
  "defaultStorageClass": "string"
}
Responses
default successful operation
delete /s3/users/{uid}
Parameters
uid string path Required
Responses
default successful operation
get /s3/users/{uid}/key
Parameters
uid string path Required
Responses
200 successful operation
RgwUserKey object 
{
  "user": "string",
  "accessKey": "string",
  "secretKey": "string"
}
get /s3/users/{uid}/keys
Parameters
uid string path Required
Responses
200 successful operation
RgwUserKey array
RgwUserKey object 
[
  {
    "user": "string",
    "accessKey": "string",
    "secretKey": "string"
  }
]
put /s3/users/{uid}/keys
Parameters
uid string path Required
body object 
{
  "keys": [
    {
      "user": "string",
      "accessKey": "string",
      "secretKey": "string"
    }
  ]
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "question": {
    "token": "string",
    "message": "string",
    "timeout": 0,
    "priority": "Standard",
    "timeLeft": 0,
    "defaultResponse": "string",
    "responseOptions": [
      "string"
    ]
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0,
  "interactive": true
}
put /s3/default-placement

Set the default placement rule. This API does not support multi-site setups.

Parameters
body object 
{
  "storageClass": "string",
  "placementRule": "string"
}
Responses
default successful operation
put /s3/placements/{name}

Create a new placement policy in the default zonegroup in the default zone. This API does not support multi-site setups.

Parameters
name string path Required
The name for the policy, each zone within a zonegroup must have a policy with the same name.
body object 
{
  "dataPool": "string",
  "indexPool": "string",
  "dataExtraPool": "string"
}
Responses
default successful operation
put /s3/users/{uid}/quota

Set a quota for this user.

Parameters
uid string path Required
body object 
{
  "enabled": true,
  "maxSize": 0,
  "maxObjects": 0,
  "maxSizeNew": 0,
  "maxObjectsNew": 0,
  "maxObjectsOld": 0,
  "maxSizeKiBOld": 0
}
Responses
default successful operation
get /s3/usage/by-user/{uid}

Retrieve usage statistics for a given S3 user.

Return results aggregated into 1 hour intervals for all buckets the user accessed. Caution: this cannot be used for the anonymous user This can be an expensive call in term of IOPS, do not poll this unnecessarily. The idea is to store the results in an accounting system. Calling this will also trim the S3 usage log if enabled in /config/config.yml, see trimS3Usage in /config/config.yml.default This requires enabling the Ceph option "rgw enable usage log", see https://docs.ceph.com/docs/master/man/8/radosgw/#usage-logging

Parameters
uid string path Required
hours integer query
How many hours to go back.
Responses
200 successful operation
S3UsageForUserByBucketResponse object
Usage data for a user, split by bucket.
{
  "buckets": {
    "additionalProp1": [
      {
        "time": 0,
        "bucketName": "string",
        "bucketOwner": "string",
        "bytesUploaded": 0,
        "bytesDownloaded": 0,
        "failedOperations": 0,
        "successfulOperations": 0,
        "metadataBytesDownloaded": 0
      }
    ],
    "additionalProp2": [
      {
        "time": 0,
        "bucketName": "string",
        "bucketOwner": "string",
        "bytesUploaded": 0,
        "bytesDownloaded": 0,
        "failedOperations": 0,
        "successfulOperations": 0,
        "metadataBytesDownloaded": 0
      }
    ],
    "additionalProp3": [
      {
        "time": 0,
        "bucketName": "string",
        "bucketOwner": "string",
        "bytesUploaded": 0,
        "bytesDownloaded": 0,
        "failedOperations": 0,
        "successfulOperations": 0,
        "metadataBytesDownloaded": 0
      }
    ]
  }
}
get /s3/users/{uid}/buckets

List all buckets owner by the user.

Parameters
uid string path Required
Responses
200 successful operation
RgwBucketResponse array
RgwBucketResponse object 
[
  {
    "id": "string",
    "owner": "string",
    "quota": {
      "enabled": true,
      "maxSize": 0,
      "maxObjects": 0,
      "max_objects": 0,
      "max_size_kb": 0,
      "maxSizeFormatted": "string",
      "maxObjectsFormatted": "string"
    },
    "usage": {
      "additionalProp1": {
        "sizeKiB": 0,
        "size_kb": 0,
        "numObjects": 0,
        "num_objects": 0,
        "sizeFormatted": "string",
        "sizeKiBActual": 0,
        "size_kb_actual": 0
      },
      "additionalProp2": {
        "sizeKiB": 0,
        "size_kb": 0,
        "numObjects": 0,
        "num_objects": 0,
        "sizeFormatted": "string",
        "sizeKiBActual": 0,
        "size_kb_actual": 0
      },
      "additionalProp3": {
        "sizeKiB": 0,
        "size_kb": 0,
        "numObjects": 0,
        "num_objects": 0,
        "sizeFormatted": "string",
        "sizeKiBActual": 0,
        "size_kb_actual": 0
      }
    },
    "bucket": "string",
    "tenant": "string",
    "modified": 0,
    "usageSum": {
      "sizeKiB": 0,
      "size_kb": 0,
      "numObjects": 0,
      "num_objects": 0,
      "sizeFormatted": "string",
      "sizeKiBActual": 0,
      "size_kb_actual": 0
    },
    "zonegroup": "string",
    "placement_rule": "string"
  }
]
get /s3/buckets/{bucketName}
Parameters
bucketName string path Required
owner string query
Responses
200 successful operation
BucketDetails object 
{
  "acl": [
    {
      "userId": "string",
      "grantee": "ALL_USERS",
      "permission": "FullControl",
      "displayName": "string"
    }
  ],
  "cors": [
    {
      "id": "string",
      "maxAgeSeconds": 0,
      "allowedHeaders": [
        "string"
      ],
      "allowedMethods": [
        "GET"
      ],
      "allowedOrigins": [
        "string"
      ],
      "exposedHeaders": [
        "string"
      ]
    }
  ],
  "versioning": "OFF"
}
put /s3/buckets/{bucketName}

Create a new S3 bucket.

Parameters
bucketName string path Required
body object
Create an S3 bucket.
{
  "acl": [
    {
      "userId": "string",
      "grantee": "ALL_USERS",
      "permission": "FullControl",
      "displayName": "string"
    }
  ],
  "owner": "string",
  "endpoint": "string",
  "placement": "string",
  "versioning": "OFF",
  "expectedNumberOfObjects": 0
}
Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
patch /s3/buckets/{bucketName}
Parameters
bucketName string path Required
owner string query
body object
Update an S3 bucket.
{
  "acl": [
    {
      "userId": "string",
      "grantee": "ALL_USERS",
      "permission": "FullControl",
      "displayName": "string"
    }
  ],
  "owner": "string",
  "versioning": "OFF"
}
Responses
default successful operation
delete /s3/buckets/{bucketName}
Parameters
bucketName string path Required
owner string query
body object 
{
  "name": "string",
  "deleteData": true,
  "thisWillDeleteData": "string"
}
Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
get /s3/users/{uid}/subusers
Parameters
uid string path Required
Responses
200 successful operation
RgwSubUser array
RgwSubUser object 
[
  {
    "id": "string",
    "permissions": "full-control"
  }
]
put /s3/users/{uid}/subusers
Parameters
uid string path Required
body object 
{
  "subusers": [
    {
      "subuser": "string",
      "permissions": "full-control"
    }
  ]
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "question": {
    "token": "string",
    "message": "string",
    "timeout": 0,
    "priority": "Standard",
    "timeLeft": 0,
    "defaultResponse": "string",
    "responseOptions": [
      "string"
    ]
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0,
  "interactive": true
}
put /s3/users/{uid}/bucket-quota

Set a quota for all buckets owned by this user.

Parameters
uid string path Required
body object 
{
  "enabled": true,
  "maxSize": 0,
  "maxObjects": 0,
  "maxSizeNew": 0,
  "maxObjectsNew": 0,
  "maxObjectsOld": 0,
  "maxSizeKiBOld": 0
}
Responses
default successful operation
put /s3/buckets/{bucketName}/quota

Set a quota for this bucket.

Parameters
bucketName string path Required
owner string query
body object 
{
  "enabled": true,
  "maxSize": 0,
  "maxObjects": 0,
  "maxSizeNew": 0,
  "maxObjectsNew": 0,
  "maxObjectsOld": 0,
  "maxSizeKiBOld": 0
}
Responses
default successful operation
get /s3/buckets/{bucketName}/policy

Get a bucket policy.

Parameters
bucketName string path Required
owner string query
Responses
200 successful operation
BucketPolicy object 
{
  "policyText": "string"
}
post /s3/buckets/{bucketName}/policy

Create or update a bucket policy. See the ceph documentation for the list of currently supported actions.

Parameters
bucketName string path Required
owner string query
body
Bucket policy in JSON format.
null
Responses
default successful operation
delete /s3/buckets/{bucketName}/policy

Delete a bucket policy.

Parameters
bucketName string path Required
owner string query
Responses
default successful operation
put /s3/buckets/{bucketName}/upload

Upload an object.

Parameters
bucketName string path Required
owner string query
key string formData
file file formData
size integer formData
Required to write large files directly into Ceph, uploads without this field must be buffered in RAM
Responses
default successful operation
get /s3/buckets/{bucketName}/objects

List objects in a bucket. Refer to S3 documentation for listing details

Parameters
bucketName string path Required
owner string query
max integer query
prefix string query
continuationToken string query
flatView boolean query
Responses
200 successful operation
S3Listing object 
{
  "objects": [
    {
      "key": "string",
      "etag": "string",
      "size": 0,
      "owner": {
        "id": "string",
        "displayName": "string"
      },
      "bucketName": "string",
      "lastModified": "string",
      "storageClass": "string"
    }
  ],
  "prefixes": [
    {
      "prefix": "string",
      "lastModified": "string"
    }
  ],
  "continuationToken": "string"
}
delete /s3/buckets/{bucketName}/objects

Delete an object by name.

Parameters
bucketName string path Required
owner string query
key string query
Responses
default successful operation
get /s3/usage/by-bucket/{bucketName}

Retrieve latest usage statistics for a given S3 bucket.

Return results aggregated into 1 hour intervals for all users that accessed the bucket. This can be an expensive call in term of IOPS, do not poll this unnecessarily. The idea is to store the results in an accounting system. Calling this will also trim the S3 usage log if enabled in /config/config.yml, see trimS3Usage in /config/config.yml.default This requires enabling the Ceph option "rgw enable usage log", see https://docs.ceph.com/docs/master/man/8/radosgw/#usage-logging

Parameters
bucketName string path Required
hours integer query
How many hours to go back.
Responses
200 successful operation
S3UsageForBucketByUserResponse object
Usage data for a bucket, split by user performing the operation.
{
  "buckets": {
    "additionalProp1": [
      {
        "time": 0,
        "bucketName": "string",
        "bucketOwner": "string",
        "bytesUploaded": 0,
        "bytesDownloaded": 0,
        "failedOperations": 0,
        "successfulOperations": 0,
        "metadataBytesDownloaded": 0
      }
    ],
    "additionalProp2": [
      {
        "time": 0,
        "bucketName": "string",
        "bucketOwner": "string",
        "bytesUploaded": 0,
        "bytesDownloaded": 0,
        "failedOperations": 0,
        "successfulOperations": 0,
        "metadataBytesDownloaded": 0
      }
    ],
    "additionalProp3": [
      {
        "time": 0,
        "bucketName": "string",
        "bucketOwner": "string",
        "bytesUploaded": 0,
        "bytesDownloaded": 0,
        "failedOperations": 0,
        "successfulOperations": 0,
        "metadataBytesDownloaded": 0
      }
    ]
  }
}
put /s3/users/{uid}/keys/{accessKey}
Parameters
uid string path Required
accessKey string path Required
secretKey string query
Responses
default successful operation
delete /s3/users/{uid}/keys/{accessKey}
Parameters
uid string path Required
accessKey string path Required
Responses
default successful operation
get /s3/buckets/{bucketName}/download

Download an object.

Parameters
bucketName string path Required
owner string query
key string query
Responses
200 successful operation
DownloadableObject object 
{
  "url": "string",
  "fileName": "string",
  "fileContents": "string"
}
get /s3/users/{uid}/cfg-file/download
Parameters
uid string path Required
Responses
200 successful operation
DownloadableObject object 
{
  "url": "string",
  "fileName": "string",
  "fileContents": "string"
}
patch /s3/users/{uid}/subusers/{subuser}
Parameters
uid string path Required
subuser string path Required
body object 
{
  "permissions": "full-control"
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "question": {
    "token": "string",
    "message": "string",
    "timeout": 0,
    "priority": "Standard",
    "timeLeft": 0,
    "defaultResponse": "string",
    "responseOptions": [
      "string"
    ]
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0,
  "interactive": true
}
delete /s3/users/{uid}/subusers/{subuser}
Parameters
uid string path Required
subuser string path Required
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "question": {
    "token": "string",
    "message": "string",
    "timeout": 0,
    "priority": "Standard",
    "timeLeft": 0,
    "defaultResponse": "string",
    "responseOptions": [
      "string"
    ]
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0,
  "interactive": true
}
get /s3/buckets/{bucketName}/objects/acl

Get the current ACL of an object.

Parameters
bucketName string path Required
owner string query
key string query
Responses
200 successful operation
AclEntry array
AclEntry object
An ACL entry for a bucket, see S3 documentation for details.
[
  {
    "userId": "string",
    "grantee": "ALL_USERS",
    "permission": "FullControl",
    "displayName": "string"
  }
]
put /s3/buckets/{bucketName}/objects/acl

Override an object's ACL.

Parameters
bucketName string path Required
owner string query
key string query
body array
AclEntry object
An ACL entry for a bucket, see S3 documentation for details.
[
  {
    "userId": "string",
    "grantee": "ALL_USERS",
    "permission": "FullControl",
    "displayName": "string"
  }
]
Responses
default successful operation
put /s3/buckets/{bucketName}/objects/copy

Copy an object.

Parameters
bucketName string path Required
owner string query
key string query
dstBucketName string query
dstKey string query
Responses
default successful operation
put /s3/buckets/{bucketName}/objects/move

Move an object.

Parameters
bucketName string path Required
owner string query
key string query
dstBucketName string query
dstKey string query
Responses
default successful operation
get /s3/users/{uid}/subusers/{subuser}/keys
Parameters
uid string path Required
subuser string path Required
Responses
200 successful operation
RgwUserKey array
RgwUserKey object 
[
  {
    "user": "string",
    "accessKey": "string",
    "secretKey": "string"
  }
]
get /s3/buckets/{bucketName}/objects/metadata

Get metadata of an object.

Parameters
bucketName string path Required
owner string query
key string query
Responses
200 successful operation
S3Metadata object 
{
  "raw": {
    "additionalProp1": {},
    "additionalProp2": {},
    "additionalProp3": {}
  },
  "etag": "string",
  "size": 0,
  "versionId": "string",
  "contentMD5": "string",
  "contentType": "string",
  "cacheControl": "string",
  "lastModified": 0,
  "userMetadata": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "expirationTime": 0,
  "contentEncoding": "string",
  "contentLanguage": "string",
  "httpExpiresDate": 0,
  "contentDisposition": "string",
  "expirationTimeRuleId": "string"
}
put /s3/buckets/{bucketName}/objects/metadata

Override object metadata.

Parameters
bucketName string path Required
owner string query
key string query
body object 
{
  "raw": {
    "additionalProp1": {},
    "additionalProp2": {},
    "additionalProp3": {}
  },
  "etag": "string",
  "size": 0,
  "versionId": "string",
  "contentMD5": "string",
  "contentType": "string",
  "cacheControl": "string",
  "lastModified": 0,
  "userMetadata": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "expirationTime": 0,
  "contentEncoding": "string",
  "contentLanguage": "string",
  "httpExpiresDate": 0,
  "contentDisposition": "string",
  "expirationTimeRuleId": "string"
}
Responses
default successful operation
get /s3/buckets/{bucketName}/multipart-uploads

List active and abandoned multi-part uploads. API params are identical to object listing.

Parameters
bucketName string path Required
owner string query
max integer query
prefix string query
continuationToken string query
flatView boolean query
Responses
200 successful operation
MultipartUploadListing object 
{
  "objects": [
    {
      "key": "string",
      "owner": {
        "id": "string",
        "displayName": "string"
      },
      "uploadId": "string",
      "initiated": "string",
      "initiator": {
        "id": "string",
        "displayName": "string"
      },
      "storageClass": "string"
    }
  ],
  "prefixes": [
    "string"
  ],
  "continuationToken": "string"
}
delete /s3/buckets/{bucketName}/multipart-uploads

Cancel an active or abandoned multi-part upload.

Parameters
bucketName string path Required
owner string query
key string query
uploadId string query
Responses
default successful operation
get /s3/buckets/{bucketName}/objects-paginated

List objects and prefixes in a bucket. Uses croit's pagination.

Parameters
bucketName string path Required
owner string query
prefix string query
flatView boolean query
pagination string query
maxQueried integer query
Maximum number of S3 objects queried for filtering.
Responses
200 successful operation
S3ObjectsResponse object 
{
  "data": [
    {
      "key": "string",
      "etag": "string",
      "size": 0,
      "owner": {
        "id": "string",
        "displayName": "string"
      },
      "bucketName": "string",
      "lastModified": "string",
      "storageClass": "string",
      "sizeFormatted": "string",
      "keyWithoutPrefix": "string"
    }
  ],
  "after": 0,
  "limit": 0,
  "total": 0,
  "prefixes": [
    "string"
  ]
}
put /s3/users/{uid}/subusers/{subuser}/keys/{accessKey}
Parameters
uid string path Required
subuser string path Required
accessKey string path Required
secretKey string query
Responses
default successful operation
delete /s3/users/{uid}/subusers/{subuser}/keys/{accessKey}
Parameters
uid string path Required
subuser string path Required
accessKey string path Required
Responses
default successful operation
get /s3/buckets/{bucketName}/multipart-uploads-paginated

List active and abandoned multi-part uploads. Uses croit's pagination.

Parameters
bucketName string path Required
owner string query
prefix string query
flatView boolean query
pagination string query
maxQueried integer query
Responses
200 successful operation
S3MultipartUploadResponse object 
{
  "data": [
    {
      "key": "string",
      "owner": {
        "id": "string",
        "displayName": "string"
      },
      "uploadId": "string",
      "initiated": "string",
      "initiator": {
        "id": "string",
        "displayName": "string"
      },
      "storageClass": "string",
      "keyWithoutPrefix": "string"
    }
  ],
  "after": 0,
  "limit": 0,
  "total": 0,
  "prefixes": [
    "string"
  ]
}
get /s3/users/{uid}/subusers/{subuser}/cfg-file/download
Parameters
uid string path Required
subuser string path Required
Responses
200 successful operation
DownloadableObject object 
{
  "url": "string",
  "fileName": "string",
  "fileContents": "string"
}
put /s3/placements/{placementRule}/storage-classes/{storageClass}

Set storage classes on placement rules. This API does not support multi-site setups.

Parameters
placementRule string path Required
The name of an (existing) placement rule.
storageClass string path Required
The name for storage class to add or edit.
body object 
{
  "dataPool": "string"
}
Responses
default successful operation
delete /s3/placements/{placementRule}/storage-classes/{storageClass}

Delete a storage class on a placement rule. Deletes the entire placement rule when specifying the STANDARD storage class. This API does not support multi-site setups.

Parameters
placementRule string path Required
The name of an (existing) placement rule.
storageClass string path Required
The name for storage class to remove, or STANDARD to remove the entire placement rule.
Responses
default successful operation