Get SYN Protection rule.

client.DDoSProtection.AdvancedTCPProtection.SynProtection.Rules.Items.Get(ctx, ruleID, query) (*AdvancedTCPProtectionSynProtectionRuleItemGetResponse, error)

GET/accounts/{account_id}/magic/advanced_tcp_protection/configs/syn_protection/rules/{rule_id}

Get a SYN Protection rule specified by the given UUID.

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

ruleID string

UUID.

maxLength36

query AdvancedTCPProtectionSynProtectionRuleItemGetParams

AccountID param.Field[string]

Identifier.

maxLength32

ReturnsExpand Collapse

type AdvancedTCPProtectionSynProtectionRuleItemGetResponse struct{…}

ID string

The unique ID of the SYN Protection rule.

BurstSensitivity string

The burst sensitivity. Must be one of ‘low’, ‘medium’, ‘high’.

CreatedOn Time

The creation timestamp of the SYN Protection rule.

formatdate-time

MitigationType string

The type of mitigation for SYN Protection. Must be one of ‘challenge’ or ‘retransmit’.

Mode string

The mode for SYN Protection. Must be one of ‘enabled’, ‘disabled’, ‘monitoring’.

ModifiedOn Time

The last modification timestamp of the SYN Protection rule.

formatdate-time

Name string

The name of the SYN Protection rule. Value is relative to the ‘scope’ setting. For ‘global’ scope, name should be ‘global’. For either the ‘region’ or ‘datacenter’ scope, name should be the actual name of the region or datacenter, e.g., ‘wnam’ or ‘lax’.

RateSensitivity string

The rate sensitivity. Must be one of ‘low’, ‘medium’, ‘high’.

Scope string

The scope for the SYN Protection rule. Must be one of ‘global’, ‘region’, or ‘datacenter’.

Get SYN Protection rule.

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"),
  )
  item, err := client.DDoSProtection.AdvancedTCPProtection.SynProtection.Rules.Items.Get(
    context.TODO(),
    "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    ddos_protection.AdvancedTCPProtectionSynProtectionRuleItemGetParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", item.ID)
}

{
  "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",
    "burst_sensitivity": "burst_sensitivity",
    "created_on": "2019-12-27T18:11:19.117Z",
    "mitigation_type": "mitigation_type",
    "mode": "mode",
    "modified_on": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "rate_sensitivity": "rate_sensitivity",
    "scope": "scope"
  }
}

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",
    "burst_sensitivity": "burst_sensitivity",
    "created_on": "2019-12-27T18:11:19.117Z",
    "mitigation_type": "mitigation_type",
    "mode": "mode",
    "modified_on": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "rate_sensitivity": "rate_sensitivity",
    "scope": "scope"
  }
}