List IPFS Universal Path Gateway Content List Entries

client.Web3.Hostnames.IPFSUniversalPaths.ContentLists.Entries.List(ctx, identifier, query) (*HostnameIPFSUniversalPathContentListEntryListResponse, error)

GET/zones/{zone_id}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries

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 WriteWeb3 Hostnames Read

ParametersExpand Collapse

identifier string

Specify the identifier of the hostname.

maxLength32

query HostnameIPFSUniversalPathContentListEntryListParams

ZoneID param.Field[string]

Specify the identifier of the hostname.

maxLength32

ReturnsExpand Collapse

type HostnameIPFSUniversalPathContentListEntryListResponse struct{…}

Entries []HostnameIPFSUniversalPathContentListEntryListResponseEntryOptional

Provides content list entries.

ID stringOptional

Specify the identifier of the hostname.

maxLength32

Content stringOptional

Specify the CID or content path of content to block.

maxLength500

CreatedOn TimeOptional

formatdate-time

Description stringOptional

Specify an optional description of the content list entry.

maxLength500

ModifiedOn TimeOptional

formatdate-time

Type HostnameIPFSUniversalPathContentListEntryListResponseEntriesTypeOptional

Specify the type of content list entry to block.

One of the following:

const HostnameIPFSUniversalPathContentListEntryListResponseEntriesTypeCid HostnameIPFSUniversalPathContentListEntryListResponseEntriesType = "cid"

const HostnameIPFSUniversalPathContentListEntryListResponseEntriesTypeContentPath HostnameIPFSUniversalPathContentListEntryListResponseEntriesType = "content_path"

List IPFS Universal Path Gateway Content List Entries

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/web3"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  entries, err := client.Web3.Hostnames.IPFSUniversalPaths.ContentLists.Entries.List(
    context.TODO(),
    "023e105f4ecef8ad9ca31a8372d0c353",
    web3.HostnameIPFSUniversalPathContentListEntryListParams{
      ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", entries.Entries)
}

{
  "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": {
    "entries": [
      {
        "id": "023e105f4ecef8ad9ca31a8372d0c353",
        "content": "QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB",
        "created_on": "2014-01-01T05:20:00.12345Z",
        "description": "this is my content list entry",
        "modified_on": "2014-01-01T05:20:00.12345Z",
        "type": "cid"
      }
    ]
  },
  "success": true,
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}

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": {
    "entries": [
      {
        "id": "023e105f4ecef8ad9ca31a8372d0c353",
        "content": "QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB",
        "created_on": "2014-01-01T05:20:00.12345Z",
        "description": "this is my content list entry",
        "modified_on": "2014-01-01T05:20:00.12345Z",
        "type": "cid"
      }
    ]
  },
  "success": true,
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}