List buckets

GET/v1/buckets

Returns all object-store buckets the token has access to. Optionally filter by project ID.

AuthorizationBearer <token>

OAuth2 authentication

In: header

Scope: workspace:admin, offline_access

cursor?|

Cursor for pagination

limit?integer

Page size, 1-100

Range1 <= value <= 100

Default100

projectId?string

Filter buckets by project ID

Match^(proj_)?([cC][^\s-]{8,}|[a-z0-9]+)$

logicalId?string

Declared identity of the resource, unique within its branch. Set by the tool that declares the resource.

Match^[A-Za-z0-9][A-Za-z0-9._-]*$

Lengthlength <= 255

branchId?string|

branchGitName?string

Length1 <= length

curl -X GET "https://example.com/v1/buckets"

{
  "data": [
    {
      "id": "string",
      "type": "bucket",
      "url": "http://example.com",
      "name": "string",
      "providerName": "string",
      "status": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "project": {
        "id": "string",
        "url": "http://example.com",
        "name": "string"
      },
      "branchId": "string",
      "logicalId": "string"
    }
  ],
  "pagination": {
    "nextCursor": "string",
    "hasMore": true
  }
}