Overview

This reference guide provides a description of the APSolute Vision REST API for software version 3.40, December 2015.

Version information

Version: 1.0

URI scheme

Schemes: HTTPS

Services

APM-Aggregations

Get Aggregation List

GET /mgmt/monitor/apm/aggregation
Parameters
Type Name Description Required Schema Default

QueryParameter

startTime

Linux epoch time UTC, in milliseconds.

true

string

QueryParameter

endTime

Linux epoch time UTC, in milliseconds.

true

string

QueryParameter

sliceSize

Resolution of the returned aggregation slices, out of SPS_1M, SPS_5M, and SPS_3H - for, one minute, five minutes, and three hours, respectively. If not specified, the server chooses the appropriate slice size.

false

string

QueryParameter

groupBy

Comma-delimited list of groupings to perform on data, including location, area, transaction, application, and date.

false

string

date

QueryParameter

desktop

Values: true - Returns end user data. false - Returns datacenter data.

false

string

false

QueryParameter

retrieveStdDev

Values: true - Calculates the standard deviation of the data slices of end-user data. false - Calculates the standard deviation of the data-center data.

false

string

false

QueryParameter

applicationNames

Comma-delimited list of applications to filter.

false

string

QueryParameter

withSla

Values true - Returns data with defined SLA only. false - Returns all data.

false

string

QueryParameter

limit

Number of aggregation slices to return. Values: 0 - 9999999

false

integer (int32)

QueryParameter

props

Comma-delimited list of data properties to return in slices. The following fields are always returned: aggDate, volume . The rest of the fields are filterable. If props is set to null, empty, or not provided, all data fields provided.

false

string

Responses
HTTP Code Description Schema

200

success

SlaWatchListWrapper

401

Not logged in

No Content

APM-Applications

Get Application List

GET /mgmt/system/config/apm/application
Parameters
Type Name Description Required Schema Default

QueryParameter

id

Requests an application ID (for a specific application).

false

integer (int32)

QueryParameter

name

Requests an application name (for a subset of applications).

false

string

QueryParameter

description

Requests an application description (for a specific application).

false

string

QueryParameter

order

Sort by field name (description\name + asc\desc).

false

string

QueryParameter

limit

Maximum number of records to display.

false

integer (int32)

QueryParameter

offset

Offset of records to start from.

false

integer (int32)

QueryParameter

props

Comma-delimited list of properties to return. The following fields always are returned: id, name. Refer to the ApplicationsList class for fields.

false

string

Responses
HTTP Code Description Schema

200

success

ApplicationsList

401

Not logged in

No Content

APM-ConfiguredAlerts

Get Alert Configuration List

GET /mgmt/system/config/apm/alert/sla
Parameters
Type Name Description Required Schema Default

QueryParameter

limit

Maximum number of records to display.

false

integer (int32)

QueryParameter

props

Comma-delimited list of fields to return. The following fields are always returned: id, alertTypeName, enabled, timeframe, parentName, statusName.

false

integer (int32)

Responses
HTTP Code Description Schema

200

success

ThresholdAlertList

401

Not logged in

No Content

APM-RawEventDetails

Get Raw Event Details

GET /mgmt/monitor/apm/rawEventDetails?id={id}
Parameters
Type Name Description Required Schema Default

QueryParameter

id

Request event ID.

true

string

Responses
HTTP Code Description Schema

200

success

EventDetails

401

Not logged in

No Content

APM-TriggeredAlerts

Get Triggered Alerts

GET /mgmt/monitor/apm/alert/triggered
Parameters
Type Name Description Required Schema Default

QueryParameter

limit

Maximum number of records to display.

false

integer (int32)

QueryParameter

props

Comma-delimited list of fields to return. The following fields always are returned: id alertTypeName enabled timeframe parentName statusName

false

string

QueryParameter

startTime

Linux epoch time, in milliseconds.

true

string

QueryParameter

endTime

Linux epoch time, in milliseconds.

true

string

QueryParameter

arr_app_id

Comma-delimited list of application IDs.

false

string

QueryParameter

alertStatus

Comma-delimited list of statuses. Values: OK, WARNING, ERROR

false

string

QueryParameter

alertType

Comma-delimited list of statuses. Values: SLA, SYS_HEALTH, APP_HEALTH

false

string

Responses
HTTP Code Description Schema

200

success

TriggeredAlertList

401

Not logged in

No Content

General-DefenseFlow

Upload File to DefenseFlow

POST /mgmt/device/df/config/sendtodevice
Description

Sends a file to the DefenseFlow device.

Query parameter:
"type" - the file type. The supported type is "Configuration".
Body parameter: The file content as octal stream.
The following is an example of a request sending a file to the DefenseFlow device:

Path: https://Vision IP/mgmt/device/df/config/sendtodevice?type=Configuration
The request body is in the following format:

Content-Disposition: form-data; name="Filedata"; filename="dfconfig.txt"
Content-Type: application/octet-stream

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

MultipartFormDataInput

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

BodyParameter

multipartFormDataInput

The file input stream and the form parameters.

true

string

Responses
HTTP Code Description Schema

200

On success, the response is a JSON in the following format:
{ "status" : "ok" }

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • multipart/form-data

Produces
  • text/plain

  • application/json

Download File from DefenseFlow

GET /mgmt/device/df/config/getfromdevice
Description

Downloads a file from a DefenseFlow device to the local OS, or to APSolute Vision server.

Query parameters:
"saveToDb" - Possible values are "true" or "false". The default is "false".
"type" - The file type. The supported type is "Configuration".

Parameters
Type Name Description Required Schema Default

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

Responses
HTTP Code Description Schema

200

On success, when "saveToDb" value is "true", the response is a JSON in the following format
{
"status": "OK",
"message": "Message Text"
}
Otherwise, the response is an application/octet-stream containing the file as an attachment.

No Content

500

On failure the response is a JSON in the following format
{
"status": "error",
"message": "Message Text"
}

No Content

Produces
  • application/octet-stream

  • application/json

Update DefenseFlow Device Scalar

PUT /mgmt/device/df/config
Description

Updates the variable values on the DefenseFlow device.
Error conditions:

If the wrong variable values are specified in the JSON body; the APSolute Vision server returns the error from a device.

The following is an example of a request updating the variable value for the license on the device:

Path: https://Vision IP/mgmt/device/df/config
The request JSON is in the following format:
{
"license": "adc-123-bwm"}

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

string

HeaderParameter

headers

Original request HTTP headers.

true

ref

PathParameter

uriInfo

Request URI.

true

ref

BodyParameter

requestBody

Request JSON.

true

string

Responses
HTTP Code Description Schema

200

On success, the response is a JSON in the following format:
{ "status" : "ok" }

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • application/json

Produces
  • application/json

Edit DefenseFlow Table Row

PUT /mgmt/device/df/config/{tableName}/{indexes : .+}
Description

Updates a row of a DefenseFlow device table.
Use cases:

If the wrong column data are specified in the JSON body, the APSolute Vision server returns a device error message.
If the path parameter is not provided, the HTTP 500 error code is returned with the error message.

The following is an example of a request adding a row with index "Test", specified in the path parameter, to the "Security Templates" table:

Path: https://Vision IP/mgmt/device/df/config/SecurityTemplates/Test/,
The request JSON is in the following format:
{
"name": "Test"
"description": "Test Only"
"origin": "PROTECTED_OBJECT"
"policyPO": "PF001"
},

The following is an example of a request adding a row with the index "Test Strategy", specified in the path parameters, to the "Operation Strategies" table:

Path: https://Vision IP/mgmt/device/df/config/OperationStrategies/Test%20Strategy/,

The request JSON is in the following format:
{"ceCollector": "None"
"ceDetector": "None"
"collection-group": "None"
"description": "Test Strategy"
"detector-type": "3rdPartyDetector"
"diversion-group": "Tier1"
"dp-group": "All"
"dp-select": "Select all"
"name": "Test Strategy"
"route-reflectors": "Disabled"
}

The following is an example of a request adding a row with the index "ProtectedObjectTest", specified in the path parameters, to the "Protected Object" table:

Path: https://Vision IP/mgmt/device/df/config/ProtectedObjects/ProtectedObjectTest/,

The request JSON is in the following format:
{"status": "Enabled"
"name": "ProtectedObjectTest"
"divert": "Enabled"
"mitigate": "Enabled"
"inject": "Enabled"
"mode": "Automatic"
"template": "Test"
"peak": "22222"
"strategy": "PF2"
"network": [
{"network": "1.1.1.1"
"vlan": "Basic"
"ne": "Tier1"
"prefix": "32"
"rsNewWhiteListSynModuleTwo": "1"}
]
}

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

string

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

PathParameter

tableName

The name of the table to retrieve from the device.

true

string

QueryParameter

props

The columns of the table to retrieve from the device.

true

string

PathParameter

indexes

The table index values according to the order defined in the MIB file.

true

string

BodyParameter

requestBody

The request JSON.

true

string

Responses
HTTP Code Description Schema

200

On success, the response is a JSON in the following format:
{ "status" : "ok" }

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • application/json

Get DefenseFlow Table Row

GET /mgmt/device/df/config/{tableName}/{indexes : .+}
Description

Retrieves a row from the DefenseFlow device table according to the provided index.
The query parameter:
"props" is an optional parameter specifying a list of column names, separated by commas.

Use cases:

If the "props" query parameter is not provided, all columns of the row are returned.
When a table does not contain the row with the specified index, an empty JSON is returned.
If the path parameter is not provided, the HTTP 500 error code is returned with the error message.

The following is an example of a request retrieving the row by index "Test Stragegy" from the "Operation Strategies" table:

Path: https://Vision IP/mgmt/device/df/config/OperationStrategies/Test%20Stragegy?props=name,description,detector-type,ceDetector,
ceCollector,collection-group,route-reflectors,diversion-group,dp-group,dp-select

The following is an example of a request retrieving the row by index "ProtectedObjectTest" from the "Protected Objects" table:

Path: https://Vision IP/mgmt/device/df/config/ProtectedObjects/ProtectedObjectTest?props=status,name,description,action,divert,
mitigate,inject,mode,network,template,policyName,policy,peak,strategy,useManual,tcpTHActiveKbps,tcpTHActivePps,tcpTHTermKbps,
tcpTHTermPps,udpTHActiveKbps,udpTHActivePps,udpTHTermKbps,udpTHTermPps,icmpTHActiveKbps,icmpTHActivePps,icmpTHTermKbps,icmpTHTermPps,
otherTHActiveKbps,otherTHActivePps,otherTHTermKbps,otherTHTermPps,totalTHActiveKbps,totalTHActivePps,totalTHTermKbps,totalTHTermPps

Parameters
Type Name Description Required Schema Default

QueryParameter

prop

false

string

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

PathParameter

tableName

The name of the table to retrieve from the device.

true

string

PathParameter

indexes

The table index values according to the order defined in the MIB file.

true

string

QueryParameter

props

The columns of the table to retrieve from the device.

true

string

Responses
HTTP Code Description Schema

200

success

TableDto array

500

On failure, the response is a JSON in the following format:
{
"status": "error",
"message": "Message Text…​"
}

No Content

Produces
  • application/json

Add DefenseFlow Table Row

POST /mgmt/device/df/config/{tableName}/{indexes : .+}
Description

Adds a row to a DefenseFlow device table.
Use cases:

If the wrong columns data is specified in the JSON body, the APSolute Vision server returns a device error message.
If the path parameter is not provided, the HTTP 500 error code is returned with the error message.

The following is an example of a request adding a row with index "Test" (specified in the path parameter) to the "Security Templates" table:

Path: https://Vision IP/mgmt/device/df/config/SecurityTemplates/Test/,
The request JSON is in the following format:
{
"name": "Test"
"description": "Test Only"
"origin": "PROTECTED_OBJECT"
"policyPO": "PF001"
}

The following is an example of a request adding a row with the index "Test Strategy", specified in the path parameters, to the "Operation Strategies" table:

Path: https://Vision IP/mgmt/device/df/config/OperationStrategies/Test%20Strategy/,

The request JSON is in the following format:
{"ceCollector": "None"
"ceDetector": "None"
"collection-group": "None"
"description": "Test Strategy"
"detector-type": "3rdPartyDetector"
"diversion-group": "Tier1"
"dp-group": "All"
"dp-select": "Select all"
"name": "Test Strategy"
"route-reflectors": "Disabled"
}

The following is an example of a request adding a row with the index "ProtectedObjectTest", specified in the path parameters, to the "Protected Object" table:

Path: https://Vision IP/mgmt/device/df/config/ProtectedObjects/ProtectedObjectTest/,

The request JSON is in the following format:
{"status": "Enabled"
"name": "ProtectedObjectTest"
"divert": "Enabled"
"mitigate": "Enabled"
"inject": "Enabled"
"mode": "Automatic"
"template": "Test"
"peak": "22222"
"strategy": "PF2"
"network": [
{"network": "1.1.1.1"
"vlan": "Basic"
"ne": "Tier1"
"prefix": "32"
"rsNewWhiteListSynModuleTwo": "1"}
]
}

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

string

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

PathParameter

tableName

The name of the table.

true

string

PathParameter

indexes

The table index values according to the order defined in the MIB file.

true

string

BodyParameter

requestBody

The request JSON.

true

string

Responses
HTTP Code Description Schema

200

On success, the response is a JSON in the following format:
{ "status" : "ok" }

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • application/json

Produces
  • application/json

Delete DefenseFlow Table Row

DELETE /mgmt/device/df/config/{tableName}/{indexes : .+}
Description

Deletes a row from the DefenseFlow device table according to the provided index.
Error conditions:

If the table does not contain the row with the specified index, an empty JSON is returned.
If the path parameter is not provided, the HTTP 500 error code is returned with the error message.

The following is an example of a request deleting the row by index "Test Stragegy" from the "Operation Strategies" table:

Path: https://Vision IP/mgmt/device/df/config/OperationStrategies/Test%20Stragegy/

The following is an example of a request retrieving the row by index "ProtectedObjectTest" from the "Protected Objects" table:

Path: https://Vision IP/mgmt/device/df/config/ProtectedObjects/ProtectedObjectTest/

Parameters
Type Name Description Required Schema Default

HeaderParameter

headers

Original request HTTP headers.

true

ref

PathParameter

uriInfo

Request URI.

true

ref

PathParameter

tableName

Name of the device table.

true

string

PathParameter

indexes

Table index values.

true

string

Responses
HTTP Code Description Schema

200

On success, the response is a JSON in the following format:
{ "status" : "ok" }

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Produces
  • application/json

Get DefenseFlow Table

GET /mgmt/device/df/config/{tableName}
Description

Retrieves the table content from a DefenseFlow device.
Query parameters:
"offset" - The index in the table from which to start retrieving. When this optional parameter is not specified, the table is retrieved starting from the first row.
"count" - Optional parameter specifying the maximum number of rows to retrieve.
"props" - Optional parameter specifying a list of columns to retrieve, separated by commas.

Use cases:

If no query parameters are provided, the whole table is returned. The maximum number of retrieved rows is according to limitations of the REST protocol.
If the path parameter is not provided, the HTTP 500 error code is returned with the error message.
When a table does not contain any rows, an empty JSON is returned.

The following is an example of a request retrieving the first 50 rows of the "Protected Objects" table:

Path: https://Vision IP/mgmt/device/df/config/ProtectedObjects?props=status,name,description,action,template,policyName,peak,strategy

The following is an example of a request retrieving the first 50 rows of the "Operation Strategies" table:

Path: https://Vision IP/gmt/device/df/config/OperationStrategies?props=name,description,detector-type,
"+collection-group,route-reflectors,diversion-group,dp-group

Parameters
Type Name Description Required Schema Default

QueryParameter

prop

false

string

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

PathParameter

tableName

The name of the table to retrieve from the device.

true

string

QueryParameter

props

The columns of the table to retrieve from the device.

true

string

Responses
HTTP Code Description Schema

200

success

TableDto array

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Produces
  • application/json

General-DeviceByIpConfig

Delete Network Protection Policy

POST /mgmt/device/byip/{deviceIp}/config/deletenetworktemplate
Description

Deletes the Network Protection policy configuration from the DefensePro device.
Error case:

If the network protection was added but the Update Policies operation was not performed on the DefensePro device, the APSolute Vision server returns a device error message:

Configuration template delete failed due to validation error. Delete of server failed. The name of the sever is invalid.

The following is an example of a request deleting the Network Protection configuration template from a DefensePro device:

Path: https://Vision IP/mgmt/device/byip/10.205.193.120/config/deletenetworktemplate?PolicyName=test3&UpdatePolices=on

Parameters
Type Name Description Required Schema Default

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

PathParameter

deviceIp

The IP address of the managed device.

true

string

Responses
HTTP Code Description Schema

200

On success, the response is a JSON in the following format:
{ "status" : "ok" }

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Produces
  • application/octet-stream

  • application/json

Get Device Configuration File

GET /mgmt/device/byip/{deviceIp}/config/getcfg
Description

Retrieves the device configuration file to the client computer or to the APSolute Vision server.

Query parameters:
saveToDb - Possible values are "true" or "false". The default is "false".
includePrivateKeys - Possible values are "true" or "false". The default is "false".
passphrase - The password for the private keys encryption. Relevant for "includePrivateKeys" value "true" only.

Parameters
Type Name Description Required Schema Default

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

PathParameter

deviceIp

The IP address of the managed device.

true

ref

Responses
HTTP Code Description Schema

200

On success, when "saveToDb" value is "true", the response is a JSON in the following format
{
"status": "OK",
"message": "Message Text"
}
Otherwise, the response is an application/octet-stream containing the file as an attachment.

No Content

500

On failure the response is a JSON in the following format
{
"status": "error",
"message": "Message Text"
}

No Content

Produces
  • application/octet-stream

  • application/json

Export Network Policy from Device

GET /mgmt/device/byip/{deviceIp}/config/getnetworktemplate
Description

Error case:

If the Network Protection policy was created but the Update Policies operation was not yet performed on the DefensePro device, an error message is returned:

Configuration template import failed due to validation error. Import of network failed. The name of the network is invalid.

The following is an example of a request to export a network protection configuration template from the DefensePro device to the APSolute Vision database:

Path: https://Vision IP/mgmt/device/byip/Device IP/config/getnetworktemplate?PolicyName=guy&ExportConfiguration=on&ExportBaselineDNS=on&ExportBaselineBDoS=on&saveToDb=true&fileName=172.16.22.20_guy_2015.11.17_16.48.53

Query parameterse:

PolicyName - The name of the Network Protection policy.
ExportConfiguration - Flag to indicate whether to export the configuration. Possible values: on / off.
ExportBaselineDNS - Flag to indicate whether to export the DNS baseline. Possible values: on / off.
ExportBaselineBDoS - Flag to indicate whether to export the BDoS baseline. Possible values: on / off.
saveToDb - Flag to indicate whether to save the template to the APSolute Vision database, or to the local OS. Possible values: true / false. Use "true" to store the file in the APSolute Vision database. Use "false" to store it on the local OS.
fileName - The name of the file to be stored in APSolute Vision database. Additionally this name can be used for importing or deleting the configuration template from the device.

Parameters
Type Name Description Required Schema Default

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

PathParameter

deviceIp

The IP address of the managed device.

true

string

Responses
HTTP Code Description Schema

200

On success, the response is a JSON in the following format:
{ "status" : "ok" }

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Produces
  • application/octet-stream

  • application/json

Get Device Table

GET /mgmt/device/byip/{deviceIp}/config/{tableName}
Description

Retrieves the table content from the device.
Query parameters:
"offset" - The index in the table to start retrieving from. When this optional parameter is not specified, the table from the beginning is returned.
"count" - Optional parameter specifying a maximum number of rows to retrieve.
"props" - Optional parameter specifying a list of columns, separated by commas.

Use cases:

If query parameters are not provided, the whole table is returned (with device limitations for the maximum rows that can be returned in REST)
If the path parameter is not provided, the HTTP 500 error code is returned with the error message.
When a table does not contain rows, the empty JSON is returned.

The following is an example of a request retrieving the first 50 rows from the "Network Protection Policies" table:

Path: https://Vision IP/mgmt/device/byip/{Device IP}/config/rsIDSNewRulesTable?offset=SGNS-Global-2&count=50&props=rsIDSNewRulesName,rsIDSNewRulesState,rsIDSNewRulesSource,rsIDSNewRulesDestination,rsIDSNewRulesPortmask,
rsIDSNewRulesDirection,Vlan_MPLSRD_TagGroup,rsIDSNewRulesVlanTagGroup,rsIDSNewRulesMPLSRDGroup,Profiles,
rsIDSNewRulesProfileNetflood,rsIDSNewRulesProfileDNS,rsIDSNewRulesProfileScanning,rsIDSNewRulesProfileStateful,
rsIDSNewRulesProfileAppsec,rsIDSNewRulesProfileConlmt,rsIDSNewRulesProfileSynprotection,rsIDSNewRulesProfilePPS,
rsIDSQuarantineStatusInPolicy,rsIDSNewRulesAction,rsIDSNewRulesPacketReportingStatus,rsIDSNewRulesPacketReportingEnforcement,
rsIDSNewRulesPacketTraceStatus,rsIDSNewRulesPacketTraceEnforcement,

The following is an example of a request retrieving the first 50 rows from the "Server Protection Policies" table:

Path: https://Vision IP/mgmt/device/byip/{Device IP}/config/rsIDSServerTable?count=50&props=rsIDSServerName,rsIDSServerIPRange,
rsIDSServerState,rsIDSServerHTTPProfile,rsIDSServerIPSProfile,rsIDSServerVlanTagGroup,rsIDSServerPacketReportStatus,
rsIDSServerPacketReportEnforcement,rsIDSServerPacketTraceStatus,rsIDSServerPacketTraceEnforcement

Parameters
Type Name Description Required Schema Default

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

deviceIp

The IP address of the managed device.

true

string

PathParameter

tableName

The name of the device table.

true

string

Responses
HTTP Code Description Schema

200

success

TableDto array

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Produces
  • application/json

Delete Server Protection Policy

POST /mgmt/device/byip/{deviceIp}/config/deleteservertemplate
Description

Deletes the Server Protection Configuration Template from the DefensePro device.
Use cases:

If the policy was added but the Update Policies operation was not performed on the DefensePro device. The APSolute Vision server returns the error from a device:

Configuration template delete failed due to validation error. Delete of server failed. The name of the sever is invalid.

The following is an example of a request deleting the Server Protection configuration template from the DefensePro device:

Path: https://Vision IP/mgmt/device/byip/10.205.193.120/config/deleteservertemplate?ServerName=DiTest&UpdatePolicies=on

Parameters
Type Name Description Required Schema Default

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

PathParameter

deviceIp

The IP address of the managed device.

true

string

Responses
HTTP Code Description Schema

200

On success, the response is a JSON in the following format:
{ "status" : "ok" }

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Produces
  • application/json

Export Server Policy from Device

GET /mgmt/device/byip/{deviceIp}/config/getservertemplate
Description

Error case:

If the Server Protection policy was created but the Update Policies operation was not yet performed on the DefensePro device, an error message is returned

Configuration template import failed due to validation error. Import of server failed. The name of the server is invalid.

The following is an example of a request to export a server protection configuration template from the DefensePro device to the APSolute Vision database:

https://Vision IP/mgmt/device/byip/Device IP/config/getservertemplate?ServerName=DC_FTP_Servers&ExportConfiguration=on&ExportBaselineHttp=on&saveToDb=true&fileName=172.16.22.21_DC_FTP_Servers_2015.11.17_17.23.55

Query parameters:

ServerName – The name of the Server Protection policy.
ExportConfiguration - Flag to indicate whether to export the configuration. Possible values: on / off.
ExportBaselineHttp - Flag to indicate whether to export the HTTP baseline. Possible values: on / off.
saveToDb - Flag to indicate whether to save the template to the APSolute Vision database, or to the local OS. Possible values: true / false. Use "true" to store the file in the APSolute Vision database. use "false" to store it on the local OS.
fileName - The name of the file to be stored in APSolute Vision database. Additionally this name can be used for importing or deleting the configuration template from the device.

Parameters
Type Name Description Required Schema Default

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

PathParameter

deviceIp

The IP address of the managed device.

true

string

Responses
HTTP Code Description Schema

200

On success, the response is a JSON in the following format:
{ "status" : "ok" }

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Produces
  • application/octet-stream

  • application/json

Update Device Scalar

PUT /mgmt/device/byip/{deviceIp}/config
Description

Updates a scalar value on the device.
Error cases:

If the wrong scalar value is specified in the JSON body, the APSolute Vision server returns the device error message.

The following is an example of a request updating the scalar values for the Time Settings of a DefensePro device:

Path: https://Vision IP/mgmt/device/byip/{Device IP}/config,
The request JSON is in the following format:
{
"rsWSDNTPPort": "123"
"rsWSDNTPServerUrl": "132.45.15.12"
},

The following is an example of a request updating the scalar values for the Alteon Management Traffic Routing:

Path: https://Vision IP/mgmt/device/byip/{Device IP}/config,
The request JSON is in the following format:
{
{"agMgmtNewCfgCdp": "2"
"agMgmtNewCfgDns": "2"
"agMgmtNewCfgOcsp": "2"
"agMgmtNewCfgReport": "2"
}

The following is an example of a request updating the scalar values of Alteon for the APM Server:

Path: https://Vision IP/mgmt/device/byip/{Device IP}/config,
The request JSON is in the following format:
{
{"agNewCfgAPMServerDataIpAddr": "172.16.55.21"
"agNewCfgAPMServerDataPort": "443"
"agNewCfgAPMServerId": "123"
"agNewCfgAPMServerMgmtIpAddr": "185.18.2.2"
}

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

string

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

deviceIp

The IP address of the managed device.

true

string

BodyParameter

requestBody

The request JSON.

true

string

Responses
HTTP Code Description Schema

200

On success, the response is a JSON in the following format:
{ "status" : "ok" }

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • application/json

Produces
  • application/json

Edit Device Table Row

PUT /mgmt/device/byip/{deviceIp}/config/{tableName}/{indexes : .+}
Description

Updates a row in a device table.
Use cases:

If inconsistent column data is specified in the JSON body, the HTTP 500 error code is returned with the error forwarded from a device.
If the path parameter is not provided, the HTTP 500 error code is returned with the error message.

The following is an example of a request updating the row with index "Test", specified in the path parameter, in the "Network Protection Policies" table:

Path: https://Vision IP/mgmt/device/byip/{Device IP}/config/rsIDSNewRulesTable/Test/,
The request JSON is in the following format:
{
"rsIDSNewRulesActionTwo": "1"
"rsIDSNewRulesDestination": "SG4"
"rsIDSNewRulesDirection": "1"
"rsIDSNewRulesInstanceIdTwo": "1"
"rsIDSNewRulesName": "Test"
"rsIDSNewRulesPacketReportingEnforcementTwo": "1"
"rsIDSNewRulesPacketTraceEnforcementTwo": "1"
"rsIDSNewRulesPacketTraceStatusTwo": "1"
"rsIDSNewRulesPortmask": ""
"rsIDSNewRulesPriorityTwo": "1"
"rsIDSNewRulesProfileAppsecThree": ""
"rsIDSNewRulesProfileConlmtThree": ""
"rsIDSNewRulesProfileDNSThree": ""
"rsIDSNewRulesProfileNetfloodThree": ""
"rsIDSNewRulesProfileSynprotectionThree": ""
"rsIDSNewRulesSource": "SG2"
"rsIDSNewRulesStateTwo": "1"
"rsIDSNewRulesVlanTagGroup": ""
}

The following is an example of a request updating the row with the indexes "SG2/1", specified in path parameters, in the "Network" table:

Path: https://Vision IP/mgmt/device/byip/{Device IP}/config/rsBWMNetworkTable/SG2/1/,

The request JSON is in the following format:
{
"rsBWMNetworkName": "SG2"
"rsBWMNetworkSubIndex": "1"
"rsBWMNetworkToIP": "66.152.0.0"
}

The following is an example of a request updating the row with the index "BDOS_Critical", specified in the path parameter, in the "BDoS Profiles" table:

Path: https://Vision IP/mgmt/device/byip/{Device IP}/config/rsNetFloodProfileTable/BDOS_Critical/,

The request JSON is in the following format:
{
"rsNetFloodProfileBandwidthIn": "343434"
"rsNetFloodProfileBandwidthOut": "343434"
"rsNetFloodProfileIcmpInQuota": "1"
"rsNetFloodProfileIcmpOutQuota": "1"
"rsNetFloodProfileIcmpStatus": "1"
"rsNetFloodProfileIgmpInQuota": "1"
"rsNetFloodProfileIgmpOutQuota": "1"
"rsNetFloodProfileIgmpStatus": "1"
"rsNetFloodProfileLevelOfReuglarzation": "1"
"rsNetFloodProfileName": "1"
"rsNetFloodProfilePacketReportStatus": "1"
"rsNetFloodProfilePacketTraceStatus": "1"
"rsNetFloodProfileTcpFinAckStatus": "1"
"rsNetFloodProfileTcpFragStatus": "2"
"rsNetFloodProfileTcpInQuota": "75"
"rsNetFloodProfileTcpOutQuota": "75"
"rsNetFloodProfileTcpRstStatus": "1"
"rsNetFloodProfileTcpSynAckStatus": "1"
"rsNetFloodProfileTcpSynStatus": "1"
"rsNetFloodProfileTransparentOptimization": "1"
"rsNetFloodProfileUdpFragStatus": "2"
"rsNetFloodProfileUdpInQuota": "50"
"rsNetFloodProfileUdpOutQuota": "50"
"rsNetFloodProfileUdpStatus": "2"
}

The following is an example of a request updating the row with the index "450000", specified in the path parameters, in the "Connection Limit Protections" table:

Path: https://Vision IP/mgmt/device/byip/{Device IP}/config/rsIDSConnectionLimitAttackTable/450000/,

The request JSON is in the following format:
{
"rsIDSConnectionLimitAttackId": "450000"
"rsIDSConnectionLimitAttackProtocol": "3"
"rsIDSConnectionLimitAttackReportMode": "0"
"rsIDSConnectionLimitAttackRisk": "2"
"rsIDSConnectionLimitAttackTrackingType": "4"
}

The following is an example of a request updating the row with the index "200009", specified in the path parameters, in the "SYN Protections" table:

Path: https://Vision IP/mgmt/device/byip/{Device IP}/config/rsIDSSYNAttackTable/200009/,

The request JSON is in the following format:
{
"rsIDSSYNAttackActivationThreshold": "2501"
"rsIDSSYNAttackId": "200009"
"rsIDSSYNAttackRisk": "4"
"rsIDSSYNAttackTerminationThreshold": "1501"
}

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

string

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

PathParameter

deviceIp

The IP address of the managed device.

true

string

PathParameter

tableName

The name of the device table.

true

string

PathParameter

indexes

The table index values according to the order defined in the MIB file.

true

string

BodyParameter

requestBody

The request JSON.

true

string

Responses
HTTP Code Description Schema

200

On success, the response is a JSON in the following format:
{ "status" : "ok" }

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • application/json

Produces
  • application/json

Get Device Table Row

GET /mgmt/device/byip/{deviceIp}/config/{tableName}/{indexes : .+}
Description

Retrieves a row from the device table according to index.
Query parameter:
"props" - Optional parameter specifying a list of column names, separated by commas.

Use cases:

If the "props" query parameter is not provided, all columns of the row are returned.
When a table does not contain the row with the specified index, the empty JSON is returned.
If the path parameter is not provided, the HTTP 500 error code is returned with the error message.

The following is an example of a request retrieving the row by index "sgns-dns-auth" from the "Network Protection Policies" table:

Path: https://Vision IP/mgmt/device/byip/{Device IP}/config/rsIDSNewRulesTable/sgns-dns-auth?props=rsIDSNewRulesName,rsIDSNewRulesState,
rsIDSNewRulesSource,rsIDSNewRulesDestination,rsIDSNewRulesPortmask,rsIDSNewRulesDirection,Vlan_MPLSRD_TagGroup,
rsIDSNewRulesVlanTagGroup,rsIDSNewRulesMPLSRDGroup,Profiles,rsIDSNewRulesProfileNetflood,rsIDSNewRulesProfileDNS,
rsIDSNewRulesProfileScanning,rsIDSNewRulesProfileStateful,rsIDSNewRulesProfileAppsec,rsIDSNewRulesProfileConlmt,
rsIDSNewRulesProfileSynprotection,rsIDSNewRulesProfilePPS,rsIDSQuarantineStatusInPolicy,rsIDSNewRulesAction,
rsIDSNewRulesPacketReportingStatus,rsIDSNewRulesPacketReportingEnforcement,rsIDSNewRulesPacketTraceStatus,
rsIDSNewRulesPacketTraceEnforcement

The following is an example of a request retrieving the row by index "sadasdasdasdasd" from the "Server Protection Policies" table:

Path: https://Vision IP/mgmt/device/byip/{Device IP}/config/rsIDSNewRulesTable/sadasdasdasdasd?props=rsIDSNewRulesName,
rsIDSNewRulesStateTwo,rsIDSNewRulesInstanceIdTwo,rsIDSNewRulesPriorityTwo,rsIDSNewRulesSource,rsIDSNewRulesDestination,
rsIDSNewRulesPortmask,rsIDSNewRulesDirection,Vlan_MPLSRD_TagGroup,rsIDSNewRulesVlanTagGroup,rsIDSNewRulesMPLSRDGroup,
Profiles,rsIDSNewRulesProfileNetfloodThree,rsIDSNewRulesProfileDNSThree,rsIDSNewRulesProfileScanningThree,
rsIDSNewRulesProfileStatefulThree,rsIDSNewRulesProfileAppsecThree,rsIDSNewRulesProfileConlmtThree,
rsIDSNewRulesProfileSynprotectionThree,rsIDSNewRulesProfilePPSThree,rsIDSNewRulesActionTwo,
rsIDSNewRulesPacketReportingStatusTwo,rsIDSNewRulesPacketReportingEnforcementTwo,rsIDSNewRulesPacketTraceStatusTwo,
rsIDSNewRulesPacketTraceEnforcementTwo

The following is an example of a request retrieving the row by index "SG2" from the "Networks" table:

Path https://Vision IP/mgmt/device/byip/{Device IP}/config/rsBWMNetworkTable/SG2?props=rsBWMNetworkName,rsBWMNetworkSubIndex,rsBWMNetworkMode,
rsBWMNetworkAddress,rsBWMNetworkFromIP,rsBWMNetworkMask,rsBWMNetworkToIP&count=50

The following is an example of a request retrieving the row by indexes "Management/MNG-1" from the "Physical Ports" table:

Path: https://Vision IP/mgmt/device/byip/{Device IP}/config/rsBWMPhysicalPortGroupTable/Management/MNG-1?props=rsBWMPhysicalPortGroupName,
rsBWMPhysicalPortGroupPort

Parameters
Type Name Description Required Schema Default

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

PathParameter

deviceIp

The IP address of the managed device.

true

string

PathParameter

tableName

The name of the table to retrieve from the device.

true

string

PathParameter

indexes

The table index values according to the order defined in the MIB file.

true

string

Responses
HTTP Code Description Schema

200

success

TableDto array

500

On failure, the response is a JSON in the following format:
{
"status": "error",
"message": "Message Text…​"
}

No Content

Produces
  • application/json

Add Device Table Row

POST /mgmt/device/byip/{deviceIp}/config/{tableName}/{indexes : .+}
Description

Adds a row to a device table.
Use cases:

If inconsistent column data is specified in the JSON body, the APSolute Vision server returns the error from a device.
If the path parameter is not provided, the HTTP 500 error code is returned with the error message.

The following is an example of a request adding a row with index "Test", specified in the path parameter, to the "Network Protection Policies" table:

Path: https://Vision IP/mgmt/device/byip/{Device IP}/config/rsIDSNewRulesTable/Test/,
The request JSON is in the following format:
{
"rsIDSNewRulesActionTwo": "1"
"rsIDSNewRulesDestination": "SG4"
"rsIDSNewRulesDirection": "1"
"rsIDSNewRulesInstanceIdTwo": "1"
"rsIDSNewRulesName": "Test"
"rsIDSNewRulesPacketReportingEnforcementTwo": "1"
"rsIDSNewRulesPacketTraceEnforcementTwo": "1"
"rsIDSNewRulesPacketTraceStatusTwo": "1"
"rsIDSNewRulesPortmask": ""
"rsIDSNewRulesPriorityTwo": "1"
"rsIDSNewRulesProfileAppsecThree": ""
"rsIDSNewRulesProfileConlmtThree": ""
"rsIDSNewRulesProfileDNSThree": ""
"rsIDSNewRulesProfileNetfloodThree": ""
"rsIDSNewRulesProfileSynprotectionThree": ""
"rsIDSNewRulesSource": "SG2"
"rsIDSNewRulesStateTwo": "1"
"rsIDSNewRulesVlanTagGroup": ""
},

The following is an example of a request adding a row with the index "Test", specified in the path parameters, to the "Signature Profile" table:

Path: https://Vision IP/mgmt/device/byip/{Device IP}/config/rsIDSSignaturesProfilesTable/Test/1/Risk/High/,

The request JSON is in the following format:
{"rsIDSSignaturesProfileName": "Test"
"rsIDSSignaturesProfileRuleAttributeName": "High"
"rsIDSSignaturesProfileRuleAttributeType": "Risk"
"rsIDSSignaturesProfileRuleName": "1"
}

The following is an example of a request adding a row with the index "Entry1", specified in the path parameters, to the "White List" table:

Path: https://Vision IP/mgmt/device/byip/{Device IP}/config/rsNewWhiteListTable/Entry1/,

The request JSON is in the following format:
{"rsNewWhiteListAction": "Test"
"rsNewWhiteListAllModules": "1"
"rsNewWhiteListDescriptionTwo": "Attach White List Entry"
"rsNewWhiteListDirection": "1"
"rsNewWhiteListDstNetwork": "SG4"
"rsNewWhiteListDstPortGroup": "rtsp"
"rsNewWhiteListHttpFloodModuleTwo": "1"
"rsNewWhiteListName": "Entry1"
"rsNewWhiteListProtocol": "0"
"rsNewWhiteListServerCrackingModuleTwo": "1"
"rsNewWhiteListSignatureModuleTwo": "1"
"rsNewWhiteListSrcNetwork": "SG2"
"rsNewWhiteListSrcPortGroup": "msn"
"rsNewWhiteListState": "1"
"rsNewWhiteListSynModuleTwo": "1"

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

string

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

PathParameter

deviceIp

The IP address of the managed device.

true

string

PathParameter

tableName

The name of the table.

true

string

PathParameter

indexes

The table index values according to the order defined in the MIB file.

true

string

BodyParameter

requestBody

The request JSON.

true

string

Responses
HTTP Code Description Schema

200

On success, the response is a JSON in the following format:
{ "status" : "ok" }

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • application/json

Produces
  • application/json

Delete Device Table Row

DELETE /mgmt/device/byip/{deviceIp}/config/{tableName}/{indexes : .+}
Description

Deletes a row from a device table. The request body is empty.

Use cases:

If the path parameter is not provided, the HTTP 500 error code is returned with the error message.

The following is an example of a request deleting the row with index "Test" (specified in the path parameter) from the "Network Protection Policies" table:
Path: https://Vision IP/mgmt/device/byip/{Device IP}/config/rsIDSNewRulesTable/Test/

The following is an example of a request deleting the row with the index "SG2/1", specified in the path parameters from the "Network" table:
Path: https://Vision IP/mgmt/device/byip/{Device IP}/config/rsBWMNetworkTable/SG2/1/

The following is an example of a request deleting the row with the index "BDOS_Critical" specified in the path parameter from the "BDoS Profiles" table:
Path: https://Vision IP/mgmt/device/byip/{Device IP}/config/rsNetFloodProfileTable/BDOS_Critical/

The following is an example of a request deleting the row with the index "450000", specified in the path parameters from the "Connection Limit Protections" table:
Path: https://Vision IP/mgmt/device/byip/{Device IP}/config/rsIDSConnectionLimitAttackTable/450000/

The following is an example of a request deleting the row with the index "BlackListEntry1", specified in the path parameters from the "Black List" table:
Path: https://Vision IP/mgmt/device/byip/{Device IP}/config/rsNewBlackListTable/BlackListEntry1/

The following is an example of a request deleting the row with the index "200009", specified in path parameters, from the "SYN Protections" table:
Path: https://Vision IP/mgmt/device/byip/{Device IP}/config/rsIDSSYNAttackTable/200009/,

Parameters
Type Name Description Required Schema Default

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

PathParameter

deviceIp

The IP address of the managed device.

true

string

PathParameter

tableName

The name of the device table.

true

string

PathParameter

indexes

The table index values according to the order defined in the MIB file.

true

string

Responses
HTTP Code Description Schema

200

On success, the response is a JSON in the following format:
{
"status" : "ok"
}

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Produces
  • application/json

General-DeviceByIpConfigV2

Update a single variable (scalar) values on the leading device and on all specified devices

PUT /mgmt/v2/devices/config/{category}
Description

Updates single variable (scalar) values on the leading device and on all specified devices.
Error condition regarding the leading device:

If the wrong variable values are specified in the JSON body, the APSolute Vision server returns device error message.

Error condition regarding the remaining devices:

If the wrong variable values are specified in the JSON body, the device error message will appear in the summarizing message on the client and in the summarizing alert.

The following is an example of a request to update variable (scalar) values on the leading device and on all specified devices:

Path: https://Vision IP/mgmt/v2/devices/config/{category},
The request JSON is in the following format:
{
"leadingDeviceIp": "172.16.162.7",
"deviceIpAddresses":["172.16.162.1","172.16.162.2","172.16.162.4"],
"requestData": {"agMgmtNewCfgRadius": "1",
"agMgmtNewCfgTacacs": "2",
"agMgmtNewCfgSyslog": "2",
"agMgmtNewCfgSnmp": "2",
"agMgmtNewCfgTftp": "2",
"agMgmtNewCfgReport": "2"
}
}

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

string

HeaderParameter

headers

Original request HTTP headers.

true

ref

BodyParameter

requestBody

Request JSON.

true

string

Responses
HTTP Code Description Schema

200

On success, of the operation on leading device, the response is a JSON in the following format:
{"ID":"R_22886","message":"The update scalars operation started for the group of devices. (ID: R_22886) "}

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • application/json

Produces
  • application/json

Send DNS Key to Device List

POST /mgmt/v2/devices/config/{category}/dnskeyimport
Description

Uploads the DNS Key text to the specified devices.

Query parameters are:
"id" - The DNS Key unique identifier.
"type" of file; The value should be "zone" for DNS Key.
"passphrase" - The password for the DNS keys encryption.
The rest are application specific parameters.

The following is an example of a request uploading a key with index "NewTextDNS" (specified in the query parameter) to the specified devices:

Path: https://Vision IP/mgmt/device/multi/config/dnskeyimport?id=NewTextDNS&type=zone&state=1&passphrase=radware&keysz=1024&hash=1&ttl=86400&exp=2419200&rollover=604800&sigval=604800&sigPUB=302400,
The request body is in the following format:
{
"requestData":"LS0tLS1CRUdJTiBSU0EgUFJJV…​.",
{
"leadingDeviceIp": "172.16.22.46",
"deviceIpAddresses":["172.16.22.44","172.16.22.43","172.16.22.42"]
}

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

string

HeaderParameter

headers

The original request HTTP headers

true

ref

PathParameter

uriInfo

The request URI

true

ref

BodyParameter

requestBody

The request JSON

true

string

Responses
HTTP Code Description Schema

200

On success, of the operation on leading device, the response is a JSON in the following format:
{"ID":"R_<Unique Operation ID>","message":"The Upload DNS Key as Text operation started for the group of devices. (ID: R_<Unique Operation ID>) "}

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Produces
  • application/json

Upload File to Device List

POST /mgmt/v2/devices/config/{category}/sendtodevice
Description

Uploads the file to the specified devices.

The query parameters are application specific.
The body parameters are the file content as an octal stream, and the leading device and device list information, as JSON string inside the form data.
The following is an example of a request uploading a tunnel with index "NewDNS" (specified in the query parameter) to the group of devices:

Path: https://Vision IP/mgmt/device/multi/config/sendtodevice?operationType=ImportTunnel&listeningAddress=10.206.158.114&listeningPort=80&fwAddress=10.206.158.114&protectedEntity=256,
The request body is in the following format:
{
Content-Disposition: form-data; name="Filedata"; filename="dbVul.kvs"
Content-Type: application/octet-stream
Content-Disposition: form-data; name="requestStringData"
{
"leadingDeviceIp": "172.16.22.46",
"deviceIpAddresses":["172.16.22.44","172.16.22.43","172.16.22.42"]
}

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

MultipartFormDataInput

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

BodyParameter

multipartFormDataInput

The file input stream and the form parameters.

true

string

Responses
HTTP Code Description Schema

200

On success, of the operation on leading device, the response is a JSON in the following format:
{"ID":"R_<Unique Operation ID>","message":"The Upload File operation started for the group of devices. (ID: R_<Unique Operation ID>) "}

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • multipart/form-data

Produces
  • text/plain

  • application/json

Get Device Table

GET /mgmt/v2/devices/{deviceId}/config/{category}/{tableName}
Description

Retrieves the table content from the device.
Query parameters:
offset - The index in the table to start retrieving from. When this optional parameter is not specified, the table from the beginning is returned.
count - Optional parameter specifying a maximum number of rows to retrieve.
props - Optional parameter specifying a list of columns, separated by commas.

Use cases:

If query parameters are not provided, the whole table is returned (with device limitations for the maximum rows that can be returned in REST)
If the path parameter is not provided, the HTTP 500 error code is returned with the error message.
When a table does not contain rows, the empty JSON is returned.

The following is an example of a request retrieving the first 50 rows from the "Network Protection Policies" table:

Path: https://Vision IP/mgmt/v2/devices/{Device ID}/config/{module}/rsIDSNewRulesTable?offset=SGNS-Global-2&count=50&props=rsIDSNewRulesName,rsIDSNewRulesState,rsIDSNewRulesSource,rsIDSNewRulesDestination,rsIDSNewRulesPortmask,
rsIDSNewRulesDirection,Vlan_MPLSRD_TagGroup,rsIDSNewRulesVlanTagGroup,rsIDSNewRulesMPLSRDGroup,Profiles,
rsIDSNewRulesProfileNetflood,rsIDSNewRulesProfileDNS,rsIDSNewRulesProfileScanning,rsIDSNewRulesProfileStateful,
rsIDSNewRulesProfileAppsec,rsIDSNewRulesProfileConlmt,rsIDSNewRulesProfileSynprotection,rsIDSNewRulesProfilePPS,
rsIDSQuarantineStatusInPolicy,rsIDSNewRulesAction,rsIDSNewRulesPacketReportingStatus,rsIDSNewRulesPacketReportingEnforcement,
rsIDSNewRulesPacketTraceStatus,rsIDSNewRulesPacketTraceEnforcement,

The following is an example of a request retrieving the first 50 rows from the "Server Protection Policies" table:

Path: https://Vision IP/mgmt/v2/devices/{Device ID}/config/{module}/rsIDSServerTable?count=50&props=rsIDSServerName,rsIDSServerIPRange,
rsIDSServerState,rsIDSServerHTTPProfile,rsIDSServerIPSProfile,rsIDSServerVlanTagGroup,rsIDSServerPacketReportStatus,
rsIDSServerPacketReportEnforcement,rsIDSServerPacketTraceStatus,rsIDSServerPacketTraceEnforcement

Parameters
Type Name Description Required Schema Default

PathParameter

deviceId

true

string

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

deviceIp

The IP address of the managed device.

true

string

PathParameter

tableName

The name of the device table.

true

string

Responses
HTTP Code Description Schema

200

success

TableDto array

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Produces
  • application/json

Edit Table Row on Device List

PUT /mgmt/v2/devices/config/{category}/{tableName}/{indexes : .+}
Description

Updates a row in the device table on the leading device and on all specified devices.
Error cases:

If wrong column data is specified in the JSON body, the APSolute Vision server returns the error from a leading device.
If the path parameter is not provided, the HTTP 500 error code is returned with the error message.

The following is an example of a request updating a row with index "Test" (specified in the path parameter) to the "Network Protection Policies" table:

Path: https://Vision IP/mgmt/v2/devices/config/aw/rsIDSNewRulesTable/Test/,
The request JSON is in the following format:
{
{
"leadingDeviceIp": "172.16.22.46",
"deviceIpAddresses":["172.16.22.44","172.16.22.43","172.16.22.42"],
"requestData": {"rsIDSNewRulesStateTwo": "1",
"rsIDSNewRulesName": "Test"
"rsIDSNewRulesInstanceIdTwo": "0"
"rsIDSNewRulesPortmask": ""
"rsIDSNewRulesInstanceIdTwo": "1"
"rsIDSNewRulesDirection": "1"
"rsIDSNewRulesVlanTagGroup": ""
"rsIDSNewRulesMPLSRDGroup": ""
"rsIDSNewRulesProfileNetfloodThree": ""
"rsIDSNewRulesProfileDNSThree": ""
"rsIDSNewRulesProfileAppsecThree": ""
"rsIDSNewRulesProfileConlmt": ""
"rsIDSNewRulesProfileSynprotectionThree": ""
"rsIDSNewRulesActionTwo": "1"
}}

The following is an example of a request updating a row with the index "Test", specified in the path parameters, to the "Signature Profile" table:

Path: https://Vision IP/mgmt/v2/devices/config/aw/rsIDSSignaturesProfilesTable/Test/1/Risk/High/,

The request JSON is in the following format:
{
"leadingDeviceIp": "172.16.22.46",
"deviceIpAddresses":["172.16.22.44","172.16.22.43","172.16.22.42"],
"requestData": {"rsIDSSignaturesProfileName": "Test1"
"rsIDSSignaturesProfileRuleAttributeName": "High"
"rsIDSSignaturesProfileRuleAttributeType": "Risk"
"rsIDSSignaturesProfileRuleName": "1"
}
}

The following is an example of a request updating a row with the index "Entry1", specified in the path parameters, to the "White List" table:

Path: https://Vision IP/mgmt/v2/devices/config/aw/rsNewWhiteListTable/Entry1/,

The request JSON is in the following format:
{
"leadingDeviceIp": "172.16.22.46",
"deviceIpAddresses":["172.16.22.44","172.16.22.43","172.16.22.42"],
"requestData": {"rsNewWhiteListAction": "Test"
"rsNewWhiteListAllModules": "1"
"rsNewWhiteListDescriptionTwo": "Attach White List Entry"
"rsNewWhiteListDirection": "1"
"rsNewWhiteListDstNetwork": "SG4"
"rsNewWhiteListDstPortGroup": "rtsp"
"rsNewWhiteListHttpFloodModuleTwo": "1"
"rsNewWhiteListName": "Entry1"
"rsNewWhiteListProtocol": "0"
"rsNewWhiteListServerCrackingModuleTwo": "1"
"rsNewWhiteListSignatureModuleTwo": "1"
"rsNewWhiteListSrcNetwork": "SG2"
"rsNewWhiteListSrcPortGroup": "msn"
"rsNewWhiteListState": "1"
"rsNewWhiteListSynModuleTwo": "1"
}}

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

string

HeaderParameter

headers

The original request HTTP headers

true

ref

PathParameter

uriInfo

The request URI

true

ref

PathParameter

tableName

The name of the table

true

string

PathParameter

indexes

The table index values according to the order defined in the MIB file

true

string

BodyParameter

requestBody

The request JSON

true

string

Responses
HTTP Code Description Schema

200

On success, of the operation on leading device, the response is a JSON in the following format:
{"ID":"R_<Unique Operation ID>","message":"The update table row operation started for the group of devices.(ID: R_<Unique Operation ID>) "}

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • application/json

Produces
  • application/json

Add Table Row to Device List

POST /mgmt/v2/devices/config/{category}/{tableName}/{indexes : .+}
Description

Adds a row to a device table on the leading device and on the specified devices.
Error cases:

If wrong columns data is specified in the JSON body, the APSolute Vision server returns the error from a leading device.
If the path parameter is not provided, the HTTP 500 error code is returned with the error message.

The following is an example of a request adding a row with index "Test" (specified in the path parameter) to the "Network Protection Policies" table:

Path: https://Vision IP/mgmt/v2/devices/config/aw/rsIDSNewRulesTable/Test/,
The request JSON is in the following format:
{
{
"leadingDeviceIp": "172.16.22.46",
"deviceIpAddresses":["172.16.22.44","172.16.22.43","172.16.22.42"],
"requestData": {"rsIDSNewRulesStateTwo": "1",
"rsIDSNewRulesName": "Test"
"rsIDSNewRulesInstanceIdTwo": "0"
"rsIDSNewRulesPortmask": ""
"rsIDSNewRulesInstanceIdTwo": "1"
"rsIDSNewRulesDirection": "1"
"rsIDSNewRulesVlanTagGroup": ""
"rsIDSNewRulesMPLSRDGroup": ""
"rsIDSNewRulesProfileNetfloodThree": ""
"rsIDSNewRulesProfileDNSThree": ""
"rsIDSNewRulesProfileAppsecThree": ""
"rsIDSNewRulesProfileConlmt": ""
"rsIDSNewRulesProfileSynprotectionThree": ""
"rsIDSNewRulesActionTwo": "1"
}}

The following is an example of a request adding a row with the index "Test", specified in the path parameters, to the "Signature Profile" table:

Path: https://Vision IP/mgmt/device/multi/config/rsIDSSignaturesProfilesTable/Test/1/Risk/High/,

The request JSON is in the following format:
{
"leadingDeviceIp": "172.16.22.46",
"deviceIpAddresses":["172.16.22.44","172.16.22.43","172.16.22.42"],
"requestData": {"rsIDSSignaturesProfileName": "Test1"
"rsIDSSignaturesProfileRuleAttributeName": "High"
"rsIDSSignaturesProfileRuleAttributeType": "Risk"
"rsIDSSignaturesProfileRuleName": "1"
}
}

The following is an example of a request adding a row with the index "Entry1", specified in the path parameters, to the "White List" table:

Path: https://Vision IP/mgmt/device/multi/config/rsNewWhiteListTable/Entry1/,

The request JSON is in the following format:
{
"leadingDeviceIp": "172.16.22.46",
"deviceIpAddresses":["172.16.22.44","172.16.22.43","172.16.22.42"],
"requestData": {"rsNewWhiteListAction": "Test"
"rsNewWhiteListAllModules": "1"
"rsNewWhiteListDescriptionTwo": "Attach White List Entry"
"rsNewWhiteListDirection": "1"
"rsNewWhiteListDstNetwork": "SG4"
"rsNewWhiteListDstPortGroup": "rtsp"
"rsNewWhiteListHttpFloodModuleTwo": "1"
"rsNewWhiteListName": "Entry1"
"rsNewWhiteListProtocol": "0"
"rsNewWhiteListServerCrackingModuleTwo": "1"
"rsNewWhiteListSignatureModuleTwo": "1"
"rsNewWhiteListSrcNetwork": "SG2"
"rsNewWhiteListSrcPortGroup": "msn"
"rsNewWhiteListState": "1"
"rsNewWhiteListSynModuleTwo": "1"
}}

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

string

HeaderParameter

headers

The original request HTTP headers

true

ref

PathParameter

uriInfo

The request URI

true

ref

PathParameter

tableName

The name of the table

true

string

PathParameter

indexes

The table index values according to the order defined in the MIB file

true

string

BodyParameter

requestBody

The request JSON

true

string

Responses
HTTP Code Description Schema

200

On success, of the operation on leading device, the response is a JSON in the following format:
{"ID":"R_<Unique Operation ID>","message":"The create table row operation started for the group of devices.(ID: R_<Unique Operation ID>) "}

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • application/json

Produces
  • application/json

Delete Table Row from Device List

DELETE /mgmt/v2/devices/config/{category}/{tableName}/{indexes : .+}
Description

Deletes a row from the leading device table and from the table on all specified devices.
Error cases:

If the wrong index is specified in the path, the APSolute Vision server returns the error from a leading device.
If the path parameter is not provided, the HTTP 500 error code is returned with the error message.

The following is an example of a request to delete a row with index "Test" (specified in the path parameter) from the "Network Protection Policies" table:

Path: https://Vision IP/mgmt/v2/devices/config/aw/rsIDSNewRulesTable/Test/,
The request JSON is in the following format:
{

"leadingDeviceIp": "172.16.22.46",
"deviceIpAddresses":["172.16.22.44","172.16.22.43","172.16.22.42"]
}

The following is an example of a request deleting a row with the indexes "Test", "1', "Risk", "High", specified in the path parameters, from the "Signature Profile" table:

Path: https://Vision IP/mgmt/v2/devices/config/aw/rsIDSSignaturesProfilesTable/Test/1/Risk/High/,

The request JSON is in the following format:
{
"leadingDeviceIp": "172.16.22.46",
"deviceIpAddresses":["172.16.22.44","172.16.22.43","172.16.22.42"]
}

The following is an example of a request deleting a row with the index "Entry1", specified in the path parameters, from the "White List" table:

Path: https://Vision IP/mgmt/v2/devices/config/aw/rsNewWhiteListTable/Entry1/,

The request JSON is in the following format:
{
"leadingDeviceIp": "172.16.22.46",
"deviceIpAddresses":["172.16.22.44","172.16.22.43","172.16.22.42"]
}

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

string

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

PathParameter

tableName

The name of the table.

true

string

PathParameter

indexes

The table index values according to the order defined in the MIB file.

true

string

BodyParameter

requestBody

The request JSON.

true

string

Responses
HTTP Code Description Schema

200

On success, of the operation on leading device, the response is a JSON in the following format:
{"ID":"R_<Unique Operation ID>","message":"The delete table row operation started for the group of devices.(ID: R_<Unique Operation ID>) "}

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • application/json

Produces
  • application/json

Update Device Scalar

PUT /mgmt/v2/devices/{deviceId}/config/{category}
Description

Updates a scalar value on the device.
Error cases:

If the wrong scalar value is specified in the JSON body, the APSolute Vision server returns the device error message.

The following is an example of a request updating the scalar values for the Time Settings of a DefensePro device:

Path: https://Vision IP/mgmt/v2/devices/{Device ID}/config/{module},
The request JSON is in the following format:
{
"rsWSDNTPPort": "123"
"rsWSDNTPServerUrl": "132.45.15.12"
},

The following is an example of a request updating the scalar values for the Alteon Management Traffic Routing:

Path: https://Vision IP/mgmt/v2/devices/{Device ID}/config/{module},
The request JSON is in the following format:
{
{"agMgmtNewCfgCdp": "2"
"agMgmtNewCfgDns": "2"
"agMgmtNewCfgOcsp": "2"
"agMgmtNewCfgReport": "2"
}

The following is an example of a request updating the scalar values of Alteon for the APM Server:

Path: https://Vision IP/mgmt/v2/devices/{Device ID}/config/{module},
The request JSON is in the following format:
{
{"agNewCfgAPMServerDataIpAddr": "172.16.55.21"
"agNewCfgAPMServerDataPort": "443"
"agNewCfgAPMServerId": "123"
"agNewCfgAPMServerMgmtIpAddr": "185.18.2.2"
}

Parameters
Type Name Description Required Schema Default

PathParameter

deviceId

true

string

BodyParameter

body

false

string

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

deviceIp

The IP address of the managed device.

true

string

BodyParameter

requestBody

The request JSON.

true

string

Responses
HTTP Code Description Schema

200

On success, the response is a JSON in the following format:
{ "status" : "ok" }

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • application/json

Produces
  • application/json

Upload Certificate to Device List

POST /mgmt/v2/devices/config/{category}/sslcertimport
Description

Uploads a certificate file to the specified devices.

Query parameters:
id - The certificate unique identifier.
type - The type of the file. Possible values are "key" for SSL key; "cert" for certificate, "req" for certificate request, "p12" for certificate and key, "interm" for intermediate certificate.
passphrase - The password for the private keys encryption.
src - The source type. Possible values are "txt" or "file". In this case the value should be "file".

Body parameters are: the file content as an octal stream, and the leading device, and the device list information as a JSON string inside the form data.
The following is an example of a request to upload a key with index "888" (specified in the query parameter) to the specified devices:

Path: https://Vision IP/mgmt/device/multi/config/sslcertimport?id=888&type=key&passphrase=radware&src=file,
The request body is in the following format:
{
Content-Disposition: form-data; name="Filedata"; filename="13.key"
Content-Type: application/octet-stream
Content-Disposition: form-data; name="requestStringData"
{
"leadingDeviceIp": "172.16.22.46",
"deviceIpAddresses":["172.16.22.44","172.16.22.43","172.16.22.42"]
}

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

MultipartFormDataInput

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

BodyParameter

multipartFormDataInput

The file input stream and the form parameters.

true

string

Responses
HTTP Code Description Schema

200

On success, of the operation on leading device, the response is a JSON in the following format:
{"ID":"R_<Unique Operation ID>","message":"The Upload Certificate as File operation started for the group of devices. (ID: R_<Unique Operation ID>) "}

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • multipart/form-data

Produces
  • text/plain

  • application/json

Edit Device Table Row

PUT /mgmt/v2/devices/{deviceId}/config/{category}/{tableName}/{indexes : .+}
Description

Updates a row in a device table.
Use cases:

If inconsistent columns data is specified in the JSON body, the HTTP 500 error code is returned with the error forwarded from a device.
If the path parameter is not provided, the HTTP 500 error code is returned with the error message.

The following is an example of a request updating the row with index "Test" (specified in the path parameter) in the "Network Protection Policies" table:

Path: https://Vision IP/mgmt/v2/devices/{Device ID}/config/{module}/rsIDSNewRulesTable/Test/,
The request JSON is in the following format:
{
"rsIDSNewRulesActionTwo": "1"
"rsIDSNewRulesDestination": "SG4"
"rsIDSNewRulesDirection": "1"
"rsIDSNewRulesInstanceIdTwo": "1"
"rsIDSNewRulesName": "Test"
"rsIDSNewRulesPacketReportingEnforcementTwo": "1"
"rsIDSNewRulesPacketTraceEnforcementTwo": "1"
"rsIDSNewRulesPacketTraceStatusTwo": "1"
"rsIDSNewRulesPortmask": ""
"rsIDSNewRulesPriorityTwo": "1"
"rsIDSNewRulesProfileAppsecThree": ""
"rsIDSNewRulesProfileConlmtThree": ""
"rsIDSNewRulesProfileDNSThree": ""
"rsIDSNewRulesProfileNetfloodThree": ""
"rsIDSNewRulesProfileSynprotectionThree": ""
"rsIDSNewRulesSource": "SG2"
"rsIDSNewRulesStateTwo": "1"
"rsIDSNewRulesVlanTagGroup": ""
}

The following is an example of a request updating the row with the indexes "SG2/1", specified in path parameters, in the "Network" table:

Path: https://Vision IP/mgmt/v2/devices/{Device ID}/config/{module}/rsBWMNetworkTable/SG2/1/,

The request JSON is in the following format:
{
"rsBWMNetworkName": "SG2"
"rsBWMNetworkSubIndex": "1"
"rsBWMNetworkToIP": "66.152.0.0"
}

The following is an example of a request updating the row with the index "BDOS_Critical", specified in the path parameter, in the "BDoS Profiles" table:

Path: https://Vision IP/mgmt/v2/devices/{Device ID}/config/{module}/rsNetFloodProfileTable/BDOS_Critical/,

The request JSON is in the following format:
{
"rsNetFloodProfileBandwidthIn": "343434"
"rsNetFloodProfileBandwidthOut": "343434"
"rsNetFloodProfileIcmpInQuota": "1"
"rsNetFloodProfileIcmpOutQuota": "1"
"rsNetFloodProfileIcmpStatus": "1"
"rsNetFloodProfileIgmpInQuota": "1"
"rsNetFloodProfileIgmpOutQuota": "1"
"rsNetFloodProfileIgmpStatus": "1"
"rsNetFloodProfileLevelOfReuglarzation": "1"
"rsNetFloodProfileName": "1"
"rsNetFloodProfilePacketReportStatus": "1"
"rsNetFloodProfilePacketTraceStatus": "1"
"rsNetFloodProfileTcpFinAckStatus": "1"
"rsNetFloodProfileTcpFragStatus": "2"
"rsNetFloodProfileTcpInQuota": "75"
"rsNetFloodProfileTcpOutQuota": "75"
"rsNetFloodProfileTcpRstStatus": "1"
"rsNetFloodProfileTcpSynAckStatus": "1"
"rsNetFloodProfileTcpSynStatus": "1"
"rsNetFloodProfileTransparentOptimization": "1"
"rsNetFloodProfileUdpFragStatus": "2"
"rsNetFloodProfileUdpInQuota": "50"
"rsNetFloodProfileUdpOutQuota": "50"
"rsNetFloodProfileUdpStatus": "2"
}

The following is an example of a request updating the row with the index "450000", specified in the path parameters, in the "Connection Limit Protections" table:

Path: https://Vision IP/mgmt/v2/devices/{Device ID}/config/{module}/rsIDSConnectionLimitAttackTable/450000/,

The request JSON is in the following format:
{
"rsIDSConnectionLimitAttackId": "450000"
"rsIDSConnectionLimitAttackProtocol": "3"
"rsIDSConnectionLimitAttackReportMode": "0"
"rsIDSConnectionLimitAttackRisk": "2"
"rsIDSConnectionLimitAttackTrackingType": "4"
}

The following is an example of a request updating the row with the index "200009", specified in the path parameters, in the "SYN Protections" table:

Path: https://Vision IP/mgmt/v2/devices/{Device ID}/config/{module}/rsIDSSYNAttackTable/200009/,

The request JSON is in the following format:
{
"rsIDSSYNAttackActivationThreshold": "2501"
"rsIDSSYNAttackId": "200009"
"rsIDSSYNAttackRisk": "4"
"rsIDSSYNAttackTerminationThreshold": "1501"
}

Parameters
Type Name Description Required Schema Default

PathParameter

deviceId

true

string

BodyParameter

body

false

string

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

PathParameter

deviceIp

The IP address of the managed device.

true

string

PathParameter

tableName

The name of the device table.

true

string

PathParameter

indexes

The table index values according to the order defined in MIB file.

true

string

BodyParameter

requestBody

The request JSON.

true

string

Responses
HTTP Code Description Schema

200

On success, the response is a JSON in the following format:
{ "status" : "ok" }

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • application/json

Produces
  • application/json

Get Device Table Row

GET /mgmt/v2/devices/{deviceId}/config/{category}/{tableName}/{indexes : .+}
Description

Retrieves a row from the device table according to index.
Query parameter:
props - Optional parameter specifying a list of column names, separated by commas.

Use cases:

If the "props" query parameter is not provided, all columns of the row are returned.
When a table does not contain the row with the specified index, the empty JSON is returned.
If the path parameter is not provided, the HTTP 500 error code is returned with the error message.

The following is an example of a request retrieving the row by index "sgns-dns-auth" from the "Network Protection Policies" table:

Path: https://Vision IP/mgmt/v2/devices/{Device ID}/config/{module}/rsIDSNewRulesTable/sgns-dns-auth?props=rsIDSNewRulesName,rsIDSNewRulesState,
rsIDSNewRulesSource,rsIDSNewRulesDestination,rsIDSNewRulesPortmask,rsIDSNewRulesDirection,Vlan_MPLSRD_TagGroup,
rsIDSNewRulesVlanTagGroup,rsIDSNewRulesMPLSRDGroup,Profiles,rsIDSNewRulesProfileNetflood,rsIDSNewRulesProfileDNS,
rsIDSNewRulesProfileScanning,rsIDSNewRulesProfileStateful,rsIDSNewRulesProfileAppsec,rsIDSNewRulesProfileConlmt,
rsIDSNewRulesProfileSynprotection,rsIDSNewRulesProfilePPS,rsIDSQuarantineStatusInPolicy,rsIDSNewRulesAction,
rsIDSNewRulesPacketReportingStatus,rsIDSNewRulesPacketReportingEnforcement,rsIDSNewRulesPacketTraceStatus,
rsIDSNewRulesPacketTraceEnforcement

The following is an example of a request retrieving the row by index "sadasdasdasdasd" from the "Server Protection Policies" table:

Path: https://Vision IP/mgmt/v2/devices/{Device ID}/config/{module}/rsIDSNewRulesTable/sadasdasdasdasd?props=rsIDSNewRulesName,
rsIDSNewRulesStateTwo,rsIDSNewRulesInstanceIdTwo,rsIDSNewRulesPriorityTwo,rsIDSNewRulesSource,rsIDSNewRulesDestination,
rsIDSNewRulesPortmask,rsIDSNewRulesDirection,Vlan_MPLSRD_TagGroup,rsIDSNewRulesVlanTagGroup,rsIDSNewRulesMPLSRDGroup,
Profiles,rsIDSNewRulesProfileNetfloodThree,rsIDSNewRulesProfileDNSThree,rsIDSNewRulesProfileScanningThree,
rsIDSNewRulesProfileStatefulThree,rsIDSNewRulesProfileAppsecThree,rsIDSNewRulesProfileConlmtThree,
rsIDSNewRulesProfileSynprotectionThree,rsIDSNewRulesProfilePPSThree,rsIDSNewRulesActionTwo,
rsIDSNewRulesPacketReportingStatusTwo,rsIDSNewRulesPacketReportingEnforcementTwo,rsIDSNewRulesPacketTraceStatusTwo,
rsIDSNewRulesPacketTraceEnforcementTwo

The following is an example of a request retrieving the row by index "SG2" from the "Networks" table:

Path https://Vision IP/mgmt/v2/devices/{Device ID}/config/{module}/rsBWMNetworkTable/SG2?props=rsBWMNetworkName,rsBWMNetworkSubIndex,rsBWMNetworkMode,
rsBWMNetworkAddress,rsBWMNetworkFromIP,rsBWMNetworkMask,rsBWMNetworkToIP&count=50

The following is an example of a request retrieving the row by indexes "Management/MNG-1" from the "Physical Ports" table:

Path: https://Vision IP/mgmt/v2/devices/{Device ID}/config/{module}/rsBWMPhysicalPortGroupTable/Management/MNG-1?props=rsBWMPhysicalPortGroupName,
rsBWMPhysicalPortGroupPort

Parameters
Type Name Description Required Schema Default

PathParameter

deviceId

true

string

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

PathParameter

deviceIp

The IP address of the managed device.

true

string

PathParameter

tableName

The name of the table to retrieve from the device.

true

string

PathParameter

indexes

The table index values according to the order defined in the MIB file.

true

string

Responses
HTTP Code Description Schema

200

success

TableDto array

500

On failure, the response is a JSON in the following format:
{
"status": "error",
"message": "Message Text…​"
}

No Content

Produces
  • application/json

Add Device Table Row

POST /mgmt/v2/devices/{deviceId}/config/{category}/{tableName}/{indexes : .+}
Description

Adds a row to a device table.
Use cases:

If inconsistent columns data is specified in the JSON body, the APSolute Vision server returns the error from a device.
If the path parameter is not provided, the HTTP 500 error code is returned with the error message.

The following is an example of a request adding a row with index "Test" (specified in the path parameter) to the "Network Protection Policies" table:

Path: https://Vision IP/mgmt/v2/devices/{Device ID}/config/{module}/rsIDSNewRulesTable/Test/,
The request JSON is in the following format:
{
"rsIDSNewRulesActionTwo": "1"
"rsIDSNewRulesDestination": "SG4"
"rsIDSNewRulesDirection": "1"
"rsIDSNewRulesInstanceIdTwo": "1"
"rsIDSNewRulesName": "Test"
"rsIDSNewRulesPacketReportingEnforcementTwo": "1"
"rsIDSNewRulesPacketTraceEnforcementTwo": "1"
"rsIDSNewRulesPacketTraceStatusTwo": "1"
"rsIDSNewRulesPortmask": ""
"rsIDSNewRulesPriorityTwo": "1"
"rsIDSNewRulesProfileAppsecThree": ""
"rsIDSNewRulesProfileConlmtThree": ""
"rsIDSNewRulesProfileDNSThree": ""
"rsIDSNewRulesProfileNetfloodThree": ""
"rsIDSNewRulesProfileSynprotectionThree": ""
"rsIDSNewRulesSource": "SG2"
"rsIDSNewRulesStateTwo": "1"
"rsIDSNewRulesVlanTagGroup": ""
},

The following is an example of a request adding a row with the index "Test", specified in the path parameters, to the "Signature Profile" table:

Path: https://Vision IP/mgmt/v2/devices/{Device ID}/config/{module}/rsIDSSignaturesProfilesTable/Test/1/Risk/High/,

The request JSON is in the following format:
{"rsIDSSignaturesProfileName": "Test"
"rsIDSSignaturesProfileRuleAttributeName": "High"
"rsIDSSignaturesProfileRuleAttributeType": "Risk"
"rsIDSSignaturesProfileRuleName": "1"
}

The following is an example of a request adding a row with the index "Entry1", specified in the path parameters, to the "White List" table:

Path: https://Vision IP/mgmt/v2/devices/{Device ID}/config/{module}/rsNewWhiteListTable/Entry1/,

The request JSON is in the following format:
{"rsNewWhiteListAction": "Test"
"rsNewWhiteListAllModules": "1"
"rsNewWhiteListDescriptionTwo": "Attach White List Entry"
"rsNewWhiteListDirection": "1"
"rsNewWhiteListDstNetwork": "SG4"
"rsNewWhiteListDstPortGroup": "rtsp"
"rsNewWhiteListHttpFloodModuleTwo": "1"
"rsNewWhiteListName": "Entry1"
"rsNewWhiteListProtocol": "0"
"rsNewWhiteListServerCrackingModuleTwo": "1"
"rsNewWhiteListSignatureModuleTwo": "1"
"rsNewWhiteListSrcNetwork": "SG2"
"rsNewWhiteListSrcPortGroup": "msn"
"rsNewWhiteListState": "1"
"rsNewWhiteListSynModuleTwo": "1"

Parameters
Type Name Description Required Schema Default

PathParameter

deviceId

true

string

BodyParameter

body

false

string

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

PathParameter

deviceIp

The IP address of the managed device.

true

string

PathParameter

tableName

The name of the table.

true

string

PathParameter

indexes

The table index values according to the order defined in the MIB file.

true

string

BodyParameter

requestBody

The request JSON.

true

string

Responses
HTTP Code Description Schema

200

On success, the response is a JSON in the following format:
{ "status" : "ok" }

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • application/json

Produces
  • application/json

Delete Device Table Row

DELETE /mgmt/v2/devices/{deviceId}/config/{category}/{tableName}/{indexes : .+}
Description

Deletes a row from a device table. The request body is empty.

Use case:

If the path parameter is not provided, the HTTP 500 error code is returned with the error message.

The following is an example of a request deleting the row with index "Test" (specified in the path parameter) from the "Network Protection Policies" table:
Path: https://Vision IP/mgmt/v2/devices/{Device ID}/config/{module}/rsIDSNewRulesTable/Test/

The following is an example of a request deleting the row with the index "SG2/1", specified in the path parameters from the "Network" table:
Path: https://Vision IP/mgmt/v2/devices/{Device ID}/config/{module}/rsBWMNetworkTable/SG2/1/

The following is an example of a request deleting the row with the index "BDOS_Critical" specified in the path parameter from the "BDoS Profiles" table:
Path: https://Vision IP/mgmt/v2/devices/{Device ID}/config/{module}/rsNetFloodProfileTable/BDOS_Critical/

The following is an example of a request deleting the row with the index "450000", specified in the path parameters from the "Connection Limit Protections" table:
Path: https://Vision IP/mgmt/v2/devices/{Device ID}/config/{module}/rsIDSConnectionLimitAttackTable/450000/

The following is an example of a request deleting the row with the index "BlackListEntry1", specified in the path parameters from the "Black List" table:
Path: https://Vision IP/mgmt/v2/devices/{Device ID}/config/{module}/rsNewBlackListTable/BlackListEntry1/

The following is an example of a request deleting the row with the index "200009", specified in path parameters, from the "SYN Protections" table:
Path: https://Vision IP/mgmt/v2/devices/{Device ID}/config/{module}/rsIDSSYNAttackTable/200009/,

Parameters
Type Name Description Required Schema Default

PathParameter

deviceId

true

string

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

PathParameter

deviceIp

The IP address of the managed device.

true

string

PathParameter

tableName

The name of the device table.

true

string

PathParameter

indexes

The table index values according to the order defined in the MIB file.

true

string

Responses
HTTP Code Description Schema

200

On success, the response is a JSON in the following format:
{
"status" : "ok"
}

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Produces
  • application/json

General-MassOperationsConfig

Manage vADC List

POST /mgmt/device/multi/config/manage
Description

Adds a list of vADC devices to APSolute Vision management.
Error cases:

If one of the specified device names already exists in the Vision server, the APSolute Vision server returns the following error: Node name in the tree must be unique. Please enter another name. (ID:M_00023)

If the specified device IP addresses is already used by another device connected to the APSolute Vision server, the APSolute Vision server returns the error: Device with IP Address [Device IP Address] already exists, please use a different IP Address. (ID:M_00302) (ID:M_00023)

The following is an example of a request to add the specified vADC devices to APSolute Vision:

Path: https://Vision IP/mgmt/device/multi/config/manage,
The request JSON is in the following format:
{
"cliPassword":"admin",
"cliPort":"22",
"cliUsername":"admin",
"cliPassword":"admin",
"exclusivelyReceiveDeviceEvents":"false",
"httpPassword":"admin",
"httpPort":"80",
"httpsPassword":"admin",
"httpsPort":"443",
"httpsUsername":"admin",
"httpUsername":"admin",
"managementIp":"172.16.62.62",
"registerDeviceEvents":"true",
"siteName":"Default",
"snmpV2ReadCommunity":"public",
"snmpV2WriteCommunity":"private",
"snmpVersion":"SNMP_V2",
"type":"Alteon",
"verifyHttpsCredentials":"true",
"createDeviceDtoList":["deviceIP":"172.16.162.1","deviceName" : "172.16.62.62_vADC-1"},{"deviceIP" : "172.16.162.2","deviceName" : "172.16.62.62_vADC-2"}],
}

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

string

PathParameter

uriInfo

Request URI.

true

ref

BodyParameter

requestBody

Request JSON.

true

string

Responses
HTTP Code Description Schema

200

On operation start, the response is a JSON in the following format:
{"ID":"R_<Unique Operation ID>","message":"The manage operation started for the group of devices. See the Alerts browser for details. (ID: R_<Unique Operation ID>) "}

No Content

500

On failure the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • application/json

Produces
  • text/plain

  • application/json

Upload File to Device List

POST /mgmt/device/multi/config/sendtodevice
Description

Uploads the file to the specified devices.

The query parameters are application specific.
The body parameters are the file content as an octal stream, and the leading device and device list information, as a JSON string inside the form data.
The following is an example of a request uploading a tunnel with index "NewDNS" ,specified in the query parameter, to the group of devices:

Path: https://Vision IP/mgmt/device/multi/config/sendtodevice?operationType=ImportTunnel&listeningAddress=10.206.158.114&listeningPort=80&fwAddress=10.206.158.114&protectedEntity=256,
The request body is in the following format:
{
Content-Disposition: form-data; name="Filedata"; filename="dbVul.kvs"
Content-Type: application/octet-stream
Content-Disposition: form-data; name="requestStringData"
{
"leadingDeviceIp": "172.16.22.46",
"deviceIpAddresses":["172.16.22.44","172.16.22.43","172.16.22.42"]
}

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

MultipartFormDataInput

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

BodyParameter

multipartFormDataInput

The file input stream and the form parameters.

true

string

Responses
HTTP Code Description Schema

200

On success of the operation on the leading device, the response is a JSON in the following format:
{"ID":"R_<Unique Operation ID>","message":"The Upload File operation started for the group of devices. (ID: R_<Unique Operation ID>) "}

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • multipart/form-data

Produces
  • text/plain

  • application/json

Upload Certificate to Device List

POST /mgmt/device/multi/config/sslcertimport
Description

Uploads certificate file to the specified devices.

Query parameters:
id - The certificate unique identifier.
type - The type of file; Possible values are "key" for SSL key; "cert" for certificate; "req" for certificate request; "p12" for certificate and key; "interm" for intermediate certificate.
passphrase - The password for the private keys encryption.
src - Source type. Possible values are "txt" or "file". In this case, the value should be "file".

Body parameters are the file content as an octal stream, and the leading device, and the device list information as JSON string inside the form data.
The following is an example of a request to upload a key with index "888" ,specified in the query parameter, to the specified devices:

Path: https://Vision IP/mgmt/device/multi/config/sslcertimport?id=888&type=key&passphrase=radware&src=file,
The request body is in the following format:
{
Content-Disposition: form-data; name="Filedata"; filename="13.key"
Content-Type: application/octet-stream
Content-Disposition: form-data; name="requestStringData"
{
"leadingDeviceIp": "172.16.22.46",
"deviceIpAddresses":["172.16.22.44","172.16.22.43","172.16.22.42"]
}

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

MultipartFormDataInput

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

BodyParameter

multipartFormDataInput

The file input stream and the form parameters.

true

string

Responses
HTTP Code Description Schema

200

On success, of the operation on the leading device, the response is a JSON in the following format:
{"ID":"R_<Unique Operation ID>","message":"The Upload Certificate as File operation started for the group of devices. (ID: R_<Unique Operation ID>) "}

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • multipart/form-data

Produces
  • text/plain

  • application/json

Perform Revert on Device List

POST /mgmt/device/multi/config/revert
Description

Activates the Revert action on each of the specified Alteon or LinkProof NG devices.
The following is an example of a request to perform the Revert action on the specified Alteon devices:

Path: https://Vision IP/mgmt/device/multi/config/revert,
The request JSON is in the following format:
{
"deviceIpAddresses":["172.16.162.1","172.16.162.2"]
}

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

string

PathParameter

uriInfo

Request URI.

true

ref

BodyParameter

requestBody

Request JSON.

true

string

Responses
HTTP Code Description Schema

200

On operation start, the response is a JSON in the following format:
{"ID":"R_<Unique Operation ID>","message":"The revert operation started for the group of devices. See the Alerts browser for details. (ID: R_<Unique Operation ID>) "}

No Content

500

On failure the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • application/json

Produces
  • text/plain

  • application/json

Perform Revert Apply on Device List

POST /mgmt/device/multi/config/revertApply
Description

Reverts the applied configuration for each of the specified Alteon or LinkProof NG devices.
The following is an example of a request reverting the applied configuration for the specified Alteon devices:

Path: https://Vision IP/mgmt/device/multi/config/revertApply,
The request JSON is in the following format:
{
"deviceIpAddresses":["172.16.162.1","172.16.162.2"]
}

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

string

PathParameter

uriInfo

Request URI.

true

ref

BodyParameter

requestBody

Request JSON.

true

string

Responses
HTTP Code Description Schema

200

On operation start, the response is a JSON in the following format:
{"ID":"R_<Unique Operation ID>","message":"The revert operation started for the group of devices. See the Alerts browser for details. (ID: R_<Unique Operation ID>) "}

No Content

500

On failure the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • application/json

Produces
  • text/plain

  • application/json

Perform Update Policies on Device List

POST /mgmt/device/multi/config/updatepolicies
Description

"Performs the Update Policies action on the specified devices.
The following is an example of a request to perform the Update Policies action on a group of devices:

Path: https://Vision IP/mgmt/device/multi/config/updatepolicies,
The request JSON is in the following format:
{
"deviceIpAddresses":["172.16.162.1","172.16.162.2","172.16.162.4"]

}

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

string

PathParameter

uriInfo

The request URI.

true

ref

BodyParameter

requestBody

The request JSON.

true

string

Responses
HTTP Code Description Schema

200

On operation start, the response is a JSON in the following format:
{"ID":"R_<Unique Operation ID>","message":"The Update Policies operation started for the group of devices. See the Alerts browser for details. (ID: R_<Unique Operation ID>) "}

No Content

500

On failure the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • application/json

Produces
  • text/plain

  • application/json

Edit Table Row on Device List

PUT /mgmt/device/multi/config/{tableName}/{indexes : .+}
Description

Updates a row in the device table on the leading device and on all specified devices.
Error cases:

If wrong column data is specified in the JSON body, the APSolute Vision server returns the error from a leading device.
If the path parameter is not provided, the HTTP 500 error code is returned with the error message.

The following is an example of a request updating a row with index "Test" (specified in the path parameter) to the "Network Protection Policies" table:

Path: https://Vision IP/mgmt/device/multi/config/rsIDSNewRulesTable/Test/,
The request JSON is in the following format:
{
{
"leadingDeviceIp": "172.16.22.46",
"deviceIpAddresses":["172.16.22.44","172.16.22.43","172.16.22.42"],
"requestData": {"rsIDSNewRulesStateTwo": "1",
"rsIDSNewRulesName": "Test"
"rsIDSNewRulesInstanceIdTwo": "0"
"rsIDSNewRulesPortmask": ""
"rsIDSNewRulesInstanceIdTwo": "1"
"rsIDSNewRulesDirection": "1"
"rsIDSNewRulesVlanTagGroup": ""
"rsIDSNewRulesMPLSRDGroup": ""
"rsIDSNewRulesProfileNetfloodThree": ""
"rsIDSNewRulesProfileDNSThree": ""
"rsIDSNewRulesProfileAppsecThree": ""
"rsIDSNewRulesProfileConlmt": ""
"rsIDSNewRulesProfileSynprotectionThree": ""
"rsIDSNewRulesActionTwo": "1"
}}

The following is an example of a request updating a row with the index "Test", specified in the path parameters, to the "Signature Profile" table:

Path: https://Vision IP/mgmt/device/multi/config/rsIDSSignaturesProfilesTable/Test/1/Risk/High/,

The request JSON is in the following format:
{
"leadingDeviceIp": "172.16.22.46",
"deviceIpAddresses":["172.16.22.44","172.16.22.43","172.16.22.42"],
"requestData": {"rsIDSSignaturesProfileName": "Test1"
"rsIDSSignaturesProfileRuleAttributeName": "High"
"rsIDSSignaturesProfileRuleAttributeType": "Risk"
"rsIDSSignaturesProfileRuleName": "1"
}
}

The following is an example of a request updating a row with the index "Entry1", specified in the path parameters, to the "White List" table:

Path: https://Vision IP/mgmt/device/multi/config/rsNewWhiteListTable/Entry1/,

The request JSON is in the following format:
{
"leadingDeviceIp": "172.16.22.46",
"deviceIpAddresses":["172.16.22.44","172.16.22.43","172.16.22.42"],
"requestData": {"rsNewWhiteListAction": "Test"
"rsNewWhiteListAllModules": "1"
"rsNewWhiteListDescriptionTwo": "Attach White List Entry"
"rsNewWhiteListDirection": "1"
"rsNewWhiteListDstNetwork": "SG4"
"rsNewWhiteListDstPortGroup": "rtsp"
"rsNewWhiteListHttpFloodModuleTwo": "1"
"rsNewWhiteListName": "Entry1"
"rsNewWhiteListProtocol": "0"
"rsNewWhiteListServerCrackingModuleTwo": "1"
"rsNewWhiteListSignatureModuleTwo": "1"
"rsNewWhiteListSrcNetwork": "SG2"
"rsNewWhiteListSrcPortGroup": "msn"
"rsNewWhiteListState": "1"
"rsNewWhiteListSynModuleTwo": "1"
}}

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

string

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

PathParameter

tableName

The name of the table.

true

string

PathParameter

indexes

The table index values according to the order defined in the MIB file.

true

string

BodyParameter

requestBody

The request JSON.

true

string

Responses
HTTP Code Description Schema

200

On success, of the operation on leading device, the response is a JSON in the following format:
{"ID":"R_<Unique Operation ID>","message":"The update table row operation started for the group of devices.(ID: R_<Unique Operation ID>) "}

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • application/json

Produces
  • application/json

Add Table Row to Device List

POST /mgmt/device/multi/config/{tableName}/{indexes : .+}
Description

Adds a row to a device table on the leading device and on the specified devices.
Error cases:

If wrong columns data is specified in the JSON body, the APSolute Vision server returns the error from a leading device.
If the path parameter is not provided, the HTTP 500 error code is returned with the error message.

The following is an example of a request adding a row with index "Test" (specified in the path parameter) to the "Network Protection Policies" table:

Path: https://Vision IP/mgmt/device/multi/config/rsIDSNewRulesTable/Test/,
The request JSON is in the following format:
{
{
"leadingDeviceIp": "172.16.22.46",
"deviceIpAddresses":["172.16.22.44","172.16.22.43","172.16.22.42"],
"requestData": {"rsIDSNewRulesStateTwo": "1",
"rsIDSNewRulesName": "Test"
"rsIDSNewRulesInstanceIdTwo": "0"
"rsIDSNewRulesPortmask": ""
"rsIDSNewRulesInstanceIdTwo": "1"
"rsIDSNewRulesDirection": "1"
"rsIDSNewRulesVlanTagGroup": ""
"rsIDSNewRulesMPLSRDGroup": ""
"rsIDSNewRulesProfileNetfloodThree": ""
"rsIDSNewRulesProfileDNSThree": ""
"rsIDSNewRulesProfileAppsecThree": ""
"rsIDSNewRulesProfileConlmt": ""
"rsIDSNewRulesProfileSynprotectionThree": ""
"rsIDSNewRulesActionTwo": "1"
}}

The following is an example of a request adding a row with the index "Test", specified in the path parameters, to the "Signature Profile" table:

Path: https://Vision IP/mgmt/device/multi/config/rsIDSSignaturesProfilesTable/Test/1/Risk/High/,

The request JSON is in the following format:
{
"leadingDeviceIp": "172.16.22.46",
"deviceIpAddresses":["172.16.22.44","172.16.22.43","172.16.22.42"],
"requestData": {"rsIDSSignaturesProfileName": "Test1"
"rsIDSSignaturesProfileRuleAttributeName": "High"
"rsIDSSignaturesProfileRuleAttributeType": "Risk"
"rsIDSSignaturesProfileRuleName": "1"
}
}

The following is an example of a request adding a row with the index "Entry1", specified in the path parameters, to the "White List" table:

Path: https://Vision IP/mgmt/device/multi/config/rsNewWhiteListTable/Entry1/,

The request JSON is in the following format:
{
"leadingDeviceIp": "172.16.22.46",
"deviceIpAddresses":["172.16.22.44","172.16.22.43","172.16.22.42"],
"requestData": {"rsNewWhiteListAction": "Test"
"rsNewWhiteListAllModules": "1"
"rsNewWhiteListDescriptionTwo": "Attach White List Entry"
"rsNewWhiteListDirection": "1"
"rsNewWhiteListDstNetwork": "SG4"
"rsNewWhiteListDstPortGroup": "rtsp"
"rsNewWhiteListHttpFloodModuleTwo": "1"
"rsNewWhiteListName": "Entry1"
"rsNewWhiteListProtocol": "0"
"rsNewWhiteListServerCrackingModuleTwo": "1"
"rsNewWhiteListSignatureModuleTwo": "1"
"rsNewWhiteListSrcNetwork": "SG2"
"rsNewWhiteListSrcPortGroup": "msn"
"rsNewWhiteListState": "1"
"rsNewWhiteListSynModuleTwo": "1"
}}

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

string

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

PathParameter

tableName

The name of the table.

true

string

PathParameter

indexes

The table index values according to the order defined in the MIB file.

true

string

BodyParameter

requestBody

The request JSON.

true

string

Responses
HTTP Code Description Schema

200

On success, of the operation on leading device, the response is a JSON in the following format:
{"ID":"R_<Unique Operation ID>","message":"The create table row operation started for the group of devices.(ID: R_<Unique Operation ID>) "}

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • application/json

Produces
  • application/json

Delete Table Row from Device List

DELETE /mgmt/device/multi/config/{tableName}/{indexes : .+}
Description

Deletes a row from the leading device table and from the table on all specified devices.
Error cases:

If the wrong index is specified in the path, the APSolute Vision server returns the error from a leading device.
If the path parameter is not provided, the HTTP 500 error code is returned with the error message.

The following is an example of a request to delete a row with index "Test" (specified in the path parameter) from the "Network Protection Policies" table:

Path: https://Vision IP/mgmt/device/multi/config/rsIDSNewRulesTable/Test/,
The request JSON is in the following format:
{

"leadingDeviceIp": "172.16.22.46",
"deviceIpAddresses":["172.16.22.44","172.16.22.43","172.16.22.42"]
}

The following is an example of a request deleting a row with the indexes "Test", "1', "Risk", "High", specified in the path parameters, from the "Signature Profile" table:

Path: https://Vision IP/mgmt/device/multi/config/rsIDSSignaturesProfilesTable/Test/1/Risk/High/,

The request JSON is in the following format:
{
"leadingDeviceIp": "172.16.22.46",
"deviceIpAddresses":["172.16.22.44","172.16.22.43","172.16.22.42"]
}

The following is an example of a request deleting a row with the index "Entry1", specified in the path parameters, from the "White List" table:

Path: https://Vision IP/mgmt/device/multi/config/rsNewWhiteListTable/Entry1/,

The request JSON is in the following format:
{
"leadingDeviceIp": "172.16.22.46",
"deviceIpAddresses":["172.16.22.44","172.16.22.43","172.16.22.42"]
}

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

string

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

PathParameter

tableName

The name of the table.

true

string

PathParameter

indexes

The table index values according to the order defined in the MIB file.

true

string

BodyParameter

requestBody

The request JSON.

true

string

Responses
HTTP Code Description Schema

200

On success, of the operation on leading device, the response is a JSON in the following format:
{"ID":"R_<Unique Operation ID>","message":"The delete table row operation started for the group of devices.(ID: R_<Unique Operation ID>) "}

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • application/json

Produces
  • application/json

Update Scalar on Device List

PUT /mgmt/device/multi/config
Description

Updates single variable (scalar) values on the leading device and on all specified devices.
Error condition regarding the leading device:

If the wrong variable values are specified in the JSON body, the APSolute Vision server returns device error message.

Error condition regarding the remaining devices:

If the wrong variable values are specified in the JSON body, the device error message will appear in the summarizing message on the client and in the summarizing alert.

The following is an example of a request to update variable (scalar) values on the leading device and on all specified devices:

Path: https://Vision IP/mgmt/device/multi/config/,
The request JSON is in the following format:
{
"leadingDeviceIp": "172.16.162.7",
"deviceIpAddresses":["172.16.162.1","172.16.162.2","172.16.162.4"],
"requestData": {"agMgmtNewCfgRadius": "1",
"agMgmtNewCfgTacacs": "2",
"agMgmtNewCfgSyslog": "2",
"agMgmtNewCfgSnmp": "2",
"agMgmtNewCfgTftp": "2",
"agMgmtNewCfgReport": "2"
}
}

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

string

HeaderParameter

headers

Original request HTTP headers.

true

ref

BodyParameter

requestBody

Request JSON.

true

string

Responses
HTTP Code Description Schema

200

On success, of the operation on leading device, the response is a JSON in the following format:
{"ID":"R_22886","message":"The update scalars operation started for the group of devices. (ID: R_22886) "}

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • application/json

Produces
  • application/json

Send DNS Key to Device List

POST /mgmt/device/multi/config/dnskeyimport
Description

Uploads the DNS Key text to the specified devices.

Query parameters are:
"id" - The DNS Key unique identifier.
"type" of file; The value should be "zone" for DNS Key.
"passphrase" - The password for the DNS keys encryption.
The rest are application specific parameters.

The following is an example of a request uploading a key with index "NewTextDNS" ,specified in the query parameter, to the specified devices:

Path: https://Vision IP/mgmt/device/multi/config/dnskeyimport?id=NewTextDNS&type=zone&state=1&passphrase=radware&keysz=1024&hash=1&ttl=86400&exp=2419200&rollover=604800&sigval=604800&sigPUB=302400,
The request body is in the following format:
{
"requestData":"LS0tLS1CRUdJTiBSU0EgUFJJV…​.",
{
"leadingDeviceIp": "172.16.22.46",
"deviceIpAddresses":["172.16.22.44","172.16.22.43","172.16.22.42"]
}

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

string

HeaderParameter

headers

The original request HTTP headers.

true

ref

PathParameter

uriInfo

The request URI.

true

ref

BodyParameter

requestBody

The request JSON.

true

string

Responses
HTTP Code Description Schema

200

On success, of the operation on leading device, the response is a JSON in the following format:
{"ID":"R_<Unique Operation ID>","message":"The Upload DNS Key as Text operation started for the group of devices. (ID: R_<Unique Operation ID>) "}

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Produces
  • application/json

Perform Save on Device List

POST /mgmt/device/multi/config/save
Description

Activates the Save action on each of the specified Alteon or LinkProof NG devices.
The following is an example of a request to perform the Save action on the specified Alteon devices:

Path: https://Vision IP/mgmt/device/multi/config/save,
The request JSON is in the following format:
{
"deviceIpAddresses":["172.16.162.1","172.16.162.2"]
}

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

string

PathParameter

uriInfo

Request URI.

true

ref

BodyParameter

requestBody

Request JSON.

true

string

Responses
HTTP Code Description Schema

200

On operation start, the response is a JSON in the following format:
{"ID":"R_<Unique Operation ID>","message":"The save operation started for the group of devices. See the Alerts browser for details. (ID: R_<Unique Operation ID>) "}

No Content

500

On failure the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • application/json

Produces
  • text/plain

  • application/json

Perform Apply on Device List

POST /mgmt/device/multi/config/apply
Description

Activates the Apply action on each of the specified Alteon or LinkProof NG devices.
The following is an example of a request to perform the Apply action on the specified Alteon devices:

Path: https://Vision IP/mgmt/device/multi/config/apply,
The request JSON is in the following format:
{
"deviceIpAddresses":["172.16.162.1","172.16.162.2"]
}

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

string

PathParameter

uriInfo

Request URI.

true

ref

BodyParameter

requestBody

Request JSON.

true

string

Responses
HTTP Code Description Schema

200

On operation start, the response is a JSON in the following format:
{"ID":"R_<Unique Operation ID>","message":"The apply operation started for the group of devices. See the Alerts browser for details. (ID: R_<Unique Operation ID>) "}

No Content

500

On failure the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • application/json

Produces
  • text/plain

  • application/json

General-SystemConfig

Upload Policy Template to Server

POST /mgmt/system/config/action/uploadtemplate
Description

Uploads a DefensePro configuration template to the APSolute Vision server

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

MultipartFormDataInput

HeaderParameter

headers

Original request HTTP headers

true

ref

QueryParameter

uriInfo

Request URI

true

ref

BodyParameter

multipartFormDataInput

The file bytes as multipart.

true

MultipartFormDataInput

Responses
HTTP Code Description Schema

200

On success, the response is a JSON in the following format {"status": "ok", "jsessionid": "sessionid"}

No Content

500

On failure, the response is a JSON in the following format {"status": "error", "message": "<Message>" …​}

No Content

Consumes
  • multipart/form-data

Produces
  • application/json

Perform Action

POST /mgmt/system/config/action/{actionName}
Description

Performs an action via the APSolute Vision server.
Supported actions are:
"Uploads the DefensePro configuration template to DefensePro devices"
;"Register the APSolute Vision server to receive notifications from a group of devices"

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

string

HeaderParameter

headers

Original request HTTP headers

true

ref

QueryParameter

uriInfo

Request URI

true

ref

PathParameter

actionName

Action name:
"importtemplatelist"
"eventregister"

true

string

BodyParameter

requestBody

The JSON body of the request is in the following format

{
"deviceIpAddresses":
[
"<IP Address>",
"IP Address", …​
],
"templateNames":
[
"<First Template Name>,…​,
<N-th Template Name> "
]}

true

string

Responses
HTTP Code Description Schema

200

The operation is performed in the background after the success response is returned as a JSON in the following format {"message":"The DefensePro Template List Import operation started for the group of devices. See the Alerts browser for details. (ID: R_32850)","ID":"32850"}

No Content

500

On failure, the response is a JSON in the following format {"status": "error", "message": "<Message>" …​}

No Content

Produces
  • application/json;charset=utf-8

General-SystemConfigItemList

Get Alerts

GET /mgmt/system/config/itemlist/alert
Description

Retrieves APSolute Vision alerts (alerts from the APSolute Vision Alert Browser).
The following is an example of a request retrieving the APSolute Vision alerts :

"Path: https://Vision IP/mgmt/system/config/itemlist/alert?page=1&filter=module:DEVICE_GENERAL,deviceType:DEFENSE_PRO,severity:MAJOR,raisedTime:2015-05-04 07:00:00&filtertype=any&maxrows=50

The following is a response example:

"alerts": [50]
{
"dbId": 3563
"module": "DEVICE_GENERAL"
"deviceType": "DEFENSE_PRO"
"severity": "MAJOR"
"raisedTime": 1430657303000
"message": "User radware failed uploading file Signature to device DP 91 - 6.12 - 172.16.22.91."
"userName": "radware"
"deviceOrmId": "2c9127b84d18d4e9014d18e83fcf005f"
"deviceIp": "172.16.22.91"
"deviceName": "DP 91 - 6.12"
"trapSid": null
"port": null
"cleared": false
"clearedTime": null
"acknowledged": false
"acknowledgedTime": null
"mailed": false
"repeatedMessageKey": null
"originatedFromAnAuditMessage": false
"messageAsOneLineString": "User radware failed uploading file Signature to device DP 91 - 6.12 - 172.16.22.91."
"}
"1": {
"dbId": 3537
"module": "DEVICE_GENERAL"
"deviceType": "DEFENSE_PRO"
"severity": "MAJOR"
"raisedTime": 1430657177000
"message": "User radware failed uploading file Signature to device DP 91 - 6.12 - 172.16.22.91."
"userName": "radware"
"deviceOrmId": "2c9127b84d18d4e9014d18e83fcf005f"
"deviceIp": "172.16.22.91"
"deviceName": "DP 91 - 6.12"
"trapSid": null
"port": null
"cleared": false
"clearedTime": null
"acknowledged": false
"acknowledgedTime": null
"mailed": false
"repeatedMessageKey": null
"originatedFromAnAuditMessage": false
"messageAsOneLineString": "User radware failed uploading file Signature to device DP 91 - 6.12 - 172.16.22.91."
}]

Parameters
Type Name Description Required Schema Default

QueryParameter

page

Number of the alert page.

true

ref

QueryParameter

props

Column names to be retrieved. When this optional parameter is not specified, all columns from the "Alert" table are returned.

true

ref

QueryParameter

filter

Filter string constrained from the following parts:

module - The alert type, which can be one of the following:
DEVICE_SECURITY - Security alerts from a device.
DEVICE_GENERAL - Alerts from the device when the configuration changes or user connects to device.
INSITE_GENERAL - APSolute Vision alerts.
INSITE_CONFIGURATION - APSolute Vision configuration alerts.
INSITE_CONTROL - APSolute Vision alerts.

deviceType - The device types in APSolute Vision: DEFENSE_PRO, LINKPROOF, ALTEON", APPWALL, DEFENSE_FLOW, MANAGEMENT_SERVER

severity - Alert severity: CRITICAL, MAJOR", MINOR, WARNING, INFO

raisedTime - The alert creation time if format "yyyy-mm-dd hh:mm:ss"

"The filter example:
"module:DEVICE_GENERAL,deviceType:DEFENSE_PRO,severity:MAJOR,raisedTime:2015-05-04 07:00:00".

true

ref

QueryParameter

filtertype

Filter type.
Values:
exact - Requires the full match of the provided filter
any - Requires inclusion of the provided filter.
For data type fields, the applied filter is always "Greater Than", despite the specified filter type.

true

ref

QueryParameter

maxrows

Maximum number of rows to return.

true

ref

Responses
HTTP Code Description Schema

200

success

AlertsInfoDto array

500

On failure, the response is a JSON in the following format {"status": "error", "message": "<Message>" …​}

No Content

Produces
  • application/json

Delete an Item from the Server

DELETE /mgmt/system/config/itemlist/{item}/{id}
Description

Deletes an APSolute Vision item from the list. Deletes DefensePro configuration templates from the APSolute Vision server.

Available item types in APSolute Vision:

"user" - The APSolute Vision user.
"deviceconfigurationfiles" - Device configuration file downloaded and stored on APSolute Vision.
"alltemplates" - DefensePro configuration templates downloaded and stored on APSolute Vision.

Parameters
Type Name Description Required Schema Default

PathParameter

item

Item type. For a DefensePro configuration template, use: "alltemplates"

true

string

PathParameter

id

DefensePro configuration Template ID, retrieved from the APSolute Vision server.

true

string

Responses
HTTP Code Description Schema

200

On success, the response is a JSON in the following format
{
"status": "ok"
}

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text"
}

No Content

Produces
  • application/json

Download Policy Templates from Server

GET /mgmt/system/config/itemlist/alltemplates
Description

Retrieves DefensePro configuration templates from the APSolute Vision server.

Query parameter:
"filter" - Filter to retrieve the data.
Filter parts:
exportedFileType - The type of exported objects. Values: SERVER_PROTECTION_TEMPLATE, NETWORK_PROTECTION_TEMPLATE
filtertype - The type of filter.
Values: "exact" - Requires the full match of the provided filter
any
- Requires inclusion of the provided filter
Filter example: "exportedFileType:SERVER_PROTECTION_TEMPLATE&filtertype=exact&filterRange=700"

Parameters
Type Name Description Required Schema Default

QueryParameter

filter

Filter used for retrieving of DefensePro configuration templates.

true

string

Responses
HTTP Code Description Schema

200

success

DeviceExportedFile array

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text".
}

No Content

Produces
  • application/json

Get Managed Device List

GET /mgmt/system/config/itemlist/alldevices
Description

Retrieves the list of managed devices.

Responses
HTTP Code Description Schema

200

success

ThinSiteTransformerDTO array

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text"
}

No Content

Produces
  • application/json

General-SystemConfigTree

Get Device Data

GET /mgmt/system/config/tree/device/byip/{ip}
Description

Retrieves device information, device properties, and status from the APSolute Vision server.

Parameters
Type Name Description Required Schema Default

PathParameter

ip

The IP address of the managed device.

true

ref

Responses
HTTP Code Description Schema

200

success

Device

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Produces
  • application/json

Lock Device

POST /mgmt/system/config/tree/device/byip/{ip}/lock
Description

Locks the device in the APSolute Vision server.

Parameters
Type Name Description Required Schema Default

PathParameter

ip

IP address of the device to lock.

true

ref

Responses
HTTP Code Description Schema

200

No Content

500

On failure, the response is a JSON in the following format {"status": "error", "message": "<Message>" …​}

No Content

Consumes
  • application/json

Unlock Device

POST /mgmt/system/config/tree/device/byip/{ip}/unlock
Description

Unlocks the device on the APSolute Vision server.

Parameters
Type Name Description Required Schema Default

PathParameter

ip

IP address of the device to unlock.

true

ref

Responses
HTTP Code Description Schema

200

On success, the response is a JSON in the following format:
{ "status" : "ok" }

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text"
}

No Content

Consumes
  • application/json

Add Device to the Server

POST /mgmt/system/config/tree/device
Description

Adds a device to APSolute Vision.
Error cases:

If the device name already exists in the APSoluteVision server, the server returns the error: Node name in the tree must be unique. Please enter another name. (ID:M_00023)

If the device IP address is already used by another device connected to the APSolute Vision server, the server returns the error: Device with IP Address 1.1.1.1 already exists, please use a different IP Address. (ID:M_00302) (ID:M_00023)

The following is an example of a request to add an Alteon device with IP Address 1.1.1.1 to APSolute Vision:

Path: https://Vision IP/mgmt/system/config/tree/device,
The request JSON is in the following format:
{
"deviceSetup":
{
"deviceAccess":
{
"cliPassword": "admin",
"cliPort": "22",
"exclusivelyReceiveDeviceEvents": "false",
"httpPassword": "admin",
"httpPort": "80",
"httpUsername": "admin",
"httpsPassword": "admin",
"httpsPort": "443",
"httpsUsername": "admin",
"managementIp": "1.1.1.1",
"registerDeviceEvents": "true",
"snmpV1ReadCommunity": "public",
"snmpV1WriteCommunity": "private",
"snmpV2ReadCommunity": "public",
"snmpV2WriteCommunity": "private",
"snmpVersion": "SNMP_V2",
"verifyHttpsCredentials": "true"
},
},
"name": "Alteon 1.1.1.1",
"parentOrmID": "303981ae4e7295d4014e7295e85d0015",
"type": "Alteon"}

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

string

BodyParameter

devicePojoStr

Request JSON

true

string

Responses
HTTP Code Description Schema

200

On success, the response is a JSON in the following format:
{ "status" : "ok" }

No Content

500

On failure, the response is a JSON in the following format
{
"status": "error",
"message": "Message Text…​"
}

No Content

Consumes
  • application/json

General-SystemMonitor

Get Alerts

GET /mgmt/system/monitor/itemlist/alert
Description

Retrieves the APSolute Vision alerts from the alert browser.

Parameters
Type Name Description Required Schema Default

QueryParameter

page

Number of the alert page, where there are 50 alerts per page.

true

ref

QueryParameter

props

Column names to be retrieved. When this optional parameter is not specified, all columns from the "Alert" table are returned.

true

ref

Responses
HTTP Code Description Schema

200

success

AlertsInfoDto array

500

On failure, the response is a JSON in the following format:
{
"status": "error",
"message": "Message Text"
}

No Content

Produces
  • application/json

General-SystemUser

Server Login

POST /mgmt/system/user/login
Description

Logs in to APSolute Vision using the configured mechanism Local/TACACS+/RADIUS.
APSolute Vision REST API uses the standard HTTP session cookie mechanism.
The successful login response returns the session ID that should be sent inside the cookie in each subsequent REST request.

The following is an example of request headers, including a cookie with session ID:

Request Headers

Accept: /
Accept-Encoding: gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8,ru;q=0.6,he;q=0.4
Connection: keep-alive
Content-Type: text/plain; charset=utf-8
<b>Cookie: JSESSIONID=6C270E7CCC972D79873EFCD687AF8039</b>
Host: 172.17.197.60
User-Agent: Mozilla/5.0 (Windows NT 5.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.135 Safari/537.36

Parameters
Type Name Description Required Schema Default

BodyParameter

body

JSON including the username and the password in the form: {username: "user", password: "pass"}

true

[text/json]

Responses
HTTP Code Description Schema

200

On successful login the response is a JSON in the following format
{
"status": "ok",
"jsessionid": "sessionid"
}

No Content

401

On unsuccessful login the response is a JSON in the following format
{
"status": "error",
"message": "Invalid Username or invalid Password. Re-enter."
}

No Content

Consumes
  • application/json

Produces
  • application/json

Server Logout

POST /mgmt/system/user/logout
Responses
HTTP Code Description Schema

200

On successful logout, the response is a JSON in the following format {"status": "ok"}

No Content

SecurityMonitoring-AttackDetails

Get Cracking Attack Details: Scan Details Section

POST /mgmt/monitor/security/dp/attacks/details/cracking/event
Description

Retrieves the Cracking Attack Details: Scan Details tab.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

DetailsRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

ProtectEvent

Produces
  • application/json

Download Capture File

GET /mgmt/monitor/security/dp/attacks/details/capture/{attackIpsId}
Description

Downloads a capture file for the specified attack.

Parameters
Type Name Description Required Schema Default

QueryParameter

JSESSIONID

false

string

PathParameter

attackIpsId

true

string

Check Capture File Availability

POST /mgmt/monitor/security/dp/attacks/details/capture/{attackIpsId}
Description

Checks whether a capture file is available for the specified attack.

Parameters
Type Name Description Required Schema Default

PathParameter

attackIpsId

true

string

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

boolean

Produces
  • application/json

Get Behavioral DoS Attack Details: Characteristics Section

POST /mgmt/monitor/security/dp/attacks/details/bdos/characteristics
Description

Retrieves the Behavioral DoS Attack Details: Characteristics tab.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

DetailsRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

Characteristics

Produces
  • application/json

Get Anti-Scanning Attack Details: Scan Details Section

POST /mgmt/monitor/security/dp/attacks/details/antiscanning/events
Description

Retrieves the Anti-Scanning Attack Details: Scan Details tab.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

DetailsRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

EventSample array

Produces
  • application/json

Get SYN Flood Attack Details: Info Section

POST /mgmt/monitor/security/dp/attacks/details/synflood
Description

Retrieves the SYN Flood Attack Details: Info tab.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

DetailsRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

SynFlood

Produces
  • application/json

Get HTTP Attack Details: Info Section

POST /mgmt/monitor/security/dp/attacks/details/mgmt/monitor/security/dp/http/info
Description

Retrieves the HTTP Attack Details: Info tab.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

DetailsRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

HttpFloodInfo

Produces
  • application/json

Get Anti-Scanning Attack Details: Info Section

POST /mgmt/monitor/security/dp/attacks/details/antiscanning/details
Description

Retrieves the Anti-Scanning Attack Details: Info tab.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

DetailsRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

AntiScanningDetails

Produces
  • application/json

Get Behavioral DoS Attack Details: Attack Statistics Table Section

POST /mgmt/monitor/security/dp/attacks/details/bdos/statistics/table
Description

Retrieves the Behavioral DoS Attack Details: Attack Statistics Table tab.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

DetailsRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

StatisticsTableRow array

Produces
  • application/json

Get DNS Attack Details: Footprint Section

POST /mgmt/monitor/security/dp/attacks/details/dns/footprint
Description

Retrieves the DNS Attack Details: Footprint tab.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

DetailsRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

DnsFootprint

Produces
  • application/json

Get Sampled Data CSV File Token

POST /mgmt/monitor/security/dp/attacks/details/sample-data/csv
Description

Retrieves a token used to download the Sampled Data CSV file.
Returns a token. To download the file, use /mgmt/monitor/security/dp/csv/download/{token} service.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

GeneralRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

string

Produces
  • application/text

Get Behavioral DoS Attack Details: Footprint Section

POST /mgmt/monitor/security/dp/attacks/details/bdos/footprint
Description

Retrieve Behavioral DoS Attack Details: Footprint tab.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

DetailsRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

Footprint

Produces
  • application/json

Get Behavioral DoS Attack Details: Attack Sampled Data

POST /mgmt/monitor/security/dp/attacks/details/sample-data
Description

Retrieves the Attack Sampled Data. Required parameters: attackIpsId, start, count

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

GeneralRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

DocumentationSampleDataResponse array

Produces
  • application/json

Get : Characteristics Section

POST /mgmt/monitor/security/dp/attacks/details/dns/characteristics
Description

Retrieves the DNS Attack Details: Characteristics tab.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

DetailsRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

DnsCharacteristics

Produces
  • application/json

Get DoS Attack Details: Info Section

POST /mgmt/monitor/security/dp/attacks/details/dos
Description

Retrieves the DoS Attack Details: Info tab.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

DetailsRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

Dos

Produces
  • application/json

Get Cracking Attack Details: Info Section

POST /mgmt/monitor/security/dp/attacks/details/cracking/details
Description

Retrieves the Cracking Attack Details: Info tab.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

DetailsRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

BlockingDetails

Produces
  • application/json

Get Behavioral DoS (TCP) Attack Details: Attack Statistics Chart Section

POST /mgmt/monitor/security/dp/attacks/details/bdos/statistics/tcp
Description

Retrieves the Behavioral DoS (TCP) Attack Details: Attack Statistics Chart tab.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

DetailsRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

Statistics

Produces
  • application/json

Get DNS Attack Details: Attack Statistics Graph Section

POST /mgmt/monitor/security/dp/attacks/details/dns/statistics
Description

Retrieves the DNS Attack Details: Attack Statistics Graph tab.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

DetailsRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

DnsStatistics

Produces
  • application/json

Get DNS Attack Details: Attack Statistics Table Section

POST /mgmt/monitor/security/dp/attacks/details/dns/statistics/table
Description

Retrieves the DNS Attack Details: Attack Statistics Table tab.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

DetailsRequest

HeaderParameter

JSESSIONID

false

string

Produces
  • application/json

Get Info Section, Region Field

POST /mgmt/monitor/security/dp/attacks/details/bdos/region
Description

Retrieves the Behavioral DoS Attack Details: Info tab, Region field.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

RegionRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

string

Produces
  • application/json

Get Behavioral DoS Attack Details (TCP): Attack Statistics Table tab

POST /mgmt/monitor/security/dp/attacks/details/bdos/statistics/table/tcp
Description

Retrieves the Behavioral DoS (TCP) Attack Details: Attack Statistics Table tab.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

DetailsRequest

HeaderParameter

JSESSIONID

false

string

Produces
  • application/json

Get Behavioral DoS Attack Details: Attack Statistics Graph Section

POST /mgmt/monitor/security/dp/attacks/details/bdos/statistics
Description

Retrieves the Behavioral DoS Attack Details: Attack Statistics Graph tab.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

DetailsRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

Statistics

Produces
  • application/json

Get HTTP Attack Details: Blocked Users Section

POST /mgmt/monitor/security/dp/attacks/details/mgmt/monitor/security/dp/http/blocked
Description

Retrieves the HTTP Attack Details: Blocked Users tab.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

DetailsRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

BlockedUser array

Produces
  • application/json

Get HTTP Attack Details: Attack Statistics Table Section

POST /mgmt/monitor/security/dp/attacks/details/mgmt/monitor/security/dp/http/statistics
Description

Retrieves the HTTP Attack Details: Attack Statistics Table tab.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

DetailsRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

HttpStatistics array

Produces
  • application/json

Get Anti-Scanning Attack Details: Footprint Section

POST /mgmt/monitor/security/dp/attacks/details/antiscanning/footprint
Description

Retrieves the Anti-Scanning Attack Details: Footprint tab.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

DetailsRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

AntiScanningFootprint

Produces
  • application/json

SecurityMonitoring-BDoS-Baseline-DefenseFlow

Get BDoS Traffic Monitoring Report, BDoS Traffic Statistics Section

POST /mgmt/monitor/security/df/protection/bdos/edge
Description

Retrieves the Suspected Edge and Attack Edge values.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

DFProtectionSimpleRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

DFBDosRealTimeEdge array

Produces
  • application/json

Get Behavioral DoS Traffic Monitoring Report, Statistics Table

POST /mgmt/monitor/security/df/protection/bdos/statistics
Description

Retrieves the Statistics Table

Parameters
Type Name Description Required Schema Default

HeaderParameter

JSESSIONID

false

string

BodyParameter

body

false

DFProtectionSimpleRequest

Responses
HTTP Code Description Schema

default

success

DFBDosRealTimeEdge array

Produces
  • application/json

SecurityMonitoring-CsvDownload

Download CSV File

GET /mgmt/monitor/security/dp/csv/download/{uid}
Description

The service receives a token and returns the CSV file.

Parameters
Type Name Description Required Schema Default

QueryParameter

JSESSIONID

false

string

PathParameter

uid

true

string

Produces
  • application/text

SecurityMonitoring-Devices

Get Device Properties for Monitored Device List

POST /mgmt/monitor/security/dp/devices/
Description

Retrieves full device information regarding devices that provide security monitoring information.
Request: array of deviceId, Response: Map[deviceId, Device]

Parameters
Type Name Description Required Schema Default

HeaderParameter

JSESSIONID

false

string

BodyParameter

body

false

string array

Responses
HTTP Code Description Schema

default

success

DeviceMapResponse

Produces
  • application/json

Get Basic Device Properties for Monitored Device List

GET /mgmt/monitor/security/dp/devices/all
Description

Retrieves the basic information regarding devices that provide security monitoring information.
The values of ports and policies in this service are empty. To retrieve full data use the service /devices.

Parameters
Type Name Description Required Schema Default

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

Device array

Produces
  • application/json

SecurityMonitoring-HttpReports

Get HTTP Request Size Distribution Reports

POST /mgmt/monitor/security/dp/http/distribution
Description

Retrieves the HTTP Request Size Distribution report.

Parameters
Type Name Description Required Schema Default

HeaderParameter

JSESSIONID

false

string

BodyParameter

body

false

ReportRequest

Responses
HTTP Code Description Schema

default

success

com.radware.novis.dp.model.http.distribution.UriValue]

Produces
  • application/json

Get Continuous Learning Statistics reports

POST /mgmt/monitor/security/dp/http/report
Description

Retrieves the Continuous Learning Statistics reports. The information for all of the sub-reports is returned in the same request.

Parameters
Type Name Description Required Schema Default

HeaderParameter

JSESSIONID

false

string

BodyParameter

body

false

ReportRequest

Produces
  • application/json

Get Hour-Specific Learning Statistics Reports

POST /mgmt/monitor/security/dp/http/week/{reportType}
Description

Retrieves the Hour-Specific Learning Statistics reports.
Use the report type parameter to specify the report type: get-post/outbound/other.

Parameters
Type Name Description Required Schema Default

HeaderParameter

JSESSIONID

false

string

PathParameter

reportType

true

string

BodyParameter

body

false

ReportRequest

Produces
  • application/json

SecurityMonitoring-HttpServers

HTTP servers

POST /mgmt/monitor/security/dp/http/servers
Description

Retrieves the list of HTTP servers for the specified device.

Parameters
Type Name Description Required Schema Default

HeaderParameter

JSESSIONID

false

string

BodyParameter

body

false

ServersRequest

Responses
HTTP Code Description Schema

default

success

Server array

Produces
  • application/json

SecurityMonitoring-ProtectionMonitoring

Get Traffic Monitoring Report and Traffic Statistics Section (part 1)

POST /mgmt/monitor/security/dp/protection/traffic/{reportType}/rate
Description

Retrieves the BDoS/DNS Traffic Monitoring Report and BDoS/DNS Traffic Statistics tab (part 1).
Retrieves the Total Traffic, Legitimate Traffic and Normal Edge values. Traffic rate service. The report type parameter should be bdos/dns.

Parameters
Type Name Description Required Schema Default

HeaderParameter

JSESSIONID

false

string

PathParameter

reportType

true

string

BodyParameter

body

false

NetworkRuleRequest

Responses
HTTP Code Description Schema

default

success

RateResult array

Produces
  • application/json

Get Attack Status Report

POST /mgmt/monitor/security/dp/protection/attack/status
Description

Retrieves the Attack Status Report (DNS or BDoS)

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

GeneralRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

BdosAttackStatusResult

Produces
  • application/json

Get Traffic Monitoring Report, Last Sample Statistics Section

POST /mgmt/monitor/security/dp/protection/table/{reportType}
Description

Retrieves the BDoS/DNS Traffic Monitoring Report, Last Sample Statistics tab
Sample statistics service. Report type parameter should be bdos/dns

Parameters
Type Name Description Required Schema Default

HeaderParameter

JSESSIONID

false

string

PathParameter

reportType

true

string

BodyParameter

body

false

NetworkRuleRequest

Responses
HTTP Code Description Schema

default

success

SampleStatisticsRow array

Produces
  • application/json

Get Traffic Monitoring Report and Traffic Statistics Section (part 2)

POST /mgmt/monitor/security/dp/protection/traffic/{reportType}/edge
Description

Retrieves the BDoS/DNS Traffic Monitoring Report and BDoS/DNS Traffic Statistics tab (part 2).
Retrieves the Suspected Edge and Attack Edge values. Traffic edge service. The report type parameter should be bdos/dns.

Parameters
Type Name Description Required Schema Default

HeaderParameter

JSESSIONID

false

string

PathParameter

reportType

true

string

BodyParameter

body

false

NetworkRuleRequest

Responses
HTTP Code Description Schema

default

success

EdgeResult array

Produces
  • application/json

Get Traffic Monitoring Report and Traffic Statistics Section (part 3)

POST /mgmt/monitor/security/dp/protection/status/{reportType}
Description

Retrieves the BDoS/DNS Traffic Monitoring Report, BDoS/DNS Traffic Statistics tab (part 3): Attack Status field.
Attack Status service. The report type parameter should be bdos/dns.

Parameters
Type Name Description Required Schema Default

HeaderParameter

JSESSIONID

false

string

PathParameter

reportType

true

string

BodyParameter

body

false

NetworkRuleRequest

Responses
HTTP Code Description Schema

default

success

WrappedString

Produces
  • application/json

SecurityMonitoring-SecurityDashboard

Get Drop intensity Information

POST /mgmt/monitor/security/dp/intensity/
Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

GeneralRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

Intensity

Produces
  • application/json

Download Security Attacks CSV

POST /mgmt/monitor/security/dp/attacks/csv
Description

Returns a token. To download the file use the following: /mgmt/monitor/security/dp/csv/download/{token}.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

GeneralRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

string

Produces
  • application/text

Get Attack Description

POST /mgmt/monitor/security/dp/attacks/description
Description

Retrieves the attack description for the relevant attack, based on the attack ID.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

RadwareRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

Description

Produces
  • application/json

Get Current Attacks Table and Ongoing Attacks Monitor

POST /mgmt/monitor/security/dp/attacks/
Description

Request filter enumeration format:
actionType - Can receive one of the following values (case sensitive): Forward, Proxy, Drop, Source Reset, Destination Reset, Source Destination Reset, Bypass, Challenge, Quarantine, Drop & Quarantine, Http 200 Ok, Http 200 Ok Reset Dest, Http 403 Forbidden, Http 403 Forbidden Reset Dest
attackRisk - Can receive one of the following values (case sensitive): Info, Low, Medium, High
attackProtocol - Can receive one of the following values (case sensitive): IP, TCP, UDP, ICMP, IGMP, Non-IP, SCTP, ICMPv6
threatGroup - Can receive one of the following values (case sensitive): Black List, Network Scans, Application DDoS, Intrusion, Packet Anomalies, Server Cracking, DDoS, Stateful ACL, Bandwidth Management
attackCategory - Can receive one of the following values (case sensitive): ACL, Anti-Scanning, Behavioral DoS, DoS, HTTP Flood, Intrusions, Server Cracking, SYN Flood, Anomalies, Stateful ACL, DNS Flood, Bandwidth Management
policyDirection - Can receive one of the following values (case sensitive): Inbound, Outbound, Both
attackStatus - Can receive one of the following values (case sensitive): Started, Terminated, Sampled, Occurred, Ongoing
direction - Can receive one of the following values (case sensitive): in, out
physicalPort - Can receive one of the following values (case sensitive): G-1, G-2, G-3, G-4, G-5, G-6, G-7, G-8, G-9, G-10, G-11, G-12, G-13, G-14, G-15, G-16, SFP-1, SFP-2, SFP-3, SFP-4, T-1, T-2, T-3, T-4, T-5, T-6, T-7, MNG-1, MNG-2, XG-1, XG-2, XG-3, XG-4, Multiple, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 125, 126, 127, 128

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

GeneralRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

DocumentationCurrentAttacksResponse

Produces
  • application/json

SecurityMonitoring-SecurityDashboard-DefenseFlow

Get DefenseFlow Current Attacks Table

POST /mgmt/monitor/security/df/attack
Description

Request filter enumeration format:
actionType - Can receive one of the following values (case sensitive): Forward, Proxy, Drop, Source Reset, Destination Reset, Source Destination Reset, Bypass, Challenge, Quarantine, Drop & Quarantine, Http 200 Ok, Http 200 Ok Reset Dest, Http 403 Forbidden, Http 403 Forbidden Reset Dest
attackRisk - Can receive one of the following values (case sensitive): Info, Low, Medium, High
attackProtocol - Can receive one of the following values (case sensitive): IP, TCP, UDP, ICMP, IGMP, Non-IP, SCTP, ICMPv6
threatGroup - Can receive one of the following values (case sensitive): Black List, Network Scans, Application DDoS, Intrusion, Packet Anomalies, Server Cracking, DDoS, Stateful ACL, Bandwidth Management
attackCategory - Can receive one of the following values (case sensitive): ACL, Anti-Scanning, Behavioral DoS, DoS, HTTP Flood, Intrusions, Server Cracking, SYN Flood, Anomalies, Stateful ACL, DNS Flood, Bandwidth Management
policyDirection - Can receive one of the following values (case sensitive): Inbound, Outbound, Both
attackStatus - Can receive one of the following values (case sensitive): Started, Terminated, Sampled, Occurred, Ongoing
direction - Can receive one of the following values (case sensitive): in, out
physicalPort - Can receive one of the following values (case sensitive): G-1, G-2, G-3, G-4, G-5, G-6, G-7, G-8, G-9, G-10, G-11, G-12, G-13, G-14, G-15, G-16, SFP-1, SFP-2, SFP-3, SFP-4, T-1, T-2, T-3, T-4, T-5, T-6, T-7, MNG-1, MNG-2, XG-1, XG-2, XG-3, XG-4, Multiple, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 125, 126, 127, 128

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

DFGeneralRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

TableResponse

Produces
  • application/json

Download SecurityAttacks Table as CSV

POST /mgmt/monitor/security/df/attack/csv
Description

Returns a token. To download the file, use the following: /csv/download/{token}.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

DFGeneralRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

string

Produces
  • application/text

Get DefenseFlow Ongoing BDoS Traffic Monitoring ReportAttack Monitor Drop Intensity Information

POST /mgmt/monitor/security/df/intensity
Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

DFGeneralRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

Intensity

Produces
  • application/json

SecurityMonitoring-TrafficMonitoring

Get Traffic Utilization Report, Traffic Authentication Statistics Section

POST /mgmt/monitor/security/dp/traffic/utilization/auth
Description

Required parameters: devices list, traffic, isPolicySelected, units.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

GeneralRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

TrafficAuth array

Produces
  • application/json

Get Traffic Utilization Report, Last Sample Statistics Section

POST /mgmt/monitor/security/dp/traffic/utilization/table
Description

Required parameters: devices list, traffic, isPolicySelected, units. The traffic parameter can receive one of the following values: Inbound, Outbound
The units parameter can receive one of the following values: Kbps, Packet/Sec, QPS.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

GeneralRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

TrafficUtilizationTableRow array

Produces
  • application/json

Get Connection Rate Report

POST /mgmt/monitor/security/dp/traffic/connections/rate
Description

Required parameters: devices list, range, protocol, isPolicySelected.
The protocol parameter can receive one of the following values: TCP, UDP, ALL.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

GeneralRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

ConnectionRateResult array

Produces
  • application/json

Get Concurrent Connections Report

POST /mgmt/monitor/security/dp/traffic/connections/concurrent
Description

Required parameters: devices list, range, protocol, isPolicySelected
The protocol parameter can receive one of the following values: TCP, UDP, ALL.

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

GeneralRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

ConcurrentConnection array

Produces
  • application/json

Get Traffic Utilization Report, Traffic Statistics Section

POST /mgmt/monitor/security/dp/traffic/utilization
Description

There should be a separate request for inbound and outbound traffic. Required parameters: devices list, traffic, protocol, isPolicySelected, units
The protocol parameter can receive one of the following values: UDP, TCP, ICMP, Other, All, SCTP, IGMP, DNS, HTTP
The traffic parameter can receive one of the following values: Inbound, Outbound
The units parameter can receive one of the following values: Kbps, Packet/Sec, QPS

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

GeneralRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

TrafficUtilizationValue array

Produces
  • application/json

SecurityMonitoring-TrafficMonitoring-DefenseFlow

Get DefenseFlow Traffic Utilization Report, Last Sample Statistics Section

POST /mgmt/monitor/security/df/traffic/utilization/table
Description

Required parameters: devices list, traffic, isPolicySelected, units. The traffic parameter can receive one of the following values: Inbound, Outbound
The units parameter can receive one of the following values: Kbps, Packet/Sec, QPS

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

DFGeneralRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

TrafficUtilizationTableRow array

Produces
  • application/json

Get DefenseFlow Traffic Utilization Report, Traffic Statistics Section

POST /mgmt/monitor/security/df/traffic/utilization
Description

Sends a separate request for inbound and outbound traffic. Required parameters: devices list, traffic, protocol, isPolicySelected, units

The protocol parameter can receive one of the following values: UDP, TCP, ICMP, Other, All, SCTP, IGMP, DNS, HTTP
The traffic parameter can receive one of the following values: Inbound, Outbound
The units parameter can receive one of the following values: Kbps, Packet/Sec, QPS

Parameters
Type Name Description Required Schema Default

BodyParameter

body

false

DFGeneralRequest

HeaderParameter

JSESSIONID

false

string

Responses
HTTP Code Description Schema

default

success

TrafficUtilizationChartValue array

Produces
  • application/json

Definitions

Agent

Name Description Required Schema Default

agentId

false

string

formattedLastUsed

false

string

description

false

string

real

false

boolean

version

false

string

uuid

false

string

enabled

false

boolean

lastUsed

false

string (date-time)

protocol

false

integer (int32)

deleted

false

boolean

port

false

integer (int32)

host

false

string

troubleshooting

false

boolean

http

false

boolean

disabled

false

boolean

id

false

integer (int32)

cipher_key

false

string

cipherKey

false

boolean

Alert

Name Description Required Schema Default

deviceType

false

[DeviceTypeEnum]

severity

false

[AlertSeverityEnum]

deviceIp

false

string

acknowledged

false

boolean

module

false

[AlertModuleEnum]

trapSid

false

string

deviceOrmId

false

string

raisedTime

false

string (date-time)

messageAsOneLineString

false

string

message

false

string

userName

false

string

deviceName

false

string

repeatedMessageKey

false

string

alertKeysEnum

false

[AlertKeysEnum]

port

false

string

dbId

false

integer (int64)

originatedFromAnAuditMessage

false

boolean

alertId

false

integer (int32)

alertKeyArgs

false

[Object] array

cleared

false

boolean

clearedTime

false

string (date-time)

mailed

false

boolean

acknowledgedTime

false

string (date-time)

AlertSeverityPercentage

Name Description Required Schema Default

warning

false

integer (int32)

error

false

integer (int32)

AlertsInfoDto

Name Description Required Schema Default

alerts

false

Alert array

alertsSummary

false

int]

numOfPages

false

integer (int32)

criticalAlerts

false

Alert array

totalNumberOfRows

false

integer (int32)

AntiScanningDetails

Name Description Required Schema Default

scanningActionReason

false

string

sourceAddress

false

string

attackIpsId

false

string

blockingDuration

false

integer (int64)

scanningActualAction

false

string

startTime

false

integer (int64)

avgTimeBetweenEvents

false

number (float)

numberOfEvents

false

integer (int64)

AntiScanningFootprint

Name Description Required Schema Default

strictnessLevel

false

string

attackIpsId

false

string

startTime

false

integer (int64)

text

false

string

direction

false

string

ApmServerConfiguredOnDevice

Name Description Required Schema Default

deviceIp

false

string

ormVersion

false

integer (int32)

apmServerIp

false

string

ormID

false

string

name

false

string

description

false

string

device

false

Device

Application

Application

Name Description Required Schema Default

maxEventTypes

false

integer (int32)

transactionTypesInUse

false

integer (int32)

name

The application name.

false

string

description

false

string

id

The application ID.

false

integer (int32)

permissionName

The permission on this application VIEW/MANAGE.

false

string

eventTypesPercentageUsage

false

string

ApplicationAlertSensitivity

Name Description Required Schema Default

high

false

Sensitivity

low

false

Sensitivity

medium

false

Sensitivity

ApplicationThresholdFailed

Name Description Required Schema Default

timeframe

false

Timeframe

timeframeId

false

integer (int32)

application

false

Application

alert

false

ThresholdAlert

id

false

integer (int32)

alertId

false

integer (int32)

alertEnabled

false

boolean

applicationId

false

integer (int32)

ApplicationThresholdGeoSla

Name Description Required Schema Default

alert

false

ThresholdAlert

locationId

false

integer (int32)

thresholdSla

false

ApplicationThresholdSla

id

false

integer (int32)

alertId

false

integer (int32)

alertEnabled

false

boolean

slaValue

false

integer (int32)

ApplicationThresholdSla

Name Description Required Schema Default

timeframe

false

Timeframe

timeframeId

false

integer (int32)

application

false

Application

alert

false

ThresholdAlert

slaMode

false

string

id

false

integer (int32)

alertId

false

integer (int32)

alertEnabled

false

boolean

applicationId

false

integer (int32)

datacenterSla

false

integer (int32)

desktopGeoSla

false

ApplicationThresholdGeoSla array

ApplicationsList

Applications List

Name Description Required Schema Default

offset

The offset in the results list.

true

integer (int32)

totalApplicationsCount

Total number of applications returned in the result.

true

integer (int32)

limit

The maximum number of results requested.

true

integer (int32)

hasNext

Specifies whether a next page of results exists.

true

boolean

list

false

[T] array

results

false

integer (int32)

apps

false

Application array

BdosAttackStatusResult

Name Description Required Schema Default

table

false

Map[AttackStatusColumn,string]]

BigInteger

Name Description Required Schema Default

bitLength

false

integer (int32)

signum

false

integer (int32)

lowestSetBit

false

integer (int32)

bitCount

false

integer (int32)

BlockedUser

Name Description Required Schema Default

sourceNums

false

integer (int32)

ip

false

string

requestUri

false

string

status

false

string

BlockingDetails

Name Description Required Schema Default

blockDuration

false

integer (int32)

attackIpsId

false

string

numEvents

false

integer (int32)

startTime

false

integer (int64)

avgTimeBetweenEvents

false

number (float)

CellDto

Name Description Required Schema Default

type

false

[GMTypesEnumDto]

valueAsStr

false

string

isindex

false

boolean

columnName

false

string

Characteristics

Name Description Required Schema Default

destinationPort

false

string

icmpMessageType

false

string

dnsQCount

false

string

sourcePort

false

string

flowLabel

false

string

fragmentOffset

false

string

attackIpsId

false

string

packetSize

false

string

ttl

false

string

dnsId

false

string

destinationIP

false

string

fragment

false

string

l4Checksum

false

string

dnsQuery

false

string

sourceIp

false

string

controllerState

false

string

tcpSequenceNumber

false

string

ipIdNumber

false

string

toS

false

string

startTime

false

integer (int64)

ConcurrentConnection

Name Description Required Schema Default

secondsFromNow

false

integer (int32)

chartValue

false

ConcurrentConnectionChartValue

ConcurrentConnectionChartValue

Name Description Required Schema Default

udpValue

false

integer (int32)

tcpValue

false

integer (int32)

ConnectionRateResult

Name Description Required Schema Default

secondsFromNow

false

integer (int32)

inbound

false

integer (int32)

outbound

false

integer (int32)

CsvConfig

Name Description Required Schema Default

timezone

false

string

titles

false

string array

fields

false

string array

CurrentAttack

Name Description Required Schema Default

deviceIp

false

string

sourcePort

false

string

vlanTag

false

string

packetCount

false

integer (int64)

destMsisdn

false

string

attackCategory

false

string

destPort

false

string

threatGroup

false

string

destAddress

false

string

startTime

false

integer (int64)

radwareId

false

integer (int64)

direction

false

string

attackName

false

string

mplsRd

false

string

attackRisk

false

string

attackIpsId

false

string

sourceAddress

false

string

policyName

false

string

srcMsisdn

false

string

physicalPort

false

string

actionType

false

string

ormId

false

string

attackProtocol

false

string

packetBandwidth

false

integer (int64)

endTime

false

integer (int64)

attackStatus

false

string

DFBDosRealTimeEdge

Name Description Required Schema Default

timeStamp

false

string (date-time)

suspectedAttack

false

number (float)

legitimateTraffic

false

number (float)

secondsFromNow

false

integer (int32)

normal

false

number (float)

normalEdge

false

number (float)

doa

false

integer (int32)

protection

false

[ProtectionEnum]

partial

false

number (float)

totalTraffic

false

number (float)

suspectedEdge

false

number (float)

full

false

number (float)

DFGeneralRequest

Name Description Required Schema Default

filter

false

FieldValue]

timezone

false

string

start

false

integer (int32)

count

false

integer (int32)

csvConfig

false

CsvConfig

sort

false

SortObject array

reportScope

false

DFReportScope

DFProtectionSimpleRequest

Name Description Required Schema Default

deviceIp

false

string

poNames

false

string array

policyName

false

string

fromTime

false

integer (int64)

protection

false

string

units

false

string

isIpv4

false

boolean

direction

false

string

DFReportScope

Name Description Required Schema Default

devices

false

string array

protectedObjects

false

string array

policies

false

Policy array

range

false

integer (int64)

policySelected

false

boolean

ports

false

Ports

Description

Name Description Required Schema Default

content

false

string

DetailsRequest

Name Description Required Schema Default

attackIpsId

true

string

Device

Name Description Required Schema Default

parent

false

SiteTreeNodeIfc

lastSoftwareVersionUpgrade

false

string (date-time)

usedByDF

false

boolean

treeType

false

string

description

false

string

siteElementContainerAbsRef

false

SiteElementContainerAbs

type

false

string

isSynchronizeSucceededOnce

false

boolean

lockState

false

[Object]

isCollectingStatistics

false

boolean

deviceStatus

false

DeviceStatus

lastConfigBackup

false

string (date-time)

hierarchyPath

false

string

requiresReset

false

boolean

ormVersion

false

integer (int32)

virtualServices

false

VirtualService array

ormID

false

string

reportingDevice

false

boolean

physicalParentId

false

string

apmServerConfiguredOnDevice

false

ApmServerConfiguredOnDevice array

name

false

string

isRegisteredToMessages

false

boolean

isMonitored

false

boolean

deviceSetup

false

DeviceSetup

DeviceAccess

Name Description Required Schema Default

cliPort

false

integer (int32)

useHttpsAuthentication

false

boolean

useSnmpV3Authentication

false

boolean

isSsh

false

boolean

verifyHttpCredentials

false

boolean

useSnmpV3Privacy

false

boolean

exclusivelyReceiveDeviceEvents

false

boolean

httpsSocketTimeout

false

integer (int32)

description

false

string

httpsPort

false

integer (int32)

httpSocketTimout

false

integer (int32)

ormVersion

false

integer (int32)

cliUsername

false

string

ormID

false

string

snmpV3PrivacyPassword

false

string

snmpV3PrivacyProtocol

false

[SnmpV3PrivacyProtocolEnum]

httpsUsername

false

string

snmpV3AuthenticationPassword

false

string

snmpV2WriteCommunity

false

string

useHttpAuthentication

false

boolean

snmpV3AuthenticationProtocol

false

[SnmpV3AuthenticationProtocolEnum]

snmpV3Username

false

string

visionMgtPort

false

[VisionMgtPortEnum]

snmpVersion

false

[SnmpVersionEnum]

verifyHttpsCredentials

false

boolean

httpPort

false

integer (int32)

httpPassword

false

string

registerDeviceEvents

false

boolean

managementIp

false

string

httpsConnectionTimeout

false

integer (int32)

httpsPassword

false

string

name

false

string

httpUsername

false

string

httpConnectionTimeout

false

integer (int32)

cliPassword

false

string

snmpV2ReadCommunity

false

string

snmpV1WriteCommunity

false

string

mgt2Ip

false

string

snmpV1ReadCommunity

false

string

mgt1Ip

false

string

DeviceDriver

Name Description Required Schema Default

deviceType

false

enum (APPDIRECTOR, DEFENSE_PRO, MANAGEMENT_SERVER, LINKPROOF, ALTEON, GENERIC, CID, APPWALL, DEFENSE_FLOW)

restOnly

false

boolean

restCategory

false

string

creationTime

false

string (date-time)

driverBlob

false

string array

description

false

string

driverNameWithExtension

false

string

deviceVersion

false

string

minimumVisionVersion

false

string

restApiVersion

false

[RestApiVersion]

driverBuildID

false

string

driverID

false

string

supportedLanguages

false

string

driverVersion

false

string

supportingVisionWeb

false

boolean

localizationSupported

false

boolean

driverName

false

string

supportingRest

false

boolean

driverNameWithoutExtension

false

string

DeviceExportedFile

Name Description Required Schema Default

deviceType

false

string

deviceFileFromDB

false

string array

ormVersion

false

integer (int32)

ormID

false

string

name

false

string

description

false

string

exportedFileType

false

[ExportedFileTypeEnum]

deviceName

false

string

fileContent

false

string array

downloadTime

false

string (date-time)

DeviceMapResponse

Name Description Required Schema Default

deviceId

false

Device

DeviceSetup

Name Description Required Schema Default

license

false

License

ormVersion

false

integer (int32)

ormID

false

string

deviceSoftware

false

Software

deviceDriver

false

DeviceDriver

name

false

string

description

false

string

deviceAccess

false

DeviceAccess

hardware

false

Hardware

DeviceStatus

Name Description Required Schema Default

isApplySaveRequired

false

[ApplySaveRequired]

isReportingServiceUp

false

boolean

defenseFlowPendingActionsAmount

false

integer (int32)

lastDeviceChangesNotification

false

string (date-time)

redundancyStatus

false

[RedundancyStatusEnum]

description

false

string

isUpdatePoliciesRequired

false

boolean

lastDeviceStatusChange

false

string (date-time)

isSyncRequired

false

boolean

ormVersion

false

integer (int32)

defenseFlowPendingActionAboveThreshold

false

boolean

highAvailabilityPriority

false

[HighAvailabilityPriorityEnum]

ormID

false

string

name

false

string

isFirstTimeConnectionSucceed

false

boolean

redundancyRole

false

[RedundancyRoleEnum]

deviceOperationMode

false

integer (int32)

status

false

[DeviceStatusEnum]

DnsCharacteristics

Name Description Required Schema Default

destinationPort

false

string

dnsQCount

false

string

attackIpsId

false

string

blockingState

false

string

dnsAQCount

false

string

flags

false

string

dnsQueryName

false

string

packetSize

false

string

ttl

false

string

dnsId

false

string

destinationIP

false

string

actionType

false

string

l4Checksum

false

string

ipIdNumber

false

string

startTime

false

integer (int64)

DnsFootprint

Name Description Required Schema Default

timeStamp

false

string (date-time)

attackIpsId

false

string

startTime

false

integer (int64)

text

false

string

DnsStatistics

Name Description Required Schema Default

chartValues

false

integer (int64) array

startTime

false

integer (int64)

normalValue

false

integer (int64)

DocumentationCurrentAttacksResponse

Name Description Required Schema Default

request

false

GeneralRequest

totalRows

false

integer (int32)

rows

false

CurrentAttack array

DocumentationSampleDataResponse

Name Description Required Schema Default

request

false

GeneralRequest

totalRows

false

integer (int32)

rows

false

SampleData array

Dos

Name Description Required Schema Default

attackerIp

false

string

attackDuration

false

integer (int64)

attackIpsId

false

string

protectedHost

false

string

attackTotalDropRate

false

integer (int64)

protectedPort

false

integer (int32)

action

false

string

startTime

false

integer (int64)

attackRate

false

integer (int64)

EdgeResult

Name Description Required Schema Default

suspectedAttack

false

integer (int32)

secondsFromNow

false

integer (int64)

suspectedEdge

false

integer (int32)

EmailTemplate

Name Description Required Schema Default

alertType

false

string

alertTypeObj

false

[AlertType]

subject

false

string

name

false

string

textBody

false

string

id

false

integer (int32)

body

false

string

Event

Name Description Required Schema Default

receivedBytes

false

integer (int64)

cpuUsage

false

integer (int64)

responseEndTime

false

string (date-time)

locationDescription

false

string

destinationProcessId

false

integer (int64)

referenceParentId

false

string

networkTime

false

integer (int32)

grossResponseTime

false

integer (int32)

dNSTime

false

integer (int64)

destinationNodeId

false

string

connectTime

false

integer (int64)

clientIP

false

string

renderingTime

false

integer (int32)

id

false

string

sourceProcessId

false

integer (int64)

dataCenterSla

false

integer (int32)

successful

false

boolean

area

false

string

dataCenterResponseTime

false

integer (int32)

responseStartTime

false

string (date-time)

memoryUsage

false

integer (int64)

domProcessing

false

integer (int64)

redirectTime

false

integer (int64)

sourceAgentPort

false

integer (int32)

appName

false

string

requestEndTime

false

string (date-time)

metDataCenterSla

false

boolean

sourceProcessName

false

string

version

false

integer (int32)

requestStartTime

false

string (date-time)

sourceIp

false

string

sourceNodeId

false

string

desktopSla

false

integer (int32)

name

false

string

eventParameters

false

string

destinationProcessName

false

string

applicationId

false

integer (int32)

sentBytes

false

integer (int64)

destinationHost

false

string

realServerIP

false

string

EventDetails

Name Description Required Schema Default

dNSTime

false

integer (int64)

event

false

Event

EventSample

Name Description Required Schema Default

destPort

false

integer (int64)

flag

false

string

attackIpsId

false

string

icmpMsgType

false

string

destAddress

false

string

startTime

false

integer (int64)

EventType

Name Description Required Schema Default

severity

false

SeverityPercentage

instances

false

integer (int64)

formattedLastUsed

false

string

description

false

string

desktopTransaction

false

boolean

formattedTimestamp

false

string

lastUsed

false

string (date-time)

thresholds

false

TransactionThresholdSla array

nameNoCData

false

string

application

false

Application

tier

false

Tier

name

false

string

descriptionNoCData

false

string

id

false

integer (int32)

sensitivity

false

TransactionAlertSensitivity

applicationId

false

integer (int32)

failedThresholds

false

TransactionThresholdFailed array

transaction

false

boolean

timestamp

false

string (date-time)

Footprint

Name Description Required Schema Default

footprint

false

string

startTime

false

integer (int64)

timestamp

false

string (date-time)

GeneralRequest

Name Description Required Schema Default

filter

Represents the filter object. The key of the map is a fieldName. The value is an object with the following fields:
operator - Can be '=', 'like', 'in'.
value - A fieldValue
arrayValue - When using an 'in' operator, these are values for the operator.
For example, if we want to filter by deviceIp in (127.0.0.1, 127.0.0.2) and attackName=BDOS, the filter will be:
{attackName:{operator:'=', value:'BDOS'}, deviceIp:{operator:'in', arrayValue:['127.0.0.1', '127.0.0.2']}}

false

{operator:'=', value:'fieldValue', arrayValue:[]}]

timezone

false

string

start

Represents the start value for paging. Use 0 or an empty value for no paging.

false

integer (int32)

count

false

integer (int32)

sort

Represents the sorting object. For example, if you want to sort by ascending Attack Name and descending TimeStamp the object will be:
[{field:'attackName', dir:'asc'}, field:'timeStamp', dir:'desc'}]

false

SortObject array

reportScope

The main request object.

true

ReportScope

Hardware

Name Description Required Schema Default

trankPortsStartNumber

false

integer (int32)

powerSupplyType

false

[PowerSupplyTypeEnum]

hasAccelerationEngineEnabled

false

boolean

formFactorType

false

string

numberOfPhisicalInterfaces

false

integer (int32)

platformType

false

string

baseMacAddress

false

string

description

false

string

compressionCardName

false

string

hasAccelerator

false

boolean

ormVersion

false

integer (int32)

ormID

false

string

hasSme

false

boolean

sslCardName

false

string

name

false

string

hasSata

false

boolean

fullHardwareTypeName

false

string

status

false

[java.util.Collection<com.radware.insite.model.setup.HardwareStatus]>

HourData

Name Description Required Schema Default

hour

false

integer (int32)

value

false

integer (int32)

HttpFloodInfo

Name Description Required Schema Default

suspiciousSources

false

integer (int32)

challengeMode

false

string

webUtilization

false

integer (int32)

newMitigationState

false

string

challengedCandidates

false

integer (int32)

escalationMode

false

string

newProtectionState

false

string

HttpReportStatistics

Name Description Required Schema Default

timeStamp

false

integer (int64)

httpReqPerConn

false

integer (int64)

anomalyOutboundMbps

false

number (double)

outboundMbps

false

number (double)

anomalyHttpReqPerConn

false

integer (int64)

anomalySrcReqPerSec

false

integer (int64)

srcReqPerSec

false

integer (int64)

anomalyOtherReqPerSec

false

integer (int64)

anomalyHttpReqPerSec

false

integer (int64)

httpReqPerSec

false

integer (int64)

otherReqPerSec

false

integer (int64)

HttpStatistics

Name Description Required Schema Default

rc

false

integer (int32)

attackIpsId

false

string

conRC

false

integer (int32)

src

false

integer (int32)

startTime

false

integer (int64)

statisticsType

false

string

outBC

false

number (float)

normalLDT

false

integer (int32) array

rateSTD

false

integer (int32) array

otherC

false

integer (int32)

Intensity

Name Description Required Schema Default

bandwidthAverage

false

number (double)

packetsAverage

false

number (double)

License

Name Description Required Schema Default

bdosEnabled

false

boolean

hardwareLicenseString

false

string

throughputLicenseString

false

string

tenGigabyteEnabled

false

boolean

description

false

string

bwmAndIpsEnabled

false

boolean

ormVersion

false

integer (int32)

dosEnabled

false

boolean

security

false

boolean

ormID

false

string

apmLicenseLimit

false

integer (int32)

ipv6

false

boolean

softwareLicenseString

false

string

name

false

string

globalRedirectionEnabled

false

boolean

vxApmLicenseLimit

false

integer (int32)

throughput

false

[ThroughputLicenseEnum]

cookiePersistencyEnabled

false

boolean

sp

false

boolean

productType

false

[ProductTypeEnum]

Message

Name Description Required Schema Default

message

false

string

timestamp

false

integer (int64)

MultipartFormDataInput

Name Description Required Schema Default

formDataMap

false

List[InputPart]]

formData

false

InputPart]

NetworkRuleRequest

Name Description Required Schema Default

policyName

true

string

range

true

integer (int32)

protection

true

string

units

true

string

isIpv4

true

boolean

deviceId

true

string

direction

true

string

Node

Name Description Required Schema Default

server

false

boolean

agentId

false

integer (int32)

agent

false

Agent

formattedLastUsed

false

string

ip

false

boolean

description

false

string

real

false

boolean

collector

false

boolean

lastUsed

false

string (date-time)

containsEvents

false

boolean

tier

false

Tier

tierId

false

integer (int32)

client

false

boolean

id

false

integer (int32)

containsTransactions

false

boolean

nodeId

false

string

timestamp

false

string (date-time)

applications

false

Application array

Policy

Name Description Required Schema Default

type

false

[PolicyType]

deviceId

false

string

policy

false

string

Port

Name Description Required Schema Default

port

false

string

deviceId

false

string

Ports

Name Description Required Schema Default

biDir

false

Port array

source

false

Port array

dest

false

Port array

ProtectEvent

Name Description Required Schema Default

protocol

false

string

attackIpsId

false

string

messages

false

Message array

startTime

false

integer (int64)

RadwareRequest

Name Description Required Schema Default

radwareId

true

integer (int32)

RateResult

Name Description Required Schema Default

secondsFromNow

false

integer (int64)

total

false

integer (int32)

normalEdge

false

integer (int32)

legitimate

false

integer (int32)

RegionRequest

Name Description Required Schema Default

attackIpsId

true

string

direction

true

string

ReportRequest

Name Description Required Schema Default

servers

The serverId list (taken from HttpServersWs).

true

string array

devices

The deviceId list. Only one value is supported.

true

string array

weekDay

(1 = 'Mo', 2 = 'Tu' …​ 7 = 'Su') if == -1 or null ⇒ use range

false

integer (int32)

range

Used only if weekDay is not specified, this value is seconds before now.

false

integer (int64)

pageSize

false

integer (int32)

pageNum

false

integer (int32)

ReportScope

Name Description Required Schema Default

devices

The deviceId array.

true

string array

policies

false

Policy array

range

The range of the report, in seconds.

true

integer (int64)

policySelected

Relevant only for Traffic Monitoring, specifies the scope: port or policy.

false

boolean

ports

false

Ports

RowDto

Name Description Required Schema Default

cells

false

CellDto array

SampleData

Name Description Required Schema Default

mplsRd

false

string

sourcePort

false

string

protocol

false

string

vlanTag

false

string

sourceAddress

false

string

destPort

false

string

attackIpsId

false

string

destAddress

false

string

srcMsisdn

false

string

destMsisdn

false

string

startTime

false

integer (int64)

physicalPort

false

string

SampleStatisticsRow

Name Description Required Schema Default

legitimateTraffic

false

string

baseLine

false

string

legitimatePortion

false

string

doa

false

string

protection

false

string

totalTraffic

false

string

baselinePortion

false

string

rtPortion

false

string

Sensitivity

Name Description Required Schema Default

intervalUnits

false

string

repeat

false

integer (int32)

interval

false

integer (int32)

intervalMilliseconds

false

integer (int64)

type

false

[SensitivityTypes]

measurements

false

integer (int32)

timeUnit

false

[TimeUnit]

Server

Name Description Required Schema Default

ormId

false

string

name

false

string

ServersRequest

Name Description Required Schema Default

devices

The deviceId array.

true

string array

SeverityPercentage

Name Description Required Schema Default

slaError

false

integer (int32)

failedError

false

integer (int32)

slaWarning

false

integer (int32)

failedWarning

false

integer (int32)

SharepathServer

Name Description Required Schema Default

dataIp

false

string

localAioApmServer

false

boolean

sharepathServerUrl

false

string

httpPort

false

integer (int32)

description

false

string

usageCounter

false

integer (int32)

percentOfCPUUsedByIO

false

number (float)

ormVersion

false

integer (int32)

managementIp

false

string

backupIp

false

string

ormID

false

string

aioEnabled

false

boolean

tps

false

number (float)

name

false

string

throughput

false

integer (int32)

cpuUsagePercent

false

number (float)

managementIpAio

false

string

lastUpdateTime

false

string (date-time)

SiteElementContainerAbs

Name Description Required Schema Default

hierarchyPath

false

string

parent

false

SiteTreeNodeIfc

ormVersion

false

integer (int32)

ormID

false

string

treeType

false

string

name

false

string

siteTreeElementCollection

false

[java.util.Collection<com.radware.insite.model.device.SiteTreeElementAbs]>

description

false

string

siteElementContainerAbsRef

false

SiteElementContainerAbs

SiteTreeNodeIfc

Name Description Required Schema Default

parent

false

SiteTreeNodeIfc

name

false

string

SlaWatch

Name Description Required Schema Default

averageResponseTimeValue

false

string

aggDate

false

integer (int64)

maxResponseTime

false

integer (int64)

locationDescription

false

string

averageRenderingTimeValue

false

string

volumeMetSla

false

integer (int64)

transactionDescription

false

string

slaWatchSeverityPercentage

false

SlaWatchSeverityPercentage

transactionName

false

string

numberFailed

false

integer (int64)

responseSum

false

integer (int64)

locationId

false

integer (int32)

averageDCTimeValue

false

string

percentageSlaValue

false

string

averageNetworkTimeValue

false

string

minResponseTime

false

integer (int64)

percentageFailedSlaValue

false

string

volumeExceedSla

false

integer (int64)

areaDescription

false

string

transactionId

false

integer (int32)

percentageFailedValue

false

string

volume

false

integer (int64)

stddevValue

false

string

percent95StddevValue

false

string

volumeHadSla

false

integer (int64)

areaId

false

integer (int32)

applicationDescription

false

string

tps

false

number (double)

applicationId

false

integer (int32)

SlaWatchListWrapper

Name Description Required Schema Default

total

false

integer (int32)

aggregations

false

SlaWatch array

SlaWatchSeverityPercentage

Name Description Required Schema Default

slaError

false

integer (int32)

failedError

false

integer (int32)

slaWarning

false

integer (int32)

id

false

integer (int32)

failedWarning

false

integer (int32)

Software

Name Description Required Schema Default

ormVersion

false

integer (int32)

ormID

false

string

name

false

string

description

false

string

version

false

string

status

false

[java.util.Collection<com.radware.insite.model.setup.SoftwareStatus]>

SortObject

Name Description Required Schema Default

field

false

string

dir

false

string

Statistics

Name Description Required Schema Default

inValue

false

integer (int64)

unit

false

[TrafficUnit]

attackIpsId

false

string

outValue

false

integer (int64)

dataType

false

[DataType]

chartValues

false

integer (int64) array

protection

false

string

startTime

false

integer (int64)

normalValue

false

integer (int64)

direction

false

string

StatisticsTable

Name Description Required Schema Default

protection

false

string

rows

false

StatisticsColumn]

StatisticsTableRow

Name Description Required Schema Default

in

false

integer (int32)

type

false

string

out

false

integer (int32)

StatisticsTableRowTcp

Name Description Required Schema Default

synIn

false

integer (int32)

rstIn

false

integer (int32)

synAckOut

false

integer (int32)

fragIn

false

integer (int32)

synAckIn

false

integer (int32)

fragOut

false

integer (int32)

rstOut

false

integer (int32)

finOut

false

integer (int32)

type

false

string

finIn

false

integer (int32)

synOut

false

integer (int32)

SynFlood

Name Description Required Schema Default

destPort

false

integer (int32)

spoofed

false

integer (int64)

webUtilization

false

integer (int64)

httpChallenge

false

string

attackIpsId

false

string

tcpUtilization

false

integer (int64)

destAddress

false

string

threshold

false

integer (int64)

startTime

false

integer (int64)

tcpChallenge

false

string

attackRate

false

integer (int64)

TableDto

Name Description Required Schema Default

rows

false

RowDto array

tableName

false

string

columnsName

false

string array

TableResponse

Name Description Required Schema Default

request

false

[REQUEST]

totalRows

false

integer (int32)

rows

false

[RESPONSE] array

ThinSiteTransformerDTO

Name Description Required Schema Default

managementIp

false

string

ormId

false

string

children

false

ThinSiteTransformerDTO array

formFactor

false

string

treeType

false

string

supportTemplate

false

boolean

name

false

string

parentOrmId

false

string

deviceVersion

false

string

type

false

string

status

false

string

ThresholdAlert

Name Description Required Schema Default

alertTypeObj

false

[AlertType]

emailTemplateAlertOffId

false

integer (int32)

emailTemplateAlertOff

false

EmailTemplate

enabled

false

boolean

timeframe

false

Timeframe

applicationDeleted

false

boolean

emailTemplateAlertOn

false

EmailTemplate

emailTemplateAlertOnId

false

integer (int32)

statusName

false

string

id

false

integer (int32)

timestamp

false

string (date-time)

cc

false

string

applicationDesc

false

string

severityPercentage

false

AlertSeverityPercentage

customClassName

false

string

back2NormalAlert

false

boolean

transactionId

false

integer (int32)

alertTypeName

false

string

parentName

false

string

fileTemplate

false

string

timeframeId

false

integer (int32)

application

false

Application

sensitivityType

false

[SensitivityTypes]

sensitivityLabel

false

string

name

false

string

shScript

false

string

sensitivity

false

string

timeframeName

false

string

to

false

string

applicationId

false

integer (int32)

formatedTimestamp

false

string

fileMaxRows

false

integer (int32)

timeframeDesc

false

string

statusObj

false

[Status]

measuredValue

false

number (double)

status

false

integer (int32)

ThresholdAlertList

Name Description Required Schema Default

alerts

false

ThresholdAlert array

offset

The offset in the results list.

true

integer (int32)

limit

The maximum number of results requested.

true

integer (int32)

hasNext

Specifies whether a next page of results exists.

true

boolean

list

false

[T] array

results

false

integer (int32)

Tier

Name Description Required Schema Default

nodes

false

Node array

deleted

false

boolean

name

false

string

icon

false

integer (int32)

description

false

string

id

false

integer (int32)

Timeframe

Name Description Required Schema Default

expression

false

string

name

false

string

description

false

string

id

false

integer (int32)

TrafficAuth

Name Description Required Schema Default

protocol

false

string

currentAttacks

false

integer (int32)

challenge

false

integer (int32)

utilization

false

integer (int32)

TrafficUtilizationChartValue

Name Description Required Schema Default

secondsFromNow

false

integer (int32)

diverted

false

BigInteger

discarded

false

BigInteger

inbound

false

BigInteger

dropped

false

BigInteger

clean

false

BigInteger

TrafficUtilizationTableRow

Name Description Required Schema Default

diverted

false

BigInteger

protocol

false

[TrafficMonitorProtocol]

discarded

false

BigInteger

inbound

false

BigInteger

dropped

false

BigInteger

clean

false

BigInteger

timestamp

false

string (date-time)

TrafficUtilizationValue

Name Description Required Schema Default

inBound

false

integer (int64)

secondsFromNow

false

integer (int32)

outBound

false

integer (int64)

inDiscard

false

integer (int64)

inExcluded

false

integer (int64)

outExclude

false

integer (int64)

outDiscard

false

integer (int64)

TransactionAlertSensitivity

Name Description Required Schema Default

high

false

Sensitivity

low

false

Sensitivity

medium

false

Sensitivity

TransactionThresholdFailed

Name Description Required Schema Default

timeframe

false

Timeframe

timeframeId

false

integer (int32)

alert

false

ThresholdAlert

id

false

integer (int32)

alertId

false

integer (int32)

alertEnabled

false

boolean

transaction

false

EventType

transactionId

false

integer (int32)

TransactionThresholdGeoSla

Name Description Required Schema Default

alert

false

ThresholdAlert

locationId

false

integer (int32)

thresholdSla

false

TransactionThresholdSla

id

false

integer (int32)

alertId

false

integer (int32)

alertEnabled

false

boolean

slaValue

false

integer (int32)

TransactionThresholdSla

Name Description Required Schema Default

timeframe

false

Timeframe

timeframeId

false

integer (int32)

alert

false

ThresholdAlert

slaMode

false

string

id

false

integer (int32)

alertId

false

integer (int32)

alertEnabled

false

boolean

datacenterSla

false

integer (int32)

transaction

false

EventType

desktopGeoSla

false

TransactionThresholdGeoSla array

transactionId

false

integer (int32)

TriggeredAlert

Name Description Required Schema Default

triggeredSensitivity

false

Sensitivity

parentAlertid

false

integer (int32)

alertTypeObj

false

[AlertType]

emailTemplateAlertOffId

false

integer (int32)

emailTemplateAlertOff

false

EmailTemplate

back2NormalTimestamp

false

string (date-time)

severityLevel

false

[SeverityLevels]

applicationDeleted

false

boolean

emailTemplateAlertOn

false

EmailTemplate

emailTemplateAlertOnId

false

integer (int32)

statusName

false

string

id

false

integer (int32)

timestamp

false

string (date-time)

cc

false

string

applicationDesc

false

string

alertType

false

string

customClassName

false

string

back2NormalAlert

false

boolean

thresholdValue

false

number (double)

sLAObjectId

false

integer (int32)

transactionId

false

integer (int32)

sLAObjectType

false

string

fileTemplate

false

string

timeframeId

false

integer (int32)

application

false

Application

sensitivityType

false

[SensitivityTypes]

name

false

string

sensitivityLabel

false

string

shScript

false

string

sensitivity

false

string

timeframeName

false

string

to

false

string

applicationId

false

integer (int32)

formatedTimestamp

false

string

fileMaxRows

false

integer (int32)

timeframeDesc

false

string

statusObj

false

[Status]

measuredValue

false

number (double)

status

false

integer (int32)

TriggeredAlertList

Name Description Required Schema Default

offset

The offset in the results list.

true

integer (int32)

limit

The maximum number of results requested.

true

integer (int32)

hasNext

Specifies whether a next page of results exists.

true

boolean

list

false

TriggeredAlert array

results

false

integer (int32)

VirtualService

Name Description Required Schema Default

virtualServiceName

false

string

virtualServerId

false

string

ormVersion

false

integer (int32)

ormID

false

string

virtualServiceId

false

string

name

false

string

description

false

string

sharepathServer

false

SharepathServer

virtualServerIp

false

string

virtualServicePort

false

integer (int32)

device

false

Device

WrappedString

Name Description Required Schema Default

result

false

string