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

Return to the regular view of this page.

VPC

1: CLIs

1.1: Approval VPC Peering

1.1.1: 1.1

1.2: Approve PrivateLink Endpoint

1.2.1: 1.1

1.3: Connect PrivateLink Endpoint

1.3.1: 1.1

1.4: Create Internet Gateway

1.4.1: 1.1
1.4.2: 1.0

1.5: Create NAT Gateway

1.5.1: 1.1
1.5.2: 1.0

1.6: Create Port

1.6.1: 1.1
1.6.2: 1.0

1.7: Create Private NAT

1.7.1: 1.1
1.7.2: 1.0

1.8: Create Private NAT IP

1.8.1: 1.1
1.8.2: 1.0

1.9: Create PrivateLink Endpoint

1.9.1: 1.1

1.10: Create PrivateLink Service

1.10.1: 1.1

1.11: Create PublicIP

1.11.1: 1.1
1.11.2: 1.0

1.12: Create Subnet

1.12.1: 1.1
1.12.2: 1.0

1.13: Create Transit Gateway

1.13.1: 1.1
1.13.2: 1.0

1.14: Create Transit Gateway Rule

1.14.1: 1.1
1.14.2: 1.0

1.15: Create Transit Gateway VPC Connection

1.15.1: 1.1
1.15.2: 1.0

1.16: Create VPC

1.16.1: 1.1
1.16.2: 1.0

1.17: Create VPC Endpoint

1.17.1: 1.1
1.17.2: 1.0

1.18: Create VPC Peering

1.18.1: 1.1
1.18.2: 1.0

1.19: Create Vpc Peering Rule

1.19.1: 1.1
1.19.2: 1.0

1.20: Delete Internet Gateway

1.20.1: 1.1
1.20.2: 1.0

1.21: Delete NAT Gateway

1.21.1: 1.1
1.21.2: 1.0

1.22: Delete Port

1.22.1: 1.1
1.22.2: 1.0

1.23: Delete Private NAT

1.23.1: 1.1
1.23.2: 1.0

1.24: Delete Private NAT IP

1.24.1: 1.1
1.24.2: 1.0

1.25: Delete PrivateLink Endpoint

1.25.1: 1.1

1.26: Delete PrivateLink Service

1.26.1: 1.1

1.27: Delete PublicIP

1.27.1: 1.1
1.27.2: 1.0

1.28: Delete Subnet

1.28.1: 1.1
1.28.2: 1.0

1.29: Delete Transit Gateway

1.29.1: 1.1
1.29.2: 1.0

1.30: Delete Transit Gateway Rule

1.30.1: 1.1
1.30.2: 1.0

1.31: Delete Transit Gateway VPC Connection

1.31.1: 1.1
1.31.2: 1.0

1.32: Delete VPC

1.32.1: 1.1
1.32.2: 1.0

1.33: Delete VPC Endpoint

1.33.1: 1.1
1.33.2: 1.0

1.34: Delete VPC Peering

1.34.1: 1.1
1.34.2: 1.0

1.35: Delete VPC Peering Rule

1.35.1: 1.1
1.35.2: 1.0

1.36: List Connected PrivateLink Endpoints

1.36.1: 1.1

1.37: List Internet Gateways

1.37.1: 1.1
1.37.2: 1.0

1.38: List NAT Gateways

1.38.1: 1.1
1.38.2: 1.0

1.39: List Ports

1.39.1: 1.1
1.39.2: 1.0

1.40: List Private NAT

1.40.1: 1.1
1.40.2: 1.0

1.41: List Private NAT IP

1.41.1: 1.1
1.41.2: 1.0

1.42: List PrivateLink Endpoint

1.42.1: 1.1

1.43: List PrivateLink Service

1.43.1: 1.1

1.44: List PublicIPs

1.44.1: 1.1
1.44.2: 1.0

1.45: List Subnets

1.45.1: 1.1
1.45.2: 1.0

1.46: List Transit Gateway Rules

1.46.1: 1.1
1.46.2: 1.0

1.47: List Transit Gateway VPC Connections

1.47.1: 1.1
1.47.2: 1.0

1.48: List Transit Gateways

1.48.1: 1.1
1.48.2: 1.0

1.49: List VPC Endpoint

1.49.1: 1.1
1.49.2: 1.0

1.50: List VPC Endpoint Connectable Resources

1.50.1: 1.1
1.50.2: 1.0

1.51: List VPC Peering

1.51.1: 1.1
1.51.2: 1.0

1.52: List VPC Peering Rules

1.52.1: 1.1
1.52.2: 1.0

1.53: List VPCs

1.53.1: 1.1
1.53.2: 1.0

1.54: Request PrivateLink Endpoint

1.54.1: 1.1

1.55: Set Internet Gateway

1.55.1: 1.1
1.55.2: 1.0

1.56: Set NAT Gateway

1.56.1: 1.1
1.56.2: 1.0

1.57: Set Port

1.57.1: 1.1
1.57.2: 1.0

1.58: Set Private NAT

1.58.1: 1.1
1.58.2: 1.0

1.59: Set PrivateLink Endpoint

1.59.1: 1.1

1.60: Set PrivateLink Service

1.60.1: 1.1

1.61: Set PublicIP

1.61.1: 1.1
1.61.2: 1.0

1.62: Set Subnet

1.62.1: 1.1
1.62.2: 1.0

1.63: Set Transit Gateway

1.63.1: 1.1
1.63.2: 1.0

1.64: Set VPC

1.64.1: 1.1
1.64.2: 1.0

1.65: Set VPC Endpoint

1.65.1: 1.1
1.65.2: 1.0

1.66: Set VPC Peering

1.66.1: 1.1
1.66.2: 1.0

1.67: Show Internet Gateway

1.67.1: 1.1
1.67.2: 1.0

1.68: Show NAT Gateway

1.68.1: 1.1
1.68.2: 1.0

1.69: Show Port

1.69.1: 1.1
1.69.2: 1.0

1.70: Show Private NAT

1.70.1: 1.1
1.70.2: 1.0

1.71: Show PrivateLink Endpoint

1.71.1: 1.1

1.72: Show PrivateLink Service

1.72.1: 1.1

1.73: Show PublicIP

1.73.1: 1.1
1.73.2: 1.0

1.74: Show Subnet

1.74.1: 1.1
1.74.2: 1.0

1.75: Show Transit Gateway

1.75.1: 1.1
1.75.2: 1.0

1.76: Show VPC

1.76.1: 1.1
1.76.2: 1.0

1.77: Show VPC Endpoint

1.77.1: 1.1
1.77.2: 1.0

1.78: Show VPC Peering

1.78.1: 1.1
1.78.2: 1.0

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

Version	Status	Supported Until
1.0	DEPRECATED	20251231
1.1	CURRENT	-

1 - CLIs

1.1 - Approval VPC Peering

1.1.1 - 1.1

scpcli vpc vpc-peering approval
--vpc_peering_id <value>
--type <value>

Description

Approval VPC Peering.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
vpc_peering_id required	string	VPC Peering ID	-
type required	string	Approval Type	-

1.2 - Approve PrivateLink Endpoint

1.2.1 - 1.1

scpcli vpc privatelink-endpoint approve
--privatelink_endpoint_id <value>
--type <value>

Description

Approve PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
privatelink_endpoint_id required	string	PrivateLink Endpoint ID	-
type required	string	PrivateLink Endpoint Action Type	-

1.3 - Connect PrivateLink Endpoint

1.3.1 - 1.1

scpcli vpc privatelink-endpoint connect
--privatelink_endpoint_id <value>
--type <value>

Description

Connect PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
privatelink_endpoint_id required	string	PrivateLink Endpoint ID	-
type required	string	PrivateLink Endpoint Action Type	-

1.4 - Create Internet Gateway

1.4.1 - 1.1

scpcli 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)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
vpc_id required	string	VPC Id	-
type required	string	Internet Gateway Type	-
description optional	string	Description	-
firewall_enabled optional	boolean	Firewall Enable	-
firewall_loggable optional	boolean	Firewall Loggable	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	Internet Gateway ID
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description
firewall_id	Firewall ID
loggable	NAT Loggable
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Internet Gateway Name
state	State
type	Internet Gateway Type
vpc_id	VPC Id
vpc_name	VPC Name

1.4.2 - 1.0

scpcli 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)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
vpc_id required	string	VPC Id	-
type required	string	Internet Gateway Type	-
description optional	string	Description	-
firewall_enabled optional	boolean	Firewall Enable	-
firewall_loggable optional	boolean	Firewall Loggable	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	Internet Gateway ID
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description
firewall_id	Firewall ID
loggable	NAT Loggable
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Internet Gateway Name
state	State
type	Internet Gateway Type
vpc_id	VPC Id
vpc_name	VPC Name

1.5 - Create NAT Gateway

1.5.1 - 1.1

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

Description

Create NAT Gateway.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
subnet_id required	string	Subnet CIDR	-
publicip_id required	string	PublicIP ID	-
description optional	string	NAT Gateway Description	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	NAT Gateway ID
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	NAT Gateway Description
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	NAT Gateway Name
nat_gateway_ip_address	NAT Gateway IP Address
publicip_id	PublicIP ID
state	NAT Gateway State
subnet_cidr	Subnet Cidr
subnet_id	Subnet Id
subnet_name	Subnet Name
vpc_id	VPC Id
vpc_name	VPC Name

1.5.2 - 1.0

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

Description

Create NAT Gateway.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
subnet_id required	string	Subnet CIDR	-
publicip_id required	string	PublicIP ID	-
description optional	string	NAT Gateway Description	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	NAT Gateway ID
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	NAT Gateway Description
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	NAT Gateway Name
nat_gateway_ip_address	NAT Gateway IP Address
publicip_id	PublicIP ID
state	NAT Gateway State
subnet_cidr	Subnet Cidr
subnet_id	Subnet Id
subnet_name	Subnet Name
vpc_id	VPC Id
vpc_name	VPC Name

1.6 - Create Port

1.6.1 - 1.1

scpcli 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)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
subnet_id required	string	Subnet Id	-
name required	string	Port Name	-
description optional	string	Description	-
fixed_ip_address optional	string	Fixed IP	-
security_groups optional	array	Security Group List	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
port

1.6.2 - 1.0

scpcli 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)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
subnet_id required	string	Subnet Id	-
name required	string	Port Name	-
description optional	string	Description	-
fixed_ip_address optional	string	Fixed IP	-
security_groups optional	array	Security Group List	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
port

1.7 - Create Private NAT

1.7.1 - 1.1

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

Description

Create Private NAT.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
name required	string	Private NAT Name	-
direct_connect_id required	string	Direct Connect ID	-
cidr required	string	Private NAT IP range	-
description optional	string	Description	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	Private NAT ID
account_id	Account ID
cidr	Private NAT IP range
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description
direct_connect_id	Direct Connect ID
direct_connect_name	Direct Connect Name
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Private NAT Name
state	Private NAT State
vpc_id	VPC Id
vpc_name	VPC Name

1.7.2 - 1.0

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

Description

Create Private NAT.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
name required	string	Private NAT Name	-
direct_connect_id required	string	Direct Connect ID	-
cidr required	string	Private NAT IP range	-
description optional	string	Description	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	Private NAT ID
account_id	Account ID
cidr	Private NAT IP range
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description
direct_connect_id	Direct Connect ID
direct_connect_name	Direct Connect Name
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Private NAT Name
state	Private NAT State
vpc_id	VPC Id
vpc_name	VPC Name

1.8 - Create Private NAT IP

1.8.1 - 1.1

scpcli vpc private-nat-ip create
--private_nat_id <value>
--ip_address <value>

Description

Create Private NAT IP.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
private_nat_id required	string	Private NAT ID	-
ip_address required	string	Private NAT IP Address	-

Responses

Name	Description	Example
id	Private NAT IP ID
attached_resource_id	Private NAT IP Attached Resource ID
attached_resource_name	Private NAT IP Attached Resource Name
attached_resource_type	Private NAT IP Attached Resource Type
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
ip_address	Private NAT IP Address
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
private_nat_id	Private NAT ID
state	Private NAT IP State

1.8.2 - 1.0

scpcli vpc private-nat-ip create
--private_nat_id <value>
--ip_address <value>

Description

Create Private NAT IP.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
private_nat_id required	string	Private NAT ID	-
ip_address required	string	Private NAT IP Address	-

Responses

Name	Description	Example
id	Private NAT IP ID
attached_resource_id	Private NAT IP Attached Resource ID
attached_resource_name	Private NAT IP Attached Resource Name
attached_resource_type	Private NAT IP Attached Resource Type
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
ip_address	Private NAT IP Address
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
private_nat_id	Private NAT ID
state	Private NAT IP State

1.9 - Create PrivateLink Endpoint

1.9.1 - 1.1

scpcli 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)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
subnet_id required	string	Subnet Id	-
name required	string	PrivateLink Endpoint Name	-
endpoint_ip_address required	string	Endpoint IP Address	-
description optional	string	Description	-
privatelink_service_id optional	string	PrivateLink Service ID	-
security_group_ids optional	array	Security Group List	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	PrivateLink Endpoint ID
account_id	Account ID
approval_type	PrivateLink Service Approval Type
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description
endpoint_ip_address	Endpoint IP Address
endpoint_ip_port_id	Endpoint IP Port ID
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	PrivateLink Endpoint Name
privatelink_service_id	PrivateLink Service ID
security_group_ids	Security Group List
state	PrivateLink Endpoint State
subnet_id	Subnet Id
vpc_id	VPC Id

1.10 - Create PrivateLink Service

1.10.1 - 1.1

scpcli 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)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
subnet_id required	string	Subnet Id	-
service_ip_address required	string	Service IP Address	-
name required	string	PrivateLink Service Name	-
connected_resource_type required	string	Connected Resource Type	-
approval_type required	string	PrivateLink Service Approval Type	-
connected_resource_id optional	string	Connected Resource ID	-
connected_resource_ip_address optional	string	Connected Resource IP Address	-
description optional	string	Description	-
high_speed_transfer optional	boolean	High Speed Data Transfer Use	-
security_group_ids optional	array	Security Group List	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	PrivateLink Service ID
account_id	Account ID
approval_type	PrivateLink Service Approval Type
connected_resource_id	Connected Resource ID
connected_resource_ip_address	Connected Resource IP Address
connected_resource_name	Connected Resource Name
connected_resource_type	Connected Resource Type
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description
high_speed_transfer	High Speed Data Transfer Use
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	PrivateLink Service Name
security_group_ids	Security Group List
service_ip_address	Service IP Address
service_ip_port_id	Service IP Port ID
state	PrivateLink Service State
subnet_id	Subnet Id
vpc_id	VPC Id

1.11 - Create PublicIP

1.11.1 - 1.1

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

Description

Create PublicIP.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
type required	string	PublicIP Type	-
description optional	string	PublicIP Description	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	PublicIP ID
account_id	Account ID
attached_resource_id	PublicIP Attached Resource ID
attached_resource_name	PublicIP Attached Resource Name
attached_resource_type	PublicIP Attached Resource Type
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	PublicIP Description
ip_address	IP Address
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
state	PublicIP State
type	PublicIP Type

1.11.2 - 1.0

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

Description

Create PublicIP.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
type required	string	PublicIP Type	-
description optional	string	PublicIP Description	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	PublicIP ID
account_id	Account ID
attached_resource_id	PublicIP Attached Resource ID
attached_resource_name	PublicIP Attached Resource Name
attached_resource_type	PublicIP Attached Resource Type
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	PublicIP Description
ip_address	IP Address
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
state	PublicIP State
type	PublicIP Type

1.12 - Create Subnet

1.12.1 - 1.1

scpcli 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 (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
vpc_id required	string	VPC Id	`7df8abb4912e4709b1cb237daccca7a8`
type required	string	Subnet Type	-
name required	string	Subnet Name	`subnetName`
cidr required	string	Subnet Cidr	`192.167.1.0/24`
allocation_pools optional	array	Allocation Pools	`[`
description optional	string	Description	`Subnet Description`
dns_nameservers optional	array	DNS Name Servers	`[`
host_routes optional	array	Host Routes	`[`
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	Subnet Id	023c57b14f11483689338d085e061492
account_id	Account ID	f1e6c81a2b054582878cb9724dc2ce9f
allocation_pools	Allocation Pools
cidr	Subnet Cidr	192.167.1.0/24
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	Subnet Description
dns_nameservers	DNS Name Servers
gateway_ip_address	Gateway IP Address	192.167.1.1
host_routes	Host Routes
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Subnet Name	subnetName
state	State
type	Subnet Type
vpc_id	VPC Id	7df8abb4912e4709b1cb237daccca7a8
vpc_name	VPC Name	vpcName

1.12.2 - 1.0

scpcli 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)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
vpc_id required	string	VPC Id	`7df8abb4912e4709b1cb237daccca7a8`
type required	string	Subnet Type	-
name required	string	Subnet Name	`subnetName`
cidr required	string	Subnet Cidr	`192.167.1.0/24`
allocation_pools optional	array	Allocation Pools	`[`
description optional	string	Description	`Subnet Description`
dns_nameservers optional	array	DNS Name Servers	`[`
host_routes optional	array	Host Routes	`[`
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	Subnet Id	023c57b14f11483689338d085e061492
account_id	Account ID	f1e6c81a2b054582878cb9724dc2ce9f
allocation_pools	Allocation Pools
cidr	Subnet Cidr	192.167.1.0/24
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	Subnet Description
dns_nameservers	DNS Name Servers
gateway_ip_address	Gateway IP Address	192.167.1.1
host_routes	Host Routes
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Subnet Name	subnetName
state	State
type	Subnet Type
vpc_id	VPC Id	7df8abb4912e4709b1cb237daccca7a8
vpc_name	VPC Name	vpcName

1.13 - Create Transit Gateway

1.13.1 - 1.1

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

Description

Create Transit Gateway.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
name required	string	Transit Gateway Name	-
description optional	string	Description	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	Transit Gateway ID
account_id	Account ID
bandwidth	Transit Gateway Port Bandwidth
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Transit Gateway Description
firewall_ids	Firewall ID
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Transit Gateway Name
state	State
uplink_enabled	Uplink Enabled

1.13.2 - 1.0

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

Description

Create Transit Gateway.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
name required	string	Transit Gateway Name	-
description optional	string	Description	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	Transit Gateway ID
account_id	Account ID
bandwidth	Transit Gateway Port Bandwidth
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Transit Gateway Description
firewall_ids	Firewall ID
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Transit Gateway Name
state	State
uplink_enabled	Uplink Enabled

1.14 - Create Transit Gateway Rule

1.14.1 - 1.1

scpcli 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)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
transit_gateway_id required	string	Transit Gateway ID	-
tgw_connection_vpc_id required	string	VPC ID Connected to Transit Gateway.	-
destination_type required	string	Destination Type	-
destination_cidr required	string	Destination CIDR	-
description optional	string	Description	-

Responses

Name	Description	Example
id	Routing Rule ID
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description
destination_cidr	Destination CIDR
destination_resource_id	Destination Resource ID
destination_resource_name	Destination Resource Name
destination_type	Destination Type
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
source_resource_id	Source Resource ID
source_resource_name	Source Resource Name
source_type	Source Type
state	State
tgw_connection_vpc_id	VPC ID Connected to Transit Gateway.
tgw_connection_vpc_name	VPC Name Connected to Transit Gateway.

1.14.2 - 1.0

scpcli 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)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
transit_gateway_id required	string	Transit Gateway ID	-
tgw_connection_vpc_id required	string	VPC ID Connected to Transit Gateway.	-
destination_type required	string	Destination Type	-
destination_cidr required	string	Destination CIDR	-
description optional	string	Description	-

Responses

Name	Description	Example
id	Routing Rule ID
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description
destination_cidr	Destination CIDR
destination_resource_id	Destination Resource ID
destination_resource_name	Destination Resource Name
destination_type	Destination Type
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
source_resource_id	Source Resource ID
source_resource_name	Source Resource Name
source_type	Source Type
state	State
tgw_connection_vpc_id	VPC ID Connected to Transit Gateway.
tgw_connection_vpc_name	VPC Name Connected to Transit Gateway.

1.15 - Create Transit Gateway VPC Connection

1.15.1 - 1.1

scpcli vpc transit-gateway-vpc-connection create
--transit_gateway_id <value>
--vpc_id <value>

Description

Create Transit Gateway VPC Connection.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
transit_gateway_id required	string	Transit Gateway ID	-
vpc_id required	string	VPC Id	-

Responses

Name	Description	Example
id	Transit Gateway VPC Connection ID
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
state	State
transit_gateway_id	Transit Gateway ID
vpc_id	VPC Id
vpc_name	VPC Name

1.15.2 - 1.0

scpcli vpc transit-gateway-vpc-connection create
--transit_gateway_id <value>
--vpc_id <value>

Description

Create Transit Gateway VPC Connection.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
transit_gateway_id required	string	Transit Gateway ID	-
vpc_id required	string	VPC Id	-

Responses

Name	Description	Example
id	Transit Gateway VPC Connection ID
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
state	State
transit_gateway_id	Transit Gateway ID
vpc_id	VPC Id
vpc_name	VPC Name

1.16 - Create VPC

1.16.1 - 1.1

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

Description

Create VPC.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
name required	string	VPC Name	`vpcName`
cidr required	string	VPC Cidr	`192.167.0.0/18`
description optional	string	Description	`VPC Description`
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	VPC Id	7df8abb4912e4709b1cb237daccca7a8
account_id	Account ID	f1e6c81a2b054582878cb9724dc2ce9f
cidr	VPC Cidr	192.167.0.0/18
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	vpcDescription
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	VPC Name	vpcName
state	State

1.16.2 - 1.0

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

Description

Create VPC.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
name required	string	VPC Name	`vpcName`
cidr required	string	VPC Cidr	`192.167.0.0/18`
description optional	string	Description	`VPC Description`
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	VPC Id	7df8abb4912e4709b1cb237daccca7a8
account_id	Account ID	f1e6c81a2b054582878cb9724dc2ce9f
cidr	VPC Cidr	192.167.0.0/18
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	vpcDescription
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	VPC Name	vpcName
state	State

1.17 - Create VPC Endpoint

1.17.1 - 1.1

scpcli 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)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
vpc_id required	string	VPC Id	-
subnet_id required	string	Subnet Id	-
resource_type required	string	VPC Endpoint Resource Type	-
resource_key required	string	VPC Endpoint Resource Key	-
resource_info required	string	VPC Endpoint Resource Key Info	-
name required	string	VPC Endpoint Name	-
endpoint_ip_address required	string	VPC Endpoint IP Address	-
description optional	string	Description	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	VPC Endpoint ID
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description
endpoint_ip_address	VPC Endpoint IP Address
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	VPC Endpoint Name
resource_info	VPC Endpoint Resource Key Info
resource_key	VPC Endpoint Resource Key
resource_type	VPC Endpoint Resource Type
state	VPC Endpoint State
subnet_id	Subnet Id
subnet_name	Subnet Name
vpc_id	VPC Id
vpc_name	VPC Name

1.17.2 - 1.0

scpcli 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)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
vpc_id required	string	VPC Id	-
subnet_id required	string	Subnet Id	-
resource_type required	string	VPC Endpoint Resource Type	-
resource_key required	string	VPC Endpoint Resource Key	-
resource_info required	string	VPC Endpoint Resource Key Info	-
name required	string	VPC Endpoint Name	-
endpoint_ip_address required	string	VPC Endpoint IP Address	-
description optional	string	Description	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	VPC Endpoint ID
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description
endpoint_ip_address	VPC Endpoint IP Address
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	VPC Endpoint Name
resource_info	VPC Endpoint Resource Key Info
resource_key	VPC Endpoint Resource Key
resource_type	VPC Endpoint Resource Type
state	VPC Endpoint State
subnet_id	Subnet Id
subnet_name	Subnet Name
vpc_id	VPC Id
vpc_name	VPC Name

1.18 - Create VPC Peering

1.18.1 - 1.1

scpcli 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)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
requester_vpc_id required	string	Requester VPC ID	-
name required	string	VPC Peering Name	-
approver_vpc_id required	string	Approver VPC ID	-
approver_vpc_account_id required	string	Approver VPC Account ID	-
description optional	string	Description	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	VPC Peering ID
account_type	Account Type
approver_vpc_account_id	Approver VPC Account ID
approver_vpc_id	Approver VPC ID
approver_vpc_name	Approver VPC Name
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_id	Requester VPC Account ID
description	VPC Peering Description
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	VPC Peering Name
requester_vpc_account_id	Requester VPC Account ID
requester_vpc_id	Requester VPC ID
requester_vpc_name	Requester VPC Name
state	State

1.18.2 - 1.0

scpcli 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)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
requester_vpc_id required	string	Requester VPC ID	-
name required	string	VPC Peering Name	-
approver_vpc_id required	string	Approver VPC ID	-
approver_vpc_account_id required	string	Approver VPC Account ID	-
description optional	string	Description	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	VPC Peering ID
account_type	Account Type
approver_vpc_account_id	Approver VPC Account ID
approver_vpc_id	Approver VPC ID
approver_vpc_name	Approver VPC Name
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_id	Requester VPC Account ID
description	VPC Peering Description
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	VPC Peering Name
requester_vpc_account_id	Requester VPC Account ID
requester_vpc_id	Requester VPC ID
requester_vpc_name	Requester VPC Name
state	State

1.19 - Create Vpc Peering Rule

1.19.1 - 1.1

scpcli 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)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
vpc_peering_id required	string	VPC Peering ID	-
destination_vpc_type required	string	Destination VPC Type	-
destination_cidr required	string	Destination CIDR	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	VPC Peering Rule ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
destination_cidr	Destination CIDR
destination_vpc_id	Destination VPC ID
destination_vpc_name	Destination VPC Name
destination_vpc_type	Destination VPC Type
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
source_vpc_id	Source VPC ID
source_vpc_name	Source VPC Name
source_vpc_type	Source VPC Type
state	State
vpc_peering_id	VPC Peering ID

1.19.2 - 1.0

scpcli 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)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
vpc_peering_id required	string	VPC Peering ID	-
destination_vpc_type required	string	Destination VPC Type	-
destination_cidr required	string	Destination CIDR	-
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	VPC Peering Rule ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
destination_cidr	Destination CIDR
destination_vpc_id	Destination VPC ID
destination_vpc_name	Destination VPC Name
destination_vpc_type	Destination VPC Type
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
source_vpc_id	Source VPC ID
source_vpc_name	Source VPC Name
source_vpc_type	Source VPC Type
state	State
vpc_peering_id	VPC Peering ID

1.20 - Delete Internet Gateway

1.20.1 - 1.1

scpcli vpc internet-gateway delete
--internet_gateway_id <value>

Description

Delete Internet Gateway.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
internet_gateway_id required	string	Internet Gateway ID	-

1.20.2 - 1.0

scpcli vpc internet-gateway delete
--internet_gateway_id <value>

Description

Delete Internet Gateway.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
internet_gateway_id required	string	Internet Gateway ID	-

1.21 - Delete NAT Gateway

1.21.1 - 1.1

scpcli vpc nat-gateway delete
--nat_gateway_id <value>

Description

Delete NAT Gateway.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
nat_gateway_id required	string	NAT Gateway ID	-

1.21.2 - 1.0

scpcli vpc nat-gateway delete
--nat_gateway_id <value>

Description

Delete NAT Gateway.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
nat_gateway_id required	string	NAT Gateway ID	-

1.22 - Delete Port

1.22.1 - 1.1

scpcli vpc port delete
--port_id <value>

Description

Delete port.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
port_id required	string	Port ID	-

1.22.2 - 1.0

scpcli vpc port delete
--port_id <value>

Description

Delete port.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
port_id required	string	Port ID	-

1.23 - Delete Private NAT

1.23.1 - 1.1

scpcli vpc private-nat delete
--private_nat_id <value>

Description

Delete Private NAT.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
private_nat_id required	string	Private NAT ID	-

1.23.2 - 1.0

scpcli vpc private-nat delete
--private_nat_id <value>

Description

Delete Private NAT.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
private_nat_id required	string	Private NAT ID	-

1.24 - Delete Private NAT IP

1.24.1 - 1.1

scpcli vpc private-nat-ip delete
--private_nat_ip_id <value>
--private_nat_id <value>

Description

Delete Private NAT IP.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
private_nat_ip_id required	string	Private NAT IP ID	-
private_nat_id required	string	Private NAT ID	-

1.24.2 - 1.0

scpcli vpc private-nat-ip delete
--private_nat_ip_id <value>
--private_nat_id <value>

Description

Delete Private NAT IP.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
private_nat_ip_id required	string	Private NAT IP ID	-
private_nat_id required	string	Private NAT ID	-

1.25 - Delete PrivateLink Endpoint

1.25.1 - 1.1

scpcli vpc privatelink-endpoint delete
--privatelink_endpoint_id <value>

Description

Delete PrivateLink Endpoint.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
privatelink_endpoint_id required	string	PrivateLink Endpoint ID	-

1.26 - Delete PrivateLink Service

1.26.1 - 1.1

scpcli vpc privatelink-service delete
--privatelink_service_id <value>

Description

Delete PrivateLink Service.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
privatelink_service_id required	string	PrivateLink Service ID	-

1.27 - Delete PublicIP

1.27.1 - 1.1

scpcli vpc public-ip delete
--publicip_id <value>

Description

Delete PublicIP.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
publicip_id required	string	PublicIP ID	-

1.27.2 - 1.0

scpcli vpc public-ip delete
--publicip_id <value>

Description

Delete PublicIP.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
publicip_id required	string	PublicIP ID	-

1.28 - Delete Subnet

1.28.1 - 1.1

scpcli vpc subnet delete
--subnet_id <value>

Description

Delete subnet.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
subnet_id required	string	Subnet Id	`023c57b14f11483689338d085e061492`

1.28.2 - 1.0

scpcli vpc subnet delete
--subnet_id <value>

Description

Delete subnet.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
subnet_id required	string	Subnet Id	`023c57b14f11483689338d085e061492`

1.29 - Delete Transit Gateway

1.29.1 - 1.1

scpcli vpc transit-gateway delete
--transit_gateway_id <value>

Description

Delete Transit Gateway.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
transit_gateway_id required	string	Transit Gateway ID	-

1.29.2 - 1.0

scpcli vpc transit-gateway delete
--transit_gateway_id <value>

Description

Delete Transit Gateway.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
transit_gateway_id required	string	Transit Gateway ID	-

1.30 - Delete Transit Gateway Rule

1.30.1 - 1.1

scpcli vpc transit-gateway-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway Rule.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
routing_rule_id required	string	Routing Rule ID	-
transit_gateway_id required	string	Transit Gateway ID	-

1.30.2 - 1.0

scpcli vpc transit-gateway-rule delete
--routing_rule_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway Rule.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
routing_rule_id required	string	Routing Rule ID	-
transit_gateway_id required	string	Transit Gateway ID	-

1.31 - Delete Transit Gateway VPC Connection

1.31.1 - 1.1

scpcli vpc transit-gateway-vpc-connection delete
--vpc_connection_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway VPC Connection.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
vpc_connection_id required	string	Transit Gateway VPC Connection ID	-
transit_gateway_id required	string	Transit Gateway ID	-

1.31.2 - 1.0

scpcli vpc transit-gateway-vpc-connection delete
--vpc_connection_id <value>
--transit_gateway_id <value>

Description

Delete Transit Gateway VPC Connection.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
vpc_connection_id required	string	Transit Gateway VPC Connection ID	-
transit_gateway_id required	string	Transit Gateway ID	-

1.32 - Delete VPC

1.32.1 - 1.1

scpcli vpc vpc delete
--vpc_id <value>

Description

Delete VPC.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
vpc_id required	string	VPC Id	-

1.32.2 - 1.0

scpcli vpc vpc delete
--vpc_id <value>

Description

Delete VPC.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
vpc_id required	string	VPC Id	-

1.33 - Delete VPC Endpoint

1.33.1 - 1.1

scpcli vpc vpc-endpoint delete
--vpc_endpoint_id <value>

Description

Delete VPC Endpoint.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
vpc_endpoint_id required	string	VPC Endpoint ID	-

1.33.2 - 1.0

scpcli vpc vpc-endpoint delete
--vpc_endpoint_id <value>

Description

Delete VPC Endpoint.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
vpc_endpoint_id required	string	VPC Endpoint ID	-

1.34 - Delete VPC Peering

1.34.1 - 1.1

scpcli vpc vpc-peering delete
--vpc_peering_id <value>

Description

Delete VPC Peering.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
vpc_peering_id required	string	VPC Peering ID	-

1.34.2 - 1.0

scpcli vpc vpc-peering delete
--vpc_peering_id <value>

Description

Delete VPC Peering.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
vpc_peering_id required	string	VPC Peering ID	-

1.35 - Delete VPC Peering Rule

1.35.1 - 1.1

scpcli vpc vpc-peering-rule delete
--routing_rule_id <value>
--vpc_peering_id <value>

Description

Delete a VPC Peering Rule.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
routing_rule_id required	string	Routing Rule ID	-
vpc_peering_id required	string	VPC Peering ID	-

1.35.2 - 1.0

scpcli vpc vpc-peering-rule delete
--routing_rule_id <value>
--vpc_peering_id <value>

Description

Delete a VPC Peering Rule.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
routing_rule_id required	string	Routing Rule ID	-
vpc_peering_id required	string	VPC Peering ID	-

1.36 - List Connected PrivateLink Endpoints

1.36.1 - 1.1

scpcli 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)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
privatelink_service_id required	string	PrivateLink Service ID	-
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`

Responses

Name	Description	Example
id	PrivateLink Endpoint ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
privatelink_service_id	PrivateLink Service ID
state	PrivateLink Endpoint State

1.37 - List Internet Gateways

1.37.1 - 1.1

scpcli 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 (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
with_count optional	string	with count	`true`
limit optional	integer	limit	`20`
marker optional	string	marker	`607e0938521643b5b4b266f343fae693`
sort optional	string	sort	`created_at:desc`
id optional	string	Internet Gateway ID	-
name optional	string	Internet Gateway Name	-
type optional	****	Internet Gateway Type	-
state optional	string	State	-
vpc_id optional	string	VPC Id	-
vpc_name optional	string	VPC Name	-

Responses

Name	Description	Example
id	Internet Gateway ID
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description
firewall_id	Firewall ID
loggable	NAT Loggable
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Internet Gateway Name
state	State
type	Internet Gateway Type
vpc_id	VPC Id
vpc_name	VPC Name

1.37.2 - 1.0

scpcli 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)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
with_count optional	string	with count	`true`
limit optional	integer	limit	`20`
marker optional	string	marker	`607e0938521643b5b4b266f343fae693`
sort optional	string	sort	`created_at:desc`
id optional	string	Internet Gateway ID	-
name optional	string	Internet Gateway Name	-
type optional	****	Internet Gateway Type	-
state optional	string	State	-
vpc_id optional	string	VPC Id	-
vpc_name optional	string	VPC Name	-

Responses

Name	Description	Example
id	Internet Gateway ID
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description
firewall_id	Firewall ID
loggable	NAT Loggable
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Internet Gateway Name
state	State
type	Internet Gateway Type
vpc_id	VPC Id
vpc_name	VPC Name

1.38 - List NAT Gateways

1.38.1 - 1.1

scpcli 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 (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
with_count optional	string	with count	`true`
limit optional	integer	limit	`20`
marker optional	string	marker	`607e0938521643b5b4b266f343fae693`
sort optional	string	sort	`created_at:desc`
name optional	string	NAT Gateway Name	-
vpc_id optional	string	VPC Id	-
vpc_name optional	string	VPC Name	-
subnet_id optional	string	Subnet Id	-
subnet_name optional	string	Subnet Name	-
nat_gateway_ip_address optional	string	NAT Gateway IP Address	-
state optional	****	NAT Gateway State	-

Responses

Name	Description	Example
id	NAT Gateway ID
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	NAT Gateway Description
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	NAT Gateway Name
nat_gateway_ip_address	NAT Gateway IP Address
publicip_id	PublicIP ID
state	NAT Gateway State
subnet_cidr	Subnet Cidr
subnet_id	Subnet Id
subnet_name	Subnet Name
vpc_id	VPC Id
vpc_name	VPC Name

1.38.2 - 1.0

scpcli 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)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
with_count optional	string	with count	`true`
limit optional	integer	limit	`20`
marker optional	string	marker	`607e0938521643b5b4b266f343fae693`
sort optional	string	sort	`created_at:desc`
name optional	string	NAT Gateway Name	-
vpc_id optional	string	VPC Id	-
vpc_name optional	string	VPC Name	-
subnet_id optional	string	Subnet Id	-
subnet_name optional	string	Subnet Name	-
nat_gateway_ip_address optional	string	NAT Gateway IP Address	-
state optional	****	NAT Gateway State	-

Responses

Name	Description	Example
id	NAT Gateway ID
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	NAT Gateway Description
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	NAT Gateway Name
nat_gateway_ip_address	NAT Gateway IP Address
publicip_id	PublicIP ID
state	NAT Gateway State
subnet_cidr	Subnet Cidr
subnet_id	Subnet Id
subnet_name	Subnet Name
vpc_id	VPC Id
vpc_name	VPC Name

1.39 - List Ports

1.39.1 - 1.1

scpcli 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>]

Description

Get port list.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
with_count optional	string	with count	`true`
limit optional	integer	Port Limit	-
marker optional	string	Port Marker	-
sort optional	string	Port Sort	-
name optional	string	Port Name	-
subnet_id optional	string	Subnet Id	-
subnet_name optional	string	Subnet Name	-
id optional	string	Port ID	-
attached_resource_id optional	string	Connected resource ID	-
fixed_ip_address optional	string	Fixed IP	-
mac_address optional	string	MAC Address	-
state optional	string	State	-
security_groups optional	string	Security Group List	-

Responses

Name	Description	Example
id	Port ID
account_id	Account ID
attached_resource_id	Connected resource ID
attached_resource_type	Connected resource Type
created_at	Created date
description	Description
fixed_ip_address	Fixed IP
mac_address	MAC Address
modified_at	Modified date
name	Port Name
state	State
subnet_id	Subnet Id
subnet_name	Subnet Name
vpc_id	VPC Id
vpc_name	VPC Name

1.39.2 - 1.0

scpcli 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>]

Description

Get port list.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
with_count optional	string	with count	`true`
limit optional	integer	Port Limit	-
marker optional	string	Port Marker	-
sort optional	string	Port Sort	-
name optional	string	Port Name	-
subnet_id optional	string	Subnet Id	-
subnet_name optional	string	Subnet Name	-
id optional	string	Port ID	-
attached_resource_id optional	string	Connected resource ID	-
fixed_ip_address optional	string	Fixed IP	-
mac_address optional	string	MAC Address	-
state optional	string	State	-
security_groups optional	string	Security Group List	-

Responses

Name	Description	Example
id	Port ID
account_id	Account ID
attached_resource_id	Connected resource ID
attached_resource_type	Connected resource Type
created_at	Created date
description	Description
fixed_ip_address	Fixed IP
mac_address	MAC Address
modified_at	Modified date
name	Port Name
state	State
subnet_id	Subnet Id
subnet_name	Subnet Name
vpc_id	VPC Id
vpc_name	VPC Name

1.40 - List Private NAT

1.40.1 - 1.1

scpcli 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 (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Private NAT Name	-
cidr optional	string	Private NAT IP range	-
vpc_id optional	string	VPC Id	-
vpc_name optional	string	VPC Name	-
direct_connect_id optional	string	Direct Connect ID	-
direct_connect_name optional	string	Direct Connect Name	-
state optional	****	Private NAT State	-

Responses

Name	Description	Example
id	Private NAT ID
account_id	Account ID
cidr	Private NAT IP range
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description
direct_connect_id	Direct Connect ID
direct_connect_name	Direct Connect Name
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Private NAT Name
state	Private NAT State
vpc_id	VPC Id
vpc_name	VPC Name

1.40.2 - 1.0

scpcli 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)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Private NAT Name	-
cidr optional	string	Private NAT IP range	-
vpc_id optional	string	VPC Id	-
vpc_name optional	string	VPC Name	-
direct_connect_id optional	string	Direct Connect ID	-
direct_connect_name optional	string	Direct Connect Name	-
state optional	****	Private NAT State	-

Responses

Name	Description	Example
id	Private NAT ID
account_id	Account ID
cidr	Private NAT IP range
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description
direct_connect_id	Direct Connect ID
direct_connect_name	Direct Connect Name
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Private NAT Name
state	Private NAT State
vpc_id	VPC Id
vpc_name	VPC Name

1.41 - List Private NAT IP

1.41.1 - 1.1

scpcli 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)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
private_nat_id required	string	Private NAT ID	-
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
ip_address optional	string	Private NAT IP Address	-
state optional	****	Private NAT IP State	-
attached_resource_type optional	****	Private NAT IP Attached Resource Type	-
attached_resource_id optional	string	Private NAT IP Attached Resource ID	-
attached_resource_name optional	string	Private NAT IP Attached Resource Name	-

Responses

Name	Description	Example
id	Private NAT IP ID
attached_resource_id	Private NAT IP Attached Resource ID
attached_resource_name	Private NAT IP Attached Resource Name
attached_resource_type	Private NAT IP Attached Resource Type
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
ip_address	Private NAT IP Address
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
private_nat_id	Private NAT ID
state	Private NAT IP State

1.41.2 - 1.0

scpcli 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)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
private_nat_id required	string	Private NAT ID	-
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
ip_address optional	string	Private NAT IP Address	-
state optional	****	Private NAT IP State	-
attached_resource_type optional	****	Private NAT IP Attached Resource Type	-
attached_resource_id optional	string	Private NAT IP Attached Resource ID	-
attached_resource_name optional	string	Private NAT IP Attached Resource Name	-

Responses

Name	Description	Example
id	Private NAT IP ID
attached_resource_id	Private NAT IP Attached Resource ID
attached_resource_name	Private NAT IP Attached Resource Name
attached_resource_type	Private NAT IP Attached Resource Type
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
ip_address	Private NAT IP Address
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
private_nat_id	Private NAT ID
state	Private NAT IP State

1.42 - List PrivateLink Endpoint

1.42.1 - 1.1

scpcli 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)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
id optional	string	PrivateLink Endpoint ID	-
name optional	string	PrivateLink Endpoint Name	-
vpc_id optional	string	VPC Id	-
subnet_id optional	string	Subnet Id	-
privatelink_service_id optional	string	PrivateLink Service ID	-
endpoint_ip_address optional	string	Endpoint IP Address	-
state optional	****	PrivateLink Endpoint State	-

Responses

Name	Description	Example
id	PrivateLink Endpoint ID
account_id	Account ID
approval_type	PrivateLink Service Approval Type
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
endpoint_ip_address	Endpoint IP Address
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	PrivateLink Endpoint Name
privatelink_service_id	PrivateLink Service ID
state	PrivateLink Endpoint State
subnet_id	Subnet Id
vpc_id	VPC Id

1.43 - List PrivateLink Service

1.43.1 - 1.1

scpcli 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)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
id optional	string	PrivateLink Service ID	-
name optional	string	PrivateLink Service Name	-
vpc_id optional	string	VPC Id	-
subnet_id optional	string	Subnet Id	-
service_ip_address optional	string	Service IP Address	-
connected_resource_id optional	string	Connected Resource ID	-
connected_resource_type optional	string	Connected Resource Type	-
connected_resource_name optional	string	Connected Resource Name	-
connected_resource_ip_address optional	string	Connected Resource IP Address	-
state optional	****	PrivateLink Service State	-

Responses

Name	Description	Example
id	PrivateLink Service ID
account_id	Account ID
approval_type	PrivateLink Service Approval Type
connected_resource_id	Connected Resource ID
connected_resource_ip_address	Connected Resource IP Address
connected_resource_name	Connected Resource Name
connected_resource_type	Connected Resource Type
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	PrivateLink Service Name
service_ip_address	Service IP Address
state	PrivateLink Service State
subnet_id	Subnet Id
vpc_id	VPC Id

1.44 - List PublicIPs

1.44.1 - 1.1

scpcli 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 (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
with_count optional	string	with count	`true`
limit optional	integer	limit	`20`
marker optional	string	marker	`607e0938521643b5b4b266f343fae693`
sort optional	string	sort	`created_at:desc`
ip_address optional	string	IP Address	-
state optional	string	PublicIP State	-
attached_resource_type optional	string	PublicIP Attached Resource Type	-
attached_resource_id optional	string	PublicIP Attached Resource ID	-
attached_resource_name optional	string	PublicIP Attached Resource Name	-
vpc_id optional	string	VPC Id	-
type optional	****	PublicIP Type	-

Responses

Name	Description	Example
id	PublicIP ID
account_id	Account ID
attached_resource_id	PublicIP Attached Resource ID
attached_resource_name	PublicIP Attached Resource Name
attached_resource_type	PublicIP Attached Resource Type
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	PublicIP Description
ip_address	IP Address
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
state	PublicIP State
type	PublicIP Type

1.44.2 - 1.0

scpcli 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)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
with_count optional	string	with count	`true`
limit optional	integer	limit	`20`
marker optional	string	marker	`607e0938521643b5b4b266f343fae693`
sort optional	string	sort	`created_at:desc`
ip_address optional	string	IP Address	-
state optional	string	PublicIP State	-
attached_resource_type optional	string	PublicIP Attached Resource Type	-
attached_resource_id optional	string	PublicIP Attached Resource ID	-
attached_resource_name optional	string	PublicIP Attached Resource Name	-
vpc_id optional	string	VPC Id	-
type optional	****	PublicIP Type	-

Responses

Name	Description	Example
id	PublicIP ID
account_id	Account ID
attached_resource_id	PublicIP Attached Resource ID
attached_resource_name	PublicIP Attached Resource Name
attached_resource_type	PublicIP Attached Resource Type
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	PublicIP Description
ip_address	IP Address
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
state	PublicIP State
type	PublicIP Type

1.45 - List Subnets

1.45.1 - 1.1

scpcli 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 (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
with_count optional	string	with count	`true`
limit optional	integer	limit	`20`
marker optional	string	marker	`607e0938521643b5b4b266f343fae693`
sort optional	string	sort	`created_at:desc`
id optional	string	Subnet Id	`023c57b14f11483689338d085e061492`
name optional	string	Subnet Name	`subnetName`
type optional	****	Subnet Type	-
state optional	****	State	-
vpc_id optional	string	VPC Id	`7df8abb4912e4709b1cb237daccca7a8`
vpc_name optional	string	VPC Name	`vpcName`

Responses

Name	Description	Example
id	Subnet Id	023c57b14f11483689338d085e061492
account_id	Account ID	f1e6c81a2b054582878cb9724dc2ce9f
cidr	Subnet Cidr	192.167.1.0/24
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
gateway_ip_address	Gateway IP Address	192.167.1.1
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Subnet Name	subnetName
state	State
type	Subnet Type
vpc_id	VPC Id	7df8abb4912e4709b1cb237daccca7a8
vpc_name	VPC Name	vpcName

1.45.2 - 1.0

scpcli 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)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
with_count optional	string	with count	`true`
limit optional	integer	limit	`20`
marker optional	string	marker	`607e0938521643b5b4b266f343fae693`
sort optional	string	sort	`created_at:desc`
id optional	string	Subnet Id	`023c57b14f11483689338d085e061492`
name optional	string	Subnet Name	`subnetName`
type optional	****	Subnet Type	-
state optional	****	State	-
vpc_id optional	string	VPC Id	`7df8abb4912e4709b1cb237daccca7a8`
vpc_name optional	string	VPC Name	`vpcName`

Responses

Name	Description	Example
id	Subnet Id	023c57b14f11483689338d085e061492
account_id	Account ID	f1e6c81a2b054582878cb9724dc2ce9f
cidr	Subnet Cidr	192.167.1.0/24
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
gateway_ip_address	Gateway IP Address	192.167.1.1
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Subnet Name	subnetName
state	State
type	Subnet Type
vpc_id	VPC Id	7df8abb4912e4709b1cb237daccca7a8
vpc_name	VPC Name	vpcName

1.46 - List Transit Gateway Rules

1.46.1 - 1.1

scpcli 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 (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
transit_gateway_id required	string	Transit Gateway ID	-
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
id optional	string	Routing Rule ID	-
tgw_connection_vpc_id optional	string	VPC ID Connected to Transit Gateway.	-
tgw_connection_vpc_name optional	string	VPC Name Connected to Transit Gateway.	-
source_type optional	****	Source Type	-
destination_type optional	****	Destination Type	-
destination_cidr optional	string	Destination CIDR	-
state optional	****	State	-

Responses

Name	Description	Example
id	Routing Rule ID
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description
destination_cidr	Destination CIDR
destination_resource_id	Destination Resource ID
destination_resource_name	Destination Resource Name
destination_type	Destination Type
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
source_resource_id	Source Resource ID
source_resource_name	Source Resource Name
source_type	Source Type
state	State
tgw_connection_vpc_id	VPC ID Connected to Transit Gateway.
tgw_connection_vpc_name	VPC Name Connected to Transit Gateway.

1.46.2 - 1.0

scpcli 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)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
transit_gateway_id required	string	Transit Gateway ID	-
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
id optional	string	Routing Rule ID	-
tgw_connection_vpc_id optional	string	VPC ID Connected to Transit Gateway.	-
tgw_connection_vpc_name optional	string	VPC Name Connected to Transit Gateway.	-
source_type optional	****	Source Type	-
destination_type optional	****	Destination Type	-
destination_cidr optional	string	Destination CIDR	-
state optional	****	State	-

Responses

Name	Description	Example
id	Routing Rule ID
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description
destination_cidr	Destination CIDR
destination_resource_id	Destination Resource ID
destination_resource_name	Destination Resource Name
destination_type	Destination Type
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
source_resource_id	Source Resource ID
source_resource_name	Source Resource Name
source_type	Source Type
state	State
tgw_connection_vpc_id	VPC ID Connected to Transit Gateway.
tgw_connection_vpc_name	VPC Name Connected to Transit Gateway.

1.47 - List Transit Gateway VPC Connections

1.47.1 - 1.1

scpcli 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)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
transit_gateway_id required	string	Transit Gateway ID	-
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
id optional	string	Transit Gateway VPC Connection ID	-
vpc_id optional	string	VPC Id	-
vpc_name optional	string	VPC Name	-
state optional	****	State	-

Responses

Name	Description	Example
id	Transit Gateway VPC Connection ID
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
state	State
transit_gateway_id	Transit Gateway ID
vpc_id	VPC Id
vpc_name	VPC Name

1.47.2 - 1.0

scpcli 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)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
transit_gateway_id required	string	Transit Gateway ID	-
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
id optional	string	Transit Gateway VPC Connection ID	-
vpc_id optional	string	VPC Id	-
vpc_name optional	string	VPC Name	-
state optional	****	State	-

Responses

Name	Description	Example
id	Transit Gateway VPC Connection ID
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
state	State
transit_gateway_id	Transit Gateway ID
vpc_id	VPC Id
vpc_name	VPC Name

1.48 - List Transit Gateways

1.48.1 - 1.1

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

Description

Get Transit Gateway list.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
id optional	string	Transit Gateway ID	-
name optional	string	Transit Gateway Name	-
state optional	****	State	-

Responses

Name	Description	Example
id	Transit Gateway ID
account_id	Account ID
bandwidth	Transit Gateway Port Bandwidth
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Transit Gateway Description
firewall_ids	Firewall ID
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Transit Gateway Name
state	State
uplink_enabled	Uplink Enabled

1.48.2 - 1.0

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

Description

Get Transit Gateway list.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
id optional	string	Transit Gateway ID	-
name optional	string	Transit Gateway Name	-
state optional	****	State	-

Responses

Name	Description	Example
id	Transit Gateway ID
account_id	Account ID
bandwidth	Transit Gateway Port Bandwidth
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Transit Gateway Description
firewall_ids	Firewall ID
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Transit Gateway Name
state	State
uplink_enabled	Uplink Enabled

1.49 - List VPC Endpoint

1.49.1 - 1.1

scpcli 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 (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
with_count optional	string	with count	`true`
limit optional	integer	limit	`20`
marker optional	string	marker	`607e0938521643b5b4b266f343fae693`
sort optional	string	sort	`created_at:desc`
id optional	string	VPC Endpoint ID	-
name optional	string	VPC Endpoint Name	-
vpc_id optional	string	VPC Id	-
vpc_name optional	string	VPC Name	-
subnet_id optional	string	Subnet Id	-
resource_key optional	string	VPC Endpoint Resource Key	-
resource_type optional	****	VPC Endpoint Resource Type	-
endpoint_ip_address optional	string	VPC Endpoint IP Address	-
state optional	****	VPC Endpoint State	-

Responses

Name	Description	Example
id	VPC Endpoint ID
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description
endpoint_ip_address	VPC Endpoint IP Address
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	VPC Endpoint Name
resource_info	VPC Endpoint Resource Key Info
resource_key	VPC Endpoint Resource Key
resource_type	VPC Endpoint Resource Type
state	VPC Endpoint State
subnet_id	Subnet Id
subnet_name	Subnet Name
vpc_id	VPC Id
vpc_name	VPC Name

1.49.2 - 1.0

scpcli 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)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
with_count optional	string	with count	`true`
limit optional	integer	limit	`20`
marker optional	string	marker	`607e0938521643b5b4b266f343fae693`
sort optional	string	sort	`created_at:desc`
id optional	string	VPC Endpoint ID	-
name optional	string	VPC Endpoint Name	-
vpc_id optional	string	VPC Id	-
vpc_name optional	string	VPC Name	-
subnet_id optional	string	Subnet Id	-
resource_key optional	string	VPC Endpoint Resource Key	-
resource_type optional	****	VPC Endpoint Resource Type	-
endpoint_ip_address optional	string	VPC Endpoint IP Address	-
state optional	****	VPC Endpoint State	-

Responses

Name	Description	Example
id	VPC Endpoint ID
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description
endpoint_ip_address	VPC Endpoint IP Address
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	VPC Endpoint Name
resource_info	VPC Endpoint Resource Key Info
resource_key	VPC Endpoint Resource Key
resource_type	VPC Endpoint Resource Type
state	VPC Endpoint State
subnet_id	Subnet Id
subnet_name	Subnet Name
vpc_id	VPC Id
vpc_name	VPC Name

1.50 - List VPC Endpoint Connectable Resources

1.50.1 - 1.1

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

Description

List VpcEndpoint connectable resources

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
resource_type required	****	VPC Endpoint Resource Type	-
vpc_id optional	string	VPC ID(required if resource_type is DNS)	-

Responses

Name	Description	Example
resource_info	VPC Endpoint Resource Key Info
resource_key	VPC Endpoint Resource Key
resource_type	VPC Endpoint Resource Type

1.50.2 - 1.0

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

Description

List VpcEndpoint connectable resources

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
resource_type required	****	VPC Endpoint Resource Type	-
vpc_id optional	string	VPC ID(required if resource_type is DNS)	-

Responses

Name	Description	Example
resource_info	VPC Endpoint Resource Key Info
resource_key	VPC Endpoint Resource Key
resource_type	VPC Endpoint Resource Type

1.51 - List VPC Peering

1.51.1 - 1.1

scpcli 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)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
id optional	string	VPC Peering ID	-
name optional	string	VPC Peering Name	-
requester_vpc_id optional	string	Requester VPC ID	-
requester_vpc_name optional	string	Requester VPC Name	-
approver_vpc_id optional	string	Approver VPC ID	-
approver_vpc_name optional	string	Approver VPC Name	-
account_type optional	****	Account Type	-
state optional	****	State	-

Responses

Name	Description	Example
id	VPC Peering ID
account_type	Account Type
approver_vpc_account_id	Approver VPC Account ID
approver_vpc_id	Approver VPC ID
approver_vpc_name	Approver VPC Name
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_id	Requester VPC Account ID
description	VPC Peering Description
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	VPC Peering Name
requester_vpc_account_id	Requester VPC Account ID
requester_vpc_id	Requester VPC ID
requester_vpc_name	Requester VPC Name
state	State

1.51.2 - 1.0

scpcli 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)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
id optional	string	VPC Peering ID	-
name optional	string	VPC Peering Name	-
requester_vpc_id optional	string	Requester VPC ID	-
requester_vpc_name optional	string	Requester VPC Name	-
approver_vpc_id optional	string	Approver VPC ID	-
approver_vpc_name optional	string	Approver VPC Name	-
account_type optional	****	Account Type	-
state optional	****	State	-

Responses

Name	Description	Example
id	VPC Peering ID
account_type	Account Type
approver_vpc_account_id	Approver VPC Account ID
approver_vpc_id	Approver VPC ID
approver_vpc_name	Approver VPC Name
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_id	Requester VPC Account ID
description	VPC Peering Description
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	VPC Peering Name
requester_vpc_account_id	Requester VPC Account ID
requester_vpc_id	Requester VPC ID
requester_vpc_name	Requester VPC Name
state	State

1.52 - List VPC Peering Rules

1.52.1 - 1.1

scpcli vpc vpc-peering-routing-rule list
--vpc_peering_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <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)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
vpc_peering_id required	string	VPC Peering ID	-
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
id optional	string	VPC Peering Rule ID	-
name optional	string	VPC Peering Name	-
source_vpc_id optional	string	Source VPC ID	-
source_vpc_type optional	****	Source VPC Type	-
destination_vpc_id optional	string	Destination VPC ID	-
destination_vpc_type optional	****	Destination VPC Type	-
destination_cidr optional	string	Destination CIDR	-
state optional	****	State	-

Responses

Name	Description	Example
id	VPC Peering Rule ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
destination_cidr	Destination CIDR
destination_vpc_id	Destination VPC ID
destination_vpc_name	Destination VPC Name
destination_vpc_type	Destination VPC Type
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
source_vpc_id	Source VPC ID
source_vpc_name	Source VPC Name
source_vpc_type	Source VPC Type
state	State
vpc_peering_id	VPC Peering ID

1.52.2 - 1.0

scpcli vpc vpc-peering-routing-rule list
--vpc_peering_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <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 (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
vpc_peering_id required	string	VPC Peering ID	-
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
id optional	string	VPC Peering Rule ID	-
name optional	string	VPC Peering Name	-
source_vpc_id optional	string	Source VPC ID	-
source_vpc_type optional	****	Source VPC Type	-
destination_vpc_id optional	string	Destination VPC ID	-
destination_vpc_type optional	****	Destination VPC Type	-
destination_cidr optional	string	Destination CIDR	-
state optional	****	State	-

Responses

Name	Description	Example
id	VPC Peering Rule ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
destination_cidr	Destination CIDR
destination_vpc_id	Destination VPC ID
destination_vpc_name	Destination VPC Name
destination_vpc_type	Destination VPC Type
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
source_vpc_id	Source VPC ID
source_vpc_name	Source VPC Name
source_vpc_type	Source VPC Type
state	State
vpc_peering_id	VPC Peering ID

1.53 - List VPCs

1.53.1 - 1.1

scpcli 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 (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
with_count optional	string	with count	`true`
limit optional	integer	limit	`20`
marker optional	string	marker	`607e0938521643b5b4b266f343fae693`
sort optional	string	sort	`created_at:desc`
id optional	string	VPC Id	`7df8abb4912e4709b1cb237daccca7a8`
name optional	string	VPC Name	`vpcName`
state optional	****	State	-
cidr optional	string	VPC Cidr	`192.167.0.0/18`

Responses

Name	Description	Example
id	VPC Id	7df8abb4912e4709b1cb237daccca7a8
account_id	Account ID	f1e6c81a2b054582878cb9724dc2ce9f
cidr	VPC Cidr	192.167.0.0/18
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	vpcDescription
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	VPC Name	vpcName
state	State

1.53.2 - 1.0

scpcli 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)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
with_count optional	string	with count	`true`
limit optional	integer	limit	`20`
marker optional	string	marker	`607e0938521643b5b4b266f343fae693`
sort optional	string	sort	`created_at:desc`
id optional	string	VPC Id	`7df8abb4912e4709b1cb237daccca7a8`
name optional	string	VPC Name	`vpcName`
state optional	****	State	-
cidr optional	string	VPC Cidr	`192.167.0.0/18`

Responses

Name	Description	Example
id	VPC Id	7df8abb4912e4709b1cb237daccca7a8
account_id	Account ID	f1e6c81a2b054582878cb9724dc2ce9f
cidr	VPC Cidr	192.167.0.0/18
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	vpcDescription
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	VPC Name	vpcName
state	State

1.54 - Request PrivateLink Endpoint

1.54.1 - 1.1

scpcli vpc privatelink-endpoint request
--privatelink_endpoint_id <value>
--type <value>

Description

Request PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
privatelink_endpoint_id required	string	PrivateLink Endpoint ID	-
type required	string	PrivateLink Endpoint Action Type	-

1.55 - Set Internet Gateway

1.55.1 - 1.1

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

Description

Set Internet Gateway.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
internet_gateway_id required	string	Internet Gateway ID	-
description optional	string	Description	-
loggable optional	boolean	NAT Loggable	-

1.55.2 - 1.0

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

Description

Set Internet Gateway.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
internet_gateway_id required	string	Internet Gateway ID	-
description optional	string	Description	-
loggable optional	boolean	NAT Loggable	-

1.56 - Set NAT Gateway

1.56.1 - 1.1

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

Description

Set NAT Gateway.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
nat_gateway_id required	string	NAT Gateway ID	-
description optional	string	NAT Gateway Description	-

1.56.2 - 1.0

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

Description

Set NAT Gateway.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
nat_gateway_id required	string	NAT Gateway ID	-
description optional	string	NAT Gateway Description	-

1.57 - Set Port

1.57.1 - 1.1

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

Description

Set port.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
port_id required	string	Port ID	-
description optional	string	Description	-
security_groups optional	array	Security Group List	-

1.57.2 - 1.0

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

Description

Set port.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
port_id required	string	Port ID	-
description optional	string	Description	-
security_groups optional	array	Security Group List	-

1.58 - Set Private NAT

1.58.1 - 1.1

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

Description

Set Private NAT.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
private_nat_id required	string	Private NAT ID	-
description optional	string	Description	-

1.58.2 - 1.0

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

Description

Set Private NAT.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
private_nat_id required	string	Private NAT ID	-
description optional	string	Description	-

1.59 - Set PrivateLink Endpoint

1.59.1 - 1.1

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

Description

Set PrivateLink Endpoint.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
privatelink_endpoint_id required	string	PrivateLink Endpoint ID	-
description optional	string	Description	-

1.60 - Set PrivateLink Service

1.60.1 - 1.1

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

Description

Set PrivateLink Service.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
privatelink_service_id required	string	PrivateLink Service ID	-
description optional	string	Description	-

1.61 - Set PublicIP

1.61.1 - 1.1

scpcli vpc public-ip set
--publicip_id <value>
--description <value>

Description

Set PublicIP.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
publicip_id required	string	PublicIP ID	-
description required	string	PublicIP Description	-

1.61.2 - 1.0

scpcli vpc public-ip set
--publicip_id <value>
--description <value>

Description

Set PublicIP.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
publicip_id required	string	PublicIP ID	-
description required	string	PublicIP Description	-

1.62 - Set Subnet

1.62.1 - 1.1

scpcli vpc subnet set
--subnet_id <value>
--description <value>

Description

Set subnet.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
subnet_id required	string	Subnet Id	`023c57b14f11483689338d085e061492`
description required	string	Description	`Subnet Description`

1.62.2 - 1.0

scpcli vpc subnet set
--subnet_id <value>
--description <value>

Description

Set subnet.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
subnet_id required	string	Subnet Id	`023c57b14f11483689338d085e061492`
description required	string	Description	`Subnet Description`

1.63 - Set Transit Gateway

1.63.1 - 1.1

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

Description

Set Transit Gateway.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
transit_gateway_id required	string	Transit Gateway ID	-
description optional	string	Description	-

1.63.2 - 1.0

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

Description

Set Transit Gateway.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
transit_gateway_id required	string	Transit Gateway ID	-
description optional	string	Description	-

1.64 - Set VPC

1.64.1 - 1.1

scpcli vpc vpc set
--vpc_id <value>
[--description <value>]

Description

Set VPC.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
vpc_id required	string	VPC Id	-
description optional	string	Description	`vpcDescription`

1.64.2 - 1.0

scpcli vpc vpc set
--vpc_id <value>
[--description <value>]

Description

Set VPC.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
vpc_id required	string	VPC Id	-
description optional	string	Description	`vpcDescription`

1.65 - Set VPC Endpoint

1.65.1 - 1.1

scpcli vpc vpc-endpoint set
--vpc_endpoint_id <value>
[--description <value>]

Description

Set VPC Endpoint.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
vpc_endpoint_id required	string	VPC Endpoint ID	-
description optional	string	Description	-

1.65.2 - 1.0

scpcli vpc vpc-endpoint set
--vpc_endpoint_id <value>
[--description <value>]

Description

Set VPC Endpoint.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
vpc_endpoint_id required	string	VPC Endpoint ID	-
description optional	string	Description	-

1.66 - Set VPC Peering

1.66.1 - 1.1

scpcli vpc vpc-peering set
--vpc_peering_id <value>
[--description <value>]

Description

Set VPC Peering.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
vpc_peering_id required	string	VPC Peering ID	-
description optional	string	Description	-

1.66.2 - 1.0

scpcli vpc vpc-peering set
--vpc_peering_id <value>
[--description <value>]

Description

Set VPC Peering.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
vpc_peering_id required	string	VPC Peering ID	-
description optional	string	Description	-

1.67 - Show Internet Gateway

1.67.1 - 1.1

scpcli vpc internet-gateway show
--internet_gateway_id <value>

Description

Show Internet Gateway.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
internet_gateway_id required	string	Internet Gateway ID	-

Responses

Name	Description	Example
id	Internet Gateway ID
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description
firewall_id	Firewall ID
loggable	NAT Loggable
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Internet Gateway Name
state	State
type	Internet Gateway Type
vpc_id	VPC Id
vpc_name	VPC Name

1.67.2 - 1.0

scpcli vpc internet-gateway show
--internet_gateway_id <value>

Description

Show Internet Gateway.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
internet_gateway_id required	string	Internet Gateway ID	-

Responses

Name	Description	Example
id	Internet Gateway ID
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description
firewall_id	Firewall ID
loggable	NAT Loggable
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Internet Gateway Name
state	State
type	Internet Gateway Type
vpc_id	VPC Id
vpc_name	VPC Name

1.68 - Show NAT Gateway

1.68.1 - 1.1

scpcli vpc nat-gateway show
--nat_gateway_id <value>

Description

Show NAT Gateway.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
nat_gateway_id required	string	NAT Gateway ID	-

Responses

Name	Description	Example
id	NAT Gateway ID
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	NAT Gateway Description
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	NAT Gateway Name
nat_gateway_ip_address	NAT Gateway IP Address
publicip_id	PublicIP ID
state	NAT Gateway State
subnet_cidr	Subnet Cidr
subnet_id	Subnet Id
subnet_name	Subnet Name
vpc_id	VPC Id
vpc_name	VPC Name

1.68.2 - 1.0

scpcli vpc nat-gateway show
--nat_gateway_id <value>

Description

Show NAT Gateway.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
nat_gateway_id required	string	NAT Gateway ID	-

Responses

Name	Description	Example
id	NAT Gateway ID
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	NAT Gateway Description
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	NAT Gateway Name
nat_gateway_ip_address	NAT Gateway IP Address
publicip_id	PublicIP ID
state	NAT Gateway State
subnet_cidr	Subnet Cidr
subnet_id	Subnet Id
subnet_name	Subnet Name
vpc_id	VPC Id
vpc_name	VPC Name

1.69 - Show Port

1.69.1 - 1.1

scpcli vpc port show
--port_id <value>

Description

Show port.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
port_id required	string	Port ID	-

Responses

Name	Description	Example
port

1.69.2 - 1.0

scpcli vpc port show
--port_id <value>

Description

Show port.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
port_id required	string	Port ID	-

Responses

Name	Description	Example
port

1.70 - Show Private NAT

1.70.1 - 1.1

scpcli vpc private-nat show
--private_nat_id <value>

Description

Show Private NAT.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
private_nat_id required	string	Private NAT ID	-

Responses

Name	Description	Example
id	Private NAT ID
account_id	Account ID
cidr	Private NAT IP range
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description
direct_connect_id	Direct Connect ID
direct_connect_name	Direct Connect Name
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Private NAT Name
state	Private NAT State
vpc_id	VPC Id
vpc_name	VPC Name

1.70.2 - 1.0

scpcli vpc private-nat show
--private_nat_id <value>

Description

Show Private NAT.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
private_nat_id required	string	Private NAT ID	-

Responses

Name	Description	Example
id	Private NAT ID
account_id	Account ID
cidr	Private NAT IP range
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description
direct_connect_id	Direct Connect ID
direct_connect_name	Direct Connect Name
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Private NAT Name
state	Private NAT State
vpc_id	VPC Id
vpc_name	VPC Name

1.71 - Show PrivateLink Endpoint

1.71.1 - 1.1

scpcli vpc privatelink-endpoint show
--privatelink_endpoint_id <value>

Description

Show PrivateLink Endpoint.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
privatelink_endpoint_id required	string	PrivateLink Endpoint ID	-

Responses

Name	Description	Example
id	PrivateLink Endpoint ID
account_id	Account ID
approval_type	PrivateLink Service Approval Type
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description
endpoint_ip_address	Endpoint IP Address
endpoint_ip_port_id	Endpoint IP Port ID
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	PrivateLink Endpoint Name
privatelink_service_id	PrivateLink Service ID
security_group_ids	Security Group List
state	PrivateLink Endpoint State
subnet_id	Subnet Id
vpc_id	VPC Id

1.72 - Show PrivateLink Service

1.72.1 - 1.1

scpcli vpc privatelink-service show
--privatelink_service_id <value>

Description

Show PrivateLink Service.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
privatelink_service_id required	string	PrivateLink Service ID	-

Responses

Name	Description	Example
id	PrivateLink Service ID
account_id	Account ID
approval_type	PrivateLink Service Approval Type
connected_resource_id	Connected Resource ID
connected_resource_ip_address	Connected Resource IP Address
connected_resource_name	Connected Resource Name
connected_resource_type	Connected Resource Type
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description
high_speed_transfer	High Speed Data Transfer Use
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	PrivateLink Service Name
security_group_ids	Security Group List
service_ip_address	Service IP Address
service_ip_port_id	Service IP Port ID
state	PrivateLink Service State
subnet_id	Subnet Id
vpc_id	VPC Id

1.73 - Show PublicIP

1.73.1 - 1.1

scpcli vpc public-ip show
--publicip_id <value>

Description

Show PublicIP.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
publicip_id required	string	PublicIP ID	-

Responses

Name	Description	Example
id	PublicIP ID
account_id	Account ID
attached_resource_id	PublicIP Attached Resource ID
attached_resource_name	PublicIP Attached Resource Name
attached_resource_type	PublicIP Attached Resource Type
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	PublicIP Description
ip_address	IP Address
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
state	PublicIP State
type	PublicIP Type

1.73.2 - 1.0

scpcli vpc public-ip show
--publicip_id <value>

Description

Show PublicIP.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
publicip_id required	string	PublicIP ID	-

Responses

Name	Description	Example
id	PublicIP ID
account_id	Account ID
attached_resource_id	PublicIP Attached Resource ID
attached_resource_name	PublicIP Attached Resource Name
attached_resource_type	PublicIP Attached Resource Type
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	PublicIP Description
ip_address	IP Address
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
state	PublicIP State
type	PublicIP Type

1.74 - Show Subnet

1.74.1 - 1.1

scpcli vpc subnet show
--subnet_id <value>

Description

Show subnet.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
subnet_id required	string	Subnet Id	`023c57b14f11483689338d085e061492`

Responses

Name	Description	Example
id	Subnet Id	023c57b14f11483689338d085e061492
account_id	Account ID	f1e6c81a2b054582878cb9724dc2ce9f
allocation_pools	Allocation Pools
cidr	Subnet Cidr	192.167.1.0/24
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	Subnet Description
dns_nameservers	DNS Name Servers
gateway_ip_address	Gateway IP Address	192.167.1.1
host_routes	Host Routes
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Subnet Name	subnetName
state	State
type	Subnet Type
vpc_id	VPC Id	7df8abb4912e4709b1cb237daccca7a8
vpc_name	VPC Name	vpcName

1.74.2 - 1.0

scpcli vpc subnet show
--subnet_id <value>

Description

Show subnet.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
subnet_id required	string	Subnet Id	`023c57b14f11483689338d085e061492`

Responses

Name	Description	Example
id	Subnet Id	023c57b14f11483689338d085e061492
account_id	Account ID	f1e6c81a2b054582878cb9724dc2ce9f
allocation_pools	Allocation Pools
cidr	Subnet Cidr	192.167.1.0/24
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	Subnet Description
dns_nameservers	DNS Name Servers
gateway_ip_address	Gateway IP Address	192.167.1.1
host_routes	Host Routes
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Subnet Name	subnetName
state	State
type	Subnet Type
vpc_id	VPC Id	7df8abb4912e4709b1cb237daccca7a8
vpc_name	VPC Name	vpcName

1.75 - Show Transit Gateway

1.75.1 - 1.1

scpcli vpc transit-gateway show
--transit_gateway_id <value>

Description

Show Transit Gateway.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
transit_gateway_id required	string	Transit Gateway ID	-

Responses

Name	Description	Example
id	Transit Gateway ID
account_id	Account ID
bandwidth	Transit Gateway Port Bandwidth
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Transit Gateway Description
firewall_ids	Firewall ID
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Transit Gateway Name
state	State
uplink_enabled	Uplink Enabled

1.75.2 - 1.0

scpcli vpc transit-gateway show
--transit_gateway_id <value>

Description

Show Transit Gateway.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
transit_gateway_id required	string	Transit Gateway ID	-

Responses

Name	Description	Example
id	Transit Gateway ID
account_id	Account ID
bandwidth	Transit Gateway Port Bandwidth
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Transit Gateway Description
firewall_ids	Firewall ID
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Transit Gateway Name
state	State
uplink_enabled	Uplink Enabled

1.76 - Show VPC

1.76.1 - 1.1

scpcli vpc vpc show
--vpc_id <value>

Description

Show VPC.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
vpc_id required	string	VPC Id	-

Responses

Name	Description	Example
id	VPC Id	7df8abb4912e4709b1cb237daccca7a8
account_id	Account ID	f1e6c81a2b054582878cb9724dc2ce9f
cidr	VPC Cidr	192.167.0.0/18
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	vpcDescription
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	VPC Name	vpcName
state	State

1.76.2 - 1.0

scpcli vpc vpc show
--vpc_id <value>

Description

Show VPC.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
vpc_id required	string	VPC Id	-

Responses

Name	Description	Example
id	VPC Id	7df8abb4912e4709b1cb237daccca7a8
account_id	Account ID	f1e6c81a2b054582878cb9724dc2ce9f
cidr	VPC Cidr	192.167.0.0/18
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	vpcDescription
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	VPC Name	vpcName
state	State

1.77 - Show VPC Endpoint

1.77.1 - 1.1

scpcli vpc vpc-endpoint show
--vpc_endpoint_id <value>

Description

Show VPC Endpoint.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
vpc_endpoint_id required	string	VPC Endpoint ID	-

Responses

Name	Description	Example
id	VPC Endpoint ID
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description
endpoint_ip_address	VPC Endpoint IP Address
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	VPC Endpoint Name
resource_info	VPC Endpoint Resource Key Info
resource_key	VPC Endpoint Resource Key
resource_type	VPC Endpoint Resource Type
state	VPC Endpoint State
subnet_id	Subnet Id
subnet_name	Subnet Name
vpc_id	VPC Id
vpc_name	VPC Name

1.77.2 - 1.0

scpcli vpc vpc-endpoint show
--vpc_endpoint_id <value>

Description

Show VPC Endpoint.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
vpc_endpoint_id required	string	VPC Endpoint ID	-

Responses

Name	Description	Example
id	VPC Endpoint ID
account_id	Account ID
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description
endpoint_ip_address	VPC Endpoint IP Address
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	VPC Endpoint Name
resource_info	VPC Endpoint Resource Key Info
resource_key	VPC Endpoint Resource Key
resource_type	VPC Endpoint Resource Type
state	VPC Endpoint State
subnet_id	Subnet Id
subnet_name	Subnet Name
vpc_id	VPC Id
vpc_name	VPC Name

1.78 - Show VPC Peering

1.78.1 - 1.1

scpcli vpc vpc-peering show
--vpc_peering_id <value>

Description

Show VPC Peering.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Name	Type	Description	Example
vpc_peering_id required	string	VPC Peering ID	-

Responses

Name	Description	Example
id	VPC Peering ID
account_type	Account Type
approver_vpc_account_id	Approver VPC Account ID
approver_vpc_id	Approver VPC ID
approver_vpc_name	Approver VPC Name
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_id	Requester VPC Account ID
description	VPC Peering Description
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	VPC Peering Name
requester_vpc_account_id	Requester VPC Account ID
requester_vpc_id	Requester VPC ID
requester_vpc_name	Requester VPC Name
state	State

1.78.2 - 1.0

scpcli vpc vpc-peering show
--vpc_peering_id <value>

Description

Show VPC Peering.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Name	Type	Description	Example
vpc_peering_id required	string	VPC Peering ID	-

Responses

Name	Description	Example
id	VPC Peering ID
account_type	Account Type
approver_vpc_account_id	Approver VPC Account ID
approver_vpc_id	Approver VPC ID
approver_vpc_name	Approver VPC Name
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
delete_requester_account_id	Requester VPC Account ID
description	VPC Peering Description
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	VPC Peering Name
requester_vpc_account_id	Requester VPC Account ID
requester_vpc_id	Requester VPC ID
requester_vpc_name	Requester VPC Name
state	State