Bucket:Set Bucket Lock

Search (SHIFT+S)

Set Bucket Lock

PUT /object/bucket/{bucketName}/lock/{IsLocked}

Locks or unlocks the specified bucket. Current user's namespace is used.

bucketName	Name of the bucket which is to be locked/unlocked.
IsLocked	Set to "true" for lock bucket and "false" for unlock bucket.

Required Roles

Requires one of the following roles:

SYSTEM_ADMIN
NAMESPACE_ADMIN

Prerequisites

The following conditions must be met in order to call this operation.

Bucket must exist.

Request Payload

<set_bucket_lock>
   <namespace></namespace>
</set_bucket_lock>

{
  "namespace": ""
}

All parameters are required unless otherwise stated.

Field	Description	Type	Notes
set_bucket_lock
namespace	Namespace that is allowed to access this bucket	String

Response Body

Response indicating Success or Failure of the operation

Examples

Request

PUT https://192.168.0.0:4443/object/bucket/standalone-bucket/lock/true: HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

<set_bucket_lock>
   <namespace>s3</namespace>
</set_bucket_lock>

Response

HTTP/1.1 200 OK
Content-Type: application/xml

Request

PUT https://192.168.0.0:4443/object/bucket/standalone-bucket/lock/true.json HTTP/1.1

Content-Type: application/json
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

{
  "set_bucket_lock": { "namespace": "s3" }
}

Response

HTTP/1.1 200 OK
Content-Type: application/json