Endpoint

/v1/s3/buckets/

GET

List all S3 buckets present in the system.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_bucket_description_list_model",
  "type": "object",
  "properties": {
    "buckets": {
      "type": "array",
      "items": {
        "description": "buckets",
        "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"
          }
        }
      }
    }
  }
}

POST

Create a new S3 bucket.

Parameters

This resource has no parameters.

Request

Schema

{
  "description": "api_bucket_options",
  "type": "object",
  "properties": {
    "name": {
      "description": "name",
      "type": "string"
    },
    "path": {
      "description": "The absolute path to the directory to use as bucket root directory. The caller must have permission to look up this directory.",
      "type": "string"
    },
    "create_fs_path": {
      "description": "Specifies whether to create the bucket root if it doesn't exist.",
      "type": "boolean"
    }
  }
}

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"
    }
  }
}