NSX-T Data Center REST API

Get paginated aggregated configuration for the draft

Get a paginated aggregated configuration of a given draft. This aggregated
configuration is the differnece between the current published firewall
configuration and a firewall configuration stored in a given draft.
For an initial API call, if request_id is present in a response, then this is
a paginated aggregated configuration of a given draft, containing all the
security policies from the aggregated configuration.
Using this request_id, more granular aggregated configuration, at security
policy level, can be fetched from subsequent API calls.
Absence of request_id suggests that whole aggregated configuration has been
returned as a response to initial API call, as the size of aggregated
configuration is not big enough to need pagination.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/drafts/{draft-id}/aggregated_with_pagination
/policy/api/v1/global-infra/drafts/{draft-id}/aggregated_with_pagination
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/drafts/{draft-id}/aggregated_with_pagination

Request Headers:

n/a

Query Parameters:

PolicyDraftPaginatedAggregatedConfigurationRequestParameters+

PolicyDraftPaginatedAggregatedConfigurationRequestParameters (schema)

Name	Description	Type	Notes
request_id	Request identifier to track subsequent API calls If the initial call to get paginated aggregated configuration for a draft, returns a paginated response, then the response will contain a request_id. This identifier needs to be passed with subsequent API calls to get detailed aggregated configuration for the draft.	string
root_path	Path of the root object of subtree Policy path of the security policy. If specified with the subsequent API calls after initial call to get paginated aggregated configuration for a draft, the response will return the subtree of this security policy having all its children. If not specified, then the subsequent API calls will return all the security policies without their children, from pre-calculated aggregated configuration of a draft. This is not required for an initial call to get paginated aggregated configuration for a draft.	string

Request Body:

n/a

Example Request:

1.Initial call to get paginated aggregated configuration. 2.Call to get the detailed aggregated configuration for a security policy

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

PolicyDraftPaginatedAggregatedConfigurationResult+

PolicyDraftPaginatedAggregatedConfigurationResult (schema)

Name	Description	Type	Notes
modifications	Total modification in aggregated configuration of a draft Total count of modified, deleted and created security policies/rules. List of modified security policies to be exposed to UI	PolicyDraftModifications
request_id	Request identifier to keep track of result Request identifier to keep track of calculated aggregated configuration a draft during subsequent API calls after initial API call. This identifier can be use to fetch the detailed aggregated configuration at security policy level. Absence of request_id suggests that whole aggregated configuration has been returned as a response to initial API call, as the size of aggregated configuration is not big enough to need pagination.	string	Readonly
result	Aggregated configuration of a draft Paginated aggregated configuration of a given draft. For an initial API call, if request_id is present in response, then this is a paginated aggregated configuration of a given draft. To get more granular aggregated configuration, request_id need to be passed to subsequent API calls. Absence of request_id suggests that whole aggregated configuration has been returned as a response to initial API call, as the size of aggregated configuration is not big enough to need pagination.	Infra	Readonly

Example Response:

1. Response to initial call to get paginated aggregated configuration. { "request_id": "3cd6bdc3-3f9c-4521-888d-4b23c3200206", "result": { "resource_type": "Infra", "id": "infra", "display_name": "infra", "path": "/infra", "children": [ { "children": [ { "SecurityPolicy": { "logging_enabled": false, "resource_type": "SecurityPolicy", "id": "app-section-1", "display_name": "app-section-1", "path": "/infra/domains/default/security-policies/app-section-1", "marked_for_delete": true, "overridden": false, "sequence_number": 0, "category": "Application", "stateful": true, "tcp_strict": true, "locked": false, "scope": [ "ANY" ], "rule_count": 200, "is_default": false, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }, "resource_type": "ChildSecurityPolicy", "marked_for_delete": true, "mark_for_override": false, "_protection": "NOT_PROTECTED" }, { "SecurityPolicy": { "logging_enabled": false, "resource_type": "SecurityPolicy", "id": "app-section-2", "display_name": "app-section-2", "path": "/infra/domains/default/security-policies/app-section-2", "marked_for_delete": true, "overridden": false, "sequence_number": 0, "category": "Application", "stateful": true, "tcp_strict": true, "locked": false, "scope": [ "ANY" ], "rule_count": 200, "is_default": false, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }, "resource_type": "ChildSecurityPolicy", "marked_for_delete": true, "mark_for_override": false, "_protection": "NOT_PROTECTED" } ], "target_type": "Domain", "resource_type": "ChildResourceReference", "id": "default", "marked_for_delete": false, "mark_for_override": false, "_protection": "NOT_PROTECTED" } ], "marked_for_delete": false, "overridden": false, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 } } 2. Response to a call to get the detailed aggregated configuration for a security policy { "request_id": "3cd6bdc3-3f9c-4521-888d-4b23c3200206", "result": { "resource_type": "Infra", "id": "infra", "display_name": "infra", "path": "/infra", "children": [ { "children": [ { "SecurityPolicy": { "logging_enabled": false, "resource_type": "SecurityPolicy", "id": "app-section-1", "display_name": "app-section-1", "path": "/infra/domains/default/security-policies/app-section-1", "children": [ { "Rule": { "action": "ALLOW", "resource_type": "Rule", "id": "rule_1", "display_name": "rule_1", "path": "/infra/domains/default/security-policies/app-section-1/rules/rule_1", "marked_for_delete": true, "overridden": false, "sequence_number": 1, "sources_excluded": false, "destinations_excluded": false, "source_groups": [ "/infra/domains/default/groups/d1" ], "destination_groups": [ "/infra/domains/default/groups/d2" ], "services": [ "ANY" ], "profiles": [ "ANY" ], "logged": true, "scope": [ "ANY" ], "disabled": false, "notes": "", "direction": "IN_OUT", "ip_protocol": "IPV4_IPV6", "is_default": false, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }, "resource_type": "ChildRule", "marked_for_delete": true, "mark_for_override": false, "_protection": "NOT_PROTECTED" } ], "marked_for_delete": true, "overridden": false, "sequence_number": 0, "category": "Application", "stateful": true, "tcp_strict": true, "locked": false, "scope": [ "ANY" ], "rule_count": 200, "is_default": false, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }, "resource_type": "ChildSecurityPolicy", "marked_for_delete": true, "mark_for_override": false, "_protection": "NOT_PROTECTED" } ], "target_type": "Domain", "resource_type": "ChildResourceReference", "id": "default", "marked_for_delete": false, "mark_for_override": false, "_protection": "NOT_PROTECTED" } ], "marked_for_delete": false, "overridden": false, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 } }

Required Permissions:

read

Feature:

policy_dfw

Additional Errors:

• 404 Not Found
• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable