Get Bucket CORS Policy

client.R2.Buckets.CORS.Get(ctx, bucketName, params) (*BucketCORSGetResponse, error)

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

Get the CORS policy 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 BucketCORSGetParams

AccountID param.Field[string]

Path param: Account ID.

maxLength32

Jurisdiction param.Field[BucketCORSGetParamsCfR2Jurisdiction]Optional

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

const BucketCORSGetParamsCfR2JurisdictionDefault BucketCORSGetParamsCfR2Jurisdiction = "default"

const BucketCORSGetParamsCfR2JurisdictionEu BucketCORSGetParamsCfR2Jurisdiction = "eu"

const BucketCORSGetParamsCfR2JurisdictionFedramp BucketCORSGetParamsCfR2Jurisdiction = "fedramp"

ReturnsExpand Collapse

type BucketCORSGetResponse struct{…}

Rules []BucketCORSGetResponseRuleOptional

Allowed BucketCORSGetResponseRulesAllowed

Object specifying allowed origins, methods and headers for this CORS rule.

Methods []BucketCORSGetResponseRulesAllowedMethod

Specifies the value for the Access-Control-Allow-Methods header R2 sets when requesting objects in a bucket from a browser.

One of the following:

const BucketCORSGetResponseRulesAllowedMethodGet BucketCORSGetResponseRulesAllowedMethod = "GET"

const BucketCORSGetResponseRulesAllowedMethodPut BucketCORSGetResponseRulesAllowedMethod = "PUT"

const BucketCORSGetResponseRulesAllowedMethodPost BucketCORSGetResponseRulesAllowedMethod = "POST"

const BucketCORSGetResponseRulesAllowedMethodDelete BucketCORSGetResponseRulesAllowedMethod = "DELETE"

const BucketCORSGetResponseRulesAllowedMethodHead BucketCORSGetResponseRulesAllowedMethod = "HEAD"

Origins []string

Specifies the value for the Access-Control-Allow-Origin header R2 sets when requesting objects in a bucket from a browser.

Headers []stringOptional

Specifies the value for the Access-Control-Allow-Headers header R2 sets when requesting objects in this bucket from a browser. Cross-origin requests that include custom headers (e.g. x-user-id) should specify these headers as AllowedHeaders.

ID stringOptional

Identifier for this rule.

ExposeHeaders []stringOptional

Specifies the headers that can be exposed back, and accessed by, the JavaScript making the cross-origin request. If you need to access headers beyond the safelisted response headers, such as Content-Encoding or cf-cache-status, you must specify it here.

MaxAgeSeconds float64Optional

Specifies the amount of time (in seconds) browsers are allowed to cache CORS preflight responses. Browsers may limit this to 2 hours or less, even if the maximum value (86400) is specified.

Get Bucket CORS Policy

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"),
  )
  cors, err := client.R2.Buckets.CORS.Get(
    context.TODO(),
    "example-bucket",
    r2.BucketCORSGetParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", cors.Rules)
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    "string"
  ],
  "result": {
    "rules": [
      {
        "allowed": {
          "methods": [
            "GET"
          ],
          "origins": [
            "http://localhost:3000"
          ],
          "headers": [
            "x-requested-by"
          ]
        },
        "id": "Allow Local Development",
        "exposeHeaders": [
          "Content-Encoding"
        ],
        "maxAgeSeconds": 3600
      }
    ]
  },
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    "string"
  ],
  "result": {
    "rules": [
      {
        "allowed": {
          "methods": [
            "GET"
          ],
          "origins": [
            "http://localhost:3000"
          ],
          "headers": [
            "x-requested-by"
          ]
        },
        "id": "Allow Local Development",
        "exposeHeaders": [
          "Content-Encoding"
        ],
        "maxAgeSeconds": 3600
      }
    ]
  },
  "success": true
}