Cloudflare.ZoneRuleset (Cloudflare v0.5.0)

Copy Markdown View Source

Zone Rulesets

Create a zone ruleset

POST /zones/{zone_id}/rulesets

Creates a ruleset at the zone level.

Responses

200

Data is at body["result"]

4XX

List zone rulesets

GET /zones/{zone_id}/rulesets

Fetches all rulesets at the zone level.

Responses

200

Data is at body["result"]

4XX

Update a zone entry point ruleset

PUT /zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint

Updates a zone entry point ruleset, creating a new version.

Responses

200

Data is at body["result"]

4XX

Get a zone entry point ruleset

GET /zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint

Fetches the latest version of the zone entry point ruleset for a given phase.

Responses

200

Data is at body["result"]

4XX

List a zone entry point ruleset's versions

GET /zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions

Fetches the versions of a zone entry point ruleset.

Responses

200

Data is at body["result"]

4XX

Get a zone entry point ruleset version

GET /zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}

Fetches a specific version of a zone entry point ruleset.

Responses

200

Data is at body["result"]

4XX

Update a zone ruleset

PUT /zones/{zone_id}/rulesets/{ruleset_id}

Updates a zone ruleset, creating a new version.

Responses

200

Data is at body["result"]

4XX

Get a zone ruleset

GET /zones/{zone_id}/rulesets/{ruleset_id}

Fetches the latest version of a zone ruleset.

Responses

200

Data is at body["result"]

4XX

Delete a zone ruleset

DELETE /zones/{zone_id}/rulesets/{ruleset_id}

Deletes all versions of an existing zone ruleset.

Responses

204

Data is at body["result"]

4XX

Create a zone ruleset rule

POST /zones/{zone_id}/rulesets/{ruleset_id}/rules

Adds a new rule to a zone ruleset. The rule will be added to the end of the existing list of rules in the ruleset by default.

Responses

200

Data is at body["result"]

4XX

Update a zone ruleset rule

PATCH /zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}

Updates an existing rule in a zone ruleset.

Responses

200

Data is at body["result"]

4XX

Delete a zone ruleset rule

DELETE /zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}

Deletes an existing rule from a zone ruleset.

Responses

200

Data is at body["result"]

4XX

List a zone ruleset's versions

GET /zones/{zone_id}/rulesets/{ruleset_id}/versions

Fetches the versions of a zone ruleset.

Responses

200

Data is at body["result"]

4XX

Get a zone ruleset version

GET /zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}

Fetches a specific version of a zone ruleset.

Responses

200

Data is at body["result"]

4XX

Delete a zone ruleset version

DELETE /zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}

Deletes an existing version of a zone ruleset.

Responses

204

Data is at body["result"]

4XX

List a zone ruleset version's rules by tag

GET /zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}/by_tag/{rule_tag}

Fetches the rules of a managed zone ruleset version for a given tag.

Responses

200

Data is at body["result"]

4XX

Summary

Functions

client(opts \\ [])
create(body, opts \\ [])
create!(body, opts \\ [])
create_rule(ruleset_id, body, opts \\ [])

Adds a new rule to a zone ruleset.

delete(id, opts \\ [])
delete!(id, opts \\ [])
index(opts \\ [])
index!(opts \\ [])
path_for(id, opts \\ [])
show(id, opts \\ [])
show!(id, opts \\ [])
update(id, body, opts \\ [])
update!(id, body, opts \\ [])
versions(ruleset_id, opts \\ [])

Lists versions of a zone ruleset.

Functions

client(opts \\ [])

@spec client(Restlax.Resource.action_options()) :: module()

create(body, opts \\ [])

@spec create(
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) ::
  {:ok, map()} | {:error, term()}

create!(body, opts \\ [])

@spec create!(
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) ::
  map() | no_return()

create_rule(ruleset_id, body, opts \\ [])

Adds a new rule to a zone ruleset.

delete(id, opts \\ [])

@spec delete(id :: term(), opts :: Restlax.Resource.action_options()) ::
  {:ok, map()} | {:error, term()}

delete!(id, opts \\ [])

@spec delete!(id :: term(), opts :: Restlax.Resource.action_options()) ::
  map() | no_return()

index(opts \\ [])

@spec index(opts :: Restlax.Resource.action_options()) ::
  {:ok, map()} | {:error, term()}

index!(opts \\ [])

@spec index!(opts :: Restlax.Resource.action_options()) :: map() | no_return()

path_for(id, opts \\ [])

@spec path_for(term(), [{:action, String.t()}]) :: String.t()

show(id, opts \\ [])

@spec show(id :: term(), opts :: Restlax.Resource.action_options()) ::
  {:ok, map()} | {:error, term()}

show!(id, opts \\ [])

@spec show!(id :: term(), opts :: Restlax.Resource.action_options()) ::
  map() | no_return()

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

@spec update(
  id :: term(),
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) :: {:ok, map()} | {:error, term()}

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

@spec update!(
  id :: term(),
  body :: Restlax.Resource.action_body(),
  opts :: Restlax.Resource.action_options()
) :: map() | no_return()

versions(ruleset_id, opts \\ [])

Lists versions of a zone ruleset.