PUT /accounts/{account_id}/r2/buckets/{bucket_name}/lock

Set lock rules for a bucket.

Servers

Path parameters

Name Type Required Description
bucket_name String Yes
account_id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

cf-r2-jurisdiction String No

Possible values:

  • "eu"
  • "fedramp"
  • "default"

Default value: "default"

Request body fields

Name Type Required Description
rules[] Array No
rules[].id String Yes

Unique identifier for this rule.

rules[].prefix String No

Rule will only apply to objects/uploads in the bucket that start with the given prefix, an empty prefix can be provided to scope rule to all objects/uploads.

rules[].condition Object Yes
rules[].enabled Boolean Yes

Whether or not this rule is in effect.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.