List object storage buckets

Get a list of all object storage buckets for the authenticated organization.

GET /buckets

List object storage buckets

cURL

curl --request GET \
  --url https://cloud.laravel.com/api/buckets \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "<string>",
      "type": "filesystems",
      "attributes": {
        "name": "<string>",
        "type": "cloudflare_r2",
        "status": "creating",
        "visibility": "private",
        "jurisdiction": "default",
        "endpoint": "<string>",
        "url": "<string>",
        "allowed_origins": [
          "<unknown>"
        ],
        "created_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "keys": {
          "data": [
            {
              "type": "filesystemKeys",
              "id": "<string>"
            }
          ]
        }
      }
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 2,
    "from": 2,
    "last_page": 2,
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "path": "<string>",
    "per_page": 1,
    "to": 2,
    "total": 1
  },
  "included": [
    {
      "id": "<string>",
      "type": "filesystemKeys",
      "attributes": {
        "name": "<string>",
        "permission": "read_write",
        "access_key_id": "<string>",
        "access_key_secret": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "filesystem": {
          "data": {
            "type": "filesystems",
            "id": "<string>"
          }
        }
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

The Bearer Token generated on the Cloud UI.

Query Parameters

include · string

Available includes are keys. You can include multiple options by separating them with a comma.

filter[type] · string

filter[status] · string

filter[visibility] · string

Response

200

application/vnd.api+json

Paginated set of FilesystemResource

data · FilesystemResource · object[] · required

Show child attributes

links · object · required

Show child attributes

meta · object · required

Show child attributes

included · FilesystemKeyResource · object[]

Show child attributes