Manage gateways

To create a gateway using the dashboard:

1. Log in to the Cloudflare dashboard 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, Ethereum, or Polygon.
• DNSLink: Only applicable to IPFS gateways, more details at DNSLink.

6. Click Deploy.

To create a gateway using the API, send a POST 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, polygon).

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

Request
curl -X POST \
-H "X-Auth-Email: user@cloudflare.com" \
-H "X-Auth-Key: REDACTED" \
"https://api.cloudflare.com/client/v4/zones/<ZONE_ID>/web3/hostnames" \
-H "Content-Type: application/json" \
-d '{
      "name": "gateway.example.com",
      "description":"This is my IPFS gateway.",
      "target":"ipfs",
      "dnslink":"/ipns/onboarding.ipfs.cloudflare.com"
  }'

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>"
  }
}

To edit a gateway using the dashboard:

1. Log in to the Cloudflare dashboard 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 PATCH Open API docs link request.

To refresh a gateway using the dashboard:

1. Log in to the Cloudflare dashboard 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 PATCH Open API docs link request with an empty request body.

To add an item to the blocklist using the dashboard:

1. Log in to the Cloudflare dashboard 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 POST Open API docs link request.

To delete a gateway using the dashboard:

1. Log in to the Cloudflare dashboard 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 DELETE Open API docs link request.