Skip to content
Cloudflare API
Start here
API Reference
R2
Buckets
Domains
Custom

Attach Custom Domain To Bucket

client.r2.buckets.domains.custom.create(stringbucketName, CustomCreateParams { account_id, domain, enabled, 4 more } params, RequestOptionsoptions?): CustomCreateResponse { domain, enabled, zoneId, 2 more }
POST/accounts/{account_id}/r2/buckets/{bucket_name}/domains/custom

Register a new custom domain for an existing R2 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: CustomCreateParams { account_id, domain, enabled, 4 more }
account_id: string

Path param: Account ID.

maxLength32
domain: string

Body param: Name of the custom domain to be added.

enabled: boolean

Body param: Whether to enable public bucket access at the custom domain. If undefined, the domain will be enabled.

zoneId: string

Body param: Zone ID of the custom domain.

ciphers?: Array<string>

Body param: An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.

minTLS?: "1.0" | "1.1" | "1.2" | "1.3"

Body param: Minimum TLS Version the custom domain will accept for incoming connections. If not set, defaults to 1.0.

One of the following:
"1.0"
"1.1"
"1.2"
"1.3"
jurisdiction?: "default" | "eu" | "fedramp"

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

One of the following:
"default"
"eu"
"fedramp"
ReturnsExpand Collapse
CustomCreateResponse { domain, enabled, zoneId, 2 more }
domain: string

Domain name of the affected custom domain.

enabled: boolean

Whether this bucket is publicly accessible at the specified custom domain.

zoneId: string

Zone ID of the custom domain.

ciphers?: Array<string>

An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.

minTLS?: "1.0" | "1.1" | "1.2" | "1.3"

Minimum TLS Version the custom domain will accept for incoming connections. If not set, defaults to 1.0.

One of the following:
"1.0"
"1.1"
"1.2"
"1.3"

Attach Custom Domain To Bucket

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const custom = await client.r2.buckets.domains.custom.create('example-bucket', {
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
  domain: 'prefix.example-domain.com',
  enabled: true,
  zoneId: '36ca64a6d92827b8a6b90be344bb1bfd',
});

console.log(custom.domain);
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    "string"
  ],
  "result": {
    "domain": "example-domain.com",
    "enabled": true,
    "zoneId": "36ca64a6d92827b8a6b90be344bb1bfd",
    "ciphers": [
      "string"
    ],
    "minTLS": "1.0"
  },
  "success": true
}
Returns Examples
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    "string"
  ],
  "result": {
    "domain": "example-domain.com",
    "enabled": true,
    "zoneId": "36ca64a6d92827b8a6b90be344bb1bfd",
    "ciphers": [
      "string"
    ],
    "minTLS": "1.0"
  },
  "success": true
}