Get Compute Related Ids Rules

Get IDS rules applied to a specific VM

Returns IDS (Intrusion Detection Service) rules organized by parent IDS security policies for the specified VM. Each result entry is an IDS security policy containing its list of associated rules.

Notes:

start_time is required. Either site_id or site_ids must also be provided.
filters accepts up to 300 filter entries. Supported filter keys: IDS_RELATED_RULE_RULE_ID, IDS_RELATED_RULE_RULE_NAME.
Obtain compute-id from the topology graph returned by POST /visualization/topology/compute-flow-topology, where each node represents a compute.
To see the DFW rules associated with this VM, use POST /visualization/security-analysis/computes/{compute-id}/related-dfw-rules.
To see the flow records for this VM, use POST /visualization/flow-analysis/computes/{compute-id}/flow-details.

Request

URI

POST

https://{api_host}/intelligence/visualization/threat-analysis/computes/{compute-id}/related-ids-rules

COPY

Path Parameters

string

compute-id

Required

External ID of the target VM.

Request Body

Wrapper request for ComputeIdIdsRules with restricted filter keys

VizComputeIdIdsRulesRequest of type(s) application/json

Required

This request body class requires all of the following: VizTimeIntervalListSiteRequest , InlineVizComputeIdIdsRulesRequest1

{
    "start_time": 0,
    "site_id": "17f7c7e5-7f8c-490a-97e9-b9c9193c45e1",
    "page_size": 10000,
    "filters": []
}

Authentication

This operation uses the following authentication methods.

Responses

200

success

Returns RelatedIdsRuleListResult of type(s) application/json

This response body class contains all of the following: VizTimeIntervalListResult , InlineRelatedIdsRuleListResult1

{
    "offset": 0,
    "number_of_results": 2,
    "total_result_count": 2,
    "total_pages": 1,
    "time_interval": {
        "start_time": 0,
        "end_time": 1782177875051
    },
    "results": [
        {
            "site_id": "17f7c7e5-7f8c-490a-97e9-b9c9193c45e1",
            "policy_path": "/infra/domains/default/intrusion-service-policies/mps",
            "related_rules": [
                {
                    "policy_path": "/infra/domains/default/intrusion-service-policies/mps/rules/New_Rule"
                }
            ]
        },
        {
            "site_id": "17f7c7e5-7f8c-490a-97e9-b9c9193c45e1",
            "policy_path": "/infra/domains/default/intrusion-service-policies/SSP_Env_IDPS_9f8399af-bd68-35f0-8f77-5fcff3c281b7",
            "related_rules": [
                {
                    "policy_path": "/infra/domains/default/intrusion-service-policies/SSP_Env_IDPS_9f8399af-bd68-35f0-8f77-5fcff3c281b7/rules/SSP_Env_IDPS_Egress_Rule"
                },
                {
                    "policy_path": "/infra/domains/default/intrusion-service-policies/SSP_Env_IDPS_9f8399af-bd68-35f0-8f77-5fcff3c281b7/rules/SSP_Env_IDPS_Ingress_Rule"
                }
            ]
        }
    ]
}

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 POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/intelligence/visualization/threat-analysis/computes/{compute-id}/related-ids-rules

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Security Explorer Operations

POST

Get App Flow Details