Update IPFS Universal Path Gateway Content List

PUT

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

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

Request

Path Params

identifier

string

required

zone_identifier

string

required

Body Params application/json

action

enum<string>

required

Behavior of the content list.

Allowed value:

block

Example:

block

entries

array[object (content_list_entry) {3}]

required

Content list entries.

content

string

optional

CID or content path of content to block.

<= 500 characters

Example:

QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB

description

string

optional

An optional description of the content list entry.

<= 500 characters

Example:

this is my content list entry

type

enum<string>

optional

Type of content list entry to block.

Allowed values:

cidcontent_path

Example:

cid

Example

{
    "action": "block",
    "entries": [
        {
            "content": "QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB",
            "description": "this is my content list entry",
            "type": "cid"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.cloudflare.com/client/v4/zones//web3/hostnames//ipfs_universal_path/content_list' \
--header 'Content-Type: application/json' \
--data-raw '{
    "action": "block",
    "entries": [
        {
            "content": "QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB",
            "description": "this is my content list entry",
            "type": "cid"
        }
    ]
}'

Responses

🟢200Update IPFS Universal Path Gateway Content List 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 (content_list_details)

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "action": "block"
    },
    "success": true
}

🟢200Update IPFS Universal Path Gateway Content List response failure

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

IPFS Universal Path Gateway Content List Details

List IPFS Universal Path Gateway Content List Entries