Skip to main content
GET
/
filesystems
/
{filesystem}
Get object storage bucket
curl --request GET \
  --url https://app.laravel.cloud/api/filesystems/{filesystem} \
  --header 'Authorization: Bearer <token>'
{
  "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>"
          }
        ]
      }
    }
  },
  "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.

Path Parameters

filesystem
string
required

The filesystem identifier

Query Parameters

include
string

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

Response

FilesystemResource

data
FilesystemResource · object
required
included
FilesystemKeyResource · object[]