Creating Folders

In this article

    You can create a new folder in the specified Amazon bucket.

    Request

    POST https://<hostname>:4443/v6/S3Resources/buckets/{bucketName}/folders?accountId=<string>&RegionType=<string>

    Request Headers

    The request header must contain an authorization token of the current session.

    Request Parameters

    The following parameters must be specified in the URL of the request:

    Parameter

    Type

    Description

    bucketName

    string

    Specifies the bucket name. For more information on how to get this parameter, see Getting Buckets.

    accountId

    string

    Specifies the identification number of a cloud account. For more information on how to get this parameter, see Getting Accounts.

    RegionType

    string

    Specifies a region type. The following types are available:

    • Global
    • USGovernment
    • China

    Request Body

    The request body must contain the following property:

    Property

    Type

    Description

    name

    string

    Specifies a name for a new folder.

    Request Example

    Request:

    POST https://abc.tech.local:4443/v6/S3Resources/buckets/Bucket5/folders?accountId=c0f030cb-a43a-4713-8da8-717c62a0b4f7&RegionType=Global

     

    Request Header:

    Authorization: Bearer <Access-Token>

    Request Body:

    {

        "name": "RESTFolder"

    }

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns a response code 201 Created.

    Response Headers

    The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

    Header

    Description

    Content-length

    The length of the response body.

    Content-type

    The media type and syntax of the response body message: application/json; charset=utf-8

    Response Body

    The response body contains the following properties:

    Property

    Type

    Description

    path

    string

    Specifies a folder path.

    name

    string

    Specifies a folder name.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Response Example

    Response:

    201 Created

     

    Response Body:

    {

     "path": "Veeam/Backup365/RESTFolder/",

     "name": "RESTFolder",

     "links": {

       "self": {

         "href": "v6/S3Resources/buckets/Bucket5/folders/RESTFolder?accountId=c0f030cb-a43a-4713-8da8-717c62a0b4f7&regionType=Global"

       },

       "account": {

         "href": "v6/accounts/c0f030cb-a43a-4713-8da8-717c62a0b4f7"

       },

       "bucket": {

         "href": "v6/S3Resources/buckets/Bucket5?accountId=c0f030cb-a43a-4713-8da8-717c62a0b4f7&RegionType=Global"

       }

     }

    }