Skip to main content
GET
/
v1
/
buckets
/
{bucket_identifier}
Get Bucket
curl --request GET \
  --url https://api.mixpeek.com/v1/buckets/{bucket_identifier} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Namespace: <x-namespace>'
{
  "bucket_id": "<string>",
  "bucket_name": "<string>",
  "description": "<string>",
  "bucket_schema": {
    "properties": {}
  },
  "unique_key": {
    "default_policy": "upsert",
    "description": "Single field, upsert by default (idempotent video ingestion)",
    "fields": [
      "video_id"
    ]
  },
  "metadata": {},
  "object_count": 123,
  "total_size_bytes": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "last_upload_at": "2023-11-07T05:31:56Z",
  "status": "ACTIVE",
  "is_locked": false,
  "batch_stats": {
    "total": 0,
    "active": 0,
    "completed": 0,
    "failed": 0
  },
  "storage_stats": {
    "total_size_bytes": 0,
    "avg_size_bytes": 0,
    "max_size_bytes": 0,
    "min_size_bytes": 0
  }
}

Authorizations

Authorization
string
header
required

Headers

Authorization
string
required
Examples:
X-Namespace
string
required
Examples:

Path Parameters

bucket_identifier
string
required

Response

bucket_name
string
required
object_count
integer
required
total_size_bytes
integer
required
bucket_id
string
description
string | null
bucket_schema
object | null
unique_key
object | null
Examples:
metadata
object
created_at
string<date-time> | null
updated_at
string<date-time> | null
last_upload_at
string<date-time> | null
status
enum<string>
Available options:
PENDING,
IN_PROGRESS,
PROCESSING,
COMPLETED,
COMPLETED_WITH_ERRORS,
FAILED,
CANCELED,
UNKNOWN,
SKIPPED,
DRAFT,
ACTIVE,
ARCHIVED,
SUSPENDED
is_locked
boolean
default:false
batch_stats
object | null
storage_stats
object | null