API reference / Storage

Storage

Object storage bucket and watch-folder management.

GET /api/v1/storage/buckets

List object storage buckets.

Response

Response 200 (application/json)
[
  {
    "name": "string",
    "role": "source"
  }
]

POST /api/v1/storage/buckets

Create a bucket.

Request

Request body (application/json)
{
  "name": "string"
}

Response

Response 201 (application/json)
{
  "name": "string",
  "role": "custom"
}

GET /api/v1/storage/buckets/{bucket}/objects

List objects in a bucket.

Parameters

NameInTypeRequired
prefixquerystringoptional
limitqueryintegeroptional
bucketpathstringrequired

Response

Response 200 (application/json)
{
  "objects": [
    {
      "key": "string",
      "size": 0,
      "isPrefix": true,
      "lastModified": "string"
    }
  ],
  "prefix": "string",
  "bucket": "string"
}

DELETE /api/v1/storage/buckets/{bucket}/objects/{*}

Delete an object from a bucket.

Parameters

NameInTypeRequired
bucketpathstringrequired
*pathstringrequired

Response

Response 204 (application/json)
"null"

GET /api/v1/storage/buckets/{bucket}/watch-folder

Get watch-folder status for a bucket.

Parameters

NameInTypeRequired
bucketpathstringrequired

Response

Response 200 (application/json)
{
  "enabled": true,
  "running": true,
  "bucket": "string"
}

POST /api/v1/storage/buckets/{bucket}/watch-folder/toggle

Toggle watch-folder ingest for a bucket.

Parameters

NameInTypeRequired
bucketpathstringrequired

Response

Response 200 (application/json)
{
  "enabled": true,
  "running": true,
  "bucket": "string"
}