EnvPublishConfigJobStatus

EnvPublishConfigJobStatus
Environment Pair Publish Config Job Status

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.
JSON Example 
{
    "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
job_id
Required  

Unique identifier of this publish job.

string
pair_id
Required  

The environment pair identifier associated with this job.

string
site_id
Required  

The site identifier from the original publish request.

PublishOperationStatus
status
Required  

Overall lifecycle status of the job: PENDING | IN_PROGRESS | COMPLETED | FAILED.

Enumeration: PENDING, IN_PROGRESS, COMPLETED, FAILED
EpochMsTimestamp
_create_time
Required  

Timestamp when the job was created.

EpochMsTimestamp
_last_modified_time
Required  

Timestamp when the job was last updated.

string
_create_user
Optional

Username of the user who initiated this publish job.

array of EnvPublishActionResult
results
Optional

Per-action results for this publish job.

Property Of
Returned By