{
  "opencollection": "1.0.0",
  "info": {
    "name": "Cloud Storage Service Public API",
    "version": "3.1.6"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Objects",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "The list of all objects that meet the filter rule criteria.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.8x8.com/storage/{region}/{apiversion}/objects",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "\nThis API is designed with filtering capabilities using Feed Item Query Language (FIQL) filter expressions. <br> FIQL introduces simple and composite operators which can be used to build basic and complex queries. <br> If the *filter* is not specified, all objects are returned.\nThe following are basic FIQL operators:\n* **`==`** - Equal to\n* **`!=`** - Not equal to\n* **`=gt=`** - Greater than\n* **`=ge=`** - Greater or equal to\n* **`=lt=`** - Less than\n* **`=le=`** - Less or equal to\nThese six operators can be used to different types of simple queries. For example:\n* **`name==MyRecording**` - Finds all items with name **`MyRecording`**\n* **`type!=callrecording`** - Finds all items which are not **`callrecording`**\n* **`size=gt=1024`** - Finds all items with size bigger than 1024\n* **`size=le=1024`** - Finds all items with size smaller or equal with 1024\nFIQL joining operators consist of the following:\n* **`;`** = AND\n* **`,`** = OR\nThese two operators can be used to join simple queries and build more complex queries. For example:\n* **`name==MyRecording,name==YourRecording`** - Find all items with name **`MyRecording`** or with name **`YourRecording`**\n* **`type==callrecording;size=gt=1024`** - Find all **`callrecording`** items with size greather than 1024\n* **`type==callrecording;(name==MyRecording,name==YourRecording)`** - Find all **`callrecording`** items with name **`MyRecording`** or with name **`YourRecording`**\n"
              },
              {
                "name": "pageKey",
                "value": "",
                "type": "query",
                "description": "This parameter indicates the page number to begin your query."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "This parameter indicates the page size to begin your query with.  A value between 1 and 100 is supported."
              },
              {
                "name": "sortField",
                "value": "",
                "type": "query",
                "description": "The field used for sorting. Content and Tag fields are supported."
              },
              {
                "name": "sortDirection",
                "value": "",
                "type": "query",
                "description": "This field describes the sorting direction. Sorting can be specified as 'ASC' for ascending or 'DESC' for descending."
              }
            ]
          },
          "docs": "\n**Tagging**\nThe CSS API features a generic tagging methodology.  The tags  on each object are determined either systematically or by customer definition.  Systematic tags are generated by the underlying provider system.  \nThe following object types are supported:\n\n* **`callrecording`**\n* **`callcenterrecording`**\n* **`screenrecording`**\n* **`meeting`**\n\nThe tag types vary depending on the provider. \n**`callrecording`**\n\n   * **pbxname** The human readable name of the PBX system.\n   * **extensio"
        },
        {
          "info": {
            "name": "Find an object by it's ID.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.8x8.com/storage/{region}/{apiversion}/objects/:objectId",
            "params": [
              {
                "name": "objectId",
                "value": "",
                "type": "path",
                "description": "Use this parameter to specify the object ID to return."
              }
            ]
          },
          "docs": "Use this method to retrieve an object by its ID."
        },
        {
          "info": {
            "name": "Download content for the given metadata.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.8x8.com/storage/{region}/{apiversion}/objects/:objectId/metadata",
            "params": [
              {
                "name": "objectId",
                "value": "",
                "type": "path",
                "description": "This parameter obtains the ID for the returned object."
              }
            ]
          },
          "docs": "This method retrieves an object using the objectId specification for a given record."
        },
        {
          "info": {
            "name": "Download content for the given metadata.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.8x8.com/storage/{region}/{apiversion}/objects/:objectId/content",
            "params": [
              {
                "name": "objectId",
                "value": "",
                "type": "path",
                "description": "This parameter obtains the ID for the returned object."
              },
              {
                "name": "presignUrl",
                "value": "",
                "type": "query",
                "description": "By specifying this parameter option, the object content which is associated with the metadata record is returned as a **`presignedUrl`** instead of a machine-readable ID."
              }
            ]
          },
          "docs": "This method retrieves an object using the **`objectId`** specification for a given record."
        }
      ]
    },
    {
      "info": {
        "name": "Bulk Downloads",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Remove existing objects.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.8x8.com/storage/{region}/{apiversion}/bulk",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This method enables you to bulk delete object metadata along with associated content."
        },
        {
          "info": {
            "name": "Cancel a running bulk download job by zip file name.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.8x8.com/storage/{region}/{apiversion}/bulk/download/cancel/:zipName",
            "params": [
              {
                "name": "zipName",
                "value": "",
                "type": "path",
                "description": "The zip archive name for bulk download cancellation."
              }
            ]
          },
          "docs": "This method cancels a running bulk download job by the zip file name."
        },
        {
          "info": {
            "name": "Removes tasks from a download request.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.8x8.com/storage/{region}/{apiversion}/bulk/download/clear"
          },
          "docs": "This method clears your task queue for bulk download requests."
        },
        {
          "info": {
            "name": "Start bulk download.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.8x8.com/storage/{region}/{apiversion}/bulk/download/start",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This method starts downloading multiple objects in bulk. The objects are zipped and transferred as one file."
        },
        {
          "info": {
            "name": "Returns the status of all bulk download job requests.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.8x8.com/storage/{region}/{apiversion}/bulk/download/status"
          },
          "docs": "This method returns the status of all bulk download job requests."
        },
        {
          "info": {
            "name": "Returns the status of a single bulk download job request by zip filename.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.8x8.com/storage/{region}/{apiversion}/bulk/download/status/:zipName",
            "params": [
              {
                "name": "presignUrl",
                "value": "",
                "type": "query",
                "description": "The pre-signed URL."
              },
              {
                "name": "zipName",
                "value": "",
                "type": "path",
                "description": "This method returns the status details for the given .zip archive."
              }
            ]
          },
          "docs": "This method returns the status of a single bulk download job request by zip filename."
        },
        {
          "info": {
            "name": "Request bulk download by .zip filename.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.8x8.com/storage/{region}/{apiversion}/bulk/download/:zipName",
            "params": [
              {
                "name": "zipName",
                "value": "",
                "type": "path",
                "description": "This operation specifies the .zip archive file name to download."
              }
            ]
          },
          "docs": "This method enables access to a single zipped file that was generated from a bulk download request and is ready for retrieval."
        }
      ]
    },
    {
      "info": {
        "name": "Buckets",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Search all buckets.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.8x8.com/storage/{region}/{apiversion}/buckets"
          },
          "docs": "A bucket is a resource that is used to store data objects and their associated metadata. This method returns all content within existing buckets."
        },
        {
          "info": {
            "name": "Returns the content of a specified bucket.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.8x8.com/storage/{region}/{apiversion}/buckets/:bucketId",
            "params": [
              {
                "name": "bucketId",
                "value": "",
                "type": "path",
                "description": "The ID for the specified bucket."
              }
            ]
          },
          "docs": "This method returns all of the contents contained within a specific bucket."
        }
      ]
    }
  ],
  "bundled": true
}