Get Environment Pairs

List environment pairs with flow stats and protection status

Returns a paginated list of monitored environment pairs, each representing directional traffic between a source and destination environment. Includes per-pair flow stats and the current protection status.

Use the pair_id from results as the {pair-id} path parameter for POST /monitoring/environment-pairs/{pair-id}/publish-config and GET /monitoring/environment-pairs/{pair-id}/publish-config/{job-id}.

Use the source_environment.id and destination_environment.id as inputs to POST /monitoring/environments/pair-details to drill into flow trend details for a specific pair.

Filter tips:

protection_statuses: [ENVIRONMENT_UNPROTECTED] - find pairs with no dedicated security policy
src_env_ids / dst_env_ids - focus on a specific environment's outbound or inbound pairs
env_ids - include any pair where the environment appears as either source or destination

If time_selection is omitted, defaults to the last 1 hour.

Request

URI

POST

https://{api_host}/intelligence/monitoring/environments/pair-summary

COPY

Request Body

Pagination, time range, and optional filters for environment pairs

EnvironmentPairsListRequestParameters of type(s) application/json

Required

This request body class requires all of the following: ListRequestParameters , InlineEnvironmentPairsListRequestParameters1

{
    "page_size": 50,
    "offset": 0,
    "time_selection": {
        "start_time": 1781806411584
    }
}

Authentication

This operation uses the following authentication methods.

Responses

200

OK. Successfully retrieved environment pairs.

Returns EnvironmentPairsListResult of type(s) application/json

This response body class contains all of the following: ListResult , InlineEnvironmentPairsListResult1

{
    "result_count": 2,
    "number_of_results": 2,
    "total_result_count": 2,
    "total_pages": 1,
    "results": [
        {
            "pair_id": "6c0a5b3c-6b9f-4d1e-afaf-ed3fb42bd57e_8ad292bc-e09b-49de-b011-03d9beab1a2a",
            "source_environment": {
                "id": "6c0a5b3c-6b9f-4d1e-afaf-ed3fb42bd57e",
                "display_name": "US_West_debug"
            },
            "destination_environment": {
                "id": "8ad292bc-e09b-49de-b011-03d9beab1a2a",
                "display_name": "LTN_West_debug"
            },
            "stats": {
                "category_default_rule_unique_flow_count": 0,
                "protection_rule_unique_flow_count": 0,
                "total_unique_flow_count": 0
            },
            "protection_status": "ENVIRONMENT_UNPROTECTED",
            "related_policies": [
                {
                    "dfw_policy_path": "/infra/domains/default/security-policies/SSP_Env_Default_Policy",
                    "default_rule_path": "/infra/domains/default/security-policies/SSP_Env_Default_Policy/rules/ssp_env_default_rule",
                    "rule_action": "JUMP_TO_APPLICATION",
                    "site_id": "5cf83f93-f9dd-4898-a345-44513572c557",
                    "is_category_global": true,
                    "is_disabled": false,
                    "is_pending_sync_from_nsx": false
                }
            ]
        }
    ]
}

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.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/intelligence/monitoring/environments/pair-summary

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

Environment Monitoring Operations

POST

Get Environment Pairs

POST