Get prefix rules

Read the per-prefix rules of your Blob Storage account with GET /v1/account/settings: default visibility, expiry and cache, size and type limits, auto-deletion.

GET /v1/account/settings

cURL

curl --request GET \
  --url 'https://blob.squarecloud.app/v1/account/settings' \
  --header 'Authorization: YOUR_API_KEY'

{
  "status": "success",
  "response": {
    "rules": [
      {
        "prefix": "invoices/",
        "private": true,
        "extensions": ["pdf"],
        "created_at": "2026-09-25T12:00:00.000Z"
      },
      {
        "prefix": "tmp/",
        "delete_after_days": 7,
        "created_at": "2026-09-25T12:00:00.000Z",
        "active_from": "2026-09-26T12:00:00.000Z"
      }
    ]
  }
}

Authorization · string · required

The API key for your account. You can find this in your account settings.

Get Settings returns the rules saved with Update Settings. Each rule applies to the files under its prefix: default visibility, expiry and cache, size and type limits, and automatic deletion. Requires the blob:read scope.

Response

status · string

“success” if successful, “error” if not.

response · object

Show properties

rules · array

The rules, as saved. See Update Settings for each field.

Show properties

prefix · string

The prefix the rule applies to, ending in /.

private · boolean

Default visibility.

expire · string

Default expiry.

max_size · number

Maximum file size, in bytes.

extensions · string[]

Accepted extensions.

cache_control · string

Default cache.

delete_after_days · number

Days after which files are deleted.

created_at · ISO 8601

When the rule was saved.

active_from · ISO 8601

When automatic deletion starts to act (24 hours after created_at). Present only with delete_after_days.

cURL

curl --request GET \
  --url 'https://blob.squarecloud.app/v1/account/settings' \
  --header 'Authorization: YOUR_API_KEY'

{
  "status": "success",
  "response": {
    "rules": [
      {
        "prefix": "invoices/",
        "private": true,
        "extensions": ["pdf"],
        "created_at": "2026-09-25T12:00:00.000Z"
      },
      {
        "prefix": "tmp/",
        "delete_after_days": 7,
        "created_at": "2026-09-25T12:00:00.000Z",
        "active_from": "2026-09-26T12:00:00.000Z"
      }
    ]
  }
}

Related

• Blob SDK: blob.rules.get()