{
"swagger": "2.0",
"info": {
"description": "Object Storage Extension for VMware Cloud Director provides a set of S3 compatible APIs for bucket and object operations. It supports AWS Signature V4 authentication token. To obtain the S3 access key and secret key for S3 API access, Cloud Director tenant users need to visit Object Storage Tenant Portal to manage their user credentials.
As an extension, the API supports JSON format in addition to XML. It also supports Cloud Director authorization token and JWT token authentication.",
"version": "1.5.0",
"title": "Cloud Director Object Storage Extension API",
"license": {
"name": "VMware Product Licensing",
"url": "https://www.vmware.com/support/support-resources/licensing/product-licenses.html"
}
},
"host": "",
"basePath": "/",
"tags": [
{
"name": "Bucket Management",
"description": "S3 Bucket Operations"
},
{
"name": "Bucket Management Extension",
"description": "Cloud Director Extended S3 Bucket Operations"
},
{
"name": "Object Management",
"description": "S3 Object Operations"
},
{
"name": "Object Management Extension",
"description": "Cloud Director Extended S3 Object Operations"
}
],
"paths": {
"/api/v1/s3/{bucketName}": {
"head": {
"tags": [
"Bucket Management"
],
"summary": "S3 head bucket",
"description": "API code: S3_HEAD_BUCKET
\nPre-authorized role(s): ANONYMOUS_USER or TENANT_ADMIN or TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "headBucketUsingHEAD",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
},
"put": {
"tags": [
"Bucket Management"
],
"summary": "S3 add bucket",
"description": "API code: S3_ADD_BUCKET
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "createBucketUsingPUT",
"consumes": [
"application/json"
],
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "x-amz-acl",
"in": "header",
"description": "The ACL of the bucket using the specified canned ACL. Valid Values: private | public-read | public-read-write | authenticated-read.",
"required": false,
"type": "string"
},
{
"name": "x-amz-grant-full-control",
"in": "header",
"description": "Allows grantee the READ, WRITE, READ_ACP, and WRITE_ACP permissions on the bucket.",
"required": false,
"type": "string"
},
{
"name": "x-amz-grant-read",
"in": "header",
"description": "Allows the specified grantee(s) to list the objects in the bucket.",
"required": false,
"type": "string"
},
{
"name": "x-amz-grant-read-acp",
"in": "header",
"description": "Allows the specified grantee(s) to read the bucket ACL.",
"required": false,
"type": "string"
},
{
"name": "x-amz-grant-write",
"in": "header",
"description": "Allows the specified grantee(s) to create, overwrite, and delete any object in the bucket.",
"required": false,
"type": "string"
},
{
"name": "x-amz-grant-write-acp",
"in": "header",
"description": "Allows the specified grantee(s) to write the ACL for the applicable bucket.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
},
"delete": {
"tags": [
"Bucket Management"
],
"summary": "S3 delete bucket",
"description": "API code: S3_DELETE_BUCKET
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "deleteBucketUsingDELETE",
"produces": [
"*/*"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
}
],
"responses": {
"204": {
"description": "No Content"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}/{folderName}{?delete-version,folder,include-descendants,try-async}": {
"delete": {
"tags": [
"Object Management Extension"
],
"summary": "S3 delete folder",
"description": "API code: S3_DELETE_FOLDER
\nPre-authorized role(s): ANONYMOUS_USER or TENANT_ADMIN or TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "deleteFolderUsingDELETE",
"produces": [
"*/*"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "delete-version",
"in": "query",
"description": "Indicating whether to delete objects/sub folders or all their versions in a folder when include-descendants is true.",
"required": false,
"type": "boolean",
"default": true,
"allowEmptyValue": false
},
{
"name": "folder",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "folderName",
"in": "path",
"description": "The folder name or the folder path.",
"required": false,
"type": "string"
},
{
"name": "include-descendants",
"in": "query",
"description": "Indicate if to include sub folders or objects when deleting a folder.",
"required": false,
"type": "boolean",
"default": false,
"allowEmptyValue": false
},
{
"name": "try-async",
"in": "query",
"description": "Indicating whether to try un-synchronized deleting a folder when include-descendants is true.",
"required": false,
"type": "boolean",
"default": false,
"allowEmptyValue": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "MultiObjectDeleteResult",
"$ref": "#/definitions/MultiObjectDeleteResult"
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}/{objectKey}{?acl,versionId}": {
"get": {
"tags": [
"Object Management"
],
"summary": "S3 get object acl",
"description": "API code: S3_GET_OBJECT_ACL
\nPre-authorized role(s): ANONYMOUS_USER or TENANT_ADMIN or TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "getObjectAclUsingGET_1",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "acl",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "objectKey",
"in": "path",
"description": "The object key. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "versionId",
"in": "query",
"description": "The version ID of the object version.",
"required": false,
"type": "string",
"allowEmptyValue": false
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"originalRef": "AccessControlPolicy",
"$ref": "#/definitions/AccessControlPolicy"
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
},
"put": {
"tags": [
"Object Management"
],
"summary": "S3 set object acl",
"description": "API code: S3_SET_OBJECT_ACL
\nPre-authorized role(s): ANONYMOUS_USER or TENANT_ADMIN or TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "setObjectAclUsingPUT",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "acl",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "objectKey",
"in": "path",
"description": "The object key. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"in": "body",
"name": "policy",
"description": "Access policies for bucket/object.",
"required": false,
"schema": {
"originalRef": "AccessControlPolicy",
"$ref": "#/definitions/AccessControlPolicy"
}
},
{
"name": "versionId",
"in": "query",
"description": "The version ID of the object version.",
"required": false,
"type": "string",
"allowEmptyValue": false
},
{
"name": "x-amz-acl",
"in": "header",
"description": "The ACL of the bucket using the specified canned ACL. Valid Values: private | public-read | public-read-write | authenticated-read.",
"required": false,
"type": "string"
},
{
"name": "x-amz-grant-full-control",
"in": "header",
"description": "Allows grantee the READ, WRITE, READ_ACP, and WRITE_ACP permissions on the bucket.",
"required": false,
"type": "string"
},
{
"name": "x-amz-grant-read",
"in": "header",
"description": "Allows the specified grantee(s) to list the objects in the bucket.",
"required": false,
"type": "string"
},
{
"name": "x-amz-grant-read-acp",
"in": "header",
"description": "Allows the specified grantee(s) to read the bucket ACL.",
"required": false,
"type": "string"
},
{
"name": "x-amz-grant-write",
"in": "header",
"description": "Allows the specified grantee(s) to create, overwrite, and delete any object in the bucket.",
"required": false,
"type": "string"
},
{
"name": "x-amz-grant-write-acp",
"in": "header",
"description": "Allows the specified grantee(s) to write the ACL for the applicable bucket.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}/{objectKey}{?cannedAcls}": {
"get": {
"tags": [
"Object Management Extension"
],
"summary": "S3 get object canned acls",
"description": "API code: S3_GET_OBJECT_CANNED_ACLS
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "getObjectAvailableCannedAclsUsingGET_1",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "cannedAcls",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "objectKey",
"in": "path",
"description": "The object key. It must be URL encoded.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"originalRef": "DescriptiveEntity",
"$ref": "#/definitions/DescriptiveEntity"
}
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}/{objectKey}{?encoding-type,max-parts,objectKey,part-number-marker,uploadId}": {
"get": {
"tags": [
"Object Management"
],
"summary": "S3 list parts",
"description": "API code: S3_LIST_PARTS
\nPre-authorized role(s): ANONYMOUS_USER or TENANT_ADMIN or TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "listPartsUsingGET",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "encoding-type",
"in": "query",
"description": "Encode the response and specifies the encoding method to use.",
"required": false,
"type": "string"
},
{
"name": "max-parts",
"in": "query",
"description": "Sets the maximum number of parts to return in the response body.",
"required": false,
"type": "integer",
"default": 1000,
"format": "int32"
},
{
"name": "objectKey",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "part-number-marker",
"in": "query",
"description": "Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "uploadId",
"in": "query",
"description": "ID for the initiated multipart upload.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "ListPartsOutput",
"$ref": "#/definitions/ListPartsOutput"
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}/{objectKey}{?meta,versionId}": {
"get": {
"tags": [
"Object Management Extension"
],
"summary": "S3 get object metadata",
"description": "API code: S3_GET_OBJECT_METADATA
\nPre-authorized role(s): ANONYMOUS_USER or TENANT_ADMIN or TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "getObjectMetadataUsingGET_1",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "meta",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "objectKey",
"in": "path",
"description": "The object key. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "versionId",
"in": "query",
"description": "The version ID of the object version.",
"required": false,
"type": "string",
"allowEmptyValue": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "ObjectBriefEx",
"$ref": "#/definitions/ObjectBriefEx"
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}/{objectKey}{?meta}": {
"put": {
"tags": [
"Object Management Extension"
],
"summary": "S3 set object metadata",
"description": "API code: S3_SET_OBJECT_METADATA
\nPre-authorized role(s): ANONYMOUS_USER or TENANT_ADMIN or TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "updateObjectMetadataUsingPUT_1",
"consumes": [
"application/json"
],
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "meta",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "objectKey",
"in": "path",
"description": "The object key. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "x-amz-copy-source",
"in": "header",
"description": "The name of the source bucket and key of the source object, separated by a slash (/).",
"required": false,
"type": "string"
},
{
"name": "x-amz-copy-source-server-side-encryption-customer-algorithm",
"in": "header",
"description": "The algorithm used during SSE-C encryption.",
"required": false,
"type": "string"
},
{
"name": "x-amz-copy-source-server-side-encryption-customer-key",
"in": "header",
"description": "The 256-bit, base64-encoded key used to encrypt or decrypt data.",
"required": false,
"type": "string"
},
{
"name": "x-amz-copy-source-server-side-encryption-customer-key-md5",
"in": "header",
"description": "The base64-encoded 128-bit MD5 digest of the encryption key.",
"required": false,
"type": "string"
},
{
"name": "x-amz-meta-*",
"in": "header",
"description": "Headers starting with x-amz-meta-* are user-defined metadata. Each one is sent and returned as a set of key-value pairs.",
"required": false,
"type": "string"
},
{
"name": "x-amz-server-side-encryption",
"in": "header",
"description": "The server-side encryption algorithm for current object.",
"required": false,
"type": "string"
},
{
"name": "x-amz-server-side-encryption-customer-algorithm",
"in": "header",
"description": "The algorithm used during SSE-C encryption.",
"required": false,
"type": "string"
},
{
"name": "x-amz-server-side-encryption-customer-key",
"in": "header",
"description": "The 256-bit, base64-encoded key used to encrypt or decrypt data.",
"required": false,
"type": "string"
},
{
"name": "x-amz-server-side-encryption-customer-key-md5",
"in": "header",
"description": "The base64-encoded 128-bit MD5 digest of the encryption key.",
"required": false,
"type": "string"
},
{
"name": "x-amz-storage-class",
"in": "header",
"description": "Specifies the storage class the new resource will use. If not specified, OSE uses the default storage class.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"originalRef": "CopyObjectResult",
"$ref": "#/definitions/CopyObjectResult"
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}/{objectKey}{?overwrite}": {
"put": {
"tags": [
"Object Management"
],
"summary": "S3 copy object",
"description": "API code: S3_COPY_OBJECT
\nPre-authorized role(s): ANONYMOUS_USER or TENANT_ADMIN or TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "copyObjectUsingPUT_1",
"consumes": [
"application/json"
],
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "objectKey",
"in": "path",
"description": "The object key. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "overwrite",
"in": "query",
"description": "Overwrites existing object.",
"required": false,
"type": "boolean",
"default": true,
"allowEmptyValue": false
},
{
"name": "x-amz-acl",
"in": "header",
"description": "The ACL of the bucket using the specified canned ACL. Valid Values: private | public-read | public-read-write | authenticated-read.",
"required": false,
"type": "string"
},
{
"name": "x-amz-copy-source",
"in": "header",
"description": "The name of the source bucket and key of the source object, separated by a slash (/).",
"required": false,
"type": "string"
},
{
"name": "x-amz-copy-source-server-side-encryption-customer-algorithm",
"in": "header",
"description": "The algorithm used during SSE-C encryption.",
"required": false,
"type": "string"
},
{
"name": "x-amz-copy-source-server-side-encryption-customer-key",
"in": "header",
"description": "The 256-bit, base64-encoded key used to encrypt or decrypt data.",
"required": false,
"type": "string"
},
{
"name": "x-amz-copy-source-server-side-encryption-customer-key-md5",
"in": "header",
"description": "The base64-encoded 128-bit MD5 digest of the encryption key.",
"required": false,
"type": "string"
},
{
"name": "x-amz-grant-full-control",
"in": "header",
"description": "Allows grantee the READ, WRITE, READ_ACP, and WRITE_ACP permissions on the bucket.",
"required": false,
"type": "string"
},
{
"name": "x-amz-grant-read",
"in": "header",
"description": "Allows the specified grantee(s) to list the objects in the bucket.",
"required": false,
"type": "string"
},
{
"name": "x-amz-grant-read-acp",
"in": "header",
"description": "Allows the specified grantee(s) to read the bucket ACL.",
"required": false,
"type": "string"
},
{
"name": "x-amz-grant-write",
"in": "header",
"description": "Allows the specified grantee(s) to create, overwrite, and delete any object in the bucket.",
"required": false,
"type": "string"
},
{
"name": "x-amz-grant-write-acp",
"in": "header",
"description": "Allows the specified grantee(s) to write the ACL for the applicable bucket.",
"required": false,
"type": "string"
},
{
"name": "x-amz-meta-*",
"in": "header",
"description": "Headers starting with x-amz-meta-* are user-defined metadata. Each one is sent and returned as a set of key-value pairs.",
"required": false,
"type": "string"
},
{
"name": "x-amz-metadata-directive",
"in": "header",
"description": "Specifies whether the metadata is copied from the source object or is replaced with metadata provided in the request. Valid values: COPY | REPLACE.",
"required": false,
"type": "string"
},
{
"name": "x-amz-server-side-encryption",
"in": "header",
"description": "The server-side encryption algorithm for current object.",
"required": false,
"type": "string"
},
{
"name": "x-amz-server-side-encryption-customer-algorithm",
"in": "header",
"description": "The algorithm used during SSE-C encryption.",
"required": false,
"type": "string"
},
{
"name": "x-amz-server-side-encryption-customer-key",
"in": "header",
"description": "The 256-bit, base64-encoded key used to encrypt or decrypt data.",
"required": false,
"type": "string"
},
{
"name": "x-amz-server-side-encryption-customer-key-md5",
"in": "header",
"description": "The base64-encoded 128-bit MD5 digest of the encryption key.",
"required": false,
"type": "string"
},
{
"name": "x-amz-storage-class",
"in": "header",
"description": "Specifies the storage class the new resource will use. If not specified, OSE uses the default storage class.",
"required": false,
"type": "string"
},
{
"name": "x-amz-tagging",
"in": "header",
"description": "Specifies a set of tags to associate with the object.",
"required": false,
"type": "string"
},
{
"name": "x-amz-tagging-directive",
"in": "header",
"description": "Specifies whether the object tags are copied from the source object or replaced with tags provided in the request. Valid values: COPY | REPLACE.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"originalRef": "CopyObjectResult",
"$ref": "#/definitions/CopyObjectResult"
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}/{objectKey}{?partNumber,uploadId}": {
"put": {
"tags": [
"Object Management"
],
"summary": "S3 upload part",
"description": "API code: S3_UPLOAD_PART
\nPre-authorized role(s): ANONYMOUS_USER or TENANT_ADMIN or TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "uploadPartUsingPUT_1",
"consumes": [
"application/json"
],
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "Content-Length",
"in": "header",
"description": "The size of the resource, in bytes.",
"required": false,
"type": "string"
},
{
"name": "Content-MD5",
"in": "header",
"description": "The base64-encoded 128-bit MD5 digest of the part data.",
"required": false,
"type": "string"
},
{
"name": "Expect",
"in": "header",
"description": "When your application uses 100-continue, it does not send the request body until it receives an acknowledgment.",
"required": false,
"type": "string"
},
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "objectKey",
"in": "path",
"description": "The object key. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "partNumber",
"in": "query",
"description": "A part number uniquely identifies a part and also defines its position within the object being created.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "uploadId",
"in": "query",
"description": "ID for the initiated multipart upload.",
"required": false,
"type": "string"
},
{
"name": "x-amz-copy-source",
"in": "header",
"required": true,
"type": "string"
},
{
"name": "x-amz-server-side-encryption-customer-algorithm",
"in": "header",
"description": "The algorithm used during SSE-C encryption.",
"required": false,
"type": "string"
},
{
"name": "x-amz-server-side-encryption-customer-key",
"in": "header",
"description": "The 256-bit, base64-encoded key used to encrypt or decrypt data.",
"required": false,
"type": "string"
},
{
"name": "x-amz-server-side-encryption-customer-key-md5",
"in": "header",
"description": "The base64-encoded 128-bit MD5 digest of the encryption key.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success"
},
"204": {
"description": "No Content"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}/{objectKey}{?permissions,versionId}": {
"get": {
"tags": [
"Object Management Extension"
],
"summary": "S3 get object permissions",
"description": "API code: S3_GET_OBJECT_PERMISSIONS
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "getObjectPermissionsUsingGET_1",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "objectKey",
"in": "path",
"description": "The object key. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "permissions",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "versionId",
"in": "query",
"description": "The version ID of the object version.",
"required": false,
"type": "string",
"allowEmptyValue": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"READ",
"WRITE",
"READ_ACP",
"WRITE_ACP",
"FULL_CONTROL",
"RESERVED"
]
}
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}/{objectKey}{?request}": {
"post": {
"tags": [
"Object Management"
],
"summary": "S3 post add object",
"description": "API code: S3_POST_ADD_OBJECT
\nPre-authorized role(s): ANONYMOUS_USER or TENANT_ADMIN or TENANT_USER
\nSupported platform(s): CLOUDIAN
\n",
"operationId": "createObjectUsingPOST",
"consumes": [
"multipart/form-data"
],
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "acl",
"in": "formData",
"description": "The ACL of the bucket using the specified canned ACL. Valid Values: private | public-read | public-read-write | authenticated-read.",
"required": false,
"type": "string"
},
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "file",
"in": "formData",
"description": "The object to be uploaded.",
"required": false,
"type": "string"
},
{
"name": "key",
"in": "formData",
"description": "The name of the uploaded object.",
"required": false,
"type": "string"
},
{
"name": "request",
"in": "query",
"description": "request",
"required": false,
"type": "string",
"format": "byte"
},
{
"name": "tagging",
"in": "formData",
"description": "Specifies a set of tags to associate with the object.",
"required": false,
"type": "string"
},
{
"name": "x-amz-meta-*",
"in": "formData",
"description": "Headers starting with x-amz-meta-* are user-defined metadata. Each one is sent and returned as a set of key-value pairs.",
"required": false,
"type": "string"
},
{
"name": "x-amz-server-side-encryption",
"in": "formData",
"description": "The server-side encryption algorithm for current object.",
"required": false,
"type": "string"
},
{
"name": "x-amz-server-side-encryption-customer-algorithm",
"in": "formData",
"description": "The algorithm used during SSE-C encryption.",
"required": false,
"type": "string"
},
{
"name": "x-amz-server-side-encryption-customer-key",
"in": "formData",
"description": "The 256-bit, base64-encoded key used to encrypt or decrypt data.",
"required": false,
"type": "string"
},
{
"name": "x-amz-server-side-encryption-customer-key-md5",
"in": "formData",
"description": "The base64-encoded 128-bit MD5 digest of the encryption key.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"originalRef": "PostResponse",
"$ref": "#/definitions/PostResponse"
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}/{objectKey}{?response-cache-control,response-content-disposition,response-content-encoding,response-content-language,response-content-type,response-expires,versionId}": {
"get": {
"tags": [
"Object Management"
],
"summary": "S3 get object",
"description": "API code: S3_GET_OBJECT
\nPre-authorized role(s): ANONYMOUS_USER or TENANT_ADMIN or TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "getObjectUsingGET",
"produces": [
"*/*"
],
"parameters": [
{
"name": "Range",
"in": "header",
"description": "The range of bytes to download.",
"required": false,
"type": "string"
},
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "objectKey",
"in": "path",
"description": "The object key. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "response-cache-control",
"in": "query",
"description": "Sets the Cache-Control header of the response.",
"required": false,
"type": "string"
},
{
"name": "response-content-disposition",
"in": "query",
"description": "Sets the Content-Disposition header of the response.",
"required": false,
"type": "string"
},
{
"name": "response-content-encoding",
"in": "query",
"description": "Sets the Content-Encoding header of the response.",
"required": false,
"type": "string"
},
{
"name": "response-content-language",
"in": "query",
"description": "Sets the Content-Language header of the response.",
"required": false,
"type": "string"
},
{
"name": "response-content-type",
"in": "query",
"description": "Sets the Content-Type header of the response.",
"required": false,
"type": "string"
},
{
"name": "response-expires",
"in": "query",
"description": "Sets the Expires header of the response.",
"required": false,
"type": "string"
},
{
"name": "versionId",
"in": "query",
"description": "The version ID of the object version.",
"required": false,
"type": "string"
},
{
"name": "x-amz-server-side-encryption-customer-algorithm",
"in": "header",
"description": "The algorithm used during SSE-C encryption.",
"required": false,
"type": "string"
},
{
"name": "x-amz-server-side-encryption-customer-key",
"in": "header",
"description": "The 256-bit, base64-encoded key used to encrypt or decrypt data.",
"required": false,
"type": "string"
},
{
"name": "x-amz-server-side-encryption-customer-key-md5",
"in": "header",
"description": "The base64-encoded 128-bit MD5 digest of the encryption key.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"originalRef": "Resource",
"$ref": "#/definitions/Resource"
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}/{objectKey}{?tagging,versionId}": {
"get": {
"tags": [
"Object Management"
],
"summary": "S3 get object tagging",
"description": "API code: S3_GET_OBJECT_TAGGING
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN
\n",
"operationId": "getObjectTaggingUsingGET_1",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "objectKey",
"in": "path",
"description": "The object key. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "tagging",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "versionId",
"in": "query",
"description": "The version ID of the object version.",
"required": false,
"type": "string",
"allowEmptyValue": false
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"originalRef": "Tagging",
"$ref": "#/definitions/Tagging"
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
},
"put": {
"tags": [
"Object Management"
],
"summary": "S3 set object tagging",
"description": "API code: S3_SET_OBJECT_TAGGING
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN
\n",
"operationId": "setObjectTaggingUsingPUT_1",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "objectKey",
"in": "path",
"description": "The object key. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "tagging",
"in": "query",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "tags",
"description": "New tags for bucket/object.",
"required": false,
"schema": {
"originalRef": "Tagging",
"$ref": "#/definitions/Tagging"
}
},
{
"name": "versionId",
"in": "query",
"description": "The version ID of the object version.",
"required": false,
"type": "string",
"allowEmptyValue": false
}
],
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
},
"delete": {
"tags": [
"Object Management"
],
"summary": "S3 delete object tagging",
"description": "API code: S3_DELETE_OBJECT_TAGGING
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN
\n",
"operationId": "deleteObjectTaggingUsingDELETE_1",
"produces": [
"*/*"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "objectKey",
"in": "path",
"description": "The object key. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "tagging",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "versionId",
"in": "query",
"description": "The version ID of the object version.",
"required": false,
"type": "string",
"allowEmptyValue": false
}
],
"responses": {
"204": {
"description": "No Content"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}/{objectKey}{?uploadId}": {
"post": {
"tags": [
"Object Management"
],
"summary": "S3 complete multipart upload",
"description": "API code: S3_COMPLETE_MULTIPART_UPLOAD
\nPre-authorized role(s): ANONYMOUS_USER or TENANT_ADMIN or TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "completeMultipartUploadUsingPOST_1",
"consumes": [
"application/json"
],
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "objectKey",
"in": "path",
"description": "The object key. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"in": "body",
"name": "upload",
"description": "upload",
"required": true,
"schema": {
"originalRef": "CompleteMultipartUpload",
"$ref": "#/definitions/CompleteMultipartUpload"
}
},
{
"name": "uploadId",
"in": "query",
"description": "ID for the initiated multipart upload.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"originalRef": "CompleteMultipartUploadResult",
"$ref": "#/definitions/CompleteMultipartUploadResult"
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
},
"delete": {
"tags": [
"Object Management"
],
"summary": "S3 abort multipart upload",
"description": "API code: S3_ABORT_MULTIPART_UPLOAD
\nPre-authorized role(s): ANONYMOUS_USER or TENANT_ADMIN or TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "abortMultipartUploadUsingDELETE_1",
"produces": [
"*/*"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "objectKey",
"in": "path",
"description": "The object key. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "uploadId",
"in": "query",
"description": "ID for the initiated multipart upload.",
"required": false,
"type": "string"
}
],
"responses": {
"204": {
"description": "No Content"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}/{objectKey}{?uploads}": {
"post": {
"tags": [
"Object Management"
],
"summary": "S3 initiate multipart upload",
"description": "API code: S3_INITIATE_MULTIPART_UPLOAD
\nPre-authorized role(s): ANONYMOUS_USER or TENANT_ADMIN or TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "initiateMultipartUploadUsingPOST_1",
"consumes": [
"application/json"
],
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "Cache-Control",
"in": "header",
"description": "Can be used to specify caching behavior along the request/reply chain.",
"required": false,
"type": "string"
},
{
"name": "Content-Disposition",
"in": "header",
"description": "An opportunity to raise a \"File Download\" dialogue box for a known MIME type with binary format or suggest a filename for dynamic content.",
"required": false,
"type": "string"
},
{
"name": "Content-Encoding",
"in": "header",
"description": "Specifies the content encodings that have been applied to the object and which decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.",
"required": false,
"type": "string"
},
{
"name": "Content-Type",
"in": "header",
"description": "A standard MIME type that describes the format of the object data.",
"required": false,
"type": "string"
},
{
"name": "Expires",
"in": "header",
"description": "The date and time at which the object should no longer be cached.",
"required": false,
"type": "string"
},
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "objectKey",
"in": "path",
"description": "The object key. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "uploads",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "x-amz-acl",
"in": "header",
"description": "The ACL of the bucket using the specified canned ACL. Valid Values: private | public-read | public-read-write | authenticated-read.",
"required": false,
"type": "string"
},
{
"name": "x-amz-grant-full-control",
"in": "header",
"description": "Allows grantee the READ, WRITE, READ_ACP, and WRITE_ACP permissions on the bucket.",
"required": false,
"type": "string"
},
{
"name": "x-amz-grant-read",
"in": "header",
"description": "Allows the specified grantee(s) to list the objects in the bucket.",
"required": false,
"type": "string"
},
{
"name": "x-amz-grant-read-acp",
"in": "header",
"description": "Allows the specified grantee(s) to read the bucket ACL.",
"required": false,
"type": "string"
},
{
"name": "x-amz-grant-write",
"in": "header",
"description": "Allows the specified grantee(s) to create, overwrite, and delete any object in the bucket.",
"required": false,
"type": "string"
},
{
"name": "x-amz-grant-write-acp",
"in": "header",
"description": "Allows the specified grantee(s) to write the ACL for the applicable bucket.",
"required": false,
"type": "string"
},
{
"name": "x-amz-meta-*",
"in": "header",
"description": "Headers starting with x-amz-meta-* are user-defined metadata. Each one is sent and returned as a set of key-value pairs.",
"required": false,
"type": "string"
},
{
"name": "x-amz-server-side-encryption",
"in": "header",
"description": "The server-side encryption algorithm for current object.",
"required": false,
"type": "string"
},
{
"name": "x-amz-server-side-encryption-customer-algorithm",
"in": "header",
"description": "The algorithm used during SSE-C encryption.",
"required": false,
"type": "string"
},
{
"name": "x-amz-server-side-encryption-customer-key",
"in": "header",
"description": "The 256-bit, base64-encoded key used to encrypt or decrypt data.",
"required": false,
"type": "string"
},
{
"name": "x-amz-server-side-encryption-customer-key-md5",
"in": "header",
"description": "The base64-encoded 128-bit MD5 digest of the encryption key.",
"required": false,
"type": "string"
},
{
"name": "x-amz-storage-class",
"in": "header",
"description": "Specifies the storage class the new resource will use. If not specified, OSE uses the default storage class.",
"required": false,
"type": "string"
},
{
"name": "x-amz-tagging",
"in": "header",
"description": "Specifies a set of tags to associate with the object.",
"required": false,
"type": "string"
},
{
"name": "x-amz-website-redirect-location",
"in": "header",
"description": "If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"originalRef": "InitiateMultipartUploadResult",
"$ref": "#/definitions/InitiateMultipartUploadResult"
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}/{objectKey}{?versionId}": {
"head": {
"tags": [
"Object Management"
],
"summary": "S3 object exists",
"description": "API code: S3_OBJECT_EXISTS
\nPre-authorized role(s): ANONYMOUS_USER or TENANT_ADMIN or TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "objectExistsUsingHEAD_1",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "objectKey",
"in": "path",
"description": "The object key. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "versionId",
"in": "query",
"description": "The version ID of the object version.",
"required": false,
"type": "string",
"allowEmptyValue": false
},
{
"name": "x-amz-server-side-encryption-customer-algorithm",
"in": "header",
"description": "The algorithm used during SSE-C encryption.",
"required": false,
"type": "string"
},
{
"name": "x-amz-server-side-encryption-customer-key",
"in": "header",
"description": "The 256-bit, base64-encoded key used to encrypt or decrypt data.",
"required": false,
"type": "string"
},
{
"name": "x-amz-server-side-encryption-customer-key-md5",
"in": "header",
"description": "The base64-encoded 128-bit MD5 digest of the encryption key.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
},
"delete": {
"tags": [
"Object Management"
],
"summary": "S3 delete object",
"description": "API code: S3_DELETE_OBJECT
\nPre-authorized role(s): ANONYMOUS_USER or TENANT_ADMIN or TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "deleteObjectUsingDELETE_1",
"produces": [
"*/*"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "objectKey",
"in": "path",
"description": "The object key. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "versionId",
"in": "query",
"description": "The version ID of the object version.",
"required": false,
"type": "string",
"allowEmptyValue": false
}
],
"responses": {
"204": {
"description": "No Content"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}{?acl}": {
"get": {
"tags": [
"Bucket Management"
],
"summary": "S3 get bucket acl",
"description": "API code: S3_GET_BUCKET_ACL
\nPre-authorized role(s): ANONYMOUS_USER or TENANT_ADMIN or TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "getBucketAclUsingGET",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "acl",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "AccessControlPolicy",
"$ref": "#/definitions/AccessControlPolicy"
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
},
"put": {
"tags": [
"Bucket Management"
],
"summary": "S3 set bucket acl",
"description": "API code: S3_SET_BUCKET_ACL
\nPre-authorized role(s): ANONYMOUS_USER or TENANT_ADMIN or TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "setBucketAclUsingPUT",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "acl",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"in": "body",
"name": "policy",
"description": "Access policies for bucket/object.",
"required": false,
"schema": {
"originalRef": "AccessControlPolicy",
"$ref": "#/definitions/AccessControlPolicy"
}
},
{
"name": "x-amz-acl",
"in": "header",
"description": "The ACL of the bucket using the specified canned ACL. Valid Values: private | public-read | public-read-write | authenticated-read.",
"required": false,
"type": "string"
},
{
"name": "x-amz-grant-full-control",
"in": "header",
"description": "Allows grantee the READ, WRITE, READ_ACP, and WRITE_ACP permissions on the bucket.",
"required": false,
"type": "string"
},
{
"name": "x-amz-grant-read",
"in": "header",
"description": "Allows the specified grantee(s) to list the objects in the bucket.",
"required": false,
"type": "string"
},
{
"name": "x-amz-grant-read-acp",
"in": "header",
"description": "Allows the specified grantee(s) to read the bucket ACL.",
"required": false,
"type": "string"
},
{
"name": "x-amz-grant-write",
"in": "header",
"description": "Allows the specified grantee(s) to create, overwrite, and delete any object in the bucket.",
"required": false,
"type": "string"
},
{
"name": "x-amz-grant-write-acp",
"in": "header",
"description": "Allows the specified grantee(s) to write the ACL for the applicable bucket.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}{?cannedAcls}": {
"get": {
"tags": [
"Bucket Management Extension"
],
"summary": "S3 get bucket canned acls",
"description": "API code: S3_GET_BUCKET_CANNED_ACLS
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "getBucketAvailableCannedAclsUsingGET",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "cannedAcls",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"originalRef": "DescriptiveEntity",
"$ref": "#/definitions/DescriptiveEntity"
}
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}{?continuation-token,fetch-owner,filter,include-deleted,offset,order,standardResult,start-after}": {
"get": {
"tags": [
"Bucket Management"
],
"summary": "S3 get bucket",
"description": "API code: S3_GET_BUCKET
\nPre-authorized role(s): ANONYMOUS_USER or TENANT_ADMIN or TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "getBucketUsingGET",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "continuation-token",
"in": "query",
"description": "List the next set of resources from where next continuation token specifies. When used, any filtering parameter will be ignored.",
"required": false,
"type": "string"
},
{
"name": "fetch-owner",
"in": "query",
"description": "Return the owner information in the response.",
"required": false,
"type": "boolean"
},
{
"name": "filter",
"in": "query",
"description": "The RSQL expression to filter page results based on property comparison.
The logical operations include:
/api/v1/types/bucket
. yyyy-MM-ddTHH:mm:ss.SSSZ
. When a timezone offset is presented with a plus (+) separator, the plus character must be encoded as %2D
.S3_GET_BUCKET_CORS
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "getBucketCorsUsingGET",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "cors",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "CORSConfiguration",
"$ref": "#/definitions/CORSConfiguration"
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
},
"put": {
"tags": [
"Bucket Management"
],
"summary": "S3 set bucket cors",
"description": "API code: S3_SET_BUCKET_CORS
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "setBucketCorsUsingPUT",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"in": "body",
"name": "configuration",
"description": "configuration",
"required": true,
"schema": {
"originalRef": "CORSConfiguration",
"$ref": "#/definitions/CORSConfiguration"
}
},
{
"name": "cors",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
},
"delete": {
"tags": [
"Bucket Management"
],
"summary": "S3 delete bucket cors",
"description": "API code: S3_DELETE_BUCKET_CORS
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "deleteBucketCorsUsingDELETE",
"produces": [
"*/*"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "cors",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "No Content"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}{?delete}": {
"post": {
"tags": [
"Object Management"
],
"summary": "S3 delete multiple objects",
"description": "API code: S3_DELETE_MULTIPLE_OBJECTS
\nPre-authorized role(s): ANONYMOUS_USER or TENANT_ADMIN or TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "deleteObjectsUsingPOST",
"consumes": [
"application/json"
],
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "delete",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "MultiObjectDeleteResult",
"$ref": "#/definitions/MultiObjectDeleteResult"
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}{?delimiter,encoding-type,key-marker,max-uploads,prefix,upload-id-marker,uploads}": {
"get": {
"tags": [
"Bucket Management"
],
"summary": "S3 list multipart uploads",
"description": "API code: S3_LIST_MULTIPART_UPLOADS
\nPre-authorized role(s): ANONYMOUS_USER or TENANT_ADMIN or TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "listUploadsUsingGET",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "delimiter",
"in": "query",
"description": "A character used to group keys. If user specifies a prefix, all of the keys that contain the same string between the prefix and the first occurrence of the delimiter after the prefix are grouped under a single result element called CommonPrefixes. If user doesn't specify the prefix parameter, the substring starts at the beginning of the key. The keys that are grouped under the CommonPrefixes result element are not returned elsewhere in the response.",
"required": false,
"type": "string",
"allowEmptyValue": false
},
{
"name": "encoding-type",
"in": "query",
"description": "Encode the response and specifies the encoding method to use.",
"required": false,
"type": "string",
"allowEmptyValue": false
},
{
"name": "key-marker",
"in": "query",
"description": "The object key to start with when listing object versions.",
"required": false,
"type": "string",
"allowEmptyValue": false
},
{
"name": "max-uploads",
"in": "query",
"description": "The maximum number of multipart uploads, from 1 to 1,000, to return in the response body",
"required": false,
"type": "integer",
"default": 1000,
"format": "int32",
"allowEmptyValue": false
},
{
"name": "prefix",
"in": "query",
"description": "Limits the response to keys that begin with the specified prefix. When used, the filter parameter will be ignored.",
"required": false,
"type": "string",
"allowEmptyValue": false
},
{
"name": "upload-id-marker",
"in": "query",
"description": "The upload ID marker indicating where in the results to begin listing.",
"required": false,
"type": "string",
"allowEmptyValue": false
},
{
"name": "uploads",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "ListBucketUploadsResult",
"$ref": "#/definitions/ListBucketUploadsResult"
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}{?encryption}": {
"get": {
"tags": [
"Bucket Management"
],
"summary": "S3 get bucket encryption",
"description": "API code: S3_GET_BUCKET_ENCRYPTION
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "getBucketEncryptionUsingGET",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "encryption",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "SSEConfiguration",
"$ref": "#/definitions/SSEConfiguration"
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
},
"put": {
"tags": [
"Bucket Management"
],
"summary": "S3 set bucket encryption",
"description": "API code: S3_SET_BUCKET_ENCRYPTION
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "setBucketEncryptionUsingPUT",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"in": "body",
"name": "conf",
"description": "conf",
"required": true,
"schema": {
"originalRef": "SSEConfiguration",
"$ref": "#/definitions/SSEConfiguration"
}
},
{
"name": "encryption",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
},
"delete": {
"tags": [
"Bucket Management"
],
"summary": "S3 delete bucket encryption",
"description": "API code: S3_DELETE_BUCKET_ENCRYPTION
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "deleteBucketEncryptionUsingDELETE",
"produces": [
"*/*"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "encryption",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "No Content"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}{?key-marker,standardResult,version-id-marker,versions}": {
"get": {
"tags": [
"Bucket Management"
],
"summary": "S3 get bucket versions",
"description": "API code: S3_GET_BUCKET_VERSIONS
\nPre-authorized role(s): ANONYMOUS_USER or TENANT_ADMIN or TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "listVersionsUsingGET",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "key-marker",
"in": "query",
"description": "The object key to start with when listing object versions.",
"required": false,
"type": "string"
},
{
"name": "standardResult",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "version-id-marker",
"in": "query",
"description": "The object version to start with when listing object versions.",
"required": false,
"type": "string"
},
{
"name": "versions",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "ListVersionResult",
"$ref": "#/definitions/ListVersionResult"
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}{?lifecycle}": {
"get": {
"tags": [
"Bucket Management"
],
"summary": "S3 get bucket lifecycle",
"description": "API code: S3_GET_BUCKET_LIFECYCLE
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "getBucketLifecycleUsingGET",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "lifecycle",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "LifecycleConfiguration",
"$ref": "#/definitions/LifecycleConfiguration"
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
},
"put": {
"tags": [
"Bucket Management"
],
"summary": "S3 set bucket lifecycle",
"description": "API code: S3_SET_BUCKET_LIFECYCLE
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "setBucketLifecycleUsingPUT",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"in": "body",
"name": "conf",
"description": "conf",
"required": true,
"schema": {
"originalRef": "LifecycleConfiguration",
"$ref": "#/definitions/LifecycleConfiguration"
}
},
{
"name": "lifecycle",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
},
"delete": {
"tags": [
"Bucket Management"
],
"summary": "S3 delete bucket lifecycle",
"description": "API code: S3_DELETE_BUCKET_LIFECYCLE
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "deleteBucketLifecycleUsingDELETE",
"produces": [
"*/*"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "lifecycle",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "No Content"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}{?location}": {
"get": {
"tags": [
"Bucket Management"
],
"summary": "S3 get bucket location",
"description": "API code: S3_GET_BUCKET_LOCATION
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "getBucketLocationUsingGET",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "location",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}{?logging,set-log-delivery}": {
"put": {
"tags": [
"Bucket Management"
],
"summary": "S3 set bucket logging",
"description": "API code: S3_SET_BUCKET_LOGGING
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN
\n",
"operationId": "setBucketLoggingUsingPUT",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"in": "body",
"name": "conf",
"description": "conf",
"required": true,
"schema": {
"originalRef": "BucketLoggingStatus",
"$ref": "#/definitions/BucketLoggingStatus"
}
},
{
"name": "logging",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "set-log-delivery",
"in": "query",
"description": "Indicating whether to add Log Delivery group permissions for the target bucket when configuring bucket logging.",
"required": false,
"type": "boolean",
"default": false,
"allowEmptyValue": false
}
],
"responses": {
"200": {
"description": "OK"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}{?logging}": {
"get": {
"tags": [
"Bucket Management"
],
"summary": "S3 get bucket logging",
"description": "API code: S3_GET_BUCKET_LOGGING
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN
\n",
"operationId": "getBucketLoggingUsingGET",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "logging",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "BucketLoggingStatus",
"$ref": "#/definitions/BucketLoggingStatus"
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}{?permissions}": {
"get": {
"tags": [
"Bucket Management Extension"
],
"summary": "S3 get bucket permissions",
"description": "API code: S3_GET_BUCKET_PERMISSIONS
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "getBucketPermissionsUsingGET",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "permissions",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"READ",
"WRITE",
"READ_ACP",
"WRITE_ACP",
"FULL_CONTROL",
"RESERVED"
]
}
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}{?policy}": {
"get": {
"tags": [
"Bucket Management"
],
"summary": "S3 get bucket policy",
"description": "API code: S3_GET_BUCKET_POLICY
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "getBucketPolicyUsingGET",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "policy",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
},
"put": {
"tags": [
"Bucket Management"
],
"summary": "S3 set bucket policy",
"description": "API code: S3_SET_BUCKET_POLICY
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "setBuckePolicyUsingPUT",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"in": "body",
"name": "conf",
"description": "conf",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "policy",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "No Content"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
},
"delete": {
"tags": [
"Bucket Management"
],
"summary": "S3 delete bucket policy",
"description": "API code: S3_DELETE_BUCKET_POLICY
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "deleteBucketPolicyUsingDELETE",
"produces": [
"*/*"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "policy",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "No Content"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}{?replication}": {
"get": {
"tags": [
"Bucket Management"
],
"summary": "S3 get bucket replication",
"description": "API code: S3_GET_BUCKET_REPLICATION
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "getBucketReplicationUsingGET",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "replication",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "ReplicationConfiguration",
"$ref": "#/definitions/ReplicationConfiguration"
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
},
"put": {
"tags": [
"Bucket Management"
],
"summary": "S3 set bucket replication",
"description": "API code: S3_SET_BUCKET_REPLICATION
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "setBucketReplicationUsingPUT",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "Content-MD5",
"in": "header",
"description": "The base64-encoded 128-bit MD5 digest of the part data.",
"required": false,
"type": "string"
},
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"in": "body",
"name": "conf",
"description": "conf",
"required": true,
"schema": {
"originalRef": "ReplicationConfiguration",
"$ref": "#/definitions/ReplicationConfiguration"
}
},
{
"name": "replication",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "x-amz-bucket-object-lock-token",
"in": "header",
"description": "Use to allow Amazon S3 object lock to be enabled for an existing bucket.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
},
"delete": {
"tags": [
"Bucket Management"
],
"summary": "S3 delete bucket replication",
"description": "API code: S3_DELETE_BUCKET_REPLICATION
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "deleteBucketReplicationUsingDELETE",
"produces": [
"*/*"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "replication",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "No Content"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}{?sync}": {
"get": {
"tags": [
"Bucket Management Extension"
],
"summary": "S3 sync bucket",
"description": "API code: S3_SYNC_BUCKET
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "syncBucketUsingGET",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "sync",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"202": {
"description": "Accepted",
"schema": {
"originalRef": "Task",
"$ref": "#/definitions/Task"
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}{?tagging}": {
"get": {
"tags": [
"Bucket Management"
],
"summary": "S3 get bucket tagging",
"description": "API code: S3_GET_BUCKET_TAGGING
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN
\n",
"operationId": "getBucketTaggingUsingGET",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "tagging",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "Tagging",
"$ref": "#/definitions/Tagging"
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
},
"put": {
"tags": [
"Bucket Management"
],
"summary": "S3 set bucket tagging",
"description": "API code: S3_SET_BUCKET_TAGGING
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN
\n",
"operationId": "setBuckeTaggingUsingPUT",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "tagging",
"in": "query",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "tags",
"description": "New tags for bucket/object.",
"required": false,
"schema": {
"originalRef": "Tagging",
"$ref": "#/definitions/Tagging"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
},
"delete": {
"tags": [
"Bucket Management"
],
"summary": "S3 delete bucket tagging",
"description": "API code: S3_DELETE_BUCKET_TAGGING
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN
\n",
"operationId": "deleteBucketTaggingUsingDELETE",
"produces": [
"*/*"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "tagging",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "No Content"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}{?versioning}": {
"get": {
"tags": [
"Bucket Management"
],
"summary": "S3 get bucket versioning",
"description": "API code: S3_GET_BUCKET_VERSIONING
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "getBucketVersioningUsingGET",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "versioning",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "VersioningConfiguration",
"$ref": "#/definitions/VersioningConfiguration"
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
},
"put": {
"tags": [
"Bucket Management"
],
"summary": "S3 set bucket versioning",
"description": "API code: S3_SET_BUCKET_VERSIONING
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "setBucketVersioningUsingPUT",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"in": "body",
"name": "conf",
"description": "conf",
"required": true,
"schema": {
"originalRef": "VersioningConfiguration",
"$ref": "#/definitions/VersioningConfiguration"
}
},
{
"name": "versioning",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3/{bucketName}{?website}": {
"get": {
"tags": [
"Bucket Management"
],
"summary": "S3 get bucket website",
"description": "API code: S3_GET_BUCKET_WEBSITE
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "getBucketWebsiteUsingGET",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "website",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "WebsiteConfiguration",
"$ref": "#/definitions/WebsiteConfiguration"
}
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
},
"put": {
"tags": [
"Bucket Management"
],
"summary": "S3 set bucket website",
"description": "API code: S3_SET_BUCKET_WEBSITE
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "setBucketWebsiteUsingPUT",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"in": "body",
"name": "conf",
"description": "conf",
"required": true,
"schema": {
"originalRef": "WebsiteConfiguration",
"$ref": "#/definitions/WebsiteConfiguration"
}
},
{
"name": "website",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
},
"delete": {
"tags": [
"Bucket Management"
],
"summary": "S3 delete bucket website",
"description": "API code: S3_DELETE_BUCKET_WEBSITE
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "deleteBucketWebsiteUsingDELETE",
"produces": [
"*/*"
],
"parameters": [
{
"name": "bucketName",
"in": "path",
"description": "The bucket name. It must be URL encoded.",
"required": false,
"type": "string"
},
{
"name": "website",
"in": "query",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "No Content"
}
},
"security": [
{
"x-vcloud-authorization": [
"global"
]
},
{
"jwt": [
"global"
]
}
],
"deprecated": false
}
},
"/api/v1/s3{?all,filter,limit,offset,order}": {
"get": {
"tags": [
"Bucket Management Extension"
],
"summary": "S3 get all buckets",
"description": "API code: S3_GET_ALL_BUCKETS
\nPre-authorized role(s): TENANT_ADMIN
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "getBucketsUsingGET",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "all",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "filter",
"in": "query",
"description": "The RSQL expression to filter page results based on property comparison./api/v1/types/bucket
. yyyy-MM-ddTHH:mm:ss.SSSZ
. When a timezone offset is presented with a plus (+) separator, the plus character must be encoded as %2D
.S3_GET_SHARED_BUCKETS
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN
\n",
"operationId": "getSharedBucketsUsingGET",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "filter",
"in": "query",
"description": "The RSQL expression to filter page results based on property comparison./api/v1/types/bucket
. yyyy-MM-ddTHH:mm:ss.SSSZ
. When a timezone offset is presented with a plus (+) separator, the plus character must be encoded as %2D
.S3_GET_BUCKETS
\nPre-authorized role(s): TENANT_USER
\nSupported platform(s): CLOUDIAN and ECS
\n",
"operationId": "getBucketsUsingGET_1",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "filter",
"in": "query",
"description": "The RSQL expression to filter page results based on property comparison./api/v1/types/bucket
. yyyy-MM-ddTHH:mm:ss.SSSZ
. When a timezone offset is presented with a plus (+) separator, the plus character must be encoded as %2D
.