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 an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of VPN service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.

Version

VersionStatusSupported Until
1.0DEPRECATED20251231
1.1CURRENT-

OpenAPI URL

https://vpn.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environmentregion
skr-west1
skr-east1
gkr-south1
gkr-south2
gkr-south3
ekr-west1
ekr-east1

1 - APIs

1.1 - Create VPN Gateway

1.1.1 - 1.1

post /v1/vpn-gateways

Description

Create VPN gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
VpnGatewayCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVpnGatewayShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpn-gateways

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpn 1.1"

Request body

{
    "description": "Example Description for VPN Gateway",
    "ip_address": "123.0.0.1",
    "ip_id": "fcde872f75c145a0893d656cc698f13e",
    "ip_type": "PUBLIC",
    "name": "ExampleVpnGW1",
    "tags": [],
    "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718"
}

Example HTTP response

Response 202

{
    "vpn_gateway": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Gateway",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "ip_address": "123.0.0.1",
        "ip_id": "fcde872f75c145a0893d656cc698f13e",
        "ip_type": "PUBLIC",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnGW1",
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1"
    }
}

1.1.2 - 1.0

post /v1/vpn-gateways

Description

Create VPN gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
VpnGatewayCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVpnGatewayShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpn-gateways

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpn 1.0"

Request body

{
    "description": "Example Description for VPN Gateway",
    "ip_address": "123.0.0.1",
    "ip_id": "fcde872f75c145a0893d656cc698f13e",
    "ip_type": "PUBLIC",
    "name": "ExampleVpnGW1",
    "tags": [],
    "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718"
}

Example HTTP response

Response 202

{
    "vpn_gateway": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Gateway",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "ip_address": "123.0.0.1",
        "ip_id": "fcde872f75c145a0893d656cc698f13e",
        "ip_type": "PUBLIC",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnGW1",
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1"
    }
}

1.2 - Create VPN Tunnel

1.2.1 - 1.1

post /v1/vpn-tunnels

Description

Create VPN tunnel.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
VpnTunnelCreateRequestV1Dot1

Responses

HTTP CodeDescriptionSchema
202AcceptedVpnTunnelShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpn-tunnels

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpn 1.1"

Request body

{
    "description": "Example Description for VPN Tunnel",
    "name": "ExampleVpnTunnel1",
    "phase1": {
        "dpd_retry_interval": 60,
        "ike_version": 2,
        "peer_gateway_ip": "123.0.0.2",
        "phase1_diffie_hellman_groups": [
            30,
            31,
            32
        ],
        "phase1_encryptions": [
            "des-md5",
            "chacha20poly1305-prfsha256"
        ],
        "phase1_life_time": 86400,
        "pre_shared_key": "PreSharedKey1"
    },
    "phase2": {
        "perfect_forward_secrecy": "ENABLE",
        "phase2_diffie_hellman_groups": [
            30,
            31,
            32
        ],
        "phase2_encryptions": [
            "null-md5",
            "aes128gcm",
            "chacha20poly1305"
        ],
        "phase2_life_time": 43200,
        "remote_subnets": [
            "10.1.1.0/24",
            "10.1.2.0/24",
            "10.1.3.0/24"
        ]
    },
    "tags": [],
    "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a"
}

Example HTTP response

Response 202

{
    "vpn_tunnel": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Tunnel",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnTunnel1",
        "phase1": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "dpd_retry_interval": 60,
            "encryptions": [
                "des-md5",
                "chacha20poly1305-prfsha256"
            ],
            "ike_version": 2,
            "life_time": 86400,
            "peer_gateway_ip": "123.0.0.2"
        },
        "phase2": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "encryptions": [
                "null-md5",
                "aes128gcm",
                "chacha20poly1305"
            ],
            "life_time": 43200,
            "perfect_forward_secrecy": "ENABLE",
            "remote_subnets": [
                "10.1.1.0/24",
                "10.1.2.0/24",
                "10.1.3.0/24"
            ]
        },
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1",
        "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a",
        "vpn_gateway_ip_address": "123.0.0.1",
        "vpn_gateway_name": "ExampleVpnGW1"
    }
}

1.2.2 - 1.0

post /v1/vpn-tunnels

Description

Create VPN tunnel.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
VpnTunnelCreateRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVpnTunnelShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpn-tunnels

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpn 1.0"

Request body

{
    "description": "Example Description for VPN Tunnel",
    "name": "ExampleVpnTunnel1",
    "phase1": {
        "dpd_retry_interval": 60,
        "ike_version": 2,
        "peer_gateway_ip": "123.0.0.2",
        "phase1_diffie_hellman_groups": [
            30,
            31,
            32
        ],
        "phase1_encryptions": [
            "des-md5",
            "chacha20poly1305-prfsha256"
        ],
        "phase1_life_time": 86400,
        "pre_shared_key": "PreSharedKey1"
    },
    "phase2": {
        "perfect_forward_secrecy": "ENABLE",
        "phase2_diffie_hellman_groups": [
            30,
            31,
            32
        ],
        "phase2_encryptions": [
            "null-md5",
            "aes128gcm",
            "chacha20poly1305"
        ],
        "phase2_life_time": 43200,
        "remote_subnet": "10.1.0.0/16"
    },
    "tags": [],
    "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a"
}

Example HTTP response

Response 202

{
    "vpn_tunnel": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Tunnel",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnTunnel1",
        "phase1": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "dpd_retry_interval": 60,
            "encryptions": [
                "des-md5",
                "chacha20poly1305-prfsha256"
            ],
            "ike_version": 2,
            "life_time": 86400,
            "peer_gateway_ip": "123.0.0.2"
        },
        "phase2": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "encryptions": [
                "null-md5",
                "aes128gcm",
                "chacha20poly1305"
            ],
            "life_time": 43200,
            "perfect_forward_secrecy": "ENABLE",
            "remote_subnet": "10.1.0.0/16"
        },
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1",
        "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a",
        "vpn_gateway_ip_address": "123.0.0.1",
        "vpn_gateway_name": "ExampleVpnGW1"
    }
}

1.3 - Delete VPN Gateway

1.3.1 - 1.1

delete /v1/vpn-gateways/{vpn_gateway_id}

Description

Delete VPN gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathvpn_gateway_id
required		VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/vpn-gateways/{vpn_gateway_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpn 1.1"

Example HTTP response

Response 202

1.3.2 - 1.0

delete /v1/vpn-gateways/{vpn_gateway_id}

Description

Delete VPN gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathvpn_gateway_id
required		VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

Example HTTP request

Request path

/v1/vpn-gateways/{vpn_gateway_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpn 1.0"

Example HTTP response

Response 202

1.4 - Delete VPN Tunnel

1.4.1 - 1.1

delete /v1/vpn-tunnels/{vpn_tunnel_id}

Description

Delete VPN tunnel.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathvpn_tunnel_id
required		VPN Tunnel ID
Example : 2ade2919287040bc92e557fbbe6709c1
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpn-tunnels/{vpn_tunnel_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpn 1.1"

Example HTTP response

Response 202

1.4.2 - 1.0

delete /v1/vpn-tunnels/{vpn_tunnel_id}

Description

Delete VPN tunnel.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathvpn_tunnel_id
required		VPN Tunnel ID
Example : 2ade2919287040bc92e557fbbe6709c1
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpn-tunnels/{vpn_tunnel_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpn 1.0"

Example HTTP response

Response 202

1.5 - List VPN Gateways

1.5.1 - 1.1

get /v1/vpn-gateways

Description

Get VPN gateway list.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryname
optional		VPN Gateway Name
Example : ExampleVpnGW1
stringNone
queryip_address
optional		VPN Gateway IP Address
Example : 123.0.0.1
stringNone
queryvpc_id
optional		VPC Id
Example : ceb44ea5ecb34a49b16495f9a63b0718
stringNone
queryvpc_name
optional		VPC Name
Example : ExampleVPC1
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVpnGatewayListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpn-gateways

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpn 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpn_gateways": [
        {
            "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Example Description for VPN Gateway",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "ip_address": "123.0.0.1",
            "ip_id": "fcde872f75c145a0893d656cc698f13e",
            "ip_type": "PUBLIC",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ExampleVpnGW1",
            "state": "ACTIVE",
            "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
            "vpc_name": "ExampleVPC1"
        }
    ]
}

1.5.2 - 1.0

get /v1/vpn-gateways

Description

Get VPN gateway list.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryname
optional		VPN Gateway Name
Example : ExampleVpnGW1
stringNone
queryip_address
optional		VPN Gateway IP Address
Example : 123.0.0.1
stringNone
queryvpc_id
optional		VPC Id
Example : ceb44ea5ecb34a49b16495f9a63b0718
stringNone
queryvpc_name
optional		VPC Name
Example : ExampleVPC1
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVpnGatewayListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpn-gateways

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpn 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpn_gateways": [
        {
            "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Example Description for VPN Gateway",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "ip_address": "123.0.0.1",
            "ip_id": "fcde872f75c145a0893d656cc698f13e",
            "ip_type": "PUBLIC",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ExampleVpnGW1",
            "state": "ACTIVE",
            "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
            "vpc_name": "ExampleVPC1"
        }
    ]
}

1.6 - List VPN Tunnels

1.6.1 - 1.1

get /v1/vpn-tunnels

Description

Get VPN tunnel list.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryname
optional		VPN Tunnel Name
Example : ExampleVpnTunnel1
stringNone
queryvpn_gateway_id
optional		VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone
queryvpn_gateway_name
optional		VPN Gateway Name
Example : ExampleVpnGW1
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVpnTunnelListResponseV1Dot1
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpn-tunnels

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpn 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpn_tunnels": [
        {
            "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Example Description for VPN Tunnel",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ExampleVpnTunnel1",
            "phase1": {
                "dpd_retry_interval": 60,
                "ike_version": 2,
                "life_time": 86400,
                "peer_gateway_ip": "123.0.0.2"
            },
            "phase2": {
                "life_time": 43200,
                "perfect_forward_secrecy": "ENABLE",
                "remote_subnets": [
                    "10.1.1.0/24",
                    "10.1.2.0/24",
                    "10.1.3.0/24"
                ]
            },
            "state": "ACTIVE",
            "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
            "vpc_name": "ExampleVPC1",
            "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a",
            "vpn_gateway_ip_address": "123.0.0.1",
            "vpn_gateway_name": "ExampleVpnGW1"
        }
    ]
}

1.6.2 - 1.0

get /v1/vpn-tunnels

Description

Get VPN tunnel list.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryname
optional		VPN Tunnel Name
Example : ExampleVpnTunnel1
stringNone
queryvpn_gateway_id
optional		VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone
queryvpn_gateway_name
optional		VPN Gateway Name
Example : ExampleVpnGW1
stringNone
querypeer_gateway_ip
optional		VPN Tunnel Peer Gateway IP Address
Example : 123.0.0.2
stringNone
queryremote_subnet
optional		VPN Tunnel IPSec Remote Subnet
Example : 10.1.0.0/16
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVpnTunnelListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/vpn-tunnels

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpn 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpn_tunnels": [
        {
            "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Example Description for VPN Tunnel",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ExampleVpnTunnel1",
            "phase1": {
                "dpd_retry_interval": 60,
                "ike_version": 2,
                "life_time": 86400,
                "peer_gateway_ip": "123.0.0.2"
            },
            "phase2": {
                "life_time": 43200,
                "perfect_forward_secrecy": "ENABLE",
                "remote_subnet": "10.1.0.0/16"
            },
            "state": "ACTIVE",
            "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
            "vpc_name": "ExampleVPC1",
            "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a",
            "vpn_gateway_ip_address": "123.0.0.1",
            "vpn_gateway_name": "ExampleVpnGW1"
        }
    ]
}

1.7 - Set VPN Gateway

1.7.1 - 1.1

put /v1/vpn-gateways/{vpn_gateway_id}

Description

Set VPN gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathvpn_gateway_id
required		VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone
bodybody
required
VpnGatewaySetRequest

Responses

HTTP CodeDescriptionSchema
200OKVpnGatewayShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpn-gateways/{vpn_gateway_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpn 1.1"

Request body

{
    "description": "Example Description for VPN Gateway"
}

Example HTTP response

Response 200

{
    "vpn_gateway": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Gateway",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "ip_address": "123.0.0.1",
        "ip_id": "fcde872f75c145a0893d656cc698f13e",
        "ip_type": "PUBLIC",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnGW1",
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1"
    }
}

1.7.2 - 1.0

put /v1/vpn-gateways/{vpn_gateway_id}

Description

Set VPN gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathvpn_gateway_id
required		VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone
bodybody
required
VpnGatewaySetRequest

Responses

HTTP CodeDescriptionSchema
200OKVpnGatewayShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpn-gateways/{vpn_gateway_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpn 1.0"

Request body

{
    "description": "Example Description for VPN Gateway"
}

Example HTTP response

Response 200

{
    "vpn_gateway": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Gateway",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "ip_address": "123.0.0.1",
        "ip_id": "fcde872f75c145a0893d656cc698f13e",
        "ip_type": "PUBLIC",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnGW1",
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1"
    }
}

1.8 - Set VPN Tunnel

1.8.1 - 1.1

put /v1/vpn-tunnels/{vpn_tunnel_id}

Description

Set VPN tunnel.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathvpn_tunnel_id
required		VPN Tunnel ID
Example : 2ade2919287040bc92e557fbbe6709c1
stringNone
bodybody
required
VpnTunnelSetRequestV1Dot1

Responses

HTTP CodeDescriptionSchema
202AcceptedVpnTunnelShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpn-tunnels/{vpn_tunnel_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpn 1.1"

Request body

{
    "description": "Example Description for VPN Tunnel",
    "phase1": {
        "dpd_retry_interval": 60,
        "ike_version": 2,
        "peer_gateway_ip": "123.0.0.2",
        "phase1_diffie_hellman_groups": [
            30,
            31,
            32
        ],
        "phase1_encryptions": [
            "des-md5",
            "chacha20poly1305-prfsha256"
        ],
        "phase1_life_time": 86400,
        "pre_shared_key": "PreSharedKey1"
    },
    "phase2": {
        "perfect_forward_secrecy": "ENABLE",
        "phase2_diffie_hellman_groups": [
            30,
            31,
            32
        ],
        "phase2_encryptions": [
            "null-md5",
            "aes128gcm",
            "chacha20poly1305"
        ],
        "phase2_life_time": 43200,
        "remote_subnets": [
            "10.1.1.0/24",
            "10.1.2.0/24",
            "10.1.3.0/24"
        ]
    }
}

Example HTTP response

Response 202

{
    "vpn_tunnel": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Tunnel",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnTunnel1",
        "phase1": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "dpd_retry_interval": 60,
            "encryptions": [
                "des-md5",
                "chacha20poly1305-prfsha256"
            ],
            "ike_version": 2,
            "life_time": 86400,
            "peer_gateway_ip": "123.0.0.2"
        },
        "phase2": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "encryptions": [
                "null-md5",
                "aes128gcm",
                "chacha20poly1305"
            ],
            "life_time": 43200,
            "perfect_forward_secrecy": "ENABLE",
            "remote_subnets": [
                "10.1.1.0/24",
                "10.1.2.0/24",
                "10.1.3.0/24"
            ]
        },
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1",
        "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a",
        "vpn_gateway_ip_address": "123.0.0.1",
        "vpn_gateway_name": "ExampleVpnGW1"
    }
}

1.8.2 - 1.0

put /v1/vpn-tunnels/{vpn_tunnel_id}

Description

Set VPN tunnel.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathvpn_tunnel_id
required		VPN Tunnel ID
Example : 2ade2919287040bc92e557fbbe6709c1
stringNone
bodybody
required
VpnTunnelSetRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedVpnTunnelShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpn-tunnels/{vpn_tunnel_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpn 1.0"

Request body

{
    "description": "Example Description for VPN Tunnel",
    "phase1": {
        "dpd_retry_interval": 60,
        "ike_version": 2,
        "peer_gateway_ip": "123.0.0.2",
        "phase1_diffie_hellman_groups": [
            30,
            31,
            32
        ],
        "phase1_encryptions": [
            "des-md5",
            "chacha20poly1305-prfsha256"
        ],
        "phase1_life_time": 86400,
        "pre_shared_key": "PreSharedKey1"
    },
    "phase2": {
        "perfect_forward_secrecy": "ENABLE",
        "phase2_diffie_hellman_groups": [
            30,
            31,
            32
        ],
        "phase2_encryptions": [
            "null-md5",
            "aes128gcm",
            "chacha20poly1305"
        ],
        "phase2_life_time": 43200,
        "remote_subnet": "10.1.0.0/16"
    }
}

Example HTTP response

Response 202

{
    "vpn_tunnel": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Tunnel",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnTunnel1",
        "phase1": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "dpd_retry_interval": 60,
            "encryptions": [
                "des-md5",
                "chacha20poly1305-prfsha256"
            ],
            "ike_version": 2,
            "life_time": 86400,
            "peer_gateway_ip": "123.0.0.2"
        },
        "phase2": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "encryptions": [
                "null-md5",
                "aes128gcm",
                "chacha20poly1305"
            ],
            "life_time": 43200,
            "perfect_forward_secrecy": "ENABLE",
            "remote_subnet": "10.1.0.0/16"
        },
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1",
        "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a",
        "vpn_gateway_ip_address": "123.0.0.1",
        "vpn_gateway_name": "ExampleVpnGW1"
    }
}

1.9 - Show VPN Gateway

1.9.1 - 1.1

get /v1/vpn-gateways/{vpn_gateway_id}

Description

Show VPN gateway.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathvpn_gateway_id
required		VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVpnGatewayShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpn-gateways/{vpn_gateway_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpn 1.1"

Example HTTP response

Response 200

{
    "vpn_gateway": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Gateway",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "ip_address": "123.0.0.1",
        "ip_id": "fcde872f75c145a0893d656cc698f13e",
        "ip_type": "PUBLIC",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnGW1",
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1"
    }
}

1.9.2 - 1.0

get /v1/vpn-gateways/{vpn_gateway_id}

Description

Show VPN gateway.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathvpn_gateway_id
required		VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVpnGatewayShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpn-gateways/{vpn_gateway_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpn 1.0"

Example HTTP response

Response 200

{
    "vpn_gateway": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Gateway",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "ip_address": "123.0.0.1",
        "ip_id": "fcde872f75c145a0893d656cc698f13e",
        "ip_type": "PUBLIC",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnGW1",
        "state": "ACTIVE",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1"
    }
}

1.10 - Show VPN Tunnel

1.10.1 - 1.1

get /v1/vpn-tunnels/{vpn_tunnel_id}

Description

Show VPN tunnel.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathvpn_tunnel_id
required		VPN Tunnel ID
Example : 2ade2919287040bc92e557fbbe6709c1
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVpnTunnelShowWithStatusResponseV1Dot1
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpn-tunnels/{vpn_tunnel_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpn 1.1"

Example HTTP response

Response 200

{
    "vpn_tunnel": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Tunnel",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnTunnel1",
        "phase1": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "dpd_retry_interval": 60,
            "encryptions": [
                "des-md5",
                "chacha20poly1305-prfsha256"
            ],
            "ike_version": 2,
            "life_time": 86400,
            "peer_gateway_ip": "123.0.0.2"
        },
        "phase2": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "encryptions": [
                "null-md5",
                "aes128gcm",
                "chacha20poly1305"
            ],
            "life_time": 43200,
            "perfect_forward_secrecy": "ENABLE",
            "remote_subnets": [
                "10.1.1.0/24",
                "10.1.2.0/24",
                "10.1.3.0/24"
            ]
        },
        "state": "ACTIVE",
        "status": "UP",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1",
        "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a",
        "vpn_gateway_ip_address": "123.0.0.1",
        "vpn_gateway_name": "ExampleVpnGW1"
    }
}

1.10.2 - 1.0

get /v1/vpn-tunnels/{vpn_tunnel_id}

Description

Show VPN tunnel.

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathvpn_tunnel_id
required		VPN Tunnel ID
Example : 2ade2919287040bc92e557fbbe6709c1
stringNone

Responses

HTTP CodeDescriptionSchema
200OKVpnTunnelShowWithStatusResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/vpn-tunnels/{vpn_tunnel_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpn 1.0"

Example HTTP response

Response 200

{
    "vpn_tunnel": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for VPN Tunnel",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleVpnTunnel1",
        "phase1": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "dpd_retry_interval": 60,
            "encryptions": [
                "des-md5",
                "chacha20poly1305-prfsha256"
            ],
            "ike_version": 2,
            "life_time": 86400,
            "peer_gateway_ip": "123.0.0.2"
        },
        "phase2": {
            "diffie_hellman_groups": [
                30,
                31,
                32
            ],
            "encryptions": [
                "null-md5",
                "aes128gcm",
                "chacha20poly1305"
            ],
            "life_time": 43200,
            "perfect_forward_secrecy": "ENABLE",
            "remote_subnet": "10.1.0.0/16"
        },
        "state": "ACTIVE",
        "status": "UP",
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "ExampleVPC1",
        "vpn_gateway_id": "b156740b6335468d8354eb9ef8eddf5a",
        "vpn_gateway_ip_address": "123.0.0.1",
        "vpn_gateway_name": "ExampleVpnGW1"
    }
}

2 - Models

2.1 - Tag

NameDescriptionSchemaDefault
key
required		tag key
Example :
string
value
required		tag value
Example :
string

2.2 - VpnGateway

NameDescriptionSchemaDefault
account_id
required		Account ID
Example : 0e3dffc50eb247a1adf4f2e5c82c4f99
string
created_at
required		Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional		Description
Example : Example Description for VPN Gateway
any of [string, null]
id
required		ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
ip_address
required		VPN Gateway IP Address
Example : 123.0.0.1
string
ip_id
required		VPN Gateway IP ID
Example : fcde872f75c145a0893d656cc698f13e
string
ip_type
required		VPN Gateway IP Type
Example : PUBLIC
string
modified_at
required		Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required		VPN Gateway Name
Example : ExampleVpnGW1
string
state
required		State
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
vpc_id
required		VPC Id
Example : ceb44ea5ecb34a49b16495f9a63b0718
string
vpc_name
required		VPC Name
Example : ExampleVPC1
string

2.3 - VpnGatewayCreateRequest

NameDescriptionSchemaDefault
description
optional		Description
Example : Example Description for VPN Gateway
any of [string, null]
ip_address
required		VPN Gateway IP Address
Example : 123.0.0.1
string
ip_id
required		VPN Gateway IP ID
Example : fcde872f75c145a0893d656cc698f13e
string
ip_type
required		VPN Gateway IP Type
Example : PUBLIC
string
name
required		VPN Gateway Name
Example : ExampleVpnGW1
string
tags
optional		Tag List
array[Tag]
vpc_id
required		VPC Id
Example : ceb44ea5ecb34a49b16495f9a63b0718
string

2.4 - VpnGatewayListResponse

NameDescriptionSchemaDefault
count
required		count
Example : 20
integer
page
required		page
Example : 0
integer
size
required		size
Example : 20
integer
sort
optional		sort
Example : ['created_at:asc']
any of [array[string], null]
vpn_gateways
required
array[VpnGateway]

2.5 - VpnGatewaySetRequest

NameDescriptionSchemaDefault
description
optional		Description
Example : Example Description for VPN Gateway
string

2.6 - VpnGatewayShowResponse

NameDescriptionSchemaDefault
vpn_gateway
required
VpnGateway

2.7 - VpnPhase1

NameDescriptionSchemaDefault
dpd_retry_interval
required		VPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec)
Example : 60
integer
ike_version
required		VPN Tunnel IKE Version
Example : 2
integer
life_time
required		VPN Tunnel ISAKMP Lifetime (sec)
Example : 86400
integer
peer_gateway_ip
required		VPN Tunnel Peer Gateway IP Address
Example : 123.0.0.2
string

2.8 - VpnPhase1CreateRequest

NameDescriptionSchemaDefault
dpd_retry_interval
required		VPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec)
Example : 60
integer
ike_version
required		VPN Tunnel IKE Version
Example : 2
integer
peer_gateway_ip
required		VPN Tunnel Peer Gateway IP Address
Example : 123.0.0.2
string
phase1_diffie_hellman_groups
required		VPN Tunnel ISAKMP Diffie-Hellman Group List
Example : [30, 31, 32]
array[integer]
phase1_encryptions
required		VPN Tunnel ISAKMP Proposal List
Example : ['des-md5', 'chacha20poly1305-prfsha256']
array[string]
phase1_life_time
required		VPN Tunnel ISAKMP Lifetime (sec)
Example : 86400
integer
pre_shared_key
required		VPN Tunnel ISAKMP Authentication : Pre-shared Key
Example : PreSharedKey1
string

2.9 - VpnPhase1CreateRequestV1Dot1

NameDescriptionSchemaDefault
dpd_retry_interval
required		VPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec)
Example : 60
integer
ike_version
required		VPN Tunnel IKE Version
Example : 2
integer
peer_gateway_ip
required		VPN Tunnel Peer Gateway IP Address
Example : 123.0.0.2
string
phase1_diffie_hellman_groups
required		VPN Tunnel ISAKMP Diffie-Hellman Group List
Example : [30, 31, 32]
array[integer]
phase1_encryptions
required		VPN Tunnel ISAKMP Proposal List
Example : ['des-md5', 'chacha20poly1305-prfsha256']
array[string]
phase1_life_time
required		VPN Tunnel ISAKMP Lifetime (sec)
Example : 86400
integer
pre_shared_key
required		VPN Tunnel ISAKMP Authentication : Pre-shared Key
Example : PreSharedKey1
string

2.10 - VpnPhase1Detail

NameDescriptionSchemaDefault
diffie_hellman_groups
required		VPN Tunnel ISAKMP Diffie-Hellman Group List
Example : [30, 31, 32]
array[integer]
dpd_retry_interval
required		VPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec)
Example : 60
integer
encryptions
required		VPN Tunnel ISAKMP Proposal List
Example : ['des-md5', 'chacha20poly1305-prfsha256']
array[string]
ike_version
required		VPN Tunnel IKE Version
Example : 2
integer
life_time
required		VPN Tunnel ISAKMP Lifetime (sec)
Example : 86400
integer
peer_gateway_ip
required		VPN Tunnel Peer Gateway IP Address
Example : 123.0.0.2
string

2.11 - VpnPhase1DetailV1Dot1

NameDescriptionSchemaDefault
diffie_hellman_groups
required		VPN Tunnel ISAKMP Diffie-Hellman Group List
Example : [30, 31, 32]
array[integer]
dpd_retry_interval
required		VPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec)
Example : 60
integer
encryptions
required		VPN Tunnel ISAKMP Proposal List
Example : ['des-md5', 'chacha20poly1305-prfsha256']
array[string]
ike_version
required		VPN Tunnel IKE Version
Example : 2
integer
life_time
required		VPN Tunnel ISAKMP Lifetime (sec)
Example : 86400
integer
peer_gateway_ip
required		VPN Tunnel Peer Gateway IP Address
Example : 123.0.0.2
string

2.12 - VpnPhase1SetRequest

NameDescriptionSchemaDefault
dpd_retry_interval
optional		VPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec)
Example : 60
any of [integer, null]
ike_version
optional		VPN Tunnel IKE Version
Example : 2
any of [integer, null]
peer_gateway_ip
optional		VPN Tunnel Peer Gateway IP Address
Example : 123.0.0.2
any of [string, null]
phase1_diffie_hellman_groups
optional		VPN Tunnel ISAKMP Diffie-Hellman Group List
Example : [30, 31, 32]
any of [array[integer], null]
phase1_encryptions
optional		VPN Tunnel ISAKMP Proposal List
Example : ['des-md5', 'chacha20poly1305-prfsha256']
any of [array[string], null]
phase1_life_time
optional		VPN Tunnel ISAKMP Lifetime (sec)
Example : 86400
any of [integer, null]
pre_shared_key
optional		VPN Tunnel ISAKMP Authentication : Pre-shared Key
Example : PreSharedKey1
any of [string, null]

2.13 - VpnPhase1SetRequestV1Dot1

NameDescriptionSchemaDefault
dpd_retry_interval
optional		VPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec)
Example : 60
any of [integer, null]
ike_version
optional		VPN Tunnel IKE Version
Example : 2
any of [integer, null]
peer_gateway_ip
optional		VPN Tunnel Peer Gateway IP Address
Example : 123.0.0.2
any of [string, null]
phase1_diffie_hellman_groups
optional		VPN Tunnel ISAKMP Diffie-Hellman Group List
Example : [30, 31, 32]
any of [array[integer], null]
phase1_encryptions
optional		VPN Tunnel ISAKMP Proposal List
Example : ['des-md5', 'chacha20poly1305-prfsha256']
any of [array[string], null]
phase1_life_time
optional		VPN Tunnel ISAKMP Lifetime (sec)
Example : 86400
any of [integer, null]
pre_shared_key
optional		VPN Tunnel ISAKMP Authentication : Pre-shared Key
Example : PreSharedKey1
any of [string, null]

2.14 - VpnPhase1V1Dot1

NameDescriptionSchemaDefault
dpd_retry_interval
required		VPN Tunnel Dead Peer Detection(DPD) Retry Interval (sec)
Example : 60
integer
ike_version
required		VPN Tunnel IKE Version
Example : 2
integer
life_time
required		VPN Tunnel ISAKMP Lifetime (sec)
Example : 86400
integer
peer_gateway_ip
required		VPN Tunnel Peer Gateway IP Address
Example : 123.0.0.2
string

2.15 - VpnPhase2

NameDescriptionSchemaDefault
life_time
required		VPN Tunnel IPSec Lifetime (sec)
Example : 43200
integer
perfect_forward_secrecy
required		VPN Tunnel IPSec Perfect Forward Secrecy(PFS)
Example : ENABLE
string
remote_subnet
required		VPN Tunnel IPSec Remote Subnet
Example : 10.1.0.0/16
string

2.16 - VpnPhase2CreateRequest

NameDescriptionSchemaDefault
perfect_forward_secrecy
required		VPN Tunnel IPSec Perfect Forward Secrecy(PFS)
Example : ENABLE
enum (ENABLE, DISABLE)
phase2_diffie_hellman_groups
required		VPN Tunnel ISAKMP Diffie-Hellman Group List
Example : [30, 31, 32]
array[integer]
phase2_encryptions
required		VPN Tunnel ISAKMP Proposal List
Example : ['null-md5', 'aes128gcm', 'chacha20poly1305']
array[string]
phase2_life_time
required		VPN Tunnel IPSec Lifetime (sec)
Example : 43200
integer
remote_subnet
required		VPN Tunnel IPSec Remote Subnet
Example : 10.1.0.0/16
string

2.17 - VpnPhase2CreateRequestV1Dot1

NameDescriptionSchemaDefault
perfect_forward_secrecy
required		VPN Tunnel IPSec Perfect Forward Secrecy(PFS)
Example : ENABLE
enum (ENABLE, DISABLE)
phase2_diffie_hellman_groups
required		VPN Tunnel ISAKMP Diffie-Hellman Group List
Example : [30, 31, 32]
array[integer]
phase2_encryptions
required		VPN Tunnel ISAKMP Proposal List
Example : ['null-md5', 'aes128gcm', 'chacha20poly1305']
array[string]
phase2_life_time
required		VPN Tunnel IPSec Lifetime (sec)
Example : 43200
integer
remote_subnets
required		VPN Tunnel IPSec Remote Subnet
Example : ['10.1.1.0/24', '10.1.2.0/24', '10.1.3.0/24']
array[string]

2.18 - VpnPhase2Detail

NameDescriptionSchemaDefault
diffie_hellman_groups
optional		VPN Tunnel IPSec Diffie-Hellman Group List
Example : [30, 31, 32]
any of [array[integer], null]
encryptions
required		VPN Tunnel IPSec Proposal List
Example : ['null-md5', 'aes128gcm', 'chacha20poly1305']
array[string]
life_time
required		VPN Tunnel IPSec Lifetime (sec)
Example : 43200
integer
perfect_forward_secrecy
required		VPN Tunnel IPSec Perfect Forward Secrecy(PFS)
Example : ENABLE
string
remote_subnet
required		VPN Tunnel IPSec Remote Subnet
Example : 10.1.0.0/16
string

2.19 - VpnPhase2DetailV1Dot1

NameDescriptionSchemaDefault
diffie_hellman_groups
optional		VPN Tunnel IPSec Diffie-Hellman Group List
Example : [30, 31, 32]
any of [array[integer], null]
encryptions
required		VPN Tunnel IPSec Proposal List
Example : ['null-md5', 'aes128gcm', 'chacha20poly1305']
array[string]
life_time
required		VPN Tunnel IPSec Lifetime (sec)
Example : 43200
integer
perfect_forward_secrecy
required		VPN Tunnel IPSec Perfect Forward Secrecy(PFS)
Example : ENABLE
string
remote_subnets
required		VPN Tunnel IPSec Remote Subnet
Example : ['10.1.1.0/24', '10.1.2.0/24', '10.1.3.0/24']
array[string]

2.20 - VpnPhase2SetRequest

NameDescriptionSchemaDefault
perfect_forward_secrecy
optional		VPN Tunnel IPSec Perfect Forward Secrecy(PFS)
Example : ENABLE
any of [enum (ENABLE, DISABLE), null]
phase2_diffie_hellman_groups
optional		VPN Tunnel ISAKMP Diffie-Hellman Group List
Example : [30, 31, 32]
any of [array[integer], null]
phase2_encryptions
optional		VPN Tunnel ISAKMP Proposal List
Example : ['null-md5', 'aes128gcm', 'chacha20poly1305']
any of [array[string], null]
phase2_life_time
optional		VPN Tunnel IPSec Lifetime (sec)
Example : 43200
any of [integer, null]
remote_subnet
optional		VPN Tunnel IPSec Remote Subnet
Example : 10.1.0.0/16
any of [string, null]

2.21 - VpnPhase2SetRequestV1Dot1

NameDescriptionSchemaDefault
perfect_forward_secrecy
optional		VPN Tunnel IPSec Perfect Forward Secrecy(PFS)
Example : ENABLE
any of [enum (ENABLE, DISABLE), null]
phase2_diffie_hellman_groups
optional		VPN Tunnel ISAKMP Diffie-Hellman Group List
Example : [30, 31, 32]
any of [array[integer], null]
phase2_encryptions
optional		VPN Tunnel ISAKMP Proposal List
Example : ['null-md5', 'aes128gcm', 'chacha20poly1305']
any of [array[string], null]
phase2_life_time
optional		VPN Tunnel IPSec Lifetime (sec)
Example : 43200
any of [integer, null]
remote_subnets
optional		VPN Tunnel IPSec Remote Subnet
Example : ['10.1.1.0/24', '10.1.2.0/24', '10.1.3.0/24']
any of [array[string], null]

2.22 - VpnPhase2V1Dot1

NameDescriptionSchemaDefault
life_time
required		VPN Tunnel IPSec Lifetime (sec)
Example : 43200
integer
perfect_forward_secrecy
required		VPN Tunnel IPSec Perfect Forward Secrecy(PFS)
Example : ENABLE
string
remote_subnets
required		VPN Tunnel IPSec Remote Subnet
Example : ['10.1.1.0/24', '10.1.2.0/24', '10.1.3.0/24']
array[string]

2.23 - VpnTunnel

NameDescriptionSchemaDefault
account_id
required		Account ID
Example : 0e3dffc50eb247a1adf4f2e5c82c4f99
string
created_at
required		Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required		Description
Example : Example Description for VPN Tunnel
any of [string, null]
id
required		ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
modified_at
required		Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required		VPN Tunnel Name
Example : ExampleVpnTunnel1
string
phase1
required		VPN Tunnel Phase1
VpnPhase1
phase2
required		VPN Tunnel Phase2
VpnPhase2
state
required		State
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
vpc_id
required		VPC Id
Example : ceb44ea5ecb34a49b16495f9a63b0718
string
vpc_name
required		VPC Name
Example : ExampleVPC1
string
vpn_gateway_id
required		VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
string
vpn_gateway_ip_address
required		VPN Gateway IP Address
Example : 123.0.0.1
string
vpn_gateway_name
required		VPN Gateway Name
Example : ExampleVpnGW1
string

2.24 - VpnTunnelCreateRequest

NameDescriptionSchemaDefault
description
optional		Description
Example : Example Description for VPN Tunnel
any of [string, null]
name
required		VPN Tunnel Name
Example : ExampleVpnTunnel1
string
phase1
required		VPN Tunnel Phase1
VpnPhase1CreateRequest
phase2
required		VPN Tunnel Phase2
VpnPhase2CreateRequest
tags
optional		Tag List
array[Tag]
vpn_gateway_id
required		VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
string

2.25 - VpnTunnelCreateRequestV1Dot1

NameDescriptionSchemaDefault
description
optional		Description
Example : Example Description for VPN Tunnel
any of [string, null]
name
required		VPN Tunnel Name
Example : ExampleVpnTunnel1
string
phase1
required		VPN Tunnel Phase1
VpnPhase1CreateRequestV1Dot1
phase2
required		VPN Tunnel Phase2
VpnPhase2CreateRequestV1Dot1
tags
optional		Tag List
array[Tag]
vpn_gateway_id
required		VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
string

2.26 - VpnTunnelDetail

NameDescriptionSchemaDefault
account_id
required		Account ID
Example : 0e3dffc50eb247a1adf4f2e5c82c4f99
string
created_at
required		Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required		Description
Example : Example Description for VPN Tunnel
any of [string, null]
id
required		ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
modified_at
required		Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required		VPN Tunnel Name
Example : ExampleVpnTunnel1
string
phase1
required		VPN Tunnel Phase1
VpnPhase1Detail
phase2
required		VPN Tunnel Phase2
VpnPhase2Detail
state
required		State
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
vpc_id
required		VPC Id
Example : ceb44ea5ecb34a49b16495f9a63b0718
string
vpc_name
required		VPC Name
Example : ExampleVPC1
string
vpn_gateway_id
required		VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
string
vpn_gateway_ip_address
required		VPN Gateway IP Address
Example : 123.0.0.1
string
vpn_gateway_name
required		VPN Gateway Name
Example : ExampleVpnGW1
string

2.27 - VpnTunnelDetailV1Dot1

NameDescriptionSchemaDefault
account_id
required		Account ID
Example : 0e3dffc50eb247a1adf4f2e5c82c4f99
string
created_at
required		Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required		Description
Example : Example Description for VPN Tunnel
any of [string, null]
id
required		ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
modified_at
required		Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required		VPN Tunnel Name
Example : ExampleVpnTunnel1
string
phase1
required		VPN Tunnel Phase1
VpnPhase1DetailV1Dot1
phase2
required		VPN Tunnel Phase2
VpnPhase2DetailV1Dot1
state
required		State
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
vpc_id
required		VPC Id
Example : ceb44ea5ecb34a49b16495f9a63b0718
string
vpc_name
required		VPC Name
Example : ExampleVPC1
string
vpn_gateway_id
required		VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
string
vpn_gateway_ip_address
required		VPN Gateway IP Address
Example : 123.0.0.1
string
vpn_gateway_name
required		VPN Gateway Name
Example : ExampleVpnGW1
string

2.28 - VpnTunnelDetailWithStatus

NameDescriptionSchemaDefault
account_id
required		Account ID
Example : 0e3dffc50eb247a1adf4f2e5c82c4f99
string
created_at
required		Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required		Description
Example : Example Description for VPN Tunnel
any of [string, null]
id
required		ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
modified_at
required		Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required		VPN Tunnel Name
Example : ExampleVpnTunnel1
string
phase1
required		VPN Tunnel Phase1
VpnPhase1Detail
phase2
required		VPN Tunnel Phase2
VpnPhase2Detail
state
required		State
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
status
required		VPN Tunnel Status
Example : UP
enum (UP, DOWN)
vpc_id
required		VPC Id
Example : ceb44ea5ecb34a49b16495f9a63b0718
string
vpc_name
required		VPC Name
Example : ExampleVPC1
string
vpn_gateway_id
required		VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
string
vpn_gateway_ip_address
required		VPN Gateway IP Address
Example : 123.0.0.1
string
vpn_gateway_name
required		VPN Gateway Name
Example : ExampleVpnGW1
string

2.29 - VpnTunnelDetailWithStatusV1Dot1

NameDescriptionSchemaDefault
account_id
required		Account ID
Example : 0e3dffc50eb247a1adf4f2e5c82c4f99
string
created_at
required		Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required		Description
Example : Example Description for VPN Tunnel
any of [string, null]
id
required		ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
modified_at
required		Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required		VPN Tunnel Name
Example : ExampleVpnTunnel1
string
phase1
required		VPN Tunnel Phase1
VpnPhase1DetailV1Dot1
phase2
required		VPN Tunnel Phase2
VpnPhase2DetailV1Dot1
state
required		State
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
status
required		VPN Tunnel Status
Example : UP
enum (UP, DOWN)
vpc_id
required		VPC Id
Example : ceb44ea5ecb34a49b16495f9a63b0718
string
vpc_name
required		VPC Name
Example : ExampleVPC1
string
vpn_gateway_id
required		VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
string
vpn_gateway_ip_address
required		VPN Gateway IP Address
Example : 123.0.0.1
string
vpn_gateway_name
required		VPN Gateway Name
Example : ExampleVpnGW1
string

2.30 - VpnTunnelListResponse

NameDescriptionSchemaDefault
count
required		count
Example : 20
integer
page
required		page
Example : 0
integer
size
required		size
Example : 20
integer
sort
optional		sort
Example : ['created_at:asc']
any of [array[string], null]
vpn_tunnels
required
array[VpnTunnel]

2.31 - VpnTunnelListResponseV1Dot1

NameDescriptionSchemaDefault
count
required		count
Example : 20
integer
page
required		page
Example : 0
integer
size
required		size
Example : 20
integer
sort
optional		sort
Example : ['created_at:asc']
any of [array[string], null]
vpn_tunnels
required
array[VpnTunnelV1Dot1]

2.32 - VpnTunnelSetRequest

NameDescriptionSchemaDefault
description
optional		Description
Example : Example Description for VPN Tunnel
any of [string, null]
phase1
optional		VPN Tunnel Phase1
any of [VpnPhase1SetRequest, null]
phase2
optional		VPN Tunnel Phase2
any of [VpnPhase2SetRequest, null]

2.33 - VpnTunnelSetRequestV1Dot1

NameDescriptionSchemaDefault
description
optional		Description
Example : Example Description for VPN Tunnel
any of [string, null]
phase1
optional		VPN Tunnel Phase1
any of [VpnPhase1SetRequestV1Dot1, null]
phase2
optional		VPN Tunnel Phase2
any of [VpnPhase2SetRequestV1Dot1, null]

2.34 - VpnTunnelShowResponse

NameDescriptionSchemaDefault
vpn_tunnel
required
VpnTunnelDetail

2.35 - VpnTunnelShowResponseV1Dot1

NameDescriptionSchemaDefault
vpn_tunnel
required
VpnTunnelDetailV1Dot1

2.36 - VpnTunnelShowWithStatusResponse

NameDescriptionSchemaDefault
vpn_tunnel
required
VpnTunnelDetailWithStatus

2.37 - VpnTunnelShowWithStatusResponseV1Dot1

NameDescriptionSchemaDefault
vpn_tunnel
required
VpnTunnelDetailWithStatusV1Dot1

2.38 - VpnTunnelV1Dot1

NameDescriptionSchemaDefault
account_id
required		Account ID
Example : 0e3dffc50eb247a1adf4f2e5c82c4f99
string
created_at
required		Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
required		Description
Example : Example Description for VPN Tunnel
any of [string, null]
id
required		ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
modified_at
required		Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required		VPN Tunnel Name
Example : ExampleVpnTunnel1
string
phase1
required		VPN Tunnel Phase1
VpnPhase1V1Dot1
phase2
required		VPN Tunnel Phase2
VpnPhase2V1Dot1
state
required		State
Example : ACTIVE
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
vpc_id
required		VPC Id
Example : ceb44ea5ecb34a49b16495f9a63b0718
string
vpc_name
required		VPC Name
Example : ExampleVPC1
string
vpn_gateway_id
required		VPN Gateway ID
Example : b156740b6335468d8354eb9ef8eddf5a
string
vpn_gateway_ip_address
required		VPN Gateway IP Address
Example : 123.0.0.1
string
vpn_gateway_name
required		VPN Gateway Name
Example : ExampleVpnGW1
string