Skip to content

ha_appliance

Overview

API to add, get and modify HA Appliance.

Version information

Version : v2

URI scheme

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

Tags

  • ha_appliance : Operations related to ha_appliance

Paths

Get operation for ha_appliance

GET /ha_appliance

Description

Use this operation to get HA Appliance

Responses

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

  • ha_appliance

PUT operation for ha_appliance

PUT /ha_appliance

Description

Use this operation to modify HA Appliance

Parameters

Type Name Schema
Body body
optional
ha_appliance_request_schema

Responses

HTTP Code Description Schema
200 Resource modified added ha_appliance_put_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

  • ha_appliance

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

ha_appliance

Name Schema
name
optional
name
package_name
optional
package_name
site_name
optional
site_name

ha_appliance_delete_success_schema

Name Schema
ha_appliance
optional
ha_appliance

ha_appliance

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

ha_appliance_post_success_schema

Name Schema
ha_appliance
optional
ha_appliance

ha_appliance

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

ha_appliance_put_success_schema

Name Schema
ha_appliance
optional
ha_appliance

ha_appliance

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

ha_appliance_request_schema

Name Schema
ha_appliance
optional
ha_appliance

ha_appliance_response_schema

Type : < ha_appliance_response_schema > array

ha_appliance_response_schema

Name Schema
name
optional
name
package_name
optional
package_name
site_name
optional
site_name

name

The HA appliance name

Type : string

package_name

Config package name using which the site API operation should be performed.

Type : string

site_name

Site Name

Type : string