CreateIPsecConnection

POST/zstack/v1/ipsec

Operation ID

CreateIPsecConnection

Since

0.6

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

params
ObjectRequired
Request body parameter object.
- name
  StringRequired
  The resource name.
- description
  String
  Optional. The detailed description of the resource.
- peerAddress
  StringRequired
  The remote network address.
- authMode
  String
  Optional. The authentication mode.
- authKey
  StringRequired
  The authentication key.
- idType
  String
  The ID configuration method.
- vipUuid
  StringRequired
  The VIP UUID.
- localId
  String
  Optional. The local ID.
- remoteId
  String
  Optional. The remote ID.
- peerCidrs
  List
  Optional. The detination network Cidrs.
- ikeVersion
  String
  Optional. The IKE version.
- ikeAuthAlgorithm
  String
  Optional. The IKE authentication algorithm.
- ikeEncryptionAlgorithm
  String
  Optional. The IKE encryption algorithm.
- ikeDhGroup
  int
  Optional. The IKE DH Group.
- ikeLifeTime
  int
  Optional. The IKE lifetime.
- policyAuthAlgorithm
  String
  Optional. The ESP authentication algorithm.
- policyEncryptionAlgorithm
  String
  Optional. The ESP encryption algorithm.
- pfs
  String
  Optional. The perfect forward secrecy.
- policyMode
  String
  Optional. The policy mode.
- transformProtocol
  String
  Optional. The transform protocol.
- resourceUuid
  String
  Optional. The resource UUID.
- tagUuids
  List
  Optional. The tag UUID list.
paramsstructure
ObjectRequired
paramsstructure request body object.
- l3NetworkUuid
  String
  Optional. The L3 network UUID.
systemTags
List
Optional. The system tags.
userTags
List
Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

success
booleanRequired
Whether the operation succeeded.
error
ErrorCodeRequired
The error code. If not null, the operation fails, or vice versa. For more information, see error.
- code
  StringRequired
  The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.
- description
  StringRequired
  The brief description of the error.
- details
  StringRequired
  The details about the error.
- elaboration
  StringRequired
  The reserved field. Default value: null.
- opaque
  LinkedHashMapRequired
  The reserved field. Default value: null.
- cause
  ErrorCodeRequired
  The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.
inventory
IPsecConnectionInventoryRequired
See inventory.
- uuid
  StringRequired
  The resource UUID.
- name
  StringRequired
  The resource name.
- description
  StringRequired
  The detailed description of the resource.
- peerAddress
  StringRequired
  The remote network address.
- authMode
  StringRequired
  The authentication mode.
- authKey
  StringRequired
  The authentication key.
- vipUuid
  StringRequired
  The VIP UUID.
- ikeAuthAlgorithm
  StringRequired
  The IKE authentication algorithm.
- ikeEncryptionAlgorithm
  StringRequired
  The IKE encryption algorithm.
- ikeDhGroup
  IntegerRequired
  The IKE DH group.
- policyAuthAlgorithm
  StringRequired
  The ESP authentication algorithm.
- policyEncryptionAlgorithm
  StringRequired
  The ESP encryption algorithm.
- pfs
  StringRequired
  The PFS DH group.
- policyMode
  StringRequired
  The encryption mode.
- transformProtocol
  StringRequired
  The security protocol.
- ikeVersion
  StringRequired
  The IKE version.
- idType
  StringRequired
  The ID configuration method.
- localId
  StringRequired
  The local ID.
- remoteId
  StringRequired
  The remote ID.
- state
  StringRequired
  The running state.
- status
  StringRequired
  The ready status.
- ikeLifeTime
  intRequired
  The IKE lifetime.
- lifeTime
  intRequired
  The IPsec lifetime.
- createDate
  TimestampRequired
  The creation date.
- lastOpDate
  TimestampRequired
  The last operation date.
- peerCidrs
  ListRequired
  See peerCidrs.
  uuid
  StringRequired
  The resource UUID.
  cidr
  StringRequired
  The cidr.
  connectionUuid
  StringRequired
  The connection UUID.
  createDate
  TimestampRequired
  The creation date.
  lastOpDate
  TimestampRequired
  The last operation date.
- l3NetworkRefs
  ListRequired
  See l3NetworkRefs.
  uuid
  StringRequired
  The resource UUID.
  connectionUuid
  StringRequired
  The connection UUID.
  l3NetworkUuid
  StringRequired
  The L3 network UUID.
  createDate
  TimestampRequired
  The creation date.
  lastOpDate
  TimestampRequired
  The last operation date.

Request Example

curl -X POST '{host}/zstack/v1/ipsec' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -d '{
  "params": {
    "name": "{name}",
    "description": "{description}",
    "peerAddress": "{peerAddress}",
    "authMode": "{authMode}",
    "authKey": "{authKey}",
    "idType": "{idType}",
    "vipUuid": "{vipUuid}",
    "localId": "{localId}",
    "remoteId": "{remoteId}",
    "peerCidrs": [
      "{peerCidrs}"
    ],
    "ikeVersion": "{ikeVersion}",
    "ikeAuthAlgorithm": "{ikeAuthAlgorithm}",
    "ikeEncryptionAlgorithm": "{ikeEncryptionAlgorithm}",
    "ikeDhGroup": "{ikeDhGroup}",
    "ikeLifeTime": "{ikeLifeTime}",
    "policyAuthAlgorithm": "{policyAuthAlgorithm}",
    "policyEncryptionAlgorithm": "{policyEncryptionAlgorithm}",
    "pfs": "{pfs}",
    "policyMode": "{policyMode}",
    "transformProtocol": "{transformProtocol}",
    "resourceUuid": "{resourceUuid}",
    "tagUuids": [
      "{tagUuids}"
    ]
  },
  "paramsstructure": {
    "l3NetworkUuid": "{l3NetworkUuid}"
  },
  "systemTags": [
    "{systemTags}"
  ],
  "userTags": [
    "{userTags}"
  ]
}'

Response Example

{
  "inventory": {
    "name": "Test-IPSec",
    "peerAddress": "100.64.10.10",
    "authKey": "auth",
    "vipUuid": "6a33d0d912263fd7a47d036eead9a27f",
    "status": "Connecting",
    "ikeLifeTime": 0,
    "lifeTime": 0,
    "peerCidrs": [
      {
        "uuid": "199b04405d1e3fef83fd67a7a1f77bb3",
        "cidr": "192.168.100.0/24",
        "connectionUuid": "6deaa1c0ffd43f8eb3ebe2e8e7e66811",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ],
    "l3NetworkRefs": [
      {}
    ]
  }
}

Change History

View all change history

Change TimeChange SummaryAction

Change Time
2026-09-23
AddedRequest body fields paramsstructure
View API

VM Instance Operations

Volume Operations

Image Operations

Affinity Group Operations

VM Scheduling Rule Group Operations

Instance Offering Operations

Disk Offering Operations

Auto-Scaling Group Operations

Snapshot Group Operations

SSH Key Operations

Zone Operations

Cluster Operations

Host Operations

GPU Device Operations

Primary Storage Operations

Backup Storage Operations

SAN Storage Operations

Physical Network Operations

PCI Device Operations

USB Redirection Operations

USB Pass-through Operations

SR-IOV Operations

Loongarch SE Operations

Hygon SE Operations

Local Storage Operations

NFS Primary Storage Operations

Shared Mount Point Primary Storage Operations

Ceph Primary Storage Operations

Shared Block Primary Storage Operations

XStor Block Primary Storage Operations

ImageStore Backup Storage Operations

Ceph Backup Storage Operations

iSCSI Server Operations

FC Storage Operations

NVMe Storage Operations

Hardware SDN Controller Operations

L2 Network Operations

L3 Network Operations

Route Resource Operations

VPC Operations

OSPF Operations

Multicast Routing Operations

Policy Routing Operations

vRouter Route Table Operations

Network Service Operations

VPC Firewall Operations

Security Group Operations

VIP Operations

EIP Operations

Port Forwarding Operations

Load Balancing Operations

IPsec Operations

NetFlow APIs

Port Mirroring APIs

Shared Bandwidth Operations

Network Security Policy Schedule Operations

CloudFormation Operations

Bare Metal Management Operations

Installation Service Operations

Elastic Bare Metal Management(Plus)

vCenter Operations

Capacity Management Operations

SNS Operations

Metric Operations

Event Operations

Alarm Operations

Event Subscription Operations

Text Template Operations

Audit Operations

CBT Operations

Backup Service Operations

CDP Operations

Script Library

XML Hook

Job Scheduling APIs

Tag Operations

Migration Service Operations

Organization Operations

Project Operations

Ticket Operations