s3

Manage S3 access.

get /s3/users

Arguments
  • No arguments...

Definition
get /s3/users
Attributes
  • uidstring

    -

  • namestring

    -

  • emailstring

    -

  • suspendedboolean

    -

  • subusersarray

    -

    • subuserstring

      -

    • permissionsstring

      [full-control, read-write, read, write]

  • bucketQuotaobject

    -

    • enabledboolean

      -

    • maxSizeKbinteger

      -

    • maxObjectsinteger

      -

  • userQuotaobject

    -

    • enabledboolean

      -

    • maxSizeKbinteger

      -

    • maxObjectsinteger

      -

Example response
[ { "uid": "string", "name": "string", "email": "string", "suspended": true, "subusers": [ { "subuser": "string", "permissions": "full-control" } ], "bucketQuota": { "enabled": true, "maxSizeKb": 0, "maxObjects": 0 }, "userQuota": { "enabled": true, "maxSizeKb": 0, "maxObjects": 0 } } ]

post /s3/users

Arguments
  • bodyoptional

    -

Definition
post /s3/users

get /s3/users/{uid}/key

Arguments
  • uidrequiredstring

    -

Definition
get /s3/users/{uid}/key
Attributes
  • userstring

    -

  • accessKeystring

    -

  • secretKeystring

    -

Example response
{ "user": "string", "accessKey": "string", "secretKey": "string" }

get /s3/users/{uid}/{subuser}/key

Arguments
  • uidrequiredstring

    -

  • subuserrequiredstring

    -

Definition
get /s3/users/{uid}/{subuser}/key
Attributes
  • userstring

    -

  • accessKeystring

    -

  • secretKeystring

    -

Example response
{ "user": "string", "accessKey": "string", "secretKey": "string" }

get /s3/users/{uid}/cfg-file/download

Arguments
  • uidrequiredstring

    -

Definition
get /s3/users/{uid}/cfg-file/download
Attributes
  • fileNamestring

    -

  • urlstring

    -

  • fileContentsstring

    -

Example response
{ "fileName": "string", "url": "string", "fileContents": "string" }

get /s3/users/{uid}/{subuser}/cfg-file/download

Arguments
  • uidrequiredstring

    -

  • subuserrequiredstring

    -

Definition
get /s3/users/{uid}/{subuser}/cfg-file/download
Attributes
  • fileNamestring

    -

  • urlstring

    -

  • fileContentsstring

    -

Example response
{ "fileName": "string", "url": "string", "fileContents": "string" }

post /s3/users/{uid}

Arguments
  • uidrequiredstring

    -

  • bodyoptional

    -

Definition
post /s3/users/{uid}

delete /s3/users/{uid}

Arguments
  • uidrequiredstring

    -

Definition
delete /s3/users/{uid}

patch /s3/users/{uid}

Arguments
  • uidrequiredstring

    -

  • bodyoptional

    -

Definition
patch /s3/users/{uid}

delete /s3/users/{uid}/{subuser}

Arguments
  • uidrequiredstring

    -

  • subuserrequiredstring

    -

Definition
delete /s3/users/{uid}/{subuser}

patch /s3/users/{uid}/{subuser}

Arguments
  • uidrequiredstring

    -

  • subuserrequiredstring

    -

  • bodyoptional

    -

Definition
patch /s3/users/{uid}/{subuser}

put /s3/users/{uid}/quota

Set a quota for this user.

Arguments
  • uidrequiredstring

    -

  • bodyoptional

    -

Definition
put /s3/users/{uid}/quota

put /s3/users/{uid}/bucket-quota

Set a quota for all buckets owned by this user.

Arguments
  • uidrequiredstring

    -

  • bodyoptional

    -

Definition
put /s3/users/{uid}/bucket-quota

get /s3/users/{uid}/buckets

List all buckets owner by the user.

Arguments
  • uidrequiredstring

    -

Definition
get /s3/users/{uid}/buckets
Attributes
  • bucketstring

    -

  • placement_rulestring

    -

  • idstring

    -

  • ownerstring

    -

  • zonegroupstring

    -

  • modifiedinteger

    -

  • usageobject

    Data usage by zone.

  • quotaobject

    -

    • enabledboolean

      -

    • maxSizeKbinteger

      -

    • maxObjectsinteger

      -

  • usageSumobject

    -

    • sizeKbinteger

      -

    • sizeKbActualinteger

      -

    • numObjectsnumber

      -

Example response
[ { "bucket": "string", "placement_rule": "string", "id": "string", "owner": "string", "zonegroup": "string", "modified": 0, "usage": {}, "quota": { "enabled": true, "maxSizeKb": 0, "maxObjects": 0 }, "usageSum": { "sizeKb": 0, "sizeKbActual": 0, "numObjects": } } ]

get /s3/buckets

Arguments
  • No arguments...

Definition
get /s3/buckets
Attributes
  • bucketstring

    -

  • placement_rulestring

    -

  • idstring

    -

  • ownerstring

    -

  • zonegroupstring

    -

  • modifiedinteger

    -

  • usageobject

    Data usage by zone.

  • quotaobject

    -

    • enabledboolean

      -

    • maxSizeKbinteger

      -

    • maxObjectsinteger

      -

  • usageSumobject

    -

    • sizeKbinteger

      -

    • sizeKbActualinteger

      -

    • numObjectsnumber

      -

Example response
[ { "bucket": "string", "placement_rule": "string", "id": "string", "owner": "string", "zonegroup": "string", "modified": 0, "usage": {}, "quota": { "enabled": true, "maxSizeKb": 0, "maxObjects": 0 }, "usageSum": { "sizeKb": 0, "sizeKbActual": 0, "numObjects": } } ]

get /s3/placements

List all available placement policies in all zones.

Arguments
  • No arguments...

Definition
get /s3/placements
Attributes
Example response
{}

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.

Arguments
  • namerequiredstring

    The name for the policy, each zone within a zonegroup must have a policy with the same name.

  • bodyoptional

    -

Definition
put /s3/placements/{name}

delete /s3/placements/{name}

Delete an unused placement policy. This API does not support multi-site setups.

Arguments
  • namerequiredstring

    -

Definition
delete /s3/placements/{name}

put /s3/buckets/{bucketName}/quota

Set a quota for this bucket.

Arguments
  • bucketNamerequiredstring

    -

  • bodyoptional

    -

Definition
put /s3/buckets/{bucketName}/quota

get /s3/buckets/{bucketName}

Arguments
  • bucketNamerequiredstring

    -

Definition
get /s3/buckets/{bucketName}
Attributes
  • corsarray

    -

    • idstring

      -

    • allowedMethodsarray

      -

    • allowedOriginsarray

      -

    • maxAgeSecondsinteger

      -

    • exposedHeadersarray

      -

    • allowedHeadersarray

      -

  • aclarray

    -

    • granteestring

      [ALL_USERS, AUTHENTICATED_USERS, SINGLE_USER, LOG_DELIVERY]

    • userIdstring

      Only meaningful if grantee == SINGLE_USER.

    • displayNamestring

      Informational. Not used when setting ACLs.

    • permissionstring

      [FullControl, Read, Write, ReadAcp, WriteAcp]

  • versioningstring

    [OFF, ENABLED, SUSPENDED, UNKNOWN]

Example response
{ "cors": [ { "id": "string", "allowedMethods": [ "GET" ], "allowedOrigins": [ "string" ], "maxAgeSeconds": 0, "exposedHeaders": [ "string" ], "allowedHeaders": [ "string" ] } ], "acl": [ { "grantee": "ALL_USERS", "userId": "string", "displayName": "string", "permission": "FullControl" } ], "versioning": "OFF" }

put /s3/buckets/{bucketName}

Create a new S3 bucket.

Arguments
  • bucketNamerequiredstring

    -

  • bodyoptional

    -

Definition
put /s3/buckets/{bucketName}
Attributes
  • namestring

    -

  • idinteger

    -

  • statestring

    [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

  • resultobject

    -

  • doneboolean

    -

  • statusCodeinteger

    -

  • startedAtinteger

    -

  • startedBystring

    -

  • objectstring

    -

  • outputstring

    -

Example response
{ "name": "string", "id": 0, "state": "WAITING", "result": {}, "done": true, "statusCode": 0, "startedAt": 0, "startedBy": "string", "object": "string", "output": "string" }

delete /s3/buckets/{bucketName}

Arguments
  • bucketNamerequiredstring

    -

  • bodyoptional

    -

Definition
delete /s3/buckets/{bucketName}
Attributes
  • namestring

    -

  • idinteger

    -

  • statestring

    [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

  • resultobject

    -

  • doneboolean

    -

  • statusCodeinteger

    -

  • startedAtinteger

    -

  • startedBystring

    -

  • objectstring

    -

  • outputstring

    -

Example response
{ "name": "string", "id": 0, "state": "WAITING", "result": {}, "done": true, "statusCode": 0, "startedAt": 0, "startedBy": "string", "object": "string", "output": "string" }

patch /s3/buckets/{bucketName}

Arguments
  • bucketNamerequiredstring

    -

  • bodyoptional

    -

Definition
patch /s3/buckets/{bucketName}

get /s3/buckets/{bucketName}/objects

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

Arguments
  • bucketNamerequiredstring

    -

  • maxoptionalinteger

    -

  • prefixoptionalstring

    -

  • continuationTokenoptionalstring

    -

  • flatViewoptionalboolean

    -

Definition
get /s3/buckets/{bucketName}/objects
Attributes
  • prefixesarray

    -

  • objectsarray

    -

    • bucketNamestring

      -

    • keystring

      -

    • sizeinteger

      -

    • lastModifiedstring

      -

    • storageClassstring

      -

    • ownerobject

      -

      • displayNamestring

        -

      • idstring

        -

    • etagstring

      -

  • continuationTokenstring

    -

Example response
{ "prefixes": [ "string" ], "objects": [ { "bucketName": "string", "key": "string", "size": 0, "lastModified": "string", "storageClass": "string", "owner": { "displayName": "string", "id": "string" }, "etag": "string" } ], "continuationToken": "string" }

delete /s3/buckets/{bucketName}/objects

Delete an object by name.

Arguments
  • bucketNamerequiredstring

    -

  • keyoptionalstring

    -

Definition
delete /s3/buckets/{bucketName}/objects

get /s3/buckets/{bucketName}/multipart-uploads

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

Arguments
  • bucketNamerequiredstring

    -

  • maxoptionalinteger

    -

  • prefixoptionalstring

    -

  • continuationTokenoptionalstring

    -

  • flatViewoptionalboolean

    -

Definition
get /s3/buckets/{bucketName}/multipart-uploads
Attributes
  • prefixesarray

    -

  • objectsarray

    -

    • keystring

      -

    • uploadIdstring

      -

    • ownerobject

      -

      • displayNamestring

        -

      • idstring

        -

    • initiatorobject

      -

      • displayNamestring

        -

      • idstring

        -

    • storageClassstring

      -

    • initiatedstring

      -

  • continuationTokenstring

    -

Example response
{ "prefixes": [ "string" ], "objects": [ { "key": "string", "uploadId": "string", "owner": { "displayName": "string", "id": "string" }, "initiator": { "displayName": "string", "id": "string" }, "storageClass": "string", "initiated": "string" } ], "continuationToken": "string" }

delete /s3/buckets/{bucketName}/multipart-uploads

Cancel an active or abandoned multi-part upload.

Arguments
  • bucketNamerequiredstring

    -

  • keyoptionalstring

    -

  • uploadIdoptionalstring

    -

Definition
delete /s3/buckets/{bucketName}/multipart-uploads

get /s3/buckets/{bucketName}/objects/metadata

Get metadata of an object.

Arguments
  • bucketNamerequiredstring

    -

  • keyoptionalstring

    -

Definition
get /s3/buckets/{bucketName}/objects/metadata
Attributes
  • rawobject

    -

  • lastModifiedinteger

    -

  • contentTypestring

    -

  • etagstring

    -

  • sizeinteger

    -

  • userMetadataobject

    -

  • versionIdstring

    -

  • contentDispositionstring

    -

  • cacheControlstring

    -

  • expirationTimeinteger

    -

  • expirationTimeRuleIdstring

    -

  • contentEncodingstring

    -

  • contentLanguagestring

    -

  • contentMD5string

    -

  • httpExpiresDateinteger

    -

Example response
{ "raw": {}, "lastModified": 0, "contentType": "string", "etag": "string", "size": 0, "userMetadata": {}, "versionId": "string", "contentDisposition": "string", "cacheControl": "string", "expirationTime": 0, "expirationTimeRuleId": "string", "contentEncoding": "string", "contentLanguage": "string", "contentMD5": "string", "httpExpiresDate": 0 }

put /s3/buckets/{bucketName}/objects/metadata

Override object metadata.

Arguments
  • bucketNamerequiredstring

    -

  • keyoptionalstring

    -

  • bodyoptional

    -

Definition
put /s3/buckets/{bucketName}/objects/metadata

get /s3/buckets/{bucketName}/download

Download an object.

Arguments
  • bucketNamerequiredstring

    -

  • keyoptionalstring

    -

Definition
get /s3/buckets/{bucketName}/download
Attributes
  • fileNamestring

    -

  • urlstring

    -

  • fileContentsstring

    -

Example response
{ "fileName": "string", "url": "string", "fileContents": "string" }

put /s3/buckets/{bucketName}/upload

Upload an object.

Arguments
  • bucketNamerequiredstring

    -

  • keyoptionalstring

    -

  • fileoptionalfile

    -

  • sizeoptionalinteger

    Required to write large files directly into Ceph, uploads without this field must be buffered in RAM

Definition
put /s3/buckets/{bucketName}/upload

put /s3/buckets/{bucketName}/objects/copy

Copy an object.

Arguments
  • bucketNamerequiredstring

    -

  • keyoptionalstring

    -

  • dstBucketNameoptionalstring

    -

  • dstKeyoptionalstring

    -

Definition
put /s3/buckets/{bucketName}/objects/copy

put /s3/buckets/{bucketName}/objects/move

Move an object.

Arguments
  • bucketNamerequiredstring

    -

  • keyoptionalstring

    -

  • dstBucketNameoptionalstring

    -

  • dstKeyoptionalstring

    -

Definition
put /s3/buckets/{bucketName}/objects/move

get /s3/usage/by-user/{uid}

Retrieve usage statistics for a given S3 user.

Arguments
  • uidrequiredstring

    -

  • hoursoptionalinteger

    How many hours to go back.

Definition
get /s3/usage/by-user/{uid}
Attributes
  • bucketsobject

    All buckets accessed by this user, entries are split into 1 hour intervals

Example response
{ "buckets": {} }

get /s3/usage/by-bucket/{bucketName}

Retrieve latest usage statistics for a given S3 bucket.

Arguments
  • bucketNamerequiredstring

    -

  • hoursoptionalinteger

    How many hours to go back.

Definition
get /s3/usage/by-bucket/{bucketName}
Attributes
  • bucketsobject

    All users (unauthenticated access is mapped to "anonymous") accessing this bucket, entries are split into 1 hour intervals.

Example response
{ "buckets": {} }