Skip to content

config_packages

Overview

API to get, export to Change Management, compile and delete config packages

Version information

Version : v2

URI scheme

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

Tags

  • config_packages : Operations related to config_packages

Paths

POST operation for config_packages

POST /config_packages

Description

Use this operation to compile the configuration package to get audit errors/warnings list.

Parameters

Type Name Description Schema
Query action
optional
Select if action is other that ADD enum (compile, export_to_cm)
Body body
optional
config_packages_request_schema

Responses

HTTP Code Description Schema
200 Resource successfully added config_packages_post_success_schema
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/json

Tags

  • config_packages

Get operation for config_packages

GET /config_packages

Description

Use this operation to get the config package information

Responses

HTTP Code Description Schema
200 API Successfully executed config_packages_response_schema
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

Produces

  • application/json

Tags

  • config_packages

DELETE operation for config_packages

DELETE /config_packages/{deletePathParam}

Description

Use this operation to delete a config package

Parameters

Type Name Description Schema
Path deletePathParam
required
Object Primary Key for DELETE operation object

Responses

HTTP Code Description Schema
200 Resource delete added config_packages_delete_success_schema
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

Produces

  • application/json

Tags

  • config_packages

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

audits

Config package compilation results.

Name Description Schema
error
optional
read-only
List of error messages. < error > array
notice
optional
read-only
List of notice messages. < notice > array
warning
optional
read-only
List of warning messages. < warning > array

error

Name Description Schema
code
optional
read-only
Audit code. string
msg
optional
read-only
Audit message. string
object
optional
read-only
Object to which the audit message corresponds to. string
parentuiid
optional
read-only
Unique identifier of parent object. string
severity
optional
read-only
Severity of the audit message. string
siteuiid
optional
read-only
Site unique identifier of the object corresponding to the audit message. string
uiid
optional
read-only
Unique identifier of the object corresponding to the audit message. string

notice

Name Description Schema
code
optional
read-only
Audit code. string
msg
optional
read-only
Audit message. string
object
optional
read-only
Object to which the audit message corresponds to. string
parentuiid
optional
read-only
Unique identifier of parent object. string
severity
optional
read-only
Severity of the audit message. string
siteuiid
optional
read-only
Site unique identifier of the object corresponding to the audit message. string
uiid
optional
read-only
Unique identifier of the object corresponding to the audit message. string

warning

Name Description Schema
code
optional
read-only
Audit code. string
msg
optional
read-only
Audit message. string
object
optional
read-only
Object to which the audit message corresponds to. string
parentuiid
optional
read-only
Unique identifier of parent object. string
severity
optional
read-only
Severity of the audit message. string
siteuiid
optional
read-only
Site unique identifier of the object corresponding to the audit message. string
uiid
optional
read-only
Unique identifier of the object corresponding to the audit message. string

config_packages

Name Schema
package_name
optional
package_name

config_packages_delete_success_schema

Name Schema
config_packages
optional
config_packages

config_packages

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

config_packages_post_success_schema

Name Schema
config_packages
optional
config_packages

config_packages

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

config_packages_put_success_schema

Name Schema
config_packages
optional
config_packages

config_packages

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

config_packages_request_schema

Name Schema
config_packages
optional
config_packages

config_packages_response_schema

Type : < config_packages_response_schema > array

config_packages_response_schema

Name Schema
audits
optional
audits
package_name
optional
package_name

package_name

Name of the config package

Type : string