developers.cloudflare.com Open in urlscan Pro
104.16.3.189  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Skip to content
Cloudflare Docs logomark
Cloudflare Docs

Web3
Navigation menu iconOpen external link

Cloudflare Docs logomark
Cloudflare Docs


Web3
Dropdown iconWeb3 menu
 * Web3 homepage

 * Overview
 * About
 * Get started
 * Expand: How to How to
    * Manage gateways
    * Subscribe to gateways
    * Use Ethereum gateway
    * Use IPFS gateway
    * Customize Cloudflare settings
    * Restrict gateway access

 * Expand: IPFS Gateway IPFS Gateway
    * Expand: Concepts Concepts
       * Interplanetary File System (IPFS)
       * DNSLink gateways
       * Universal Path gateway
   
    * Expand: Reference Reference
       * Peering
       * Using IPFS with your website
       * Automated deployments
   
    * Troubleshooting

 * Expand: Ethereum Gateway Ethereum Gateway
    * Expand: Concepts Concepts
       * Ethereum network
       * Node types
   
    * Expand: Reference Reference
       * Supported API methods
       * Supported networks
       * Rinkeby deprecation
       * Kill Switches

 * Expand: Reference Reference
    * Gateway DNS records
    * Gateway status
    * Legacy gateway migration
    * Limits

 * API referenceAPI link label Open API docs link




SearchK
Edit Edit this page

Issue Report an issue with this page

Log in Log into the Cloudflare dashboard

Search icon (depiction of a magnifying glass)
Light theme icon (depiction of a sun)
Dark theme icon (depiction of a moon)
Set theme to dark (⇧+D)
 * ↑ Top
 * Create a gateway
 * Edit a gateway
 * Refresh a gateway
 * Update blocklist
 * Delete a gateway


 1. Products
 2. Web3
 3. How to
 4. Manage gateways


MANAGE GATEWAYS

A Cloudflare Web3 gateway provides HTTP-accessible interfaces to various Web3
networks. You can interact with a gateway in several ways.


CREATE A GATEWAY

 * Dashboard
 * API

To create a gateway using the dashboard:

 1. Log in to the Cloudflare dashboardExternal link icon Open external link .
 2. Select your account and website.
 3. Go to Web3.
 4. Click Create Web3 Gateway.
 5. Enter the following information:

 * Hostname: Enter a hostname to use as your gateway, which has to be a
   subdomain of the current Cloudflare zone.
 * Gateway Description: Enter a description to help distinguish between
   different gateways.
 * Gateway Type: Select a gateway target of IPFS DNSLink, IPFS Universal Path,
   or Ethereum.
 * DNSLink: Only applicable to IPFS gateways, more details at DNSLink.

 6. Click Deploy.

To create a gateway using the API, send a POSTAPI link label Open API docs link
request that includes the following parameters:

 * name: The hostname that will point to the target gateway via a CNAME record.
 * target: The gateway target for the hostname (ethereum, ipfs,
   ipfs_universal_path).

If you need help with API authentication, refer to Cloudflare API documentation.

Request
curl "https://api.cloudflare.com/client/v4/zones/{zone_id}/web3/hostnames" \

--header "X-Auth-Email: <EMAIL>" \

--header "X-Auth-Key: <API_KEY>" \

--header "Content-Type: application/json" \

--data '{
  "name": "gateway.example.com",
  "description": "This is my IPFS gateway.",
  "target": "ipfs",
  "dnslink": "/ipns/onboarding.ipfs.cloudflare.com"
}'


Copy Button

The response contains the complete definition of the new gateway.

Response
{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "<WEB3_GATEWAY_ID>",
    "name": "gateway.example.com",
    "description": "This is my IPFS gateway.",
    "status": "active",
    "target": "ipfs",
    "dnslink": "/ipns/onboarding.ipfs.cloudflare.com",
    "created_on": "<CREATED_ON_DATE>",
    "modified_on": "<MODIFIED_ON_DATE>"
  }

}


Copy Button

When you create a gateway, Cloudflare automatically:

 * Creates and adds records to your Cloudflare DNS so your gateway can receive
   and route traffic appropriately.
 * Proxies traffic to that hostname.
 * Issues an SSL/TLS certificate to cover the specified hostname.

--------------------------------------------------------------------------------


EDIT A GATEWAY

Once you have created a gateway, you can only edit the Gateway Description and —
if it is an IPFS gateway — also edit the value for the DNSLink field.

If you need to edit other fields, delete the gateway and create a new one.

 * Dashboard
 * API

To edit a gateway using the dashboard:

 1. Log in to the Cloudflare dashboardExternal link icon Open external link .
 2. Select your account and website.
 3. Go to Web3.
 4. On a specific gateway, click Edit.
 5. Update the Gateway Description and — if editing an IPFS gateway — the value
    for the DNSLink.
 6. Click Reapply.

To edit specific settings for a gateway, use a PATCHAPI link label Open API docs
link request.

--------------------------------------------------------------------------------


REFRESH A GATEWAY

When your gateway is stuck in an Error status, you should try refreshing the
gateway, which attempts to re-create the associated DNS records for the
hostname.

 * Dashboard
 * API

To refresh a gateway using the dashboard:

 1. Log in to the Cloudflare dashboardExternal link icon Open external link .
 2. Select your account and website.
 3. Go to Web3.
 4. On a gateway, click the dropdown then Refresh.

To refresh a gateway using the API, send a PATCHAPI link label Open API docs
link request with an empty request body.

--------------------------------------------------------------------------------


UPDATE BLOCKLIST

When you set up a IPFS Universal Path gateway, you may want to add items to the
gateway blocklist, which allows you to block access to specific content.

You have the ability to block access to one or more:

 * CIDs (QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB)
 * IPFS content paths
   (/ipfs/QmYwAPJzv5CZsnA625s3Xf2nemtYgPpHdWEz79ojWnPbdG/readme)
 * IPNS content paths (/ipns/example.com)

 * Dashboard
 * API

To add an item to the blocklist using the dashboard:

 1. Log in to the Cloudflare dashboardExternal link icon Open external link .

 2. Select your account and website.

 3. Go to Web3.

 4. On a specific gateway, click the dropdown then Blocklist.

 5. Click Add entry.

 6. Enter the following information:
    
    * Blocklist entry type: Choose CID or Content path.
    * Blocklist entry content: Add a CID or content path to block, meaning
      either a valid CIDv0 or CIDv1 string (CID) or the entry should start with
      /ipfs/ or /ipns/ (content path).
    * Blocklist entry description: Add a description to help you identify the
      blocklist entry.

 7. Click Add.

To add a blocklist item using the API, send a POSTAPI link label Open API docs
link request.

--------------------------------------------------------------------------------


DELETE A GATEWAY

When you delete a gateway, Cloudflare will automatically remove all associated
hostname DNS records. This action will impact your traffic and cannot be undone.

 * Dashboard
 * API

To delete a gateway using the dashboard:

 1. Log in to the Cloudflare dashboardExternal link icon Open external link .
 2. Select your account and website.
 3. Go to Web3.
 4. On a specific gateway, click the dropdown then Remove.
 5. Click Delete hostname.

To delete a gateway using the API, send a DELETEAPI link label Open API docs
link request.
Cloudflare DashboardExternal link icon Open external link   ·   DiscordExternal
link icon Open external link   ·   CommunityExternal link icon Open external
link   ·   Learning CenterExternal link icon Open external link   ·   Support
PortalExternal link icon Open external link   ·   Cookie Preferences
Edit on GitHubExternal link icon Open external link   ·   Updated 1 year ago



OUR SITE USES COOKIES

Like most websites, we use cookies to make our site work the way you expect it
to, improve your experience on our site, analyze site usage, and assist in our
marketing efforts. By choosing "Accept All Cookies", you agree to the storing of
all categories of cookies on your device. If you wish to accept or reject some
categories of cookies, please click “Cookie Preferences.”
Cookie Preferences Reject All Accept All Cookies



YOUR COOKIE OPTIONS

Cloudflare uses four types of cookies as described below. You can decide which
categories of cookies you wish to accept to improve your experience on our
website. To learn more about the cookies we use on our site, please read our
Cookie Policy.
Cloudflare's Cookie Policy
Allow All


MANAGE CONSENT PREFERENCES

STRICTLY NECESSARY COOKIES

Always Active

Strictly Necessary cookies are essential to our website functioning as expected.
You cannot turn off Strictly Necessary cookies because they are required to
deliver security, enable core site functionality, and help you use our site's
features and services as you would expect (including remembering your cookie
consent preferences). Cloudflare does not use these cookies to track individuals
across websites.

Cookies Details‎

FUNCTIONAL COOKIES

Functional Cookies

Functional cookies allow us to remember choices you make about the kind of
experience you want on our site and to provide you with a more personalized
experience. For example, a functional cookie is required to remember which
language you prefer.

Cookies Details‎

PERFORMANCE COOKIES

Performance Cookies

Performance cookies help us learn how you use our website to help improve its
performance and design. These cookies provide us with aggregated statistical
information such as number of page visits, page load speeds, how long a user
spends on a particular page, and the types of browsers or devices used to access
our site.

Cookies Details‎

TARGETING COOKIES

Targeting Cookies

We use Targeting cookies to deliver advertisements relevant to you and your
interests when you visit other websites that host advertisements.

Cookies Details‎
Back Button


COOKIE LIST



Search Icon
Filter Icon

Clear
checkbox label label
Apply Cancel
Consent Leg.Interest
checkbox label label
checkbox label label
checkbox label label

Reject All Confirm My Choices