Edit Web3 Hostname

PATCH

https://api.cloudflare.com/client/v4/zones/{zone_identifier}/web3/hostnames/{identifier}

Last modified:2022-12-16 13:48:35

Request

Path Params

identifier

string

required

zone_identifier

string

required

Body Params application/json

description

string

optional

An optional description of the hostname.

<= 500 characters

Example:

This is my IPFS gateway.

dnslink

string

optional

DNSLink value used if the target is ipfs.

Example:

/ipns/onboarding.ipfs.cloudflare.com

Example

{
    "description": "This is my IPFS gateway.",
    "dnslink": "/ipns/onboarding.ipfs.cloudflare.com"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.cloudflare.com/client/v4/zones//web3/hostnames/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "This is my IPFS gateway.",
    "dnslink": "/ipns/onboarding.ipfs.cloudflare.com"
}'

Responses

🟢200Edit Web3 Hostname response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object (web3-hostname)

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "created_on": "2014-01-01T05:20:00.12345Z",
        "description": "This is my IPFS gateway.",
        "dnslink": "/ipns/onboarding.ipfs.cloudflare.com",
        "id": "023e105f4ecef8ad9ca31a8372d0c353",
        "modified_on": "2014-01-01T05:20:00.12345Z",
        "name": "gateway.example.com",
        "status": "active",
        "target": "ipfs"
    },
    "success": true
}

🟢200Edit Web3 Hostname response failure

Modified at 2022-12-16 13:48:35

Web3 Hostname Details

IPFS Universal Path Gateway Content List Details