Cloudflare.Filter (Cloudflare v0.5.0)

Copy Markdown View Source

Filters

Update filters

PUT /zones/{zone_id}/filters

Updates one or more existing filters.

Responses

200 Update filters response

Data is at body["result"]

[
  {
    "description": "*string*",
    "expression": "*string*",
    "id": "*string*",
    "paused": "*boolean*",
    "ref": "*string*"
  }
]
4XX Update filters response failure
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "result_info": {
    "count": "*number*",
    "page": "*number*",
    "per_page": "*number*",
    "total_count": "*number*"
  },
  "success": "*boolean*"
}

Create filters

POST /zones/{zone_id}/filters

Creates one or more filters.

Responses

200 Create filters response

Data is at body["result"]

[
  {
    "description": "*string*",
    "expression": "*string*",
    "id": "*string*",
    "paused": "*boolean*",
    "ref": "*string*"
  }
]
4XX Create filters response failure
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "result_info": {
    "count": "*number*",
    "page": "*number*",
    "per_page": "*number*",
    "total_count": "*number*"
  },
  "success": "*boolean*"
}

List filters

GET /zones/{zone_id}/filters

Fetches filters in a zone. You can filter the results using several optional parameters.

Responses

200 List filters response

Data is at body["result"]

[
  {
    "description": "*string*",
    "expression": "*string*",
    "id": "*string*",
    "paused": "*boolean*",
    "ref": "*string*"
  }
]
4XX List filters response failure
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "result_info": {
    "count": "*number*",
    "page": "*number*",
    "per_page": "*number*",
    "total_count": "*number*"
  },
  "success": "*boolean*"
}

Delete filters

DELETE /zones/{zone_id}/filters

Deletes one or more existing filters.

Responses

200 Delete filters response

Data is at body["result"]

[
  {
    "id": "*string*"
  }
]
4XX Delete filters response failure
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "result_info": {
    "count": "*number*",
    "page": "*number*",
    "per_page": "*number*",
    "total_count": "*number*"
  },
  "success": "*boolean*"
}

Update a filter

PUT /zones/{zone_id}/filters/{filter_id}

Updates an existing filter.

Responses

200 Update a filter response

Data is at body["result"]

{
  "description": "*string*",
  "expression": "*string*",
  "id": "*string*",
  "paused": "*boolean*",
  "ref": "*string*"
}
4XX Update a filter response failure
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Get a filter

GET /zones/{zone_id}/filters/{filter_id}

Fetches the details of a filter.

Responses

200 Get a filter response

Data is at body["result"]

{
  "description": "*string*",
  "expression": "*string*",
  "id": "*string*",
  "paused": "*boolean*",
  "ref": "*string*"
}
4XX Get a filter response failure
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Delete a filter

DELETE /zones/{zone_id}/filters/{filter_id}

Deletes an existing filter.

Responses

200 Delete a filter response

Data is at body["result"]

{
  "id": "*string*"
}
4XX Delete a filter response failure
{
  "errors": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "messages": [
    {
      "code": "*integer*",
      "message": "*string*"
    }
  ],
  "result": {},
  "success": "*boolean*"
}

Summary

Functions

bulk_delete(body, opts \\ [])

Bulk-deletes multiple filters (DELETE collection with body).

bulk_update(body, opts \\ [])

Bulk-updates multiple filters (PUT collection).

client(opts \\ [])
create(body, opts \\ [])
create!(body, opts \\ [])
delete(id, opts \\ [])
delete!(id, opts \\ [])
index(opts \\ [])

Lists all filters in a zone.

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

Functions

bulk_delete(body, opts \\ [])

Bulk-deletes multiple filters (DELETE collection with body).

bulk_update(body, opts \\ [])

Bulk-updates multiple filters (PUT collection).

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()

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 \\ [])

Lists all filters in a zone.

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()