CloudflareApi.Web3Hostname (cloudflare_api v0.5.0)

Helper functions for Cloudflare Web3 Hostname endpoints, including IPFS content list management.

Summary

Functions

create_content_list_entry(client, zone_id, identifier, params)

Create a content list entry (POST /zones/:zone_id/web3/hostnames/:identifier/ipfs_universal_path/content_list/entries).

create_hostname(client, zone_id, params)

Create a Web3 hostname (POST /zones/:zone_id/web3/hostnames).

delete_content_list_entry(client, zone_id, identifier, entry_id)

Delete a content list entry (DELETE /zones/:zone_id/web3/hostnames/:identifier/ipfs_universal_path/content_list/entries/:content_list_entry_identifier).

delete_hostname(client, zone_id, identifier)

Delete a Web3 hostname (DELETE /zones/:zone_id/web3/hostnames/:identifier).

get_content_list(client, zone_id, identifier)

Fetch the IPFS universal path content list (GET /zones/:zone_id/web3/hostnames/:identifier/ipfs_universal_path/content_list).

get_content_list_entry(client, zone_id, identifier, entry_id)

Fetch a content list entry (GET /zones/:zone_id/web3/hostnames/:identifier/ipfs_universal_path/content_list/entries/:content_list_entry_identifier).

get_hostname(client, zone_id, identifier)

Fetch a Web3 hostname (GET /zones/:zone_id/web3/hostnames/:identifier).

list_content_list_entries(client, zone_id, identifier)

List content list entries (GET /zones/:zone_id/web3/hostnames/:identifier/ipfs_universal_path/content_list/entries).

list_hostnames(client, zone_id)

List Web3 hostnames (GET /zones/:zone_id/web3/hostnames).

patch_hostname(client, zone_id, identifier, params)

Patch a Web3 hostname (PATCH /zones/:zone_id/web3/hostnames/:identifier).

update_content_list(client, zone_id, identifier, params)

Replace the IPFS universal path content list (PUT /zones/:zone_id/web3/hostnames/:identifier/ipfs_universal_path/content_list).

update_content_list_entry(client, zone_id, identifier, entry_id, params)

Replace a content list entry (PUT /zones/:zone_id/web3/hostnames/:identifier/ipfs_universal_path/content_list/entries/:content_list_entry_identifier).

Functions

create_content_list_entry(client, zone_id, identifier, params)

@spec create_content_list_entry(
  Tesla.Client.t() | (-> Tesla.Client.t()),
  String.t(),
  String.t(),
  keyword() | map() | nil
) :: {:ok, term()} | {:error, term()}

Create a content list entry (POST /zones/:zone_id/web3/hostnames/:identifier/ipfs_universal_path/content_list/entries).

create_hostname(client, zone_id, params)

@spec create_hostname(
  Tesla.Client.t() | (-> Tesla.Client.t()),
  String.t(),
  keyword() | map() | nil
) ::
  {:ok, term()} | {:error, term()}

Create a Web3 hostname (POST /zones/:zone_id/web3/hostnames).

delete_content_list_entry(client, zone_id, identifier, entry_id)

@spec delete_content_list_entry(
  Tesla.Client.t() | (-> Tesla.Client.t()),
  String.t(),
  String.t(),
  String.t()
) :: {:ok, term()} | {:error, term()}

Delete a content list entry (DELETE /zones/:zone_id/web3/hostnames/:identifier/ipfs_universal_path/content_list/entries/:content_list_entry_identifier).

delete_hostname(client, zone_id, identifier)

@spec delete_hostname(
  Tesla.Client.t() | (-> Tesla.Client.t()),
  String.t(),
  String.t()
) ::
  {:ok, term()} | {:error, term()}

Delete a Web3 hostname (DELETE /zones/:zone_id/web3/hostnames/:identifier).

get_content_list(client, zone_id, identifier)

@spec get_content_list(
  Tesla.Client.t() | (-> Tesla.Client.t()),
  String.t(),
  String.t()
) ::
  {:ok, term()} | {:error, term()}

Fetch the IPFS universal path content list (GET /zones/:zone_id/web3/hostnames/:identifier/ipfs_universal_path/content_list).

get_content_list_entry(client, zone_id, identifier, entry_id)

@spec get_content_list_entry(
  Tesla.Client.t() | (-> Tesla.Client.t()),
  String.t(),
  String.t(),
  String.t()
) :: {:ok, term()} | {:error, term()}

Fetch a content list entry (GET /zones/:zone_id/web3/hostnames/:identifier/ipfs_universal_path/content_list/entries/:content_list_entry_identifier).

get_hostname(client, zone_id, identifier)

@spec get_hostname(Tesla.Client.t() | (-> Tesla.Client.t()), String.t(), String.t()) ::
  {:ok, term()} | {:error, term()}

Fetch a Web3 hostname (GET /zones/:zone_id/web3/hostnames/:identifier).

list_content_list_entries(client, zone_id, identifier)

@spec list_content_list_entries(
  Tesla.Client.t() | (-> Tesla.Client.t()),
  String.t(),
  String.t()
) ::
  {:ok, term()} | {:error, term()}

List content list entries (GET /zones/:zone_id/web3/hostnames/:identifier/ipfs_universal_path/content_list/entries).

list_hostnames(client, zone_id)

@spec list_hostnames(Tesla.Client.t() | (-> Tesla.Client.t()), String.t()) ::
  {:ok, term()} | {:error, term()}

List Web3 hostnames (GET /zones/:zone_id/web3/hostnames).

patch_hostname(client, zone_id, identifier, params)

@spec patch_hostname(
  Tesla.Client.t() | (-> Tesla.Client.t()),
  String.t(),
  String.t(),
  keyword() | map() | nil
) :: {:ok, term()} | {:error, term()}

Patch a Web3 hostname (PATCH /zones/:zone_id/web3/hostnames/:identifier).

update_content_list(client, zone_id, identifier, params)

@spec update_content_list(
  Tesla.Client.t() | (-> Tesla.Client.t()),
  String.t(),
  String.t(),
  keyword() | map() | nil
) :: {:ok, term()} | {:error, term()}

Replace the IPFS universal path content list (PUT /zones/:zone_id/web3/hostnames/:identifier/ipfs_universal_path/content_list).

update_content_list_entry(client, zone_id, identifier, entry_id, params)

@spec update_content_list_entry(
  Tesla.Client.t() | (-> Tesla.Client.t()),
  String.t(),
  String.t(),
  String.t(),
  keyword() | map() | nil
) :: {:ok, term()} | {:error, term()}

Replace a content list entry (PUT /zones/:zone_id/web3/hostnames/:identifier/ipfs_universal_path/content_list/entries/:content_list_entry_identifier).