Get Sensor Feature Config

Get Sensor Feature Config
Get sensor appliance feature configuration by id

Get feature configuration for the sensor appliance with the specified id.

Request
URI
GET
https://{api_host}/sensors/appliances/{appliance-id}/feature-config
COPY
Path Parameters
string
appliance-id
Required

Used to identify a sensor appliance.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns SensorFeatureConfig of type(s) application/json
{
    "ids_enabled": false,
    "ids_config": {
        "pcap_enabled": false
    },
    "flows_enabled": false,
    "mps_enabled": false,
    "mps_config": {
        "document_file_type": false,
        "executable_file_type": false,
        "media_file_type": false,
        "archive_file_type": false,
        "data_file_type": false,
        "script_file_type": false,
        "other_file_type": false
    }
}
boolean
ids_enabled
Required

Specifies if IDS events are to be sent by sensors.

object
ids_config
Optional

Configuration of IDS on the sensor.

boolean
flows_enabled
Required

Specifies if flows are to be collected by sensors.

boolean
mps_enabled
Required

Specifies if MPS (file events) are to be sent by sensors.

object
mps_config
Optional

Configuration of MPS for the sensor.


default

Error

Returns Error of type(s) application/json
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required

Message describing the error.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/sensors/appliances/{appliance-id}/feature-config