Skip to content

appliance_ha_status

Overview

This resource provides the appliance is in active or passive. This is an Internal API used by SD-WAN Center to find the active appliance

Version information

Version : v2

URI scheme

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

Tags

  • appliance_ha_status : Operations related to appliance_ha_status

Paths

Get operation for appliance_ha_status

GET /appliance_ha_status

Description

Use this operation to get the appliance status.

Responses

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

  • appliance_ha_status

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

appliance_ha_status_delete_success_schema

Name Schema
appliance_ha_status
optional
appliance_ha_status

appliance_ha_status

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

appliance_ha_status_post_success_schema

Name Schema
appliance_ha_status
optional
appliance_ha_status

appliance_ha_status

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

appliance_ha_status_put_success_schema

Name Schema
appliance_ha_status
optional
appliance_ha_status

appliance_ha_status

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

appliance_ha_status_response_schema

Type : < appliance_ha_status_response_schema > array

appliance_ha_status_response_schema

Name Schema
is_active
optional
is_active
status
optional
status

is_active

If it's active, then is_active will be 1 else it will be 0

Type : boolean

status

response status

Type : string