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

Return to the regular view of this page.

VPC

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 VPC service and how to call CLI. The output is formatted as a JSON string

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
1.2CURRENT-
1.1SUPPORTED20261130
1.0DEPRECATED20251231

1 - CLIs

1.1 - Add VPC CIDR

1.1.1 - 1.2

scp-cli vpc vpc cidr create
--vpc_id <value>
--cidr <value>

Description

Add VPC CIDR.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-
cidr
required
stringVPC Cidr192.167.0.0/18

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidr_countCidr Count20
cidrs
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState

1.2 - Approval VPC Peering

1.2.1 - 1.2

scp-cli vpc vpc-peering approval
--vpc_peering_id <value>
--type <value>

Description

Approval VPC Peering.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
type
required
stringApproval Type-

1.2.2 - 1.1

scp-cli vpc vpc-peering approval
--vpc_peering_id <value>
--type <value>

Description

Approval VPC Peering.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
type
required
stringApproval Type-

1.3 - Approve PrivateLink Endpoint

1.3.1 - 1.2

scp-cli vpc privatelink-endpoint approve
--privatelink_endpoint_id <value>
--type <value>

Description

Approve PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
type
required
stringPrivateLink Endpoint Action TypeAPPROVE

1.3.2 - 1.1

scp-cli vpc privatelink-endpoint approve
--privatelink_endpoint_id <value>
--type <value>

Description

Approve PrivateLink Endpoint

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
type
required
stringPrivateLink Endpoint Action TypeAPPROVE

1.4 - Connect PrivateLink Endpoint

1.4.1 - 1.2

scp-cli vpc privatelink-endpoint connect
--privatelink_endpoint_id <value>
--type <value>

Description

Connect PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
type
required
stringPrivateLink Endpoint Action TypeDISCONNECT

1.4.2 - 1.1

scp-cli vpc privatelink-endpoint connect
--privatelink_endpoint_id <value>
--type <value>

Description

Connect PrivateLink Endpoint

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
type
required
stringPrivateLink Endpoint Action TypeDISCONNECT

1.5 - Connect Subnet VIP Port

1.5.1 - 1.2

scp-cli vpc subnet vip port create
--vip_id <value>
--subnet_id <value>
--port_id <value>

Description

Connect Subnet Vip Port

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vip_id
required
stringSubnet Vip Id0466a9448d9a4411a86055939e451c8f
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492
port_id
required
stringPort ID35268a9f2eda4cde83b1d85c1f61f67d

Responses

NameDescriptionExample
idConnected Port Id35268a9f2eda4cde83b1d85c1f61f67d
subnet_vip_idSubnet Vip Id0466a9448d9a4411a86055939e451c8f

1.6 - Create Internet Gateway

1.6.1 - 1.2

scp-cli vpc internet-gateway create
--vpc_id <value>
--type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_loggable <value>]
[--tags <value>]

Description

Create Internet Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
type
required
stringInternet Gateway Type-
description
optional
stringDescriptionInternet Gateway Description
firewall_enabled
optional
booleanFirewall Enable-
firewall_loggable
optional
booleanFirewall Loggable-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idInternet Gateway ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionInternet Gateway Description
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
loggableNAT LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway NameIGW_VPCname
stateState
typeInternet Gateway Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.6.2 - 1.1

scp-cli vpc internet-gateway create
--vpc_id <value>
--type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_loggable <value>]
[--tags <value>]

Description

Create Internet Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
type
required
stringInternet Gateway Type-
description
optional
stringDescriptionInternet Gateway Description
firewall_enabled
optional
booleanFirewall Enable-
firewall_loggable
optional
booleanFirewall Loggable-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idInternet Gateway ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionInternet Gateway Description
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
loggableNAT LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway NameIGW_VPCname
stateState
typeInternet Gateway Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.6.3 - 1.0

scp-cli vpc internet-gateway create
--vpc_id <value>
--type <value>
[--description <value>]
[--firewall_enabled <value>]
[--firewall_loggable <value>]
[--tags <value>]

Description

Create Internet Gateway.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
type
required
stringInternet Gateway Type-
description
optional
stringDescriptionInternet Gateway Description
firewall_enabled
optional
booleanFirewall Enable-
firewall_loggable
optional
booleanFirewall Loggable-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idInternet Gateway ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionInternet Gateway Description
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
loggableNAT LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway NameIGW_VPCname
stateState
typeInternet Gateway Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.7 - Create NAT Gateway

1.7.1 - 1.2

scp-cli vpc nat-gateway create
--subnet_id <value>
--publicip_id <value>
[--description <value>]
[--tags <value>]

Description

Create NAT Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet CIDR023c57b14f11483689338d085e061492
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18
description
optional
stringNAT Gateway DescriptionVpcEndpoint Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idNAT Gateway ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway DescriptionVpcEndpoint Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway NameNatGatewayName
nat_gateway_ip_addressNAT Gateway IP Address192.167.0.5
publicip_idPublicIP ID12f56e27070248a6a240a497e43fbe18
stateNAT Gateway StateACTIVE
subnet_cidrSubnet Cidr192.167.1.0/24
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.7.2 - 1.1

scp-cli vpc nat-gateway create
--subnet_id <value>
--publicip_id <value>
[--description <value>]
[--tags <value>]

Description

Create NAT Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet CIDR023c57b14f11483689338d085e061492
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18
description
optional
stringNAT Gateway DescriptionVpcEndpoint Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idNAT Gateway ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway DescriptionVpcEndpoint Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway NameNatGatewayName
nat_gateway_ip_addressNAT Gateway IP Address192.167.0.5
publicip_idPublicIP ID12f56e27070248a6a240a497e43fbe18
stateNAT Gateway StateACTIVE
subnet_cidrSubnet Cidr192.167.1.0/24
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.7.3 - 1.0

scp-cli vpc nat-gateway create
--subnet_id <value>
--publicip_id <value>
[--description <value>]
[--tags <value>]

Description

Create NAT Gateway.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet CIDR023c57b14f11483689338d085e061492
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18
description
optional
stringNAT Gateway DescriptionVpcEndpoint Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idNAT Gateway ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway DescriptionVpcEndpoint Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway NameNatGatewayName
nat_gateway_ip_addressNAT Gateway IP Address192.167.0.5
publicip_idPublicIP ID12f56e27070248a6a240a497e43fbe18
stateNAT Gateway StateACTIVE
subnet_cidrSubnet Cidr192.167.1.0/24
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.8 - Create Port

1.8.1 - 1.2

scp-cli vpc port create
--subnet_id <value>
--name <value>
[--description <value>]
[--fixed_ip_address <value>]
[--security_groups <value>]
[--tags <value>]

Description

Create port.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id-
name
required
stringPort NameportName
description
optional
stringDescriptionPort Description
fixed_ip_address
optional
stringFixed IP-
security_groups
optional
arraySecurity Group List-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPort ID023c57b1-4f11-4836-8933-8d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idConnected resource ID9387e8f51de04a03994de8a9c3524935
attached_resource_typeConnected resource Type
created_atCreated date
descriptionDescriptionPort Description
fixed_ip_addressFixed IP192.168.1.100
mac_addressMAC Addressfa:16:3e:00:00:01
modified_atModified date
namePort NameportName
security_groupsSecurity Group List
stateState
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
virtual_ip_addressesVirtual IP Address
vpc_idVPC Id071bc63b767444c9afaab1c972d302d5
vpc_nameVPC NamevpcName

1.8.2 - 1.1

scp-cli vpc port create
--subnet_id <value>
--name <value>
[--description <value>]
[--fixed_ip_address <value>]
[--security_groups <value>]
[--tags <value>]

Description

Create port.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id-
name
required
stringPort NameportName
description
optional
stringDescriptionPort Description
fixed_ip_address
optional
stringFixed IP-
security_groups
optional
arraySecurity Group List-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPort ID023c57b1-4f11-4836-8933-8d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idConnected resource ID9387e8f51de04a03994de8a9c3524935
attached_resource_typeConnected resource Type
created_atCreated date
descriptionDescriptionPort Description
fixed_ip_addressFixed IP192.168.1.100
mac_addressMAC Addressfa:16:3e:00:00:01
modified_atModified date
namePort NameportName
security_groupsSecurity Group List
stateState
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id071bc63b767444c9afaab1c972d302d5
vpc_nameVPC NamevpcName

1.8.3 - 1.0

scp-cli vpc port create
--subnet_id <value>
--name <value>
[--description <value>]
[--fixed_ip_address <value>]
[--security_groups <value>]
[--tags <value>]

Description

Create port.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id-
name
required
stringPort NameportName
description
optional
stringDescriptionPort Description
fixed_ip_address
optional
stringFixed IP-
security_groups
optional
arraySecurity Group List-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPort ID023c57b1-4f11-4836-8933-8d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idConnected resource ID9387e8f51de04a03994de8a9c3524935
attached_resource_typeConnected resource Type
created_atCreated date
descriptionDescriptionPort Description
fixed_ip_addressFixed IP192.168.1.100
mac_addressMAC Addressfa:16:3e:00:00:01
modified_atModified date
namePort NameportName
security_groupsSecurity Group List
stateState
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id071bc63b767444c9afaab1c972d302d5
vpc_nameVPC NamevpcName

1.9 - Create Private NAT

1.9.1 - 1.2

scp-cli vpc private-nat create
--service_type <value>
--service_resource_id <value>
--name <value>
--cidr <value>
[--description <value>]
[--tags <value>]

Description

Create Private NAT.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
service_type
required
stringPrivate NAT connected Service TypeDIRECT_CONNECT
service_resource_id
required
stringPrivate NAT connected Service Resource ID3f342bf9a557405b997c2cf48c89cbc2
name
required
stringPrivate NAT NamePrivateNatName
cidr
required
stringPrivate NAT IP range192.167.0.0/24
description
optional
stringDescriptionPrivateNat Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivate NAT ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrPrivate NAT IP range192.167.0.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateNat Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT NamePrivateNatName
service_resource_idPrivate NAT connected Service Resource ID3f342bf9a557405b997c2cf48c89cbc2
service_resource_namePrivate NAT connected Service Resource NamePrivateNatName
service_typePrivate NAT connected Service TypeDIRECT_CONNECT
statePrivate NAT StateACTIVE

1.9.2 - 1.1

scp-cli vpc private-nat create
--name <value>
--direct_connect_id <value>
--cidr <value>
[--description <value>]
[--tags <value>]

Description

Create Private NAT.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
name
required
stringPrivate NAT NamePrivateNatName
direct_connect_id
required
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
cidr
required
stringPrivate NAT IP range192.167.0.0/24
description
optional
stringDescriptionPrivateNat Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivate NAT ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrPrivate NAT IP range192.167.0.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateNat Description
direct_connect_idDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
direct_connect_nameDirect Connect NameDirectConnectName
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT NamePrivateNatName
statePrivate NAT StateACTIVE
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.9.3 - 1.0

scp-cli vpc private-nat create
--name <value>
--direct_connect_id <value>
--cidr <value>
[--description <value>]
[--tags <value>]

Description

Create Private NAT.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
name
required
stringPrivate NAT NamePrivateNatName
direct_connect_id
required
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
cidr
required
stringPrivate NAT IP range192.167.0.0/24
description
optional
stringDescriptionPrivateNat Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivate NAT ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrPrivate NAT IP range192.167.0.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateNat Description
direct_connect_idDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
direct_connect_nameDirect Connect NameDirectConnectName
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT NamePrivateNatName
statePrivate NAT StateACTIVE
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.10 - Create Private NAT IP

1.10.1 - 1.2

scp-cli vpc private-nat-ip create
--private_nat_id <value>
--ip_address <value>

Description

Create Private NAT IP.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18
ip_address
required
stringPrivate NAT IP Address-

Responses

NameDescriptionExample
idPrivate NAT IP ID
attached_resource_idPrivate NAT IP Attached Resource ID
attached_resource_namePrivate NAT IP Attached Resource Name
attached_resource_typePrivate NAT IP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
ip_addressPrivate NAT IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
private_nat_idPrivate NAT ID
statePrivate NAT IP State

1.10.2 - 1.1

scp-cli vpc private-nat-ip create
--private_nat_id <value>
--ip_address <value>

Description

Create Private NAT IP.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18
ip_address
required
stringPrivate NAT IP Address-

Responses

NameDescriptionExample
idPrivate NAT IP ID
attached_resource_idPrivate NAT IP Attached Resource ID
attached_resource_namePrivate NAT IP Attached Resource Name
attached_resource_typePrivate NAT IP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
ip_addressPrivate NAT IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
private_nat_idPrivate NAT ID
statePrivate NAT IP State

1.10.3 - 1.0

scp-cli vpc private-nat-ip create
--private_nat_id <value>
--ip_address <value>

Description

Create Private NAT IP.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18
ip_address
required
stringPrivate NAT IP Address-

Responses

NameDescriptionExample
idPrivate NAT IP ID
attached_resource_idPrivate NAT IP Attached Resource ID
attached_resource_namePrivate NAT IP Attached Resource Name
attached_resource_typePrivate NAT IP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
ip_addressPrivate NAT IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
private_nat_idPrivate NAT ID
statePrivate NAT IP State

1.11 - Create PrivateLink Endpoint

1.11.1 - 1.2

scp-cli vpc privatelink-endpoint create
--subnet_id <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--privatelink_service_id <value>]
[--security_group_ids <value>]
[--tags <value>]

Description

Create PrivateLink Endpoint.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
name
required
stringPrivateLink Endpoint NameEndpointName
endpoint_ip_address
required
stringEndpoint IP Address192.167.1.5
description
optional
stringDescriptionPrivateLink Endpoint Description
privatelink_service_id
optional
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
security_group_ids
optional
arraySecurity Group List[
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateLink Endpoint Description
endpoint_ip_addressEndpoint IP Address192.167.1.5
endpoint_ip_port_idEndpoint IP Port IDb44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Endpoint NameEndpointName
privatelink_service_idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
security_group_idsSecurity Group List[‘17776b52-0a64-440d-9e93-b4fc37be935b’]
statePrivateLink Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

1.11.2 - 1.1

scp-cli vpc privatelink-endpoint create
--subnet_id <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--privatelink_service_id <value>]
[--security_group_ids <value>]
[--tags <value>]

Description

Create PrivateLink Endpoint.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
name
required
stringPrivateLink Endpoint NameEndpointName
endpoint_ip_address
required
stringEndpoint IP Address192.167.1.5
description
optional
stringDescriptionPrivateLink Endpoint Description
privatelink_service_id
optional
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
security_group_ids
optional
arraySecurity Group List[
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateLink Endpoint Description
endpoint_ip_addressEndpoint IP Address192.167.1.5
endpoint_ip_port_idEndpoint IP Port IDb44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Endpoint NameEndpointName
privatelink_service_idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
security_group_idsSecurity Group List[‘17776b52-0a64-440d-9e93-b4fc37be935b’]
statePrivateLink Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

1.12 - Create PrivateLink Service

1.12.1 - 1.2

scp-cli vpc privatelink-service create
--subnet_id <value>
--service_ip_address <value>
--name <value>
--connected_resource_type <value>
--approval_type <value>
[--connected_resource_id <value>]
[--connected_resource_ip_address <value>]
[--description <value>]
[--high_speed_transfer <value>]
[--security_group_ids <value>]
[--tags <value>]

Description

Create PrivateLink Service.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
service_ip_address
required
stringService IP Address192.167.0.5
name
required
stringPrivateLink Service NameServiceName
connected_resource_type
required
stringConnected Resource TypeLB
approval_type
required
stringPrivateLink Service Approval TypeAUTO
connected_resource_id
optional
stringConnected Resource IDa3e3a662a4f34442a94166df5ff9f577
connected_resource_ip_address
optional
stringConnected Resource IP Address192.167.0.10
description
optional
stringDescriptionPrivateLink Service Description
high_speed_transfer
optional
booleanHigh Speed Data Transfer UseFalse
security_group_ids
optional
arraySecurity Group List[
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
connected_resource_idConnected Resource IDa3e3a662a4f34442a94166df5ff9f577
connected_resource_ip_addressConnected Resource IP Address192.167.0.10
connected_resource_nameConnected Resource NamelbResourceName
connected_resource_typeConnected Resource TypeLB
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateLink Service Description
high_speed_transferHigh Speed Data Transfer UseFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Service NameServiceName
security_group_idsSecurity Group List[‘00b6af37-73b5-4de2-b080-c295a1a0382e’]
service_ip_addressService IP Address192.167.0.5
service_ip_port_idService IP Port IDd21a4b81-f52a-43a8-b985-341e763458bb
statePrivateLink Service State
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

1.12.2 - 1.1

scp-cli vpc privatelink-service create
--subnet_id <value>
--service_ip_address <value>
--name <value>
--connected_resource_type <value>
--approval_type <value>
[--connected_resource_id <value>]
[--connected_resource_ip_address <value>]
[--description <value>]
[--high_speed_transfer <value>]
[--security_group_ids <value>]
[--tags <value>]

Description

Create PrivateLink Service.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
service_ip_address
required
stringService IP Address192.167.0.5
name
required
stringPrivateLink Service NameServiceName
connected_resource_type
required
stringConnected Resource TypeLB
approval_type
required
stringPrivateLink Service Approval TypeAUTO
connected_resource_id
optional
stringConnected Resource IDa3e3a662a4f34442a94166df5ff9f577
connected_resource_ip_address
optional
stringConnected Resource IP Address192.167.0.10
description
optional
stringDescriptionPrivateLink Service Description
high_speed_transfer
optional
booleanHigh Speed Data Transfer UseFalse
security_group_ids
optional
arraySecurity Group List[
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
connected_resource_idConnected Resource IDa3e3a662a4f34442a94166df5ff9f577
connected_resource_ip_addressConnected Resource IP Address192.167.0.10
connected_resource_nameConnected Resource NamelbResourceName
connected_resource_typeConnected Resource TypeLB
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateLink Service Description
high_speed_transferHigh Speed Data Transfer UseFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Service NameServiceName
security_group_idsSecurity Group List[‘00b6af37-73b5-4de2-b080-c295a1a0382e’]
service_ip_addressService IP Address192.167.0.5
service_ip_port_idService IP Port IDd21a4b81-f52a-43a8-b985-341e763458bb
statePrivateLink Service State
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

1.13 - Create PublicIP

1.13.1 - 1.2

scp-cli vpc public-ip create
--type <value>
[--description <value>]
[--tags <value>]

Description

Create PublicIP.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
type
required
stringPublicIP TypeIGW
description
optional
stringPublicIP DescriptionPublic IP Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPublicIP ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_namePublicIP Attached Resource NameAttached NAT Gateway Name
attached_resource_typePublicIP Attached Resource TypeNAT_GW
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP DescriptionPublic IP Description
ip_addressIP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP StateATTACHED
typePublicIP TypeIGW

1.13.2 - 1.1

scp-cli vpc public-ip create
--type <value>
[--description <value>]
[--tags <value>]

Description

Create PublicIP.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
type
required
stringPublicIP TypeIGW
description
optional
stringPublicIP DescriptionPublic IP Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPublicIP ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_namePublicIP Attached Resource NameAttached NAT Gateway Name
attached_resource_typePublicIP Attached Resource TypeNAT_GW
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP DescriptionPublic IP Description
ip_addressIP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP StateATTACHED
typePublicIP TypeIGW

1.13.3 - 1.0

scp-cli vpc public-ip create
--type <value>
[--description <value>]
[--tags <value>]

Description

Create PublicIP.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
type
required
stringPublicIP TypeIGW
description
optional
stringPublicIP DescriptionPublic IP Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idPublicIP ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_namePublicIP Attached Resource NameAttached NAT Gateway Name
attached_resource_typePublicIP Attached Resource TypeNAT_GW
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP DescriptionPublic IP Description
ip_addressIP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP StateATTACHED
typePublicIP TypeIGW

1.14 - Create Subnet

1.14.1 - 1.2

scp-cli vpc subnet create
--vpc_id <value>
--type <value>
--name <value>
--cidr <value>
[--allocation_pools <value>]
[--description <value>]
[--dns_nameservers <value>]
[--gateway_ip_address <value>]
[--host_routes <value>]
[--tags <value>]

Description

Create subnet.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
type
required
stringSubnet Type-
name
required
stringSubnet NamesubnetName
cidr
required
stringSubnet Cidr192.167.1.0/24
allocation_pools
optional
arrayAllocation Pools[
description
optional
stringDescriptionSubnet Description
dns_nameservers
optional
arrayDNS Name Servers[
gateway_ip_address
optional
stringGateway IP Address192.167.1.1
host_routes
optional
arrayHost Routes[
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
allocation_poolsAllocation Pools
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionSubnet Description
dhcp_ip_addressDHCP IP Address
dns_nameserversDNS Name Servers
gateway_ip_addressGateway IP Address192.167.1.1
host_routesHost Routes
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateState
typeSubnet Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.14.2 - 1.1

scp-cli vpc subnet create
--vpc_id <value>
--type <value>
--name <value>
--cidr <value>
[--allocation_pools <value>]
[--description <value>]
[--dns_nameservers <value>]
[--host_routes <value>]
[--tags <value>]

Description

Create subnet.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
type
required
stringSubnet Type-
name
required
stringSubnet NamesubnetName
cidr
required
stringSubnet Cidr192.167.1.0/24
allocation_pools
optional
arrayAllocation Pools[
description
optional
stringDescriptionSubnet Description
dns_nameservers
optional
arrayDNS Name Servers[
host_routes
optional
arrayHost Routes[
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
allocation_poolsAllocation Pools
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionSubnet Description
dns_nameserversDNS Name Servers
gateway_ip_addressGateway IP Address192.167.1.1
host_routesHost Routes
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateState
typeSubnet Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.14.3 - 1.0

scp-cli vpc subnet create
--vpc_id <value>
--type <value>
--name <value>
--cidr <value>
[--allocation_pools <value>]
[--description <value>]
[--dns_nameservers <value>]
[--host_routes <value>]
[--tags <value>]

Description

Create subnet.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
type
required
stringSubnet Type-
name
required
stringSubnet NamesubnetName
cidr
required
stringSubnet Cidr192.167.1.0/24
allocation_pools
optional
arrayAllocation Pools[
description
optional
stringDescriptionSubnet Description
dns_nameservers
optional
arrayDNS Name Servers[
host_routes
optional
arrayHost Routes[
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
allocation_poolsAllocation Pools
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionSubnet Description
dns_nameserversDNS Name Servers
gateway_ip_addressGateway IP Address192.167.1.1
host_routesHost Routes
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateState
typeSubnet Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.15 - Create Subnet VIP

1.15.1 - 1.2

scp-cli vpc subnet vip create
--subnet_id <value>
[--description <value>]
[--virtual_ip_address <value>]

Description

Create Subnet Vip

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
description
optional
stringDescriptionSubnet VIP Description
virtual_ip_address
optional
stringVirtual IP Address192.168.20.6

Responses

NameDescriptionExample
idSubnet Vip Id0466a9448d9a4411a86055939e451c8f
connected_ports
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionSubnet VIP Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateStateACTIVE
static_natStatic NAT Info
subnet_idSubnet ID023c57b14f11483689338d085e061492
vip_port_idVip Port Id35268a9f2eda4cde83b1d85c1f61f67d
virtual_ip_addressVirtual IP Address192.168.20.6

1.16 - Create Subnet VIP NAT IP

1.16.1 - 1.2

scp-cli vpc subnet vip nat create
--vip_id <value>
--subnet_id <value>
--publicip_id <value>
--nat_type <value>

Description

Create Subnet Vip Nat Ip

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vip_id
required
stringSubnet Vip Id0466a9448d9a4411a86055939e451c8f
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492
publicip_id
required
stringPublicip ID12f56e27070248a6a240a497e43fbe18
nat_type
required
stringNAT TypePUBLIC

Responses

NameDescriptionExample
idStatic Nat Id0009e49548154745948e9722adefbf40
publicip_idPublicip ID12f56e27070248a6a240a497e43fbe18
stateStatic Nat StateACTIVE

1.17 - Create Transit Gateway

1.17.1 - 1.2

scp-cli vpc transit-gateway create
--name <value>
[--description <value>]
[--tags <value>]

Description

Create Transit Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
name
required
stringTransit Gateway NameTransitGatewayName
description
optional
stringDescriptionTransitGateway Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_connection_stateFirewall Connection StateINACTIVE
firewall_idsFirewall ID[‘bbb93aca123f4bb2b2c0f206f4a86b2b’]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

1.17.2 - 1.1

scp-cli vpc transit-gateway create
--name <value>
[--description <value>]
[--tags <value>]

Description

Create Transit Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
name
required
stringTransit Gateway NameTransitGatewayName
description
optional
stringDescriptionTransitGateway Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_idsFirewall ID[‘bbb93aca123f4bb2b2c0f206f4a86b2b’]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

1.17.3 - 1.0

scp-cli vpc transit-gateway create
--name <value>
[--description <value>]
[--tags <value>]

Description

Create Transit Gateway.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
name
required
stringTransit Gateway NameTransitGatewayName
description
optional
stringDescriptionTransitGateway Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_idsFirewall ID[‘bbb93aca123f4bb2b2c0f206f4a86b2b’]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

1.18 - Create Transit Gateway Firewall

1.18.1 - 1.2

scp-cli vpc transit-gateway-firewall create
--transit_gateway_id <value>
--product_type <value>

Description

Create Transit Gateway Firewall.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
product_type
required
stringFw Product TypeTGW_DGW

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_connection_stateFirewall Connection StateINACTIVE
firewall_idsFirewall ID[‘bbb93aca123f4bb2b2c0f206f4a86b2b’]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

1.19 - Create Transit Gateway Firewall Connection

1.19.1 - 1.2

scp-cli vpc transit-gateway-firewall-connection create
--transit_gateway_id <value>

Description

Create Transit Gateway Firewall Connection.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_connection_stateFirewall Connection StateINACTIVE
firewall_idsFirewall ID[‘bbb93aca123f4bb2b2c0f206f4a86b2b’]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

1.20 - Create Transit Gateway Rule

1.20.1 - 1.2

scp-cli vpc transit-gateway-rule create
--transit_gateway_id <value>
--tgw_connection_vpc_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]

Description

Create Transit Gateway Rule.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
tgw_connection_vpc_id
required
stringVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
destination_type
required
stringDestination TypeVPC
destination_cidr
required
stringDestination CIDR192.167.5.0/24
description
optional
stringDescriptionRouting Rule Description

Responses

NameDescriptionExample
idRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionDescriptionRouting Rule Description
destination_cidrDestination CIDR192.167.5.0/24
destination_resource_idDestination Resource IDceb44ea5ecb34a49b16495f9a63b0718
destination_resource_nameDestination Resource NameVpcName
destination_typeDestination TypeVPC
source_resource_idSource Resource ID8582cc5d89994a42ad53282fd4a8d8be
source_resource_nameSource Resource NameTgwName
source_typeSource TypeTGW
stateStateACTIVE
tgw_connection_vpc_idVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
tgw_connection_vpc_nameVPC Name Connected to Transit Gateway.ConnectedVpcName

1.20.2 - 1.1

scp-cli vpc transit-gateway-rule create
--transit_gateway_id <value>
--tgw_connection_vpc_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]

Description

Create Transit Gateway Rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
tgw_connection_vpc_id
required
stringVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
destination_type
required
stringDestination TypeVPC
destination_cidr
required
stringDestination CIDR192.167.5.0/24
description
optional
stringDescriptionRouting Rule Description

Responses

NameDescriptionExample
idRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionDescriptionRouting Rule Description
destination_cidrDestination CIDR192.167.5.0/24
destination_resource_idDestination Resource IDceb44ea5ecb34a49b16495f9a63b0718
destination_resource_nameDestination Resource NameVpcName
destination_typeDestination TypeVPC
source_resource_idSource Resource ID8582cc5d89994a42ad53282fd4a8d8be
source_resource_nameSource Resource NameTgwName
source_typeSource TypeTGW
stateStateACTIVE
tgw_connection_vpc_idVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
tgw_connection_vpc_nameVPC Name Connected to Transit Gateway.ConnectedVpcName

1.20.3 - 1.0

scp-cli vpc transit-gateway-rule create
--transit_gateway_id <value>
--tgw_connection_vpc_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]

Description

Create Transit Gateway Rule.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
tgw_connection_vpc_id
required
stringVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
destination_type
required
stringDestination TypeVPC
destination_cidr
required
stringDestination CIDR192.167.5.0/24
description
optional
stringDescriptionRouting Rule Description

Responses

NameDescriptionExample
idRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionDescriptionRouting Rule Description
destination_cidrDestination CIDR192.167.5.0/24
destination_resource_idDestination Resource IDceb44ea5ecb34a49b16495f9a63b0718
destination_resource_nameDestination Resource NameVpcName
destination_typeDestination TypeVPC
source_resource_idSource Resource ID8582cc5d89994a42ad53282fd4a8d8be
source_resource_nameSource Resource NameTgwName
source_typeSource TypeTGW
stateStateACTIVE
tgw_connection_vpc_idVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
tgw_connection_vpc_nameVPC Name Connected to Transit Gateway.ConnectedVpcName

1.21 - Create Transit Gateway Uplink Rule

1.21.1 - 1.2

scp-cli vpc transit-gateway-uplink-rule create
--transit_gateway_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]

Description

Create Transit Gateway Uplink Rule.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
destination_type
required
stringDestination TypeON_PREMISE
destination_cidr
required
stringDestination CIDR192.167.5.0/24
description
optional
stringDescriptionRouting Rule Description

Responses

NameDescriptionExample
idRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
descriptionDescriptionRouting Rule Description
destination_cidrDestination CIDR192.167.5.0/24
destination_typeDestination TypeON_PREMISE
stateStateACTIVE

1.21.2 - 1.1

scp-cli vpc transit-gateway-uplink-rule create
--transit_gateway_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]

Description

Create Transit Gateway Uplink Rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
destination_type
required
stringDestination TypeON_PREMISE
destination_cidr
required
stringDestination CIDR192.167.5.0/24
description
optional
stringDescriptionRouting Rule Description

Responses

NameDescriptionExample
idRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
descriptionDescriptionRouting Rule Description
destination_cidrDestination CIDR192.167.5.0/24
destination_typeDestination TypeON_PREMISE
stateStateACTIVE

1.21.3 - 1.0

scp-cli vpc transit-gateway-uplink-rule create
--transit_gateway_id <value>
--destination_type <value>
--destination_cidr <value>
[--description <value>]

Description

Create Transit Gateway Uplink Rule.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
destination_type
required
stringDestination TypeON_PREMISE
destination_cidr
required
stringDestination CIDR192.167.5.0/24
description
optional
stringDescriptionRouting Rule Description

Responses

NameDescriptionExample
idRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
descriptionDescriptionRouting Rule Description
destination_cidrDestination CIDR192.167.5.0/24
destination_typeDestination TypeON_PREMISE
stateStateACTIVE

1.22 - Create Transit Gateway VPC Connection

1.22.1 - 1.2

scp-cli vpc transit-gateway-vpc-connection create
--transit_gateway_id <value>
--vpc_id <value>

Description

Create Transit Gateway VPC Connection.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8

Responses

NameDescriptionExample
idTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateStateACTIVE
transit_gateway_idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.22.2 - 1.1

scp-cli vpc transit-gateway-vpc-connection create
--transit_gateway_id <value>
--vpc_id <value>

Description

Create Transit Gateway VPC Connection.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8

Responses

NameDescriptionExample
idTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateStateACTIVE
transit_gateway_idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.22.3 - 1.0

scp-cli vpc transit-gateway-vpc-connection create
--transit_gateway_id <value>
--vpc_id <value>

Description

Create Transit Gateway VPC Connection.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8

Responses

NameDescriptionExample
idTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateStateACTIVE
transit_gateway_idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.23 - Create VPC

1.23.1 - 1.2

scp-cli vpc vpc create
--name <value>
--cidr <value>
[--description <value>]
[--tags <value>]

Description

Create VPC.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
name
required
stringVPC NamevpcName
cidr
required
stringVPC Cidr192.167.0.0/18
description
optional
stringDescriptionVPC Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidr_countCidr Count20
cidrs
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState

1.23.2 - 1.1

scp-cli vpc vpc create
--name <value>
--cidr <value>
[--description <value>]
[--tags <value>]

Description

Create VPC.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
name
required
stringVPC NamevpcName
cidr
required
stringVPC Cidr192.167.0.0/18
description
optional
stringDescriptionVPC Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrVPC Cidr192.167.0.0/18
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState

1.23.3 - 1.0

scp-cli vpc vpc create
--name <value>
--cidr <value>
[--description <value>]
[--tags <value>]

Description

Create VPC.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
name
required
stringVPC NamevpcName
cidr
required
stringVPC Cidr192.167.0.0/18
description
optional
stringDescriptionVPC Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrVPC Cidr192.167.0.0/18
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState

1.24 - Create VPC Endpoint

1.24.1 - 1.2

scp-cli vpc vpc-endpoint create
--vpc_id <value>
--subnet_id <value>
--resource_type <value>
--resource_key <value>
--resource_info <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--tags <value>]

Description

Create VPC Endpoint.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
resource_type
required
stringVPC Endpoint Resource TypeFS
resource_key
required
stringVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_info
required
stringVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
name
required
stringVPC Endpoint NameVpcEndpointName
endpoint_ip_address
required
stringVPC Endpoint IP Address192.167.0.5
description
optional
stringDescriptionVpcEndpoint Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionVpcEndpoint Description
endpoint_ip_addressVPC Endpoint IP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint NameVpcEndpointName
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS
stateVPC Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.24.2 - 1.1

scp-cli vpc vpc-endpoint create
--vpc_id <value>
--subnet_id <value>
--resource_type <value>
--resource_key <value>
--resource_info <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--tags <value>]

Description

Create VPC Endpoint.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
resource_type
required
stringVPC Endpoint Resource TypeFS
resource_key
required
stringVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_info
required
stringVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
name
required
stringVPC Endpoint NameVpcEndpointName
endpoint_ip_address
required
stringVPC Endpoint IP Address192.167.0.5
description
optional
stringDescriptionVpcEndpoint Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionVpcEndpoint Description
endpoint_ip_addressVPC Endpoint IP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint NameVpcEndpointName
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS
stateVPC Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.24.3 - 1.0

scp-cli vpc vpc-endpoint create
--vpc_id <value>
--subnet_id <value>
--resource_type <value>
--resource_key <value>
--resource_info <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--tags <value>]

Description

Create VPC Endpoint.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
resource_type
required
stringVPC Endpoint Resource TypeFS
resource_key
required
stringVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_info
required
stringVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
name
required
stringVPC Endpoint NameVpcEndpointName
endpoint_ip_address
required
stringVPC Endpoint IP Address192.167.0.5
description
optional
stringDescriptionVpcEndpoint Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionVpcEndpoint Description
endpoint_ip_addressVPC Endpoint IP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint NameVpcEndpointName
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS
stateVPC Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.25 - Create VPC Peering

1.25.1 - 1.2

scp-cli vpc vpc-peering create
--requester_vpc_id <value>
--name <value>
--approver_vpc_id <value>
--approver_vpc_account_id <value>
[--description <value>]
[--tags <value>]

Description

Create VPC Peering.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
requester_vpc_id
required
stringRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
name
required
stringVPC Peering NamevpcPeeringName
approver_vpc_id
required
stringApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_account_id
required
stringApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
description
optional
stringDescriptionvpcPeering Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Peering ID023c57b14f11483689338d085e061492
account_typeAccount Type
approver_vpc_account_idApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
approver_vpc_idApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_nameApprover VPC NamevpcName
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionVPC Peering DescriptionvpcPeering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering NamevpcPeeringName
requester_vpc_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
requester_vpc_idRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_nameRequester VPC NamevpcName
stateState

1.25.2 - 1.1

scp-cli vpc vpc-peering create
--requester_vpc_id <value>
--name <value>
--approver_vpc_id <value>
--approver_vpc_account_id <value>
[--description <value>]
[--tags <value>]

Description

Create VPC Peering.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
requester_vpc_id
required
stringRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
name
required
stringVPC Peering NamevpcPeeringName
approver_vpc_id
required
stringApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_account_id
required
stringApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
description
optional
stringDescriptionvpcPeering Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Peering ID023c57b14f11483689338d085e061492
account_typeAccount Type
approver_vpc_account_idApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
approver_vpc_idApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_nameApprover VPC NamevpcName
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionVPC Peering DescriptionvpcPeering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering NamevpcPeeringName
requester_vpc_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
requester_vpc_idRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_nameRequester VPC NamevpcName
stateState

1.25.3 - 1.0

scp-cli vpc vpc-peering create
--requester_vpc_id <value>
--name <value>
--approver_vpc_id <value>
--approver_vpc_account_id <value>
[--description <value>]
[--tags <value>]

Description

Create VPC Peering.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
requester_vpc_id
required
stringRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
name
required
stringVPC Peering NamevpcPeeringName
approver_vpc_id
required
stringApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_account_id
required
stringApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
description
optional
stringDescriptionvpcPeering Description
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Peering ID023c57b14f11483689338d085e061492
account_typeAccount Type
approver_vpc_account_idApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
approver_vpc_idApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_nameApprover VPC NamevpcName
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionVPC Peering DescriptionvpcPeering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering NamevpcPeeringName
requester_vpc_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
requester_vpc_idRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_nameRequester VPC NamevpcName
stateState

1.26 - Create Vpc Peering Rule

1.26.1 - 1.2

scp-cli vpc vpc-peering-routing-rule create
--vpc_peering_id <value>
--destination_vpc_type <value>
--destination_cidr <value>
[--tags <value>]

Description

Create a VPC Peering Rule.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
destination_vpc_type
required
stringDestination VPC Type-
destination_cidr
required
stringDestination CIDR-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Peering Rule ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
destination_cidrDestination CIDR
destination_vpc_idDestination VPC ID
destination_vpc_nameDestination VPC Name
destination_vpc_typeDestination VPC Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
source_vpc_idSource VPC ID
source_vpc_nameSource VPC Name
source_vpc_typeSource VPC Type
stateState
vpc_peering_idVPC Peering ID

1.26.2 - 1.1

scp-cli vpc vpc-peering-routing-rule create
--vpc_peering_id <value>
--destination_vpc_type <value>
--destination_cidr <value>
[--tags <value>]

Description

Create a VPC Peering Rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
destination_vpc_type
required
stringDestination VPC Type-
destination_cidr
required
stringDestination CIDR-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Peering Rule ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
destination_cidrDestination CIDR
destination_vpc_idDestination VPC ID
destination_vpc_nameDestination VPC Name
destination_vpc_typeDestination VPC Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
source_vpc_idSource VPC ID
source_vpc_nameSource VPC Name
source_vpc_typeSource VPC Type
stateState
vpc_peering_idVPC Peering ID

1.26.3 - 1.0

scp-cli vpc vpc-peering-routing-rule create
--vpc_peering_id <value>
--destination_vpc_type <value>
--destination_cidr <value>
[--tags <value>]

Description

Create a VPC Peering Rule.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
destination_vpc_type
required
stringDestination VPC Type-
destination_cidr
required
stringDestination CIDR-
tags
optional
arrayTag List'{"key": "", "value": ""}'

Responses

NameDescriptionExample
idVPC Peering Rule ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
destination_cidrDestination CIDR
destination_vpc_idDestination VPC ID
destination_vpc_nameDestination VPC Name
destination_vpc_typeDestination VPC Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
source_vpc_idSource VPC ID
source_vpc_nameSource VPC Name
source_vpc_typeSource VPC Type
stateState
vpc_peering_idVPC Peering ID

1.27 - Delete Internet Gateway

1.27.1 - 1.2

scp-cli vpc internet-gateway delete
--internet_gateway_id <value>

Description

Delete Internet Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID023c57b14f11483689338d085e061492

1.27.2 - 1.1

scp-cli vpc internet-gateway delete
--internet_gateway_id <value>

Description

Delete Internet Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID023c57b14f11483689338d085e061492

1.27.3 - 1.0

scp-cli vpc internet-gateway delete
--internet_gateway_id <value>

Description

Delete Internet Gateway.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID023c57b14f11483689338d085e061492

1.28 - Delete NAT Gateway

1.28.1 - 1.2

scp-cli vpc nat-gateway delete
--nat_gateway_id <value>

Description

Delete NAT Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID12f56e27070248a6a240a497e43fbe18

1.28.2 - 1.1

scp-cli vpc nat-gateway delete
--nat_gateway_id <value>

Description

Delete NAT Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID12f56e27070248a6a240a497e43fbe18

1.28.3 - 1.0

scp-cli vpc nat-gateway delete
--nat_gateway_id <value>

Description

Delete NAT Gateway.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID12f56e27070248a6a240a497e43fbe18

1.29 - Delete Port

1.29.1 - 1.2

scp-cli vpc port delete
--port_id <value>

Description

Delete port.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID023c57b1-4f11-4836-8933-8d085e061492

1.29.2 - 1.1

scp-cli vpc port delete
--port_id <value>

Description

Delete port.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID023c57b1-4f11-4836-8933-8d085e061492

1.29.3 - 1.0

scp-cli vpc port delete
--port_id <value>

Description

Delete port.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID023c57b1-4f11-4836-8933-8d085e061492

1.30 - Delete Private NAT

1.30.1 - 1.2

scp-cli vpc private-nat delete
--private_nat_id <value>

Description

Delete Private NAT.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18

1.30.2 - 1.1

scp-cli vpc private-nat delete
--private_nat_id <value>

Description

Delete Private NAT.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18

1.30.3 - 1.0

scp-cli vpc private-nat delete
--private_nat_id <value>

Description

Delete Private NAT.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18

1.31 - Delete Private NAT IP

1.31.1 - 1.2

scp-cli vpc private-nat-ip delete
--private_nat_ip_id <value>
--private_nat_id <value>

Description

Delete Private NAT IP.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
private_nat_ip_id
required
stringPrivate NAT IP ID-
private_nat_id
required
stringPrivate NAT ID-

1.31.2 - 1.1

scp-cli vpc private-nat-ip delete
--private_nat_ip_id <value>
--private_nat_id <value>

Description

Delete Private NAT IP.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
private_nat_ip_id
required
stringPrivate NAT IP ID-
private_nat_id
required
stringPrivate NAT ID-

1.31.3 - 1.0

scp-cli vpc private-nat-ip delete
--private_nat_ip_id <value>
--private_nat_id <value>

Description

Delete Private NAT IP.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
private_nat_ip_id
required
stringPrivate NAT IP ID-
private_nat_id
required
stringPrivate NAT ID-

1.32 - Delete PrivateLink Endpoint

1.32.1 - 1.2

scp-cli vpc privatelink-endpoint delete
--privatelink_endpoint_id <value>

Description

Delete PrivateLink Endpoint.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02

1.32.2 - 1.1

scp-cli vpc privatelink-endpoint delete
--privatelink_endpoint_id <value>

Description

Delete PrivateLink Endpoint.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02

1.33 - Delete PrivateLink Service

1.33.1 - 1.2

scp-cli vpc privatelink-service delete
--privatelink_service_id <value>

Description

Delete PrivateLink Service.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d

1.33.2 - 1.1

scp-cli vpc privatelink-service delete
--privatelink_service_id <value>

Description

Delete PrivateLink Service.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d

1.34 - Delete PublicIP

1.34.1 - 1.2

scp-cli vpc public-ip delete
--publicip_id <value>

Description

Delete PublicIP.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18

1.34.2 - 1.1

scp-cli vpc public-ip delete
--publicip_id <value>

Description

Delete PublicIP.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18

1.34.3 - 1.0

scp-cli vpc public-ip delete
--publicip_id <value>

Description

Delete PublicIP.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18

1.35 - Delete Subnet

1.35.1 - 1.2

scp-cli vpc subnet delete
--subnet_id <value>

Description

Delete subnet.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492

1.35.2 - 1.1

scp-cli vpc subnet delete
--subnet_id <value>

Description

Delete subnet.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492

1.35.3 - 1.0

scp-cli vpc subnet delete
--subnet_id <value>

Description

Delete subnet.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492

1.36 - Delete Subnet Vip

1.36.1 - 1.2

scp-cli vpc subnet vip delete
--vip_id <value>
--subnet_id <value>

Description

Delete Subnet Vip

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vip_id
required
stringSubnet Vip Id0466a9448d9a4411a86055939e451c8f
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492

1.37 - Delete Subnet Vip Connected Port

1.37.1 - 1.2

scp-cli vpc subnet vip port delete 
--connected_port_id <value>
--vip_id <value>
--subnet_id <value>

Description

Delete Subnet Vip Connected Port

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
connected_port_id
required
stringSubnet Vip Connected Port Id13e2a5a1acbe4713a9a2c70ce226e822
vip_id
required
stringSubnet Vip Id0466a9448d9a4411a86055939e451c8f
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492

1.38 - Delete Subnet VIP NAT IP

1.38.1 - 1.2

scp-cli vpc subnet vip nat delete
--static_nat_id <value>
--vip_id <value>
--subnet_id <value>

Description

Delete Subnet Vip Nat Ip

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
static_nat_id
required
stringStatic NAT ID0009e49548154745948e9722adefbf40
vip_id
required
stringSubnet Vip Id0466a9448d9a4411a86055939e451c8f
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492

1.39 - Delete Transit Gateway

1.39.1 - 1.2

scp-cli vpc transit-gateway delete
--transit_gateway_id <value>

Description

Delete Transit Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

1.39.2 - 1.1

scp-cli vpc transit-gateway delete
--transit_gateway_id <value>

Description

Delete Transit Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

1.39.3 - 1.0

scp-cli vpc transit-gateway delete
--transit_gateway_id <value>

Description

Delete Transit Gateway.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

1.40 - Delete Transit Gateway Firewall

1.40.1 - 1.2

scp-cli vpc transit-gateway-firewall-delete
--firewall_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway Firewall.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
firewall_id
required
stringFirewall IDbbb93aca123f4bb2b2c0f206f4a86b2b
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

1.41 - Delete Transit Gateway Firewall Connection

1.41.1 - 1.2

scp-cli vpc transit-gateway-firewall-connection delete
--transit_gateway_id <value>

Description

Delete Transit Gateway Firewall Connection.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

1.42 - Delete Transit Gateway Rule

1.42.1 - 1.2

scp-cli vpc transit-gateway-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway Rule.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

1.42.2 - 1.1

scp-cli vpc transit-gateway-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway Rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

1.42.3 - 1.0

scp-cli vpc transit-gateway-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway Rule.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

1.43 - Delete Transit Gateway Uplink Rule

1.43.1 - 1.2

scp-cli vpc transit-gateway-uplink-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway Uplink Rule.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

1.43.2 - 1.1

scp-cli vpc transit-gateway-uplink-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway Uplink Rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

1.43.3 - 1.0

scp-cli vpc transit-gateway-uplink-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway Uplink Rule.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

1.44 - Delete Transit Gateway VPC Connection

1.44.1 - 1.2

scp-cli vpc transit-gateway-vpc-connection delete
--vpc_connection_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway VPC Connection.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_connection_id
required
stringTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

1.44.2 - 1.1

scp-cli vpc transit-gateway-vpc-connection delete
--vpc_connection_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway VPC Connection.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_connection_id
required
stringTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

1.44.3 - 1.0

scp-cli vpc transit-gateway-vpc-connection delete
--vpc_connection_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway VPC Connection.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
vpc_connection_id
required
stringTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

1.45 - Delete VPC

1.45.1 - 1.2

scp-cli vpc vpc delete
--vpc_id <value>

Description

Delete VPC.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-

1.45.2 - 1.1

scp-cli vpc vpc delete
--vpc_id <value>

Description

Delete VPC.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-

1.45.3 - 1.0

scp-cli vpc vpc delete
--vpc_id <value>

Description

Delete VPC.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-

1.46 - Delete VPC Endpoint

1.46.1 - 1.2

scp-cli vpc vpc-endpoint delete
--vpc_endpoint_id <value>

Description

Delete VPC Endpoint.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18

1.46.2 - 1.1

scp-cli vpc vpc-endpoint delete
--vpc_endpoint_id <value>

Description

Delete VPC Endpoint.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18

1.46.3 - 1.0

scp-cli vpc vpc-endpoint delete
--vpc_endpoint_id <value>

Description

Delete VPC Endpoint.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18

1.47 - Delete VPC Peering

1.47.1 - 1.2

scp-cli vpc vpc-peering delete
--vpc_peering_id <value>

Description

Delete VPC Peering.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492

1.47.2 - 1.1

scp-cli vpc vpc-peering delete
--vpc_peering_id <value>

Description

Delete VPC Peering.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492

1.47.3 - 1.0

scp-cli vpc vpc-peering delete
--vpc_peering_id <value>

Description

Delete VPC Peering.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492

1.48 - Delete VPC Peering Rule

1.48.1 - 1.2

scp-cli vpc vpc-peering-rule delete
--routing_rule_id <value>
--vpc_peering_id <value>

Description

Delete a VPC Peering Rule.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID-
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492

1.48.2 - 1.1

scp-cli vpc vpc-peering-rule delete
--routing_rule_id <value>
--vpc_peering_id <value>

Description

Delete a VPC Peering Rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID-
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492

1.48.3 - 1.0

scp-cli vpc vpc-peering-rule delete
--routing_rule_id <value>
--vpc_peering_id <value>

Description

Delete a VPC Peering Rule.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
routing_rule_id
required
stringRouting Rule ID-
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492

1.49 - List Connected PrivateLink Endpoints

1.49.1 - 1.2

scp-cli vpc privatelink-service-connected-endpoint list
--privatelink_service_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

Get Connected PrivateLink Endpoint List.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
privatelink_service_idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
statePrivateLink Endpoint StateACTIVE

1.49.2 - 1.1

scp-cli vpc privatelink-service-connected-endpoint list
--privatelink_service_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

Get Connected PrivateLink Endpoint List.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
privatelink_service_idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
statePrivateLink Endpoint StateACTIVE

1.50 - List Internet Gateways

1.50.1 - 1.2

scp-cli vpc internet-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

Get Internet Gateway list.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringInternet Gateway ID023c57b14f11483689338d085e061492
name
optional
stringInternet Gateway NameIGW_VPCname
type
optional
****Internet Gateway Type-
state
optional
stringState-
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName

Responses

NameDescriptionExample
idInternet Gateway ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionInternet Gateway Description
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
loggableNAT LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway NameIGW_VPCname
stateState
typeInternet Gateway Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.50.2 - 1.1

scp-cli vpc internet-gateway list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

Get Internet Gateway list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringInternet Gateway ID023c57b14f11483689338d085e061492
name
optional
stringInternet Gateway NameIGW_VPCname
type
optional
****Internet Gateway Type-
state
optional
stringState-
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName

Responses

NameDescriptionExample
idInternet Gateway ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionInternet Gateway Description
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
loggableNAT LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway NameIGW_VPCname
stateState
typeInternet Gateway Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.50.3 - 1.0

scp-cli vpc internet-gateway list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

Get Internet Gateway list.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringInternet Gateway ID023c57b14f11483689338d085e061492
name
optional
stringInternet Gateway NameIGW_VPCname
type
optional
****Internet Gateway Type-
state
optional
stringState-
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName

Responses

NameDescriptionExample
idInternet Gateway ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionInternet Gateway Description
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
loggableNAT LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway NameIGW_VPCname
stateState
typeInternet Gateway Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.51 - List NAT Gateways

1.51.1 - 1.2

scp-cli vpc nat-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--nat_gateway_ip_address <value>]
[--state <value>]

Description

Get NAT Gateway list.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringNAT Gateway NameNatGatewayName
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
subnet_name
optional
stringSubnet NamesubnetName
nat_gateway_ip_address
optional
stringNAT Gateway IP Address192.167.0.5
state
optional
****NAT Gateway StateACTIVE

Responses

NameDescriptionExample
idNAT Gateway ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway DescriptionVpcEndpoint Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway NameNatGatewayName
nat_gateway_ip_addressNAT Gateway IP Address192.167.0.5
publicip_idPublicIP ID12f56e27070248a6a240a497e43fbe18
stateNAT Gateway StateACTIVE
subnet_cidrSubnet Cidr192.167.1.0/24
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.51.2 - 1.1

scp-cli vpc nat-gateway list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--nat_gateway_ip_address <value>]
[--state <value>]

Description

Get NAT Gateway list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
name
optional
stringNAT Gateway NameNatGatewayName
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
subnet_name
optional
stringSubnet NamesubnetName
nat_gateway_ip_address
optional
stringNAT Gateway IP Address192.167.0.5
state
optional
****NAT Gateway StateACTIVE

Responses

NameDescriptionExample
idNAT Gateway ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway DescriptionVpcEndpoint Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway NameNatGatewayName
nat_gateway_ip_addressNAT Gateway IP Address192.167.0.5
publicip_idPublicIP ID12f56e27070248a6a240a497e43fbe18
stateNAT Gateway StateACTIVE
subnet_cidrSubnet Cidr192.167.1.0/24
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.51.3 - 1.0

scp-cli vpc nat-gateway list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--nat_gateway_ip_address <value>]
[--state <value>]

Description

Get NAT Gateway list.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
name
optional
stringNAT Gateway NameNatGatewayName
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
subnet_name
optional
stringSubnet NamesubnetName
nat_gateway_ip_address
optional
stringNAT Gateway IP Address192.167.0.5
state
optional
****NAT Gateway StateACTIVE

Responses

NameDescriptionExample
idNAT Gateway ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway DescriptionVpcEndpoint Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway NameNatGatewayName
nat_gateway_ip_addressNAT Gateway IP Address192.167.0.5
publicip_idPublicIP ID12f56e27070248a6a240a497e43fbe18
stateNAT Gateway StateACTIVE
subnet_cidrSubnet Cidr192.167.1.0/24
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.52 - List Ports

1.52.1 - 1.2

scp-cli vpc port list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--id <value>]
[--attached_resource_id <value>]
[--fixed_ip_address <value>]
[--mac_address <value>]
[--state <value>]
[--security_groups <value>]
[--attached_resource_types <value>]

Description

Get port list.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerPort Limit-
marker
optional
stringPort Marker-
sort
optional
stringPort Sort-
name
optional
stringPort NameportName
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
subnet_name
optional
stringSubnet NamesubnetName
id
optional
stringPort ID023c57b1-4f11-4836-8933-8d085e061492
attached_resource_id
optional
stringConnected resource ID9387e8f51de04a03994de8a9c3524935
fixed_ip_address
optional
stringFixed IP192.168.1.100
mac_address
optional
stringMAC Addressfa:16:3e:00:00:01
state
optional
stringState-
security_groups
optional
stringSecurity Group List-
attached_resource_types
optional
****Attached Resource Type-

Responses

NameDescriptionExample
idPort ID023c57b1-4f11-4836-8933-8d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idConnected resource ID9387e8f51de04a03994de8a9c3524935
attached_resource_typeConnected resource Type
created_atCreated date
descriptionDescriptionPort Description
fixed_ip_addressFixed IP192.168.1.100
mac_addressMAC Addressfa:16:3e:00:00:01
modified_atModified date
namePort NameportName
stateState
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id071bc63b767444c9afaab1c972d302d5
vpc_nameVPC NamevpcName

1.52.2 - 1.1

scp-cli vpc port list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--id <value>]
[--attached_resource_id <value>]
[--fixed_ip_address <value>]
[--mac_address <value>]
[--state <value>]
[--security_groups <value>]
[--attached_resource_types <value>]

Description

Get port list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerPort Limit-
marker
optional
stringPort Marker-
sort
optional
stringPort Sort-
name
optional
stringPort NameportName
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
subnet_name
optional
stringSubnet NamesubnetName
id
optional
stringPort ID023c57b1-4f11-4836-8933-8d085e061492
attached_resource_id
optional
stringConnected resource ID9387e8f51de04a03994de8a9c3524935
fixed_ip_address
optional
stringFixed IP192.168.1.100
mac_address
optional
stringMAC Addressfa:16:3e:00:00:01
state
optional
stringState-
security_groups
optional
stringSecurity Group List-
attached_resource_types
optional
****Attached Resource Type-

Responses

NameDescriptionExample
idPort ID023c57b1-4f11-4836-8933-8d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idConnected resource ID9387e8f51de04a03994de8a9c3524935
attached_resource_typeConnected resource Type
created_atCreated date
descriptionDescriptionPort Description
fixed_ip_addressFixed IP192.168.1.100
mac_addressMAC Addressfa:16:3e:00:00:01
modified_atModified date
namePort NameportName
stateState
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id071bc63b767444c9afaab1c972d302d5
vpc_nameVPC NamevpcName

1.52.3 - 1.0

scp-cli vpc port list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--name <value>]
[--subnet_id <value>]
[--subnet_name <value>]
[--id <value>]
[--attached_resource_id <value>]
[--fixed_ip_address <value>]
[--mac_address <value>]
[--state <value>]
[--security_groups <value>]
[--attached_resource_types <value>]

Description

Get port list.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerPort Limit-
marker
optional
stringPort Marker-
sort
optional
stringPort Sort-
name
optional
stringPort NameportName
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
subnet_name
optional
stringSubnet NamesubnetName
id
optional
stringPort ID023c57b1-4f11-4836-8933-8d085e061492
attached_resource_id
optional
stringConnected resource ID9387e8f51de04a03994de8a9c3524935
fixed_ip_address
optional
stringFixed IP192.168.1.100
mac_address
optional
stringMAC Addressfa:16:3e:00:00:01
state
optional
stringState-
security_groups
optional
stringSecurity Group List-
attached_resource_types
optional
****Attached Resource Type-

Responses

NameDescriptionExample
idPort ID023c57b1-4f11-4836-8933-8d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idConnected resource ID9387e8f51de04a03994de8a9c3524935
attached_resource_typeConnected resource Type
created_atCreated date
descriptionDescriptionPort Description
fixed_ip_addressFixed IP192.168.1.100
mac_addressMAC Addressfa:16:3e:00:00:01
modified_atModified date
namePort NameportName
stateState
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id071bc63b767444c9afaab1c972d302d5
vpc_nameVPC NamevpcName

1.53 - List Private NAT

1.53.1 - 1.2

scp-cli vpc private-nat list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--cidr <value>]
[--vpc_id <value>]
[--service_resource_id <value>]
[--service_type <value>]
[--service_resource_name <value>]
[--state <value>]

Description

Get Private NAT list.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPrivate NAT NamePrivateNatName
cidr
optional
stringPrivate NAT IP range192.167.0.0/24
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
service_resource_id
optional
stringPrivate NAT connected Service Resource ID3f342bf9a557405b997c2cf48c89cbc2
service_type
optional
****Private NAT connected Service TypeDIRECT_CONNECT
service_resource_name
optional
stringPrivate NAT connected Service Resource NameService Resource Name
state
optional
****Private NAT StateACTIVE

Responses

NameDescriptionExample
idPrivate NAT ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrPrivate NAT IP range192.167.0.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateNat Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT NamePrivateNatName
service_resource_idPrivate NAT connected Service Resource ID3f342bf9a557405b997c2cf48c89cbc2
service_resource_namePrivate NAT connected Service Resource NamePrivateNatName
service_typePrivate NAT connected Service TypeDIRECT_CONNECT
statePrivate NAT StateACTIVE

1.53.2 - 1.1

scp-cli vpc private-nat list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--cidr <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--direct_connect_id <value>]
[--direct_connect_name <value>]
[--state <value>]

Description

Get Private NAT list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPrivate NAT NamePrivateNatName
cidr
optional
stringPrivate NAT IP range192.167.0.0/24
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName
direct_connect_id
optional
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
direct_connect_name
optional
stringDirect Connect NameDirectConnectName
state
optional
****Private NAT StateACTIVE

Responses

NameDescriptionExample
idPrivate NAT ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrPrivate NAT IP range192.167.0.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateNat Description
direct_connect_idDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
direct_connect_nameDirect Connect NameDirectConnectName
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT NamePrivateNatName
statePrivate NAT StateACTIVE
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.53.3 - 1.0

scp-cli vpc private-nat list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--cidr <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--direct_connect_id <value>]
[--direct_connect_name <value>]
[--state <value>]

Description

Get Private NAT list.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPrivate NAT NamePrivateNatName
cidr
optional
stringPrivate NAT IP range192.167.0.0/24
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName
direct_connect_id
optional
stringDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
direct_connect_name
optional
stringDirect Connect NameDirectConnectName
state
optional
****Private NAT StateACTIVE

Responses

NameDescriptionExample
idPrivate NAT ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrPrivate NAT IP range192.167.0.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateNat Description
direct_connect_idDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
direct_connect_nameDirect Connect NameDirectConnectName
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT NamePrivateNatName
statePrivate NAT StateACTIVE
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.54 - List Private NAT IP

1.54.1 - 1.2

scp-cli vpc private-nat-ip list
--private_nat_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]

Description

Get Private NAT IP list.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
ip_address
optional
stringPrivate NAT IP Address-
state
optional
****Private NAT IP State-
attached_resource_type
optional
****Private NAT IP Attached Resource Type-
attached_resource_id
optional
stringPrivate NAT IP Attached Resource ID-
attached_resource_name
optional
stringPrivate NAT IP Attached Resource Name-

Responses

NameDescriptionExample
idPrivate NAT IP ID
attached_resource_idPrivate NAT IP Attached Resource ID
attached_resource_namePrivate NAT IP Attached Resource Name
attached_resource_typePrivate NAT IP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
ip_addressPrivate NAT IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
private_nat_idPrivate NAT ID
statePrivate NAT IP State

1.54.2 - 1.1

scp-cli vpc private-nat-ip list
--private_nat_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]

Description

Get Private NAT IP list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
ip_address
optional
stringPrivate NAT IP Address-
state
optional
****Private NAT IP State-
attached_resource_type
optional
****Private NAT IP Attached Resource Type-
attached_resource_id
optional
stringPrivate NAT IP Attached Resource ID-
attached_resource_name
optional
stringPrivate NAT IP Attached Resource Name-

Responses

NameDescriptionExample
idPrivate NAT IP ID
attached_resource_idPrivate NAT IP Attached Resource ID
attached_resource_namePrivate NAT IP Attached Resource Name
attached_resource_typePrivate NAT IP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
ip_addressPrivate NAT IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
private_nat_idPrivate NAT ID
statePrivate NAT IP State

1.54.3 - 1.0

scp-cli vpc private-nat-ip list
--private_nat_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]

Description

Get Private NAT IP list.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
ip_address
optional
stringPrivate NAT IP Address-
state
optional
****Private NAT IP State-
attached_resource_type
optional
****Private NAT IP Attached Resource Type-
attached_resource_id
optional
stringPrivate NAT IP Attached Resource ID-
attached_resource_name
optional
stringPrivate NAT IP Attached Resource Name-

Responses

NameDescriptionExample
idPrivate NAT IP ID
attached_resource_idPrivate NAT IP Attached Resource ID
attached_resource_namePrivate NAT IP Attached Resource Name
attached_resource_typePrivate NAT IP Attached Resource Type
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
ip_addressPrivate NAT IP Address
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
private_nat_idPrivate NAT ID
statePrivate NAT IP State

1.55 - List PrivateLink Endpoint

1.55.1 - 1.2

scp-cli vpc privatelink-endpoint list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--subnet_id <value>]
[--privatelink_service_id <value>]
[--endpoint_ip_address <value>]
[--state <value>]

Description

Get PrivateLink Endpoint List.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
name
optional
stringPrivateLink Endpoint NameEndpointName
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
privatelink_service_id
optional
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
endpoint_ip_address
optional
stringEndpoint IP Address192.167.1.5
state
optional
****PrivateLink Endpoint StateACTIVE

Responses

NameDescriptionExample
idPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
endpoint_ip_addressEndpoint IP Address192.167.1.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Endpoint NameEndpointName
privatelink_service_idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
statePrivateLink Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

1.55.2 - 1.1

scp-cli vpc privatelink-endpoint list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--subnet_id <value>]
[--privatelink_service_id <value>]
[--endpoint_ip_address <value>]
[--state <value>]

Description

Get PrivateLink Endpoint List.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
name
optional
stringPrivateLink Endpoint NameEndpointName
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
privatelink_service_id
optional
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
endpoint_ip_address
optional
stringEndpoint IP Address192.167.1.5
state
optional
****PrivateLink Endpoint StateACTIVE

Responses

NameDescriptionExample
idPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
endpoint_ip_addressEndpoint IP Address192.167.1.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Endpoint NameEndpointName
privatelink_service_idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
statePrivateLink Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

1.56 - List PrivateLink Service

1.56.1 - 1.2

scp-cli vpc privatelink-service list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--subnet_id <value>]
[--service_ip_address <value>]
[--connected_resource_id <value>]
[--connected_resource_type <value>]
[--connected_resource_name <value>]
[--connected_resource_ip_address <value>]
[--state <value>]

Description

Get PrivateLink Service List.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
name
optional
stringPrivateLink Service NameServiceName
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
service_ip_address
optional
stringService IP Address192.167.0.5
connected_resource_id
optional
stringConnected Resource IDa3e3a662a4f34442a94166df5ff9f577
connected_resource_type
optional
****Connected Resource TypeLB
connected_resource_name
optional
stringConnected Resource NamelbResourceName
connected_resource_ip_address
optional
stringConnected Resource IP Address192.167.0.10
state
optional
****PrivateLink Service StateACTIVE

Responses

NameDescriptionExample
idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
connected_resource_idConnected Resource IDa3e3a662a4f34442a94166df5ff9f577
connected_resource_ip_addressConnected Resource IP Address192.167.0.10
connected_resource_nameConnected Resource NamelbResourceName
connected_resource_typeConnected Resource TypeLB
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Service NameServiceName
service_ip_addressService IP Address192.167.0.5
statePrivateLink Service State
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

1.56.2 - 1.1

scp-cli vpc privatelink-service list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--subnet_id <value>]
[--service_ip_address <value>]
[--connected_resource_id <value>]
[--connected_resource_type <value>]
[--connected_resource_name <value>]
[--connected_resource_ip_address <value>]
[--state <value>]

Description

Get PrivateLink Service List.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
name
optional
stringPrivateLink Service NameServiceName
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
service_ip_address
optional
stringService IP Address192.167.0.5
connected_resource_id
optional
stringConnected Resource IDa3e3a662a4f34442a94166df5ff9f577
connected_resource_type
optional
****Connected Resource TypeLB
connected_resource_name
optional
stringConnected Resource NamelbResourceName
connected_resource_ip_address
optional
stringConnected Resource IP Address192.167.0.10
state
optional
****PrivateLink Service StateACTIVE

Responses

NameDescriptionExample
idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
connected_resource_idConnected Resource IDa3e3a662a4f34442a94166df5ff9f577
connected_resource_ip_addressConnected Resource IP Address192.167.0.10
connected_resource_nameConnected Resource NamelbResourceName
connected_resource_typeConnected Resource TypeLB
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Service NameServiceName
service_ip_addressService IP Address192.167.0.5
statePrivateLink Service State
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

1.57 - List PublicIPs

1.57.1 - 1.2

scp-cli vpc public-ip list
[--size <value>]
[--page <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]
[--vpc_id <value>]
[--type <value>]

Description

Get PublicIP list.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
ip_address
optional
stringIP Address192.167.0.5
state
optional
stringPublicIP StateATTACHED
attached_resource_type
optional
stringPublicIP Attached Resource TypeNAT_GW
attached_resource_id
optional
stringPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_name
optional
stringPublicIP Attached Resource NameAttached NAT Gateway Name
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
type
optional
****PublicIP TypeIGW

Responses

NameDescriptionExample
idPublicIP ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_namePublicIP Attached Resource NameAttached NAT Gateway Name
attached_resource_typePublicIP Attached Resource TypeNAT_GW
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP DescriptionPublic IP Description
ip_addressIP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP StateATTACHED
typePublicIP TypeIGW

1.57.2 - 1.1

scp-cli vpc public-ip list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]
[--vpc_id <value>]
[--type <value>]

Description

Get PublicIP list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
ip_address
optional
stringIP Address192.167.0.5
state
optional
stringPublicIP StateATTACHED
attached_resource_type
optional
stringPublicIP Attached Resource TypeNAT_GW
attached_resource_id
optional
stringPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_name
optional
stringPublicIP Attached Resource NameAttached NAT Gateway Name
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
type
optional
****PublicIP TypeIGW

Responses

NameDescriptionExample
idPublicIP ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_namePublicIP Attached Resource NameAttached NAT Gateway Name
attached_resource_typePublicIP Attached Resource TypeNAT_GW
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP DescriptionPublic IP Description
ip_addressIP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP StateATTACHED
typePublicIP TypeIGW

1.57.3 - 1.0

scp-cli vpc public-ip list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--ip_address <value>]
[--state <value>]
[--attached_resource_type <value>]
[--attached_resource_id <value>]
[--attached_resource_name <value>]
[--vpc_id <value>]
[--type <value>]

Description

Get PublicIP list.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
ip_address
optional
stringIP Address192.167.0.5
state
optional
stringPublicIP StateATTACHED
attached_resource_type
optional
stringPublicIP Attached Resource TypeNAT_GW
attached_resource_id
optional
stringPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_name
optional
stringPublicIP Attached Resource NameAttached NAT Gateway Name
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
type
optional
****PublicIP TypeIGW

Responses

NameDescriptionExample
idPublicIP ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_namePublicIP Attached Resource NameAttached NAT Gateway Name
attached_resource_typePublicIP Attached Resource TypeNAT_GW
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP DescriptionPublic IP Description
ip_addressIP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP StateATTACHED
typePublicIP TypeIGW

1.58 - List Subnet Vips

1.58.1 - 1.2

scp-cli vpc subnet vip list
--subnet_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--virtual_ip_address <value>]
[--public_ip_address <value>]

Description

Get list Subnet Vip

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
virtual_ip_address
optional
stringVirtual IP Address192.168.20.6
public_ip_address
optional
stringPublic IP Address100.112.9.84

Responses

NameDescriptionExample
idSubnet Vip Id0466a9448d9a4411a86055939e451c8f
connected_port_countConnected Port Count2
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateStateACTIVE
static_natStatic NAT Info
virtual_ip_addressVirtual IP Address192.168.20.6

1.59 - List Subnets

1.59.1 - 1.2

scp-cli vpc subnet list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--cidr <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

Get subnet list.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringSubnet Id023c57b14f11483689338d085e061492
name
optional
stringSubnet NamesubnetName
type
optional
****Subnet Type-
cidr
optional
stringSubnet Cidr192.167.1.0/24
state
optional
****State-
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
gateway_ip_addressGateway IP Address192.167.1.1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateState
typeSubnet Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.59.2 - 1.1

scp-cli vpc subnet list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

Get subnet list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringSubnet Id023c57b14f11483689338d085e061492
name
optional
stringSubnet NamesubnetName
type
optional
****Subnet Type-
state
optional
****State-
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
gateway_ip_addressGateway IP Address192.167.1.1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateState
typeSubnet Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.59.3 - 1.0

scp-cli vpc subnet list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--type <value>]
[--state <value>]
[--vpc_id <value>]
[--vpc_name <value>]

Description

Get subnet list.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringSubnet Id023c57b14f11483689338d085e061492
name
optional
stringSubnet NamesubnetName
type
optional
****Subnet Type-
state
optional
****State-
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
gateway_ip_addressGateway IP Address192.167.1.1
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateState
typeSubnet Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.60 - List Transit Gateway Rules

1.60.1 - 1.2

scp-cli vpc transit-gateway-rule list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--tgw_connection_vpc_id <value>]
[--tgw_connection_vpc_name <value>]
[--source_type <value>]
[--destination_type <value>]
[--destination_cidr <value>]
[--state <value>]
[--rule_type <value>]

Description

Get Transit Gateway Rule list.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
tgw_connection_vpc_id
optional
stringVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
tgw_connection_vpc_name
optional
stringVPC Name Connected to Transit Gateway.ConnectedVpcName
source_type
optional
****Source TypeTGW
destination_type
optional
****Destination TypeVPC
destination_cidr
optional
stringDestination CIDR192.167.5.0/24
state
optional
****StateACTIVE
rule_type
optional
****Rule TypeTGW_VPC

Responses

NameDescriptionExample
idRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionRouting Rule Description
destination_cidrDestination CIDR192.167.5.0/24
destination_resource_idDestination Resource IDceb44ea5ecb34a49b16495f9a63b0718
destination_resource_nameDestination Resource NameVpcName
destination_typeDestination TypeVPC
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
rule_typeRule TypeTGW_VPC
source_resource_idSource Resource ID8582cc5d89994a42ad53282fd4a8d8be
source_resource_nameSource Resource NameTgwName
source_typeSource TypeTGW
stateStateACTIVE
tgw_connection_vpc_idVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
tgw_connection_vpc_nameVPC Name Connected to Transit Gateway.ConnectedVpcName

1.60.2 - 1.1

scp-cli vpc transit-gateway-rule list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--tgw_connection_vpc_id <value>]
[--tgw_connection_vpc_name <value>]
[--source_type <value>]
[--destination_type <value>]
[--destination_cidr <value>]
[--state <value>]

Description

Get Transit Gateway Rule list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
tgw_connection_vpc_id
optional
stringVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
tgw_connection_vpc_name
optional
stringVPC Name Connected to Transit Gateway.ConnectedVpcName
source_type
optional
****Source TypeTGW
destination_type
optional
****Destination TypeVPC
destination_cidr
optional
stringDestination CIDR192.167.5.0/24
state
optional
****StateACTIVE

Responses

NameDescriptionExample
idRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionRouting Rule Description
destination_cidrDestination CIDR192.167.5.0/24
destination_resource_idDestination Resource IDceb44ea5ecb34a49b16495f9a63b0718
destination_resource_nameDestination Resource NameVpcName
destination_typeDestination TypeVPC
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
source_resource_idSource Resource ID8582cc5d89994a42ad53282fd4a8d8be
source_resource_nameSource Resource NameTgwName
source_typeSource TypeTGW
stateStateACTIVE
tgw_connection_vpc_idVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
tgw_connection_vpc_nameVPC Name Connected to Transit Gateway.ConnectedVpcName

1.60.3 - 1.0

scp-cli vpc transit-gateway-rule list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--tgw_connection_vpc_id <value>]
[--tgw_connection_vpc_name <value>]
[--source_type <value>]
[--destination_type <value>]
[--destination_cidr <value>]
[--state <value>]

Description

Get Transit Gateway Rule list.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
tgw_connection_vpc_id
optional
stringVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
tgw_connection_vpc_name
optional
stringVPC Name Connected to Transit Gateway.ConnectedVpcName
source_type
optional
****Source TypeTGW
destination_type
optional
****Destination TypeVPC
destination_cidr
optional
stringDestination CIDR192.167.5.0/24
state
optional
****StateACTIVE

Responses

NameDescriptionExample
idRouting Rule ID43772aff4539403d9ba74bf1fdaa00c8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionRouting Rule Description
destination_cidrDestination CIDR192.167.5.0/24
destination_resource_idDestination Resource IDceb44ea5ecb34a49b16495f9a63b0718
destination_resource_nameDestination Resource NameVpcName
destination_typeDestination TypeVPC
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
source_resource_idSource Resource ID8582cc5d89994a42ad53282fd4a8d8be
source_resource_nameSource Resource NameTgwName
source_typeSource TypeTGW
stateStateACTIVE
tgw_connection_vpc_idVPC ID Connected to Transit Gateway.ffeced8e191c478eabd66b6e2cab8e34
tgw_connection_vpc_nameVPC Name Connected to Transit Gateway.ConnectedVpcName

1.61 - List Transit Gateway VPC Connections

1.61.1 - 1.2

scp-cli vpc transit-gateway-vpc-connection list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--state <value>]

Description

Get Transit Gateway VPC Connection list.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName
state
optional
****StateACTIVE

Responses

NameDescriptionExample
idTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateStateACTIVE
transit_gateway_idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.61.2 - 1.1

scp-cli vpc transit-gateway-vpc-connection list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--state <value>]

Description

Get Transit Gateway VPC Connection list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName
state
optional
****StateACTIVE

Responses

NameDescriptionExample
idTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateStateACTIVE
transit_gateway_idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.61.3 - 1.0

scp-cli vpc transit-gateway-vpc-connection list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--state <value>]

Description

Get Transit Gateway VPC Connection list.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName
state
optional
****StateACTIVE

Responses

NameDescriptionExample
idTransit Gateway VPC Connection IDffeced8e191c478eabd66b6e2cab8e34
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateStateACTIVE
transit_gateway_idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.62 - List Transit Gateways

1.62.1 - 1.2

scp-cli vpc transit-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--firewall_connection_state <value>]

Description

Get Transit Gateway list.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
name
optional
stringTransit Gateway NameTransitGatewayName
state
optional
****StateACTIVE
firewall_connection_state
optional
****Firewall Connection StateINACTIVE

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_connection_stateFirewall Connection StateINACTIVE
firewall_idsFirewall ID[‘bbb93aca123f4bb2b2c0f206f4a86b2b’]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

1.62.2 - 1.1

scp-cli vpc transit-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]

Description

Get Transit Gateway list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
name
optional
stringTransit Gateway NameTransitGatewayName
state
optional
****StateACTIVE

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_idsFirewall ID[‘bbb93aca123f4bb2b2c0f206f4a86b2b’]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

1.62.3 - 1.0

scp-cli vpc transit-gateway list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]

Description

Get Transit Gateway list.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
name
optional
stringTransit Gateway NameTransitGatewayName
state
optional
****StateACTIVE

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_idsFirewall ID[‘bbb93aca123f4bb2b2c0f206f4a86b2b’]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

1.63 - List VPC Endpoint

1.63.1 - 1.2

scp-cli vpc vpc-endpoint list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--resource_key <value>]
[--resource_type <value>]
[--endpoint_ip_address <value>]
[--state <value>]

Description

Get VPC Endpoint list.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
name
optional
stringVPC Endpoint NameVpcEndpointName
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
resource_key
optional
stringVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_type
optional
****VPC Endpoint Resource TypeFS
endpoint_ip_address
optional
stringVPC Endpoint IP Address192.167.0.5
state
optional
****VPC Endpoint StateACTIVE

Responses

NameDescriptionExample
idVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionVpcEndpoint Description
endpoint_ip_addressVPC Endpoint IP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint NameVpcEndpointName
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS
stateVPC Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.63.2 - 1.1

scp-cli vpc vpc-endpoint list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--resource_key <value>]
[--resource_type <value>]
[--endpoint_ip_address <value>]
[--state <value>]

Description

Get VPC Endpoint list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
name
optional
stringVPC Endpoint NameVpcEndpointName
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
resource_key
optional
stringVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_type
optional
****VPC Endpoint Resource TypeFS
endpoint_ip_address
optional
stringVPC Endpoint IP Address192.167.0.5
state
optional
****VPC Endpoint StateACTIVE

Responses

NameDescriptionExample
idVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionVpcEndpoint Description
endpoint_ip_addressVPC Endpoint IP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint NameVpcEndpointName
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS
stateVPC Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.63.3 - 1.0

scp-cli vpc vpc-endpoint list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--vpc_id <value>]
[--vpc_name <value>]
[--subnet_id <value>]
[--resource_key <value>]
[--resource_type <value>]
[--endpoint_ip_address <value>]
[--state <value>]

Description

Get VPC Endpoint list.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
name
optional
stringVPC Endpoint NameVpcEndpointName
vpc_id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_name
optional
stringVPC NamevpcName
subnet_id
optional
stringSubnet Id023c57b14f11483689338d085e061492
resource_key
optional
stringVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_type
optional
****VPC Endpoint Resource TypeFS
endpoint_ip_address
optional
stringVPC Endpoint IP Address192.167.0.5
state
optional
****VPC Endpoint StateACTIVE

Responses

NameDescriptionExample
idVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionVpcEndpoint Description
endpoint_ip_addressVPC Endpoint IP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint NameVpcEndpointName
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS
stateVPC Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.64 - List VPC Endpoint Connectable Resources

1.64.1 - 1.2

scp-cli vpc vpc-endpoint-connectable-resource list
--resource_type <value>
[--vpc_id <value>]

Description

List VpcEndpoint connectable resources

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
resource_type
required
****VPC Endpoint Resource TypeFS
vpc_id
optional
stringVPC ID(required if resource_type is DNS)7df8abb4912e4709b1cb237daccca7a8

Responses

NameDescriptionExample
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS

1.64.2 - 1.1

scp-cli vpc vpc-endpoint-connectable-resource list
--resource_type <value>
[--vpc_id <value>]

Description

List VpcEndpoint connectable resources

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
resource_type
required
****VPC Endpoint Resource TypeFS
vpc_id
optional
stringVPC ID(required if resource_type is DNS)7df8abb4912e4709b1cb237daccca7a8

Responses

NameDescriptionExample
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS

1.64.3 - 1.0

scp-cli vpc vpc-endpoint-connectable-resource list
--resource_type <value>
[--vpc_id <value>]

Description

List VpcEndpoint connectable resources

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
resource_type
required
****VPC Endpoint Resource TypeFS
vpc_id
optional
stringVPC ID(required if resource_type is DNS)7df8abb4912e4709b1cb237daccca7a8

Responses

NameDescriptionExample
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS

1.65 - List VPC Peering

1.65.1 - 1.2

scp-cli vpc vpc-peering list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--requester_vpc_id <value>]
[--requester_vpc_name <value>]
[--approver_vpc_id <value>]
[--approver_vpc_name <value>]
[--account_type <value>]
[--state <value>]

Description

Get VPC Peering list.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Peering ID023c57b14f11483689338d085e061492
name
optional
stringVPC Peering NamevpcPeeringName
requester_vpc_id
optional
stringRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_name
optional
stringRequester VPC NamevpcName
approver_vpc_id
optional
stringApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_name
optional
stringApprover VPC NamevpcName
account_type
optional
****Account Type-
state
optional
****State-

Responses

NameDescriptionExample
idVPC Peering ID023c57b14f11483689338d085e061492
account_typeAccount Type
approver_vpc_account_idApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
approver_vpc_idApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_nameApprover VPC NamevpcName
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionVPC Peering DescriptionvpcPeering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering NamevpcPeeringName
requester_vpc_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
requester_vpc_idRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_nameRequester VPC NamevpcName
stateState

1.65.2 - 1.1

scp-cli vpc vpc-peering list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--requester_vpc_id <value>]
[--requester_vpc_name <value>]
[--approver_vpc_id <value>]
[--approver_vpc_name <value>]
[--account_type <value>]
[--state <value>]

Description

Get VPC Peering list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Peering ID023c57b14f11483689338d085e061492
name
optional
stringVPC Peering NamevpcPeeringName
requester_vpc_id
optional
stringRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_name
optional
stringRequester VPC NamevpcName
approver_vpc_id
optional
stringApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_name
optional
stringApprover VPC NamevpcName
account_type
optional
****Account Type-
state
optional
****State-

Responses

NameDescriptionExample
idVPC Peering ID023c57b14f11483689338d085e061492
account_typeAccount Type
approver_vpc_account_idApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
approver_vpc_idApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_nameApprover VPC NamevpcName
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionVPC Peering DescriptionvpcPeering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering NamevpcPeeringName
requester_vpc_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
requester_vpc_idRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_nameRequester VPC NamevpcName
stateState

1.65.3 - 1.0

scp-cli vpc vpc-peering list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--requester_vpc_id <value>]
[--requester_vpc_name <value>]
[--approver_vpc_id <value>]
[--approver_vpc_name <value>]
[--account_type <value>]
[--state <value>]

Description

Get VPC Peering list.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Peering ID023c57b14f11483689338d085e061492
name
optional
stringVPC Peering NamevpcPeeringName
requester_vpc_id
optional
stringRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_name
optional
stringRequester VPC NamevpcName
approver_vpc_id
optional
stringApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_name
optional
stringApprover VPC NamevpcName
account_type
optional
****Account Type-
state
optional
****State-

Responses

NameDescriptionExample
idVPC Peering ID023c57b14f11483689338d085e061492
account_typeAccount Type
approver_vpc_account_idApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
approver_vpc_idApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_nameApprover VPC NamevpcName
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionVPC Peering DescriptionvpcPeering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering NamevpcPeeringName
requester_vpc_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
requester_vpc_idRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_nameRequester VPC NamevpcName
stateState

1.66 - List VPC Peering Rules

1.66.1 - 1.2

scp-cli vpc vpc-peering-routing-rule list
--vpc_peering_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--source_vpc_id <value>]
[--source_vpc_type <value>]
[--destination_vpc_id <value>]
[--destination_vpc_type <value>]
[--destination_cidr <value>]
[--state <value>]

Description

Get VPC Peering Rule list.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Peering Rule ID-
source_vpc_id
optional
stringSource VPC ID-
source_vpc_type
optional
****Source VPC Type-
destination_vpc_id
optional
stringDestination VPC ID-
destination_vpc_type
optional
****Destination VPC Type-
destination_cidr
optional
stringDestination CIDR-
state
optional
****State-

Responses

NameDescriptionExample
idVPC Peering Rule ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
destination_cidrDestination CIDR
destination_vpc_idDestination VPC ID
destination_vpc_nameDestination VPC Name
destination_vpc_typeDestination VPC Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
source_vpc_idSource VPC ID
source_vpc_nameSource VPC Name
source_vpc_typeSource VPC Type
stateState
vpc_peering_idVPC Peering ID

1.66.2 - 1.1

scp-cli vpc vpc-peering-routing-rule list
--vpc_peering_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--source_vpc_id <value>]
[--source_vpc_type <value>]
[--destination_vpc_id <value>]
[--destination_vpc_type <value>]
[--destination_cidr <value>]
[--state <value>]
[--name <value>]

Description

Get VPC Peering Rule list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Peering Rule ID-
source_vpc_id
optional
stringSource VPC ID-
source_vpc_type
optional
****Source VPC Type-
destination_vpc_id
optional
stringDestination VPC ID-
destination_vpc_type
optional
****Destination VPC Type-
destination_cidr
optional
stringDestination CIDR-
state
optional
****State-
name
optional
stringVPC Peering Name-

Responses

NameDescriptionExample
idVPC Peering Rule ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
destination_cidrDestination CIDR
destination_vpc_idDestination VPC ID
destination_vpc_nameDestination VPC Name
destination_vpc_typeDestination VPC Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
source_vpc_idSource VPC ID
source_vpc_nameSource VPC Name
source_vpc_typeSource VPC Type
stateState
vpc_peering_idVPC Peering ID

1.66.3 - 1.0

scp-cli vpc vpc-peering-routing-rule list
--vpc_peering_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--source_vpc_id <value>]
[--source_vpc_type <value>]
[--destination_vpc_id <value>]
[--destination_vpc_type <value>]
[--destination_cidr <value>]
[--state <value>]
[--name <value>]

Description

Get VPC Peering Rule list.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Peering Rule ID-
source_vpc_id
optional
stringSource VPC ID-
source_vpc_type
optional
****Source VPC Type-
destination_vpc_id
optional
stringDestination VPC ID-
destination_vpc_type
optional
****Destination VPC Type-
destination_cidr
optional
stringDestination CIDR-
state
optional
****State-
name
optional
stringVPC Peering Name-

Responses

NameDescriptionExample
idVPC Peering Rule ID
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
destination_cidrDestination CIDR
destination_vpc_idDestination VPC ID
destination_vpc_nameDestination VPC Name
destination_vpc_typeDestination VPC Type
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
source_vpc_idSource VPC ID
source_vpc_nameSource VPC Name
source_vpc_typeSource VPC Type
stateState
vpc_peering_idVPC Peering ID

1.67 - List VPCs

1.67.1 - 1.2

scp-cli vpc vpc list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--cidr <value>]

Description

Get VPC list.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
name
optional
stringVPC NamevpcName
state
optional
****State-
cidr
optional
stringVPC Cidr192.167.0.0/18

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidr_countCidr Count20
cidrs
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState

1.67.2 - 1.1

scp-cli vpc vpc list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--cidr <value>]

Description

Get VPC list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
name
optional
stringVPC NamevpcName
state
optional
****State-
cidr
optional
stringVPC Cidr192.167.0.0/18

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrVPC Cidr192.167.0.0/18
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState

1.67.3 - 1.0

scp-cli vpc vpc list
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--id <value>]
[--name <value>]
[--state <value>]
[--cidr <value>]

Description

Get VPC list.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
id
optional
stringVPC Id7df8abb4912e4709b1cb237daccca7a8
name
optional
stringVPC NamevpcName
state
optional
****State-
cidr
optional
stringVPC Cidr192.167.0.0/18

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrVPC Cidr192.167.0.0/18
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState

1.68 - Request PrivateLink Endpoint

1.68.1 - 1.2

scp-cli vpc privatelink-endpoint request
--privatelink_endpoint_id <value>
--type <value>

Description

Request PrivateLink Endpoint

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
type
required
stringPrivateLink Endpoint Action TypeCANCEL

1.68.2 - 1.1

scp-cli vpc privatelink-endpoint request
--privatelink_endpoint_id <value>
--type <value>

Description

Request PrivateLink Endpoint

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
type
required
stringPrivateLink Endpoint Action TypeCANCEL

1.69 - Set Internet Gateway

1.69.1 - 1.2

scp-cli vpc internet-gateway set
--internet_gateway_id <value>
[--description <value>]
[--loggable <value>]

Description

Set Internet Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID023c57b14f11483689338d085e061492
description
optional
stringDescriptionInternet Gateway Description
loggable
optional
booleanNAT Loggable-

1.69.2 - 1.1

scp-cli vpc internet-gateway set
--internet_gateway_id <value>
[--description <value>]
[--loggable <value>]

Description

Set Internet Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID023c57b14f11483689338d085e061492
description
optional
stringDescriptionInternet Gateway Description
loggable
optional
booleanNAT Loggable-

1.69.3 - 1.0

scp-cli vpc internet-gateway set
--internet_gateway_id <value>
[--description <value>]
[--loggable <value>]

Description

Set Internet Gateway.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID023c57b14f11483689338d085e061492
description
optional
stringDescriptionInternet Gateway Description
loggable
optional
booleanNAT Loggable-

1.70 - Set NAT Gateway

1.70.1 - 1.2

scp-cli vpc nat-gateway set
--nat_gateway_id <value>
[--description <value>]

Description

Set NAT Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID12f56e27070248a6a240a497e43fbe18
description
optional
stringNAT Gateway DescriptionVpcEndpoint Description

1.70.2 - 1.1

scp-cli vpc nat-gateway set
--nat_gateway_id <value>
[--description <value>]

Description

Set NAT Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID12f56e27070248a6a240a497e43fbe18
description
optional
stringNAT Gateway DescriptionVpcEndpoint Description

1.70.3 - 1.0

scp-cli vpc nat-gateway set
--nat_gateway_id <value>
[--description <value>]

Description

Set NAT Gateway.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID12f56e27070248a6a240a497e43fbe18
description
optional
stringNAT Gateway DescriptionVpcEndpoint Description

1.71 - Set Port

1.71.1 - 1.2

scp-cli vpc port set
--port_id <value>
[--description <value>]
[--security_groups <value>]

Description

Set port.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID023c57b1-4f11-4836-8933-8d085e061492
description
optional
stringDescriptionPort Description
security_groups
optional
arraySecurity Group List-

1.71.2 - 1.1

scp-cli vpc port set
--port_id <value>
[--description <value>]
[--security_groups <value>]

Description

Set port.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID023c57b1-4f11-4836-8933-8d085e061492
description
optional
stringDescriptionPort Description
security_groups
optional
arraySecurity Group List-

1.71.3 - 1.0

scp-cli vpc port set
--port_id <value>
[--description <value>]
[--security_groups <value>]

Description

Set port.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID023c57b1-4f11-4836-8933-8d085e061492
description
optional
stringDescriptionPort Description
security_groups
optional
arraySecurity Group List-

1.72 - Set Private NAT

1.72.1 - 1.2

scp-cli vpc private-nat set
--private_nat_id <value>
[--description <value>]

Description

Set Private NAT.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18
description
optional
stringDescriptionPrivateNat Description

1.72.2 - 1.1

scp-cli vpc private-nat set
--private_nat_id <value>
[--description <value>]

Description

Set Private NAT.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18
description
optional
stringDescriptionPrivateNat Description

1.72.3 - 1.0

scp-cli vpc private-nat set
--private_nat_id <value>
[--description <value>]

Description

Set Private NAT.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18
description
optional
stringDescriptionPrivateNat Description

1.73 - Set PrivateLink Endpoint

1.73.1 - 1.2

scp-cli vpc privatelink-endpoint set
--privatelink_endpoint_id <value>
[--description <value>]

Description

Set PrivateLink Endpoint.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
description
optional
stringDescriptionPrivateLink Endpoint Description

1.73.2 - 1.1

scp-cli vpc privatelink-endpoint set
--privatelink_endpoint_id <value>
[--description <value>]

Description

Set PrivateLink Endpoint.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
description
optional
stringDescriptionPrivateLink Endpoint Description

1.74 - Set PrivateLink Service

1.74.1 - 1.2

scp-cli vpc privatelink-service set
--privatelink_service_id <value>
[--description <value>]

Description

Set PrivateLink Service.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
description
optional
stringDescriptionPrivateLink Service Description

1.74.2 - 1.1

scp-cli vpc privatelink-service set
--privatelink_service_id <value>
[--description <value>]

Description

Set PrivateLink Service.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
description
optional
stringDescriptionPrivateLink Service Description

1.75 - Set PublicIP

1.75.1 - 1.2

scp-cli vpc public-ip set
--publicip_id <value>
--description <value>

Description

Set PublicIP.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18
description
required
stringPublicIP DescriptionPublic IP Description

1.75.2 - 1.1

scp-cli vpc public-ip set
--publicip_id <value>
--description <value>

Description

Set PublicIP.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18
description
required
stringPublicIP DescriptionPublic IP Description

1.75.3 - 1.0

scp-cli vpc public-ip set
--publicip_id <value>
--description <value>

Description

Set PublicIP.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18
description
required
stringPublicIP DescriptionPublic IP Description

1.76 - Set Subnet

1.76.1 - 1.2

scp-cli vpc subnet set
--subnet_id <value>
[--description <value>]
[--dhcp_ip_address <value>]

Description

Set subnet.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
description
optional
stringDescriptionSubnet Description
dhcp_ip_address
optional
stringDHCP IP Address-

1.76.2 - 1.1

scp-cli vpc subnet set
--subnet_id <value>
--description <value>

Description

Set subnet.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
description
required
stringDescriptionSubnet Description

1.76.3 - 1.0

scp-cli vpc subnet set
--subnet_id <value>
--description <value>

Description

Set subnet.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492
description
required
stringDescriptionSubnet Description

1.77 - Set Subnet Vip

1.77.1 - 1.2

scp-cli vpc subnet vip set
--vip_id <value>
--subnet_id <value>
--description <value>

Description

Set Subnet Vip

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vip_id
required
stringSubnet Vip Id0466a9448d9a4411a86055939e451c8f
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492
description
required
stringDescriptionSubnet VIP Description

1.78 - Set Transit Gateway

1.78.1 - 1.2

scp-cli vpc transit-gateway set
--transit_gateway_id <value>
[--description <value>]

Description

Set Transit Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
description
optional
stringDescriptionTransitGateway Description

1.78.2 - 1.1

scp-cli vpc transit-gateway set
--transit_gateway_id <value>
[--description <value>]

Description

Set Transit Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
description
optional
stringDescriptionTransitGateway Description

1.78.3 - 1.0

scp-cli vpc transit-gateway set
--transit_gateway_id <value>
[--description <value>]

Description

Set Transit Gateway.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
description
optional
stringDescriptionTransitGateway Description

1.79 - Set VPC

1.79.1 - 1.2

scp-cli vpc vpc set
--vpc_id <value>
[--description <value>]

Description

Set VPC.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-
description
optional
stringDescriptionvpcDescription

1.79.2 - 1.1

scp-cli vpc vpc set
--vpc_id <value>
[--description <value>]

Description

Set VPC.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-
description
optional
stringDescriptionvpcDescription

1.79.3 - 1.0

scp-cli vpc vpc set
--vpc_id <value>
[--description <value>]

Description

Set VPC.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-
description
optional
stringDescriptionvpcDescription

1.80 - Set VPC Endpoint

1.80.1 - 1.2

scp-cli vpc vpc-endpoint set
--vpc_endpoint_id <value>
[--description <value>]

Description

Set VPC Endpoint.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
description
optional
stringDescriptionVpcEndpoint Description

1.80.2 - 1.1

scp-cli vpc vpc-endpoint set
--vpc_endpoint_id <value>
[--description <value>]

Description

Set VPC Endpoint.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
description
optional
stringDescriptionVpcEndpoint Description

1.80.3 - 1.0

scp-cli vpc vpc-endpoint set
--vpc_endpoint_id <value>
[--description <value>]

Description

Set VPC Endpoint.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
description
optional
stringDescriptionVpcEndpoint Description

1.81 - Set VPC Peering

1.81.1 - 1.2

scp-cli vpc vpc-peering set
--vpc_peering_id <value>
[--description <value>]

Description

Set VPC Peering.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
description
optional
stringDescriptionvpcPeering Description

1.81.2 - 1.1

scp-cli vpc vpc-peering set
--vpc_peering_id <value>
[--description <value>]

Description

Set VPC Peering.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
description
optional
stringDescriptionvpcPeering Description

1.81.3 - 1.0

scp-cli vpc vpc-peering set
--vpc_peering_id <value>
[--description <value>]

Description

Set VPC Peering.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492
description
optional
stringDescriptionvpcPeering Description

1.82 - Show Internet Gateway

1.82.1 - 1.2

scp-cli vpc internet-gateway show
--internet_gateway_id <value>

Description

Show Internet Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idInternet Gateway ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionInternet Gateway Description
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
loggableNAT LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway NameIGW_VPCname
stateState
typeInternet Gateway Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.82.2 - 1.1

scp-cli vpc internet-gateway show
--internet_gateway_id <value>

Description

Show Internet Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idInternet Gateway ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionInternet Gateway Description
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
loggableNAT LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway NameIGW_VPCname
stateState
typeInternet Gateway Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.82.3 - 1.0

scp-cli vpc internet-gateway show
--internet_gateway_id <value>

Description

Show Internet Gateway.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
internet_gateway_id
required
stringInternet Gateway ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idInternet Gateway ID023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionInternet Gateway Description
firewall_idFirewall IDb156740b6335468d8354eb9ef8eddf5a
loggableNAT LoggableFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameInternet Gateway NameIGW_VPCname
stateState
typeInternet Gateway Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.83 - Show NAT Gateway

1.83.1 - 1.2

scp-cli vpc nat-gateway show
--nat_gateway_id <value>

Description

Show NAT Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idNAT Gateway ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway DescriptionVpcEndpoint Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway NameNatGatewayName
nat_gateway_ip_addressNAT Gateway IP Address192.167.0.5
publicip_idPublicIP ID12f56e27070248a6a240a497e43fbe18
stateNAT Gateway StateACTIVE
subnet_cidrSubnet Cidr192.167.1.0/24
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.83.2 - 1.1

scp-cli vpc nat-gateway show
--nat_gateway_id <value>

Description

Show NAT Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idNAT Gateway ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway DescriptionVpcEndpoint Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway NameNatGatewayName
nat_gateway_ip_addressNAT Gateway IP Address192.167.0.5
publicip_idPublicIP ID12f56e27070248a6a240a497e43fbe18
stateNAT Gateway StateACTIVE
subnet_cidrSubnet Cidr192.167.1.0/24
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.83.3 - 1.0

scp-cli vpc nat-gateway show
--nat_gateway_id <value>

Description

Show NAT Gateway.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
nat_gateway_id
required
stringNAT Gateway ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idNAT Gateway ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionNAT Gateway DescriptionVpcEndpoint Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameNAT Gateway NameNatGatewayName
nat_gateway_ip_addressNAT Gateway IP Address192.167.0.5
publicip_idPublicIP ID12f56e27070248a6a240a497e43fbe18
stateNAT Gateway StateACTIVE
subnet_cidrSubnet Cidr192.167.1.0/24
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.84 - Show Port

1.84.1 - 1.2

scp-cli vpc port show
--port_id <value>

Description

Show port.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID023c57b1-4f11-4836-8933-8d085e061492

Responses

NameDescriptionExample
idPort ID023c57b1-4f11-4836-8933-8d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idConnected resource ID9387e8f51de04a03994de8a9c3524935
attached_resource_typeConnected resource Type
created_atCreated date
descriptionDescriptionPort Description
fixed_ip_addressFixed IP192.168.1.100
mac_addressMAC Addressfa:16:3e:00:00:01
modified_atModified date
namePort NameportName
security_groupsSecurity Group List
stateState
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
virtual_ip_addressesVirtual IP Address
vpc_idVPC Id071bc63b767444c9afaab1c972d302d5
vpc_nameVPC NamevpcName

1.84.2 - 1.1

scp-cli vpc port show
--port_id <value>

Description

Show port.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID023c57b1-4f11-4836-8933-8d085e061492

Responses

NameDescriptionExample
idPort ID023c57b1-4f11-4836-8933-8d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idConnected resource ID9387e8f51de04a03994de8a9c3524935
attached_resource_typeConnected resource Type
created_atCreated date
descriptionDescriptionPort Description
fixed_ip_addressFixed IP192.168.1.100
mac_addressMAC Addressfa:16:3e:00:00:01
modified_atModified date
namePort NameportName
security_groupsSecurity Group List
stateState
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id071bc63b767444c9afaab1c972d302d5
vpc_nameVPC NamevpcName

1.84.3 - 1.0

scp-cli vpc port show
--port_id <value>

Description

Show port.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
port_id
required
stringPort ID023c57b1-4f11-4836-8933-8d085e061492

Responses

NameDescriptionExample
idPort ID023c57b1-4f11-4836-8933-8d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idConnected resource ID9387e8f51de04a03994de8a9c3524935
attached_resource_typeConnected resource Type
created_atCreated date
descriptionDescriptionPort Description
fixed_ip_addressFixed IP192.168.1.100
mac_addressMAC Addressfa:16:3e:00:00:01
modified_atModified date
namePort NameportName
security_groupsSecurity Group List
stateState
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id071bc63b767444c9afaab1c972d302d5
vpc_nameVPC NamevpcName

1.85 - Show Private NAT

1.85.1 - 1.2

scp-cli vpc private-nat show
--private_nat_id <value>

Description

Show Private NAT.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idPrivate NAT ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrPrivate NAT IP range192.167.0.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateNat Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT NamePrivateNatName
service_resource_idPrivate NAT connected Service Resource ID3f342bf9a557405b997c2cf48c89cbc2
service_resource_namePrivate NAT connected Service Resource NamePrivateNatName
service_typePrivate NAT connected Service TypeDIRECT_CONNECT
statePrivate NAT StateACTIVE

1.85.2 - 1.1

scp-cli vpc private-nat show
--private_nat_id <value>

Description

Show Private NAT.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idPrivate NAT ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrPrivate NAT IP range192.167.0.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateNat Description
direct_connect_idDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
direct_connect_nameDirect Connect NameDirectConnectName
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT NamePrivateNatName
statePrivate NAT StateACTIVE
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.85.3 - 1.0

scp-cli vpc private-nat show
--private_nat_id <value>

Description

Show Private NAT.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
private_nat_id
required
stringPrivate NAT ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idPrivate NAT ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrPrivate NAT IP range192.167.0.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateNat Description
direct_connect_idDirect Connect IDfe860e0af0c04dcd8182b84f907f31f4
direct_connect_nameDirect Connect NameDirectConnectName
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivate NAT NamePrivateNatName
statePrivate NAT StateACTIVE
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.86 - Show PrivateLink Endpoint

1.86.1 - 1.2

scp-cli vpc privatelink-endpoint show
--privatelink_endpoint_id <value>

Description

Show PrivateLink Endpoint.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02

Responses

NameDescriptionExample
idPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateLink Endpoint Description
endpoint_ip_addressEndpoint IP Address192.167.1.5
endpoint_ip_port_idEndpoint IP Port IDb44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Endpoint NameEndpointName
privatelink_service_idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
security_group_idsSecurity Group List[‘17776b52-0a64-440d-9e93-b4fc37be935b’]
statePrivateLink Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

1.86.2 - 1.1

scp-cli vpc privatelink-endpoint show
--privatelink_endpoint_id <value>

Description

Show PrivateLink Endpoint.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02

Responses

NameDescriptionExample
idPrivateLink Endpoint IDbba6d4de3ad64e41b3a1b6c88983ec02
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateLink Endpoint Description
endpoint_ip_addressEndpoint IP Address192.167.1.5
endpoint_ip_port_idEndpoint IP Port IDb44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Endpoint NameEndpointName
privatelink_service_idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
security_group_idsSecurity Group List[‘17776b52-0a64-440d-9e93-b4fc37be935b’]
statePrivateLink Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

1.87 - Show PrivateLink Service

1.87.1 - 1.2

scp-cli vpc privatelink-service show
--privatelink_service_id <value>

Description

Show PrivateLink Service.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d

Responses

NameDescriptionExample
idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
connected_resource_idConnected Resource IDa3e3a662a4f34442a94166df5ff9f577
connected_resource_ip_addressConnected Resource IP Address192.167.0.10
connected_resource_nameConnected Resource NamelbResourceName
connected_resource_typeConnected Resource TypeLB
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateLink Service Description
high_speed_transferHigh Speed Data Transfer UseFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Service NameServiceName
security_group_idsSecurity Group List[‘00b6af37-73b5-4de2-b080-c295a1a0382e’]
service_ip_addressService IP Address192.167.0.5
service_ip_port_idService IP Port IDd21a4b81-f52a-43a8-b985-341e763458bb
statePrivateLink Service State
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

1.87.2 - 1.1

scp-cli vpc privatelink-service show
--privatelink_service_id <value>

Description

Show PrivateLink Service.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d

Responses

NameDescriptionExample
idPrivateLink Service IDe3df2e8e3b374fbb81d4e322b52ca50d
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
approval_typePrivateLink Service Approval TypeAUTO
connected_resource_idConnected Resource IDa3e3a662a4f34442a94166df5ff9f577
connected_resource_ip_addressConnected Resource IP Address192.167.0.10
connected_resource_nameConnected Resource NamelbResourceName
connected_resource_typeConnected Resource TypeLB
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionPrivateLink Service Description
high_speed_transferHigh Speed Data Transfer UseFalse
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
namePrivateLink Service NameServiceName
security_group_idsSecurity Group List[‘00b6af37-73b5-4de2-b080-c295a1a0382e’]
service_ip_addressService IP Address192.167.0.5
service_ip_port_idService IP Port IDd21a4b81-f52a-43a8-b985-341e763458bb
statePrivateLink Service State
subnet_idSubnet Id023c57b14f11483689338d085e061492
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8

1.88 - Show PublicIP

1.88.1 - 1.2

scp-cli vpc public-ip show
--publicip_id <value>

Description

Show PublicIP.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idPublicIP ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_namePublicIP Attached Resource NameAttached NAT Gateway Name
attached_resource_typePublicIP Attached Resource TypeNAT_GW
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP DescriptionPublic IP Description
ip_addressIP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP StateATTACHED
typePublicIP TypeIGW

1.88.2 - 1.1

scp-cli vpc public-ip show
--publicip_id <value>

Description

Show PublicIP.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idPublicIP ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_namePublicIP Attached Resource NameAttached NAT Gateway Name
attached_resource_typePublicIP Attached Resource TypeNAT_GW
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP DescriptionPublic IP Description
ip_addressIP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP StateATTACHED
typePublicIP TypeIGW

1.88.3 - 1.0

scp-cli vpc public-ip show
--publicip_id <value>

Description

Show PublicIP.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
publicip_id
required
stringPublicIP ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idPublicIP ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
attached_resource_idPublicIP Attached Resource ID37e6db41f5124184a43251a63124cdc9
attached_resource_namePublicIP Attached Resource NameAttached NAT Gateway Name
attached_resource_typePublicIP Attached Resource TypeNAT_GW
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionPublicIP DescriptionPublic IP Description
ip_addressIP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
statePublicIP StateATTACHED
typePublicIP TypeIGW

1.89 - Show Subnet

1.89.1 - 1.2

scp-cli vpc subnet show
--subnet_id <value>

Description

Show subnet.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
allocation_poolsAllocation Pools
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionSubnet Description
dhcp_ip_addressDHCP IP Address
dns_nameserversDNS Name Servers
gateway_ip_addressGateway IP Address192.167.1.1
host_routesHost Routes
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateState
typeSubnet Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.89.2 - 1.1

scp-cli vpc subnet show
--subnet_id <value>

Description

Show subnet.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
allocation_poolsAllocation Pools
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionSubnet Description
dns_nameserversDNS Name Servers
gateway_ip_addressGateway IP Address192.167.1.1
host_routesHost Routes
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateState
typeSubnet Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.89.3 - 1.0

scp-cli vpc subnet show
--subnet_id <value>

Description

Show subnet.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
subnet_id
required
stringSubnet Id023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idSubnet Id023c57b14f11483689338d085e061492
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
allocation_poolsAllocation Pools
cidrSubnet Cidr192.167.1.0/24
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionSubnet Description
dns_nameserversDNS Name Servers
gateway_ip_addressGateway IP Address192.167.1.1
host_routesHost Routes
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameSubnet NamesubnetName
stateState
typeSubnet Type
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.90 - Show Subnet Vip

1.90.1 - 1.2

scp-cli vpc subnet vip show
--vip_id <value>
--subnet_id <value>

Description

Show Subnet Vip

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vip_id
required
stringSubnet Vip Id0466a9448d9a4411a86055939e451c8f
subnet_id
required
stringSubnet ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idSubnet Vip Id0466a9448d9a4411a86055939e451c8f
connected_ports
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionSubnet VIP Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
stateStateACTIVE
static_natStatic NAT Info
subnet_idSubnet ID023c57b14f11483689338d085e061492
vip_port_idVip Port Id35268a9f2eda4cde83b1d85c1f61f67d
virtual_ip_addressVirtual IP Address192.168.20.6

1.91 - Show Transit Gateway

1.91.1 - 1.2

scp-cli vpc transit-gateway show
--transit_gateway_id <value>

Description

Show Transit Gateway.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_connection_stateFirewall Connection StateINACTIVE
firewall_idsFirewall ID[‘bbb93aca123f4bb2b2c0f206f4a86b2b’]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

1.91.2 - 1.1

scp-cli vpc transit-gateway show
--transit_gateway_id <value>

Description

Show Transit Gateway.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_idsFirewall ID[‘bbb93aca123f4bb2b2c0f206f4a86b2b’]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

1.91.3 - 1.0

scp-cli vpc transit-gateway show
--transit_gateway_id <value>

Description

Show Transit Gateway.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
transit_gateway_id
required
stringTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_idsFirewall ID[‘bbb93aca123f4bb2b2c0f206f4a86b2b’]
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

1.92 - Show VPC

1.92.1 - 1.2

scp-cli vpc vpc show
--vpc_id <value>

Description

Show VPC.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidr_countCidr Count20
cidrs
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState

1.92.2 - 1.1

scp-cli vpc vpc show
--vpc_id <value>

Description

Show VPC.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrVPC Cidr192.167.0.0/18
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState

1.92.3 - 1.0

scp-cli vpc vpc show
--vpc_id <value>

Description

Show VPC.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
vpc_id
required
stringVPC Id-

Responses

NameDescriptionExample
idVPC Id7df8abb4912e4709b1cb237daccca7a8
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
cidrVPC Cidr192.167.0.0/18
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionvpcDescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC NamevpcName
stateState

1.93 - Show VPC Endpoint

1.93.1 - 1.2

scp-cli vpc vpc-endpoint show
--vpc_endpoint_id <value>

Description

Show VPC Endpoint.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionVpcEndpoint Description
endpoint_ip_addressVPC Endpoint IP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint NameVpcEndpointName
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS
stateVPC Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.93.2 - 1.1

scp-cli vpc vpc-endpoint show
--vpc_endpoint_id <value>

Description

Show VPC Endpoint.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionVpcEndpoint Description
endpoint_ip_addressVPC Endpoint IP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint NameVpcEndpointName
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS
stateVPC Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.93.3 - 1.0

scp-cli vpc vpc-endpoint show
--vpc_endpoint_id <value>

Description

Show VPC Endpoint.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
vpc_endpoint_id
required
stringVPC Endpoint ID12f56e27070248a6a240a497e43fbe18

Responses

NameDescriptionExample
idVPC Endpoint ID12f56e27070248a6a240a497e43fbe18
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionDescriptionVpcEndpoint Description
endpoint_ip_addressVPC Endpoint IP Address192.167.0.5
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Endpoint NameVpcEndpointName
resource_infoVPC Endpoint Resource Key Infox.samsungsdscloud.com(Registry)
resource_keyVPC Endpoint Resource Key07c5364702384471b650147321b52173
resource_typeVPC Endpoint Resource TypeFS
stateVPC Endpoint StateACTIVE
subnet_idSubnet Id023c57b14f11483689338d085e061492
subnet_nameSubnet NamesubnetName
vpc_idVPC Id7df8abb4912e4709b1cb237daccca7a8
vpc_nameVPC NamevpcName

1.94 - Show VPC Peering

1.94.1 - 1.2

scp-cli vpc vpc-peering show
--vpc_peering_id <value>

Description

Show VPC Peering.

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idVPC Peering ID023c57b14f11483689338d085e061492
account_typeAccount Type
approver_vpc_account_idApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
approver_vpc_idApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_nameApprover VPC NamevpcName
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionVPC Peering DescriptionvpcPeering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering NamevpcPeeringName
requester_vpc_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
requester_vpc_idRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_nameRequester VPC NamevpcName
stateState

1.94.2 - 1.1

scp-cli vpc vpc-peering show
--vpc_peering_id <value>

Description

Show VPC Peering.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idVPC Peering ID023c57b14f11483689338d085e061492
account_typeAccount Type
approver_vpc_account_idApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
approver_vpc_idApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_nameApprover VPC NamevpcName
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionVPC Peering DescriptionvpcPeering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering NamevpcPeeringName
requester_vpc_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
requester_vpc_idRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_nameRequester VPC NamevpcName
stateState

1.94.3 - 1.0

scp-cli vpc vpc-peering show
--vpc_peering_id <value>

Description

Show VPC Peering.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
vpc_peering_id
required
stringVPC Peering ID023c57b14f11483689338d085e061492

Responses

NameDescriptionExample
idVPC Peering ID023c57b14f11483689338d085e061492
account_typeAccount Type
approver_vpc_account_idApprover VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
approver_vpc_idApprover VPC ID7df8abb4912e4709b1cb237daccca7a8
approver_vpc_nameApprover VPC NamevpcName
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
descriptionVPC Peering DescriptionvpcPeering Description
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameVPC Peering NamevpcPeeringName
requester_vpc_account_idRequester VPC Account IDf1e6c81a2b054582878cb9724dc2ce9f
requester_vpc_idRequester VPC ID7df8abb4912e4709b1cb237daccca7a8
requester_vpc_nameRequester VPC NamevpcName
stateState