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

Return to the regular view of this page.

List Transit Gateways

1 - 1.3

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

Description

Get Transit Gateway list.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

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

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_connection_stateFirewall Connection StateINACTIVE
firewall_idsFirewall IDsbbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

2 - 1.2

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

Description

Get Transit Gateway list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

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

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_connection_stateFirewall Connection StateINACTIVE
firewall_idsFirewall IDsbbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

3 - 1.1

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

Description

Get Transit Gateway list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

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

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_idsFirewall IDsbbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse

4 - 1.0

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

Description

Get Transit Gateway list.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

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

Responses

NameDescriptionExample
idTransit Gateway IDfe860e0af0c04dcd8182b84f907f31f4
account_idAccount IDf1e6c81a2b054582878cb9724dc2ce9f
bandwidthTransit Gateway Port Bandwidth1
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
descriptionTransit Gateway DescriptionTransitGateway Description
firewall_idsFirewall IDsbbb93aca123f4bb2b2c0f206f4a86b2b,te140e0af0c04dcd8182b84f875f42f6
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameTransit Gateway NameTransitGatewayName
stateStateACTIVE
uplink_enabledUplink EnabledFalse