Skip to main content

Get Containers

This request returns a list of containers that are available for files upload.

get /storage/containers

Sample​

A sample GET request to get a list of containers:

curl -X GET \
'https://api.carrierx.com/core/v2/storage/containers' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response​

200 status code with a list of Container objects:

{
    "count": 1,
    "has_more": false,
    "items": [
        {
            "allow_publish": true,
            "allowed_classifications": [],
            "available_bytes_percent": 100,
            "available_files_percent": 100,
            "blocked_classifications": [],
            "container_sid": "a291fe99-43d6-446f-a63e-91f93030dc7e",
            "default_file_lifecycle_action": "no_action",
            "default_file_lifecycle_ttl": -1,
            "default_file_publish": "file_sid",
            "default_file_threshold_include": true,
            "default_file_unique": false,
            "durability_class": "unassigned",
            "encrypted": false,
            "external_attributes": {},
            "integer_key_1": null,
            "integer_key_2": null,
            "name": "N/A",
            "parent_container_sid": null,
            "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
            "publish_domain": "https://storage.carrierx.com",
            "quota_bytes": 1073741824,
            "quota_files": 100,
            "string_key_1": null,
            "string_key_2": null,
            "string_key_3": null,
            "string_key_4": null,
            "threshold_action": null,
            "threshold_available_bytes_percent": null,
            "threshold_available_files_percent": null,
            "threshold_bytes": null,
            "threshold_bytes_target": null,
            "threshold_files": null,
            "threshold_files_target": null,
            "threshold_grace_period": 0,
            "threshold_total_bytes": 0,
            "threshold_total_files": 0,
            "total_bytes": 0,
            "total_files": 0,
            "type": "internal",
            "unique": false
        }
    ],
    "limit": 1000,
    "offset": 0,
    "pagination": {},
    "total": 1
}

This request is enabled for Pagination, Result Filtering, and Field Filtering.

Required Scopes​

To get information about Container objects, the partner must have one of the following scopes enabled:

  • storage.manage
  • storage.read