Get a DoS protection profile

GET 
/dos-protection-profiles/:id

Get an existing DoS protection profile.

Request

Path Parameters

id uuidrequired

The UUID of the configuration resource

Responses

200

OK

application/json

Schema

Schema

oneOf

folder

folder stringrequired

Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z\d-_\. ]+$

The folder in which the resource is defined

snippet

snippet stringrequired

Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z\d-_\. ]+$

The snippet in which the resource is defined

device

device stringrequired

Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z\d-_\. ]+$

The device in which the resource is defined

id string

The UUID of the DNS security profile

name stringrequired

Possible values: <= 31 characters

Profile name

type stringrequired

Possible values: [aggregate, classified]

Type

description string

Possible values: <= 255 characters

Description

flood object

tcp-syn object

oneOf

red

red object

alarm-rate integerrequired

Possible values: <= 2000000

Default value: 10000

Connection rate (cps) to generate alarm

activate-rate integerrequired

Possible values: >= 1 and <= 2000000

Default value: 10000

Connection rate (cps) to start RED

maximal-rate integerrequired

Possible values: >= 1 and <= 2000000

Default value: 40000

Maximal connection rate (cps) allowed

block object

duration integer

Possible values: >= 1 and <= 21600

Default value: 300

syn-cookies

syn-cookies objectrequired

alarm-rate integerrequired

Possible values: <= 2000000

Default value: 10000

Connection rate (cps) to generate alarm

activate-rate integerrequired

Possible values: <= 2000000

Default value: 0

Connection rate (cps) to activate SYN cookies proxy

maximal-rate integerrequired

Possible values: >= 1 and <= 2000000

Default value: 1000000

Maximum connection rate (cps) allowed

block block

duration integer

Possible values: >= 1 and <= 21600

Default value: 300

udp object

enable boolean

red object

alarm-rate integerrequired

Possible values: <= 2000000

Default value: 10000

Connection rate (cps) to generate alarm

activate-rate integerrequired

Possible values: >= 1 and <= 2000000

Default value: 10000

Connection rate (cps) to start RED

maximal-rate integerrequired

Possible values: >= 1 and <= 2000000

Default value: 40000

Maximal connection rate (cps) allowed

block object

duration integer

Possible values: >= 1 and <= 21600

Default value: 300

icmp object

enable boolean

red object

alarm-rate integerrequired

Possible values: <= 2000000

Default value: 10000

Connection rate (cps) to generate alarm

activate-rate integerrequired

Possible values: >= 1 and <= 2000000

Default value: 10000

Connection rate (cps) to start RED

maximal-rate integerrequired

Possible values: >= 1 and <= 2000000

Default value: 40000

Maximal connection rate (cps) allowed

block object

duration integer

Possible values: >= 1 and <= 21600

Default value: 300

icmpv6 object

enable boolean

red object

alarm-rate integerrequired

Possible values: <= 2000000

Default value: 10000

Connection rate (cps) to generate alarm

activate-rate integerrequired

Possible values: >= 1 and <= 2000000

Default value: 10000

Connection rate (cps) to start RED

maximal-rate integerrequired

Possible values: >= 1 and <= 2000000

Default value: 40000

Maximal connection rate (cps) allowed

block object

duration integer

Possible values: >= 1 and <= 21600

Default value: 300

other-ip object

enable boolean

red object

alarm-rate integerrequired

Possible values: <= 2000000

Default value: 10000

Connection rate (cps) to generate alarm

activate-rate integerrequired

Possible values: >= 1 and <= 2000000

Default value: 10000

Connection rate (cps) to start RED

maximal-rate integerrequired

Possible values: >= 1 and <= 2000000

Default value: 40000

Maximal connection rate (cps) allowed

block object

duration integer

Possible values: >= 1 and <= 21600

Default value: 300

resource object

sessions object

enabled boolean

max-concurrent-limit integer

Possible values: >= 1 and <= 4194304

Default value: 32768

Example (from schema)

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "name": "string",
  "type": "aggregate",
  "description": "string",
  "flood": {
    "udp": {
      "enable": false,
      "red": {
        "alarm-rate": 10000,
        "activate-rate": 10000,
        "maximal-rate": 40000,
        "block": {
          "duration": 300
        }
      }
    },
    "icmp": {
      "enable": false,
      "red": {
        "alarm-rate": 10000,
        "activate-rate": 10000,
        "maximal-rate": 40000,
        "block": {
          "duration": 300
        }
      }
    },
    "icmpv6": {
      "enable": false,
      "red": {
        "alarm-rate": 10000,
        "activate-rate": 10000,
        "maximal-rate": 40000,
        "block": {
          "duration": 300
        }
      }
    },
    "other-ip": {
      "enable": false,
      "red": {
        "alarm-rate": 10000,
        "activate-rate": 10000,
        "maximal-rate": 40000,
        "block": {
          "duration": 300
        }
      }
    }
  },
  "resource": {
    "sessions": {
      "enabled": false,
      "max-concurrent-limit": 32768
    }
  }
}

400

Bad Request

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

input_format_mismatch

Input Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "message": "Input Format Mismatch: input-format=json",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

output_format_mismatch

Output Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "message": "Output Format Mismatch: output-format=json Accept=xml",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

missing_query_parameter

Missing Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "message": "Missing Query Parameter: name",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_query_parameter

Invalid Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Query Parameter: location=invalid",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

401

Unauthorized

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

auth_not_authenticated

Not Authenticated

{
  "_errors": [
    {
      "code": "E016",
      "message": "Not Authenticated",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_credential

Invalid Credential

{
  "_errors": [
    {
      "code": "E016",
      "message": "Invalid Credential",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

key_too_long

Key Too Long

{
  "_errors": [
    {
      "code": "E016",
      "message": "Key Too Long",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

key_expired

Key Expired

{
  "_errors": [
    {
      "code": "E016",
      "message": "Key Expired",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

need_password_change

Need Password Change

{
  "_errors": [
    {
      "code": "E016",
      "message": "The password needs to be changed.",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

403

Forbidden

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

auth_unauthorized

Unauthorized

{
  "_errors": [
    {
      "code": "E007",
      "message": "Unauthorized",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

404

Not Found

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

object_not_present

Object Not Present

{
  "_errors": [
    {
      "code": "E005",
      "message": "Object Not Present",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

default

General Errors

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

version_not_supported

Version Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Version Not Supported",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

method_not_allowed

Method Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Method Not Supported",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

action_not_supported

Action Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Action Not Supported: move",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

bad_xpath

Bad XPath

{
  "_errors": [
    {
      "code": "E013",
      "message": "Bad XPath",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_command

Invalid Command

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Command",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

malformed_command

Malformed Command

{
  "_errors": [
    {
      "code": "E003",
      "message": "Malformed Command",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

session_timeout

Session Timeout

{
  "_errors": [
    {
      "code": "4",
      "message": "Session Timeout",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Loading...