EnvironmentPair

EnvironmentPair
Environment Pair

A directed pair of monitored environments representing traffic flow from source to destination.

Notes:

  • The pair_id is the underscore-concatenation of source and destination environment UUIDs, and serves as the {pair-id} path parameter for environment pair publish endpoints.
JSON Example 
{
    "pair_id": "string",
    "source_environment": {
        "id": "string",
        "display_name": "string"
    },
    "destination_environment": {
        "id": "string",
        "display_name": "string"
    },
    "stats": {
        "category_default_rule_unique_flow_count": 0,
        "protection_rule_unique_flow_count": 0,
        "total_unique_flow_count": 0
    },
    "protection_status": "string",
    "related_policies": [
        {
            "dfw_policy_path": "string",
            "default_rule_path": "string",
            "rule_action": "string",
            "site_id": "string",
            "is_category_global": false,
            "is_disabled": false,
            "is_pending_sync_from_nsx": false
        }
    ],
    "latest_publish_job_status": {
        "job_id": "job-uuid-001",
        "pair_id": "b5c46138-2107-47c4-886e-75ecf971b382_d26e9c1e-8b51-4253-ba23-4006c73a0d42",
        "site_id": "77366441-9e69-47d1-9bbb-8c608f27f158",
        "status": "FAILED",
        "_create_time": 1750714942696,
        "_last_modified_time": 1750714960000,
        "_create_user": "admin",
        "results": [
            {
                "action_index": 0,
                "action_type": "POLICY_WITH_PROTECTION_RULE_CREATE",
                "action_status": "COMPLETED",
                "path": "/infra/domains/default/security-policies/ENV-Shared-to-Production"
            },
            {
                "action_index": 1,
                "action_type": "PROTECTION_RULE_UPDATE",
                "action_status": "FAILED",
                "path": "/infra/domains/default/security-policies/Policy-abc/rules/Rule-xyz",
                "status_message": "Rule not found on NSX Manager",
                "error_details": "404 Not Found: /infra/domains/default/security-policies/Policy-abc/rules/Rule-xyz"
            }
        ]
    }
}
string
pair_id
Optional

Unique identifier for the environment pair, formed by concatenating source and destination environment UUIDs with an underscore (e.g. src-env-uuid_dst-env-uuid).

Environment
source_environment
Optional

Environment schema

Environment
destination_environment
Optional

Environment schema

EnvironmentPairSummaryStats
stats
Optional

Summary stats for an environment pair

EnvironmentPairProtectionStatus
protection_status
Optional

Protection status of an environment pair.

Status Description
ENVIRONMENT_UNPROTECTED No dedicated environment section exists, or the default section has an Allow or Jump To Application rule - no explicit pair-wise protection.
ALLOWED User has explicitly allowed inter-zone traffic in the pair-wise environment section.
MONITORED User has explicitly set inter-zone traffic to Jump To Application for deeper inspection.
LOCKDOWN_GLOBAL User has explicitly locked down the global environment category section.
LOCKDOWN_SECTION User has explicitly locked down the pair-wise section.
Enumeration: ENVIRONMENT_UNPROTECTED, ALLOWED, MONITORED, LOCKDOWN_GLOBAL, LOCKDOWN_SECTION
array of EnvironmentPairPolicyInfoDetails
related_policies
Optional

Policies related to this environment pair

EnvPublishConfigJobStatus
latest_publish_job_status
Optional

Status and per-action results of an asynchronous publish job for an environment pair.

Notes:

  • Poll this resource after initiating a publish job until status is COMPLETED or FAILED.
  • Each entry in results maps to the corresponding input action via action_index (zero-based position in the original publish_actions array).
  • On failure, check error_details on FAILED result entries for the specific error from NSX Manager.
Used By