Update IPFS Universal Path Gateway Content List

client.web3.hostnames.ipfsUniversalPaths.contentLists.update(, , ?): ContentList { action }

PUT/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Web3 Hostnames Write

ParametersExpand Collapse

identifier: string

Specify the identifier of the hostname.

maxLength32

params: ContentListUpdateParams { zone_id, action, entries }

zone_id: string

Path param: Specify the identifier of the hostname.

maxLength32

action: "block"

Body param: Behavior of the content list.

entries: Array<Entry>

Body param: Provides content list entries.

id?: string

Specify the identifier of the hostname.

maxLength32

content?: string

Specify the CID or content path of content to block.

maxLength500

created_on?: string

formatdate-time

description?: string

Specify an optional description of the content list entry.

maxLength500

modified_on?: string

formatdate-time

type?: "cid" | "content_path"

Specify the type of content list entry to block.

One of the following:

"cid"

"content_path"

ReturnsExpand Collapse

ContentList { action }

action?: "block"

Behavior of the content list.

Update IPFS Universal Path Gateway Content List

import Cloudflare from 'cloudflare';

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

const contentList = await client.web3.hostnames.ipfsUniversalPaths.contentLists.update(
  '023e105f4ecef8ad9ca31a8372d0c353',
  {
    zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
    action: 'block',
    entries: [{}],
  },
);

console.log(contentList.action);

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "action": "block"
  },
  "success": true,
  "result_info": {}
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "action": "block"
  },
  "success": true,
  "result_info": {}
}