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

Return to the regular view of this page.

VPC

1: APIs

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 SAP Secondary Subnets

1.45.1: 1.1

1.46: List Subnets

1.46.1: 1.1
1.46.2: 1.0

1.47: List Transit Gateway Rules

1.47.1: 1.1
1.47.2: 1.0

1.48: List Transit Gateway VPC Connections

1.48.1: 1.1
1.48.2: 1.0

1.49: List Transit Gateways

1.49.1: 1.1
1.49.2: 1.0

1.50: List VPC Endpoint

1.50.1: 1.1
1.50.2: 1.0

1.51: List VPC Endpoint Connectable Resources

1.51.1: 1.1
1.51.2: 1.0

1.52: List VPC Peering

1.52.1: 1.1
1.52.2: 1.0

1.53: List VPC Peering Rules

1.53.1: 1.1
1.53.2: 1.0

1.54: List VPCs

1.54.1: 1.1
1.54.2: 1.0

1.55: Request PrivateLink Endpoint

1.55.1: 1.1

1.56: Set Internet Gateway

1.56.1: 1.1
1.56.2: 1.0

1.57: Set NAT Gateway

1.57.1: 1.1
1.57.2: 1.0

1.58: Set Port

1.58.1: 1.1
1.58.2: 1.0

1.59: Set Private NAT

1.59.1: 1.1
1.59.2: 1.0

1.60: Set PrivateLink Endpoint

1.60.1: 1.1

1.61: Set PrivateLink Service

1.61.1: 1.1

1.62: Set PublicIP

1.62.1: 1.1
1.62.2: 1.0

1.63: Set Subnet

1.63.1: 1.1
1.63.2: 1.0

1.64: Set Transit Gateway

1.64.1: 1.1
1.64.2: 1.0

1.65: Set VPC

1.65.1: 1.1
1.65.2: 1.0

1.66: Set VPC Endpoint

1.66.1: 1.1
1.66.2: 1.0

1.67: Set VPC Peering

1.67.1: 1.1
1.67.2: 1.0

1.68: Show Internet Gateway

1.68.1: 1.1
1.68.2: 1.0

1.69: Show NAT Gateway

1.69.1: 1.1
1.69.2: 1.0

1.70: Show Port

1.70.1: 1.1
1.70.2: 1.0

1.71: Show Private NAT

1.71.1: 1.1
1.71.2: 1.0

1.72: Show PrivateLink Endpoint

1.72.1: 1.1

1.73: Show PrivateLink Service

1.73.1: 1.1

1.74: Show PublicIP

1.74.1: 1.1
1.74.2: 1.0

1.75: Show Subnet

1.75.1: 1.1
1.75.2: 1.0

1.76: Show Transit Gateway

1.76.1: 1.1
1.76.2: 1.0

1.77: Show VPC

1.77.1: 1.1
1.77.2: 1.0

1.78: Show VPC Endpoint

1.78.1: 1.1
1.78.2: 1.0

1.79: Show VPC Peering

1.79.1: 1.1
1.79.2: 1.0

2: Models

2.1: ConnectedEndpointListResponse
2.2: ConnectedPrivateLinkEndpoint
2.3: InternetGateway
2.4: InternetGatewayCreateRequest
2.5: InternetGatewayListResponse
2.6: InternetGatewaySetRequest
2.7: InternetGatewayShowResponse
2.8: NatGateway
2.9: NatGatewayCreateRequest
2.10: NatGatewayListResponse
2.11: NatGatewaySetRequest
2.12: NatGatewayShowResponse
2.13: Port
2.14: PortCreateRequest
2.15: PortList
2.16: PortListResponse
2.17: PortSecurityGroup
2.18: PortSetRequest
2.19: PortShowResponse
2.20: PrivateLinkEndpoint
2.21: PrivateLinkEndpointApprovalRequest
2.22: PrivateLinkEndpointConnectionRequest
2.23: PrivateLinkEndpointCreateRequest
2.24: PrivateLinkEndpointDetail
2.25: PrivateLinkEndpointListResponse
2.26: PrivateLinkEndpointRequest
2.27: PrivateLinkEndpointSetRequest
2.28: PrivateLinkEndpointShowResponse
2.29: PrivateLinkEndpointSummary
2.30: PrivateLinkEndpointSummaryShowResponse
2.31: PrivateLinkService
2.32: PrivateLinkServiceCreateRequest
2.33: PrivateLinkServiceDetail
2.34: PrivateLinkServiceListResponse
2.35: PrivateLinkServiceSetRequest
2.36: PrivateLinkServiceShowResponse
2.37: PrivateNat
2.38: PrivateNatCreateRequest
2.39: PrivateNatIp
2.40: PrivateNatIpCreateRequest
2.41: PrivateNatIpListResponse
2.42: PrivateNatIpShowResponse
2.43: PrivateNatListResponse
2.44: PrivateNatSetRequest
2.45: PrivateNatShowResponse
2.46: Publicip
2.47: PublicipCreateRequest
2.48: PublicipListResponse
2.49: PublicipSetRequest
2.50: PublicipShowResponse
2.51: SapSecondarySubnet
2.52: SapSecondarySubnetListResponse
2.53: Subnet
2.54: SubnetCreateRequest
2.55: SubnetDetail
2.56: SubnetListResponse
2.57: SubnetSetRequest
2.58: SubnetShowResponse
2.59: Tag
2.60: TransitGateway
2.61: TransitGatewayCreateRequest
2.62: TransitGatewayListResponse
2.63: TransitGatewayRule
2.64: TransitGatewayRuleCreateRequest
2.65: TransitGatewayRuleListResponse
2.66: TransitGatewayRuleShowResponse
2.67: TransitGatewaySetRequest
2.68: TransitGatewayShowResponse
2.69: TransitGatewayVpcConnection
2.70: TransitGatewayVpcConnectionCreateRequest
2.71: TransitGatewayVpcConnectionListResponse
2.72: TransitGatewayVpcConnectionShowResponse
2.73: Vpc
2.74: VpcCreateRequest
2.75: VpcEndpoint
2.76: VpcEndpointConnectableResourceDetail
2.77: VpcEndpointConnectableResourceListResponse
2.78: VpcEndpointCreateRequest
2.79: VpcEndpointListResponse
2.80: VpcEndpointSetRequest
2.81: VpcEndpointShowResponse
2.82: VpcListResponse
2.83: VpcPeering
2.84: VpcPeeringApprovalRequest
2.85: VpcPeeringCreateRequest
2.86: VpcPeeringListResponse
2.87: VpcPeeringRule
2.88: VpcPeeringRuleCreateRequest
2.89: VpcPeeringRuleListResponse
2.90: VpcPeeringRuleShowResponse
2.91: VpcPeeringSetRequest
2.92: VpcPeeringShowResponse
2.93: VpcSetRequest
2.94: VpcShowResponse

Overview

Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.

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

Version

Version	Status	Supported Until
1.0	DEPRECATED	20251231
1.1	CURRENT	-

OpenAPI URL

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

Environment and Region List

environment	region
s	kr-west1
s	kr-east1
g	kr-south1
g	kr-south2
g	kr-south3
e	kr-west1
e	kr-east1

1 - APIs

1.1 - Approval VPC Peering

1.1.1 - 1.1

put /v1/vpc-peerings/{vpc_peering_id}/approval

Description

Approval VPC Peering.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example :	string	None
body	body required		VpcPeeringApprovalRequest

Responses

HTTP Code	Description	Schema
200	OK	VpcPeeringShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}/approval

Request header

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

Request body

{
    "type": "CREATE_APPROVE"
}

Example HTTP response

Response 200

{
    "vpc_peering": {
        "account_type": "SAME",
        "approver_vpc_account_id": "",
        "approver_vpc_id": "",
        "approver_vpc_name": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_requester_account_id": "",
        "description": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "requester_vpc_account_id": "",
        "requester_vpc_id": "",
        "requester_vpc_name": "",
        "state": "CREATING"
    }
}

1.2 - Approve PrivateLink Endpoint

1.2.1 - 1.1

put /v1/privatelink-endpoints/{privatelink_endpoint_id}/approval

Description

Approve PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example :	string	None
body	body required		PrivateLinkEndpointApprovalRequest

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkEndpointSummaryShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_id}/approval

Request header

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

Request body

{
    "type": "APPROVE"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "created_at": "2026-02-11T06:45:07.448Z",
        "id": "",
        "state": "REQUESTING"
    }
}

1.3 - Connect PrivateLink Endpoint

1.3.1 - 1.1

put /v1/privatelink-endpoints/{privatelink_endpoint_id}/connection

Description

Connect PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example :	string	None
body	body required		PrivateLinkEndpointConnectionRequest

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkEndpointSummaryShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_id}/connection

Request header

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

Request body

{
    "type": "DISCONNECT"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "created_at": "2026-02-11T06:45:07.468Z",
        "id": "",
        "state": "REQUESTING"
    }
}

1.4 - Create Internet Gateway

1.4.1 - 1.1

post /v1/internet-gateways

Description

Create Internet Gateway.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		InternetGatewayCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	InternetGatewayShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/internet-gateways

Request header

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

Request body

{
    "description": "",
    "firewall_enabled": false,
    "firewall_loggable": false,
    "tags": [],
    "type": "IGW",
    "vpc_id": ""
}

Example HTTP response

Response 202

{
    "internet_gateway": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "id": "",
        "loggable": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.4.2 - 1.0

post /v1/internet-gateways

Description

Create Internet Gateway.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		InternetGatewayCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	InternetGatewayShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/internet-gateways

Request header

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

Request body

{
    "description": "",
    "firewall_enabled": false,
    "firewall_loggable": false,
    "tags": [],
    "type": "IGW",
    "vpc_id": ""
}

Example HTTP response

Response 202

{
    "internet_gateway": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "id": "",
        "loggable": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.5 - Create NAT Gateway

1.5.1 - 1.1

post /v1/nat-gateways

Description

Create NAT Gateway.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		NatGatewayCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	NatGatewayShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/nat-gateways

Request header

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

Request body

{
    "description": "",
    "publicip_id": "",
    "subnet_id": "",
    "tags": []
}

Example HTTP response

Response 202

{
    "nat_gateway": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "nat_gateway_ip_address": "",
        "publicip_id": "",
        "state": "",
        "subnet_cidr": "",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.5.2 - 1.0

post /v1/nat-gateways

Description

Create NAT Gateway.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		NatGatewayCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	NatGatewayShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/nat-gateways

Request header

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

Request body

{
    "description": "",
    "publicip_id": "",
    "subnet_id": "",
    "tags": []
}

Example HTTP response

Response 202

{
    "nat_gateway": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "nat_gateway_ip_address": "",
        "publicip_id": "",
        "state": "",
        "subnet_cidr": "",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.6 - Create Port

1.6.1 - 1.1

post /v1/ports

Description

Create port.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		PortCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	PortShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/ports

Request header

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

Request body

{
    "description": "",
    "fixed_ip_address": "",
    "name": "",
    "security_groups": [],
    "subnet_id": "",
    "tags": []
}

Example HTTP response

Response 201

{
    "port": {
        "account_id": "",
        "attached_resource_id": "",
        "attached_resource_type": "",
        "created_at": "2026-02-11T06:45:07.048Z",
        "description": "",
        "fixed_ip_address": "",
        "id": "",
        "mac_address": "",
        "modified_at": "2026-02-11T06:45:07.048Z",
        "name": "",
        "security_groups": [
            {
                "id": "",
                "name": ""
            }
        ],
        "state": "",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.6.2 - 1.0

post /v1/ports

Description

Create port.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		PortCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	PortShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/ports

Request header

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

Request body

{
    "description": "",
    "fixed_ip_address": "",
    "name": "",
    "security_groups": [],
    "subnet_id": "",
    "tags": []
}

Example HTTP response

Response 201

{
    "port": {
        "account_id": "",
        "attached_resource_id": "",
        "attached_resource_type": "",
        "created_at": "2026-02-11T06:45:05.409Z",
        "description": "",
        "fixed_ip_address": "",
        "id": "",
        "mac_address": "",
        "modified_at": "2026-02-11T06:45:05.409Z",
        "name": "",
        "security_groups": [
            {
                "id": "",
                "name": ""
            }
        ],
        "state": "",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.7 - Create Private NAT

1.7.1 - 1.1

post /v1/private-nats

Description

Create Private NAT.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		PrivateNatCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	PrivateNatShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/private-nats

Request header

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

Request body

{
    "cidr": "",
    "description": "",
    "direct_connect_id": "",
    "name": "",
    "tags": []
}

Example HTTP response

Response 202

{
    "private_nat": {
        "account_id": "",
        "cidr": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "direct_connect_id": "",
        "direct_connect_name": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.7.2 - 1.0

post /v1/private-nats

Description

Create Private NAT.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		PrivateNatCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	PrivateNatShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/private-nats

Request header

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

Request body

{
    "cidr": "",
    "description": "",
    "direct_connect_id": "",
    "name": "",
    "tags": []
}

Example HTTP response

Response 202

{
    "private_nat": {
        "account_id": "",
        "cidr": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "direct_connect_id": "",
        "direct_connect_name": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.8 - Create Private NAT IP

1.8.1 - 1.1

post /v1/private-nats/{private_nat_id}/private-nat-ips

Description

Create Private NAT IP.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example :	string	None
body	body required		PrivateNatIpCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	PrivateNatIpShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}/private-nat-ips

Request header

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

Request body

{
    "ip_address": ""
}

Example HTTP response

Response 201

{
    "private_nat_ip": {
        "attached_resource_id": "",
        "attached_resource_name": "",
        "attached_resource_type": "VM",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "",
        "ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "private_nat_id": "",
        "state": "RESERVED"
    }
}

1.8.2 - 1.0

post /v1/private-nats/{private_nat_id}/private-nat-ips

Description

Create Private NAT IP.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example :	string	None
body	body required		PrivateNatIpCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	PrivateNatIpShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}/private-nat-ips

Request header

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

Request body

{
    "ip_address": ""
}

Example HTTP response

Response 201

{
    "private_nat_ip": {
        "attached_resource_id": "",
        "attached_resource_name": "",
        "attached_resource_type": "VM",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "",
        "ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "private_nat_id": "",
        "state": "RESERVED"
    }
}

1.9 - Create PrivateLink Endpoint

1.9.1 - 1.1

post /v1/privatelink-endpoints

Description

Create PrivateLink Endpoint.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		PrivateLinkEndpointCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	PrivateLinkEndpointShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/privatelink-endpoints

Request header

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

Request body

{
    "description": "",
    "endpoint_ip_address": "",
    "name": "",
    "privatelink_service_id": "",
    "security_group_ids": [],
    "subnet_id": "",
    "tags": []
}

Example HTTP response

Response 202

{
    "privatelink_endpoint": {
        "account_id": "",
        "approval_type": "MANUAL",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "endpoint_ip_address": "",
        "endpoint_ip_port_id": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "privatelink_service_id": "",
        "security_group_ids": [],
        "state": "REQUESTING",
        "subnet_id": "",
        "vpc_id": ""
    }
}

1.10 - Create PrivateLink Service

1.10.1 - 1.1

post /v1/privatelink-services

Description

Create PrivateLink Service.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		PrivateLinkServiceCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	PrivateLinkServiceShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/privatelink-services

Request header

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

Request body

{
    "approval_type": "MANUAL",
    "connected_resource_id": "",
    "connected_resource_ip_address": "",
    "connected_resource_type": "LB",
    "description": "",
    "high_speed_transfer": false,
    "name": "",
    "security_group_ids": [],
    "service_ip_address": "",
    "subnet_id": "",
    "tags": []
}

Example HTTP response

Response 202

{
    "privatelink_service": {
        "account_id": "",
        "approval_type": "MANUAL",
        "connected_resource_id": "",
        "connected_resource_ip_address": "",
        "connected_resource_name": "",
        "connected_resource_type": "LB",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "high_speed_transfer": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "security_group_ids": [],
        "service_ip_address": "",
        "service_ip_port_id": "",
        "state": "CREATING",
        "subnet_id": "",
        "vpc_id": ""
    }
}

1.11 - Create PublicIP

1.11.1 - 1.1

post /v1/publicips

Description

Create PublicIP.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		PublicipCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	PublicipShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/publicips

Request header

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

Request body

{
    "description": "",
    "tags": [],
    "type": "IGW"
}

Example HTTP response

Response 201

{
    "publicip": {
        "account_id": "",
        "attached_resource_id": "",
        "attached_resource_name": "",
        "attached_resource_type": "VM",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "RESERVED",
        "type": "IGW"
    }
}

1.11.2 - 1.0

post /v1/publicips

Description

Create PublicIP.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		PublicipCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	PublicipShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/publicips

Request header

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

Request body

{
    "description": "",
    "tags": [],
    "type": "IGW"
}

Example HTTP response

Response 201

{
    "publicip": {
        "account_id": "",
        "attached_resource_id": "",
        "attached_resource_name": "",
        "attached_resource_type": "VM",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "RESERVED",
        "type": "IGW"
    }
}

1.12 - Create Subnet

1.12.1 - 1.1

post /v1/subnets

Description

Create subnet.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		SubnetCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	SubnetShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/subnets

Request header

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

Request body

{
    "allocation_pools": "[{\"start\":\"192.167.1.2\", \"end\":\"192.167.1.100\"}]",
    "cidr": "192.167.1.0/24",
    "description": "Subnet Description",
    "dns_nameservers": "[\"1.1.1.1\", \"2.2.2.2\"]",
    "host_routes": "[{\"destination\":\"192.168.10.0/24\", \"nexthop\":\"192.168.10.0\"}]",
    "name": "subnetName",
    "tags": [],
    "type": "GENERAL",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "subnet": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "allocation_pools": [],
        "cidr": "192.167.1.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet Description",
        "dns_nameservers": [],
        "gateway_ip_address": "192.167.1.1",
        "host_routes": [],
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "subnetName",
        "state": "CREATING",
        "type": "GENERAL",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

1.12.2 - 1.0

post /v1/subnets

Description

Create subnet.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		SubnetCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	SubnetShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/subnets

Request header

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

Request body

{
    "allocation_pools": "[{\"start\":\"192.167.1.2\", \"end\":\"192.167.1.100\"}]",
    "cidr": "192.167.1.0/24",
    "description": "Subnet Description",
    "dns_nameservers": "[\"1.1.1.1\", \"2.2.2.2\"]",
    "host_routes": "[{\"destination\":\"192.168.10.0/24\", \"nexthop\":\"192.168.10.0\"}]",
    "name": "subnetName",
    "tags": [],
    "type": "GENERAL",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "subnet": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "allocation_pools": [],
        "cidr": "192.167.1.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet Description",
        "dns_nameservers": [],
        "gateway_ip_address": "192.167.1.1",
        "host_routes": [],
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "subnetName",
        "state": "CREATING",
        "type": "GENERAL",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

1.13 - Create Transit Gateway

1.13.1 - 1.1

post /v1/transit-gateways

Description

Create Transit Gateway.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		TransitGatewayCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	TransitGatewayShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/transit-gateways

Request header

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

Request body

{
    "description": "",
    "name": "",
    "tags": []
}

Example HTTP response

Response 202

{
    "transit_gateway": {
        "account_id": "",
        "bandwidth": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_ids": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "uplink_enabled": false
    }
}

1.13.2 - 1.0

post /v1/transit-gateways

Description

Create Transit Gateway.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		TransitGatewayCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	TransitGatewayShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/transit-gateways

Request header

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

Request body

{
    "description": "",
    "name": "",
    "tags": []
}

Example HTTP response

Response 202

{
    "transit_gateway": {
        "account_id": "",
        "bandwidth": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_ids": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "uplink_enabled": false
    }
}

1.14 - Create Transit Gateway Rule

1.14.1 - 1.1

post /v1/transit-gateways/{transit_gateway_id}/routing-rules

Description

Create Transit Gateway Rule.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None
body	body required		TransitGatewayRuleCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	TransitGatewayRuleShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/routing-rules

Request header

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

Request body

{
    "description": "",
    "destination_cidr": "",
    "destination_type": "VPC",
    "tgw_connection_vpc_id": ""
}

Example HTTP response

Response 202

{
    "transit_gateway_rule": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "destination_cidr": "",
        "destination_resource_id": "",
        "destination_resource_name": "",
        "destination_type": "VPC",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "source_resource_id": "",
        "source_resource_name": "",
        "source_type": "VPC",
        "state": "CREATING",
        "tgw_connection_vpc_id": "",
        "tgw_connection_vpc_name": ""
    }
}

1.14.2 - 1.0

post /v1/transit-gateways/{transit_gateway_id}/routing-rules

Description

Create Transit Gateway Rule.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None
body	body required		TransitGatewayRuleCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	TransitGatewayRuleShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/routing-rules

Request header

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

Request body

{
    "description": "",
    "destination_cidr": "",
    "destination_type": "VPC",
    "tgw_connection_vpc_id": ""
}

Example HTTP response

Response 202

{
    "transit_gateway_rule": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "destination_cidr": "",
        "destination_resource_id": "",
        "destination_resource_name": "",
        "destination_type": "VPC",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "source_resource_id": "",
        "source_resource_name": "",
        "source_type": "VPC",
        "state": "CREATING",
        "tgw_connection_vpc_id": "",
        "tgw_connection_vpc_name": ""
    }
}

1.15 - Create Transit Gateway VPC Connection

1.15.1 - 1.1

post /v1/transit-gateways/{transit_gateway_id}/vpc-connections

Description

Create Transit Gateway VPC Connection.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None
body	body required		TransitGatewayVpcConnectionCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	TransitGatewayVpcConnectionShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/vpc-connections

Request header

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

Request body

{
    "vpc_id": ""
}

Example HTTP response

Response 202

{
    "transit_gateway_vpc_connection": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "CREATING",
        "transit_gateway_id": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.15.2 - 1.0

post /v1/transit-gateways/{transit_gateway_id}/vpc-connections

Description

Create Transit Gateway VPC Connection.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None
body	body required		TransitGatewayVpcConnectionCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	TransitGatewayVpcConnectionShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/vpc-connections

Request header

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

Request body

{
    "vpc_id": ""
}

Example HTTP response

Response 202

{
    "transit_gateway_vpc_connection": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "CREATING",
        "transit_gateway_id": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.16 - Create VPC

1.16.1 - 1.1

post /v1/vpcs

Description

Create VPC.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		VpcCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	VpcShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpcs

Request header

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

Request body

{
    "cidr": "192.167.0.0/18",
    "description": "VPC Description",
    "name": "vpcName",
    "tags": []
}

Example HTTP response

Response 201

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/18",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "vpcDescription",
        "id": "7df8abb4912e4709b1cb237daccca7a8",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcName",
        "state": "CREATING"
    }
}

1.16.2 - 1.0

post /v1/vpcs

Description

Create VPC.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		VpcCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	VpcShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpcs

Request header

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

Request body

{
    "cidr": "192.167.0.0/18",
    "description": "VPC Description",
    "name": "vpcName",
    "tags": []
}

Example HTTP response

Response 201

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/18",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "vpcDescription",
        "id": "7df8abb4912e4709b1cb237daccca7a8",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcName",
        "state": "CREATING"
    }
}

1.17 - Create VPC Endpoint

1.17.1 - 1.1

post /v1/vpc-endpoints

Description

Create VPC Endpoint.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		VpcEndpointCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	VpcEndpointShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-endpoints

Request header

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

Request body

{
    "description": "",
    "endpoint_ip_address": "",
    "name": "",
    "resource_info": "",
    "resource_key": "",
    "resource_type": "FS",
    "subnet_id": "",
    "tags": [],
    "vpc_id": ""
}

Example HTTP response

Response 202

{
    "vpc_endpoint": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "endpoint_ip_address": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "resource_info": "",
        "resource_key": "",
        "resource_type": "FS",
        "state": "CREATING",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.17.2 - 1.0

post /v1/vpc-endpoints

Description

Create VPC Endpoint.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		VpcEndpointCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	VpcEndpointShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-endpoints

Request header

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

Request body

{
    "description": "",
    "endpoint_ip_address": "",
    "name": "",
    "resource_info": "",
    "resource_key": "",
    "resource_type": "FS",
    "subnet_id": "",
    "tags": [],
    "vpc_id": ""
}

Example HTTP response

Response 202

{
    "vpc_endpoint": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "endpoint_ip_address": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "resource_info": "",
        "resource_key": "",
        "resource_type": "FS",
        "state": "CREATING",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.18 - Create VPC Peering

1.18.1 - 1.1

post /v1/vpc-peerings

Description

Create VPC Peering.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		VpcPeeringCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	VpcPeeringShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-peerings

Request header

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

Request body

{
    "approver_vpc_account_id": "",
    "approver_vpc_id": "",
    "description": "",
    "name": "",
    "requester_vpc_id": "",
    "tags": []
}

Example HTTP response

Response 202

{
    "vpc_peering": {
        "account_type": "SAME",
        "approver_vpc_account_id": "",
        "approver_vpc_id": "",
        "approver_vpc_name": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_requester_account_id": "",
        "description": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "requester_vpc_account_id": "",
        "requester_vpc_id": "",
        "requester_vpc_name": "",
        "state": "CREATING"
    }
}

1.18.2 - 1.0

post /v1/vpc-peerings

Description

Create VPC Peering.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		VpcPeeringCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	VpcPeeringShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-peerings

Request header

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

Request body

{
    "approver_vpc_account_id": "",
    "approver_vpc_id": "",
    "description": "",
    "name": "",
    "requester_vpc_id": "",
    "tags": []
}

Example HTTP response

Response 202

{
    "vpc_peering": {
        "account_type": "SAME",
        "approver_vpc_account_id": "",
        "approver_vpc_id": "",
        "approver_vpc_name": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_requester_account_id": "",
        "description": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "requester_vpc_account_id": "",
        "requester_vpc_id": "",
        "requester_vpc_name": "",
        "state": "CREATING"
    }
}

1.19 - Create Vpc Peering Rule

1.19.1 - 1.1

post /v1/vpc-peerings/{vpc_peering_id}/routing-rules

Description

Create a VPC Peering Rule.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example :	string	None
body	body required		VpcPeeringRuleCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	VpcPeeringRuleShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}/routing-rules

Request header

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

Request body

{
    "destination_cidr": "",
    "destination_vpc_type": "REQUESTER_VPC",
    "tags": []
}

Example HTTP response

Response 202

{
    "vpc_peering_rule": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "destination_cidr": "",
        "destination_vpc_id": "",
        "destination_vpc_name": "",
        "destination_vpc_type": "REQUESTER_VPC",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "source_vpc_id": "",
        "source_vpc_name": "",
        "source_vpc_type": "REQUESTER_VPC",
        "state": "CREATING",
        "vpc_peering_id": ""
    }
}

1.19.2 - 1.0

post /v1/vpc-peerings/{vpc_peering_id}/routing-rules

Description

Create a VPC Peering Rule.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example :	string	None
body	body required		VpcPeeringRuleCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	VpcPeeringRuleShowResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}/routing-rules

Request header

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

Request body

{
    "destination_cidr": "",
    "destination_vpc_type": "REQUESTER_VPC",
    "tags": []
}

Example HTTP response

Response 202

{
    "vpc_peering_rule": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "destination_cidr": "",
        "destination_vpc_id": "",
        "destination_vpc_name": "",
        "destination_vpc_type": "REQUESTER_VPC",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "source_vpc_id": "",
        "source_vpc_name": "",
        "source_vpc_type": "REQUESTER_VPC",
        "state": "CREATING",
        "vpc_peering_id": ""
    }
}

1.20 - Delete Internet Gateway

1.20.1 - 1.1

delete /v1/internet-gateways/{internet_gateway_id}

Description

Delete Internet Gateway.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	internet_gateway_id required	Internet Gateway ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/internet-gateways/{internet_gateway_id}

Request header

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

Example HTTP response

Response 202

1.20.2 - 1.0

delete /v1/internet-gateways/{internet_gateway_id}

Description

Delete Internet Gateway.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	internet_gateway_id required	Internet Gateway ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/internet-gateways/{internet_gateway_id}

Request header

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

Example HTTP response

Response 202

1.21 - Delete NAT Gateway

1.21.1 - 1.1

delete /v1/nat-gateways/{nat_gateway_id}

Description

Delete NAT Gateway.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	nat_gateway_id required	NAT Gateway ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/nat-gateways/{nat_gateway_id}

Request header

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

Example HTTP response

Response 202

1.21.2 - 1.0

delete /v1/nat-gateways/{nat_gateway_id}

Description

Delete NAT Gateway.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	nat_gateway_id required	NAT Gateway ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/nat-gateways/{nat_gateway_id}

Request header

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

Example HTTP response

Response 202

1.22 - Delete Port

1.22.1 - 1.1

delete /v1/ports/{port_id}

Description

Delete port.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	port_id required	Port ID Example :	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/ports/{port_id}

Request header

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

Example HTTP response

Response 204

1.22.2 - 1.0

delete /v1/ports/{port_id}

Description

Delete port.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	port_id required	Port ID Example :	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/ports/{port_id}

Request header

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

Example HTTP response

Response 204

1.23 - Delete Private NAT

1.23.1 - 1.1

delete /v1/private-nats/{private_nat_id}

Description

Delete Private NAT.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}

Request header

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

Example HTTP response

Response 202

1.23.2 - 1.0

delete /v1/private-nats/{private_nat_id}

Description

Delete Private NAT.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}

Request header

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

Example HTTP response

Response 202

1.24 - Delete Private NAT IP

1.24.1 - 1.1

delete /v1/private-nats/{private_nat_id}/private-nat-ips/{private_nat_ip_id}

Description

Delete Private NAT IP.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example :	string	None
path	private_nat_ip_id required	Private NAT IP ID Example :	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}/private-nat-ips/{private_nat_ip_id}

Request header

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

Example HTTP response

Response 204

1.24.2 - 1.0

delete /v1/private-nats/{private_nat_id}/private-nat-ips/{private_nat_ip_id}

Description

Delete Private NAT IP.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example :	string	None
path	private_nat_ip_id required	Private NAT IP ID Example :	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}/private-nat-ips/{private_nat_ip_id}

Request header

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

Example HTTP response

Response 204

1.25 - Delete PrivateLink Endpoint

1.25.1 - 1.1

delete /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

Delete PrivateLink Endpoint.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_id}

Request header

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

Example HTTP response

Response 202

1.26 - Delete PrivateLink Service

1.26.1 - 1.1

delete /v1/privatelink-services/{privatelink_service_id}

Description

Delete PrivateLink Service.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_service_id required	PrivateLink Service ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/privatelink-services/{privatelink_service_id}

Request header

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

Example HTTP response

Response 202

1.27 - Delete PublicIP

1.27.1 - 1.1

delete /v1/publicips/{publicip_id}

Description

Delete PublicIP.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	publicip_id required	PublicIP ID Example :	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/publicips/{publicip_id}

Request header

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

Example HTTP response

Response 204

1.27.2 - 1.0

delete /v1/publicips/{publicip_id}

Description

Delete PublicIP.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	publicip_id required	PublicIP ID Example :	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/publicips/{publicip_id}

Request header

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

Example HTTP response

Response 204

1.28 - Delete Subnet

1.28.1 - 1.1

delete /v1/subnets/{subnet_id}

Description

Delete subnet.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	subnet_id required	Subnet Id Example : `023c57b14f11483689338d085e061492`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/subnets/{subnet_id}

Request header

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

Example HTTP response

Response 202

1.28.2 - 1.0

delete /v1/subnets/{subnet_id}

Description

Delete subnet.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	subnet_id required	Subnet Id Example : `023c57b14f11483689338d085e061492`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/subnets/{subnet_id}

Request header

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

Example HTTP response

Response 202

1.29 - Delete Transit Gateway

1.29.1 - 1.1

delete /v1/transit-gateways/{transit_gateway_id}

Description

Delete Transit Gateway.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}

Request header

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

Example HTTP response

Response 202

1.29.2 - 1.0

delete /v1/transit-gateways/{transit_gateway_id}

Description

Delete Transit Gateway.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}

Request header

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

Example HTTP response

Response 202

1.30 - Delete Transit Gateway Rule

1.30.1 - 1.1

delete /v1/transit-gateways/{transit_gateway_id}/routing-rules/{routing_rule_id}

Description

Delete Transit Gateway Rule.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None
path	routing_rule_id required	Routing Rule ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/routing-rules/{routing_rule_id}

Request header

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

Example HTTP response

Response 202

1.30.2 - 1.0

delete /v1/transit-gateways/{transit_gateway_id}/routing-rules/{routing_rule_id}

Description

Delete Transit Gateway Rule.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None
path	routing_rule_id required	Routing Rule ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/routing-rules/{routing_rule_id}

Request header

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

Example HTTP response

Response 202

1.31 - Delete Transit Gateway VPC Connection

1.31.1 - 1.1

delete /v1/transit-gateways/{transit_gateway_id}/vpc-connections/{vpc_connection_id}

Description

Delete Transit Gateway VPC Connection.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None
path	vpc_connection_id required	Transit Gateway VPC Connection ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/vpc-connections/{vpc_connection_id}

Request header

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

Example HTTP response

Response 202

1.31.2 - 1.0

delete /v1/transit-gateways/{transit_gateway_id}/vpc-connections/{vpc_connection_id}

Description

Delete Transit Gateway VPC Connection.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None
path	vpc_connection_id required	Transit Gateway VPC Connection ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/vpc-connections/{vpc_connection_id}

Request header

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

Example HTTP response

Response 202

1.32 - Delete VPC

1.32.1 - 1.1

delete /v1/vpcs/{vpc_id}

Description

Delete VPC.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_id required	VPC Id Example :	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/vpcs/{vpc_id}

Request header

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

Example HTTP response

Response 204

1.32.2 - 1.0

delete /v1/vpcs/{vpc_id}

Description

Delete VPC.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_id required	VPC Id Example :	string	None

Responses

HTTP Code	Description	Schema
204	No Content	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/vpcs/{vpc_id}

Request header

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

Example HTTP response

Response 204

1.33 - Delete VPC Endpoint

1.33.1 - 1.1

delete /v1/vpc-endpoints/{vpc_endpoint_id}

Description

Delete VPC Endpoint.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_endpoint_id required	VPC Endpoint ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/vpc-endpoints/{vpc_endpoint_id}

Request header

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

Example HTTP response

Response 202

1.33.2 - 1.0

delete /v1/vpc-endpoints/{vpc_endpoint_id}

Description

Delete VPC Endpoint.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_endpoint_id required	VPC Endpoint ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/vpc-endpoints/{vpc_endpoint_id}

Request header

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

Example HTTP response

Response 202

1.34 - Delete VPC Peering

1.34.1 - 1.1

delete /v1/vpc-peerings/{vpc_peering_id}

Description

Delete VPC Peering.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}

Request header

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

Example HTTP response

Response 202

1.34.2 - 1.0

delete /v1/vpc-peerings/{vpc_peering_id}

Description

Delete VPC Peering.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}

Request header

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

Example HTTP response

Response 202

1.35 - Delete VPC Peering Rule

1.35.1 - 1.1

delete /v1/vpc-peerings/{vpc_peering_id}/routing-rules/{routing_rule_id}

Description

Delete a VPC Peering Rule.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example :	string	None
path	routing_rule_id required	Routing Rule ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}/routing-rules/{routing_rule_id}

Request header

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

Example HTTP response

Response 202

1.35.2 - 1.0

delete /v1/vpc-peerings/{vpc_peering_id}/routing-rules/{routing_rule_id}

Description

Delete a VPC Peering Rule.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example :	string	None
path	routing_rule_id required	Routing Rule ID Example :	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}/routing-rules/{routing_rule_id}

Request header

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

Example HTTP response

Response 202

1.36 - List Connected PrivateLink Endpoints

1.36.1 - 1.1

get /v1/privatelink-services/{privatelink_service_id}/connected-endpoints

Description

Get Connected PrivateLink Endpoint List.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_service_id required	PrivateLink Service ID Example :	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	ConnectedEndpointListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/privatelink-services/{privatelink_service_id}/connected-endpoints

Request header

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

Example HTTP response

Response 200

{
    "connected_privatelink_endpoints": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "privatelink_service_id": "",
            "state": "REQUESTING"
        }
    ],
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.37 - List Internet Gateways

1.37.1 - 1.1

get /v1/internet-gateways

Description

Get Internet Gateway list.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	limit Example : `20`	any of [integer, null]	None
query	marker optional	marker Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	Internet Gateway ID Example :	any of [string, null]	None
query	name optional	Internet Gateway Name Example :	any of [string, null]	None
query	type optional	Internet Gateway Type Example :	enum (IGW, GGW, SIGW)
query	state optional	State Example :	string
query	vpc_id optional	VPC Id Example :	any of [string, null]
query	vpc_name optional	VPC Name Example :	any of [string, null]

Responses

HTTP Code	Description	Schema
200	OK	InternetGatewayListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/internet-gateways

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "internet_gateways": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "firewall_id": "",
            "id": "",
            "loggable": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "state": "CREATING",
            "type": "IGW",
            "vpc_id": "",
            "vpc_name": ""
        }
    ],
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

1.37.2 - 1.0

get /v1/internet-gateways

Description

Get Internet Gateway list.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	limit Example : `20`	any of [integer, null]	None
query	marker optional	marker Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	Internet Gateway ID Example :	any of [string, null]	None
query	name optional	Internet Gateway Name Example :	any of [string, null]	None
query	type optional	Internet Gateway Type Example :	enum (IGW, GGW, SIGW)
query	state optional	State Example :	string
query	vpc_id optional	VPC Id Example :	any of [string, null]
query	vpc_name optional	VPC Name Example :	any of [string, null]

Responses

HTTP Code	Description	Schema
200	OK	InternetGatewayListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/internet-gateways

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "internet_gateways": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "firewall_id": "",
            "id": "",
            "loggable": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "state": "CREATING",
            "type": "IGW",
            "vpc_id": "",
            "vpc_name": ""
        }
    ],
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

1.38 - List NAT Gateways

1.38.1 - 1.1

get /v1/nat-gateways

Description

Get NAT Gateway list.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	limit Example : `20`	any of [integer, null]	None
query	marker optional	marker Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	NAT Gateway Name Example :	any of [string, null]	None
query	vpc_id optional	VPC Id Example :	any of [string, null]	None
query	vpc_name optional	VPC Name Example :	any of [string, null]	None
query	subnet_id optional	Subnet Id Example :	any of [string, null]	None
query	subnet_name optional	Subnet Name Example :	any of [string, null]	None
query	nat_gateway_ip_address optional	NAT Gateway IP Address Example :	any of [string, null]	None
query	state optional	NAT Gateway State Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	NatGatewayListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/nat-gateways

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "nat_gateways": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "nat_gateway_ip_address": "",
            "publicip_id": "",
            "state": "",
            "subnet_cidr": "",
            "subnet_id": "",
            "subnet_name": "",
            "vpc_id": "",
            "vpc_name": ""
        }
    ]
}

1.38.2 - 1.0

get /v1/nat-gateways

Description

Get NAT Gateway list.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	limit Example : `20`	any of [integer, null]	None
query	marker optional	marker Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	NAT Gateway Name Example :	any of [string, null]	None
query	vpc_id optional	VPC Id Example :	any of [string, null]	None
query	vpc_name optional	VPC Name Example :	any of [string, null]	None
query	subnet_id optional	Subnet Id Example :	any of [string, null]	None
query	subnet_name optional	Subnet Name Example :	any of [string, null]	None
query	nat_gateway_ip_address optional	NAT Gateway IP Address Example :	any of [string, null]	None
query	state optional	NAT Gateway State Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	NatGatewayListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/nat-gateways

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "nat_gateways": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "nat_gateway_ip_address": "",
            "publicip_id": "",
            "state": "",
            "subnet_cidr": "",
            "subnet_id": "",
            "subnet_name": "",
            "vpc_id": "",
            "vpc_name": ""
        }
    ]
}

1.39 - List Ports

1.39.1 - 1.1

get /v1/ports

Description

Get port list.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	Port Limit Example :	any of [integer, null]	None
query	marker optional	Port Marker Example :	any of [string, null]	None
query	sort optional	Port Sort Example :	any of [string, null]	None
query	name optional	Port Name Example :	any of [string, null]	None
query	subnet_id optional	Subnet Id Example :	any of [string, null]	None
query	subnet_name optional	Subnet Name Example :	any of [string, null]	None
query	id optional	Port ID Example :	any of [string, null]	None
query	attached_resource_id optional	Connected resource ID Example :	any of [string, null]	None
query	fixed_ip_address optional	Fixed IP Example :	any of [string, null]	None
query	mac_address optional	MAC Address Example :	any of [string, null]	None
query	state optional	State Example :	any of [string, null]	None
query	security_groups optional	Security Group List Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	PortListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/ports

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "ports": [
        {
            "account_id": "",
            "attached_resource_id": "",
            "attached_resource_type": "",
            "created_at": "2026-02-11T06:45:07.029Z",
            "description": "",
            "fixed_ip_address": "",
            "id": "",
            "mac_address": "",
            "modified_at": "2026-02-11T06:45:07.029Z",
            "name": "",
            "state": "",
            "subnet_id": "",
            "subnet_name": "",
            "vpc_id": "",
            "vpc_name": ""
        }
    ]
}

1.39.2 - 1.0

get /v1/ports

Description

Get port list.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	Port Limit Example :	any of [integer, null]	None
query	marker optional	Port Marker Example :	any of [string, null]	None
query	sort optional	Port Sort Example :	any of [string, null]	None
query	name optional	Port Name Example :	any of [string, null]	None
query	subnet_id optional	Subnet Id Example :	any of [string, null]	None
query	subnet_name optional	Subnet Name Example :	any of [string, null]	None
query	id optional	Port ID Example :	any of [string, null]	None
query	attached_resource_id optional	Connected resource ID Example :	any of [string, null]	None
query	fixed_ip_address optional	Fixed IP Example :	any of [string, null]	None
query	mac_address optional	MAC Address Example :	any of [string, null]	None
query	state optional	State Example :	any of [string, null]	None
query	security_groups optional	Security Group List Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	PortListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/ports

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "ports": [
        {
            "account_id": "",
            "attached_resource_id": "",
            "attached_resource_type": "",
            "created_at": "2026-02-11T06:45:05.389Z",
            "description": "",
            "fixed_ip_address": "",
            "id": "",
            "mac_address": "",
            "modified_at": "2026-02-11T06:45:05.389Z",
            "name": "",
            "state": "",
            "subnet_id": "",
            "subnet_name": "",
            "vpc_id": "",
            "vpc_name": ""
        }
    ]
}

1.40 - List Private NAT

1.40.1 - 1.1

get /v1/private-nats

Description

Get Private NAT list.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Private NAT Name Example :	any of [string, null]	None
query	cidr optional	Private NAT IP range Example :	any of [string, null]	None
query	vpc_id optional	VPC Id Example :	any of [string, null]	None
query	vpc_name optional	VPC Name Example :	any of [string, null]	None
query	direct_connect_id optional	Direct Connect ID Example :	any of [string, null]	None
query	direct_connect_name optional	Direct Connect Name Example :	any of [string, null]	None
query	state optional	Private NAT State Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateNatListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/private-nats

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_nats": [
        {
            "account_id": "",
            "cidr": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "direct_connect_id": "",
            "direct_connect_name": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "state": "CREATING",
            "vpc_id": "",
            "vpc_name": ""
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.40.2 - 1.0

get /v1/private-nats

Description

Get Private NAT list.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Private NAT Name Example :	any of [string, null]	None
query	cidr optional	Private NAT IP range Example :	any of [string, null]	None
query	vpc_id optional	VPC Id Example :	any of [string, null]	None
query	vpc_name optional	VPC Name Example :	any of [string, null]	None
query	direct_connect_id optional	Direct Connect ID Example :	any of [string, null]	None
query	direct_connect_name optional	Direct Connect Name Example :	any of [string, null]	None
query	state optional	Private NAT State Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateNatListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/private-nats

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_nats": [
        {
            "account_id": "",
            "cidr": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "direct_connect_id": "",
            "direct_connect_name": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "state": "CREATING",
            "vpc_id": "",
            "vpc_name": ""
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.41 - List Private NAT IP

1.41.1 - 1.1

get /v1/private-nats/{private_nat_id}/private-nat-ips

Description

Get Private NAT IP list.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example :	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	ip_address optional	Private NAT IP Address Example :	any of [string, null]	None
query	state optional	Private NAT IP State Example :	any of [enum (RESERVED, ATTACHED, DELETED), null]	None
query	attached_resource_type optional	Private NAT IP Attached Resource Type Example :	any of [enum (VM, BM), null]	None
query	attached_resource_id optional	Private NAT IP Attached Resource ID Example :	any of [string, null]	None
query	attached_resource_name optional	Private NAT IP Attached Resource Name Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateNatIpListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}/private-nat-ips

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_nat_ips": [
        {
            "attached_resource_id": "",
            "attached_resource_name": "",
            "attached_resource_type": "VM",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "",
            "ip_address": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "private_nat_id": "",
            "state": "RESERVED"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.41.2 - 1.0

get /v1/private-nats/{private_nat_id}/private-nat-ips

Description

Get Private NAT IP list.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example :	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	ip_address optional	Private NAT IP Address Example :	any of [string, null]	None
query	state optional	Private NAT IP State Example :	any of [enum (RESERVED, ATTACHED, DELETED), null]	None
query	attached_resource_type optional	Private NAT IP Attached Resource Type Example :	any of [enum (VM, BM), null]	None
query	attached_resource_id optional	Private NAT IP Attached Resource ID Example :	any of [string, null]	None
query	attached_resource_name optional	Private NAT IP Attached Resource Name Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateNatIpListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}/private-nat-ips

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_nat_ips": [
        {
            "attached_resource_id": "",
            "attached_resource_name": "",
            "attached_resource_type": "VM",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "",
            "ip_address": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "private_nat_id": "",
            "state": "RESERVED"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.42 - List PrivateLink Endpoint

1.42.1 - 1.1

get /v1/privatelink-endpoints

Description

Get PrivateLink Endpoint List.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	PrivateLink Endpoint ID Example :	any of [string, null]	None
query	name optional	PrivateLink Endpoint Name Example :	any of [string, null]	None
query	vpc_id optional	VPC Id Example :	any of [string, null]	None
query	subnet_id optional	Subnet Id Example :	any of [string, null]	None
query	privatelink_service_id optional	PrivateLink Service ID Example :	any of [string, null]	None
query	endpoint_ip_address optional	Endpoint IP Address Example :	any of [string, null]	None
query	state optional	PrivateLink Endpoint State Example :	any of [enum (REQUESTING, CREATING, REJECTED, CANCELED, ACTIVE, DISCONNECTED, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkEndpointListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/privatelink-endpoints

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "privatelink_endpoints": [
        {
            "account_id": "",
            "approval_type": "MANUAL",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "endpoint_ip_address": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "privatelink_service_id": "",
            "state": "REQUESTING",
            "subnet_id": "",
            "vpc_id": ""
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.43 - List PrivateLink Service

1.43.1 - 1.1

get /v1/privatelink-services

Description

Get PrivateLink Service List.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	PrivateLink Service ID Example :	any of [string, null]	None
query	name optional	PrivateLink Service Name Example :	any of [string, null]	None
query	vpc_id optional	VPC Id Example :	any of [string, null]	None
query	subnet_id optional	Subnet Id Example :	any of [string, null]	None
query	service_ip_address optional	Service IP Address Example :	any of [string, null]	None
query	connected_resource_id optional	Connected Resource ID Example :	any of [string, null]	None
query	connected_resource_type optional	Connected Resource Type Example :	any of [string, null]	None
query	connected_resource_name optional	Connected Resource Name Example :	any of [string, null]	None
query	connected_resource_ip_address optional	Connected Resource IP Address Example :	any of [string, null]	None
query	state optional	PrivateLink Service State Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkServiceListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/privatelink-services

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "privatelink_services": [
        {
            "account_id": "",
            "approval_type": "MANUAL",
            "connected_resource_id": "",
            "connected_resource_ip_address": "",
            "connected_resource_name": "",
            "connected_resource_type": "LB",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "service_ip_address": "",
            "state": "CREATING",
            "subnet_id": "",
            "vpc_id": ""
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.44 - List PublicIPs

1.44.1 - 1.1

get /v1/publicips

Description

Get PublicIP list.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	limit Example : `20`	any of [integer, null]	None
query	marker optional	marker Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	ip_address optional	IP Address Example :	any of [string, null]	None
query	state optional	PublicIP State Example :	any of [string, null]	None
query	attached_resource_type optional	PublicIP Attached Resource Type Example :	any of [string, null]	None
query	attached_resource_id optional	PublicIP Attached Resource ID Example :	any of [string, null]	None
query	attached_resource_name optional	PublicIP Attached Resource Name Example :	any of [string, null]	None
query	vpc_id optional	VPC Id Example :	any of [string, null]	None
query	type optional	PublicIP Type Example :	any of [enum (IGW, GGW, SIGW), null]	None

Responses

HTTP Code	Description	Schema
200	OK	PublicipListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/publicips

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "publicips": [
        {
            "account_id": "",
            "attached_resource_id": "",
            "attached_resource_name": "",
            "attached_resource_type": "VM",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "id": "",
            "ip_address": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "RESERVED",
            "type": "IGW"
        }
    ]
}

1.44.2 - 1.0

get /v1/publicips

Description

Get PublicIP list.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	limit Example : `20`	any of [integer, null]	None
query	marker optional	marker Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	ip_address optional	IP Address Example :	any of [string, null]	None
query	state optional	PublicIP State Example :	any of [string, null]	None
query	attached_resource_type optional	PublicIP Attached Resource Type Example :	any of [string, null]	None
query	attached_resource_id optional	PublicIP Attached Resource ID Example :	any of [string, null]	None
query	attached_resource_name optional	PublicIP Attached Resource Name Example :	any of [string, null]	None
query	vpc_id optional	VPC Id Example :	any of [string, null]	None
query	type optional	PublicIP Type Example :	any of [enum (IGW, GGW, SIGW), null]	None

Responses

HTTP Code	Description	Schema
200	OK	PublicipListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/publicips

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "publicips": [
        {
            "account_id": "",
            "attached_resource_id": "",
            "attached_resource_name": "",
            "attached_resource_type": "VM",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "id": "",
            "ip_address": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "RESERVED",
            "type": "IGW"
        }
    ]
}

1.45 - List SAP Secondary Subnets

1.45.1 - 1.1

get /v1/subnets/{subnet_id}/sap-secondary-subnets

Description

List SAP Secondary Subnets

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	subnet_id required	Subnet Id Example : `023c57b14f11483689338d085e061492`	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	SapSecondarySubnetListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/subnets/{subnet_id}/sap-secondary-subnets

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "secondary_subnets": [
        {
            "account_id": "",
            "cidr": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "ACTIVE",
            "subnet_id": "",
            "vlan_no_id": "",
            "vpc_id": ""
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.46 - List Subnets

1.46.1 - 1.1

get /v1/subnets

Description

Get subnet list.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	limit Example : `20`	any of [integer, null]	None
query	marker optional	marker Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	Subnet Id Example : `023c57b14f11483689338d085e061492`	string
query	name optional	Subnet Name Example : `subnetName`	string
query	type optional	Subnet Type Example :	any of [enum (GENERAL, LOCAL, VPC_ENDPOINT), array[enum (GENERAL, LOCAL, VPC_ENDPOINT)]]
query	state optional	State Example :	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
query	vpc_id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	string
query	vpc_name optional	VPC Name Example : `vpcName`	string

Responses

HTTP Code	Description	Schema
200	OK	SubnetListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/subnets

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "subnets": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "cidr": "192.167.1.0/24",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "gateway_ip_address": "192.167.1.1",
            "id": "023c57b14f11483689338d085e061492",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "subnetName",
            "state": "CREATING",
            "type": "GENERAL",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

1.46.2 - 1.0

get /v1/subnets

Description

Get subnet list.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	limit Example : `20`	any of [integer, null]	None
query	marker optional	marker Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	Subnet Id Example : `023c57b14f11483689338d085e061492`	string
query	name optional	Subnet Name Example : `subnetName`	string
query	type optional	Subnet Type Example :	any of [enum (GENERAL, LOCAL, VPC_ENDPOINT), array[enum (GENERAL, LOCAL, VPC_ENDPOINT)]]
query	state optional	State Example :	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
query	vpc_id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	string
query	vpc_name optional	VPC Name Example : `vpcName`	string

Responses

HTTP Code	Description	Schema
200	OK	SubnetListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/subnets

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "subnets": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "cidr": "192.167.1.0/24",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "gateway_ip_address": "192.167.1.1",
            "id": "023c57b14f11483689338d085e061492",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "subnetName",
            "state": "CREATING",
            "type": "GENERAL",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

1.47 - List Transit Gateway Rules

1.47.1 - 1.1

get /v1/transit-gateways/{transit_gateway_id}/routing-rules

Description

Get Transit Gateway Rule list.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	Routing Rule ID Example :	any of [string, null]	None
query	tgw_connection_vpc_id optional	VPC ID Connected to Transit Gateway. Example :	any of [string, null]	None
query	tgw_connection_vpc_name optional	VPC Name Connected to Transit Gateway. Example :	any of [string, null]	None
query	source_type optional	Source Type Example :	enum (VPC, TGW)	None
query	destination_type optional	Destination Type Example :	enum (VPC, TGW)	None
query	destination_cidr optional	Destination CIDR Example :	any of [string, null]	None
query	state optional	State Example :	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)	None

Responses

HTTP Code	Description	Schema
200	OK	TransitGatewayRuleListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/routing-rules

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "transit_gateway_rules": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "destination_cidr": "",
            "destination_resource_id": "",
            "destination_resource_name": "",
            "destination_type": "VPC",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "source_resource_id": "",
            "source_resource_name": "",
            "source_type": "VPC",
            "state": "CREATING",
            "tgw_connection_vpc_id": "",
            "tgw_connection_vpc_name": ""
        }
    ]
}

1.47.2 - 1.0

get /v1/transit-gateways/{transit_gateway_id}/routing-rules

Description

Get Transit Gateway Rule list.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	Routing Rule ID Example :	any of [string, null]	None
query	tgw_connection_vpc_id optional	VPC ID Connected to Transit Gateway. Example :	any of [string, null]	None
query	tgw_connection_vpc_name optional	VPC Name Connected to Transit Gateway. Example :	any of [string, null]	None
query	source_type optional	Source Type Example :	enum (VPC, TGW)	None
query	destination_type optional	Destination Type Example :	enum (VPC, TGW)	None
query	destination_cidr optional	Destination CIDR Example :	any of [string, null]	None
query	state optional	State Example :	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)	None

Responses

HTTP Code	Description	Schema
200	OK	TransitGatewayRuleListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/routing-rules

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "transit_gateway_rules": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "destination_cidr": "",
            "destination_resource_id": "",
            "destination_resource_name": "",
            "destination_type": "VPC",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "source_resource_id": "",
            "source_resource_name": "",
            "source_type": "VPC",
            "state": "CREATING",
            "tgw_connection_vpc_id": "",
            "tgw_connection_vpc_name": ""
        }
    ]
}

1.48 - List Transit Gateway VPC Connections

1.48.1 - 1.1

get /v1/transit-gateways/{transit_gateway_id}/vpc-connections

Description

Get Transit Gateway VPC Connection list.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	Transit Gateway VPC Connection ID Example :	any of [string, null]	None
query	vpc_id optional	VPC Id Example :	any of [string, null]	None
query	vpc_name optional	VPC Name Example :	any of [string, null]	None
query	state optional	State Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	TransitGatewayVpcConnectionListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/vpc-connections

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "transit_gateway_vpc_connections": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "CREATING",
            "transit_gateway_id": "",
            "vpc_id": "",
            "vpc_name": ""
        }
    ]
}

1.48.2 - 1.0

get /v1/transit-gateways/{transit_gateway_id}/vpc-connections

Description

Get Transit Gateway VPC Connection list.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	Transit Gateway VPC Connection ID Example :	any of [string, null]	None
query	vpc_id optional	VPC Id Example :	any of [string, null]	None
query	vpc_name optional	VPC Name Example :	any of [string, null]	None
query	state optional	State Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	TransitGatewayVpcConnectionListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/vpc-connections

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "transit_gateway_vpc_connections": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "CREATING",
            "transit_gateway_id": "",
            "vpc_id": "",
            "vpc_name": ""
        }
    ]
}

1.49 - List Transit Gateways

1.49.1 - 1.1

get /v1/transit-gateways

Description

Get Transit Gateway list.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	Transit Gateway ID Example :	any of [string, null]	None
query	name optional	Transit Gateway Name Example :	any of [string, null]	None
query	state optional	State Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING), null]	None

Responses

HTTP Code	Description	Schema
200	OK	TransitGatewayListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/transit-gateways

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "transit_gateways": [
        {
            "account_id": "",
            "bandwidth": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "firewall_ids": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "state": "CREATING",
            "uplink_enabled": false
        }
    ]
}

1.49.2 - 1.0

get /v1/transit-gateways

Description

Get Transit Gateway list.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	Transit Gateway ID Example :	any of [string, null]	None
query	name optional	Transit Gateway Name Example :	any of [string, null]	None
query	state optional	State Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING), null]	None

Responses

HTTP Code	Description	Schema
200	OK	TransitGatewayListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/transit-gateways

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "transit_gateways": [
        {
            "account_id": "",
            "bandwidth": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "firewall_ids": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "state": "CREATING",
            "uplink_enabled": false
        }
    ]
}

1.50 - List VPC Endpoint

1.50.1 - 1.1

get /v1/vpc-endpoints

Description

Get VPC Endpoint list.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	limit Example : `20`	any of [integer, null]	None
query	marker optional	marker Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	VPC Endpoint ID Example :	any of [string, null]	None
query	name optional	VPC Endpoint Name Example :	any of [string, null]	None
query	vpc_id optional	VPC Id Example :	any of [string, null]	None
query	vpc_name optional	VPC Name Example :	any of [string, null]	None
query	subnet_id optional	Subnet Id Example :	any of [string, null]	None
query	resource_key optional	VPC Endpoint Resource Key Example :	any of [string, null]	None
query	resource_type optional	VPC Endpoint Resource Type Example :	any of [enum (FS, OBS, SCR, DNS), null]	None
query	endpoint_ip_address optional	VPC Endpoint IP Address Example :	any of [string, null]	None
query	state optional	VPC Endpoint State Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	VpcEndpointListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-endpoints

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "vpc_endpoints": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "endpoint_ip_address": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "resource_info": "",
            "resource_key": "",
            "resource_type": "FS",
            "state": "CREATING",
            "subnet_id": "",
            "subnet_name": "",
            "vpc_id": "",
            "vpc_name": ""
        }
    ]
}

1.50.2 - 1.0

get /v1/vpc-endpoints

Description

Get VPC Endpoint list.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	limit Example : `20`	any of [integer, null]	None
query	marker optional	marker Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	VPC Endpoint ID Example :	any of [string, null]	None
query	name optional	VPC Endpoint Name Example :	any of [string, null]	None
query	vpc_id optional	VPC Id Example :	any of [string, null]	None
query	vpc_name optional	VPC Name Example :	any of [string, null]	None
query	subnet_id optional	Subnet Id Example :	any of [string, null]	None
query	resource_key optional	VPC Endpoint Resource Key Example :	any of [string, null]	None
query	resource_type optional	VPC Endpoint Resource Type Example :	any of [enum (FS, OBS, SCR, DNS), null]	None
query	endpoint_ip_address optional	VPC Endpoint IP Address Example :	any of [string, null]	None
query	state optional	VPC Endpoint State Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	VpcEndpointListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-endpoints

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "vpc_endpoints": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "endpoint_ip_address": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "resource_info": "",
            "resource_key": "",
            "resource_type": "FS",
            "state": "CREATING",
            "subnet_id": "",
            "subnet_name": "",
            "vpc_id": "",
            "vpc_name": ""
        }
    ]
}

1.51 - List VPC Endpoint Connectable Resources

1.51.1 - 1.1

get /v1/vpc-endpoints/connectable-resources

Description

List VpcEndpoint connectable resources

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	resource_type required	VPC Endpoint Resource Type Example :	enum (FS, OBS, SCR, DNS)	None
query	vpc_id optional	VPC ID(required if resource_type is DNS) Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	VpcEndpointConnectableResourceListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-endpoints/connectable-resources?resource_type={resource_type}

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "vpc_endpoint_connectable_resources": [
        {
            "resource_info": "",
            "resource_key": "",
            "resource_type": "FS"
        }
    ]
}

1.51.2 - 1.0

get /v1/vpc-endpoints/connectable-resources

Description

List VpcEndpoint connectable resources

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	resource_type required	VPC Endpoint Resource Type Example :	enum (FS, OBS, SCR, DNS)	None
query	vpc_id optional	VPC ID(required if resource_type is DNS) Example :	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	VpcEndpointConnectableResourceListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-endpoints/connectable-resources?resource_type={resource_type}

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "vpc_endpoint_connectable_resources": [
        {
            "resource_info": "",
            "resource_key": "",
            "resource_type": "FS"
        }
    ]
}

1.52 - List VPC Peering

1.52.1 - 1.1

get /v1/vpc-peerings

Description

Get VPC Peering list.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	VPC Peering ID Example :	any of [string, null]	None
query	name optional	VPC Peering Name Example :	any of [string, null]	None
query	requester_vpc_id optional	Requester VPC ID Example :	any of [string, null]	None
query	requester_vpc_name optional	Requester VPC Name Example :	any of [string, null]	None
query	approver_vpc_id optional	Approver VPC ID Example :	any of [string, null]	None
query	approver_vpc_name optional	Approver VPC Name Example :	any of [string, null]	None
query	account_type optional	Account Type Example :	any of [enum (SAME, DIFFERENT), null]	None
query	state optional	State Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING), null]	None

Responses

HTTP Code	Description	Schema
200	OK	VpcPeeringListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-peerings

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpc_peerings": [
        {
            "account_type": "SAME",
            "approver_vpc_account_id": "",
            "approver_vpc_id": "",
            "approver_vpc_name": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "delete_requester_account_id": "",
            "description": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "requester_vpc_account_id": "",
            "requester_vpc_id": "",
            "requester_vpc_name": "",
            "state": "CREATING"
        }
    ]
}

1.52.2 - 1.0

get /v1/vpc-peerings

Description

Get VPC Peering list.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	VPC Peering ID Example :	any of [string, null]	None
query	name optional	VPC Peering Name Example :	any of [string, null]	None
query	requester_vpc_id optional	Requester VPC ID Example :	any of [string, null]	None
query	requester_vpc_name optional	Requester VPC Name Example :	any of [string, null]	None
query	approver_vpc_id optional	Approver VPC ID Example :	any of [string, null]	None
query	approver_vpc_name optional	Approver VPC Name Example :	any of [string, null]	None
query	account_type optional	Account Type Example :	any of [enum (SAME, DIFFERENT), null]	None
query	state optional	State Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING), null]	None

Responses

HTTP Code	Description	Schema
200	OK	VpcPeeringListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-peerings

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpc_peerings": [
        {
            "account_type": "SAME",
            "approver_vpc_account_id": "",
            "approver_vpc_id": "",
            "approver_vpc_name": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "delete_requester_account_id": "",
            "description": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "requester_vpc_account_id": "",
            "requester_vpc_id": "",
            "requester_vpc_name": "",
            "state": "CREATING"
        }
    ]
}

1.53 - List VPC Peering Rules

1.53.1 - 1.1

get /v1/vpc-peerings/{vpc_peering_id}/routing-rules

Description

Get VPC Peering Rule list.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example :	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	VPC Peering Rule ID Example :	any of [string, null]	None
query	name optional	VPC Peering Name Example :	any of [string, null]	None
query	source_vpc_id optional	Source VPC ID Example :	any of [string, null]	None
query	source_vpc_type optional	Source VPC Type Example :	enum (REQUESTER_VPC, APPROVER_VPC)	None
query	destination_vpc_id optional	Destination VPC ID Example :	any of [string, null]	None
query	destination_vpc_type optional	Destination VPC Type Example :	enum (REQUESTER_VPC, APPROVER_VPC)	None
query	destination_cidr optional	Destination CIDR Example :	any of [string, null]	None
query	state optional	State Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING), null]	None

Responses

HTTP Code	Description	Schema
200	OK	VpcPeeringRuleListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}/routing-rules

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpc_peering_rules": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "destination_cidr": "",
            "destination_vpc_id": "",
            "destination_vpc_name": "",
            "destination_vpc_type": "REQUESTER_VPC",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "source_vpc_id": "",
            "source_vpc_name": "",
            "source_vpc_type": "REQUESTER_VPC",
            "state": "CREATING",
            "vpc_peering_id": ""
        }
    ]
}

1.53.2 - 1.0

get /v1/vpc-peerings/{vpc_peering_id}/routing-rules

Description

Get VPC Peering Rule list.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example :	string	None
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	VPC Peering Rule ID Example :	any of [string, null]	None
query	name optional	VPC Peering Name Example :	any of [string, null]	None
query	source_vpc_id optional	Source VPC ID Example :	any of [string, null]	None
query	source_vpc_type optional	Source VPC Type Example :	enum (REQUESTER_VPC, APPROVER_VPC)	None
query	destination_vpc_id optional	Destination VPC ID Example :	any of [string, null]	None
query	destination_vpc_type optional	Destination VPC Type Example :	enum (REQUESTER_VPC, APPROVER_VPC)	None
query	destination_cidr optional	Destination CIDR Example :	any of [string, null]	None
query	state optional	State Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING), null]	None

Responses

HTTP Code	Description	Schema
200	OK	VpcPeeringRuleListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}/routing-rules

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpc_peering_rules": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "destination_cidr": "",
            "destination_vpc_id": "",
            "destination_vpc_name": "",
            "destination_vpc_type": "REQUESTER_VPC",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "source_vpc_id": "",
            "source_vpc_name": "",
            "source_vpc_type": "REQUESTER_VPC",
            "state": "CREATING",
            "vpc_peering_id": ""
        }
    ]
}

1.54 - List VPCs

1.54.1 - 1.1

get /v1/vpcs

Description

Get VPC list.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	limit Example : `20`	any of [integer, null]	None
query	marker optional	marker Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	name optional	VPC Name Example : `vpcName`	any of [string, null]	None
query	state optional	State Example :	enum (CREATING, ACTIVE, DELETED, ERROR)	None
query	cidr optional	VPC Cidr Example : `192.167.0.0/18`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	VpcListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpcs

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "vpcs": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "cidr": "192.167.0.0/18",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "vpcDescription",
            "id": "7df8abb4912e4709b1cb237daccca7a8",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "vpcName",
            "state": "CREATING"
        }
    ]
}

1.54.2 - 1.0

get /v1/vpcs

Description

Get VPC list.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	with_count optional	with count Example : `true`	any of [string, null]	None
query	limit optional	limit Example : `20`	any of [integer, null]	None
query	marker optional	marker Example : `607e0938521643b5b4b266f343fae693`	any of [string, null]	None
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	name optional	VPC Name Example : `vpcName`	any of [string, null]	None
query	state optional	State Example :	enum (CREATING, ACTIVE, DELETED, ERROR)	None
query	cidr optional	VPC Cidr Example : `192.167.0.0/18`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	VpcListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/vpcs

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "vpcs": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "cidr": "192.167.0.0/18",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "vpcDescription",
            "id": "7df8abb4912e4709b1cb237daccca7a8",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "vpcName",
            "state": "CREATING"
        }
    ]
}

1.55 - Request PrivateLink Endpoint

1.55.1 - 1.1

put /v1/privatelink-endpoints/{privatelink_endpoint_id}/request

Description

Request PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example :	string	None
body	body required		PrivateLinkEndpointRequest

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkEndpointShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_id}/request

Request header

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

Request body

{
    "type": "CANCEL"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "account_id": "",
        "approval_type": "MANUAL",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "endpoint_ip_address": "",
        "endpoint_ip_port_id": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "privatelink_service_id": "",
        "security_group_ids": [],
        "state": "REQUESTING",
        "subnet_id": "",
        "vpc_id": ""
    }
}

1.56 - Set Internet Gateway

1.56.1 - 1.1

put /v1/internet-gateways/{internet_gateway_id}

Description

Set Internet Gateway.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	internet_gateway_id required	Internet Gateway ID Example :	string	None
body	body required		InternetGatewaySetRequest

Responses

HTTP Code	Description	Schema
200	OK	InternetGatewayShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/internet-gateways/{internet_gateway_id}

Request header

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

Request body

{
    "description": "",
    "loggable": ""
}

Example HTTP response

Response 200

{
    "internet_gateway": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "id": "",
        "loggable": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.56.2 - 1.0

put /v1/internet-gateways/{internet_gateway_id}

Description

Set Internet Gateway.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	internet_gateway_id required	Internet Gateway ID Example :	string	None
body	body required		InternetGatewaySetRequest

Responses

HTTP Code	Description	Schema
200	OK	InternetGatewayShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/internet-gateways/{internet_gateway_id}

Request header

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

Request body

{
    "description": "",
    "loggable": ""
}

Example HTTP response

Response 200

{
    "internet_gateway": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "id": "",
        "loggable": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.57 - Set NAT Gateway

1.57.1 - 1.1

put /v1/nat-gateways/{nat_gateway_id}

Description

Set NAT Gateway.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	nat_gateway_id required	NAT Gateway ID Example :	string	None
body	body required		NatGatewaySetRequest

Responses

HTTP Code	Description	Schema
200	OK	NatGatewayShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/nat-gateways/{nat_gateway_id}

Request header

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

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "nat_gateway": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "nat_gateway_ip_address": "",
        "publicip_id": "",
        "state": "",
        "subnet_cidr": "",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.57.2 - 1.0

put /v1/nat-gateways/{nat_gateway_id}

Description

Set NAT Gateway.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	nat_gateway_id required	NAT Gateway ID Example :	string	None
body	body required		NatGatewaySetRequest

Responses

HTTP Code	Description	Schema
200	OK	NatGatewayShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/nat-gateways/{nat_gateway_id}

Request header

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

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "nat_gateway": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "nat_gateway_ip_address": "",
        "publicip_id": "",
        "state": "",
        "subnet_cidr": "",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.58 - Set Port

1.58.1 - 1.1

put /v1/ports/{port_id}

Description

Set port.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	port_id required	Port ID Example :	string	None
body	body required		PortSetRequest

Responses

HTTP Code	Description	Schema
200	OK	PortShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/ports/{port_id}

Request header

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

Request body

{
    "description": "",
    "security_groups": [
        ""
    ]
}

Example HTTP response

Response 200

{
    "port": {
        "account_id": "",
        "attached_resource_id": "",
        "attached_resource_type": "",
        "created_at": "2026-02-11T06:45:07.130Z",
        "description": "",
        "fixed_ip_address": "",
        "id": "",
        "mac_address": "",
        "modified_at": "2026-02-11T06:45:07.130Z",
        "name": "",
        "security_groups": [
            {
                "id": "",
                "name": ""
            }
        ],
        "state": "",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.58.2 - 1.0

put /v1/ports/{port_id}

Description

Set port.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	port_id required	Port ID Example :	string	None
body	body required		PortSetRequest

Responses

HTTP Code	Description	Schema
200	OK	PortShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/ports/{port_id}

Request header

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

Request body

{
    "description": "",
    "security_groups": [
        ""
    ]
}

Example HTTP response

Response 200

{
    "port": {
        "account_id": "",
        "attached_resource_id": "",
        "attached_resource_type": "",
        "created_at": "2026-02-11T06:45:05.497Z",
        "description": "",
        "fixed_ip_address": "",
        "id": "",
        "mac_address": "",
        "modified_at": "2026-02-11T06:45:05.497Z",
        "name": "",
        "security_groups": [
            {
                "id": "",
                "name": ""
            }
        ],
        "state": "",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.59 - Set Private NAT

1.59.1 - 1.1

put /v1/private-nats/{private_nat_id}

Description

Set Private NAT.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example :	string	None
body	body required		PrivateNatSetRequest

Responses

HTTP Code	Description	Schema
200	OK	PrivateNatShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}

Request header

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

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "private_nat": {
        "account_id": "",
        "cidr": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "direct_connect_id": "",
        "direct_connect_name": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.59.2 - 1.0

put /v1/private-nats/{private_nat_id}

Description

Set Private NAT.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example :	string	None
body	body required		PrivateNatSetRequest

Responses

HTTP Code	Description	Schema
200	OK	PrivateNatShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}

Request header

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

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "private_nat": {
        "account_id": "",
        "cidr": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "direct_connect_id": "",
        "direct_connect_name": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.60 - Set PrivateLink Endpoint

1.60.1 - 1.1

put /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

Set PrivateLink Endpoint.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example :	string	None
body	body required		PrivateLinkEndpointSetRequest

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkEndpointShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_id}

Request header

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

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "account_id": "",
        "approval_type": "MANUAL",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "endpoint_ip_address": "",
        "endpoint_ip_port_id": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "privatelink_service_id": "",
        "security_group_ids": [],
        "state": "REQUESTING",
        "subnet_id": "",
        "vpc_id": ""
    }
}

1.61 - Set PrivateLink Service

1.61.1 - 1.1

put /v1/privatelink-services/{privatelink_service_id}

Description

Set PrivateLink Service.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_service_id required	PrivateLink Service ID Example :	string	None
body	body required		PrivateLinkServiceSetRequest

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkServiceShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/privatelink-services/{privatelink_service_id}

Request header

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

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "privatelink_service": {
        "account_id": "",
        "approval_type": "MANUAL",
        "connected_resource_id": "",
        "connected_resource_ip_address": "",
        "connected_resource_name": "",
        "connected_resource_type": "LB",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "high_speed_transfer": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "security_group_ids": [],
        "service_ip_address": "",
        "service_ip_port_id": "",
        "state": "CREATING",
        "subnet_id": "",
        "vpc_id": ""
    }
}

1.62 - Set PublicIP

1.62.1 - 1.1

put /v1/publicips/{publicip_id}

Description

Set PublicIP.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	publicip_id required	PublicIP ID Example :	string	None
body	body required		PublicipSetRequest

Responses

HTTP Code	Description	Schema
200	OK	PublicipShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/publicips/{publicip_id}

Request header

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

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "publicip": {
        "account_id": "",
        "attached_resource_id": "",
        "attached_resource_name": "",
        "attached_resource_type": "VM",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "RESERVED",
        "type": "IGW"
    }
}

1.62.2 - 1.0

put /v1/publicips/{publicip_id}

Description

Set PublicIP.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	publicip_id required	PublicIP ID Example :	string	None
body	body required		PublicipSetRequest

Responses

HTTP Code	Description	Schema
200	OK	PublicipShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/publicips/{publicip_id}

Request header

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

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "publicip": {
        "account_id": "",
        "attached_resource_id": "",
        "attached_resource_name": "",
        "attached_resource_type": "VM",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "RESERVED",
        "type": "IGW"
    }
}

1.63 - Set Subnet

1.63.1 - 1.1

put /v1/subnets/{subnet_id}

Description

Set subnet.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	subnet_id required	Subnet Id Example : `023c57b14f11483689338d085e061492`	string	None
body	body required		SubnetSetRequest

Responses

HTTP Code	Description	Schema
200	OK	SubnetShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/subnets/{subnet_id}

Request header

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

Request body

{
    "description": "Subnet Description"
}

Example HTTP response

Response 200

{
    "subnet": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "allocation_pools": [],
        "cidr": "192.167.1.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet Description",
        "dns_nameservers": [],
        "gateway_ip_address": "192.167.1.1",
        "host_routes": [],
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "subnetName",
        "state": "CREATING",
        "type": "GENERAL",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

1.63.2 - 1.0

put /v1/subnets/{subnet_id}

Description

Set subnet.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	subnet_id required	Subnet Id Example : `023c57b14f11483689338d085e061492`	string	None
body	body required		SubnetSetRequest

Responses

HTTP Code	Description	Schema
200	OK	SubnetShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/subnets/{subnet_id}

Request header

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

Request body

{
    "description": "Subnet Description"
}

Example HTTP response

Response 200

{
    "subnet": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "allocation_pools": [],
        "cidr": "192.167.1.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet Description",
        "dns_nameservers": [],
        "gateway_ip_address": "192.167.1.1",
        "host_routes": [],
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "subnetName",
        "state": "CREATING",
        "type": "GENERAL",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

1.64 - Set Transit Gateway

1.64.1 - 1.1

put /v1/transit-gateways/{transit_gateway_id}

Description

Set Transit Gateway.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None
body	body required		TransitGatewaySetRequest

Responses

HTTP Code	Description	Schema
200	OK	TransitGatewayShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}

Request header

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

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "transit_gateway": {
        "account_id": "",
        "bandwidth": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_ids": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "uplink_enabled": false
    }
}

1.64.2 - 1.0

put /v1/transit-gateways/{transit_gateway_id}

Description

Set Transit Gateway.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None
body	body required		TransitGatewaySetRequest

Responses

HTTP Code	Description	Schema
200	OK	TransitGatewayShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}

Request header

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

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "transit_gateway": {
        "account_id": "",
        "bandwidth": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_ids": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "uplink_enabled": false
    }
}

1.65 - Set VPC

1.65.1 - 1.1

put /v1/vpcs/{vpc_id}

Description

Set VPC.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_id required	VPC Id Example :	string	None
body	body required		VpcSetRequest

Responses

HTTP Code	Description	Schema
200	OK	VpcShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpcs/{vpc_id}

Request header

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

Request body

{
    "description": "vpcDescription"
}

Example HTTP response

Response 200

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/18",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "vpcDescription",
        "id": "7df8abb4912e4709b1cb237daccca7a8",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcName",
        "state": "CREATING"
    }
}

1.65.2 - 1.0

put /v1/vpcs/{vpc_id}

Description

Set VPC.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_id required	VPC Id Example :	string	None
body	body required		VpcSetRequest

Responses

HTTP Code	Description	Schema
200	OK	VpcShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpcs/{vpc_id}

Request header

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

Request body

{
    "description": "vpcDescription"
}

Example HTTP response

Response 200

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/18",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "vpcDescription",
        "id": "7df8abb4912e4709b1cb237daccca7a8",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcName",
        "state": "CREATING"
    }
}

1.66 - Set VPC Endpoint

1.66.1 - 1.1

put /v1/vpc-endpoints/{vpc_endpoint_id}

Description

Set VPC Endpoint.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_endpoint_id required	VPC Endpoint ID Example :	string	None
body	body required		VpcEndpointSetRequest

Responses

HTTP Code	Description	Schema
200	OK	VpcEndpointShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpc-endpoints/{vpc_endpoint_id}

Request header

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

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "vpc_endpoint": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "endpoint_ip_address": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "resource_info": "",
        "resource_key": "",
        "resource_type": "FS",
        "state": "CREATING",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.66.2 - 1.0

put /v1/vpc-endpoints/{vpc_endpoint_id}

Description

Set VPC Endpoint.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_endpoint_id required	VPC Endpoint ID Example :	string	None
body	body required		VpcEndpointSetRequest

Responses

HTTP Code	Description	Schema
200	OK	VpcEndpointShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpc-endpoints/{vpc_endpoint_id}

Request header

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

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "vpc_endpoint": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "endpoint_ip_address": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "resource_info": "",
        "resource_key": "",
        "resource_type": "FS",
        "state": "CREATING",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.67 - Set VPC Peering

1.67.1 - 1.1

put /v1/vpc-peerings/{vpc_peering_id}

Description

Set VPC Peering.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example :	string	None
body	body required		VpcPeeringSetRequest

Responses

HTTP Code	Description	Schema
200	OK	VpcPeeringShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}

Request header

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

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "vpc_peering": {
        "account_type": "SAME",
        "approver_vpc_account_id": "",
        "approver_vpc_id": "",
        "approver_vpc_name": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_requester_account_id": "",
        "description": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "requester_vpc_account_id": "",
        "requester_vpc_id": "",
        "requester_vpc_name": "",
        "state": "CREATING"
    }
}

1.67.2 - 1.0

put /v1/vpc-peerings/{vpc_peering_id}

Description

Set VPC Peering.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example :	string	None
body	body required		VpcPeeringSetRequest

Responses

HTTP Code	Description	Schema
200	OK	VpcPeeringShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}

Request header

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

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "vpc_peering": {
        "account_type": "SAME",
        "approver_vpc_account_id": "",
        "approver_vpc_id": "",
        "approver_vpc_name": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_requester_account_id": "",
        "description": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "requester_vpc_account_id": "",
        "requester_vpc_id": "",
        "requester_vpc_name": "",
        "state": "CREATING"
    }
}

1.68 - Show Internet Gateway

1.68.1 - 1.1

get /v1/internet-gateways/{internet_gateway_id}

Description

Show Internet Gateway.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	internet_gateway_id required	Internet Gateway ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	InternetGatewayShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/internet-gateways/{internet_gateway_id}

Request header

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

Example HTTP response

Response 200

{
    "internet_gateway": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "id": "",
        "loggable": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.68.2 - 1.0

get /v1/internet-gateways/{internet_gateway_id}

Description

Show Internet Gateway.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	internet_gateway_id required	Internet Gateway ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	InternetGatewayShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/internet-gateways/{internet_gateway_id}

Request header

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

Example HTTP response

Response 200

{
    "internet_gateway": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "id": "",
        "loggable": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.69 - Show NAT Gateway

1.69.1 - 1.1

get /v1/nat-gateways/{nat_gateway_id}

Description

Show NAT Gateway.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	nat_gateway_id required	NAT Gateway ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	NatGatewayShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/nat-gateways/{nat_gateway_id}

Request header

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

Example HTTP response

Response 200

{
    "nat_gateway": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "nat_gateway_ip_address": "",
        "publicip_id": "",
        "state": "",
        "subnet_cidr": "",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.69.2 - 1.0

get /v1/nat-gateways/{nat_gateway_id}

Description

Show NAT Gateway.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	nat_gateway_id required	NAT Gateway ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	NatGatewayShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/nat-gateways/{nat_gateway_id}

Request header

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

Example HTTP response

Response 200

{
    "nat_gateway": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "nat_gateway_ip_address": "",
        "publicip_id": "",
        "state": "",
        "subnet_cidr": "",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.70 - Show Port

1.70.1 - 1.1

get /v1/ports/{port_id}

Description

Show port.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	port_id required	Port ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	PortShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/ports/{port_id}

Request header

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

Example HTTP response

Response 200

{
    "port": {
        "account_id": "",
        "attached_resource_id": "",
        "attached_resource_type": "",
        "created_at": "2026-02-11T06:45:07.111Z",
        "description": "",
        "fixed_ip_address": "",
        "id": "",
        "mac_address": "",
        "modified_at": "2026-02-11T06:45:07.111Z",
        "name": "",
        "security_groups": [
            {
                "id": "",
                "name": ""
            }
        ],
        "state": "",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.70.2 - 1.0

get /v1/ports/{port_id}

Description

Show port.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	port_id required	Port ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	PortShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/ports/{port_id}

Request header

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

Example HTTP response

Response 200

{
    "port": {
        "account_id": "",
        "attached_resource_id": "",
        "attached_resource_type": "",
        "created_at": "2026-02-11T06:45:05.477Z",
        "description": "",
        "fixed_ip_address": "",
        "id": "",
        "mac_address": "",
        "modified_at": "2026-02-11T06:45:05.477Z",
        "name": "",
        "security_groups": [
            {
                "id": "",
                "name": ""
            }
        ],
        "state": "",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.71 - Show Private NAT

1.71.1 - 1.1

get /v1/private-nats/{private_nat_id}

Description

Show Private NAT.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateNatShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}

Request header

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

Example HTTP response

Response 200

{
    "private_nat": {
        "account_id": "",
        "cidr": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "direct_connect_id": "",
        "direct_connect_name": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.71.2 - 1.0

get /v1/private-nats/{private_nat_id}

Description

Show Private NAT.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateNatShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}

Request header

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

Example HTTP response

Response 200

{
    "private_nat": {
        "account_id": "",
        "cidr": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "direct_connect_id": "",
        "direct_connect_name": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.72 - Show PrivateLink Endpoint

1.72.1 - 1.1

get /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

Show PrivateLink Endpoint.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkEndpointShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_id}

Request header

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

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "account_id": "",
        "approval_type": "MANUAL",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "endpoint_ip_address": "",
        "endpoint_ip_port_id": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "privatelink_service_id": "",
        "security_group_ids": [],
        "state": "REQUESTING",
        "subnet_id": "",
        "vpc_id": ""
    }
}

1.73 - Show PrivateLink Service

1.73.1 - 1.1

get /v1/privatelink-services/{privatelink_service_id}

Description

Show PrivateLink Service.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_service_id required	PrivateLink Service ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateLinkServiceShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/privatelink-services/{privatelink_service_id}

Request header

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

Example HTTP response

Response 200

{
    "privatelink_service": {
        "account_id": "",
        "approval_type": "MANUAL",
        "connected_resource_id": "",
        "connected_resource_ip_address": "",
        "connected_resource_name": "",
        "connected_resource_type": "LB",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "high_speed_transfer": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "security_group_ids": [],
        "service_ip_address": "",
        "service_ip_port_id": "",
        "state": "CREATING",
        "subnet_id": "",
        "vpc_id": ""
    }
}

1.74 - Show PublicIP

1.74.1 - 1.1

get /v1/publicips/{publicip_id}

Description

Show PublicIP.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	publicip_id required	PublicIP ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	PublicipShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/publicips/{publicip_id}

Request header

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

Example HTTP response

Response 200

{
    "publicip": {
        "account_id": "",
        "attached_resource_id": "",
        "attached_resource_name": "",
        "attached_resource_type": "VM",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "RESERVED",
        "type": "IGW"
    }
}

1.74.2 - 1.0

get /v1/publicips/{publicip_id}

Description

Show PublicIP.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	publicip_id required	PublicIP ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	PublicipShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/publicips/{publicip_id}

Request header

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

Example HTTP response

Response 200

{
    "publicip": {
        "account_id": "",
        "attached_resource_id": "",
        "attached_resource_name": "",
        "attached_resource_type": "VM",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "RESERVED",
        "type": "IGW"
    }
}

1.75 - Show Subnet

1.75.1 - 1.1

get /v1/subnets/{subnet_id}

Description

Show subnet.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	subnet_id required	Subnet Id Example : `023c57b14f11483689338d085e061492`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SubnetShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/subnets/{subnet_id}

Request header

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

Example HTTP response

Response 200

{
    "subnet": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "allocation_pools": [],
        "cidr": "192.167.1.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet Description",
        "dns_nameservers": [],
        "gateway_ip_address": "192.167.1.1",
        "host_routes": [],
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "subnetName",
        "state": "CREATING",
        "type": "GENERAL",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

1.75.2 - 1.0

get /v1/subnets/{subnet_id}

Description

Show subnet.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	subnet_id required	Subnet Id Example : `023c57b14f11483689338d085e061492`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SubnetShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/subnets/{subnet_id}

Request header

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

Example HTTP response

Response 200

{
    "subnet": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "allocation_pools": [],
        "cidr": "192.167.1.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet Description",
        "dns_nameservers": [],
        "gateway_ip_address": "192.167.1.1",
        "host_routes": [],
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "subnetName",
        "state": "CREATING",
        "type": "GENERAL",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

1.76 - Show Transit Gateway

1.76.1 - 1.1

get /v1/transit-gateways/{transit_gateway_id}

Description

Show Transit Gateway.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	TransitGatewayShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}

Request header

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

Example HTTP response

Response 200

{
    "transit_gateway": {
        "account_id": "",
        "bandwidth": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_ids": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "uplink_enabled": false
    }
}

1.76.2 - 1.0

get /v1/transit-gateways/{transit_gateway_id}

Description

Show Transit Gateway.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	TransitGatewayShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}

Request header

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

Example HTTP response

Response 200

{
    "transit_gateway": {
        "account_id": "",
        "bandwidth": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_ids": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "CREATING",
        "uplink_enabled": false
    }
}

1.77 - Show VPC

1.77.1 - 1.1

get /v1/vpcs/{vpc_id}

Description

Show VPC.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_id required	VPC Id Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	VpcShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpcs/{vpc_id}

Request header

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

Example HTTP response

Response 200

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/18",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "vpcDescription",
        "id": "7df8abb4912e4709b1cb237daccca7a8",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcName",
        "state": "CREATING"
    }
}

1.77.2 - 1.0

get /v1/vpcs/{vpc_id}

Description

Show VPC.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_id required	VPC Id Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	VpcShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpcs/{vpc_id}

Request header

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

Example HTTP response

Response 200

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/18",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "vpcDescription",
        "id": "7df8abb4912e4709b1cb237daccca7a8",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcName",
        "state": "CREATING"
    }
}

1.78 - Show VPC Endpoint

1.78.1 - 1.1

get /v1/vpc-endpoints/{vpc_endpoint_id}

Description

Show VPC Endpoint.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_endpoint_id required	VPC Endpoint ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	VpcEndpointShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpc-endpoints/{vpc_endpoint_id}

Request header

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

Example HTTP response

Response 200

{
    "vpc_endpoint": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "endpoint_ip_address": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "resource_info": "",
        "resource_key": "",
        "resource_type": "FS",
        "state": "CREATING",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.78.2 - 1.0

get /v1/vpc-endpoints/{vpc_endpoint_id}

Description

Show VPC Endpoint.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_endpoint_id required	VPC Endpoint ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	VpcEndpointShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpc-endpoints/{vpc_endpoint_id}

Request header

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

Example HTTP response

Response 200

{
    "vpc_endpoint": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "endpoint_ip_address": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "resource_info": "",
        "resource_key": "",
        "resource_type": "FS",
        "state": "CREATING",
        "subnet_id": "",
        "subnet_name": "",
        "vpc_id": "",
        "vpc_name": ""
    }
}

1.79 - Show VPC Peering

1.79.1 - 1.1

get /v1/vpc-peerings/{vpc_peering_id}

Description

Show VPC Peering.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	VpcPeeringShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}

Request header

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

Example HTTP response

Response 200

{
    "vpc_peering": {
        "account_type": "SAME",
        "approver_vpc_account_id": "",
        "approver_vpc_id": "",
        "approver_vpc_name": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_requester_account_id": "",
        "description": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "requester_vpc_account_id": "",
        "requester_vpc_id": "",
        "requester_vpc_name": "",
        "state": "CREATING"
    }
}

1.79.2 - 1.0

get /v1/vpc-peerings/{vpc_peering_id}

Description

Show VPC Peering.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	VpcPeeringShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/vpc-peerings/{vpc_peering_id}

Request header

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

Example HTTP response

Response 200

{
    "vpc_peering": {
        "account_type": "SAME",
        "approver_vpc_account_id": "",
        "approver_vpc_id": "",
        "approver_vpc_name": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_requester_account_id": "",
        "description": "",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "requester_vpc_account_id": "",
        "requester_vpc_id": "",
        "requester_vpc_name": "",
        "state": "CREATING"
    }
}

2 - Models

2.1 - ConnectedEndpointListResponse

Name	Description	Schema
connected_privatelink_endpoints required		array[ConnectedPrivateLinkEndpoint]
count required	count Example : `20`	integer
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

2.2 - ConnectedPrivateLinkEndpoint

Name	Description	Schema
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
id required	PrivateLink Endpoint ID Example :	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
privatelink_service_id required	PrivateLink Service ID Example :	string
state required	PrivateLink Endpoint State Example : `REQUESTING`	enum (REQUESTING, CREATING, REJECTED, CANCELED, ACTIVE, DISCONNECTED, DELETING, DELETED, ERROR)

2.3 - InternetGateway

Name	Description	Schema
account_id required	Account ID Example :	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	Description Example :	any of [string, null]
firewall_id optional	Firewall ID Example :	any of [string, null]
id required	Internet Gateway ID Example :	string
loggable optional	NAT Loggable Example :	boolean
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Internet Gateway Name Example :	string
state required	State Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
type required	Internet Gateway Type Example : `IGW`	enum (IGW, GGW, SIGW)
vpc_id required	VPC Id Example :	string
vpc_name required	VPC Name Example :	string

2.4 - InternetGatewayCreateRequest

Name	Description	Schema
description optional	Description Example :	any of [string, null]
firewall_enabled optional	Firewall Enable Example : `False`	boolean
firewall_loggable optional	Firewall Loggable Example : `False`	boolean
tags optional	Tag List	array[Tag]
type required	Internet Gateway Type Example : `IGW`	enum (IGW, GGW, SIGW)
vpc_id required	VPC Id Example :	string

2.5 - InternetGatewayListResponse

Name	Description	Schema
count optional	total count Example : `20`	any of [integer, null]
internet_gateways required		array[InternetGateway]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]

2.6 - InternetGatewaySetRequest

Name	Description	Schema	Default
description optional	Description Example :	any of [string, null]
loggable optional	NAT Loggable Example :	boolean

2.7 - InternetGatewayShowResponse

Name	Description	Schema	Default
internet_gateway required		InternetGateway

2.8 - NatGateway

Name	Description	Schema
account_id required	Account ID Example :	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	NAT Gateway Description Example :	any of [string, null]
id required	NAT Gateway ID Example :	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	NAT Gateway Name Example :	string
nat_gateway_ip_address required	NAT Gateway IP Address Example :	string
publicip_id optional	PublicIP ID Example :	any of [string, null]
state required	NAT Gateway State Example :	string
subnet_cidr required	Subnet Cidr Example :	string
subnet_id required	Subnet Id Example :	string
subnet_name required	Subnet Name Example :	string
vpc_id required	VPC Id Example :	string
vpc_name required	VPC Name Example :	string

2.9 - NatGatewayCreateRequest

Name	Description	Schema
description optional	NAT Gateway Description Example : Maximum length : `50`	string
publicip_id required	PublicIP ID Example :	string
subnet_id required	Subnet CIDR Example :	string
tags optional	Tag List	array[Tag]

2.10 - NatGatewayListResponse

Name	Description	Schema
count optional	total count Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
nat_gateways required		array[NatGateway]

2.11 - NatGatewaySetRequest

Name	Description	Schema	Default
description optional	NAT Gateway Description Example : Maximum length : `50`	string

2.12 - NatGatewayShowResponse

Name	Description	Schema	Default
nat_gateway required		NatGateway

2.13 - Port

Name	Description	Schema
account_id required	Account ID Example :	string
attached_resource_id required	Connected resource ID Example :	string
attached_resource_type required	Connected resource Type Example :	string
created_at required	Created date Example :	string (date-time)
description required	Description Example :	string
fixed_ip_address required	Fixed IP Example :	string
id required	Port ID Example :	string
mac_address required	MAC Address Example :	string
modified_at required	Modified date Example :	string (date-time)
name required	Port Name Example :	string
security_groups required	Security Group List	array[PortSecurityGroup]
state required	State Example :	string
subnet_id required	Subnet Id Example :	string
subnet_name required	Subnet Name Example :	string
vpc_id required	VPC Id Example :	string
vpc_name required	VPC Name Example :	string

2.14 - PortCreateRequest

Name	Description	Schema
description optional	Description Example :	any of [string, null]
fixed_ip_address optional	Fixed IP Example :	any of [string, null]
name required	Port Name Example : Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
security_groups optional	Security Group List	array[string]
subnet_id required	Subnet Id Example :	string
tags optional	Tag List	array[Tag]

2.15 - PortList

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

2.16 - PortListResponse

Name	Description	Schema
count optional	total count Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
ports required		array[PortList]

2.17 - PortSecurityGroup

Name	Description	Schema	Default
id optional	Security Group ID Example :	any of [string, null]
name optional	Security Group Name Example :	any of [string, null]

2.18 - PortSetRequest

Name	Description	Schema	Default
description optional	Description Example :	any of [string, null]
security_groups optional	Security Group List Example :	any of [array[string], null]

2.19 - PortShowResponse

Name	Description	Schema	Default
port required		any of [Port, null]

2.20 - PrivateLinkEndpoint

Name	Description	Schema
account_id required	Account ID Example :	string
approval_type required	PrivateLink Service Approval Type Example : `MANUAL`	enum (MANUAL, AUTO)
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
endpoint_ip_address required	Endpoint IP Address Example :	string
id required	PrivateLink Endpoint ID Example :	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	PrivateLink Endpoint Name Example :	string
privatelink_service_id required	PrivateLink Service ID Example :	string
state required	PrivateLink Endpoint State Example : `REQUESTING`	enum (REQUESTING, CREATING, REJECTED, CANCELED, ACTIVE, DISCONNECTED, DELETING, DELETED, ERROR)
subnet_id required	Subnet Id Example :	string
vpc_id required	VPC Id Example :	string

2.21 - PrivateLinkEndpointApprovalRequest

Name	Description	Schema	Default
type required	PrivateLink Endpoint Action Type Example : `APPROVE`	enum (APPROVE, REJECT)

2.22 - PrivateLinkEndpointConnectionRequest

Name	Description	Schema	Default
type required	PrivateLink Endpoint Action Type Example : `DISCONNECT`	enum (DISCONNECT, RECONNECT)

2.23 - PrivateLinkEndpointCreateRequest

Name	Description	Schema
description optional	Description Example : Maximum length : `50`	string
endpoint_ip_address required	Endpoint IP Address Example :	string
name required	PrivateLink Endpoint Name Example : Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
privatelink_service_id optional	PrivateLink Service ID Example :	string
security_group_ids optional	Security Group List	array[string]
subnet_id required	Subnet Id Example :	string
tags optional	Tag List	array[Tag]

2.24 - PrivateLinkEndpointDetail

Name	Description	Schema
account_id required	Account ID Example :	string
approval_type required	PrivateLink Service Approval Type Example : `MANUAL`	enum (MANUAL, AUTO)
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	Description Example :	any of [string, null]
endpoint_ip_address required	Endpoint IP Address Example :	string
endpoint_ip_port_id optional	Endpoint IP Port ID Example :	any of [string, null]
id required	PrivateLink Endpoint ID Example :	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	PrivateLink Endpoint Name Example :	string
privatelink_service_id required	PrivateLink Service ID Example :	string
security_group_ids optional	Security Group List	array[string]
state required	PrivateLink Endpoint State Example : `REQUESTING`	enum (REQUESTING, CREATING, REJECTED, CANCELED, ACTIVE, DISCONNECTED, DELETING, DELETED, ERROR)
subnet_id required	Subnet Id Example :	string
vpc_id required	VPC Id Example :	string

2.25 - PrivateLinkEndpointListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
privatelink_endpoints required		array[PrivateLinkEndpoint]
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

2.26 - PrivateLinkEndpointRequest

Name	Description	Schema	Default
type required	PrivateLink Endpoint Action Type Example : `CANCEL`	enum (CANCEL, RE_REQUEST)

2.27 - PrivateLinkEndpointSetRequest

Name	Description	Schema	Default
description optional	Description Example : Maximum length : `50`	string

2.28 - PrivateLinkEndpointShowResponse

Name	Description	Schema	Default
privatelink_endpoint required		PrivateLinkEndpointDetail

2.29 - PrivateLinkEndpointSummary

Name	Description	Schema
created_at required	Created date Example :	string (date-time)
id required	PrivateLink Endpoint ID Example :	string
state required	PrivateLink Endpoint State Example : `REQUESTING`	enum (REQUESTING, CREATING, REJECTED, CANCELED, ACTIVE, DISCONNECTED, DELETING, DELETED, ERROR)

2.30 - PrivateLinkEndpointSummaryShowResponse

Name	Description	Schema	Default
privatelink_endpoint required		PrivateLinkEndpointSummary

2.31 - PrivateLinkService

Name	Description	Schema
account_id required	Account ID Example :	string
approval_type required	PrivateLink Service Approval Type Example : `MANUAL`	enum (MANUAL, AUTO)
connected_resource_id optional	Connected Resource ID Example :	any of [string, null]
connected_resource_ip_address required	Connected Resource IP Address Example :	string
connected_resource_name required	Connected Resource Name Example :	string
connected_resource_type required	Connected Resource Type Example : `LB`	enum (LB, IP)
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
id required	PrivateLink Service ID Example :	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	PrivateLink Service Name Example :	string
service_ip_address required	Service IP Address Example :	string
state required	PrivateLink Service State Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
subnet_id required	Subnet Id Example :	string
vpc_id required	VPC Id Example :	string

2.32 - PrivateLinkServiceCreateRequest

Name	Description	Schema
approval_type required	PrivateLink Service Approval Type Example : `MANUAL`	enum (MANUAL, AUTO)
connected_resource_id optional	Connected Resource ID Example :	string
connected_resource_ip_address optional	Connected Resource IP Address Example :	string
connected_resource_type required	Connected Resource Type Example : `LB`	enum (LB, IP)
description optional	Description Example : Maximum length : `50`	string
high_speed_transfer optional	High Speed Data Transfer Use Example : `False`	boolean
name required	PrivateLink Service Name Example : Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
security_group_ids optional	Security Group List	array[string]
service_ip_address required	Service IP Address Example :	string
subnet_id required	Subnet Id Example :	string
tags optional	Tag List	array[Tag]

2.33 - PrivateLinkServiceDetail

Name	Description	Schema
account_id required	Account ID Example :	string
approval_type required	PrivateLink Service Approval Type Example : `MANUAL`	enum (MANUAL, AUTO)
connected_resource_id optional	Connected Resource ID Example :	any of [string, null]
connected_resource_ip_address required	Connected Resource IP Address Example :	string
connected_resource_name required	Connected Resource Name Example :	string
connected_resource_type required	Connected Resource Type Example : `LB`	enum (LB, IP)
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	Description Example :	any of [string, null]
high_speed_transfer required	High Speed Data Transfer Use Example :	boolean
id required	PrivateLink Service ID Example :	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	PrivateLink Service Name Example :	string
security_group_ids optional	Security Group List	array[string]
service_ip_address required	Service IP Address Example :	string
service_ip_port_id optional	Service IP Port ID Example :	any of [string, null]
state required	PrivateLink Service State Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
subnet_id required	Subnet Id Example :	string
vpc_id required	VPC Id Example :	string

2.34 - PrivateLinkServiceListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
privatelink_services required		array[PrivateLinkService]
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

2.35 - PrivateLinkServiceSetRequest

Name	Description	Schema	Default
description optional	Description Example : Maximum length : `50`	string

2.36 - PrivateLinkServiceShowResponse

Name	Description	Schema	Default
privatelink_service required		PrivateLinkServiceDetail

2.37 - PrivateNat

Name	Description	Schema
account_id required	Account ID Example :	string
cidr required	Private NAT IP range Example :	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	Description Example :	any of [string, null]
direct_connect_id required	Direct Connect ID Example :	string
direct_connect_name optional	Direct Connect Name Example :	any of [string, null]
id required	Private NAT ID Example :	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Private NAT Name Example :	string
state required	Private NAT State Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
vpc_id required	VPC Id Example :	string
vpc_name optional	VPC Name Example :	any of [string, null]

2.38 - PrivateNatCreateRequest

Name	Description	Schema
cidr required	Private NAT IP range Example :	string
description optional	Description Example : Maximum length : `50`	string
direct_connect_id required	Direct Connect ID Example :	string
name required	Private NAT Name Example : Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
tags optional	Tag List	array[Tag]

2.39 - PrivateNatIp

Name	Description	Schema
attached_resource_id optional	Private NAT IP Attached Resource ID Example :	any of [string, null]
attached_resource_name optional	Private NAT IP Attached Resource Name Example :	any of [string, null]
attached_resource_type optional	Private NAT IP Attached Resource Type Example : `VM`	any of [enum (VM, BM), null]
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
id required	Private NAT IP ID Example :	string
ip_address required	Private NAT IP Address Example :	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
private_nat_id required	Private NAT ID Example :	string
state required	Private NAT IP State Example : `RESERVED`	enum (RESERVED, ATTACHED, DELETED)

2.40 - PrivateNatIpCreateRequest

Name	Description	Schema	Default
ip_address required	Private NAT IP Address Example : Minimum length : `7` Maximum length : `15`	string

2.41 - PrivateNatIpListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
private_nat_ips required		array[PrivateNatIp]
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

2.42 - PrivateNatIpShowResponse

Name	Description	Schema	Default
private_nat_ip required		PrivateNatIp

2.43 - PrivateNatListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
private_nats required		array[PrivateNat]
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

2.44 - PrivateNatSetRequest

Name	Description	Schema	Default
description optional	Description Example : Maximum length : `50`	string

2.45 - PrivateNatShowResponse

Name	Description	Schema	Default
private_nat required		PrivateNat

2.46 - Publicip

Name	Description	Schema
account_id required	Account ID Example :	string
attached_resource_id optional	PublicIP Attached Resource ID Example :	any of [string, null]
attached_resource_name optional	PublicIP Attached Resource Name Example :	any of [string, null]
attached_resource_type optional	PublicIP Attached Resource Type Example : `VM`	any of [enum (VM, ALB, LB, BM, DB, NAT_GW, GPU_NODE, VPN), null]
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	PublicIP Description Example :	any of [string, null]
id required	PublicIP ID Example :	string
ip_address required	IP Address Example :	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
state required	PublicIP State Example : `RESERVED`	enum (RESERVED, ATTACHED, DELETED)
type required	PublicIP Type Example : `IGW`	enum (IGW, GGW, SIGW)

2.47 - PublicipCreateRequest

Name	Description	Schema
description optional	PublicIP Description Example :	any of [string, null]
tags optional	Tag List	array[Tag]
type required	PublicIP Type Example : `IGW`	enum (IGW, GGW, SIGW)

2.48 - PublicipListResponse

Name	Description	Schema
count optional	total count Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
publicips required		array[Publicip]

2.49 - PublicipSetRequest

Name	Description	Schema	Default
description required	PublicIP Description Example : Maximum length : `50`	string

2.50 - PublicipShowResponse

Name	Description	Schema	Default
publicip required		Publicip

2.51 - SapSecondarySubnet

Name	Description	Schema
account_id required	Account ID Example :	string
cidr required	CIDR Example :	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
state required	Secondary Subnet State Example : `ACTIVE`	enum (ACTIVE, DELETED)
subnet_id required	Primary Subnet Id Example :	string
vlan_no_id required	VLAN ID of Primary Subnet Example :	string
vpc_id required	VPC ID Example :	string

2.52 - SapSecondarySubnetListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
secondary_subnets required		array[SapSecondarySubnet]
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

2.53 - Subnet

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	string
cidr required	Subnet Cidr Example : `192.167.1.0/24`	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
gateway_ip_address required	Gateway IP Address Example : `192.167.1.1`	any of [string, null]
id required	Subnet Id Example : `023c57b14f11483689338d085e061492`	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Subnet Name Example : `subnetName` Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
state required	State Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
type required	Subnet Type Example : `GENERAL`	enum (GENERAL, LOCAL, VPC_ENDPOINT)
vpc_id required	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	string
vpc_name required	VPC Name Example : `vpcName`	string

2.54 - SubnetCreateRequest

Name	Description	Schema
allocation_pools optional	Allocation Pools Example : `[{"start":"192.167.1.2", "end":"192.167.1.100"}]`	array[object]
cidr required	Subnet Cidr Example : `192.167.1.0/24`	string
description optional	Description Example : `Subnet Description`	any of [string, null]
dns_nameservers optional	DNS Name Servers Example : `["1.1.1.1", "2.2.2.2"]`	array[string]
host_routes optional	Host Routes Example : `[{"destination":"192.168.10.0/24", "nexthop":"192.168.10.0"}]`	array[object]
name required	Subnet Name Example : `subnetName` Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
tags optional	Tag List	array[Tag]
type required	Subnet Type Example : `GENERAL`	enum (GENERAL, LOCAL, VPC_ENDPOINT)
vpc_id required	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	string

2.55 - SubnetDetail

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	string
allocation_pools optional	Allocation Pools	array[object]
cidr required	Subnet Cidr Example : `192.167.1.0/24`	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	Description Example : `Subnet Description`	any of [string, null]
dns_nameservers optional	DNS Name Servers	array[string]
gateway_ip_address required	Gateway IP Address Example : `192.167.1.1`	any of [string, null]
host_routes optional	Host Routes	array[object]
id required	Subnet Id Example : `023c57b14f11483689338d085e061492`	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Subnet Name Example : `subnetName` Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
state required	State Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
type required	Subnet Type Example : `GENERAL`	enum (GENERAL, LOCAL, VPC_ENDPOINT)
vpc_id required	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	string
vpc_name required	VPC Name Example : `vpcName`	string

2.56 - SubnetListResponse

Name	Description	Schema
count optional	total count Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
subnets required		array[Subnet]

2.57 - SubnetSetRequest

Name	Description	Schema	Default
description required	Description Example : `Subnet Description` Maximum length : `50`	string

2.58 - SubnetShowResponse

Name	Description	Schema	Default
subnet required		SubnetDetail

2.59 - Tag

Name	Description	Schema	Default
key required	tag key Example :	string
value required	tag value Example :	string

2.60 - TransitGateway

Name	Description	Schema
account_id required	Account ID Example :	string
bandwidth optional	Transit Gateway Port Bandwidth Example :	any of [integer, null]
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	Transit Gateway Description Example :	any of [string, null]
firewall_ids optional	Firewall ID Example :	any of [string, null]
id required	Transit Gateway ID Example :	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Transit Gateway Name Example : Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
state required	State Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING)
uplink_enabled optional	Uplink Enabled Example : `False`	boolean

2.61 - TransitGatewayCreateRequest

Name	Description	Schema
description optional	Description Example :	any of [string, null]
name required	Transit Gateway Name Example : Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
tags optional	Tag List	array[Tag]

2.62 - TransitGatewayListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]
transit_gateways required		array[TransitGateway]

2.63 - TransitGatewayRule

Name	Description	Schema
account_id required	Account ID Example :	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description required	Description Example :	string
destination_cidr required	Destination CIDR Example :	string
destination_resource_id required	Destination Resource ID Example :	any of [string, null]
destination_resource_name optional	Destination Resource Name Example :	any of [string, null]
destination_type required	Destination Type Example : `VPC`	enum (VPC, TGW)
id required	Routing Rule ID Example :	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
source_resource_id required	Source Resource ID Example :	any of [string, null]
source_resource_name optional	Source Resource Name Example :	any of [string, null]
source_type required	Source Type Example : `VPC`	enum (VPC, TGW)
state required	State Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
tgw_connection_vpc_id required	VPC ID Connected to Transit Gateway. Example :	any of [string, null]
tgw_connection_vpc_name optional	VPC Name Connected to Transit Gateway. Example :	any of [string, null]

2.64 - TransitGatewayRuleCreateRequest

Name	Description	Schema
description optional	Description Example : Maximum length : `50`	string
destination_cidr required	Destination CIDR Example :	string
destination_type required	Destination Type Example : `VPC`	enum (VPC, TGW)
tgw_connection_vpc_id required	VPC ID Connected to Transit Gateway. Example :	string

2.65 - TransitGatewayRuleListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]
transit_gateway_rules required		array[TransitGatewayRule]

2.66 - TransitGatewayRuleShowResponse

Name	Description	Schema	Default
transit_gateway_rule required		TransitGatewayRule

2.67 - TransitGatewaySetRequest

Name	Description	Schema	Default
description optional	Description Example : Maximum length : `50`	string

2.68 - TransitGatewayShowResponse

Name	Description	Schema	Default
transit_gateway required		TransitGateway

2.69 - TransitGatewayVpcConnection

Name	Description	Schema
account_id required	Account ID Example :	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
id required	Transit Gateway VPC Connection ID Example :	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
state required	State Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
transit_gateway_id required	Transit Gateway ID Example :	string
vpc_id required	VPC Id Example :	string
vpc_name required	VPC Name Example :	string

2.70 - TransitGatewayVpcConnectionCreateRequest

Name	Description	Schema	Default
vpc_id required	VPC Id Example :	string

2.71 - TransitGatewayVpcConnectionListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]
transit_gateway_vpc_connections required		array[TransitGatewayVpcConnection]

2.72 - TransitGatewayVpcConnectionShowResponse

Name	Description	Schema	Default
transit_gateway_vpc_connection required		TransitGatewayVpcConnection

2.73 - Vpc

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	string
cidr required	VPC Cidr Example : `192.167.0.0/18`	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	Description Example : `vpcDescription`	any of [string, null]
id required	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	VPC Name Example : `vpcName` Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
state required	State Example : `CREATING`	enum (CREATING, ACTIVE, DELETED, ERROR)

2.74 - VpcCreateRequest

Name	Description	Schema
cidr required	VPC Cidr Example : `192.167.0.0/18`	string
description optional	Description Example : `VPC Description`	any of [string, null]
name required	VPC Name Example : `vpcName` Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
tags optional	Tag List	array[Tag]

2.75 - VpcEndpoint

Name	Description	Schema
account_id required	Account ID Example :	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	Description Example :	any of [string, null]
endpoint_ip_address required	VPC Endpoint IP Address Example :	string
id required	VPC Endpoint ID Example :	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	VPC Endpoint Name Example :	string
resource_info required	VPC Endpoint Resource Key Info Example :	string
resource_key required	VPC Endpoint Resource Key Example :	string
resource_type required	VPC Endpoint Resource Type Example : `FS`	enum (FS, OBS, SCR, DNS)
state required	VPC Endpoint State Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
subnet_id required	Subnet Id Example :	string
subnet_name required	Subnet Name Example :	string
vpc_id required	VPC Id Example :	string
vpc_name required	VPC Name Example :	string

2.76 - VpcEndpointConnectableResourceDetail

Name	Description	Schema
resource_info required	VPC Endpoint Resource Key Info Example :	string
resource_key required	VPC Endpoint Resource Key Example :	string
resource_type required	VPC Endpoint Resource Type Example : `FS`	enum (FS, OBS, SCR, DNS)

2.77 - VpcEndpointConnectableResourceListResponse

Name	Description	Schema
count optional	total count Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
vpc_endpoint_connectable_resources required		array[VpcEndpointConnectableResourceDetail]

2.78 - VpcEndpointCreateRequest

Name	Description	Schema
description optional	Description Example : Maximum length : `50`	string
endpoint_ip_address required	VPC Endpoint IP Address Example :	string
name required	VPC Endpoint Name Example : Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
resource_info required	VPC Endpoint Resource Key Info Example : Maximum length : `200`	string
resource_key required	VPC Endpoint Resource Key Example :	string
resource_type required	VPC Endpoint Resource Type Example : `FS`	enum (FS, OBS, SCR, DNS)
subnet_id required	Subnet Id Example :	string
tags optional	Tag List	array[Tag]
vpc_id required	VPC Id Example :	string

2.79 - VpcEndpointListResponse

Name	Description	Schema
count optional	total count Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
vpc_endpoints required		array[VpcEndpoint]

2.80 - VpcEndpointSetRequest

Name	Description	Schema	Default
description optional	Description Example : Maximum length : `50`	string

2.81 - VpcEndpointShowResponse

Name	Description	Schema	Default
vpc_endpoint required		VpcEndpoint

2.82 - VpcListResponse

Name	Description	Schema
count optional	total count Example : `20`	any of [integer, null]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
vpcs required		array[Vpc]

2.83 - VpcPeering

Name	Description	Schema
account_type required	Account Type Example : `SAME`	enum (SAME, DIFFERENT)
approver_vpc_account_id required	Approver VPC Account ID Example :	string
approver_vpc_id required	Approver VPC ID Example :	string
approver_vpc_name required	Approver VPC Name Example :	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
delete_requester_account_id optional	Requester VPC Account ID Example :	any of [string, null]
description optional	VPC Peering Description Example :	any of [string, null]
id required	VPC Peering ID Example :	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	VPC Peering Name Example : Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
requester_vpc_account_id required	Requester VPC Account ID Example :	string
requester_vpc_id required	Requester VPC ID Example :	string
requester_vpc_name required	Requester VPC Name Example :	string
state required	State Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING)

2.84 - VpcPeeringApprovalRequest

Name	Description	Schema	Default
type required	Approval Type Example : `CREATE_APPROVE`	enum (CREATE_APPROVE, CREATE_CANCEL, CREATE_REJECT, CREATE_RE_REQUEST, DELETE_APPROVE, DELETE_CANCEL, DELETE_REJECT)

2.85 - VpcPeeringCreateRequest

Name	Description	Schema
approver_vpc_account_id required	Approver VPC Account ID Example :	string
approver_vpc_id required	Approver VPC ID Example :	string
description optional	Description Example :	any of [string, null]
name required	VPC Peering Name Example : Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
requester_vpc_id required	Requester VPC ID Example :	string
tags optional	Tag List	array[Tag]

2.86 - VpcPeeringListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]
vpc_peerings required		array[VpcPeering]

2.87 - VpcPeeringRule

Name	Description	Schema
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
destination_cidr required	Destination CIDR Example :	string
destination_vpc_id required	Destination VPC ID Example :	string
destination_vpc_name required	Destination VPC Name Example :	string
destination_vpc_type required	Destination VPC Type Example : `REQUESTER_VPC`	enum (REQUESTER_VPC, APPROVER_VPC)
id required	VPC Peering Rule ID Example :	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
source_vpc_id required	Source VPC ID Example :	string
source_vpc_name required	Source VPC Name Example :	string
source_vpc_type required	Source VPC Type Example : `REQUESTER_VPC`	enum (REQUESTER_VPC, APPROVER_VPC)
state required	State Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
vpc_peering_id required	VPC Peering ID Example :	string

2.88 - VpcPeeringRuleCreateRequest

Name	Description	Schema
destination_cidr required	Destination CIDR Example :	string
destination_vpc_type required	Destination VPC Type Example : `REQUESTER_VPC`	enum (REQUESTER_VPC, APPROVER_VPC)
tags optional	Tag List	array[Tag]

2.89 - VpcPeeringRuleListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]
vpc_peering_rules required		array[VpcPeeringRule]

2.90 - VpcPeeringRuleShowResponse

Name	Description	Schema	Default
vpc_peering_rule required		VpcPeeringRule

2.91 - VpcPeeringSetRequest

Name	Description	Schema	Default
description optional	Description Example : Maximum length : `50`	string

2.92 - VpcPeeringShowResponse

Name	Description	Schema	Default
vpc_peering required		VpcPeering

2.93 - VpcSetRequest

Name	Description	Schema	Default
description optional	Description Example : `vpcDescription`	any of [string, null]

2.94 - VpcShowResponse

Name	Description	Schema	Default
vpc required		Vpc