Skip to main content
PUT
Create or Update One Folder Rule
Creates the rule for one folder prefix or changes it, and leaves the other rules alone. Put the prefix in the URL, URL-encoded (for example tmp%2F). The response is the whole list with its new etag. Scope: blob:write.
string
required
Folder prefix, URL-encoded. Stored with a trailing /.
A rule needs at least one field besides the prefix; an empty rule returns VALIDATION_ERROR.
string
Default visibility of new objects in the folder: public or private.
number
Default expiration of each new object, in seconds. At least the plan’s minimum expiration (7 days, or 1 hour on Enterprise-26 or higher).
number
Largest accepted file, 512 bytes to 10 GB.
string[]
Accepted extensions: 1–50 items, each 1–16 lowercase characters (letters and digits), without the dot.
string
Default cache_control of new objects. no-cache needs Enterprise-26 or higher.
number
Delete objects this many days after upload, 1–3650. Applies 24 hours after the rule is saved.
string
The workspace ID, when the blob belongs to a workspace. The call acts on the blob of the workspace owner and needs the blob:read workspace permission (blob:manage on routes that change data). Leave it out to act on your own blob.

Example request

Response

object
The whole rule list and its new etag.

Error Responses

string
The error code indicating the reason for failure. Possible values:
  • AUTH_TOKEN_MISSING (401): No Authorization header was sent.
  • API_KEY_INVALID (401): The API key doesn’t exist, was revoked, or its secret doesn’t match.
  • API_KEY_SCOPE_DENIED (403): The key lacks the scope this route needs (blob:read or blob:write); details.required names it.
  • WORKSPACE_PERMISSION_DENIED (403): Only with workspace_id: you’re not a member, or your role lacks the blob permission.
  • WORKSPACE_NOT_FOUND (404): Only with workspace_id: no workspace with that ID, or you’re not a member.
  • BLOB_NAMESPACE_SUSPENDED (403): The account’s blob storage is suspended, or its plan expired. Uploads and other writes are refused from the start of the 72-hour grace period.
  • VALIDATION_ERROR (400): A parameter or body field failed validation. details.path names the field.
  • BLOB_RULE_LIMIT (409): Adding this rule would exceed the plan’s rule limit: 5, 10 or 20.
  • PLAN_RESTRICTED_FEATURE (403): cache_control is no-cache on a plan below Enterprise-26.