This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

VPN

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of VPN service and how to call CLI. The output is formatted as a JSON string

Version

VersionStatusSupported Until
1.0DEPRECATED20251231
1.1CURRENT-

1 - CLIs

1.1 - Create VPN Gateway

1.1.1 - 1.1

scpcli vpn vpn-gateway create
--vpc_id <value>
--name <value>
--ip_type <value>
--ip_id <value>
--ip_address <value>
[--description <value>]
[--tags <value>]

Description

Create VPN gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpc_id
required		stringVPC Idceb44ea5ecb34a49b16495f9a63b0718
name
required		stringVPN Gateway NameExampleVpnGW1
ip_type
required		stringVPN Gateway IP TypePUBLIC
ip_id
required		stringVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_address
required		stringVPN Gateway IP Address123.0.0.1
description
optional		stringDescriptionExample Description for VPN Gateway
tags
optional		arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Gateway
ip_addressVPN Gateway IP Address123.0.0.1
ip_idVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_typeVPN Gateway IP TypePUBLIC
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Gateway NameExampleVpnGW1
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1

1.1.2 - 1.0

scpcli vpn vpn-gateway create
--vpc_id <value>
--name <value>
--ip_type <value>
--ip_id <value>
--ip_address <value>
[--description <value>]
[--tags <value>]

Description

Create VPN gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required		stringVPC Idceb44ea5ecb34a49b16495f9a63b0718
name
required		stringVPN Gateway NameExampleVpnGW1
ip_type
required		stringVPN Gateway IP TypePUBLIC
ip_id
required		stringVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_address
required		stringVPN Gateway IP Address123.0.0.1
description
optional		stringDescriptionExample Description for VPN Gateway
tags
optional		arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Gateway
ip_addressVPN Gateway IP Address123.0.0.1
ip_idVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_typeVPN Gateway IP TypePUBLIC
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Gateway NameExampleVpnGW1
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1

1.2 - Create VPN Tunnel

1.2.1 - 1.1

scpcli vpn vpn-tunnel create
--remote_subnets <value>
--phase2_life_time <value>
--phase2_encryptions <value>
--phase2_diffie_hellman_groups <value>
--perfect_forward_secrecy <value>
--pre_shared_key <value>
--phase1_life_time <value>
--phase1_encryptions <value>
--phase1_diffie_hellman_groups <value>
--peer_gateway_ip <value>
--ike_version <value>
--dpd_retry_interval <value>
--vpn_gateway_id <value>
--name <value>
[--description <value>]
[--tags <value>]

Description

Create VPN tunnel.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
remote_subnets
required		arrayVPN Tunnel IPSec Remote Subnet10.1.1.0/24
phase2_life_time
required		integerVPN Tunnel IPSec Lifetime (sec)43200
phase2_encryptions
required		arrayVPN Tunnel ISAKMP Proposal Listnull-md5
phase2_diffie_hellman_groups
required		arrayVPN Tunnel ISAKMP Diffie-Hellman Group List30
perfect_forward_secrecy
required		stringVPN Tunnel IPSec Perfect Forward Secrecy(PFS)ENABLE
pre_shared_key
required		stringVPN Tunnel ISAKMP Authentication : Pre-shared KeyPreSharedKey1
phase1_life_time
required		integerVPN Tunnel ISAKMP Lifetime (sec)86400
phase1_encryptions
required		arrayVPN Tunnel ISAKMP Proposal Listdes-md5
phase1_diffie_hellman_groups
required		arrayVPN Tunnel ISAKMP Diffie-Hellman Group List30
peer_gateway_ip
required		stringVPN Tunnel Peer Gateway IP Address123.0.0.2
ike_version
required		integerVPN Tunnel IKE Version2
dpd_retry_interval
required		integerVPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec)60
vpn_gateway_id
required		stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
name
required		stringVPN Tunnel NameExampleVpnTunnel1
description
optional		stringDescriptionExample Description for VPN Tunnel
tags
optional		arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Tunnel
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Tunnel NameExampleVpnTunnel1
phase1VPN Tunnel Phase1
phase2VPN Tunnel Phase2
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1
vpn_gateway_idVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_ip_addressVPN Gateway IP Address123.0.0.1
vpn_gateway_nameVPN Gateway NameExampleVpnGW1

1.2.2 - 1.0

scpcli vpn vpn-tunnel create
--remote_subnet <value>
--phase2_life_time <value>
--phase2_encryptions <value>
--phase2_diffie_hellman_groups <value>
--perfect_forward_secrecy <value>
--pre_shared_key <value>
--phase1_life_time <value>
--phase1_encryptions <value>
--phase1_diffie_hellman_groups <value>
--peer_gateway_ip <value>
--ike_version <value>
--dpd_retry_interval <value>
--vpn_gateway_id <value>
--name <value>
[--description <value>]
[--tags <value>]

Description

Create VPN tunnel.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
remote_subnet
required		stringVPN Tunnel IPSec Remote Subnet10.1.0.0/16
phase2_life_time
required		integerVPN Tunnel IPSec Lifetime (sec)43200
phase2_encryptions
required		arrayVPN Tunnel ISAKMP Proposal Listnull-md5
phase2_diffie_hellman_groups
required		arrayVPN Tunnel ISAKMP Diffie-Hellman Group List30
perfect_forward_secrecy
required		stringVPN Tunnel IPSec Perfect Forward Secrecy(PFS)ENABLE
pre_shared_key
required		stringVPN Tunnel ISAKMP Authentication : Pre-shared KeyPreSharedKey1
phase1_life_time
required		integerVPN Tunnel ISAKMP Lifetime (sec)86400
phase1_encryptions
required		arrayVPN Tunnel ISAKMP Proposal Listdes-md5
phase1_diffie_hellman_groups
required		arrayVPN Tunnel ISAKMP Diffie-Hellman Group List30
peer_gateway_ip
required		stringVPN Tunnel Peer Gateway IP Address123.0.0.2
ike_version
required		integerVPN Tunnel IKE Version2
dpd_retry_interval
required		integerVPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec)60
vpn_gateway_id
required		stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
name
required		stringVPN Tunnel NameExampleVpnTunnel1
description
optional		stringDescriptionExample Description for VPN Tunnel
tags
optional		arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Tunnel
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Tunnel NameExampleVpnTunnel1
phase1VPN Tunnel Phase1
phase2VPN Tunnel Phase2
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1
vpn_gateway_idVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_ip_addressVPN Gateway IP Address123.0.0.1
vpn_gateway_nameVPN Gateway NameExampleVpnGW1

1.3 - Delete VPN Gateway

1.3.1 - 1.1

scpcli vpn vpn-gateway delete
--vpn_gateway_id <value>

Description

Delete VPN gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpn_gateway_id
required		stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a

1.3.2 - 1.0

scpcli vpn vpn-gateway delete
--vpn_gateway_id <value>

Description

Delete VPN gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpn_gateway_id
required		stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a

1.4 - Delete VPN Tunnel

1.4.1 - 1.1

scpcli vpn vpn-tunnel delete
--vpn_tunnel_id <value>

Description

Delete VPN tunnel.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpn_tunnel_id
required		stringVPN Tunnel ID2ade2919287040bc92e557fbbe6709c1

1.4.2 - 1.0

scpcli vpn vpn-tunnel delete
--vpn_tunnel_id <value>

Description

Delete VPN tunnel.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpn_tunnel_id
required		stringVPN Tunnel ID2ade2919287040bc92e557fbbe6709c1

1.5 - List VPN Gateways

1.5.1 - 1.1

scpcli vpn vpn-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--ip_address <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

Get VPN gateway list.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
size
optional		integersize20
page
optional		integerpage0
sort
optional		stringsortcreated_at:desc
name
optional		stringVPN Gateway NameExampleVpnGW1
ip_address
optional		stringVPN Gateway IP Address123.0.0.1
vpc_id
optional		stringVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_name
optional		stringVPC NameExampleVPC1

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Gateway
ip_addressVPN Gateway IP Address123.0.0.1
ip_idVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_typeVPN Gateway IP TypePUBLIC
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Gateway NameExampleVpnGW1
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1

1.5.2 - 1.0

scpcli vpn vpn-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--ip_address <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

Get VPN gateway list.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
size
optional		integersize20
page
optional		integerpage0
sort
optional		stringsortcreated_at:desc
name
optional		stringVPN Gateway NameExampleVpnGW1
ip_address
optional		stringVPN Gateway IP Address123.0.0.1
vpc_id
optional		stringVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_name
optional		stringVPC NameExampleVPC1

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Gateway
ip_addressVPN Gateway IP Address123.0.0.1
ip_idVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_typeVPN Gateway IP TypePUBLIC
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Gateway NameExampleVpnGW1
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1

1.6 - List VPN Tunnels

1.6.1 - 1.1

scpcli vpn vpn-tunnel list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--vpn_gateway_id <value>]
[--vpn_gateway_name <value>]

Description

Get VPN tunnel list.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
size
optional		integersize20
page
optional		integerpage0
sort
optional		stringsortcreated_at:desc
name
optional		stringVPN Tunnel NameExampleVpnTunnel1
vpn_gateway_id
optional		stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_name
optional		stringVPN Gateway NameExampleVpnGW1

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Tunnel
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Tunnel NameExampleVpnTunnel1
phase1VPN Tunnel Phase1
phase2VPN Tunnel Phase2
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1
vpn_gateway_idVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_ip_addressVPN Gateway IP Address123.0.0.1
vpn_gateway_nameVPN Gateway NameExampleVpnGW1

1.6.2 - 1.0

scpcli vpn vpn-tunnel list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--vpn_gateway_id <value>]
[--vpn_gateway_name <value>]
[--peer_gateway_ip <value>]
[--remote_subnet <value>]

Description

Get VPN tunnel list.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
size
optional		integersize20
page
optional		integerpage0
sort
optional		stringsortcreated_at:desc
name
optional		stringVPN Tunnel NameExampleVpnTunnel1
vpn_gateway_id
optional		stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_name
optional		stringVPN Gateway NameExampleVpnGW1
peer_gateway_ip
optional		stringVPN Tunnel Peer Gateway IP Address123.0.0.2
remote_subnet
optional		stringVPN Tunnel IPSec Remote Subnet10.1.0.0/16

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Tunnel
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Tunnel NameExampleVpnTunnel1
phase1VPN Tunnel Phase1
phase2VPN Tunnel Phase2
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1
vpn_gateway_idVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_ip_addressVPN Gateway IP Address123.0.0.1
vpn_gateway_nameVPN Gateway NameExampleVpnGW1

1.7 - Set VPN Gateway

1.7.1 - 1.1

scpcli vpn vpn-gateway set
--vpn_gateway_id <value>
[--description <value>]

Description

Set VPN gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpn_gateway_id
required		stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
description
optional		stringDescriptionExample Description for VPN Gateway

1.7.2 - 1.0

scpcli vpn vpn-gateway set
--vpn_gateway_id <value>
[--description <value>]

Description

Set VPN gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpn_gateway_id
required		stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
description
optional		stringDescriptionExample Description for VPN Gateway

1.8 - Set VPN Tunnel

1.8.1 - 1.1

scpcli vpn vpn-tunnel set
--vpn_tunnel_id <value>
[--description <value>]
[--dpd_retry_interval <value>]
[--ike_version <value>]
[--peer_gateway_ip <value>]
[--phase1_diffie_hellman_groups <value>]
[--phase1_encryptions <value>]
[--phase1_life_time <value>]
[--pre_shared_key <value>]
[--perfect_forward_secrecy <value>]
[--phase2_diffie_hellman_groups <value>]
[--phase2_encryptions <value>]
[--phase2_life_time <value>]
[--remote_subnets <value>]

Description

Set VPN tunnel.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpn_tunnel_id
required		stringVPN Tunnel ID2ade2919287040bc92e557fbbe6709c1
description
optional		stringDescriptionExample Description for VPN Tunnel
dpd_retry_interval
optional		integerVPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec)60
ike_version
optional		integerVPN Tunnel IKE Version2
peer_gateway_ip
optional		stringVPN Tunnel Peer Gateway IP Address123.0.0.2
phase1_diffie_hellman_groups
optional		arrayVPN Tunnel ISAKMP Diffie-Hellman Group List30
phase1_encryptions
optional		arrayVPN Tunnel ISAKMP Proposal Listdes-md5
phase1_life_time
optional		integerVPN Tunnel ISAKMP Lifetime (sec)86400
pre_shared_key
optional		stringVPN Tunnel ISAKMP Authentication : Pre-shared KeyPreSharedKey1
perfect_forward_secrecy
optional		****VPN Tunnel IPSec Perfect Forward Secrecy(PFS)ENABLE
phase2_diffie_hellman_groups
optional		arrayVPN Tunnel ISAKMP Diffie-Hellman Group List30
phase2_encryptions
optional		arrayVPN Tunnel ISAKMP Proposal Listnull-md5
phase2_life_time
optional		integerVPN Tunnel IPSec Lifetime (sec)43200
remote_subnets
optional		arrayVPN Tunnel IPSec Remote Subnet10.1.1.0/24

1.8.2 - 1.0

scpcli vpn vpn-tunnel set
--vpn_tunnel_id <value>
[--description <value>]
[--dpd_retry_interval <value>]
[--ike_version <value>]
[--peer_gateway_ip <value>]
[--phase1_diffie_hellman_groups <value>]
[--phase1_encryptions <value>]
[--phase1_life_time <value>]
[--pre_shared_key <value>]
[--perfect_forward_secrecy <value>]
[--phase2_diffie_hellman_groups <value>]
[--phase2_encryptions <value>]
[--phase2_life_time <value>]
[--remote_subnet <value>]

Description

Set VPN tunnel.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpn_tunnel_id
required		stringVPN Tunnel ID2ade2919287040bc92e557fbbe6709c1
description
optional		stringDescriptionExample Description for VPN Tunnel
dpd_retry_interval
optional		integerVPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec)60
ike_version
optional		integerVPN Tunnel IKE Version2
peer_gateway_ip
optional		stringVPN Tunnel Peer Gateway IP Address123.0.0.2
phase1_diffie_hellman_groups
optional		arrayVPN Tunnel ISAKMP Diffie-Hellman Group List30
phase1_encryptions
optional		arrayVPN Tunnel ISAKMP Proposal Listdes-md5
phase1_life_time
optional		integerVPN Tunnel ISAKMP Lifetime (sec)86400
pre_shared_key
optional		stringVPN Tunnel ISAKMP Authentication : Pre-shared KeyPreSharedKey1
perfect_forward_secrecy
optional		****VPN Tunnel IPSec Perfect Forward Secrecy(PFS)ENABLE
phase2_diffie_hellman_groups
optional		arrayVPN Tunnel ISAKMP Diffie-Hellman Group List30
phase2_encryptions
optional		arrayVPN Tunnel ISAKMP Proposal Listnull-md5
phase2_life_time
optional		integerVPN Tunnel IPSec Lifetime (sec)43200
remote_subnet
optional		stringVPN Tunnel IPSec Remote Subnet10.1.0.0/16

1.9 - Show VPN Gateway

1.9.1 - 1.1

scpcli vpn vpn-gateway show
--vpn_gateway_id <value>

Description

Show VPN gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpn_gateway_id
required		stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Gateway
ip_addressVPN Gateway IP Address123.0.0.1
ip_idVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_typeVPN Gateway IP TypePUBLIC
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Gateway NameExampleVpnGW1
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1

1.9.2 - 1.0

scpcli vpn vpn-gateway show
--vpn_gateway_id <value>

Description

Show VPN gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpn_gateway_id
required		stringVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Gateway
ip_addressVPN Gateway IP Address123.0.0.1
ip_idVPN Gateway IP IDfcde872f75c145a0893d656cc698f13e
ip_typeVPN Gateway IP TypePUBLIC
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Gateway NameExampleVpnGW1
stateStateACTIVE
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1

1.10 - Show VPN Tunnel

1.10.1 - 1.1

scpcli vpn vpn-tunnel show
--vpn_tunnel_id <value>

Description

Show VPN tunnel.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

NameTypeDescriptionExample
vpn_tunnel_id
required		stringVPN Tunnel ID2ade2919287040bc92e557fbbe6709c1

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Tunnel
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Tunnel NameExampleVpnTunnel1
phase1VPN Tunnel Phase1
phase2VPN Tunnel Phase2
stateStateACTIVE
statusVPN Tunnel StatusUP
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1
vpn_gateway_idVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_ip_addressVPN Gateway IP Address123.0.0.1
vpn_gateway_nameVPN Gateway NameExampleVpnGW1

1.10.2 - 1.0

scpcli vpn vpn-tunnel show
--vpn_tunnel_id <value>

Description

Show VPN tunnel.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

NameTypeDescriptionExample
vpn_tunnel_id
required		stringVPN Tunnel ID2ade2919287040bc92e557fbbe6709c1

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
account_idAccount ID0e3dffc50eb247a1adf4f2e5c82c4f99
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionExample Description for VPN Tunnel
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPN Tunnel NameExampleVpnTunnel1
phase1VPN Tunnel Phase1
phase2VPN Tunnel Phase2
stateStateACTIVE
statusVPN Tunnel StatusUP
vpc_idVPC Idceb44ea5ecb34a49b16495f9a63b0718
vpc_nameVPC NameExampleVPC1
vpn_gateway_idVPN Gateway IDb156740b6335468d8354eb9ef8eddf5a
vpn_gateway_ip_addressVPN Gateway IP Address123.0.0.1
vpn_gateway_nameVPN Gateway NameExampleVpnGW1