This is an archive version of the document. To get the most up-to-date information, see the current version.

Creating Folders

In this article

    This section explains how to create a new folder in an S3-Compatible or IBM object storage container.

    Request

    POST https://<hostname>:4443/v4/S3CompatibleResources/buckets/{bucketName}/folders?accountId=<accountId>&ServicePoint=<ServicePoint>&CustomRegionId=<CustomRegionId>

    Request Headers

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

    Request Parameters

    The following parameters must be posted as URL.

    Parameter

    Type

    Description

    bucketName

    string

    A name of the bucket,

    accountId

    string

    An identification number of the account under which you can connect to object storage.

    ServicePoint

    string

    An endpoint of the host server.

    CustomRegionId

    string

    An identification number of the region object storage belongs.

    Request Body

    Property

    Type

    Description

    name

    string

    Specifies the name for a new folder.

    Request Example

    POST https://abc.tech.local:4443/v4/S3CompatibleResources/buckets/bucket1/folders?accountId=ebacce24-e6a3-494b-b29c-24d0d588f35e&servicePoint=abc.tech.local:9000&customRegionId=us-east-1

     

    Request Header:

    Authorization: Bearer <Access-Token>

    {

        "name": "RESTStorageFolder"

    }

    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

    Property

    Type

    Description

    path

    string

    A folder path.

    name

    string

    A folder name.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Response Example

    {

      "path": "Veeam/Backup365/RESTStorageFolder/",

      "name": "RESTStorageFolder",

      "links":    {

         "self": {"href": "https://abc.tech.local:4443/v4/S3CompatibleResources/buckets/bucket1/folders/RESTStorageFolder?accountId=ebacce24-e6a3-494b-b29c-24d0d588f35e&ServicePoint=172.17.186.13:9000&CustomRegionId=us-east-1"},

         "account": {"href": "https://abc.tech.local:4443/v4/accounts/ebacce24-e6a3-494b-b29c-24d0d588f35e"},

         "bucket": {"href": "https://abc.tech.local:4443/v4/S3CompatibleResources/buckets/bucket1?accountId=ebacce24-e6a3-494b-b29c-24d0d588f35e&ServicePoint=172.17.186.13:9000&CustomRegionId=us-east-1"}

      }

    }

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.