Get Bucket Lock Rules

client.R2.Buckets.Locks.Get(ctx, bucketName, params) (*BucketLockGetResponse, error)

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

Get lock rules for a bucket.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

ParametersExpand Collapse

bucketName string

Name of the bucket.

maxLength64

minLength3

params BucketLockGetParams

AccountID param.Field[string]

Path param: Account ID.

maxLength32

Jurisdiction param.Field[BucketLockGetParamsCfR2Jurisdiction]Optional

Header param: Jurisdiction where objects in this bucket are guaranteed to be stored.

const BucketLockGetParamsCfR2JurisdictionDefault BucketLockGetParamsCfR2Jurisdiction = "default"

const BucketLockGetParamsCfR2JurisdictionEu BucketLockGetParamsCfR2Jurisdiction = "eu"

const BucketLockGetParamsCfR2JurisdictionFedramp BucketLockGetParamsCfR2Jurisdiction = "fedramp"

ReturnsExpand Collapse

type BucketLockGetResponse struct{…}

Rules []BucketLockGetResponseRuleOptional

ID string

Unique identifier for this rule.

Condition BucketLockGetResponseRulesCondition

Condition to apply a lock rule to an object for how long in seconds.

One of the following:

type BucketLockGetResponseRulesConditionR2LockRuleAgeCondition struct{…}

Condition to apply a lock rule to an object for how long in seconds.

MaxAgeSeconds int64

Type BucketLockGetResponseRulesConditionR2LockRuleAgeConditionType

type BucketLockGetResponseRulesConditionR2LockRuleDateCondition struct{…}

Condition to apply a lock rule to an object until a specific date.

Date Time

formatdate-time

Type BucketLockGetResponseRulesConditionR2LockRuleDateConditionType

type BucketLockGetResponseRulesConditionR2LockRuleIndefiniteCondition struct{…}

Condition to apply a lock rule indefinitely.

Type BucketLockGetResponseRulesConditionR2LockRuleIndefiniteConditionType

Enabled bool

Whether or not this rule is in effect.

Prefix stringOptional

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.

Get Bucket Lock Rules

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/option"
  "github.com/stainless-sdks/cloudflare-go/r2"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  lock, err := client.R2.Buckets.Locks.Get(
    context.TODO(),
    "example-bucket",
    r2.BucketLockGetParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", lock.Rules)
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    "string"
  ],
  "result": {
    "rules": [
      {
        "id": "Lock all objects for 24 hours",
        "condition": {
          "maxAgeSeconds": 100,
          "type": "Age"
        },
        "enabled": true,
        "prefix": "prefix"
      }
    ]
  },
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    "string"
  ],
  "result": {
    "rules": [
      {
        "id": "Lock all objects for 24 hours",
        "condition": {
          "maxAgeSeconds": 100,
          "type": "Age"
        },
        "enabled": true,
        "prefix": "prefix"
      }
    ]
  },
  "success": true
}