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.

Request:

Method:

POST

URI Path(s):

/policy/api/v1/infra/settings/firewall/export

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

ExportRequestParameter+

Name	Description	Type	Notes
draft_path	Policy path of draft Policy path of a draft which is to be exported. If not provided, current firewall configuration will then be exported.	string
passphrase	Passphrase to sign exported files Passphrase to sign exported files. The passphrase specified must be at least 8 characters in length and must contain at least one lowercase, one uppercase, one numeric character and one non-space special character.	string	Required Minimum length: 8 Pattern: "^$\|^(?=.[a-z])(?=.[A-Z])(?=.\d)(?=.[^a-zA-Z\d\s]).{8,}$"

Example Request:

1. Export of current firewall configuration, POST https://<policy-mgr>/policy/api/v1/infra/settings/firewall/export { "passphrase": "AA12!@bb" } 2. Export of the draft, POST https://<policy-mgr>/policy/api/v1/infra/settings/firewall/export { "passphrase": "AA12!@bb", "draft_path": "/infra/drafts/draft1" }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ExportTask+

ExportTask (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
async_response_available	True if response for asynchronous request is available	boolean	Readonly
cancelable	True if this task can be canceled	boolean	Readonly
description	Description of the task	string	Readonly
draft_path	Policy path of a draft Policy path of a draft if this is an export task to export draft configuration.	string	Readonly
end_time	The end time of the task in epoch milliseconds	EpochMsTimestamp	Readonly
exported_file	Name of the exported file Name of the exported file generated after completion of export task.	string	Readonly
failure_msg	Reason of the task failure This property holds the reason of the task failure, if any.	string	Readonly
id	Identifier for this task	string	Readonly
message	A message describing the disposition of the task	string	Readonly
progress	Task progress if known, from 0 to 100	integer	Readonly Minimum: 0 Maximum: 100
request_method	HTTP request method	string	Readonly
request_uri	URI of the method invocation that spawned this task	string	Readonly
start_time	The start time of the task in epoch milliseconds	EpochMsTimestamp	Readonly
status	Current status of the task	TaskStatus	Readonly
user	Name of the user who created this task	string	Readonly

Example Response:

1. Export of current firewall configuration, { "id": "export_task", "status": "running", "description": "Export of the current firewall configuration.", "exported_file": "fw_config_apr2020.zip", "failure_msg": null, "user": "admin", "start_time": 1587491995996 } 2. Export of the draft, { "id": "export_task", "status": "running", "description": "Export of the draft /infra/drafts/draft1", "exported_file": "draft1.zip", "failure_msg": null, "user": "admin", "start_time": 1587491995996 }

Invoke export task

Request:

ExportRequestParameter (schema)

Example Request:

Successful Response:

ExportTask (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: