config_packages

config_packages

Configuration for API to get, export to Change Management, compile and delete config packages resource.

Read/write properties

package_name <String>

Name of the config package. Minimum length = 1 Maximum length = 141

Read only properties

audits <audit_obj>

Config package compilation results..

Operations

compile add delete get (all) export_to_cm

[compile]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config/config_packages?action=compile

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

HTTP Method: POST

{"config_packages": { "package_name":<String> }}

Response Payload: JSON

{ "errorcode": 0, "message": "Done", "severity": <String;_value>}

[add]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config/config_packages

Description: Use this operation to create new configuration package.

HTTP Method: POST

Request Payload: JSON

{"config_packages": { "package_name":<String_value> }}

Response Payload: JSON

{ "config_packages":{ "package_name":<String_value>

, "audits":<audit_obj_value> }]}

[delete]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config/config_packages/package_name=<String>

Description: Use this operation to delete config package from change management

HTTP Method: DELETE

Response Payload: JSON

{ "errorcode": 0, "message": "Done", "severity": <String;_value> }

[get (all)]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config/config_packages

Description: Use this operation to get the config package information

HTTP Method: GET

Response Payload: JSON

{"config_packages":[{ "package_name":<String_value>

, "audits":<audit_obj_value> }]}

[export_to_cm]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config/config_packages?action=export_to_cm

Description: Use this operation to export the configuration package to change management

HTTP Method: POST

{"config_packages": { "package_name":<String> }}

Response Payload: JSON

{ "errorcode": 0, "message": "Done", "severity": <String;_value>}

Was this article helpful?