List buckets

Lists the buckets in the workspace, in name order, one page at a time. Pass nextCursor as cursor to read the next page. Pass name to find one bucket by its exact name, prefix to list the buckets whose name starts with a text, or nameContains to list the buckets whose name holds a text. Pass state=deleted to list the buckets that can still be restored. Role: viewer or higher.

GET/v1/workspaces/{workspaceId}/buckets

Authentication

Send your Graphon API key with every request. The value is the whole API key that Graphon showed when you created it. See Authentication.

Authorization: Bearer <GRAPHON_API_KEY>

curl \
  --url "https://storage.graphon.sh/v1/workspaces/wspq7ws2np5l8z4/buckets" \
  --header "Authorization: Bearer $GRAPHON_API_KEY"

Request

Loading your session…

Response

JSON

{
  "items": [
    {
      "id": "bktA1b2C3d4E5",
      "workspaceId": "wspq7ws2np5l8z4",
      "name": "support-tickets",
      "provider": "gcp",
      "location": "us-central1",
      "storageClass": "standard",
      "permission": "private",
      "phase": "active",
      "recoverableUntil": null,
      "availability": "online",
      "indexing": "enabled",
      "objectCount": 12,
      "revision": 1,
      "createdAt": "2026-10-01T12:00:00.000Z",
      "policy": {}
    }
  ],
  "nextCursor": null
}

Path parameters

workspaceIdstring

The workspace id.

Query parameters

namestring (optional)

Return only the bucket with this exact name.

statestring (optional)

active (the default) lists buckets that can be used. deleted lists buckets inside their recovery window. all lists both. One of: active, deleted, all.

prefixstring (optional)

Return only the buckets whose name starts with this text. It matches the start of the name, and it is case-sensitive.

nameContainsstring (optional)

Return only the buckets whose name holds this text. It matches anywhere in the name, and it ignores case.

cursorstring (optional)

The nextCursor from the previous page.

limitstring (optional)

The most buckets on one page, from 1 to 1000. The default is 1000.

Was this page helpful?

View as Markdown