{
  "opencollection": "1.0.0",
  "info": {
    "name": "Rook Ceph Object Storage Buckets Objects API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Objects",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Objects in a Bucket",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{rgw-host}:{port}/:bucket",
            "params": [
              {
                "name": "bucket",
                "value": "",
                "type": "path",
                "description": "Name of the S3 bucket in the Ceph Object Storage gateway. Must be globally unique within the object store and follow DNS naming conventions."
              },
              {
                "name": "list-type",
                "value": "",
                "type": "query",
                "description": "Set to 2 to use the newer List Objects V2 API which uses continuation tokens instead of markers for pagination."
              },
              {
                "name": "prefix",
                "value": "",
                "type": "query",
                "description": "Limits the response to keys beginning with the specified prefix. Used to organize objects into virtual directories."
              },
              {
                "name": "delimiter",
                "value": "",
                "type": "query",
                "description": "Character used to group keys. All keys that contain the delimiter between the prefix and the first occurrence of the delimiter are grouped into a single CommonPrefix entry."
              },
              {
                "name": "max-keys",
                "value": "",
                "type": "query",
                "description": "Maximum number of keys to return in a single response. Defaults to 1000, maximum is 1000."
              },
              {
                "name": "continuation-token",
                "value": "",
                "type": "query",
                "description": "Token from a previous List Objects V2 response used to continue listing from where the previous call left off."
              },
              {
                "name": "marker",
                "value": "",
                "type": "query",
                "description": "Key after which listing should begin, used for pagination in List Objects V1 API."
              }
            ]
          },
          "docs": "Returns a list of objects stored in the specified S3 bucket. Supports filtering by prefix, delimiter for hierarchical listings, and pagination through continuation tokens. Returns up to 1000 objects per request by default."
        },
        {
          "info": {
            "name": "Download an Object",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{rgw-host}:{port}/:bucket/:key",
            "headers": [
              {
                "name": "Range",
                "value": ""
              },
              {
                "name": "If-Match",
                "value": ""
              },
              {
                "name": "If-None-Match",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "bucket",
                "value": "",
                "type": "path",
                "description": "Name of the S3 bucket in the Ceph Object Storage gateway. Must be globally unique within the object store and follow DNS naming conventions."
              },
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "Object key (path) within the bucket. Can include forward slashes to simulate a directory hierarchy, with a maximum length of 1024 bytes."
              }
            ]
          },
          "docs": "Downloads the data and metadata of an object from the specified key in the S3 bucket. Supports range requests for partial content retrieval and conditional requests using ETag or Last-Modified headers. Returns the object data in the response body."
        },
        {
          "info": {
            "name": "Upload an Object",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://{rgw-host}:{port}/:bucket/:key",
            "params": [
              {
                "name": "bucket",
                "value": "",
                "type": "path",
                "description": "Name of the S3 bucket in the Ceph Object Storage gateway. Must be globally unique within the object store and follow DNS naming conventions."
              },
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "Object key (path) within the bucket. Can include forward slashes to simulate a directory hierarchy, with a maximum length of 1024 bytes."
              }
            ]
          },
          "docs": "Uploads an object to the specified key in the S3 bucket. The object data is included in the request body. Optional request headers allow specifying content type, content encoding, server-side encryption, storage class, and custom metadata prefixed with x-amz-meta-."
        },
        {
          "info": {
            "name": "Delete an Object",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://{rgw-host}:{port}/:bucket/:key",
            "params": [
              {
                "name": "bucket",
                "value": "",
                "type": "path",
                "description": "Name of the S3 bucket in the Ceph Object Storage gateway. Must be globally unique within the object store and follow DNS naming conventions."
              },
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "Object key (path) within the bucket. Can include forward slashes to simulate a directory hierarchy, with a maximum length of 1024 bytes."
              }
            ]
          },
          "docs": "Deletes the specified object from the S3 bucket. If versioning is enabled, this creates a delete marker rather than permanently removing the object. The operation is idempotent and returns HTTP 204 even if the object does not exist."
        },
        {
          "info": {
            "name": "Get Object Metadata",
            "type": "http"
          },
          "http": {
            "method": "HEAD",
            "url": "http://{rgw-host}:{port}/:bucket/:key",
            "params": [
              {
                "name": "bucket",
                "value": "",
                "type": "path",
                "description": "Name of the S3 bucket in the Ceph Object Storage gateway. Must be globally unique within the object store and follow DNS naming conventions."
              },
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "Object key (path) within the bucket. Can include forward slashes to simulate a directory hierarchy, with a maximum length of 1024 bytes."
              }
            ]
          },
          "docs": "Retrieves the metadata of an object without downloading the object data. Returns HTTP headers containing content type, content length, ETag, last modified date, and any custom metadata associated with the object."
        }
      ]
    }
  ],
  "bundled": true
}