Create a DoS protection profile

POST /dos-protection-profiles

Create a new DoS protection profile.

Request

application/json

Body

Created

oneOf

folder
snippet
device

folder stringrequired

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

The folder in which the resource is defined

snippet stringrequired

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

The snippet in which the resource is defined

device stringrequired

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

The device in which the resource is defined

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
syn-cookies

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

Responses

Created

Bad Request

application/json

Schema

_errors object[]

Array [

code string

message string

details object

help string

]

_request_id string

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

Input Format Mismatch

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

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

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

Invalid Query Parameter

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

Missing Body

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

Invalid Object

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

Unauthorized

application/json

Schema

_errors object[]

Array [

code string

message string

details object

help string

]

_request_id string

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

Not Authenticated

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

Invalid Credential

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

Key Too Long

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

Key Expired

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

Need Password Change

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

Forbidden

application/json

Schema
Example (from schema)
auth_unauthorized

Schema

_errors object[]

Array [

code string

message string

details object

help string

]

_request_id string

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

Unauthorized

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

Conflict

application/json

Schema
Example (from schema)
object_not_unique
name_not_unique
reference_not_zero

Schema

_errors object[]

Array [

code string

message string

details object

help string

]

_request_id string

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

Object Not Unique

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

Name Not Unique

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

Reference Not Zero

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

General Errors

application/json

Schema

_errors object[]

Array [

code string

message string

details object

help string

]

_request_id string

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

Version Not Supported

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

Method Not Supported

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

Action Not Supported

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

Bad XPath

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

Invalid Command

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

Malformed Command

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

Session Timeout

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

Create a DoS protection profile

/dos-protection-profiles

Request​

Body

Responses​

Request

Responses