Cloudflare v0.2.0

Cloudflare.Zone (Cloudflare v0.2.0) View Source

Zone

A Zone is a domain name along with its subdomains and other identities

List Zones

GET List, search, sort, and filter your zones

GET zones

Permission needed: #zone:read

Available in:

  • FREE
  • PRO
  • BUSINESS
  • ENTERPRISE

Create Zone

POST

POST zones

Permission needed: #zone:edit

Available in:

  • FREE
  • PRO
  • BUSINESS
  • ENTERPRISE

Zone Details

GET

GET zones/:identifier

Permission needed: #zone:read

Available in:

  • FREE
  • PRO
  • BUSINESS
  • ENTERPRISE

Edit Zone

PATCH Only one zone property can be changed at a time

PATCH zones/:identifier

Permission needed: None

Available in:

  • FREE
  • PRO
  • BUSINESS
  • ENTERPRISE

Delete Zone

DELETE Delete an existing zone.

DELETE zones/:identifier

Permission needed: #zone:edit

Available in:

  • FREE
  • PRO
  • BUSINESS
  • ENTERPRISE

Zone Activation Check

PUT Initiate another zone activation check

PUT zones/:identifier/activation_check

Permission needed: #zone:edit

Available in:

  • FREE
  • PRO
  • BUSINESS
  • ENTERPRISE

Purge All Files

POST Remove ALL files from Cloudflare's cache

POST zones/:identifier/purge_cache

Permission needed: #cache_purge:edit

Available in:

  • FREE
  • PRO
  • BUSINESS
  • ENTERPRISE

Purge Files by URL

POST Granularly remove one or more files from Cloudflare's cache either by specifying URLs. All tiers can purge by URL.To purge files with custom cache keys, include the headers used to compute the cache key as in the example. To purge files with ${geo} or ${devicetype} in their cache keys, include the CF-Device-Type or CF-IPCountry headers.NB: When including the Origin header, be sure to include the scheme and hostname. The port number can be omitted if it is the default port (80 for http, 443 for https), but must be included otherwise.

POST zones/:identifier/purge_cache

Permission needed: #cache_purge:edit

Available in:

  • FREE
  • PRO
  • BUSINESS
  • ENTERPRISE

Link to this section Summary

Functions

activation_check(id, opts \\ [])
client(opts \\ [])
create(body, opts \\ [])
create!(body, opts \\ [])
delete(id, opts \\ [])
delete!(id, opts \\ [])
index(opts \\ [])
index!(opts \\ [])
path_for(id, opts \\ [])
purge_cache(id, matcher \\ %{}, opts \\ [])

Purge all files

Cloudflare.Zone.purge_cache(zone_id)

Purge specific files

Cloudflare.Zone.purge_cache(zone_id, %{
  "files" => [
    "http://www.example.com/css/styles.css",
    %{
      "headers" => %{
        "CF-Device-Type" => "desktop",
        "CF-IPCountry" => "US",
        "Origin" => "https://www.cloudflare.com"
      },
      "url" => "http://www.example.com/cat_picture.jpg"
    }
  ]
})

Cloudflare.Zone.purge_cache(zone_id, %{
  "hosts" => ["www.example.com", "images.example.com"],
  "prefixes" => ["www.example.com/foo", "images.example.com/bar/baz"],
  "tags" => ["some-tag", "another-tag"]
})
show(id, opts \\ [])
show!(id, opts \\ [])
update(id, body, opts \\ [])
update!(id, body, opts \\ [])

Link to this section Functions

Link to this function

activation_check(id, opts \\ [])

View Source

Specs

activation_check(id :: term(), opts :: Restlax.Resource.action_options()) ::
  Tesla.Env.result()
Link to this function

client(opts \\ [])

View Source

Specs

client(Restlax.Resource.action_options()) :: module()
Link to this function

create(body, opts \\ [])

View Source

Specs

create(
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) ::
  Tesla.Env.result()
Link to this function

create!(body, opts \\ [])

View Source

Specs

create!(
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) ::
  Tesla.Env.t() | no_return()
Link to this function

delete(id, opts \\ [])

View Source

Specs

delete(id :: term(), opts :: Restlax.Resource.action_options()) ::
  Tesla.Env.result()
Link to this function

delete!(id, opts \\ [])

View Source

Specs

delete!(id :: term(), opts :: Restlax.Resource.action_options()) ::
  Tesla.Env.t() | no_return()
Link to this function

index(opts \\ [])

View Source

Specs

index(opts :: Restlax.Resource.action_options()) :: Tesla.Env.result()
Link to this function

index!(opts \\ [])

View Source

Specs

index!(opts :: Restlax.Resource.action_options()) :: Tesla.Env.t() | no_return()
Link to this function

path_for(id, opts \\ [])

View Source

Specs

path_for(term(), [{:action, String.t()}]) :: String.t()
Link to this function

purge_cache(id, matcher \\ %{}, opts \\ [])

View Source

Specs

purge_cache(
  id :: term(),
  matcher :: map() | keyword(),
  opts :: Restlax.Resource.action_options()
) :: Tesla.Env.result()

Purge all files 

Cloudflare.Zone.purge_cache(zone_id)

Purge specific files 

Cloudflare.Zone.purge_cache(zone_id, %{
  "files" => [
    "http://www.example.com/css/styles.css",
    %{
      "headers" => %{
        "CF-Device-Type" => "desktop",
        "CF-IPCountry" => "US",
        "Origin" => "https://www.cloudflare.com"
      },
      "url" => "http://www.example.com/cat_picture.jpg"
    }
  ]
})

Cloudflare.Zone.purge_cache(zone_id, %{
  "hosts" => ["www.example.com", "images.example.com"],
  "prefixes" => ["www.example.com/foo", "images.example.com/bar/baz"],
  "tags" => ["some-tag", "another-tag"]
})
Link to this function

show(id, opts \\ [])

View Source

Specs

show(id :: term(), opts :: Restlax.Resource.action_options()) ::
  Tesla.Env.result()
Link to this function

show!(id, opts \\ [])

View Source

Specs

show!(id :: term(), opts :: Restlax.Resource.action_options()) ::
  Tesla.Env.t() | no_return()
Link to this function

update(id, body, opts \\ [])

View Source

Specs

update(
  id :: term(),
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) :: Tesla.Env.result()
Link to this function

update!(id, body, opts \\ [])

View Source

Specs

update!(
  id :: term(),
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) :: Tesla.Env.t() | no_return()