Cloudflare.AccountRuleset (Cloudflare v0.5.0)

Copy Markdown View Source

Account Rulesets

Create an account ruleset

POST /accounts/{account_id}/rulesets

Creates a ruleset at the account level.

Responses

200

Data is at body["result"]

4XX

List account rulesets

GET /accounts/{account_id}/rulesets

Fetches all rulesets at the account level.

Responses

200

Data is at body["result"]

4XX

Update an account entry point ruleset

PUT /accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint

Updates an account entry point ruleset, creating a new version.

Responses

200

Data is at body["result"]

4XX

Get an account entry point ruleset

GET /accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint

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

Responses

200

Data is at body["result"]

4XX

List an account entry point ruleset's versions

GET /accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions

Fetches the versions of an account entry point ruleset.

Responses

200

Data is at body["result"]

4XX

Get an account entry point ruleset version

GET /accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}

Fetches a specific version of an account entry point ruleset.

Responses

200

Data is at body["result"]

4XX

Update an account ruleset

PUT /accounts/{account_id}/rulesets/{ruleset_id}

Updates an account ruleset, creating a new version.

Responses

200

Data is at body["result"]

4XX

Get an account ruleset

GET /accounts/{account_id}/rulesets/{ruleset_id}

Fetches the latest version of an account ruleset.

Responses

200

Data is at body["result"]

4XX

Delete an account ruleset

DELETE /accounts/{account_id}/rulesets/{ruleset_id}

Deletes all versions of an existing account ruleset.

Responses

204

Data is at body["result"]

4XX

Create an account ruleset rule

POST /accounts/{account_id}/rulesets/{ruleset_id}/rules

Adds a new rule to an account 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 an account ruleset rule

PATCH /accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}

Updates an existing rule in an account ruleset.

Responses

200

Data is at body["result"]

4XX

Delete an account ruleset rule

DELETE /accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}

Deletes an existing rule from an account ruleset.

Responses

200

Data is at body["result"]

4XX

List an account ruleset's versions

GET /accounts/{account_id}/rulesets/{ruleset_id}/versions

Fetches the versions of an account ruleset.

Responses

200

Data is at body["result"]

4XX

Get an account ruleset version

GET /accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}

Fetches a specific version of an account ruleset.

Responses

200

Data is at body["result"]

4XX

Delete an account ruleset version

DELETE /accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}

Deletes an existing version of an account ruleset.

Responses

204

Data is at body["result"]

4XX

List an account ruleset version's rules by tag

GET /accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}/by_tag/{rule_tag}

Fetches the rules of a managed account 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 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 rules in a specific version of a 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 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 rules in a specific version of a ruleset.