Skip to content

virtual_path_default_set_ipsec_properties

Overview

API to modify, get Virtual Path Default Set IPsec settings

Version information

Version : v2

URI scheme

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

Tags

  • virtual_path_default_set_ipsec_properties : Operations related to virtual_path_default_set_ipsec_properties

Paths

Get operation for virtual_path_default_set_ipsec_properties

GET /virtual_path_default_set_ipsec_properties

Description

Use this operation to get the Virtual Path Default Set IPsec settings

Responses

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

PUT operation for virtual_path_default_set_ipsec_properties

PUT /virtual_path_default_set_ipsec_properties

Description

Use this operation to modify Virtual Path Default Set IPsec settings

Parameters

Type Name Schema
Body body
optional
virtual_path_default_set_ipsec_properties_request_schema

Responses

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

  • virtual_path_default_set_ipsec_properties

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

encapsulation_type

Choose an IPsec protocol

Type : enum (esp, esp_auth, ah)

encryption_mode

If you chose ESP as the Tunnel Mode for this Virtual Path, choose an Encryption Algorithm.

Type : enum (aes128, aes256)

hash_algorithm

If you chose AH or ESP+Auth as the Tunnel Mode for this Virtual Path, choose a Hash Algorithm.

Type : enum (sha, sha256)

id

Auto-generated ID to uniquely identify Virtual Path Default Set IPsec settings

Type : integer

lifetime

Enter the amount of time, in seconds, for an IPsec security association to exist.

Type : integer

package_name

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

Type : string

secure_virtual_path_user_data_with_ipsec

Enable Secure Virtual Path User Data with IPsec to secure all user data in the Virtual Path using an IPsec tunnel.

Type : boolean

virtual_path_default_set_ipsec_properties

Name Schema
encapsulation_type
optional
encapsulation_type
encryption_mode
optional
encryption_mode
hash_algorithm
optional
hash_algorithm
id
optional
id
lifetime
optional
lifetime
package_name
optional
package_name
secure_virtual_path_user_data_with_ipsec
optional
secure_virtual_path_user_data_with_ipsec

virtual_path_default_set_ipsec_properties_delete_success_schema

Name Schema
virtual_path_default_set_ipsec_properties
optional
virtual_path_default_set_ipsec_properties

virtual_path_default_set_ipsec_properties

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

virtual_path_default_set_ipsec_properties_post_success_schema

Name Schema
virtual_path_default_set_ipsec_properties
optional
virtual_path_default_set_ipsec_properties

virtual_path_default_set_ipsec_properties

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

virtual_path_default_set_ipsec_properties_put_success_schema

Name Schema
virtual_path_default_set_ipsec_properties
optional
virtual_path_default_set_ipsec_properties

virtual_path_default_set_ipsec_properties

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

virtual_path_default_set_ipsec_properties_request_schema

Name Schema
virtual_path_default_set_ipsec_properties
optional
virtual_path_default_set_ipsec_properties

virtual_path_default_set_ipsec_properties_response_schema

Type : < virtual_path_default_set_ipsec_properties_response_schema > array

virtual_path_default_set_ipsec_properties_response_schema

Name Schema
encapsulation_type
optional
encapsulation_type
encryption_mode
optional
encryption_mode
hash_algorithm
optional
hash_algorithm
id
optional
id
lifetime
optional
lifetime
package_name
optional
package_name
secure_virtual_path_user_data_with_ipsec
optional
secure_virtual_path_user_data_with_ipsec
virtual_path_default_set_name
optional
virtual_path_default_set_name

virtual_path_default_set_name

Virtual path default set name using which the API operation should be performed.

Type : string