/v1/s3/buckets/{name} | Qumulo Documentation

Endpoint

/v1/s3/buckets/{name}

DELETE

Delete an existing S3 bucket.

Parameters

Name	Description	Required
`name`	Bucket name	Yes
`delete-root-dir`	If set to true, the root directory of the bucket will also be unlinked. Otherwise the root directory is not unlinked.	Yes

Response

Codes

Code	Description
200	Return value on success

PATCH

Modify the versioning status or lock configuration for the specified S3 bucket

Parameters

Name	Description	Required
`name`	Bucket name	Yes

Request

Schema

{
  "description": "api_bucket_patch",
  "type": "object",
  "properties": {
    "anonymous_access_enabled": {
      "description": "[Deprecated] Use bucket policies to enable anonymous access",
      "type": "boolean"
    },
    "versioning": {
      "description": "The versioning state of the S3 bucket: Unversioned, Enabled, or Suspended. Note: These values are case sensitive.",
      "type": "string"
    },
    "lock_config": {
      "description": "The lock configuration of the S3 bucket.",
      "type": "object",
      "properties": {
        "enabled": {
          "description": "Specifies whether Object Lock is enabled for the S3 bucket.",
          "type": "boolean"
        },
        "default_retention": {
          "description": "The default retention period for the S3 bucket.",
          "type": "object",
          "properties": {
            "units": {
              "description": "The units of the retention, either DAYS or YEARS",
              "type": "string"
            },
            "value": {
              "description": "The number of either DAYS or YEARS in the retention period",
              "type": "number"
            }
          }
        }
      }
    }
  }
}

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_bucket_description",
  "type": "object",
  "properties": {
    "name": {
      "description": "The name of the S3 bucket.",
      "type": "string"
    },
    "creation_time": {
      "description": "The creation time of the S3 bucket.",
      "type": "string"
    },
    "path": {
      "description": "The bucket root directory of the S3 bucket.",
      "type": "string"
    },
    "anonymous_access_enabled": {
      "description": "Deprecated. To configure anonymous access for an S3 bucket, use the qq s3_set_bucket policy command with an Allow statement that targets the local:guest account.",
      "type": "boolean"
    },
    "versioning": {
      "description": "The versioning state of the current S3 bucket: Unversioned, Enabled, or Suspended.",
      "type": "string"
    },
    "lock_config": {
      "description": "The Object Lock configuration for the S3 bucket.",
      "type": "object",
      "properties": {
        "enabled": {
          "description": "Specifies whether Object Lock is enabled for the S3 bucket.",
          "type": "boolean"
        },
        "default_retention": {
          "description": "The default retention period for the S3 bucket.",
          "type": "object",
          "properties": {
            "units": {
              "description": "The units of the retention, either DAYS or YEARS",
              "type": "string"
            },
            "value": {
              "description": "The number of either DAYS or YEARS in the retention period",
              "type": "number"
            }
          }
        }
      }
    }
  }
}