Skip to content
Start here

List all TCP Flow Protection filters.

client.DDoSProtection.AdvancedTCPProtection.TCPFlowProtection.Filters.List(ctx, params) (*V4PagePaginationArray[AdvancedTCPProtectionTCPFlowProtectionFilterListResponse], error)
GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/tcp_flow_protection/filters

List all TCP Flow Protection filters for an account.

Security
API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
Accepted Permissions (at least one required)
DDoS Protection WriteDDoS Protection Read
ParametersExpand Collapse
params AdvancedTCPProtectionTCPFlowProtectionFilterListParams
AccountID param.Field[string]

Path param: Identifier.

maxLength32
Direction param.Field[string]Optional

Query param: The direction of ordering (ASC or DESC). Defaults to ‘ASC’.

Mode param.Field[string]Optional

Query param: The mode of the filters to get. Optional. Valid values: ‘enabled’, ‘disabled’, ‘monitoring’.

Order param.Field[string]Optional

Query param: The field to order by. Defaults to ‘prefix’.

Page param.Field[int64]Optional

Query param: The page number for pagination. Defaults to 1.

formatint64
PerPage param.Field[int64]Optional

Query param: The number of items per page. Must be between 10 and 1000. Defaults to 25.

formatint64
ReturnsExpand Collapse
type AdvancedTCPProtectionTCPFlowProtectionFilterListResponse struct{…}
ID string

The unique ID of the expression filter.

CreatedOn Time

The creation timestamp of the expression filter.

formatdate-time
Expression string

The filter expression.

Mode string

The filter’s mode. Must be one of ‘enabled’, ‘disabled’, ‘monitoring’.

ModifiedOn Time

The last modification timestamp of the expression filter.

formatdate-time

List all TCP Flow Protection filters.

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/ddos_protection"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  page, err := client.DDoSProtection.AdvancedTCPProtection.TCPFlowProtection.Filters.List(context.TODO(), ddos_protection.AdvancedTCPProtectionTCPFlowProtectionFilterListParams{
    AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "id",
      "created_on": "2019-12-27T18:11:19.117Z",
      "expression": "ip.dst in { 192.0.2.0/24 198.51.100.0/24 } and tcp.srcport in { 80 443 10000..65535 }",
      "mode": "mode",
      "modified_on": "2019-12-27T18:11:19.117Z"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}
Returns Examples
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "id",
      "created_on": "2019-12-27T18:11:19.117Z",
      "expression": "ip.dst in { 192.0.2.0/24 198.51.100.0/24 } and tcp.srcport in { 80 443 10000..65535 }",
      "mode": "mode",
      "modified_on": "2019-12-27T18:11:19.117Z"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}