Jump to

• Request
• Response
• Examples

Create container

put

/v1/{account}/{container}

Creates a container.

Request

Path Parameters

• account: string
  The unique name for the account. An account is also known as the project or tenant.
• container: string
  The unique name for the container. The container name must be from 1 to 256 characters long and can start with any character and contain any pattern. Character set must be UTF-8. The container name cannot contain a slash (/) character because this character delimits the container and object name. For example, /account/container/object.

Header Parameters

• X-Auth-Token: string
  Authentication token.
• X-Container-Meta-Access-Control-Allow-Origin(optional): string
  List of origins to be allowed to make cross-origin Requests. Entries in the list are space-separated.
• X-Container-Meta-Access-Control-Expose-Headers(optional): string
  List of headers exposed to the user agent (e.g. browser) in the actual request response. Entries in the list are space-separated.
• X-Container-Meta-Access-Control-Max-Age(optional): integer
  Minimum Value: 0

  Maximum age in seconds for the origin to hold the preflight results.
• X-Container-Meta-Temp-URL-Key(optional): string
  The secret key value for temporary URLs.
• X-Container-Meta-Temp-URL-Key-2(optional): string
  A second secret key value for temporary URLs. The second key enables you to rotate keys by having two active keys at the same time.
• X-Container-Meta-{name}(optional): string
  The container metadata, where {name} is the name of metadata item. You must specify an X-Container-Meta-{name} header for each metadata item (for each {name}) that you want to add or update.
• X-Container-Read(optional): string
  Sets a container access control list (ACL) that grants read access. Container ACLs are available on any Object Storage cluster, and are enabled by container rather than by cluster.

  To set the container read ACL:

  $ curl -X {PUT|POST} -i -H 'X-Auth-Token: TOKEN' -H \ 
  'X-Container-Read: ACL' STORAGE_URL/CONTAINER

  In the command, specify the ACL in the X-Container-Read header, as follows:

  • .r:*—All referrers.
  • .r:example.com,swift.example.com—Comma-separated list of referrers.
  • .rlistings—Container listing access.

• X-Container-Write(optional): string
  Sets an ACL that grants write access.
• X-Storage-Class: string
  Specifies the type of container. For archive containers, the only valid value is Archive.

  Note that the storage class of a container may not be changed once the container has been created.

  Default Value: Archive

  Allowed Values: [ "Archive" ]
• X-Worm-Expiration-Days(optional): integer
  Minimum Value: 1

  Minimum number of days an object, once uploaded, must reside in a container before it can be overwritten with a PUT or POST or deleted.

Back to Top

Response

Supported Media Types

• application/json

201 Response

Success. The container has been created.

Headers

• Content-Length: integer
  Minimum Value: 0

  If the operation succeeds, this value is zero (0). If the operation fails, this value is the length of the error text in the response body.
• Content-Type: string
  If the operation fails, this value is the MIME type of the error text in the response body.
• Date: string(date-time)
  The transaction date and time.

  The date and time stamp format is ISO 8601:

  CCYY-MM-DDThh:mm:ss±hh:mm

  For example, 2015-08-27T09:49:58-05:00.

  The ±hh:mm value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is -05:00.

  A null value indicates that the token never expires.

• X-Timestamp: integer(timestamp)
  Minimum Value: 0

  The date and time in UNIX Epoch time stamp format when the account, container, or object was initially created as a current version.

  For example, 1440619048 is equivalent to Mon, Wed, 26 Aug 2015 19:57:28 GMT.

• X-Trans-Id: string(uuid)
  A unique transaction identifier for this request. Your service provider might need this value if you report a problem.

202 Response

Success. The container has been updated.

Note that this is consistent with actual OpenStack Swift behavior, but not with the documented OpenStack Swift return code of 204.

Headers

• Content-Length: integer
  Minimum Value: 0

  If the operation succeeds, this value is zero (0). If the operation fails, this value is the length of the error text in the response body.
• Content-Type: string
  If the operation fails, this value is the MIME type of the error text in the response body.
• Date: string(date-time)
  The transaction date and time.

  The date and time stamp format is ISO 8601:

  CCYY-MM-DDThh:mm:ss±hh:mm

  For example, 2015-08-27T09:49:58-05:00.

  The ±hh:mm value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is -05:00.

  A null value indicates that the token never expires.

• X-Timestamp: integer(timestamp)
  Minimum Value: 0

  The date and time in UNIX Epoch time stamp format when the account, container, or object was initially created as a current version.

  For example, 1440619048 is equivalent to Mon, Wed, 26 Aug 2015 19:57:28 GMT.

• X-Trans-Id: string(uuid)
  A unique transaction identifier for this request. Your service provider might need this value if you report a problem.

400 Response

Invalid value for storage class was provided. It could also occur if the value for the X-Worm-Expiration-Days header is invalid. It must be a valid integer greater than 0

Headers

• Content-Length: integer
  Minimum Value: 0

  This value is the length of the error text in the response body.
• Content-Type: string
  This value is the MIME type of the error text in the response body.

401 Response

Request does not include an authentication token, or authentication token specified in the request is not valid. It may have expired. Authentication tokens expire after 30 minutes.

Headers

• Content-Length: integer
  Minimum Value: 0

  The length of the error text in the response body.
• Content-Type: string
  The MIME type of the error text in the response body.

403 Response

Forbidden. Possible causes:

• A data center has not been selected for your service in Oracle Cloud My Services.
• The request was sent to an incorrect data center. For example, the data center for your service is Chicago (us2), but the request was sent to the URL corresponding to the Ashburn (us6) data center.
• You don't have the required permission to perform the operation on the specified container. For example, there may be a change in the roles assigned to your user or the access privileges defined for the container specified in the request.
• The specified operation is not permitted for archive objects or containers with storage class Archive
• Violating a container or object level WORM policy by trying to PUT, POST, or DELETE an object that has not expired or trying to update an existing container level WORM policy.

Headers

• Content-Length: integer
  Minimum Value: 0

  The length of the error text in the response body.
• Content-Type: string
  The MIME type of the error text in the response body.

Back to Top

Examples

cURL Command

The following example shows how to create a container in your account in Oracle Cloud Infrastructure Object Storage Classic by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -v -X PUT \
     -H "X-Auth-Token: AUTH_tkb4fdf39c92e9f62cca9b7c196f8b6e6b" \
     https://foo.storage.oraclecloud.com/v1/myservice-bar/FirstContainer

Sample Response

The following is a sample response of this command:

HTTP/1.1 201 Created
Date: Fri, 06 Mar 2015 10:34:20 GMT
Content-Length: 0
Content-Type: text/html; charset=UTF-8
X-Trans-Id: tx23a1084b8c674fdeae8d4-0054f982ac

Back to Top