Skip to content

get_package_file

Overview

Downloads Package File. Note: Please ensure downloaded package name to be saved in zip format for compatibility

Version information

Version : v2

URI scheme

Host :
BasePath : /sdwan/nitro/v2/config/
Schemes : HTTP

Tags

  • get_package_file : Operations related to get_package_file

Paths

POST operation for get_package_file

POST /get_package_file

Description

Use this operation to Download a package from SD-WAN Appliance

Parameters

Type Name Description Schema
Query action
required
Select if action is other that ADD enum (file_download)
Body body
optional
get_package_file_request_schema

Responses

HTTP Code Description Schema
200 File Download successfully string (binary)
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Consumes

  • application/json

Produces

  • application/octet-stream
  • application/json

Tags

  • get_package_file

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

appliance_type

Appliance type: primary or secondary appliance

Type : enum (primary, secondary)

get_package_file

Name Schema
appliance_type
optional
appliance_type
package_type
optional
package_type
site_name
optional
site_name

get_package_file_delete_success_schema

Name Schema
get_package_file
optional
get_package_file

get_package_file

Name Description Schema
message
optional
Example : "resource deleted succesfully" string

get_package_file_post_success_schema

Name Schema
get_package_file
optional
get_package_file

get_package_file

Name Description Schema
message
optional
Example : "resource added succesfully" string

get_package_file_put_success_schema

Name Schema
get_package_file
optional
get_package_file

get_package_file

Name Description Schema
message
optional
Example : "resource modified succesfully" string

get_package_file_request_schema

Name Schema
get_package_file
optional
get_package_file

get_package_file_response_schema

Type : < get_package_file_response_schema > array

get_package_file_response_schema

Name Schema
appliance_type
optional
appliance_type
package_type
optional
package_type
site_name
optional
site_name

package_type

Download Package Type

Type : enum (active, staging)

site_name

Site Name

Type : string