NSX-T Data Center REST API

Associated URIs:

API Description	API Path
List policy drafts List policy drafts.	GET /policy/api/v1/infra/drafts GET /policy/api/v1/global-infra/drafts GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/drafts
Delete a manual draft Delete a manual draft.	DELETE /policy/api/v1/infra/drafts/{draft-id} DELETE /policy/api/v1/global-infra/drafts/{draft-id} DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/drafts/{draft-id}
Read draft Read a draft for a given draft identifier.	GET /policy/api/v1/infra/drafts/{draft-id} GET /policy/api/v1/global-infra/drafts/{draft-id} GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/drafts/{draft-id}
Patch a manual draft Create a new manual draft if the specified draft id does not correspond to an existing draft. Update the manual draft otherwise. Auto draft can not be updated.	PATCH /policy/api/v1/infra/drafts/{draft-id} PATCH /policy/api/v1/global-infra/drafts/{draft-id} PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/drafts/{draft-id}
Publish a draft Read a draft and publish it by applying changes onto current configuration. If there are additional changes on top of draft configuration, pass it as a request body, in form of Infra object. Otherwise, if there are no additional changes, then pass empty Infra object as a request body.	POST /policy/api/v1/infra/drafts/{draft-id}?action=publish POST /policy/api/v1/global-infra/drafts/{draft-id}?action=publish POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/drafts/{draft-id}?action=publish
Create or update a manual draft Create a new manual draft if the specified draft id does not correspond to an existing draft. Update the manual draft otherwise. Auto draft can not be updated.	PUT /policy/api/v1/infra/drafts/{draft-id} PUT /policy/api/v1/global-infra/drafts/{draft-id} PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/drafts/{draft-id}
Get an aggregated configuration for the draft Get an aggregated configuration that will get applied onto current configuration during publish of this draft. The response is a hierarchical payload containing the aggregated configuration differences from the latest auto draft till the specified draft.	GET /policy/api/v1/infra/drafts/{draft-id}/aggregated GET /policy/api/v1/global-infra/drafts/{draft-id}/aggregated GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/drafts/{draft-id}/aggregated
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.	GET /policy/api/v1/infra/drafts/{draft-id}/aggregated_with_pagination GET /policy/api/v1/global-infra/drafts/{draft-id}/aggregated_with_pagination GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/drafts/{draft-id}/aggregated_with_pagination
Get a preview of a configuration after publish of a draft Get a preview of a configuration which will be present after publish of a specified draft. The response essentially is a hierarchical payload containing the configuration, which will be in active after a specified draft gets published onto current configuration.	GET /policy/api/v1/infra/drafts/{draft-id}/complete GET /policy/api/v1/global-infra/drafts/{draft-id}/complete GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/drafts/{draft-id}/complete