NSX-T Data Center REST API

Associated URIs:

API Description API Path

Get the information of export task


Get the information of the latest export task.
GET /policy/api/v1/infra/settings/firewall/export
GET /policy/api/v1/global-infra/settings/firewall/export
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/export

Download exported file


Download the exported file generated from the last export task. The request
should have proper headers set to download the file. Please add the below
two headers, if it is not already present
Accept application/json, text/plain, */*
Accept-Encoding gzip, deflate, br
GET /policy/api/v1/infra/settings/firewall/export?action=download
GET /policy/api/v1/global-infra/settings/firewall/export?action=download
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/export?action=download

Cancel a running export task


This operation cancels an export task. Task needs to be in running state.
POST /policy/api/v1/infra/settings/firewall/export?action=cancel
POST /policy/api/v1/global-infra/settings/firewall/export?action=cancel
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/export?action=cancel

Invoke export task


Invoke export task. There can be only one export task run at any point of
time. Hence invocation of another export task will be discarded, when there
exist an already running export task.
Exported configuration will be in a CSV format. This CSV file will be zipped
into a ZIP file, that can be downloaded after the completion of export task.
POST /policy/api/v1/infra/settings/firewall/export
POST /policy/api/v1/global-infra/settings/firewall/export
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/export

Get the information of import task


Get the information of the latest import task.
GET /policy/api/v1/infra/settings/firewall/import
GET /policy/api/v1/global-infra/settings/firewall/import
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/import

Invoke import task


Invoke import task. There can be only one import task run at any point of
time. Hence invocation of another import task will be discarded, when there
exist an already running import task.
POST /policy/api/v1/infra/settings/firewall/import
POST /policy/api/v1/global-infra/settings/firewall/import
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/import

Cancel a running import task


This operation cancels an import task. Task needs to be in running state.
POST /policy/api/v1/infra/settings/firewall/import?action=cancel
POST /policy/api/v1/global-infra/settings/firewall/import?action=cancel
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/settings/firewall/import?action=cancel