Update Monitoring Settings

Create or update monitoring settings for a site

Create or update monitoring settings for a specific site.

If settings already exist for the site they will be fully replaced; otherwise new settings are created. All IP entries are validated before saving - invalid formats will return a 400 error.

Supported IP formats for excluded_scanner_ips:

Single IP: "10.10.10.10"
IP range: "10.10.12.1-10.10.12.4"
CIDR: "10.10.11.0/24"

Side effect: Changes take effect on the next monitoring data collection cycle. Flows where the source IP matches an excluded entry will no longer appear in infra monitoring results. Destination IPs are not checked.

Request

URI

PUT

https://{api_host}/intelligence/monitoring/site-settings/{site-id}

COPY

Path Parameters

string

site-id

Required

The unique identifier of the site

site-id example

5cf83f93-f9dd-4898-a345-44513572c557

Request Body

Monitoring settings with the full list of scanner IPs to exclude

MonitoringSettings of type(s) application/json

Required

Show optional properties

{
    "site_id": "5cf83f93-f9dd-4898-a345-44513572c557"
}

{
    "site_id": "5cf83f93-f9dd-4898-a345-44513572c557",
    "excluded_scanner_ips": [
        "10.10.10.10",
        "10.10.12.1-10.10.12.4",
        "10.10.11.0/24"
    ]
}

string

site_id

Required

The unique identifier of the site for which the monitoring settings are configured.

array of string

excluded_scanner_ips

Optional

List of IP addresses, IP ranges, or CIDR notations to exclude from infra monitoring only. Flows where the source IP matches an excluded entry are filtered out of infra monitoring results. Destination IPs are not checked. Use this to suppress noise from security scanners and vulnerability assessment tools.

Supported formats (IPv4 and IPv6):

Single IP: "10.10.10.10" or "2001:db8::1"
IP range: "10.10.12.1-10.10.12.4"
CIDR block: "10.10.11.0/24" or "2001:db8::/32"

Authentication

This operation uses the following authentication methods.

enterprise_admin

security_engineer

security_op

Responses

200

OK. Monitoring settings updated successfully.

Returns MonitoringSettings of type(s) application/json

{
    "site_id": "5cf83f93-f9dd-4898-a345-44513572c557",
    "excluded_scanner_ips": [
        "10.10.10.10",
        "10.10.12.1-10.10.12.4",
        "10.10.11.0/24"
    ]
}

string

site_id

Required

The unique identifier of the site for which the monitoring settings are configured.

array of string

excluded_scanner_ips

Optional

Supported formats (IPv4 and IPv6):

Single IP: "10.10.10.10" or "2001:db8::1"
IP range: "10.10.12.1-10.10.12.4"
CIDR block: "10.10.11.0/24" or "2001:db8::/32"

400

Bad Request

Returns BadRequest 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.

401

Unauthorized

Returns Unauthorized 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.

403

Forbidden

Returns Forbidden 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.

412

Precondition Failed

Returns PreconditionFailed 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.

428

Precondition Required

Returns PreconditionRequired 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.

429

Too Many Requests

Returns TooManyRequests 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.

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 -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"site_id":"string"}' https://{api_host}/intelligence/monitoring/site-settings/{site-id}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Application Monitoring Operations

POST

Fetch All Results By Time