---
title: "List object storage keys"
method: GET
path: "/buckets/{filesystem}/keys"
tags: ["Bucket Keys"]
---

# List object storage keys

`GET /buckets/{filesystem}/keys`

## Request

- Base URL: `https://cloud.laravel.com/api`
- URL: `https://cloud.laravel.com/api/buckets/{filesystem}/keys`
- Auth: HTTP bearer

Get a list of all keys for a specific object storage bucket.

## Path parameters

- `filesystem` string, required

## Query parameters

- `include` string[]

## Response `200`

Paginated set of `FilesystemKeyResource`

- object
  - `data` FilesystemKeyResource[], required
    - `id` string, required
    - `type` 'filesystemKeys', required
    - `attributes` object
      - `name` string, required
      - `permission` 'read_write' | 'read_only', required
      - `access_key_id` string, nullable, required
      - `access_key_secret` string, nullable, required
      - `created_at` string, date-time, nullable, required
    - `relationships` object
      - `filesystem` object
        - `data` FilesystemResourceIdentifier, required
          - `type` 'filesystems', required
          - `id` string, required
  - `links` object, required
    - `first` string
    - `last` string
    - `prev` string
    - `next` string
  - `meta` object, required
    - `current_page` integer, required
    - `from` integer, nullable, required
    - `last_page` integer, required
    - `links` object[], required: Generated paginator links.
      - `url` string, nullable, required
      - `label` string, required
      - `active` boolean, required
    - `path` string, nullable, required: Base path for paginator generated URLs.
    - `per_page` integer, required: Number of items shown per page.
    - `to` integer, nullable, required: Number of the last item in the slice.
    - `total` integer, required: Total number of items being paginated.
  - `included` FilesystemResource[]
    - `id` string, required
    - `type` 'filesystems', required
    - `attributes` object
      - `name` string, required
      - `type` 'cloudflare_r2', required
      - `status` 'creating' | 'updating' | 'available' | 'deleting' | 'deleted' | 'unknown', required
      - `visibility` 'private' | 'public', required
      - `jurisdiction` 'default' | 'eu' | 'us', required
      - `location_hint` 'automatic' | 'wnam' | 'enam' | 'weur' | 'eeur' | 'apac' | 'oc', required: Where Cloudflare should place an R2 bucket's data. Automatic lets Cloudflare choose, which it does from the caller's location rather than the customer's.
      - `endpoint` string, nullable, required
      - `url` string, nullable, required
      - `allowed_origins` unknown, required
      - `cors_settings` unknown, required
      - `created_at` string, date-time, nullable, required
    - `relationships` object
      - `keys` object
        - `data` FilesystemKeyResourceIdentifier[], required
          - `type` 'filesystemKeys', required
          - `id` string, required

## Other responses

- `403`: Authorization error
- `404`: Not found

---

[API](https://skmtc.dev/laravel/apis/laravel-cloud.md) - [All operations](https://skmtc.dev/laravel/apis/laravel-cloud/llms.txt) - [OpenAPI document](https://skmtc.dev/laravel/apis/laravel-cloud/revisions/af603f54ff33?raw)
