List vulnerability protection signatures

GET 
/sse/config/v1/vulnerability-protection-signatures

Retrieve all vulnerability protection profile signature.

Request

Query Parameters

limit number

The maximum number of result objects to return per page.

offset number

The offset of the result entry.

name string

The name of the entry.

folder stringrequired

Possible values: Value must match regular expression ^[0-9a-zA-Z._-\s]{1,}$, [Shared, Mobile Users, Remote Networks, Service Connections, Mobile Users Container, Mobile Users Explicit Proxy]

The folder on which you want to perform this operation.

Responses

200

List of vulnerability-protection signatures

application/json

Schema

Schema

data object[]
Array [
affected_host object
oneOf
client
client boolean
server
server boolean
bugtraq string[]
comment string
Possible values: <= 256 characters
cve string[]
default_action object
oneOf
allow
allow object
alert
alert object
drop
drop object
reset_client
reset_client object
reset_server
reset_server object
reset_both
reset_both object
block_ip
block_ip object
duration integer
Possible values: >= 1 and <= 3600
track_by string
Possible values: [source-and-destination, source]
direction string
Possible values: [client2server, server2client, both]
id string
uuid of the resource
reference string[]
severity string
Possible values: [critical, low, high, medium, informational]
signature object
oneOf
combination
combination object
and_condition object[]
Array [
name string
or_condition object[]
Array [
name string
threat_id string
]
]
order_free boolean
time_attribute object
interval integer
Possible values: >= 1 and <= 3600
threshold integer
Possible values: >= 1 and <= 255
track_by string
Possible values: [source-and-destination, source, destination]
standard
standard object[]
Array [
and_condition object[]
Array [
name string
or_condition object[]
Array [
name string
operator object
equal_to object
context string
negate boolean
qualifier object[]
Array [
name string
value string
]
value integer
Possible values: <= 4294967295
greater_than object
context string
qualifier object[]
Array [
name string
value string
]
value integer
Possible values: <= 4294967295
less_than object
context string
qualifier object[]
Array [
name string
value string
]
value integer
Possible values: <= 4294967295
pattern_match object
context string
negate boolean
pattern string
qualifier object[]
Array [
name string
value string
]
]
]
comment string
Possible values: <= 256 characters
name stringrequired
order_free boolean
scope string
Possible values: [protocol-data-unit, session]
]
threat_id integerrequired
Possible values: >= 41000 and <= 6900000
threat id range <41000-45000> and <6800001-6900000>
threatname stringrequired
Possible values: <= 1024 characters
vendor string[]
]
limit number

Default value: 200

offset number

Default value: 0

total number

Example (from schema)

{
  "data": [
    {
      "affected_host": {
        "client": true
      },
      "bugtraq": [
        "string"
      ],
      "comment": "string",
      "cve": [
        "string"
      ],
      "default_action": {
        "allow": {}
      },
      "direction": "client2server",
      "id": "abcd-1234",
      "reference": [
        "string"
      ],
      "severity": "critical",
      "signature": {
        "combination": {
          "and_condition": [
            {
              "name": "string",
              "or_condition": [
                {
                  "name": "string",
                  "threat_id": "string"
                }
              ]
            }
          ],
          "order_free": false,
          "time_attribute": {
            "interval": 0,
            "threshold": 0,
            "track_by": "source-and-destination"
          }
        }
      },
      "threat_id": 0,
      "threatname": "string",
      "vendor": [
        "string"
      ]
    }
  ],
  "limit": 200,
  "offset": 0,
  "total": 0
}

400

Bad Request

application/json

Schema

Schema

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

Example (from schema)

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

input_format_mismatch

Input Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Input Format Mismatch: input-format=json"
    }
  ],
  "_request_id": "abcd-1234"
}

invalid_query_parameter

Invalid Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Invalid Query Parameter: location=invalid"
    }
  ],
  "_request_id": "abcd-1234"
}

missing_query_parameter

Missing Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Missing Query Parameter: name"
    }
  ],
  "_request_id": "abcd-1234"
}

output_format_mismatch

Output Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Output Format Mismatch: output-format=json Accept=xml"
    }
  ],
  "_request_id": "abcd-1234"
}

401

Unauthorized

application/json

Schema

Schema

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

Example (from schema)

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

auth_not_authenticated

Not Authenticated

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "Not Authenticated"
    }
  ],
  "_request_id": "abcd-1234"
}

invalid_credential

Invalid Credential

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "Invalid Credential"
    }
  ],
  "_request_id": "abcd-1234"
}

key_expired

Key Expired

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "Key Expired"
    }
  ],
  "_request_id": "abcd-1234"
}

key_too_long

Key Too Long

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "Key Too Long"
    }
  ],
  "_request_id": "abcd-1234"
}

need_password_change

Need Password Change

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "The password needs to be changed."
    }
  ],
  "_request_id": "abcd-1234"
}

403

Forbidden

application/json

Schema

Schema

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

Example (from schema)

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

auth_unauthorized

Unauthorized

{
  "_errors": [
    {
      "code": "E007",
      "details": {},
      "message": "Unauthorized"
    }
  ],
  "_request_id": "abcd-1234"
}

404

Not Found

application/json

Schema

Schema

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

Example (from schema)

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

object_not_present

Object Not Present

{
  "_errors": [
    {
      "code": "E005",
      "details": {},
      "message": "Object Not Present"
    }
  ],
  "_request_id": "abcd-1234"
}

default

General Errors

application/json

Schema

Schema

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

Example (from schema)

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

action_not_supported

Action Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "details": {},
      "message": "Action Not Supported: move"
    }
  ],
  "_request_id": "abcd-1234"
}

bad_xpath

Bad XPath

{
  "_errors": [
    {
      "code": "E013",
      "details": {},
      "message": "Bad XPath"
    }
  ],
  "_request_id": "abcd-1234"
}

invalid_command

Invalid Command

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Invalid Command"
    }
  ],
  "_request_id": "abcd-1234"
}

malformed_command

Malformed Command

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Malformed Command"
    }
  ],
  "_request_id": "abcd-1234"
}

method_not_allowed

Method Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "details": {},
      "message": "Method Not Supported"
    }
  ],
  "_request_id": "abcd-1234"
}

session_timeout

Session Timeout

{
  "_errors": [
    {
      "code": 4,
      "details": {},
      "message": "Session Timeout"
    }
  ],
  "_request_id": "abcd-1234"
}

version_not_supported

Version Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "details": {},
      "message": "Version Not Supported"
    }
  ],
  "_request_id": "abcd-1234"
}

Loading...