Skip to content

virtual_ip_addresses

Overview

API to add, modify, delete, and get Virtual IP Address

Version information

Version : v2

URI scheme

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

Tags

  • virtual_ip_addresses : Operations related to virtual_ip_addresses

Paths

POST operation for virtual_ip_addresses

POST /virtual_ip_addresses

Description

Use this operation to add a Virtual IP address

Parameters

Type Name Schema
Body body
optional
virtual_ip_addresses_request_schema

Responses

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

  • virtual_ip_addresses

Get operation for virtual_ip_addresses

GET /virtual_ip_addresses

Description

Use this operation to get the list of Virtual IP addresses

Responses

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

  • virtual_ip_addresses

PUT operation for virtual_ip_addresses

PUT /virtual_ip_addresses

Description

Use this operation to modify a Virtual IP address

Responses

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

Produces

  • application/json

Tags

  • virtual_ip_addresses

DELETE operation for virtual_ip_addresses

DELETE /virtual_ip_addresses/{deletePathParam}

Description

Use this operation to delete a Virtual IP address

Parameters

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

Responses

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

  • virtual_ip_addresses

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

id

Auto-generated ID. Use this ID to modify or delete a Virtual IP address

Type : integer

ip_address

IP Address with prefix

Type : string

is_auto

Tells that this Virtual IP address is auto-generated

Type : boolean

is_identity

If enabled, the Virtual IP Address will be used for IP services

Type : boolean

is_private

If enabled, the Virtual IP Address will only be routable on the local Appliance

Type : boolean

package_name

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

Type : string

site_name

Site Name

Type : string

virtual_interface_name

Enter one of the associated Virtual Interfaces

Type : string

virtual_ip_addresses

Name Schema
id
optional
id
ip_address
optional
ip_address
is_auto
optional
is_auto
is_identity
optional
is_identity
is_private
optional
is_private
package_name
optional
package_name
site_name
optional
site_name
virtual_interface_name
optional
virtual_interface_name

virtual_ip_addresses_delete_success_schema

Name Schema
virtual_ip_addresses
optional
virtual_ip_addresses

virtual_ip_addresses

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

virtual_ip_addresses_post_success_schema

Name Schema
virtual_ip_addresses
optional
virtual_ip_addresses

virtual_ip_addresses

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

virtual_ip_addresses_put_success_schema

Name Schema
virtual_ip_addresses
optional
virtual_ip_addresses

virtual_ip_addresses

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

virtual_ip_addresses_request_schema

Name Schema
virtual_ip_addresses
optional
virtual_ip_addresses

virtual_ip_addresses_response_schema

Type : < virtual_ip_addresses_response_schema > array

virtual_ip_addresses_response_schema

Name Schema
id
optional
id
ip_address
optional
ip_address
is_auto
optional
is_auto
is_identity
optional
is_identity
is_private
optional
is_private
package_name
optional
package_name
site_name
optional
site_name
virtual_interface_name
optional
virtual_interface_name