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

Version

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

Version	Status	Not Before
1.1	CURRENT	-
1.0	SUPPORTED	20261130

OpenAPI URL

https://direct-connect.{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.1 - APIs

1.1.1 - Create Direct Connect

1.1.1.1 - 1.1

post /v1/direct-connects

Description

Create direct connect.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		DirectConnectCreateRequest

Responses

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

Example HTTP request

Request path

/v1/direct-connects

Request header

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

Request body

{
    "bandwidth": 1,
    "description": "TransitGateway Description",
    "firewall_enabled": true,
    "firewall_loggable": true,
    "name": "DirectConnectName",
    "tags": "[{'key': 'key', 'value': 'value'}]",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "direct_connect": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "fe860e0af0c04dcd8182b84f907f31f4",
        "firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "DirectConnectName",
        "state": "ACTIVE",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

1.1.1.2 - 1.0

post /v1/direct-connects

Description

Create direct connect.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261130

Parameters

Type	Name	Description	Schema	Default
body	body required		DirectConnectCreateRequest

Responses

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

Example HTTP request

Request path

/v1/direct-connects

Request header

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

Request body

{
    "bandwidth": 1,
    "description": "TransitGateway Description",
    "firewall_enabled": true,
    "firewall_loggable": true,
    "name": "DirectConnectName",
    "tags": "[{'key': 'key', 'value': 'value'}]",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "direct_connect": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "fe860e0af0c04dcd8182b84f907f31f4",
        "firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "DirectConnectName",
        "state": "ACTIVE",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

1.1.2 - Create Routing Rule

1.1.2.1 - 1.1

post /v1/direct-connects/{direct_connect_id}/routing-rules

Description

Create a routing rule.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	direct_connect_id required	Direct Connect ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	string	None
body	body required		RoutingRuleCreateRequest

Responses

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

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_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 = direct-connect 1.1"

Request body

{
    "description": "TransitGateway Description",
    "destination_cidr": "11.11.11.0/24",
    "destination_resource_id": "be3c84238562488e81e4e0675f86be62",
    "destination_type": "ON_PREMISE"
}

Example HTTP response

Response 202

{
    "routing_rule": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "destination_cidr": "11.11.11.0/24",
        "destination_resource_id": "be3c84238562488e81e4e0675f86be62",
        "destination_resource_name": "ResourceName",
        "destination_type": "ON_PREMISE",
        "id": "c8980aa2bf1e43c9998682f7baaf1c46",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "owner_id": "cd1610830b9046418e4bc67831c533e6",
        "owner_type": "DIRECT_CONNECT",
        "state": "ACTIVE"
    }
}

1.1.2.2 - 1.0

post /v1/direct-connects/{direct_connect_id}/routing-rules

Description

Create a routing rule.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261130

Parameters

Type	Name	Description	Schema	Default
path	direct_connect_id required	Direct Connect ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	string	None
body	body required		RoutingRuleCreateRequest

Responses

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

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_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 = direct-connect 1.0"

Request body

{
    "description": "TransitGateway Description",
    "destination_cidr": "11.11.11.0/24",
    "destination_resource_id": "be3c84238562488e81e4e0675f86be62",
    "destination_type": "ON_PREMISE"
}

Example HTTP response

Response 202

{
    "routing_rule": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "destination_cidr": "11.11.11.0/24",
        "destination_resource_id": "be3c84238562488e81e4e0675f86be62",
        "destination_resource_name": "ResourceName",
        "destination_type": "ON_PREMISE",
        "id": "c8980aa2bf1e43c9998682f7baaf1c46",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "owner_id": "cd1610830b9046418e4bc67831c533e6",
        "owner_type": "DIRECT_CONNECT",
        "state": "ACTIVE"
    }
}

1.1.3 - Delete Direct Connect

1.1.3.1 - 1.1

delete /v1/direct-connects/{direct_connect_id}

Description

Delete direct connect.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	direct_connect_id required	Direct Connect ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	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/direct-connects/{direct_connect_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 = direct-connect 1.1"

Example HTTP response

Response 202

1.1.3.2 - 1.0

delete /v1/direct-connects/{direct_connect_id}

Description

Delete direct connect.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261130

Parameters

Type	Name	Description	Schema	Default
path	direct_connect_id required	Direct Connect ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	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/direct-connects/{direct_connect_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 = direct-connect 1.0"

Example HTTP response

Response 202

1.1.4 - Delete Routing Rule

1.1.4.1 - 1.1

delete /v1/direct-connects/{direct_connect_id}/routing-rules/{routing_rule_id}

Description

Delete a routing rule.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	direct_connect_id required	Direct Connect ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	string	None
path	routing_rule_id required	Routing Rule ID Example : `c8980aa2bf1e43c9998682f7baaf1c46`	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/direct-connects/{direct_connect_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 = direct-connect 1.1"

Example HTTP response

Response 202

1.1.4.2 - 1.0

delete /v1/direct-connects/{direct_connect_id}/routing-rules/{routing_rule_id}

Description

Delete a routing rule.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261130

Parameters

Type	Name	Description	Schema	Default
path	direct_connect_id required	Direct Connect ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	string	None
path	routing_rule_id required	Routing Rule ID Example : `c8980aa2bf1e43c9998682f7baaf1c46`	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/direct-connects/{direct_connect_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 = direct-connect 1.0"

Example HTTP response

Response 202

1.1.5 - List Direct Connects

1.1.5.1 - 1.1

get /v1/direct-connects

Description

Get direct connect list.

State ACTIVE (CURRENT)

Version	Not Before
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	Direct Connect ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	string
query	name optional	Direct Connect Name Example : `DirectConnectName`	string
query	state optional	State Example : `ACTIVE`	enum (CREATING, ACTIVE, EDITING, 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	DirectConnectListResponseV1Dot1
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/direct-connects

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "direct_connects": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "bandwidth": 1,
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "fe860e0af0c04dcd8182b84f907f31f4",
            "firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
            "id": "fe860e0af0c04dcd8182b84f907f31f4",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "DirectConnectName",
            "state": "ACTIVE",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.1.5.2 - 1.0

get /v1/direct-connects

Description

Get direct connect list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261130

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	Direct Connect ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	string
query	name optional	Direct Connect Name Example : `DirectConnectName`	string
query	state optional	State Example : `ACTIVE`	enum (CREATING, ACTIVE, EDITING, 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	DirectConnectListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/direct-connects

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "direct_connects": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "bandwidth": 1,
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "fe860e0af0c04dcd8182b84f907f31f4",
            "firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
            "id": "fe860e0af0c04dcd8182b84f907f31f4",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "DirectConnectName",
            "state": "ACTIVE",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ],
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

1.1.6 - List Routing Rules

1.1.6.1 - 1.1

get /v1/direct-connects/{direct_connect_id}/routing-rules

Description

Get routing rule list.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	direct_connect_id required	Direct Connect ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	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 : `c8980aa2bf1e43c9998682f7baaf1c46`	any of [string, null]	None
query	destination_type optional	Destination Type Example : `ON_PREMISE`	enum (VPC, ON_PREMISE)	None
query	destination_cidr optional	Destination CIDR Example : `11.11.11.0/24`	any of [string, null]	None
query	state optional	State Example : `ACTIVE`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)	None

Responses

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

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_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 = direct-connect 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "routing_rules": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "TransitGateway Description",
            "destination_cidr": "11.11.11.0/24",
            "destination_resource_id": "be3c84238562488e81e4e0675f86be62",
            "destination_resource_name": "ResourceName",
            "destination_type": "ON_PREMISE",
            "id": "c8980aa2bf1e43c9998682f7baaf1c46",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "owner_id": "cd1610830b9046418e4bc67831c533e6",
            "owner_type": "DIRECT_CONNECT",
            "state": "ACTIVE"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.1.6.2 - 1.0

get /v1/direct-connects/{direct_connect_id}/routing-rules

Description

Get routing rule list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261130

Parameters

Type	Name	Description	Schema	Default
path	direct_connect_id required	Direct Connect ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	string	None
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	Routing Rule ID Example : `c8980aa2bf1e43c9998682f7baaf1c46`	any of [string, null]	None
query	destination_type optional	Destination Type Example : `ON_PREMISE`	enum (VPC, ON_PREMISE)	None
query	destination_cidr optional	Destination CIDR Example : `11.11.11.0/24`	any of [string, null]	None
query	state optional	State Example : `ACTIVE`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)	None

Responses

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

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_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 = direct-connect 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "routing_rules": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "TransitGateway Description",
            "destination_cidr": "11.11.11.0/24",
            "destination_resource_id": "be3c84238562488e81e4e0675f86be62",
            "destination_resource_name": "ResourceName",
            "destination_type": "ON_PREMISE",
            "id": "c8980aa2bf1e43c9998682f7baaf1c46",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "owner_id": "cd1610830b9046418e4bc67831c533e6",
            "owner_type": "DIRECT_CONNECT",
            "state": "ACTIVE"
        }
    ]
}

1.1.7 - Set Direct Connect

1.1.7.1 - 1.1

put /v1/direct-connects/{direct_connect_id}

Description

Set direct connect.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	direct_connect_id required	Direct Connect ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	string	None
body	body required		DirectConnectSetRequest

Responses

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

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_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 = direct-connect 1.1"

Request body

{
    "description": "TransitGateway Description"
}

Example HTTP response

Response 200

{
    "direct_connect": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "fe860e0af0c04dcd8182b84f907f31f4",
        "firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "DirectConnectName",
        "state": "ACTIVE",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

1.1.7.2 - 1.0

put /v1/direct-connects/{direct_connect_id}

Description

Set direct connect.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261130

Parameters

Type	Name	Description	Schema	Default
path	direct_connect_id required	Direct Connect ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	string	None
body	body required		DirectConnectSetRequest

Responses

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

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_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 = direct-connect 1.0"

Request body

{
    "description": "TransitGateway Description"
}

Example HTTP response

Response 200

{
    "direct_connect": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "fe860e0af0c04dcd8182b84f907f31f4",
        "firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "DirectConnectName",
        "state": "ACTIVE",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

1.1.8 - Show Direct Connect

1.1.8.1 - 1.1

get /v1/direct-connects/{direct_connect_id}

Description

Show direct connect.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	direct_connect_id required	Direct Connect ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	string	None

Responses

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

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_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 = direct-connect 1.1"

Example HTTP response

Response 200

{
    "direct_connect": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "fe860e0af0c04dcd8182b84f907f31f4",
        "firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "DirectConnectName",
        "state": "ACTIVE",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

1.1.8.2 - 1.0

get /v1/direct-connects/{direct_connect_id}

Description

Show direct connect.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20261130

Parameters

Type	Name	Description	Schema	Default
path	direct_connect_id required	Direct Connect ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	string	None

Responses

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

Example HTTP request

Request path

/v1/direct-connects/{direct_connect_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 = direct-connect 1.0"

Example HTTP response

Response 200

{
    "direct_connect": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "fe860e0af0c04dcd8182b84f907f31f4",
        "firewall_id": "dffc455f1bd14e0594e4faa638aac3a1",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "DirectConnectName",
        "state": "ACTIVE",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

1.2 - Models

1.2.1 - DirectConnect

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	string
bandwidth required	Port Bandwidth Example : `1`	integer
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	Direct Connect Description Example : `fe860e0af0c04dcd8182b84f907f31f4`	any of [string, null]
firewall_id optional	Firewall ID Example : `dffc455f1bd14e0594e4faa638aac3a1`	any of [string, null]
id required	Direct Connect ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	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	Direct Connect Name Example : `DirectConnectName` Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
state required	State Example : `ACTIVE`	enum (CREATING, ACTIVE, EDITING, DELETING, DELETED, ERROR)
vpc_id required	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	string
vpc_name required	VPC Name Example : `vpcName`	string

1.2.2 - DirectConnectCreateRequest

Name	Description	Schema
bandwidth required	Port Bandwidth Example : `1`	integer
description optional	Direct Connect Description Example : `TransitGateway Description` Maximum length : `50`	string
firewall_enabled optional	Firewall Use Example : `True`	boolean
firewall_loggable optional	Firewall Loggable Example : `True`	boolean
name required	Direct Connect Name Example : `DirectConnectName` Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
tags optional	Tag List Example : `[{'key': 'key', 'value': 'value'}]`	array[Tag]
vpc_id required	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	string

1.2.3 - DirectConnectListResponse

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

1.2.4 - DirectConnectListResponseV1Dot1

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

1.2.5 - DirectConnectSetRequest

Name	Description	Schema	Default
description required	Direct Connect Description Example : `TransitGateway Description` Maximum length : `50`	string

1.2.6 - DirectConnectShowResponse

Name	Description	Schema	Default
direct_connect required		DirectConnect

1.2.7 - RoutingRule

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	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 : `TransitGateway Description`	string
destination_cidr required	Destination CIDR Example : `11.11.11.0/24`	string
destination_resource_id required	Destination Resource ID Example : `be3c84238562488e81e4e0675f86be62`	any of [string, null]
destination_resource_name optional	Destination Resource Name Example : `ResourceName`	any of [string, null]
destination_type required	Destination Type Example : `ON_PREMISE`	enum (VPC, ON_PREMISE, INTERNET, TGW)
id required	Routing Rule ID Example : `c8980aa2bf1e43c9998682f7baaf1c46`	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
owner_id required	Routing Rule Owner ID Example : `cd1610830b9046418e4bc67831c533e6`	string
owner_type required	Routing Rule Owner Type Example : `DIRECT_CONNECT`	enum (INTERNET_GATEWAY, GROUP_GATEWAY, DIRECT_CONNECT, SUBNET, PRIVATE_NAT, TRANSIT_GATEWAY, VPC_PEERING, SECURE_INTERNET_GATEWAY)
state required	State Example : `ACTIVE`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)

1.2.8 - RoutingRuleCreateRequest

Name	Description	Schema
description optional	Description Example : `TransitGateway Description` Maximum length : `50`	string
destination_cidr required	Destination CIDR Example : `11.11.11.0/24`	string
destination_resource_id optional	Destination Resource ID Example : `be3c84238562488e81e4e0675f86be62`	any of [string, null]
destination_type required	Destination Type Example : `ON_PREMISE`	enum (VPC, ON_PREMISE)

1.2.9 - RoutingRuleListResponse

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]
routing_rules required		array[RoutingRule]

1.2.10 - RoutingRuleListResponseV1Dot1

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

1.2.11 - RoutingRuleShowResponse

Name	Description	Schema	Default
routing_rule required		RoutingRule

1.2.12 - Tag

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

2 - DNS

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 DNS service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.

Version

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

Version	Status	Not Before
1.3	CURRENT	-
1.2	DEPRECATED	20260331
1.1	DEPRECATED	20260331

OpenAPI URL

https://dns.{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

2.1 - APIs

2.1.1 - Activate Private DNS

2.1.1.1 - 1.3

post /v1/private-dns/activate

Description

Activate Private DNS

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		PrivateDnsActivateRequest

Responses

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

Example HTTP request

Request path

/v1/private-dns/activate

Request header

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

Request body

{
    "name": "private-dns01"
}

Example HTTP response

Response 202

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.1.2 - 1.2

post /v1/private-dns/activate

Description

Activate Private DNS

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		PrivateDnsActivateRequest

Responses

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

Example HTTP request

Request path

/v1/private-dns/activate

Request header

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

Request body

{
    "name": "private-dns01"
}

Example HTTP response

Response 202

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.1.3 - 1.1

post /v1/private-dns/activate

Description

Activate Private DNS

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		PrivateDnsActivateRequest

Responses

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

Example HTTP request

Request path

/v1/private-dns/activate

Request header

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

Request body

{
    "name": "private-dns01"
}

Example HTTP response

Response 202

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.2 - Create Hosted Zone

2.1.2.1 - 1.3

post /v1/hosted-zones

Description

Create a new hosted zone.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		HostedZoneCreateRequestV1Dot3

Responses

HTTP Code	Description	Schema
202	Accepted	HostedZoneShowResponseV1Dot3
400	Bad Request	None
403	Forbidden	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones

Request header

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

Request body

{
    "description": "This is description",
    "name": "my-zone.com",
    "private_dns_id": "10fjkewefprivatedns3193rud543",
    "tags": [],
    "type": "private"
}

Example HTTP response

Response 202

{
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "description": "This is description",
    "hosted_zone_type": "public",
    "id": "3432012nfdksdf03ktrld9234lgfg",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "my-zone.com",
    "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
    "private_dns_id": "10fjkewefprivatedns3193rud543",
    "private_dns_name": "private-dns01",
    "status": "CREATING",
    "ttl": "3600"
}

2.1.2.2 - 1.2

post /v1/hosted-zones

Description

Create a new hosted zone.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		HostedZoneCreateRequestV1Dot2

Responses

HTTP Code	Description	Schema
202	Accepted	HostedZoneShowResponseV1Dot2
400	Bad Request	None
403	Forbidden	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones

Request header

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

Request body

{
    "description": "This is description",
    "email": "test@samsung.com",
    "name": "my-zone.com",
    "private_dns_id": "",
    "tags": [],
    "type": "public"
}

Example HTTP response

Response 202

{
    "action": "",
    "attributes": "",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "email": "test@samsung.com",
    "hosted_zone_type": "public",
    "id": "3432012nfdksdf03ktrld9234lgfg",
    "links": "",
    "masters": [
        ""
    ],
    "name": "my-zone.com",
    "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
    "private_dns_id": "10fjkewefprivatedns3193rud543",
    "private_dns_name": "private-dns01",
    "project_id": "",
    "serial": "",
    "shared": "",
    "status": "ACTIVE",
    "transferred_at": "",
    "ttl": 3600,
    "type": "",
    "updated_at": "",
    "version": ""
}

2.1.2.3 - 1.1

post /v1/hosted-zones

Description

Create a new hosted zone.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		HostedZoneCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	HostedZoneCreateResponse
400	Bad Request	None
403	Forbidden	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones

Request header

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

Request body

{
    "description": "This is description",
    "email": "test@samsung.com",
    "name": "my-zone.com",
    "tags": [],
    "type": "public"
}

Example HTTP response

Response 202

{
    "action": "",
    "attributes": "",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "email": "test@samsung.com",
    "hosted_zone_type": "public",
    "id": "3432012nfdksdf03ktrld9234lgfg",
    "links": "",
    "masters": [
        ""
    ],
    "name": "my-zone.com",
    "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
    "project_id": "",
    "serial": "",
    "shared": "",
    "status": "ACTIVE",
    "transferred_at": "",
    "ttl": 3600,
    "type": "",
    "updated_at": "",
    "version": ""
}

2.1.3 - Create Hosted Zone Record

2.1.3.1 - 1.3

post /v1/hosted-zones/{hosted_zone_id}/records

Description

Create a new recordset in the hosted zone

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	string	None
body	body required		RecordCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	RecordCreateResponse
400	Bad Request	None
403	Forbidden	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records

Request header

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

Request body

{
    "description": "This is description",
    "name": "test.app",
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "ttl": 3600,
    "type": "A"
}

Example HTTP response

Response 202

{
    "action": "CREATE",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
    "links": "",
    "name": "test.app",
    "project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "status": "ACTIVE",
    "ttl": 3600,
    "type": "A",
    "updated_at": "2026-02-09T08:00:40Z",
    "version": 1,
    "zone_id": "3432012nfdksdf03ktrld9234lgfg",
    "zone_name": "my-zone.com"
}

2.1.4 - Create Private DNS

2.1.4.1 - 1.3

post /v1/private-dns

Description

Create Private DNS

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		PrivateDnsCreateRequest

Responses

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

Example HTTP request

Request path

/v1/private-dns

Request header

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

Request body

{
    "connected_vpc_ids": [],
    "description": "This is description",
    "name": "private-dns01",
    "tags": [
        {
            "key": "",
            "value": ""
        }
    ]
}

Example HTTP response

Response 202

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.4.2 - 1.2

post /v1/private-dns

Description

Create Private DNS

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		PrivateDnsCreateRequest

Responses

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

Example HTTP request

Request path

/v1/private-dns

Request header

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

Request body

{
    "connected_vpc_ids": [],
    "description": "This is description",
    "name": "private-dns01",
    "tags": [
        {
            "key": "",
            "value": ""
        }
    ]
}

Example HTTP response

Response 202

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.4.3 - 1.1

post /v1/private-dns

Description

Create Private DNS

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		PrivateDnsCreateRequest

Responses

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

Example HTTP request

Request path

/v1/private-dns

Request header

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

Request body

{
    "connected_vpc_ids": [],
    "description": "This is description",
    "name": "private-dns01",
    "tags": [
        {
            "key": "",
            "value": ""
        }
    ]
}

Example HTTP response

Response 202

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.5 - Create Public Domain

2.1.5.1 - 1.2

post /v1/public-domain-names

Description

Create a new Public Domain record

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		CreatePublicDomainRequest

Responses

HTTP Code	Description	Schema
201	Created	CreatePublicDomainResponse
400	Bad Request	None
403	Forbidden	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/public-domain-names

Request header

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

Request body

{
    "address_type": "DOMESTIC",
    "auto_extension": true,
    "description": "This is description",
    "domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
    "domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
    "domestic_second_address_en": "West Campus 1F",
    "domestic_second_address_ko": "서관 1층",
    "name": "example.com",
    "overseas_first_address": "123 Main St",
    "overseas_second_address": "New York",
    "overseas_third_address": "NY 10001",
    "postal_code": "12345",
    "register_email": "admin@example.com",
    "register_name_en": "Hong Gildong",
    "register_name_ko": "홍길동",
    "register_telno": "010-1234-5678",
    "tags": []
}

Example HTTP response

Response 201

{
    "public_domain_name": {
        "address_type": "DOMESTIC",
        "auto_extension": true,
        "created_at": "2025-09-08T03:43:57Z",
        "created_by": "504f24f8111e42e0578f367acd2a149f",
        "description": "This is description",
        "domestic_address_en": "West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul",
        "domestic_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층",
        "domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
        "domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
        "domestic_second_address_en": "West Campus 1F",
        "domestic_second_address_ko": "서관 1층",
        "expired_date": "2026-09-09T00:00:00Z",
        "id": "10fjkeweffpublicdomain3193rud543",
        "modified_at": "2026-02-09T08:00:40Z",
        "modified_by": "504f24f8111e42e0578f367acd2a149f",
        "name": "example.com",
        "overseas_address": "123 Main St, New York, NY 10001",
        "overseas_first_address": "123 Main St",
        "overseas_second_address": "New York",
        "overseas_third_address": "NY 10001",
        "postal_code": "12345",
        "register_email": "admin@example.com",
        "register_name_en": "Hong Gildong",
        "register_name_ko": "홍길동",
        "register_telno": "010-1234-5678",
        "start_date": "2025-09-09T00:00:00Z",
        "status": "REGISTERED"
    }
}

2.1.5.2 - 1.1

post /v1/public-domain-names

Description

Create a new Public Domain record

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		CreatePublicDomainRequest

Responses

HTTP Code	Description	Schema
201	Created	CreatePublicDomainResponse
400	Bad Request	None
403	Forbidden	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/public-domain-names

Request header

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

Request body

{
    "address_type": "DOMESTIC",
    "auto_extension": true,
    "description": "This is description",
    "domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
    "domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
    "domestic_second_address_en": "West Campus 1F",
    "domestic_second_address_ko": "서관 1층",
    "name": "example.com",
    "overseas_first_address": "123 Main St",
    "overseas_second_address": "New York",
    "overseas_third_address": "NY 10001",
    "postal_code": "12345",
    "register_email": "admin@example.com",
    "register_name_en": "Hong Gildong",
    "register_name_ko": "홍길동",
    "register_telno": "010-1234-5678",
    "tags": []
}

Example HTTP response

Response 201

{
    "public_domain_name": {
        "address_type": "DOMESTIC",
        "auto_extension": true,
        "created_at": "2025-09-08T03:43:57Z",
        "created_by": "504f24f8111e42e0578f367acd2a149f",
        "description": "This is description",
        "domestic_address_en": "West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul",
        "domestic_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층",
        "domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
        "domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
        "domestic_second_address_en": "West Campus 1F",
        "domestic_second_address_ko": "서관 1층",
        "expired_date": "2026-09-09T00:00:00Z",
        "id": "10fjkeweffpublicdomain3193rud543",
        "modified_at": "2026-02-09T08:00:40Z",
        "modified_by": "504f24f8111e42e0578f367acd2a149f",
        "name": "example.com",
        "overseas_address": "123 Main St, New York, NY 10001",
        "overseas_first_address": "123 Main St",
        "overseas_second_address": "New York",
        "overseas_third_address": "NY 10001",
        "postal_code": "12345",
        "register_email": "admin@example.com",
        "register_name_en": "Hong Gildong",
        "register_name_ko": "홍길동",
        "register_telno": "010-1234-5678",
        "start_date": "2025-09-09T00:00:00Z",
        "status": "REGISTERED"
    }
}

2.1.6 - Create Public Domain Name

2.1.6.1 - 1.3

post /v1/public-domain-names

Description

Create a new Public Domain Name

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		CreatePublicDomainRequest

Responses

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

Example HTTP request

Request path

/v1/public-domain-names

Request header

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

Request body

{
    "address_type": "DOMESTIC",
    "auto_extension": true,
    "description": "This is description",
    "domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
    "domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
    "domestic_second_address_en": "West Campus 1F",
    "domestic_second_address_ko": "서관 1층",
    "name": "example.com",
    "overseas_first_address": "123 Main St",
    "overseas_second_address": "New York",
    "overseas_third_address": "NY 10001",
    "postal_code": "12345",
    "register_email": "admin@example.com",
    "register_name_en": "Hong Gildong",
    "register_name_ko": "홍길동",
    "register_telno": "010-1234-5678",
    "tags": []
}

Example HTTP response

Response 201

{
    "public_domain_name": {
        "address_type": "DOMESTIC",
        "auto_extension": true,
        "created_at": "2025-09-08T03:43:57Z",
        "created_by": "504f24f8111e42e0578f367acd2a149f",
        "description": "This is description",
        "domestic_address_en": "West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul",
        "domestic_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층",
        "domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
        "domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
        "domestic_second_address_en": "West Campus 1F",
        "domestic_second_address_ko": "서관 1층",
        "expired_date": "2026-09-09T00:00:00Z",
        "id": "10fjkeweffpublicdomain3193rud543",
        "modified_at": "2026-02-09T08:00:40Z",
        "modified_by": "504f24f8111e42e0578f367acd2a149f",
        "name": "example.com",
        "overseas_address": "123 Main St, New York, NY 10001",
        "overseas_first_address": "123 Main St",
        "overseas_second_address": "New York",
        "overseas_third_address": "NY 10001",
        "postal_code": "12345",
        "register_email": "admin@example.com",
        "register_name_en": "Hong Gildong",
        "register_name_ko": "홍길동",
        "register_telno": "010-1234-5678",
        "start_date": "2025-09-09T00:00:00Z",
        "status": "REGISTERED"
    }
}

2.1.7 - Create Record

2.1.7.1 - 1.2

post /v1/hosted-zones/{hosted_zone_id}/records

Description

Create a new recordset in the hosted zone

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	string	None
body	body required		RecordCreateRequestV1Dot1To1Dot2

Responses

HTTP Code	Description	Schema
202	Accepted	RecordCreateResponse
400	Bad Request	None
403	Forbidden	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records

Request header

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

Request body

{
    "description": "This is description",
    "name": "test.app",
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "ttl": 3600,
    "type": "A"
}

Example HTTP response

Response 202

{
    "action": "CREATE",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
    "links": "",
    "name": "test.app",
    "project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "status": "ACTIVE",
    "ttl": 3600,
    "type": "A",
    "updated_at": "2026-02-09T08:00:40Z",
    "version": 1,
    "zone_id": "3432012nfdksdf03ktrld9234lgfg",
    "zone_name": "my-zone.com"
}

2.1.7.2 - 1.1

post /v1/hosted-zones/{hosted_zone_id}/records

Description

Create a new recordset in the hosted zone

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	string	None
body	body required		RecordCreateRequestV1Dot1To1Dot2

Responses

HTTP Code	Description	Schema
202	Accepted	RecordCreateResponse
400	Bad Request	None
403	Forbidden	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records

Request header

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

Request body

{
    "description": "This is description",
    "name": "test.app",
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "ttl": 3600,
    "type": "A"
}

Example HTTP response

Response 202

{
    "action": "CREATE",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
    "links": "",
    "name": "test.app",
    "project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "status": "ACTIVE",
    "ttl": 3600,
    "type": "A",
    "updated_at": "2026-02-09T08:00:40Z",
    "version": 1,
    "zone_id": "3432012nfdksdf03ktrld9234lgfg",
    "zone_name": "my-zone.com"
}

2.1.8 - Delete Hosted Zone

2.1.8.1 - 1.3

delete /v1/hosted-zones/{hosted_zone_id}

Description

Delete a hosted zone

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	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/hosted-zones/{hosted_zone_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 = dns 1.3"

Example HTTP response

Response 202

2.1.8.2 - 1.2

delete /v1/hosted-zones/{hosted_zone_id}

Description

Delete a hosted zone

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	string	None

Responses

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

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_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 = dns 1.2"

Example HTTP response

Response 202

{
    "action": "",
    "attributes": "",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "email": "test@samsung.com",
    "hosted_zone_type": "public",
    "id": "3432012nfdksdf03ktrld9234lgfg",
    "links": "",
    "masters": [
        ""
    ],
    "name": "my-zone.com",
    "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
    "private_dns_id": "10fjkewefprivatedns3193rud543",
    "private_dns_name": "private-dns01",
    "project_id": "",
    "serial": "",
    "shared": "",
    "status": "ACTIVE",
    "transferred_at": "",
    "ttl": 3600,
    "type": "",
    "updated_at": "",
    "version": ""
}

2.1.8.3 - 1.1

delete /v1/hosted-zones/{hosted_zone_id}

Description

Delete a hosted zone

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	string	None

Responses

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

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_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 = dns 1.1"

Example HTTP response

Response 202

{
    "action": "",
    "attributes": "",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "email": "test@samsung.com",
    "hosted_zone_type": "public",
    "id": "3432012nfdksdf03ktrld9234lgfg",
    "links": "",
    "masters": [
        ""
    ],
    "name": "my-zone.com",
    "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
    "project_id": "",
    "serial": "",
    "shared": "",
    "status": "ACTIVE",
    "transferred_at": "",
    "ttl": 3600,
    "type": "",
    "updated_at": "",
    "version": ""
}

2.1.9 - Delete Hosted Zone Record

2.1.9.1 - 1.3

delete /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Delete hosted zone record

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Hosted Zone ID Example : `3432012nfdksdf03ktrld9234lgfg`	string	None
path	record_id required	Record ID Example : `6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7`	string	None

Responses

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

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_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 = dns 1.3"

Example HTTP response

Response 202

{
    "action": "CREATE",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
    "links": "",
    "name": "test.app",
    "project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "status": "ACTIVE",
    "ttl": 3600,
    "type": "A",
    "updated_at": "2026-02-09T08:00:40Z",
    "version": 1,
    "zone_id": "3432012nfdksdf03ktrld9234lgfg",
    "zone_name": "my-zone.com"
}

2.1.10 - Delete Private DNS

2.1.10.1 - 1.3

delete /v1/private-dns/{private_dns_id}

Description

Delete Private DNS

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	private_dns_id required	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	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/private-dns/{private_dns_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 = dns 1.3"

Example HTTP response

Response 202

2.1.10.2 - 1.2

delete /v1/private-dns/{private_dns_id}

Description

Delete Private DNS

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	private_dns_id required	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	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/private-dns/{private_dns_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 = dns 1.2"

Example HTTP response

Response 202

2.1.10.3 - 1.1

delete /v1/private-dns/{private_dns_id}

Description

Delete Private DNS

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	private_dns_id required	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	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/private-dns/{private_dns_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 = dns 1.1"

Example HTTP response

Response 202

2.1.11 - Delete Record

2.1.11.1 - 1.2

delete /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Delete a recordset

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Hosted Zone ID Example : `3432012nfdksdf03ktrld9234lgfg`	string	None
path	record_id required	Record ID Example : `6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7`	string	None

Responses

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

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_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 = dns 1.2"

Example HTTP response

Response 202

{
    "action": "CREATE",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
    "links": "",
    "name": "test.app",
    "project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "status": "ACTIVE",
    "ttl": 3600,
    "type": "A",
    "updated_at": "2026-02-09T08:00:40Z",
    "version": 1,
    "zone_id": "3432012nfdksdf03ktrld9234lgfg",
    "zone_name": "my-zone.com"
}

2.1.11.2 - 1.1

delete /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Delete a recordset

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Hosted Zone ID Example : `3432012nfdksdf03ktrld9234lgfg`	string	None
path	record_id required	Record ID Example : `6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7`	string	None

Responses

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

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_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 = dns 1.1"

Example HTTP response

Response 202

{
    "action": "CREATE",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
    "links": "",
    "name": "test.app",
    "project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "status": "ACTIVE",
    "ttl": 3600,
    "type": "A",
    "updated_at": "2026-02-09T08:00:40Z",
    "version": 1,
    "zone_id": "3432012nfdksdf03ktrld9234lgfg",
    "zone_name": "my-zone.com"
}

2.1.12 - Get Public Domain Detail

2.1.12.1 - 1.2

get /v1/public-domain-names/{public_domain_id}

Description

Retrieve detailed information for a specific public domain by ID

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	ID Example : `10fjkeweffpublicdomain3193rud543`	string	None

Responses

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

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_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 = dns 1.2"

Example HTTP response

Response 200

{
    "public_domain_name": {
        "address_type": "DOMESTIC",
        "auto_extension": true,
        "created_at": "2025-09-08T03:43:57Z",
        "created_by": "504f24f8111e42e0578f367acd2a149f",
        "description": "This is description",
        "domestic_address_en": "West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul",
        "domestic_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층",
        "domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
        "domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
        "domestic_second_address_en": "West Campus 1F",
        "domestic_second_address_ko": "서관 1층",
        "expired_date": "2026-09-09T00:00:00Z",
        "id": "10fjkeweffpublicdomain3193rud543",
        "modified_at": "2026-02-09T08:00:40Z",
        "modified_by": "504f24f8111e42e0578f367acd2a149f",
        "name": "example.com",
        "overseas_address": "123 Main St, New York, NY 10001",
        "overseas_first_address": "123 Main St",
        "overseas_second_address": "New York",
        "overseas_third_address": "NY 10001",
        "postal_code": "12345",
        "register_email": "admin@example.com",
        "register_name_en": "Hong Gildong",
        "register_name_ko": "홍길동",
        "register_telno": "010-1234-5678",
        "start_date": "2025-09-09T00:00:00Z",
        "status": "REGISTERED"
    }
}

2.1.12.2 - 1.1

get /v1/public-domain-names/{public_domain_id}

Description

Retrieve detailed information for a specific public domain by ID

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	ID Example : `10fjkeweffpublicdomain3193rud543`	string	None

Responses

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

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_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 = dns 1.1"

Example HTTP response

Response 200

{
    "public_domain_name": {
        "address_type": "DOMESTIC",
        "auto_extension": true,
        "created_at": "2025-09-08T03:43:57Z",
        "created_by": "504f24f8111e42e0578f367acd2a149f",
        "description": "This is description",
        "domestic_address_en": "West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul",
        "domestic_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층",
        "domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
        "domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
        "domestic_second_address_en": "West Campus 1F",
        "domestic_second_address_ko": "서관 1층",
        "expired_date": "2026-09-09T00:00:00Z",
        "id": "10fjkeweffpublicdomain3193rud543",
        "modified_at": "2026-02-09T08:00:40Z",
        "modified_by": "504f24f8111e42e0578f367acd2a149f",
        "name": "example.com",
        "overseas_address": "123 Main St, New York, NY 10001",
        "overseas_first_address": "123 Main St",
        "overseas_second_address": "New York",
        "overseas_third_address": "NY 10001",
        "postal_code": "12345",
        "register_email": "admin@example.com",
        "register_name_en": "Hong Gildong",
        "register_name_ko": "홍길동",
        "register_telno": "010-1234-5678",
        "start_date": "2025-09-09T00:00:00Z",
        "status": "REGISTERED"
    }
}

2.1.13 - List Hosted Zone Records

2.1.13.1 - 1.3

get /v1/hosted-zones/{hosted_zone_id}/records

Description

Get record list in a hosted zone

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	string	None
query	limit optional	limit Example :	any of [integer, null]	None
query	marker optional	marker Example :	any of [string, null]	None
query	sort_dir optional	sort direction Example :	any of [string, null]	None
query	sort_key optional	sort key Example :	any of [string, null]	None
query	name optional	name Example : `test.app`	any of [string, null]	None
query	exact_name optional	name Example : `test.app`	any of [string, null]	None
query	type optional	Type of the record Example : `A`	any of [string, null]	None
query	data optional	Record data Example : `12345.ns.private.kr-west1.dev2.samsungsdscloud.com`	any of [string, null]	None
query	status optional	The status Example : `ACTIVE`	any of [string, null]	None
query	description optional	description Example : `This is description`	any of [string, null]	None
query	ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]	None

Responses

HTTP Code	Description	Schema
200	OK	RecordListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": "",
    "metadata": "",
    "records": [
        {
            "action": "CREATE",
            "created_at": "2025-09-08T03:43:57Z",
            "description": "This is description",
            "id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
            "links": "",
            "name": "test.app",
            "project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
            "records": [
                "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
            ],
            "status": "ACTIVE",
            "ttl": 3600,
            "type": "A",
            "updated_at": "2026-02-09T08:00:40Z",
            "version": 1,
            "zone_id": "3432012nfdksdf03ktrld9234lgfg",
            "zone_name": "my-zone.com"
        }
    ]
}

2.1.14 - List Hosted Zones

2.1.14.1 - 1.3

get /v1/hosted-zones

Description

Return list of hosted zones

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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	name Example : `my-zone.com`	any of [string, null]	None
query	type optional	Type of zone Example :	any of [enum (public, private), null]	None
query	status optional	The status Example :	any of [enum (CREATING, EDITING, ACTIVE, DELETING, DELETED, ERROR, PENDING, UNKNOWN), null]	None

Responses

HTTP Code	Description	Schema
200	OK	HostedZoneListResponseV1Dot3
403	Forbidden	None

Example HTTP request

Request path

/v1/hosted-zones

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "hosted_zones": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "This is description",
            "hosted_zone_type": "public",
            "id": "3432012nfdksdf03ktrld9234lgfg",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "my-zone.com",
            "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
            "private_dns_id": "10fjkewefprivatedns3193rud543",
            "private_dns_name": "private-dns01",
            "status": "CREATING",
            "ttl": "3600"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2.1.14.2 - 1.2

get /v1/hosted-zones

Description

Return list of hosted zones

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
query	name optional	name Example : `my-zone.com`	any of [string, null]	None
query	exact_name optional	name Example : `my-zone.com`	any of [string, null]	None
query	type optional	Type of zone Example : `public`	any of [string, null]	None
query	email optional	email Example : `test@samsung.com`	any of [string, null]	None
query	status optional	The status Example : `ACTIVE`	any of [string, null]	None
query	description optional	description Example : `This is description`	any of [string, null]	None
query	ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]	None
query	page optional	Page Example : `0`	any of [integer, null]	0
query	size optional	Size Example : `20`	any of [integer, null]	20
query	sort optional	Sort Example : `name:asc`	any of [string, null]	name:asc

Responses

HTTP Code	Description	Schema
200	OK	HostedZoneListResponseV1Dot2
403	Forbidden	None

Example HTTP request

Request path

/v1/hosted-zones

Request header

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

Example HTTP response

Response 200

{
    "count": "",
    "hosted_zones": [
        {
            "action": "",
            "attributes": "",
            "created_at": "2025-09-08T03:43:57Z",
            "description": "This is description",
            "email": "test@samsung.com",
            "hosted_zone_type": "public",
            "id": "3432012nfdksdf03ktrld9234lgfg",
            "links": "",
            "masters": [
                ""
            ],
            "name": "my-zone.com",
            "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
            "private_dns_id": "10fjkewefprivatedns3193rud543",
            "private_dns_name": "private-dns01",
            "project_id": "",
            "serial": "",
            "shared": "",
            "status": "ACTIVE",
            "transferred_at": "",
            "ttl": 3600,
            "type": "",
            "updated_at": "",
            "version": ""
        }
    ],
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "page": "",
    "size": "",
    "sort": ""
}

2.1.14.3 - 1.1

get /v1/hosted-zones

Description

Return list of hosted zones

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
query	name optional	name Example : `my-zone.com`	any of [string, null]	None
query	exact_name optional	name Example : `my-zone.com`	any of [string, null]	None
query	type optional	Type of zone Example : `public`	any of [string, null]	None
query	email optional	email Example : `test@samsung.com`	any of [string, null]	None
query	status optional	The status Example : `ACTIVE`	any of [string, null]	None
query	description optional	description Example : `This is description`	any of [string, null]	None
query	ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]	None
query	page optional	Page Example : `0`	any of [integer, null]	0
query	size optional	Size Example : `20`	any of [integer, null]	20
query	sort optional	Sort Example : `name:asc`	any of [string, null]	name:asc

Responses

HTTP Code	Description	Schema
200	OK	HostedZoneListResponseV1Dot1
403	Forbidden	None

Example HTTP request

Request path

/v1/hosted-zones

Request header

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

Example HTTP response

Response 200

{
    "count": "",
    "hosted_zones": [
        {
            "action": "",
            "attributes": "",
            "created_at": "2025-09-08T03:43:57Z",
            "description": "This is description",
            "email": "test@samsung.com",
            "hosted_zone_type": "public",
            "id": "3432012nfdksdf03ktrld9234lgfg",
            "links": "",
            "masters": [
                ""
            ],
            "name": "my-zone.com",
            "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
            "project_id": "",
            "serial": "",
            "shared": "",
            "status": "ACTIVE",
            "transferred_at": "",
            "ttl": 3600,
            "type": "",
            "updated_at": "",
            "version": ""
        }
    ],
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "page": "",
    "size": "",
    "sort": ""
}

2.1.15 - List Private DNS

2.1.15.1 - 1.3

get /v1/private-dns

Description

List all Private DNS

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	any of [string, null]	None
query	name optional	Private DNS Name Example :	any of [string, null]	None
query	vpc_id optional	Connected VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	state optional	State Example : `ACTIVE`	any of [enum (CREATING, EDITING, ACTIVE, ACTIVATING, INACTIVE, DELETING, DELETED, ERROR, PENDING), null]	None

Responses

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

Example HTTP request

Request path

/v1/private-dns

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_dns": [
        {
            "auth_dns_name": "",
            "connected_vpc_ids": [
                ""
            ],
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "This is description",
            "id": "10fjkewefprivatedns3193rud543",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "private-dns01",
            "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
            "pool_name": "",
            "registered_region": "KR-WEST1",
            "resolver_ip": "198.19.0.101",
            "resolver_name": "",
            "state": "CREATING"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2.1.15.2 - 1.2

get /v1/private-dns

Description

List all Private DNS

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260331

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	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	any of [string, null]	None
query	name optional	Private DNS Name Example :	any of [string, null]	None
query	vpc_id optional	Connected VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	state optional	State Example : `ACTIVE`	any of [enum (CREATING, EDITING, ACTIVE, ACTIVATING, INACTIVE, DELETING, DELETED, ERROR, PENDING), null]	None

Responses

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

Example HTTP request

Request path

/v1/private-dns

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_dns": [
        {
            "auth_dns_name": "",
            "connected_vpc_ids": [
                ""
            ],
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "This is description",
            "id": "10fjkewefprivatedns3193rud543",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "private-dns01",
            "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
            "pool_name": "",
            "registered_region": "KR-WEST1",
            "resolver_ip": "198.19.0.101",
            "resolver_name": "",
            "state": "CREATING"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2.1.15.3 - 1.1

get /v1/private-dns

Description

List all Private DNS

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

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	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	any of [string, null]	None
query	name optional	Private DNS Name Example :	any of [string, null]	None
query	vpc_id optional	Connected VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	state optional	State Example : `ACTIVE`	any of [enum (CREATING, EDITING, ACTIVE, ACTIVATING, INACTIVE, DELETING, DELETED, ERROR, PENDING), null]	None

Responses

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

Example HTTP request

Request path

/v1/private-dns

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_dns": [
        {
            "auth_dns_name": "",
            "connected_vpc_ids": [
                ""
            ],
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "This is description",
            "id": "10fjkewefprivatedns3193rud543",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "private-dns01",
            "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
            "pool_name": "",
            "registered_region": "KR-WEST1",
            "resolver_ip": "198.19.0.101",
            "resolver_name": "",
            "state": "CREATING"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2.1.16 - List Public Domain Names

2.1.16.1 - 1.3

get /v1/public-domain-names

Description

Return list of Public Domain Names

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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	Public Domain Name Example : `example.com`	any of [string, null]	None
query	created_by optional	Created By_ Example : `504f24f8111e42e0578f367acd2a149f`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/public-domain-names

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "public_domain_names": [
        {
            "created_at": "2025-09-08T03:43:57Z",
            "created_by": "504f24f8111e42e0578f367acd2a149f",
            "expired_date": "2026-09-09T00:00:00Z",
            "id": "10fjkeweffpublicdomain3193rud543",
            "modified_at": "2026-02-09T08:00:40Z",
            "modified_by": "504f24f8111e42e0578f367acd2a149f",
            "name": "example.com",
            "register_email": "admin@example.com",
            "start_date": "2025-09-09T00:00:00Z",
            "status": "REGISTERED"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2.1.17 - List Public Domains

2.1.17.1 - 1.2

get /v1/public-domain-names

Description

List all Public Domains

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260331

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	Public Domain Name Example : `example.com`	any of [string, null]	None
query	created_by optional	Created By_ Example : `504f24f8111e42e0578f367acd2a149f`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/public-domain-names

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "public_domain_names": [
        {
            "created_at": "2025-09-08T03:43:57Z",
            "created_by": "504f24f8111e42e0578f367acd2a149f",
            "expired_date": "2026-09-09T00:00:00Z",
            "id": "10fjkeweffpublicdomain3193rud543",
            "modified_at": "2026-02-09T08:00:40Z",
            "modified_by": "504f24f8111e42e0578f367acd2a149f",
            "name": "example.com",
            "register_email": "admin@example.com",
            "start_date": "2025-09-09T00:00:00Z",
            "status": "REGISTERED"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2.1.17.2 - 1.1

get /v1/public-domain-names

Description

List all Public Domains

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

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	Public Domain Name Example : `example.com`	any of [string, null]	None
query	created_by optional	Created By_ Example : `504f24f8111e42e0578f367acd2a149f`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/public-domain-names

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "public_domain_names": [
        {
            "created_at": "2025-09-08T03:43:57Z",
            "created_by": "504f24f8111e42e0578f367acd2a149f",
            "expired_date": "2026-09-09T00:00:00Z",
            "id": "10fjkeweffpublicdomain3193rud543",
            "modified_at": "2026-02-09T08:00:40Z",
            "modified_by": "504f24f8111e42e0578f367acd2a149f",
            "name": "example.com",
            "register_email": "admin@example.com",
            "start_date": "2025-09-09T00:00:00Z",
            "status": "REGISTERED"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2.1.18 - List Records

2.1.18.1 - 1.2

get /v1/hosted-zones/{hosted_zone_id}/records

Description

Get recordset list in a hosted zone

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	string	None
query	limit optional	limit Example :	any of [integer, null]	None
query	marker optional	marker Example :	any of [string, null]	None
query	sort_dir optional	sort direction Example :	any of [string, null]	None
query	sort_key optional	sort key Example :	any of [string, null]	None
query	name optional	name Example : `test.app`	any of [string, null]	None
query	exact_name optional	name Example : `test.app`	any of [string, null]	None
query	type optional	Type of the record Example : `A`	any of [string, null]	None
query	data optional	Record data Example : `12345.ns.private.kr-west1.dev2.samsungsdscloud.com`	any of [string, null]	None
query	status optional	The status Example : `ACTIVE`	any of [string, null]	None
query	description optional	description Example : `This is description`	any of [string, null]	None
query	ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]	None

Responses

HTTP Code	Description	Schema
200	OK	RecordListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": "",
    "metadata": "",
    "records": [
        {
            "action": "CREATE",
            "created_at": "2025-09-08T03:43:57Z",
            "description": "This is description",
            "id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
            "links": "",
            "name": "test.app",
            "project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
            "records": [
                "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
            ],
            "status": "ACTIVE",
            "ttl": 3600,
            "type": "A",
            "updated_at": "2026-02-09T08:00:40Z",
            "version": 1,
            "zone_id": "3432012nfdksdf03ktrld9234lgfg",
            "zone_name": "my-zone.com"
        }
    ]
}

2.1.18.2 - 1.1

get /v1/hosted-zones/{hosted_zone_id}/records

Description

Get recordset list in a hosted zone

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	string	None
query	limit optional	limit Example :	any of [integer, null]	None
query	marker optional	marker Example :	any of [string, null]	None
query	sort_dir optional	sort direction Example :	any of [string, null]	None
query	sort_key optional	sort key Example :	any of [string, null]	None
query	name optional	name Example : `test.app`	any of [string, null]	None
query	exact_name optional	name Example : `test.app`	any of [string, null]	None
query	type optional	Type of the record Example : `A`	any of [string, null]	None
query	data optional	Record data Example : `12345.ns.private.kr-west1.dev2.samsungsdscloud.com`	any of [string, null]	None
query	status optional	The status Example : `ACTIVE`	any of [string, null]	None
query	description optional	description Example : `This is description`	any of [string, null]	None
query	ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]	None

Responses

HTTP Code	Description	Schema
200	OK	RecordListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "links": "",
    "metadata": "",
    "records": [
        {
            "action": "CREATE",
            "created_at": "2025-09-08T03:43:57Z",
            "description": "This is description",
            "id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
            "links": "",
            "name": "test.app",
            "project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
            "records": [
                "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
            ],
            "status": "ACTIVE",
            "ttl": 3600,
            "type": "A",
            "updated_at": "2026-02-09T08:00:40Z",
            "version": 1,
            "zone_id": "3432012nfdksdf03ktrld9234lgfg",
            "zone_name": "my-zone.com"
        }
    ]
}

2.1.19 - Set Hosted Zone Record

2.1.19.1 - 1.3

put /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Update Hosted Zone record

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Hosted Zone ID Example : `3432012nfdksdf03ktrld9234lgfg`	string	None
path	record_id required	Record ID Example : `6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7`	string	None
body	body required		RecordSetRequest

Responses

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

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_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 = dns 1.3"

Request body

{
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "ttl": 3600
}

Example HTTP response

Response 202

{
    "action": "CREATE",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
    "links": "",
    "name": "test.app",
    "project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "status": "ACTIVE",
    "ttl": 3600,
    "type": "A",
    "updated_at": "2026-02-09T08:00:40Z",
    "version": 1,
    "zone_id": "3432012nfdksdf03ktrld9234lgfg",
    "zone_name": "my-zone.com"
}

2.1.20 - Set Private DNS

2.1.20.1 - 1.3

put /v1/private-dns/{private_dns_id}

Description

Update Private DNS

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	private_dns_id required	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	string	None
body	body required		PrivateDnsSetRequest

Responses

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

Example HTTP request

Request path

/v1/private-dns/{private_dns_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 = dns 1.3"

Request body

{
    "connected_vpc_ids": [
        ""
    ],
    "description": "This is description"
}

Example HTTP response

Response 202

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.20.2 - 1.2

put /v1/private-dns/{private_dns_id}

Description

Update Private DNS

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	private_dns_id required	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	string	None
body	body required		PrivateDnsSetRequest

Responses

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

Example HTTP request

Request path

/v1/private-dns/{private_dns_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 = dns 1.2"

Request body

{
    "connected_vpc_ids": [
        ""
    ],
    "description": "This is description"
}

Example HTTP response

Response 202

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.20.3 - 1.1

put /v1/private-dns/{private_dns_id}

Description

Update Private DNS

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	private_dns_id required	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	string	None
body	body required		PrivateDnsSetRequest

Responses

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

Example HTTP request

Request path

/v1/private-dns/{private_dns_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 = dns 1.1"

Request body

{
    "connected_vpc_ids": [
        ""
    ],
    "description": "This is description"
}

Example HTTP response

Response 202

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.21 - Set Public Domain Name

2.1.21.1 - 1.3

put /v1/public-domain-names/{public_domain_id}

Description

Update Public Domain Name

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	ID Example : `10fjkeweffpublicdomain3193rud543`	string	None
body	body required		PublicDomainPartialUpdateRequest

Responses

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

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_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 = dns 1.3"

Request body

{
    "auto_extension": true,
    "description": "This is description"
}

Example HTTP response

Response 200

{
    "auto_extension": true,
    "description": "This is description",
    "id": "10fjkeweffpublicdomain3193rud543"
}

2.1.22 - Set Public Domain Name Whois Info

2.1.22.1 - 1.3

put /v1/public-domain-names/{public_domain_id}/information

Description

Update Public Domain Name Whois Info

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	ID Example : `10fjkeweffpublicdomain3193rud543`	string	None
body	body required		PubblicDomainWhoisInfoUpdateRequest

Responses

HTTP Code	Description	Schema
200	OK	PublicDomainWhoisInfoUpdateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_id}/information

Request header

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

Request body

{
    "address_type": "DOMESTIC",
    "domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
    "domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
    "domestic_second_address_en": "West Campus 1F",
    "domestic_second_address_ko": "서관 1층",
    "overseas_first_address": "123 Main St",
    "overseas_second_address": "New York",
    "overseas_third_address": "NY 10001",
    "postal_code": "12345",
    "register_email": "admin@example.com",
    "register_telno": "010-1234-5678"
}

Example HTTP response

Response 200

{
    "address_type": "DOMESTIC",
    "domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
    "domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
    "domestic_second_address_en": "West Campus 1F",
    "domestic_second_address_ko": "서관 1층",
    "name": "example.com",
    "overseas_first_address": "123 Main St",
    "overseas_second_address": "New York",
    "overseas_third_address": "NY 10001",
    "postal_code": "12345",
    "register_email": "admin@example.com",
    "register_name_en": "Hong Gildong",
    "register_name_ko": "홍길동",
    "register_telno": "010-1234-5678"
}

2.1.23 - Show Hosted Zone

2.1.23.1 - 1.3

get /v1/hosted-zones/{hosted_zone_id}

Description

Return details of a hosted zone.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	string	None

Responses

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

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_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 = dns 1.3"

Example HTTP response

Response 200

{
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "description": "This is description",
    "hosted_zone_type": "public",
    "id": "3432012nfdksdf03ktrld9234lgfg",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "my-zone.com",
    "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
    "private_dns_id": "10fjkewefprivatedns3193rud543",
    "private_dns_name": "private-dns01",
    "status": "CREATING",
    "ttl": "3600"
}

2.1.23.2 - 1.2

get /v1/hosted-zones/{hosted_zone_id}

Description

Return details of a hosted zone.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	string	None

Responses

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

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_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 = dns 1.2"

Example HTTP response

Response 200

{
    "action": "",
    "attributes": "",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "email": "test@samsung.com",
    "hosted_zone_type": "public",
    "id": "3432012nfdksdf03ktrld9234lgfg",
    "links": "",
    "masters": [
        ""
    ],
    "name": "my-zone.com",
    "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
    "private_dns_id": "10fjkewefprivatedns3193rud543",
    "private_dns_name": "private-dns01",
    "project_id": "",
    "serial": "",
    "shared": "",
    "status": "ACTIVE",
    "transferred_at": "",
    "ttl": 3600,
    "type": "",
    "updated_at": "",
    "version": ""
}

2.1.23.3 - 1.1

get /v1/hosted-zones/{hosted_zone_id}

Description

Return details of a hosted zone.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	string	None

Responses

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

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_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 = dns 1.1"

Example HTTP response

Response 200

{
    "action": "",
    "attributes": "",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "email": "test@samsung.com",
    "hosted_zone_type": "public",
    "id": "3432012nfdksdf03ktrld9234lgfg",
    "links": "",
    "masters": [
        ""
    ],
    "name": "my-zone.com",
    "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
    "project_id": "",
    "serial": "",
    "shared": "",
    "status": "ACTIVE",
    "transferred_at": "",
    "ttl": 3600,
    "type": "",
    "updated_at": "",
    "version": ""
}

2.1.24 - Show Hosted Zone Record

2.1.24.1 - 1.3

get /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Get details of a hosted zone record

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Hosted Zone ID Example : `3432012nfdksdf03ktrld9234lgfg`	string	None
path	record_id required	Record ID Example : `6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7`	string	None

Responses

HTTP Code	Description	Schema
200	OK	RecordShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_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 = dns 1.3"

Example HTTP response

Response 200

{
    "action": "CREATE",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
    "links": "",
    "name": "test.app",
    "project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "status": "ACTIVE",
    "ttl": 3600,
    "type": "A",
    "updated_at": "2026-02-09T08:00:40Z",
    "version": 1,
    "zone_id": "3432012nfdksdf03ktrld9234lgfg",
    "zone_name": "my-zone.com"
}

2.1.25 - Show Private DNS

2.1.25.1 - 1.3

get /v1/private-dns/{private_dns_id}

Description

Show Private DNS

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	private_dns_id required	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	string	None

Responses

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

Example HTTP request

Request path

/v1/private-dns/{private_dns_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 = dns 1.3"

Example HTTP response

Response 200

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.25.2 - 1.2

get /v1/private-dns/{private_dns_id}

Description

Show Private DNS

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	private_dns_id required	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	string	None

Responses

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

Example HTTP request

Request path

/v1/private-dns/{private_dns_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 = dns 1.2"

Example HTTP response

Response 200

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.25.3 - 1.1

get /v1/private-dns/{private_dns_id}

Description

Show Private DNS

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	private_dns_id required	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	string	None

Responses

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

Example HTTP request

Request path

/v1/private-dns/{private_dns_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 = dns 1.1"

Example HTTP response

Response 200

{
    "private_dns": {
        "auth_dns_name": "",
        "connected_vpc_ids": [
            ""
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "This is description",
        "id": "10fjkewefprivatedns3193rud543",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "private-dns01",
        "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
        "pool_name": "",
        "registered_region": "KR-WEST1",
        "resolver_ip": "198.19.0.101",
        "resolver_name": "",
        "state": "CREATING"
    }
}

2.1.26 - Show Public Domain Name

2.1.26.1 - 1.3

get /v1/public-domain-names/{public_domain_id}

Description

Return details of a public domain name

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	ID Example : `10fjkeweffpublicdomain3193rud543`	string	None

Responses

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

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_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 = dns 1.3"

Example HTTP response

Response 200

{
    "public_domain_name": {
        "address_type": "DOMESTIC",
        "auto_extension": true,
        "created_at": "2025-09-08T03:43:57Z",
        "created_by": "504f24f8111e42e0578f367acd2a149f",
        "description": "This is description",
        "domestic_address_en": "West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul",
        "domestic_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층",
        "domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
        "domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
        "domestic_second_address_en": "West Campus 1F",
        "domestic_second_address_ko": "서관 1층",
        "expired_date": "2026-09-09T00:00:00Z",
        "id": "10fjkeweffpublicdomain3193rud543",
        "modified_at": "2026-02-09T08:00:40Z",
        "modified_by": "504f24f8111e42e0578f367acd2a149f",
        "name": "example.com",
        "overseas_address": "123 Main St, New York, NY 10001",
        "overseas_first_address": "123 Main St",
        "overseas_second_address": "New York",
        "overseas_third_address": "NY 10001",
        "postal_code": "12345",
        "register_email": "admin@example.com",
        "register_name_en": "Hong Gildong",
        "register_name_ko": "홍길동",
        "register_telno": "010-1234-5678",
        "start_date": "2025-09-09T00:00:00Z",
        "status": "REGISTERED"
    }
}

2.1.27 - Show Record

2.1.27.1 - 1.2

get /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Get details of a recordset

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Hosted Zone ID Example : `3432012nfdksdf03ktrld9234lgfg`	string	None
path	record_id required	Record ID Example : `6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7`	string	None

Responses

HTTP Code	Description	Schema
200	OK	RecordShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_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 = dns 1.2"

Example HTTP response

Response 200

{
    "action": "CREATE",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
    "links": "",
    "name": "test.app",
    "project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "status": "ACTIVE",
    "ttl": 3600,
    "type": "A",
    "updated_at": "2026-02-09T08:00:40Z",
    "version": 1,
    "zone_id": "3432012nfdksdf03ktrld9234lgfg",
    "zone_name": "my-zone.com"
}

2.1.27.2 - 1.1

get /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Get details of a recordset

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Hosted Zone ID Example : `3432012nfdksdf03ktrld9234lgfg`	string	None
path	record_id required	Record ID Example : `6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7`	string	None

Responses

HTTP Code	Description	Schema
200	OK	RecordShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_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 = dns 1.1"

Example HTTP response

Response 200

{
    "action": "CREATE",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
    "links": "",
    "name": "test.app",
    "project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "status": "ACTIVE",
    "ttl": 3600,
    "type": "A",
    "updated_at": "2026-02-09T08:00:40Z",
    "version": 1,
    "zone_id": "3432012nfdksdf03ktrld9234lgfg",
    "zone_name": "my-zone.com"
}

2.1.28 - Transfer Public Domain Name

2.1.28.1 - 1.3

post /v1/public-domain-names/{public_domain_id}/transfer

Description

Transfer Public Domain Name

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	ID Example : `10fjkeweffpublicdomain3193rud543`	string	None
body	body required		PublicDomainTransferRequest

Responses

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

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_id}/transfer

Request header

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

Request body

{
    "target_account_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
    "type": "REQUEST"
}

Example HTTP response

Response 200

{
    "auto_extension": true,
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "description": "This is description",
    "expired_date": "2026-09-09T00:00:00Z",
    "id": "10fjkeweffpublicdomain3193rud543",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "example.com",
    "start_date": "2025-09-09T00:00:00Z",
    "state": "TRANSFER_REQUESTED"
}

2.1.29 - Update auto_extension or description

2.1.29.1 - 1.2

put /v1/public-domain-names/{public_domain_id}

Description

Update auto_extension or description of a Public Domain

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	ID Example : `10fjkeweffpublicdomain3193rud543`	string	None
body	body required		PublicDomainPartialUpdateRequest

Responses

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

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_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 = dns 1.2"

Request body

{
    "auto_extension": true,
    "description": "This is description"
}

Example HTTP response

Response 200

{
    "auto_extension": true,
    "description": "This is description",
    "id": "10fjkeweffpublicdomain3193rud543"
}

2.1.29.2 - 1.1

put /v1/public-domain-names/{public_domain_id}

Description

Update auto_extension or description of a Public Domain

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	ID Example : `10fjkeweffpublicdomain3193rud543`	string	None
body	body required		PublicDomainPartialUpdateRequest

Responses

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

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_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 = dns 1.1"

Request body

{
    "auto_extension": true,
    "description": "This is description"
}

Example HTTP response

Response 200

{
    "auto_extension": true,
    "description": "This is description",
    "id": "10fjkeweffpublicdomain3193rud543"
}

2.1.30 - Update Hosted Zone

2.1.30.1 - 1.3

put /v1/hosted-zones/{hosted_zone_id}

Description

Update Hosted Zone

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	string	None
body	body required		HostedZoneSetRequestV1Dot3

Responses

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

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_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 = dns 1.3"

Request body

{
    "description": "This is description"
}

Example HTTP response

Response 202

{
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "description": "This is description",
    "hosted_zone_type": "public",
    "id": "3432012nfdksdf03ktrld9234lgfg",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "my-zone.com",
    "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
    "private_dns_id": "10fjkewefprivatedns3193rud543",
    "private_dns_name": "private-dns01",
    "status": "CREATING",
    "ttl": "3600"
}

2.1.30.2 - 1.2

put /v1/hosted-zones/{hosted_zone_id}

Description

Update Hosted Zone

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	string	None
body	body required		HostedZoneSetRequest

Responses

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

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_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 = dns 1.2"

Request body

{
    "description": "This is description",
    "email": "test@samsung.com"
}

Example HTTP response

Response 202

{
    "action": "",
    "attributes": "",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "email": "test@samsung.com",
    "hosted_zone_type": "public",
    "id": "3432012nfdksdf03ktrld9234lgfg",
    "links": "",
    "masters": [
        ""
    ],
    "name": "my-zone.com",
    "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
    "private_dns_id": "10fjkewefprivatedns3193rud543",
    "private_dns_name": "private-dns01",
    "project_id": "",
    "serial": "",
    "shared": "",
    "status": "ACTIVE",
    "transferred_at": "",
    "ttl": 3600,
    "type": "",
    "updated_at": "",
    "version": ""
}

2.1.30.3 - 1.1

put /v1/hosted-zones/{hosted_zone_id}

Description

Update Hosted Zone

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	string	None
body	body required		HostedZoneSetRequest

Responses

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

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_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 = dns 1.1"

Request body

{
    "description": "This is description",
    "email": "test@samsung.com"
}

Example HTTP response

Response 202

{
    "action": "",
    "attributes": "",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "email": "test@samsung.com",
    "hosted_zone_type": "public",
    "id": "3432012nfdksdf03ktrld9234lgfg",
    "links": "",
    "masters": [
        ""
    ],
    "name": "my-zone.com",
    "pool_id": "10fjksdpooliddfsi12389esfdslkdsr32",
    "project_id": "",
    "serial": "",
    "shared": "",
    "status": "ACTIVE",
    "transferred_at": "",
    "ttl": 3600,
    "type": "",
    "updated_at": "",
    "version": ""
}

2.1.31 - Update Record

2.1.31.1 - 1.2

put /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Update a recordset

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Hosted Zone ID Example : `3432012nfdksdf03ktrld9234lgfg`	string	None
path	record_id required	Record ID Example : `6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7`	string	None
body	body required		RecordSetRequest

Responses

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

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_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 = dns 1.2"

Request body

{
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "ttl": 3600
}

Example HTTP response

Response 202

{
    "action": "CREATE",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
    "links": "",
    "name": "test.app",
    "project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "status": "ACTIVE",
    "ttl": 3600,
    "type": "A",
    "updated_at": "2026-02-09T08:00:40Z",
    "version": 1,
    "zone_id": "3432012nfdksdf03ktrld9234lgfg",
    "zone_name": "my-zone.com"
}

2.1.31.2 - 1.1

put /v1/hosted-zones/{hosted_zone_id}/records/{record_id}

Description

Update a recordset

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	hosted_zone_id required	Hosted Zone ID Example : `3432012nfdksdf03ktrld9234lgfg`	string	None
path	record_id required	Record ID Example : `6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7`	string	None
body	body required		RecordSetRequest

Responses

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

Example HTTP request

Request path

/v1/hosted-zones/{hosted_zone_id}/records/{record_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 = dns 1.1"

Request body

{
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "ttl": 3600
}

Example HTTP response

Response 202

{
    "action": "CREATE",
    "created_at": "2025-09-08T03:43:57Z",
    "description": "This is description",
    "id": "6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7",
    "links": "",
    "name": "test.app",
    "project_id": "003dffc50eb123a1cbf4f2e5c71d4f15",
    "records": [
        "12345.ns.private.kr-west1.dev2.samsungsdscloud.com"
    ],
    "status": "ACTIVE",
    "ttl": 3600,
    "type": "A",
    "updated_at": "2026-02-09T08:00:40Z",
    "version": 1,
    "zone_id": "3432012nfdksdf03ktrld9234lgfg",
    "zone_name": "my-zone.com"
}

2.1.32 - Update WHOIS info for Public Domain

2.1.32.1 - 1.2

put /v1/public-domain-names/{public_domain_id}/information

Description

Update WHOIS information and sync with DB for a public domain

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260331

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	ID Example : `10fjkeweffpublicdomain3193rud543`	string	None
body	body required		PubblicDomainWhoisInfoUpdateRequest

Responses

HTTP Code	Description	Schema
200	OK	PublicDomainWhoisInfoUpdateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_id}/information

Request header

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

Request body

{
    "address_type": "DOMESTIC",
    "domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
    "domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
    "domestic_second_address_en": "West Campus 1F",
    "domestic_second_address_ko": "서관 1층",
    "overseas_first_address": "123 Main St",
    "overseas_second_address": "New York",
    "overseas_third_address": "NY 10001",
    "postal_code": "12345",
    "register_email": "admin@example.com",
    "register_telno": "010-1234-5678"
}

Example HTTP response

Response 200

{
    "address_type": "DOMESTIC",
    "domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
    "domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
    "domestic_second_address_en": "West Campus 1F",
    "domestic_second_address_ko": "서관 1층",
    "name": "example.com",
    "overseas_first_address": "123 Main St",
    "overseas_second_address": "New York",
    "overseas_third_address": "NY 10001",
    "postal_code": "12345",
    "register_email": "admin@example.com",
    "register_name_en": "Hong Gildong",
    "register_name_ko": "홍길동",
    "register_telno": "010-1234-5678"
}

2.1.32.2 - 1.1

put /v1/public-domain-names/{public_domain_id}/information

Description

Update WHOIS information and sync with DB for a public domain

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260331

Parameters

Type	Name	Description	Schema	Default
path	public_domain_id required	ID Example : `10fjkeweffpublicdomain3193rud543`	string	None
body	body required		PubblicDomainWhoisInfoUpdateRequest

Responses

HTTP Code	Description	Schema
200	OK	PublicDomainWhoisInfoUpdateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None
500	Internal Server Error	None

Example HTTP request

Request path

/v1/public-domain-names/{public_domain_id}/information

Request header

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

Request body

{
    "address_type": "DOMESTIC",
    "domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
    "domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
    "domestic_second_address_en": "West Campus 1F",
    "domestic_second_address_ko": "서관 1층",
    "overseas_first_address": "123 Main St",
    "overseas_second_address": "New York",
    "overseas_third_address": "NY 10001",
    "postal_code": "12345",
    "register_email": "admin@example.com",
    "register_telno": "010-1234-5678"
}

Example HTTP response

Response 200

{
    "address_type": "DOMESTIC",
    "domestic_first_address_en": "125 Olympic-ro 35-gil, Songpa-gu, Seoul",
    "domestic_first_address_ko": "서울특별시 송파구 올림픽로35길 125 (신천동)",
    "domestic_second_address_en": "West Campus 1F",
    "domestic_second_address_ko": "서관 1층",
    "name": "example.com",
    "overseas_first_address": "123 Main St",
    "overseas_second_address": "New York",
    "overseas_third_address": "NY 10001",
    "postal_code": "12345",
    "register_email": "admin@example.com",
    "register_name_en": "Hong Gildong",
    "register_name_ko": "홍길동",
    "register_telno": "010-1234-5678"
}

2.2 - Models

2.2.1 - CreatePublicDomainRequest

Name	Description	Schema	Default
address_type required	Address type Example : `DOMESTIC`	string
auto_extension optional	Auto extension flag Example : `True`	any of [boolean, null]	True
description optional	description Example : `This is description`	any of [string, null]
domestic_first_address_en required	Domestic first address (EN) Example : `125 Olympic-ro 35-gil, Songpa-gu, Seoul`	any of [string, null]
domestic_first_address_ko required	Domestic first address (KO) Example : `서울특별시 송파구 올림픽로35길 125 (신천동)`	any of [string, null]
domestic_second_address_en required	Domestic second address (EN) Example : `West Campus 1F`	any of [string, null]
domestic_second_address_ko required	Domestic second address (KO) Example : `서관 1층` Maximum length : `16`	string
name required	Public Domain Name Example : `example.com`	string
overseas_first_address required	Overseas address - Address Example : `123 Main St`	any of [string, null]
overseas_second_address required	Overseas address - City Example : `New York`	any of [string, null]
overseas_third_address required	Overseas address - State & Country Example : `NY 10001`	any of [string, null]
postal_code required	Postal code Example : `12345` Maximum length : `6`	string
register_email required	Register email Example : `admin@example.com`	string
register_name_en required	Register Name Overseas Example : `Hong Gildong` Maximum length : `30`	string
register_name_ko required	Register Name Domestic Example : `홍길동` Maximum length : `30`	string
register_telno required	Register telephone number Example : `010-1234-5678`	string
tags optional	Tag List	array[Tag]

2.2.2 - CreatePublicDomainResponse

Name	Description	Schema	Default
public_domain_name required		PublicDomainDetail

2.2.3 - HostedZone

Name	Description	Schema
action required	current action in progress Example :	string
attributes optional	Key:Value pairs of information about this zone Example :	any of [object, null]
created_at optional	Created Date Example : `2025-09-08T03:43:57Z`	any of [string, null]
description optional	description Example : `This is description`	any of [string, null]
email required	email Example : `test@samsung.com`	string
hosted_zone_type optional	Hosted Zone type Example : `public`	any of [string, null]
id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	string
links optional	Links to resource Example :	any of [object, null]
masters optional	The servers to slave from to get DNS information Example :	any of [array[string], null]
name required	name Example : `my-zone.com`	string
pool_id required	Designate Pool ID Example : `10fjksdpooliddfsi12389esfdslkdsr32`	string
project_id required	ProjectID Example :	string
serial required	serial number Example :	integer
shared optional	True if the zone is shared with another account Example :	any of [boolean, null]
status required	The status Example : `ACTIVE`	string
transferred_at optional	The last time an update was retrieved from the master servers Example :	any of [string, null]
ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]
type optional	Type of zone Example :	any of [string, null]
updated_at optional	Updated Date Example :	any of [string, null]
version optional	Version Example :	any of [integer, null]

2.2.4 - HostedZoneCreateRequest

Name	Description	Schema
description optional	description Example : `This is description`	any of [string, null]
email required	email Example : `test@samsung.com`	string
name required	name Example : `my-zone.com`	string
tags optional	Tag List	array[Tag]
type optional	Type of zone Example : `public` Pattern : `^(public\|private)$`	any of [string, null]

2.2.5 - HostedZoneCreateRequestV1Dot2

Name	Description	Schema
description optional	description Example : `This is description`	any of [string, null]
email required	email Example : `test@samsung.com`	string
name required	name Example : `my-zone.com`	string
private_dns_id optional	Private DNS ID Example :	any of [string, null]
tags optional	Tag List	array[Tag]
type optional	Type of zone Example : `public` Pattern : `^(public\|private)$`	any of [string, null]

2.2.6 - HostedZoneCreateRequestV1Dot3

Name	Description	Schema
description optional	description Example : `This is description`	any of [string, null]
name required	name Example : `my-zone.com`	string
private_dns_id optional	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	any of [string, null]
tags optional	Tag List	array[Tag]
type required	Type of zone Example : `private`	enum (public, private)

2.2.7 - HostedZoneCreateResponse

Name	Description	Schema
action required	current action in progress Example :	string
attributes optional	Key:Value pairs of information about this zone Example :	any of [object, null]
created_at optional	Created Date Example : `2025-09-08T03:43:57Z`	any of [string, null]
description optional	description Example : `This is description`	any of [string, null]
email required	email Example : `test@samsung.com`	string
hosted_zone_type optional	Hosted Zone type Example : `public`	any of [string, null]
id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	string
links optional	Links to resource Example :	any of [object, null]
masters optional	The servers to slave from to get DNS information Example :	any of [array[string], null]
name required	name Example : `my-zone.com`	string
pool_id required	Designate Pool ID Example : `10fjksdpooliddfsi12389esfdslkdsr32`	string
project_id required	ProjectID Example :	string
serial required	serial number Example :	integer
shared optional	True if the zone is shared with another account Example :	any of [boolean, null]
status required	The status Example : `ACTIVE`	string
transferred_at optional	The last time an update was retrieved from the master servers Example :	any of [string, null]
ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]
type optional	Type of zone Example :	any of [string, null]
updated_at optional	Updated Date Example :	any of [string, null]
version optional	Version Example :	any of [integer, null]

2.2.8 - HostedZoneDeleteResponse

Name	Description	Schema
action required	current action in progress Example :	string
attributes optional	Key:Value pairs of information about this zone Example :	any of [object, null]
created_at optional	Created Date Example : `2025-09-08T03:43:57Z`	any of [string, null]
description optional	description Example : `This is description`	any of [string, null]
email required	email Example : `test@samsung.com`	string
hosted_zone_type optional	Hosted Zone type Example : `public`	any of [string, null]
id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	string
links optional	Links to resource Example :	any of [object, null]
masters optional	The servers to slave from to get DNS information Example :	any of [array[string], null]
name required	name Example : `my-zone.com`	string
pool_id required	Designate Pool ID Example : `10fjksdpooliddfsi12389esfdslkdsr32`	string
project_id required	ProjectID Example :	string
serial required	serial number Example :	integer
shared optional	True if the zone is shared with another account Example :	any of [boolean, null]
status required	The status Example : `ACTIVE`	string
transferred_at optional	The last time an update was retrieved from the master servers Example :	any of [string, null]
ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]
type optional	Type of zone Example :	any of [string, null]
updated_at optional	Updated Date Example :	any of [string, null]
version optional	Version Example :	any of [integer, null]

2.2.9 - HostedZoneListResponseV1Dot1

Name	Description	Schema
count required	Count Example :	integer
hosted_zones required	Hosted Zone LIST	array[HostedZone]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
page required	Page Example :	integer
size required	Size Example :	integer
sort required	Sort Example :	string

2.2.10 - HostedZoneListResponseV1Dot2

Name	Description	Schema
count required	Count Example :	integer
hosted_zones required	Hosted Zone LIST	array[HostedZoneV1Dot2]
links optional	links Example : `[{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}]`	any of [array[object], null]
page required	Page Example :	integer
size required	Size Example :	integer
sort required	Sort Example :	string

2.2.11 - HostedZoneListResponseV1Dot3

Name	Description	Schema
count required	count Example : `20`	integer
hosted_zones required	Hosted Zone LIST	array[HostedZoneV1Dot3]
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.12 - HostedZoneSetRequest

Name	Description	Schema	Default
description optional	description Example : `This is description`	any of [string, null]
email optional	email Example : `test@samsung.com`	any of [string, null]

2.2.13 - HostedZoneSetRequestV1Dot3

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

2.2.14 - HostedZoneSetResponse

Name	Description	Schema
action required	current action in progress Example :	string
attributes optional	Key:Value pairs of information about this zone Example :	any of [object, null]
created_at optional	Created Date Example : `2025-09-08T03:43:57Z`	any of [string, null]
description optional	description Example : `This is description`	any of [string, null]
email required	email Example : `test@samsung.com`	string
hosted_zone_type optional	Hosted Zone type Example : `public`	any of [string, null]
id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	string
links optional	Links to resource Example :	any of [object, null]
masters optional	The servers to slave from to get DNS information Example :	any of [array[string], null]
name required	name Example : `my-zone.com`	string
pool_id required	Designate Pool ID Example : `10fjksdpooliddfsi12389esfdslkdsr32`	string
project_id required	ProjectID Example :	string
serial required	serial number Example :	integer
shared optional	True if the zone is shared with another account Example :	any of [boolean, null]
status required	The status Example : `ACTIVE`	string
transferred_at optional	The last time an update was retrieved from the master servers Example :	any of [string, null]
ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]
type optional	Type of zone Example :	any of [string, null]
updated_at optional	Updated Date Example :	any of [string, null]
version optional	Version Example :	any of [integer, null]

2.2.15 - HostedZoneShowResponse

Name	Description	Schema
action required	current action in progress Example :	string
attributes optional	Key:Value pairs of information about this zone Example :	any of [object, null]
created_at optional	Created Date Example : `2025-09-08T03:43:57Z`	any of [string, null]
description optional	description Example : `This is description`	any of [string, null]
email required	email Example : `test@samsung.com`	string
hosted_zone_type optional	Hosted Zone type Example : `public`	any of [string, null]
id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	string
links optional	Links to resource Example :	any of [object, null]
masters optional	The servers to slave from to get DNS information Example :	any of [array[string], null]
name required	name Example : `my-zone.com`	string
pool_id required	Designate Pool ID Example : `10fjksdpooliddfsi12389esfdslkdsr32`	string
project_id required	ProjectID Example :	string
serial required	serial number Example :	integer
shared optional	True if the zone is shared with another account Example :	any of [boolean, null]
status required	The status Example : `ACTIVE`	string
transferred_at optional	The last time an update was retrieved from the master servers Example :	any of [string, null]
ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]
type optional	Type of zone Example :	any of [string, null]
updated_at optional	Updated Date Example :	any of [string, null]
version optional	Version Example :	any of [integer, null]

2.2.16 - HostedZoneShowResponseV1Dot2

Name	Description	Schema
action required	current action in progress Example :	string
attributes optional	Key:Value pairs of information about this zone Example :	any of [object, null]
created_at optional	Created Date Example : `2025-09-08T03:43:57Z`	any of [string, null]
description optional	description Example : `This is description`	any of [string, null]
email required	email Example : `test@samsung.com`	string
hosted_zone_type optional	Hosted Zone type Example : `public`	any of [string, null]
id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	string
links optional	Links to resource Example :	any of [object, null]
masters optional	The servers to slave from to get DNS information Example :	any of [array[string], null]
name required	name Example : `my-zone.com`	string
pool_id required	Designate Pool ID Example : `10fjksdpooliddfsi12389esfdslkdsr32`	string
private_dns_id optional	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	any of [string, null]
private_dns_name optional	Private DNS Name Example : `private-dns01`	any of [string, null]
project_id required	ProjectID Example :	string
serial required	serial number Example :	integer
shared optional	True if the zone is shared with another account Example :	any of [boolean, null]
status required	The status Example : `ACTIVE`	string
transferred_at optional	The last time an update was retrieved from the master servers Example :	any of [string, null]
ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]
type optional	Type of zone Example :	any of [string, null]
updated_at optional	Updated Date Example :	any of [string, null]
version optional	Version Example :	any of [integer, null]

2.2.17 - HostedZoneShowResponseV1Dot3

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
description required	description Example : `This is description`	any of [string, null]
hosted_zone_type optional	Hosted Zone type Example : `public`	enum (public, private)
id required	Hosted Zone ID Example : `3432012nfdksdf03ktrld9234lgfg`	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	Hosted Zone Name Example : `my-zone.com`	string
pool_id required	Designate Pool ID Example : `10fjksdpooliddfsi12389esfdslkdsr32`	string
private_dns_id optional	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	any of [string, null]
private_dns_name optional	Private DNS Name Example : `private-dns01`	any of [string, null]
status required	State Example : `CREATING`	enum (CREATING, EDITING, ACTIVE, DELETING, DELETED, ERROR, PENDING, UNKNOWN)
ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]

2.2.18 - HostedZoneV1Dot2

Name	Description	Schema
action required	current action in progress Example :	string
attributes optional	Key:Value pairs of information about this zone Example :	any of [object, null]
created_at optional	Created Date Example : `2025-09-08T03:43:57Z`	any of [string, null]
description optional	description Example : `This is description`	any of [string, null]
email required	email Example : `test@samsung.com`	string
hosted_zone_type optional	Hosted Zone type Example : `public`	any of [string, null]
id required	Id Example : `3432012nfdksdf03ktrld9234lgfg`	string
links optional	Links to resource Example :	any of [object, null]
masters optional	The servers to slave from to get DNS information Example :	any of [array[string], null]
name required	name Example : `my-zone.com`	string
pool_id required	Designate Pool ID Example : `10fjksdpooliddfsi12389esfdslkdsr32`	string
private_dns_id optional	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	any of [string, null]
private_dns_name optional	Private DNS Name Example : `private-dns01`	any of [string, null]
project_id required	ProjectID Example :	string
serial required	serial number Example :	integer
shared optional	True if the zone is shared with another account Example :	any of [boolean, null]
status required	The status Example : `ACTIVE`	string
transferred_at optional	The last time an update was retrieved from the master servers Example :	any of [string, null]
ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]
type optional	Type of zone Example :	any of [string, null]
updated_at optional	Updated Date Example :	any of [string, null]
version optional	Version Example :	any of [integer, null]

2.2.19 - HostedZoneV1Dot3

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
description required	description Example : `This is description`	any of [string, null]
hosted_zone_type optional	Hosted Zone type Example : `public`	enum (public, private)
id required	Hosted Zone ID Example : `3432012nfdksdf03ktrld9234lgfg`	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	Hosted Zone Name Example : `my-zone.com`	string
pool_id required	Designate Pool ID Example : `10fjksdpooliddfsi12389esfdslkdsr32`	string
private_dns_id optional	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	any of [string, null]
private_dns_name optional	Private DNS Name Example : `private-dns01`	any of [string, null]
status required	State Example : `CREATING`	enum (CREATING, EDITING, ACTIVE, DELETING, DELETED, ERROR, PENDING, UNKNOWN)
ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]

2.2.20 - PrivateDns

Name	Description	Schema
auth_dns_name required	Auth DNS Name Example :	any of [string, null]
connected_vpc_ids optional	Connected VPC ID	array[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 : `This is description`	any of [string, null]
id required	Private DNS ID Example : `10fjkewefprivatedns3193rud543`	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 DNS Name Example : `private-dns01`	string
pool_id required	Designate Pool ID Example : `10fjksdpooliddfsi12389esfdslkdsr32`	any of [string, null]
pool_name required	Pool Name Example :	any of [string, null]
registered_region required	Registered Region Example : `KR-WEST1`	any of [string, null]
resolver_ip required	Private DNS Resolver IP Example : `198.19.0.101`	any of [string, null]
resolver_name required	Private DNS Resolver Name Example :	any of [string, null]
state required	State Example : `CREATING`	enum (CREATING, EDITING, ACTIVE, ACTIVATING, INACTIVE, DELETING, DELETED, ERROR, PENDING)

2.2.21 - PrivateDnsActivateRequest

Name	Description	Schema	Default
name required	Private DNS Name Example : `private-dns01` Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string

2.2.22 - PrivateDnsCreateRequest

Name	Description	Schema
connected_vpc_ids optional	Connected VPC ID	array[string]
description optional	description Example : `This is description`	any of [string, null]
name required	Private DNS Name Example : `private-dns01` Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
tags optional		any of [array[Tag], null]

2.2.23 - PrivateDnsListResponse

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

2.2.24 - PrivateDnsSetRequest

Name	Description	Schema	Default
connected_vpc_ids optional	Connected VPC ID Example :	any of [array[string], null]
description optional	description Example : `This is description`	any of [string, null]

2.2.25 - PrivateDnsShowResponse

Name	Description	Schema	Default
private_dns required		PrivateDns

2.2.26 - PubblicDomainWhoisInfoUpdateRequest

Name	Description	Schema
address_type required	Address type Example : `DOMESTIC`	string
domestic_first_address_en required	Domestic first address (EN) Example : `125 Olympic-ro 35-gil, Songpa-gu, Seoul`	string
domestic_first_address_ko required	Domestic first address (KO) Example : `서울특별시 송파구 올림픽로35길 125 (신천동)`	string
domestic_second_address_en required	Domestic second address (EN) Example : `West Campus 1F`	any of [string, null]
domestic_second_address_ko required	Domestic second address (KO) Example : `서관 1층` Maximum length : `16`	string
overseas_first_address required	Overseas address - Address Example : `123 Main St`	any of [string, null]
overseas_second_address required	Overseas address - City Example : `New York`	any of [string, null]
overseas_third_address required	Overseas address - State & Country Example : `NY 10001`	any of [string, null]
postal_code required	Postal code Example : `12345` Maximum length : `6`	string
register_email required	Register email Example : `admin@example.com`	string
register_telno required	Register telephone number Example : `010-1234-5678`	string

2.2.27 - PublicDomainDetail

Name	Description	Schema
address_type required	Address type Example : `DOMESTIC`	string
auto_extension required	Auto extension flag Example : `True`	boolean
created_at required	Created Date Example : `2025-09-08T03:43:57Z`	string
created_by required	Created By_ Example : `504f24f8111e42e0578f367acd2a149f`	string
description optional	description Example : `This is description`	any of [string, null]
domestic_address_en required	Domestic Address (EN) Example : `West Campus 1F, 125 Olympic-ro 35-gil, Songpa-gu, Seoul`	string
domestic_address_ko required	Domestic Address (KO) Example : `서울특별시 송파구 올림픽로35길 125 (신천동), 서관 1층`	string
domestic_first_address_en required	Domestic first address (EN) Example : `125 Olympic-ro 35-gil, Songpa-gu, Seoul`	string
domestic_first_address_ko required	Domestic first address (KO) Example : `서울특별시 송파구 올림픽로35길 125 (신천동)`	string
domestic_second_address_en required	Domestic second address (EN) Example : `West Campus 1F`	string
domestic_second_address_ko required	Domestic second address (KO) Example : `서관 1층`	string
expired_date required	Expired date Example : `2026-09-09T00:00:00Z`	string
id required	ID Example : `10fjkeweffpublicdomain3193rud543`	string
modified_at required	Modified Date Example : `2026-02-09T08:00:40Z`	string
modified_by required	Modified By_ Example : `504f24f8111e42e0578f367acd2a149f`	string
name required	Public Domain Name Example : `example.com`	string
overseas_address optional	Overseas Address Example : `123 Main St, New York, NY 10001`	string
overseas_first_address required	Overseas address - Address Example : `123 Main St`	string
overseas_second_address required	Overseas address - City Example : `New York`	string
overseas_third_address required	Overseas address - State & Country Example : `NY 10001`	string
postal_code required	Postal code Example : `12345`	string
register_email required	Register email Example : `admin@example.com`	string
register_name_en required	Register Name Overseas Example : `Hong Gildong`	string
register_name_ko required	Register Name Domestic Example : `홍길동`	string
register_telno required	Register telephone number Example : `010-1234-5678`	string
start_date required	Start date Example : `2025-09-09T00:00:00Z`	string
status required	The status Example : `REGISTERED`	string

2.2.28 - PublicDomainDetailResponse

Name	Description	Schema	Default
public_domain_name required		PublicDomainDetail

2.2.29 - PublicDomainListItem

Name	Description	Schema
created_at required	Created Date Example : `2025-09-08T03:43:57Z`	string
created_by required	Start date Example : `504f24f8111e42e0578f367acd2a149f`	string
expired_date required	Expired date Example : `2026-09-09T00:00:00Z`	string
id required	ID Example : `10fjkeweffpublicdomain3193rud543`	string
modified_at required	Modified Date Example : `2026-02-09T08:00:40Z`	string
modified_by required	Modified By_ Example : `504f24f8111e42e0578f367acd2a149f`	string
name required	Public Domain Name Example : `example.com`	string
register_email required	Register email Example : `admin@example.com`	string
start_date required	Start date Example : `2025-09-09T00:00:00Z`	string
status required	The status Example : `REGISTERED`	string

2.2.30 - PublicDomainListResponse

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

2.2.31 - PublicDomainPartialUpdateRequest

Name	Description	Schema	Default
auto_extension optional	Auto extension flag Example : `True`	any of [boolean, null]
description optional	description Example : `This is description`	any of [string, null]

2.2.32 - PublicDomainPartialUpdateResponse

Name	Description	Schema
auto_extension optional	Auto extension flag Example : `True`	any of [boolean, null]
description optional	description Example : `This is description`	any of [string, null]
id required	ID Example : `10fjkeweffpublicdomain3193rud543`	string

2.2.33 - PublicDomainTransferRequest

Name	Description	Schema	Default
target_account_id optional	Target account id (required when type=REQUEST) Example : `003dffc50eb123a1cbf4f2e5c71d4f15`	any of [string, null]
type required	Transfer operation type Example : `REQUEST`	enum (REQUEST, CANCEL, APPROVE, REJECT)

2.2.34 - PublicDomainTransferResponse

Name	Description	Schema
auto_extension required	Auto extension flag Example : `True`	boolean
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 : `This is description`	any of [string, null]
expired_date required	Expired date Example : `2026-09-09T00:00:00Z`	string (date-time)
id required	ID Example : `10fjkeweffpublicdomain3193rud543`	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	Public Domain Name Example : `example.com`	string
start_date required	Start date Example : `2025-09-09T00:00:00Z`	string (date-time)
state required	State Example : `TRANSFER_REQUESTED`	enum (ACTIVE, CREATING, REGISTERED, EXPIRED, DELETED, TRANSFER_REQUESTING, TRANSFER_REQUESTED, DELETING)

2.2.35 - PublicDomainWhoisInfoUpdateResponse

Name	Description	Schema
address_type required	Address type Example : `DOMESTIC`	string
domestic_first_address_en required	Domestic first address (EN) Example : `125 Olympic-ro 35-gil, Songpa-gu, Seoul`	string
domestic_first_address_ko required	Domestic first address (KO) Example : `서울특별시 송파구 올림픽로35길 125 (신천동)`	string
domestic_second_address_en required	Domestic second address (EN) Example : `West Campus 1F`	any of [string, null]
domestic_second_address_ko required	Domestic second address (KO) Example : `서관 1층` Maximum length : `16`	string
name required	Public Domain Name Example : `example.com`	string
overseas_first_address required	Overseas address - Address Example : `123 Main St`	any of [string, null]
overseas_second_address required	Overseas address - City Example : `New York`	any of [string, null]
overseas_third_address required	Overseas address - State & Country Example : `NY 10001`	any of [string, null]
postal_code required	Postal code Example : `12345` Maximum length : `6`	string
register_email required	Register email Example : `admin@example.com`	string
register_name_en required	Register Name Overseas Example : `Hong Gildong`	string
register_name_ko required	Register Name Domestic Example : `홍길동`	string
register_telno required	Register telephone number Example : `010-1234-5678`	string

2.2.36 - Record

Name	Description	Schema
action optional	current action in progress Example : `CREATE`	any of [string, null]
created_at optional	Created Date Example : `2025-09-08T03:43:57Z`	any of [string, null]
description optional	description Example : `This is description`	any of [string, null]
id optional	Record ID Example : `6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7`	any of [string, null]
links optional	Links to resource Example :	any of [object, null]
name optional	name Example : `test.app`	any of [string, null]
project_id optional	ProjectID Example : `003dffc50eb123a1cbf4f2e5c71d4f15`	any of [string, null]
records optional	A list of data for this record Example : `['12345.ns.private.kr-west1.dev2.samsungsdscloud.com']`	any of [array[string], null]
status optional	The status Example : `ACTIVE`	any of [string, null]
ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]
type optional	Type of the record Example : `A`	any of [string, null]
updated_at optional	Updated Date Example : `2026-02-09T08:00:40Z`	any of [string, null]
version optional	Version Example : `1`	any of [integer, null]
zone_id optional	ID for the zone that contains this record Example : `3432012nfdksdf03ktrld9234lgfg`	any of [string, null]
zone_name optional	The name of the zone that contains this record Example : `my-zone.com`	any of [string, null]

2.2.37 - RecordCreateRequest

Name	Description	Schema
description optional	description Example : `This is description`	any of [string, null]
name required	name Example : `test.app`	string
records required	A list of data for this record Example : `['12345.ns.private.kr-west1.dev2.samsungsdscloud.com']`	array[object]
ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]
type required	Type of the record Example : `A`	string

2.2.38 - RecordCreateRequestV1Dot1To1Dot2

Name	Description	Schema
description optional	description Example : `This is description`	any of [string, null]
name required	name Example : `test.app`	string
records required	A list of data for this record Example : `['12345.ns.private.kr-west1.dev2.samsungsdscloud.com']`	array[object]
ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]
type required	Type of the record Example : `A`	string

2.2.39 - RecordCreateResponse

Name	Description	Schema
action optional	current action in progress Example : `CREATE`	any of [string, null]
created_at optional	Created Date Example : `2025-09-08T03:43:57Z`	any of [string, null]
description optional	description Example : `This is description`	any of [string, null]
id optional	Record ID Example : `6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7`	any of [string, null]
links optional	Links to resource Example :	any of [object, null]
name optional	name Example : `test.app`	any of [string, null]
project_id optional	ProjectID Example : `003dffc50eb123a1cbf4f2e5c71d4f15`	any of [string, null]
records optional	A list of data for this record Example : `['12345.ns.private.kr-west1.dev2.samsungsdscloud.com']`	any of [array[string], null]
status optional	The status Example : `ACTIVE`	any of [string, null]
ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]
type optional	Type of the record Example : `A`	any of [string, null]
updated_at optional	Updated Date Example : `2026-02-09T08:00:40Z`	any of [string, null]
version optional	Version Example : `1`	any of [integer, null]
zone_id optional	ID for the zone that contains this record Example : `3432012nfdksdf03ktrld9234lgfg`	any of [string, null]
zone_name optional	The name of the zone that contains this record Example : `my-zone.com`	any of [string, null]

2.2.40 - RecordListResponse

Name	Description	Schema
count optional	total count Example : `20`	any of [integer, null]
links optional	Links to resource Example :	any of [object, null]
metadata optional	Total Count Example :	any of [object, null]
records required	Record list	array[Record]

2.2.41 - RecordSetRequest

Name	Description	Schema	Default
records optional	A list of data for this record Example : `['12345.ns.private.kr-west1.dev2.samsungsdscloud.com']`	any of [array[object], null]
ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]

2.2.42 - RecordSetResponse

Name	Description	Schema
action optional	current action in progress Example : `CREATE`	any of [string, null]
created_at optional	Created Date Example : `2025-09-08T03:43:57Z`	any of [string, null]
description optional	description Example : `This is description`	any of [string, null]
id optional	Record ID Example : `6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7`	any of [string, null]
links optional	Links to resource Example :	any of [object, null]
name optional	name Example : `test.app`	any of [string, null]
project_id optional	ProjectID Example : `003dffc50eb123a1cbf4f2e5c71d4f15`	any of [string, null]
records optional	A list of data for this record Example : `['12345.ns.private.kr-west1.dev2.samsungsdscloud.com']`	any of [array[string], null]
status optional	The status Example : `ACTIVE`	any of [string, null]
ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]
type optional	Type of the record Example : `A`	any of [string, null]
updated_at optional	Updated Date Example : `2026-02-09T08:00:40Z`	any of [string, null]
version optional	Version Example : `1`	any of [integer, null]
zone_id optional	ID for the zone that contains this record Example : `3432012nfdksdf03ktrld9234lgfg`	any of [string, null]
zone_name optional	The name of the zone that contains this record Example : `my-zone.com`	any of [string, null]

2.2.43 - RecordShowResponse

Name	Description	Schema
action optional	current action in progress Example : `CREATE`	any of [string, null]
created_at optional	Created Date Example : `2025-09-08T03:43:57Z`	any of [string, null]
description optional	description Example : `This is description`	any of [string, null]
id optional	Record ID Example : `6ed7bc1-4b05-3cc7-7105-c1b71f7f30a7`	any of [string, null]
links optional	Links to resource Example :	any of [object, null]
name optional	name Example : `test.app`	any of [string, null]
project_id optional	ProjectID Example : `003dffc50eb123a1cbf4f2e5c71d4f15`	any of [string, null]
records optional	A list of data for this record Example : `['12345.ns.private.kr-west1.dev2.samsungsdscloud.com']`	any of [array[string], null]
status optional	The status Example : `ACTIVE`	any of [string, null]
ttl optional	TTL for the zone. Example : `3600`	any of [integer, null]
type optional	Type of the record Example : `A`	any of [string, null]
updated_at optional	Updated Date Example : `2026-02-09T08:00:40Z`	any of [string, null]
version optional	Version Example : `1`	any of [integer, null]
zone_id optional	ID for the zone that contains this record Example : `3432012nfdksdf03ktrld9234lgfg`	any of [string, null]
zone_name optional	The name of the zone that contains this record Example : `my-zone.com`	any of [string, null]

2.2.44 - Tag

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

3 - Firewall

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 Firewall service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.

Version

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

Version	Status	Not Before
1.0	CURRENT	-

OpenAPI URL

https://firewall.{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

3.1 - APIs

3.1.1 - Create Firewall Rule

3.1.1.1 - 1.0

post /v1/firewalls/rules

Description

Create firewall rule.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Type	Name	Description	Schema	Default
body	body required		FirewallRuleCreateSingleRequest

Responses

HTTP Code	Description	Schema
201	Created	FirewallRuleShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/firewalls/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 = firewall 1.0"

Request body

{
    "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
    "firewall_rule": {
        "action": "ALLOW",
        "description": "Firewall rule description example",
        "destination_address": [
            "10.0.0.1",
            "10.0.0.2"
        ],
        "direction": "INBOUND",
        "order_direction": "BEFORE",
        "order_rule_id": "043aa63459da466faad71fe4fe587031",
        "service": [
            {
                "service_type": "TCP",
                "service_value": "443"
            }
        ],
        "source_address": [
            "192.168.1.1",
            "192.168.1.2"
        ],
        "status": "ENABLE"
    }
}

Example HTTP response

Response 201

{
    "firewall_rule": {
        "action": "ALLOW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Firewall rule description example",
        "destination_address": [
            "10.0.0.1",
            "10.0.0.2"
        ],
        "destination_interface": "IFW1-v1001dn",
        "direction": "INBOUND",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "b156740b6335468d8354eb9ef8eddf5a",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "b156740b6335468d8354eb9ef8eddf5a",
        "sequence": 100,
        "service": [
            {
                "service_type": "TCP",
                "service_value": "443"
            }
        ],
        "source_address": [
            "192.168.1.1",
            "192.168.1.2"
        ],
        "source_interface": "IFW1-v2501up",
        "state": "CREATING",
        "status": "ENABLE",
        "vendor_rule_id": "72"
    }
}

3.1.2 - Delete Firewall Rule

3.1.2.1 - 1.0

delete /v1/firewalls/rules/{firewall_rule_id}

Description

Delete firewall rule.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	firewall_rule_id required	Firewall Rule ID Example : `b156740b6335468d8354eb9ef8eddf5a`	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/firewalls/rules/{firewall_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 = firewall 1.0"

Example HTTP response

Response 204

3.1.3 - List Firewall Rules

3.1.3.1 - 1.0

get /v1/firewalls/rules

Description

Get firewall rule list.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

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	firewall_id required	Firewall ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string	None
query	src_ip optional	Source IP Example : `192.168.1.1`	string	None
query	dst_ip optional	Destination IP Example : `192.168.1.1`	string	None
query	description optional	Firewall Rule Description Example : `Firewall rule description example`	string	None
query	state optional	Firewall Rule State	array[enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)]	[]
query	status optional	Firewall Rule Status Example :	enum (ENABLE, DISABLE)	None
query	fetch_all optional	Firewall Rule Fetch ALL Example : `False`	boolean	False

Responses

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

Example HTTP request

Request path

/v1/firewalls/rules?firewall_id={firewall_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 = firewall 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "firewall_rules": [
        {
            "action": "ALLOW",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Firewall rule description example",
            "destination_address": [
                "10.0.0.1",
                "10.0.0.2"
            ],
            "destination_interface": "IFW1-v1001dn",
            "direction": "INBOUND",
            "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
            "id": "b156740b6335468d8354eb9ef8eddf5a",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "b156740b6335468d8354eb9ef8eddf5a",
            "sequence": 100,
            "service": [
                {
                    "service_type": "TCP",
                    "service_value": "443"
                }
            ],
            "source_address": [
                "192.168.1.1",
                "192.168.1.2"
            ],
            "source_interface": "IFW1-v2501up",
            "state": "CREATING",
            "status": "ENABLE",
            "vendor_rule_id": "72"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

3.1.4 - List Firewalls

3.1.4.1 - 1.0

get /v1/firewalls

Description

Get firewall list.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

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	Firewall Name Example : `FW_IGW_secuVPC`	string	None
query	vpc_name optional	VPC Name Example : `secuVPC`	string	None
query	product_type optional	Firewall Product Type	array[enum (IGW, GGW, DGW, LB, SIGW, TGW_IGW, TGW_GGW, TGW_DGW, TGW_SIGW, TGW_BM)]	[]
query	state optional	Firewall State	array[enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR, DEPLOYING)]	[]

Responses

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

Example HTTP request

Request path

/v1/firewalls

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "firewalls": [
        {
            "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "flavor_name": "SMALL",
            "flavor_rule_quota": 100,
            "fw_resource_id": "005fd1d30dea11f08a2c56773bef875b",
            "id": "b156740b6335468d8354eb9ef8eddf5a",
            "loggable": false,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "FW_IGW_secuVPC",
            "pre_product_id": "76479b7ffee1431198d9beb4502cda08",
            "product_type": "IGW",
            "state": "CREATING",
            "status": "ENABLE",
            "total_rule_count": 8,
            "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
            "vpc_name": "secuVPC"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

3.1.5 - Set Firewall

3.1.5.1 - 1.0

put /v1/firewalls/{firewall_id}

Description

Set firewall.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	firewall_id required	Firewall ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string	None
body	body required		FirewallSetRequest

Responses

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

Example HTTP request

Request path

/v1/firewalls/{firewall_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 = firewall 1.0"

Request body

{
    "flavor_name": "EXSMALL",
    "loggable": false
}

Example HTTP response

Response 200

{
    "firewall": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "flavor_name": "SMALL",
        "flavor_rule_quota": 100,
        "fw_resource_id": "005fd1d30dea11f08a2c56773bef875b",
        "id": "b156740b6335468d8354eb9ef8eddf5a",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "FW_IGW_secuVPC",
        "pre_product_id": "76479b7ffee1431198d9beb4502cda08",
        "product_type": "IGW",
        "state": "CREATING",
        "status": "ENABLE",
        "total_rule_count": 8,
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "secuVPC"
    }
}

3.1.6 - Set Firewall Rule

3.1.6.1 - 1.0

put /v1/firewalls/rules/{firewall_rule_id}

Description

Set firewall rule.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	firewall_rule_id required	Firewall Rule ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string	None
body	body required		FirewallRuleSetRequest

Responses

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

Example HTTP request

Request path

/v1/firewalls/rules/{firewall_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 = firewall 1.0"

Request body

{
    "action": "ALLOW",
    "description": "Firewall rule description example",
    "destination_address": [
        "10.0.0.1",
        "10.0.0.2"
    ],
    "direction": "INBOUND",
    "service": [
        {
            "service_type": "TCP",
            "service_value": "443"
        }
    ],
    "source_address": [
        "192.168.1.1",
        "192.168.1.2"
    ]
}

Example HTTP response

Response 200

{
    "firewall_rule": {
        "action": "ALLOW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Firewall rule description example",
        "destination_address": [
            "10.0.0.1",
            "10.0.0.2"
        ],
        "destination_interface": "IFW1-v1001dn",
        "direction": "INBOUND",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "b156740b6335468d8354eb9ef8eddf5a",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "b156740b6335468d8354eb9ef8eddf5a",
        "sequence": 100,
        "service": [
            {
                "service_type": "TCP",
                "service_value": "443"
            }
        ],
        "source_address": [
            "192.168.1.1",
            "192.168.1.2"
        ],
        "source_interface": "IFW1-v2501up",
        "state": "CREATING",
        "status": "ENABLE",
        "vendor_rule_id": "72"
    }
}

3.1.7 - Show Firewall

3.1.7.1 - 1.0

get /v1/firewalls/{firewall_id}

Description

Show firewall.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	firewall_id required	Firewall ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string	None

Responses

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

Example HTTP request

Request path

/v1/firewalls/{firewall_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 = firewall 1.0"

Example HTTP response

Response 200

{
    "firewall": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "flavor_name": "SMALL",
        "flavor_rule_quota": 100,
        "fw_resource_id": "005fd1d30dea11f08a2c56773bef875b",
        "id": "b156740b6335468d8354eb9ef8eddf5a",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "FW_IGW_secuVPC",
        "pre_product_id": "76479b7ffee1431198d9beb4502cda08",
        "product_type": "IGW",
        "state": "CREATING",
        "status": "ENABLE",
        "total_rule_count": 8,
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "secuVPC"
    }
}

3.1.8 - Show Firewall Rule

3.1.8.1 - 1.0

get /v1/firewalls/rules/{firewall_rule_id}

Description

Show firewall rule.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	firewall_rule_id required	Firewall Rule ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string	None

Responses

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

Example HTTP request

Request path

/v1/firewalls/rules/{firewall_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 = firewall 1.0"

Example HTTP response

Response 200

{
    "firewall_rule": {
        "action": "ALLOW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Firewall rule description example",
        "destination_address": [
            "10.0.0.1",
            "10.0.0.2"
        ],
        "destination_interface": "IFW1-v1001dn",
        "direction": "INBOUND",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "b156740b6335468d8354eb9ef8eddf5a",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "b156740b6335468d8354eb9ef8eddf5a",
        "sequence": 100,
        "service": [
            {
                "service_type": "TCP",
                "service_value": "443"
            }
        ],
        "source_address": [
            "192.168.1.1",
            "192.168.1.2"
        ],
        "source_interface": "IFW1-v2501up",
        "state": "CREATING",
        "status": "ENABLE",
        "vendor_rule_id": "72"
    }
}

3.2 - Models

3.2.1 - Firewall

Name	Description	Schema
account_id required	Account ID Example : `0e3dffc50eb247a1adf4f2e5c82c4f99`	string
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
flavor_name optional	Firewall Size Name Example : `SMALL`	string
flavor_rule_quota optional	Firewall Rule Quota Example : `100`	integer
fw_resource_id required	Fw Resource ID Example : `005fd1d30dea11f08a2c56773bef875b`	string
id required	Firewall ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string
loggable required	Logging Use Example : `False`	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	Firewall Name Example : `FW_IGW_secuVPC`	string
pre_product_id optional	Pre Product ID Example : `76479b7ffee1431198d9beb4502cda08`	string
product_type required	Firewall Product Type Example : `IGW`	enum (IGW, GGW, DGW, LB, SIGW, TGW_IGW, TGW_GGW, TGW_DGW, TGW_SIGW, TGW_BM)
state required	Firewall State Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR, DEPLOYING)
status required	Firewall Status Example : `ENABLE`	enum (ENABLE, DISABLE)
total_rule_count optional	Total Rule Count Example : `8`	integer
vpc_id required	VPC Id Example : `ceb44ea5ecb34a49b16495f9a63b0718`	any of [string, null]
vpc_name required	VPC Name Example : `secuVPC`	any of [string, null]

3.2.2 - FirewallListResponse

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

3.2.3 - FirewallPort

Name	Description	Schema	Default
service_type required	Service Protocol Type Example : `TCP`	enum (TCP, UDP, ICMP, IP, TCP_ALL, UDP_ALL, ICMP_ALL, ALL)
service_value optional	Service Port Value Example : `443`	string

3.2.4 - FirewallRule

Name	Description	Schema
action required	Firewall Rule Action Example : `ALLOW`	enum (ALLOW, DENY)
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	Firewall Rule Description Example : `Firewall rule description example`	any of [string, null]
destination_address required	Destination Address Example : `['10.0.0.1', '10.0.0.2']`	array[string]
destination_interface required	Destination Interface Name Example : `IFW1-v1001dn`	string
direction required	Firewall Rule Direction Example : `INBOUND`	enum (INBOUND, OUTBOUND)
firewall_id required	Firewall ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string
id required	Firewall Rule ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name optional	Firewall Rule Name Example : `b156740b6335468d8354eb9ef8eddf5a`	any of [string, null]
sequence required	Firewall Rule Sequence Example : `100`	integer
service required	Service Port	array[FirewallPort]
source_address required	Source Address Example : `['192.168.1.1', '192.168.1.2']`	array[string]
source_interface required	Source Interface Name Example : `IFW1-v2501up`	string
state required	Firewall Rule State Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
status required	Firewall Rule Status Example : `ENABLE`	enum (ENABLE, DISABLE)
vendor_rule_id required	Vendor Rule ID Example : `72`	string

3.2.5 - FirewallRuleCreateRequest

Name	Description	Schema
action required	Firewall Rule Action Example : `ALLOW`	enum (ALLOW, DENY)
description optional	Firewall Rule Description Example : `Firewall rule description example`	any of [string, null]
destination_address required	Destination Address Example : `['10.0.0.1', '10.0.0.2']`	array[string]
direction required	Firewall Rule Direction Example : `INBOUND`	enum (INBOUND, OUTBOUND)
order_direction optional	Order Direction Example : `BEFORE`	enum (BEFORE, AFTER, BOTTOM)
order_rule_id optional	Order Rule ID Example : `043aa63459da466faad71fe4fe587031`	string
service required	Service Port	array[FirewallPort]
source_address required	Source Address Example : `['192.168.1.1', '192.168.1.2']`	array[string]
status required	Firewall Rule Status Example : `ENABLE`	enum (ENABLE, DISABLE)

3.2.6 - FirewallRuleCreateSingleRequest

Name	Description	Schema	Default
firewall_id required	Firewall ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string
firewall_rule required	Firewall Rule List	FirewallRuleCreateRequest

3.2.7 - FirewallRuleListResponse

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

3.2.8 - FirewallRuleSetRequest

Name	Description	Schema
action required	Firewall Rule Action Example : `ALLOW`	enum (ALLOW, DENY)
description optional	Firewall Rule Description Example : `Firewall rule description example`	any of [string, null]
destination_address required	Destination Address Example : `['10.0.0.1', '10.0.0.2']`	array[string]
direction required	Firewall Rule Direction Example : `INBOUND`	enum (INBOUND, OUTBOUND)
service required	Service Port	array[FirewallPort]
source_address required	Source Address Example : `['192.168.1.1', '192.168.1.2']`	array[string]

3.2.9 - FirewallRuleShowResponse

Name	Description	Schema	Default
firewall_rule required		FirewallRule

3.2.10 - FirewallSetRequest

Name	Description	Schema	Default
flavor_name optional	Firewall Size Name Example : `EXSMALL`	enum (EXSMALL, SMALL, MEDIUM, LARGE, EXLARGE)
loggable optional	Logging Use Example : `False`	boolean

3.2.11 - FirewallShowResponse

Name	Description	Schema	Default
firewall required		Firewall

4 - Global CDN

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 Global CDN service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.

Version

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

Version	Status	Not Before
1.0	CURRENT	-

OpenAPI URL

https://cdn.{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

4.1 - APIs

4.1.1 - Create Cdn Service

4.1.1.1 - 1.0

post /v1/cdns

Description

create cdn service

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Type	Name	Description	Schema	Default
body	body required		CdnServiceCreateRequest

Responses

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

Example HTTP request

Request path

/v1/cdns

Request header

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

Request body

{
    "cache_expiry_time": "",
    "cache_key_hostname": "REQUEST_HOST_HEADER",
    "caching_option": "",
    "cdn_origin_hostname": "test.example.com",
    "cdn_origin_port": "",
    "cdn_origin_protocol": "",
    "cdn_service_domain_prefix": "global1",
    "cdn_service_origin_path": "/test/global/",
    "content_policy": "",
    "custom_forward_host_header": "",
    "description": "",
    "forward_host_header": "REQUEST_HOST_HEADER",
    "name": "test1",
    "origin_hostname_type": "DOMAIN",
    "query_string_ignored": "",
    "range_request_allowed": "",
    "request_custom_headers": "",
    "response_custom_headers": "",
    "tags": []
}

Example HTTP response

Response 202

{
    "cdn": {
        "account_id": "",
        "resource_id": "",
        "workflow_id": ""
    }
}

4.1.2 - Delete Cdn Service

4.1.2.1 - 1.0

delete /v1/cdns/{id}

Description

delete cdn service

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	id required	cdn service id Example :	string	None

Responses

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

Example HTTP request

Request path

/v1/cdns/{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 = cdn 1.0"

Example HTTP response

Response 202

{
    "cdn": {
        "account_id": "",
        "resource_id": "",
        "workflow_id": ""
    }
}

4.1.3 - Detail Cdn Service

4.1.3.1 - 1.0

get /v1/cdns/{id}

Description

detail cdn service

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	id required	cdn service id Example :	string	None

Responses

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

Example HTTP request

Request path

/v1/cdns/{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 = cdn 1.0"

Example HTTP response

Response 200

{
    "cdn": {
        "account_id": "",
        "cache_expiry_time": "",
        "cache_key_hostname": "",
        "caching_option": "",
        "cdn_origin_hostname": "",
        "cdn_origin_port": "",
        "cdn_origin_protocol": "",
        "cdn_service_activation_state": "",
        "cdn_service_config_version": "",
        "cdn_service_domain": "",
        "cdn_service_origin_path": "",
        "cdn_service_state": "",
        "content_policy": "",
        "created_at": "",
        "created_by": "",
        "custom_forward_host_header": "",
        "description": "",
        "forward_host_header": "",
        "id": "",
        "modified_at": "",
        "modified_by": "",
        "name": "",
        "origin_hostname_type": "",
        "query_string_ignored": "",
        "range_request_allowed": "",
        "region": "",
        "request_custom_headers": "",
        "response_custom_headers": ""
    }
}

4.1.4 - List Cdn Service

4.1.4.1 - 1.0

get /v1/cdns

Description

list cdn service

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

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	created_by optional	create by Example :	any of [string, null]	None
query	name optional	cdn service name Example :	any of [string, null]	None
query	cdn_service_domain optional	cdn service domain Example :	any of [string, null]	None
query	cdn_origin_hostname optional	cdn service origin host name Example :	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/cdns

Request header

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

Example HTTP response

Response 200

{
    "cdn": [
        {
            "account_id": "",
            "cdn_origin_hostname": "",
            "cdn_service_domain": "",
            "cdn_service_state": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "region": ""
        }
    ],
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

4.1.5 - Purge Cdn Service

4.1.5.1 - 1.0

post /v1/cdns/{id}/purge

Description

purge cdn service

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	id required	cdn service id Example :	string	None
body	body required		CdnServicePurgeRequest

Responses

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

Example HTTP request

Request path

/v1/cdns/{id}/purge

Request header

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

Request body

{
    "custom_url": "/test/",
    "target_content": "",
    "target_url": ""
}

Example HTTP response

Response 202

{
    "cdn": {
        "account_id": "",
        "resource_id": "",
        "workflow_id": ""
    }
}

4.1.6 - Start Cdn Service

4.1.6.1 - 1.0

post /v1/cdns/{id}/start

Description

start cdn service

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	id required	cdn service id Example :	string	None

Responses

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

Example HTTP request

Request path

/v1/cdns/{id}/start

Request header

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

Example HTTP response

Response 202

{
    "cdn": {
        "account_id": "",
        "resource_id": "",
        "workflow_id": ""
    }
}

4.1.7 - Stop Cdn Service

4.1.7.1 - 1.0

post /v1/cdns/{id}/stop

Description

stop cdn service

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	id required	cdn service id Example :	string	None

Responses

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

Example HTTP request

Request path

/v1/cdns/{id}/stop

Request header

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

Example HTTP response

Response 202

{
    "cdn": {
        "account_id": "",
        "resource_id": "",
        "workflow_id": ""
    }
}

4.1.8 - Update Cdn Service

4.1.8.1 - 1.0

put /v1/cdns/{id}

Description

update cdn service

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	id required	cdn service id Example :	string	None
body	body required		CdnServiceUpdateRequest

Responses

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

Example HTTP request

Request path

/v1/cdns/{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 = cdn 1.0"

Request body

{
    "cache_expiry_time": "",
    "cache_key_hostname": "REQUEST_HOST_HEADER",
    "caching_option": "",
    "cdn_origin_hostname": "test.example.com",
    "cdn_origin_port": "",
    "cdn_origin_protocol": "",
    "cdn_service_origin_path": "/test/global/",
    "content_policy": "",
    "custom_forward_host_header": "",
    "forward_host_header": "REQUEST_HOST_HEADER",
    "origin_hostname_type": "DOMAIN",
    "query_string_ignored": "",
    "range_request_allowed": "",
    "request_custom_headers": "",
    "response_custom_headers": ""
}

Example HTTP response

Response 202

{
    "cdn": {
        "account_id": "",
        "resource_id": "",
        "workflow_id": ""
    }
}

4.1.9 - Update Description of Cdn Service

4.1.9.1 - 1.0

put /v1/cdns/{id}/description

Description

Update description of cdn service

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	id required	cdn service id Example :	string	None
body	body required		CdnServiceModifyDescriptionRequest

Responses

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

Example HTTP request

Request path

/v1/cdns/{id}/description

Request header

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

Request body

{
    "description": ""
}

Example HTTP response

Response 200

{
    "cdn": {
        "account_id": "",
        "cache_expiry_time": "",
        "cache_key_hostname": "",
        "caching_option": "",
        "cdn_origin_hostname": "",
        "cdn_origin_port": "",
        "cdn_origin_protocol": "",
        "cdn_service_activation_state": "",
        "cdn_service_config_version": "",
        "cdn_service_domain": "",
        "cdn_service_origin_path": "",
        "cdn_service_state": "",
        "content_policy": "",
        "created_at": "",
        "created_by": "",
        "custom_forward_host_header": "",
        "description": "",
        "forward_host_header": "",
        "id": "",
        "modified_at": "",
        "modified_by": "",
        "name": "",
        "origin_hostname_type": "",
        "query_string_ignored": "",
        "range_request_allowed": "",
        "region": "",
        "request_custom_headers": "",
        "response_custom_headers": ""
    }
}

4.2 - Models

4.2.1 - CdnServiceCreateRequest

Name	Description	Schema
cache_expiry_time required	cache expiry time Example : Minimum : `3600` Maximum : `2592000`	integer
cache_key_hostname required	cache key hostname Example : `REQUEST_HOST_HEADER`	enum (REQUEST_HOST_HEADER, ORIGIN_HOSTNAME)
caching_option required	caching option Example :	string
cdn_origin_hostname required	cdn service origin host name Example : `test.example.com` Pattern : `^(([a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9\-][a-zA-Z0-9])\.)([A-Za-z0-9]\|[A-Za-z0-9][A-Za-z0-9\-][A-Za-z0-9])$\|^((25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)$` Maximum length* : `253`	string
cdn_origin_port required	cdn service origin port Example : Minimum : `1` Maximum : `65535`	integer
cdn_origin_protocol required	cdn service origin protocol Example :	string
cdn_service_domain_prefix required	cdn service domain prefix Example : `global1` Pattern : `^[a-z0-9]$` Minimum length* : `4` Maximum length : `40`	string
cdn_service_origin_path optional	cdn service origin path Example : `/test/global/` Pattern : `^/$\|^(/[a-zA-Z0-9-._]+)+/$`	any of [string, null]
content_policy required	content policy Example :	string
custom_forward_host_header optional	custom forward host header Example :	any of [string, null]
description optional	Description Example :	any of [string, null]
forward_host_header required	forward host header Example : `REQUEST_HOST_HEADER`	enum (REQUEST_HOST_HEADER, ORIGIN_HOSTNAME, CUSTOM)
name required	cdn service name Example : `test1` Pattern : `^[a-zA-Z0-9]$` Minimum length* : `3` Maximum length : `20`	string
origin_hostname_type required	origin hostname type Example : `DOMAIN`	enum (DOMAIN, IP)
query_string_ignored required	query string ignored Example :	boolean
range_request_allowed required	range request allowed Example :	boolean
request_custom_headers optional	request custom headers Example :	object
response_custom_headers optional	response custom header Example :	object
tags optional	Tag List	array[Tag]

4.2.2 - CdnServiceDetail

Name	Description	Schema
account_id required	Account ID Example :	string
cache_expiry_time required	cache expiry time Example :	integer
cache_key_hostname required	cache key hostname Example :	string
caching_option required	caching option Example :	string
cdn_origin_hostname required	cdn service origin host name Example :	string
cdn_origin_port required	cdn service origin port Example :	integer
cdn_origin_protocol required	cdn service origin protocol Example :	string
cdn_service_activation_state required	cdn service activation state Example :	string
cdn_service_config_version required	cdn service config version Example :	integer
cdn_service_domain required	cdn service domain Example :	string
cdn_service_origin_path required	cdn service origin path Example :	string
cdn_service_state required	cdn service state Example :	string
content_policy required	content policy Example :	string
created_at required	create at Example :	string
created_by required	create by Example :	string
custom_forward_host_header required	custom forward host header Example :	string
description required	Description Example :	string
forward_host_header required	forward host header Example :	string
id required	cdn service id Example :	string
modified_at required	modified at Example :	string
modified_by required	modified by Example :	string
name required	cdn service name Example :	string
origin_hostname_type required	origin hostname type Example :	string
query_string_ignored required	query string ignored Example :	boolean
range_request_allowed required	range request allowed Example :	boolean
region required	region Example :	string
request_custom_headers required	request custom headers Example :	object
response_custom_headers required	response custom header Example :	object

4.2.3 - CdnServiceDetailResponse

Name	Description	Schema	Default
cdn required		CdnServiceDetail

4.2.4 - CdnServiceListResponse

Name	Description	Schema
cdn required		array[CdnServiceResponse]
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]

4.2.5 - CdnServiceModifyDescriptionRequest

Name	Description	Schema	Default
description required	Description Example :	string

4.2.6 - CdnServicePurgeRequest

Name	Description	Schema
custom_url optional	custom url Example : `/test/` Pattern : `^/[a-zA-Z0-9-._/]*$`	any of [string, null]
target_content required	target content Example :	string
target_url required	target url Example :	string

4.2.7 - CdnServiceResponse

Name	Description	Schema
account_id required	Account ID Example :	string
cdn_origin_hostname required	cdn service origin host name Example :	string
cdn_service_domain required	cdn service domain Example :	string
cdn_service_state required	cdn service state 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]
id required	cdn 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	cdn service name Example :	string
region required	region Example :	string

4.2.8 - CdnServiceResponseResult

Name	Description	Schema	Default
cdn required		CdnServiceResult

4.2.9 - CdnServiceResult

Name	Description	Schema
account_id required	Account ID Example :	string
resource_id required	resource id Example :	string
workflow_id required	workflow id Example :	string

4.2.10 - CdnServiceUpdateRequest

Name	Description	Schema
cache_expiry_time required	cache expiry time Example : Minimum : `3600` Maximum : `2592000`	integer
cache_key_hostname required	cache key hostname Example : `REQUEST_HOST_HEADER`	enum (REQUEST_HOST_HEADER, ORIGIN_HOSTNAME)
caching_option required	caching option Example :	string
cdn_origin_hostname required	cdn service origin host name Example : `test.example.com` Pattern : `^(([a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9\-][a-zA-Z0-9])\.)([A-Za-z0-9]\|[A-Za-z0-9][A-Za-z0-9\-][A-Za-z0-9])$\|^((25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)$` Maximum length* : `253`	string
cdn_origin_port required	cdn service origin port Example : Minimum : `1` Maximum : `65535`	integer
cdn_origin_protocol required	cdn service origin protocol Example :	string
cdn_service_origin_path optional	cdn service origin path Example : `/test/global/` Pattern : `^/$\|^(/[a-zA-Z0-9-._]+)+/$`	any of [string, null]
content_policy required	content policy Example :	string
custom_forward_host_header optional	custom forward host header Example :	any of [string, null]
forward_host_header required	forward host header Example : `REQUEST_HOST_HEADER`	enum (REQUEST_HOST_HEADER, ORIGIN_HOSTNAME, CUSTOM)
origin_hostname_type required	origin hostname type Example : `DOMAIN`	enum (DOMAIN, IP)
query_string_ignored required	query string ignored Example :	boolean
range_request_allowed required	range request allowed Example :	boolean
request_custom_headers optional	request custom headers Example :	any of [object, null]
response_custom_headers optional	response custom header Example :	any of [object, null]

4.2.11 - Tag

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

5 - GSLB

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 GSLB service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.

Version

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

Version	Status	Not Before
1.1	CURRENT	-
1.0	DEPRECATED	20260531

OpenAPI URL

https://gslb.{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

5.1 - APIs

5.1.1 - CreateGslb

5.1.1.1 - 1.1

post /v1/gslbs

Description

The GSLB Create.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		GslbCreateRequestV1Dot1

Responses

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

Example HTTP request

Request path

/v1/gslbs

Request header

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

Request body

{
    "algorithm": "ROUND_ROBIN",
    "description": "Example Description for GSLB",
    "env_usage": "PUBLIC",
    "health_check": {
        "health_check_interval": "",
        "health_check_probe_timeout": "",
        "health_check_user_id": "",
        "health_check_user_password": "",
        "protocol": "",
        "receive_string": "",
        "send_string": "",
        "service_port": "",
        "timeout": ""
    },
    "name": "example.gslb.e.samsungsdscloud.com",
    "resources": [
        {
            "description": "",
            "destination": "",
            "region": "",
            "weight": 0
        }
    ],
    "tags": []
}

Example HTTP response

Response 202

{
    "gslb": {
        "algorithm": "ROUND_ROBIN",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for GSLB",
        "env_usage": "PUBLIC",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": 2,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "example.gslb.e.samsungsdscloud.com",
        "state": "ACTIVE"
    }
}

5.1.1.2 - 1.0

post /v1/gslbs

Description

The GSLB Create.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
body	body required		GslbCreateRequest

Responses

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

Example HTTP request

Request path

/v1/gslbs

Request header

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

Request body

{
    "algorithm": "",
    "description": "",
    "env_usage": "",
    "health_check": {
        "health_check_interval": "",
        "health_check_probe_timeout": "",
        "health_check_user_id": "",
        "health_check_user_password": "",
        "protocol": "",
        "receive_string": "",
        "send_string": "",
        "service_port": "",
        "timeout": ""
    },
    "name": "",
    "resources": [
        {
            "description": "",
            "destination": "",
            "disabled": false,
            "region": "",
            "weight": 0
        }
    ],
    "tags": []
}

Example HTTP response

Response 202

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

5.1.2 - DeleteGslb

5.1.2.1 - 1.1

delete /v1/gslbs/{gslb_id}

Description

The GSLB Delete.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	gslb_id required	The GSLB ID. Example :	string	None

Responses

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

Example HTTP request

Request path

/v1/gslbs/{gslb_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 = gslb 1.1"

Example HTTP response

Response 202

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

5.1.2.2 - 1.0

delete /v1/gslbs/{gslb_id}

Description

The GSLB Delete.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
path	gslb_id required	The GSLB ID. Example :	string	None

Responses

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

Example HTTP request

Request path

/v1/gslbs/{gslb_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 = gslb 1.0"

Example HTTP response

Response 202

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

5.1.3 - ListGslbResources

5.1.3.1 - 1.1

get /v1/gslbs/{gslb_id}/resources

Description

The GSLB Resource List.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	gslb_id required	The GSLB 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	GslbResourceListResponseV1Dot1
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/gslbs/{gslb_id}/resources

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "gslb_resources": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "destination": "",
            "health_check_status": "CONNECTED",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "region": "",
            "status": "ENABLE",
            "weight": 0
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

5.1.3.2 - 1.0

get /v1/gslbs/{gslb_id}/resources

Description

The GSLB Resource List.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
path	gslb_id required	The GSLB 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	GslbResourceListResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/gslbs/{gslb_id}/resources

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "gslb_resources": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "destination": "",
            "disabled": false,
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "region": "",
            "weight": 0
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

5.1.4 - ListGslbs

5.1.4.1 - 1.1

get /v1/gslbs

Description

The GSLB List.

State ACTIVE (CURRENT)

Version	Not Before
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	state optional	The GSLB State. Example :	any of [string, null]	None
query	name optional	The Name of the gslb. Example :	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/gslbs

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "gslbs": [
        {
            "algorithm": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "env_usage": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "linked_resource_count": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "state": ""
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

5.1.4.2 - 1.0

get /v1/gslbs

Description

The GSLB List.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

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	state optional	The GSLB State. Example :	any of [string, null]	None
query	name optional	The Name of the gslb. Example :	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/gslbs

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "gslbs": [
        {
            "algorithm": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "env_usage": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "linked_resource_count": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "state": ""
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

5.1.5 - ListGslbsRegionalRoutingControl

5.1.5.1 - 1.1

get /v1/gslbs/routing-control

Description

The GSLB Regional Resource List.

State ACTIVE (CURRENT)

Version	Not Before
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	region optional	The GSLB Resource Region. Example :	any of [string, null]	None
query	status optional	The GSLB Resource Status. Example :	any of [enum (ENABLE, DISABLE), null]	None
query	name optional	The Name of the gslb. Example :	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/gslbs/routing-control

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "regional_gslbs": [
        {
            "algorithm": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "env_usage": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "linked_regional_resource_count": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "region": "",
            "status": "ENABLE"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

5.1.6 - SetGslb

5.1.6.1 - 1.1

put /v1/gslbs/{gslb_id}

Description

The GSLB Set.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	gslb_id required	The GSLB ID. Example :	string	None
body	body required		GslbSetRequest

Responses

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

Example HTTP request

Request path

/v1/gslbs/{gslb_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 = gslb 1.1"

Request body

{
    "algorithm": "",
    "description": ""
}

Example HTTP response

Response 200

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

5.1.6.2 - 1.0

put /v1/gslbs/{gslb_id}

Description

The GSLB Set.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
path	gslb_id required	The GSLB ID. Example :	string	None
body	body required		GslbSetRequest

Responses

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

Example HTTP request

Request path

/v1/gslbs/{gslb_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 = gslb 1.0"

Request body

{
    "algorithm": "",
    "description": ""
}

Example HTTP response

Response 200

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

5.1.7 - SetGslbHealthCheck

5.1.7.1 - 1.1

put /v1/gslbs/{gslb_id}/health-check

Description

Set GSLB Health Checks.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	gslb_id required	The GSLB ID. Example :	string	None
body	body required		GslbHealthCheck

Responses

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

Example HTTP request

Request path

/v1/gslbs/{gslb_id}/health-check

Request header

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

Request body

{
    "health_check_interval": "",
    "health_check_probe_timeout": "",
    "health_check_user_id": "",
    "health_check_user_password": "",
    "protocol": "",
    "receive_string": "",
    "send_string": "",
    "service_port": "",
    "timeout": ""
}

Example HTTP response

Response 202

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

5.1.7.2 - 1.0

put /v1/gslbs/{gslb_id}/health-check

Description

Set GSLB Health Checks.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
path	gslb_id required	The GSLB ID. Example :	string	None
body	body required		GslbHealthCheck

Responses

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

Example HTTP request

Request path

/v1/gslbs/{gslb_id}/health-check

Request header

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

Request body

{
    "health_check_interval": "",
    "health_check_probe_timeout": "",
    "health_check_user_id": "",
    "health_check_user_password": "",
    "protocol": "",
    "receive_string": "",
    "send_string": "",
    "service_port": "",
    "timeout": ""
}

Example HTTP response

Response 202

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

5.1.8 - SetGslbRegionalRoutingControl

5.1.8.1 - 1.1

put /v1/gslbs/{gslb_id}/routing-control

Description

Set GSLB Regional Routing.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	gslb_id required	The GSLB ID. Example :	string	None
body	body required		GslbRoutingControlRequest

Responses

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

Example HTTP request

Request path

/v1/gslbs/{gslb_id}/routing-control

Request header

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

Request body

{
    "region": "",
    "status": "ENABLE"
}

Example HTTP response

Response 202

{
    "regional_gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_regional_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "region": "",
        "status": "ENABLE"
    }
}

5.1.9 - SetGslbResources

5.1.9.1 - 1.1

put /v1/gslbs/{gslb_id}/resources

Description

Set GSLB Resources.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	gslb_id required	The GSLB ID. Example :	string	None
body	body required		GslbResourcesSetRequest

Responses

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

Example HTTP request

Request path

/v1/gslbs/{gslb_id}/resources

Request header

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

Request body

{
    "resources": [
        {
            "description": "",
            "destination": "",
            "region": "",
            "weight": 0
        }
    ]
}

Example HTTP response

Response 202

{
    "gslb_resources": [
        {
            "description": "",
            "destination": "",
            "region": "",
            "status": "ENABLE",
            "weight": 0
        }
    ]
}

5.1.9.2 - 1.0

put /v1/gslbs/{gslb_id}/resources

Description

Set GSLB Resources.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
path	gslb_id required	The GSLB ID. Example :	string	None
body	body required		GslbResourceSetRequest

Responses

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

Example HTTP request

Request path

/v1/gslbs/{gslb_id}/resources

Request header

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

Request body

{
    "resources": [
        {
            "description": "",
            "destination": "",
            "disabled": false,
            "region": "",
            "weight": 0
        }
    ]
}

Example HTTP response

Response 202

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

5.1.10 - ShowGslb

5.1.10.1 - 1.1

get /v1/gslbs/{gslb_id}

Description

The GSLB Show.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	gslb_id required	The GSLB ID. Example :	string	None

Responses

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

Example HTTP request

Request path

/v1/gslbs/{gslb_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 = gslb 1.1"

Example HTTP response

Response 200

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

5.1.10.2 - 1.0

get /v1/gslbs/{gslb_id}

Description

The GSLB Show.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260531

Parameters

Type	Name	Description	Schema	Default
path	gslb_id required	The GSLB ID. Example :	string	None

Responses

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

Example HTTP request

Request path

/v1/gslbs/{gslb_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 = gslb 1.0"

Example HTTP response

Response 200

{
    "gslb": {
        "algorithm": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "env_usage": "",
        "health_check": {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_interval": "",
            "health_check_probe_timeout": "",
            "health_check_user_id": "",
            "health_check_user_password": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "protocol": "",
            "receive_string": "",
            "send_string": "",
            "service_port": "",
            "timeout": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "linked_resource_count": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": ""
    }
}

5.2 - Models

5.2.1 - GslbCreateRequest

Name	Description	Schema
algorithm required	The GSLB Algorithm. Example :	string
description optional	Description Example :	any of [string, null]
env_usage required	The GSLB Environment Usage. Example :	string
health_check optional	The GSLB Health Check.	any of [GslbHealthCheck, null]
name required	The Name of the gslb. Example :	string
resources required		array[GslbResource]
tags optional	Tag List	array[Tag]

5.2.2 - GslbCreateRequestV1Dot1

Name	Description	Schema
algorithm required	The GSLB Algorithm. Example : `ROUND_ROBIN`	enum (RATIO, ROUND_ROBIN)
description optional	Description Example : `Example Description for GSLB`	any of [string, null]
env_usage required	The GSLB Environment Usage. Example : `PUBLIC`	enum (PUBLIC, PRIVATE)
health_check optional	The GSLB Health Check.	any of [GslbHealthCheck, null]
name required	The Name of the gslb. Example : `example.gslb.e.samsungsdscloud.com`	string
resources required	The GSLB Resource List.	array[GslbResourceV1Dot1]
tags optional	Tag List	array[Tag]

5.2.3 - GslbDetail

Name	Description	Schema
algorithm required	The GSLB Algorithm. 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]
env_usage required	The GSLB Environment Usage. Example :	string
health_check required		any of [GslbHeathCheckShowResponse, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
linked_resource_count required	The GSLB Linked Resource Count. Example :	integer
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	The Name of the gslb. Example :	string
state required	The GSLB State. Example :	string

5.2.4 - GslbHealthCheck

Name	Description	Schema
health_check_interval optional	The GSLB Health Check Interval. Example :	any of [integer, null]
health_check_probe_timeout optional	The GSLB Health Check Probe Timeout. Example :	any of [integer, null]
health_check_user_id optional	The GSLB Health Check User Name. Example :	any of [string, null]
health_check_user_password optional	The GSLB Health Check Password. Example :	any of [string, null]
protocol required	The GSLB Health Check Protocol. Example :	string
receive_string optional	The GSLB Health Check Receive String. Example :	any of [string, null]
send_string optional	The GSLB Health Check Send String. Example :	any of [string, null]
service_port optional	The GSLB Health Check Service Port. Example :	any of [integer, null]
timeout optional	The GSLB Health Check Timeout. Example :	any of [integer, null]

5.2.5 - GslbHeathCheckShowResponse

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
health_check_interval optional	The GSLB Health Check Interval. Example :	any of [integer, null]
health_check_probe_timeout optional	The GSLB Health Check Probe Timeout. Example :	any of [integer, null]
health_check_user_id optional	The GSLB Health Check User Name. Example :	any of [string, null]
health_check_user_password optional	The GSLB Health Check Password. Example :	any of [string, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
protocol required	The GSLB Health Check Protocol. Example :	string
receive_string optional	The GSLB Health Check Receive String. Example :	any of [string, null]
send_string optional	The GSLB Health Check Send String. Example :	any of [string, null]
service_port optional	The GSLB Health Check Service Port. Example :	any of [integer, null]
timeout optional	The GSLB Health Check Timeout. Example :	any of [integer, null]

5.2.6 - GslbListResponse

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

5.2.7 - GslbResource

Name	Description	Schema
description optional	Description Example :	any of [string, null]
destination required	The GSLB Resource Destination. Example :	string
disabled optional	The GSLB Resource disabled. Example : `False`	any of [boolean, null]
region required	The GSLB Resource Region. Example :	string
weight optional	The GSLB Resource Weight. Example : `0`	any of [integer, null]

5.2.8 - GslbResourceListResponse

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

5.2.9 - GslbResourceListResponseV1Dot1

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

5.2.10 - GslbResourceResponse

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
description optional	Description Example :	any of [string, null]
destination required	The GSLB Resource Destination. Example :	string
disabled optional	The GSLB Resource disabled. Example : `False`	any of [boolean, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
region required	The GSLB Resource Region. Example :	string
weight optional	The GSLB Resource Weight. Example : `0`	any of [integer, null]

5.2.11 - GslbResourceResponseV1Dot1

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
description optional	Description Example :	any of [string, null]
destination required	The GSLB Resource Destination. Example :	string
health_check_status required	The GSLB Resource Health Check Status. Example : `CONNECTED`	enum (CONNECTED, DISCONNECTED)
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
region required	The GSLB Resource Region. Example :	string
status required	The GSLB Resource Status. Example : `ENABLE`	enum (ENABLE, DISABLE)
weight optional	The GSLB Resource Weight. Example : `0`	any of [integer, null]

5.2.12 - GslbResourceSetRequest

Name	Description	Schema	Default
resources required		array[GslbResource]

5.2.13 - GslbResourceSetRequestV1Dot1

Name	Description	Schema
description optional	Description Example :	any of [string, null]
destination required	The GSLB Resource Destination. Example :	string
region required	The GSLB Resource Region. Example :	string
weight optional	The GSLB Resource Weight. Example : `0`	any of [integer, null]

5.2.14 - GslbResourcesSetRequest

Name	Description	Schema	Default
resources required		array[GslbResourceSetRequestV1Dot1]

5.2.15 - GslbResourcesSetResponse

Name	Description	Schema	Default
gslb_resources required		array[GslbResourceWithStatus]

5.2.16 - GslbResourceV1Dot1

Name	Description	Schema
description optional	Description Example :	any of [string, null]
destination required	The GSLB Resource Destination. Example :	string
region required	The GSLB Resource Region. Example :	string
weight optional	The GSLB Resource Weight. Example : `0`	any of [integer, null]

5.2.17 - GslbResourceWithStatus

Name	Description	Schema
description optional	Description Example :	any of [string, null]
destination required	The GSLB Resource Destination. Example :	string
region required	The GSLB Resource Region. Example :	string
status required	The GSLB Resource Status. Example : `ENABLE`	enum (ENABLE, DISABLE)
weight optional	The GSLB Resource Weight. Example : `0`	any of [integer, null]

5.2.18 - GslbResponseCommon

Name	Description	Schema
algorithm required	The GSLB Algorithm. 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]
env_usage required	The GSLB Environment Usage. Example :	string
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
linked_resource_count required	The GSLB Linked Resource Count. Example :	integer
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	The Name of the gslb. Example :	string
state required	The GSLB State. Example :	string

5.2.19 - GslbRoutingControlListResponse

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

5.2.20 - GslbRoutingControlRequest

Name	Description	Schema	Default
region required	The GSLB Resource Region. Example :	string
status required	The GSLB Resource Status. Example : `ENABLE`	enum (ENABLE, DISABLE)

5.2.21 - GslbRoutingControlResponse

Name	Description	Schema	Default
regional_gslb required		GslbRoutingControlResponseCommon

5.2.22 - GslbRoutingControlResponseCommon

Name	Description	Schema
algorithm required	The GSLB Algorithm. 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]
env_usage required	The GSLB Environment Usage. Example :	string
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
linked_regional_resource_count required	The GSLB Linked Resource Count Per Region. Example :	integer
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	The Name of the gslb. Example :	string
region required	The GSLB Resource Region. Example :	string
status required	The GSLB Resource Status. Example : `ENABLE`	enum (ENABLE, DISABLE)

5.2.23 - GslbSetRequest

Name	Description	Schema	Default
algorithm optional	The GSLB Algorithm. Example :	any of [string, null]
description optional	Description Example :	any of [string, null]

5.2.24 - GslbShowResponse

Name	Description	Schema	Default
gslb required		GslbDetail

5.2.25 - GslbShowResponseV1Dot1

Name	Description	Schema	Default
gslb required		GslbV1Dot1

5.2.26 - GslbV1Dot1

Name	Description	Schema
algorithm required	The GSLB Algorithm. Example : `ROUND_ROBIN`	enum (RATIO, ROUND_ROBIN)
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description optional	Description Example : `Example Description for GSLB`	any of [string, null]
env_usage required	The GSLB Environment Usage. Example : `PUBLIC`	enum (PUBLIC, PRIVATE)
health_check optional	The GSLB Health Check.	any of [GslbHeathCheckShowResponse, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
linked_resource_count required	The GSLB Linked Resource Count. Example : `2`	integer
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	The Name of the gslb. Example : `example.gslb.e.samsungsdscloud.com`	string
state required	The GSLB State. Example : `ACTIVE`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING)

5.2.27 - Tag

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

6 - Load Balancer

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 LOADBALANCER service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.

Version

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

Version	Status	Not Before
1.3	CURRENT	-
1.2	DEPRECATED	20260319
1.1	DEPRECATED	20260319
1.0	DEPRECATED	20251023

OpenAPI URL

https://loadbalancer.{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

6.1 - APIs

6.1.1 - AddLbServerGroupMembers

6.1.1.1 - 1.3

post /v1/lb-server-groups/{lb_server_group_id}/members

Description

Add Lb Server Group Member bulk

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	ID of Lb Server Group Example :	string	None
body	body required		MemberListCreateRequestV1Dot1

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_id}/members

Request header

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

Request body

{
    "members": [
        {
            "member_ip": "192.168.0.1",
            "member_port": 80,
            "member_state": "ENABLE",
            "member_weight": 100,
            "name": "virtualserver-1",
            "object_id": "1",
            "object_type": "VM"
        }
    ]
}

Example HTTP response

Response 202

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "members": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "lb_server_group_id": "",
            "member_ip": "",
            "member_port": "",
            "member_state": "",
            "member_weight": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "object_id": "",
            "object_type": "VM",
            "state": "CREATING",
            "subnet_id": "",
            "uuid": ""
        }
    ]
}

6.1.1.2 - 1.2

post /v1/lb-server-groups/{lb_server_group_id}/members

Description

Add Lb Server Group Member bulk

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	ID of Lb Server Group Example :	string	None
body	body required		MemberListCreateRequestV1Dot1

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_id}/members

Request header

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

Request body

{
    "members": [
        {
            "member_ip": "192.168.0.1",
            "member_port": 80,
            "member_state": "ENABLE",
            "member_weight": 100,
            "name": "virtualserver-1",
            "object_id": "1",
            "object_type": "VM"
        }
    ]
}

Example HTTP response

Response 202

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "members": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "lb_server_group_id": "",
            "member_ip": "",
            "member_port": "",
            "member_state": "",
            "member_weight": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "object_id": "",
            "object_type": "VM",
            "state": "CREATING",
            "subnet_id": "",
            "uuid": ""
        }
    ]
}

6.1.1.3 - 1.1

post /v1/lb-server-groups/{lb_server_group_id}/members

Description

Add Lb Server Group Member bulk

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	ID of Lb Server Group Example :	string	None
body	body required		MemberListCreateRequestV1Dot1

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_id}/members

Request header

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

Request body

{
    "members": [
        {
            "member_ip": "192.168.0.1",
            "member_port": 80,
            "member_state": "ENABLE",
            "member_weight": 100,
            "name": "virtualserver-1",
            "object_id": "1",
            "object_type": "VM"
        }
    ]
}

Example HTTP response

Response 202

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "members": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "lb_server_group_id": "",
            "member_ip": "",
            "member_port": "",
            "member_state": "",
            "member_weight": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "object_id": "",
            "object_type": "VM",
            "state": "CREATING",
            "subnet_id": "",
            "uuid": ""
        }
    ]
}

6.1.2 - CreateLBHealthCheck

6.1.2.1 - 1.3

post /v1/lb-health-checks

Description

Create LB Health Check

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		LbHealthCheckCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	LbHealthCheckShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-health-checks

Request header

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

Request body

{
    "lb_health_check": {
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_url": "/test",
        "http_method": "GET",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "tags": [],
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

Example HTTP response

Response 201

{
    "lb_health_check": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_type": "DEFAULT",
        "health_check_url": "/test",
        "http_method": "GET",
        "id": "46c681018e33453085ca7c8db54e0076",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "Test-LbMonitor-01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.2.2 - 1.2

post /v1/lb-health-checks

Description

Create LB Health Check

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Type	Name	Description	Schema	Default
body	body required		LbHealthCheckCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	LbHealthCheckShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-health-checks

Request header

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

Request body

{
    "lb_health_check": {
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_url": "/test",
        "http_method": "GET",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "tags": [],
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

Example HTTP response

Response 201

{
    "lb_health_check": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_type": "DEFAULT",
        "health_check_url": "/test",
        "http_method": "GET",
        "id": "46c681018e33453085ca7c8db54e0076",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "Test-LbMonitor-01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.2.3 - 1.1

post /v1/lb-health-checks

Description

Create LB Health Check

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Type	Name	Description	Schema	Default
body	body required		LbHealthCheckCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	LbHealthCheckShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-health-checks

Request header

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

Request body

{
    "lb_health_check": {
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_url": "/test",
        "http_method": "GET",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "tags": [],
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

Example HTTP response

Response 201

{
    "lb_health_check": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_type": "DEFAULT",
        "health_check_url": "/test",
        "http_method": "GET",
        "id": "46c681018e33453085ca7c8db54e0076",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "Test-LbMonitor-01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.3 - CreateLbListener

6.1.3.1 - 1.3

post /v1/lb-listeners

Description

create LB listener

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		LbListenerCreateRequestV1Dot3

Responses

HTTP Code	Description	Schema
201	Created	LbListenerShowResponseV1Dot3
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-listeners

Request header

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

Request body

{
    "listener": {
        "condition_type": "URL_PATH",
        "description": "",
        "hsts_max_age": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "idle_timeout": "",
        "insert_client_ip": "",
        "loadbalancer_id": "",
        "name": "",
        "persistence": "",
        "protocol": "TCP",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "not_after_dt": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "support_http2": false,
        "tags": [],
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

Example HTTP response

Response 201

{
    "listener": {
        "condition_type": "URL_PATH",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "hsts_max_age": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "idle_timeout": "",
        "insert_client_ip": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "persistence": "",
        "protocol": "TCP",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "server_group_name": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "not_after_dt": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "state": "",
        "support_http2": false,
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

6.1.3.2 - 1.2

post /v1/lb-listeners

Description

create LB listener

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Type	Name	Description	Schema	Default
body	body required		LbListenerCreateRequestV1Dot2

Responses

HTTP Code	Description	Schema
201	Created	LbListenerShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-listeners

Request header

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

Request body

{
    "listener": {
        "condition_type": "URL_PATH",
        "description": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "insert_client_ip": "",
        "loadbalancer_id": "",
        "name": "",
        "persistence": "",
        "protocol": "",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "not_after_dt": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "support_http2": false,
        "tags": [],
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

Example HTTP response

Response 201

{
    "listener": {
        "condition_type": "URL_PATH",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "insert_client_ip": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "persistence": "",
        "protocol": "",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "server_group_name": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "not_after_dt": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "state": "",
        "support_http2": false,
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

6.1.3.3 - 1.1

post /v1/lb-listeners

Description

create LB listener

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Type	Name	Description	Schema	Default
body	body required		LbListenerCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	LbListenerShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/lb-listeners

Request header

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

Request body

{
    "listener": {
        "condition_type": "URL_PATH",
        "description": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "insert_client_ip": "",
        "loadbalancer_id": "",
        "name": "",
        "persistence": "",
        "protocol": "",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "not_after_dt": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "support_http2": false,
        "tags": [],
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

Example HTTP response

Response 201

{
    "listener": {
        "condition_type": "URL_PATH",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "insert_client_ip": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "persistence": "",
        "protocol": "",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "server_group_name": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "not_after_dt": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "state": "",
        "support_http2": false,
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

6.1.4 - CreateLBServerGroup

6.1.4.1 - 1.3

post /v1/lb-server-groups

Description

Create LB Server Group

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		LbServerGroupCreateRequest

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups

Request header

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

Request body

{
    "lb_server_group": {
        "description": "this is an lb server group",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "tags": [],
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

Example HTTP response

Response 202

{
    "lb_server_group": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "lb_name": "Test-LB-01",
        "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.4.2 - 1.2

post /v1/lb-server-groups

Description

Create LB Server Group

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Type	Name	Description	Schema	Default
body	body required		LbServerGroupCreateRequest

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups

Request header

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

Request body

{
    "lb_server_group": {
        "description": "this is an lb server group",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "tags": [],
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

Example HTTP response

Response 202

{
    "lb_server_group": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "lb_name": "Test-LB-01",
        "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.4.3 - 1.1

post /v1/lb-server-groups

Description

Create LB Server Group

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Type	Name	Description	Schema	Default
body	body required		LbServerGroupCreateRequest

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups

Request header

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

Request body

{
    "lb_server_group": {
        "description": "this is an lb server group",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "tags": [],
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

Example HTTP response

Response 202

{
    "lb_server_group": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "lb_name": "Test-LB-01",
        "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.5 - CreateLoadbalancer

6.1.5.1 - 1.3

post /v1/loadbalancers

Description

create Load Balancer

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		LoadbalancerCreateRequest

Responses

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

Example HTTP request

Request path

/v1/loadbalancers

Request header

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

Request body

{
    "loadbalancer": {
        "description": "",
        "firewall_enabled": true,
        "firewall_logging_enabled": true,
        "health_check_ip_1": "",
        "health_check_ip_2": "",
        "layer_type": "",
        "name": "",
        "publicip_id": "",
        "service_ip": "",
        "source_nat_ip": "",
        "subnet_id": "",
        "tags": [],
        "vpc_id": ""
    }
}

Example HTTP response

Response 202

{
    "loadbalancer": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "layer_type": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "",
        "subnet_id": "",
        "vpc_id": ""
    }
}

6.1.5.2 - 1.2

post /v1/loadbalancers

Description

create Load Balancer

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Type	Name	Description	Schema	Default
body	body required		LoadbalancerCreateRequest

Responses

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

Example HTTP request

Request path

/v1/loadbalancers

Request header

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

Request body

{
    "loadbalancer": {
        "description": "",
        "firewall_enabled": true,
        "firewall_logging_enabled": true,
        "health_check_ip_1": "",
        "health_check_ip_2": "",
        "layer_type": "",
        "name": "",
        "publicip_id": "",
        "service_ip": "",
        "source_nat_ip": "",
        "subnet_id": "",
        "tags": [],
        "vpc_id": ""
    }
}

Example HTTP response

Response 202

{
    "loadbalancer": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "layer_type": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "",
        "subnet_id": "",
        "vpc_id": ""
    }
}

6.1.5.3 - 1.1

post /v1/loadbalancers

Description

create Load Balancer

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Type	Name	Description	Schema	Default
body	body required		LoadbalancerCreateRequest

Responses

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

Example HTTP request

Request path

/v1/loadbalancers

Request header

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

Request body

{
    "loadbalancer": {
        "description": "",
        "firewall_enabled": true,
        "firewall_logging_enabled": true,
        "health_check_ip_1": "",
        "health_check_ip_2": "",
        "layer_type": "",
        "name": "",
        "publicip_id": "",
        "service_ip": "",
        "source_nat_ip": "",
        "subnet_id": "",
        "tags": [],
        "vpc_id": ""
    }
}

Example HTTP response

Response 202

{
    "loadbalancer": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "layer_type": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "state": "",
        "subnet_id": "",
        "vpc_id": ""
    }
}

6.1.6 - CreateLoadbalancerPrivateNatIp

6.1.6.1 - 1.3

post /v1/loadbalancers/{loadbalancer_id}/private-static-nats

Description

create Load Balancer Private NAT IP

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	ID Example :	string	None
body	body required		PrivateStaticNatCreateRequest

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_id}/private-static-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 = loadbalancer 1.3"

Request body

{
    "static_nat": {
        "private_nat_id": "",
        "private_nat_ip_id": ""
    }
}

Example HTTP response

Response 202

{
    "static_nat": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "external_ip_address": "",
        "id": "",
        "internal_ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "private_nat_ip_id": "",
        "state": "",
        "subnet_id": ""
    }
}

6.1.7 - CreateLoadbalancerPublicNatIp

6.1.7.1 - 1.3

post /v1/loadbalancers/{loadbalancer_id}/static-nats

Description

create Load Balancer Public NAT IP

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	ID Example :	string	None
body	body required		StaticNatCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	StaticNatCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_id}/static-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 = loadbalancer 1.3"

Request body

{
    "static_nat": {
        "publicip_id": ""
    }
}

Example HTTP response

Response 201

{
    "static_nat": {
        "account_id": "",
        "action_type": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "external_ip_address": "",
        "id": "",
        "internal_ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "owner_id": "",
        "owner_name": "",
        "owner_type": "",
        "publicip_id": "",
        "service_ip_port_id": "",
        "state": "",
        "subnet_id": "",
        "type": "",
        "vpc_id": ""
    }
}

6.1.7.2 - 1.2

post /v1/loadbalancers/{loadbalancer_id}/static-nats

Description

create Load Balancer Public NAT IP

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	ID Example :	string	None
body	body required		StaticNatCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	StaticNatCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_id}/static-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 = loadbalancer 1.2"

Request body

{
    "static_nat": {
        "publicip_id": ""
    }
}

Example HTTP response

Response 201

{
    "static_nat": {
        "account_id": "",
        "action_type": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "external_ip_address": "",
        "id": "",
        "internal_ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "owner_id": "",
        "owner_name": "",
        "owner_type": "",
        "publicip_id": "",
        "service_ip_port_id": "",
        "state": "",
        "subnet_id": "",
        "type": "",
        "vpc_id": ""
    }
}

6.1.7.3 - 1.1

post /v1/loadbalancers/{loadbalancer_id}/static-nats

Description

create Load Balancer Public NAT IP

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	ID Example :	string	None
body	body required		StaticNatCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	StaticNatCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_id}/static-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 = loadbalancer 1.1"

Request body

{
    "static_nat": {
        "publicip_id": ""
    }
}

Example HTTP response

Response 201

{
    "static_nat": {
        "account_id": "",
        "action_type": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "external_ip_address": "",
        "id": "",
        "internal_ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "owner_id": "",
        "owner_name": "",
        "owner_type": "",
        "publicip_id": "",
        "service_ip_port_id": "",
        "state": "",
        "subnet_id": "",
        "type": "",
        "vpc_id": ""
    }
}

6.1.8 - DeleteLBHealthCheck

6.1.8.1 - 1.3

delete /v1/lb-health-checks/{lb_health_check_id}

Description

Delete LB Health Check

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	lb_health_check_id required	LB Health Check ID Example : `e3cd678b11784734bc366148aa37580e`	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/lb-health-checks/{lb_health_check_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 = loadbalancer 1.3"

Example HTTP response

Response 204

6.1.8.2 - 1.2

delete /v1/lb-health-checks/{lb_health_check_id}

Description

Delete LB Health Check

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Type	Name	Description	Schema	Default
path	lb_health_check_id required	LB Health Check ID Example : `e3cd678b11784734bc366148aa37580e`	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/lb-health-checks/{lb_health_check_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 = loadbalancer 1.2"

Example HTTP response

Response 204

6.1.8.3 - 1.1

delete /v1/lb-health-checks/{lb_health_check_id}

Description

Delete LB Health Check

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Type	Name	Description	Schema	Default
path	lb_health_check_id required	LB Health Check ID Example : `e3cd678b11784734bc366148aa37580e`	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/lb-health-checks/{lb_health_check_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 = loadbalancer 1.1"

Example HTTP response

Response 204

6.1.9 - DeleteLbListener

6.1.9.1 - 1.3

delete /v1/lb-listeners/{listener_id}

Description

delete LB listener

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	listener_id required	The ID of the listener. 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/lb-listeners/{listener_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 = loadbalancer 1.3"

Example HTTP response

Response 204

6.1.9.2 - 1.2

delete /v1/lb-listeners/{listener_id}

Description

delete LB listener

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Type	Name	Description	Schema	Default
path	listener_id required	The ID of the listener. 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/lb-listeners/{listener_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 = loadbalancer 1.2"

Example HTTP response

Response 204

6.1.9.3 - 1.1

delete /v1/lb-listeners/{listener_id}

Description

delete LB listener

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Type	Name	Description	Schema	Default
path	listener_id required	The ID of the listener. 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/lb-listeners/{listener_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 = loadbalancer 1.1"

Example HTTP response

Response 204

6.1.10 - DeleteLBServerGroup

6.1.10.1 - 1.3

delete /v1/lb-server-groups/{lb_server_group_id}

Description

Delete LB Server Group

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	LB Server Group ID Example : `3d8d8754d0d54683a29f3dcc3dd95d5b`	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/lb-server-groups/{lb_server_group_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 = loadbalancer 1.3"

Example HTTP response

Response 202

6.1.10.2 - 1.2

delete /v1/lb-server-groups/{lb_server_group_id}

Description

Delete LB Server Group

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	LB Server Group ID Example : `3d8d8754d0d54683a29f3dcc3dd95d5b`	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/lb-server-groups/{lb_server_group_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 = loadbalancer 1.2"

Example HTTP response

Response 202

6.1.10.3 - 1.1

delete /v1/lb-server-groups/{lb_server_group_id}

Description

Delete LB Server Group

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	LB Server Group ID Example : `3d8d8754d0d54683a29f3dcc3dd95d5b`	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/lb-server-groups/{lb_server_group_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 = loadbalancer 1.1"

Example HTTP response

Response 202

6.1.11 - DeleteLoadbalancer

6.1.11.1 - 1.3

delete /v1/loadbalancers/{loadbalancer_id}

Description

delete Load Balancer

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	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/loadbalancers/{loadbalancer_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 = loadbalancer 1.3"

Example HTTP response

Response 202

6.1.11.2 - 1.2

delete /v1/loadbalancers/{loadbalancer_id}

Description

delete Load Balancer

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	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/loadbalancers/{loadbalancer_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 = loadbalancer 1.2"

Example HTTP response

Response 202

6.1.11.3 - 1.1

delete /v1/loadbalancers/{loadbalancer_id}

Description

delete Load Balancer

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	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/loadbalancers/{loadbalancer_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 = loadbalancer 1.1"

Example HTTP response

Response 202

6.1.12 - DeleteLoadbalancerPrivateNatIp

6.1.12.1 - 1.3

delete /v1/loadbalancers/{loadbalancer_id}/private-static-nats

Description

delete Load Balancer Private NAT IP

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	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/loadbalancers/{loadbalancer_id}/private-static-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 = loadbalancer 1.3"

Example HTTP response

Response 202

6.1.13 - DeleteLoadbalancerPublicNatIp

6.1.13.1 - 1.3

delete /v1/loadbalancers/{loadbalancer_id}/static-nats

Description

delete Load Balancer Public NAT IP

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	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/loadbalancers/{loadbalancer_id}/static-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 = loadbalancer 1.3"

Example HTTP response

Response 204

6.1.13.2 - 1.2

delete /v1/loadbalancers/{loadbalancer_id}/static-nats

Description

delete Load Balancer Public NAT IP

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	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/loadbalancers/{loadbalancer_id}/static-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 = loadbalancer 1.2"

Example HTTP response

Response 204

6.1.13.3 - 1.1

delete /v1/loadbalancers/{loadbalancer_id}/static-nats

Description

delete Load Balancer Public NAT IP

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	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/loadbalancers/{loadbalancer_id}/static-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 = loadbalancer 1.1"

Example HTTP response

Response 204

6.1.14 - ListLBHealthChecks

6.1.14.1 - 1.3

get /v1/lb-health-checks

Description

List LB Health Checks

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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	LB Health Check name Example : `Test-LbMonitor-01`	any of [string, null]	None
query	protocol optional	LB Health Check Protocol Example : `['TCP', 'UDP']`	any of [array[enum (TCP, HTTP, HTTPS)], enum (TCP, HTTP, HTTPS), null]	None
query	subnet_id optional	Service Subnet ID Example : `60fba45cb6c811efba41ba92e4fe7200`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/lb-health-checks

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "lb_health_checks": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_type": "DEFAULT",
            "id": "46c681018e33453085ca7c8db54e0076",
            "lb_server_group_count": 2,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "Test-LbMonitor-01",
            "protocol": "TCP",
            "state": "ACTIVE",
            "subnet_id": "60fba45cb6c811efba41ba92e4fe7200"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.14.2 - 1.2

get /v1/lb-health-checks

Description

List LB Health Checks

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

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	LB Health Check name Example : `Test-LbMonitor-01`	any of [string, null]	None
query	protocol optional	LB Health Check Protocol Example : `['TCP', 'UDP']`	any of [array[enum (TCP, HTTP, HTTPS)], enum (TCP, HTTP, HTTPS), null]	None
query	subnet_id optional	Service Subnet ID Example : `60fba45cb6c811efba41ba92e4fe7200`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/lb-health-checks

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "lb_health_checks": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_type": "DEFAULT",
            "id": "46c681018e33453085ca7c8db54e0076",
            "lb_server_group_count": 2,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "Test-LbMonitor-01",
            "protocol": "TCP",
            "state": "ACTIVE",
            "subnet_id": "60fba45cb6c811efba41ba92e4fe7200"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.14.3 - 1.1

get /v1/lb-health-checks

Description

List LB Health Checks

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

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	LB Health Check name Example : `Test-LbMonitor-01`	any of [string, null]	None
query	protocol optional	LB Health Check Protocol Example : `['TCP', 'UDP']`	any of [array[enum (TCP, HTTP, HTTPS)], enum (TCP, HTTP, HTTPS), null]	None
query	subnet_id optional	Service Subnet ID Example : `60fba45cb6c811efba41ba92e4fe7200`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/lb-health-checks

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "lb_health_checks": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_check_type": "DEFAULT",
            "id": "46c681018e33453085ca7c8db54e0076",
            "lb_server_group_count": 2,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "Test-LbMonitor-01",
            "protocol": "TCP",
            "state": "ACTIVE",
            "subnet_id": "60fba45cb6c811efba41ba92e4fe7200"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.15 - ListLbListeners

6.1.15.1 - 1.3

get /v1/lb-listeners

Description

get LB listener list

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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	loadbalancer_id optional	The ID of the load balancer. Example :	any of [string, null]	None
query	state optional	The State of the listener. Example :	any of [string, null]	None
query	name optional	The name of the listener. Example :	any of [string, null]	None
query	service_port optional	The port of the listener. Example :	any of [integer, null]	None
query	protocol optional	Protocol Example : `['TCP', 'UDP']`	any of [array[enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY)], enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY), null]	None
query	not_protocol optional	The protocol of the listener to exclude. Example : `TCP`	any of [enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY), null]	None

Responses

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

Example HTTP request

Request path

/v1/lb-listeners

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "listeners": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "protocol": "TCP",
            "service_port": "",
            "state": ""
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.15.2 - 1.2

get /v1/lb-listeners

Description

get LB listener list

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

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	loadbalancer_id optional	The ID of the load balancer. Example :	any of [string, null]	None
query	state optional	The State of the listener. Example :	any of [string, null]	None
query	name optional	The name of the listener. Example :	any of [string, null]	None
query	service_port optional	The port of the listener. Example :	any of [integer, null]	None
query	protocol optional	Protocol Example : `['TCP', 'UDP']`	any of [array[enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY)], enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY), null]	None
query	not_protocol optional	The protocol of the listener to exclude. Example : `TCP`	any of [enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY), null]	None

Responses

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

Example HTTP request

Request path

/v1/lb-listeners

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "listeners": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "protocol": "TCP",
            "service_port": "",
            "state": ""
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.15.3 - 1.1

get /v1/lb-listeners

Description

get LB listener list

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

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	loadbalancer_id optional	The ID of the load balancer. Example :	any of [string, null]	None
query	state optional	The State of the listener. Example :	any of [string, null]	None
query	name optional	The name of the listener. Example :	any of [string, null]	None
query	service_port optional	The port of the listener. Example :	any of [integer, null]	None
query	protocol optional	Protocol Example : `['TCP', 'UDP']`	any of [array[enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY)], enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY), null]	None
query	not_protocol optional	The protocol of the listener to exclude. Example : `TCP`	any of [enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY), null]	None

Responses

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

Example HTTP request

Request path

/v1/lb-listeners

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "listeners": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "protocol": "TCP",
            "service_port": "",
            "state": ""
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.16 - ListLbServerGroupMembers

6.1.16.1 - 1.3

get /v1/lb-server-groups/{lb_server_group_id}/members

Description

Get Lb Server Group Member List

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	ID of Lb Server Group 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	name optional	Name of Member Example :	any of [string, null]	None
query	member_ip optional	IP of Member Example :	any of [string, null]	None
query	member_port optional	Protocol port of Member Example :	any of [integer, null]	None

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_id}/members

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "members": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_state": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "lb_server_group_id": "",
            "member_ip": "",
            "member_port": "",
            "member_state": "",
            "member_weight": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "object_id": "",
            "object_type": "VM",
            "state": "CREATING"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.16.2 - 1.2

get /v1/lb-server-groups/{lb_server_group_id}/members

Description

Get Lb Server Group Member List

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	ID of Lb Server Group 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	name optional	Name of Member Example :	any of [string, null]	None
query	member_ip optional	IP of Member Example :	any of [string, null]	None
query	member_port optional	Protocol port of Member Example :	any of [integer, null]	None

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_id}/members

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "members": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_state": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "lb_server_group_id": "",
            "member_ip": "",
            "member_port": "",
            "member_state": "",
            "member_weight": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "object_id": "",
            "object_type": "VM",
            "state": "CREATING"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.16.3 - 1.1

get /v1/lb-server-groups/{lb_server_group_id}/members

Description

Get Lb Server Group Member List

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	ID of Lb Server Group 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	name optional	Name of Member Example :	any of [string, null]	None
query	member_ip optional	IP of Member Example :	any of [string, null]	None
query	member_port optional	Protocol port of Member Example :	any of [integer, null]	None

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_id}/members

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "members": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "health_state": "",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "lb_server_group_id": "",
            "member_ip": "",
            "member_port": "",
            "member_state": "",
            "member_weight": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "object_id": "",
            "object_type": "VM",
            "state": "CREATING"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.17 - ListLBServerGroups

6.1.17.1 - 1.3

get /v1/lb-server-groups

Description

Get LB Server Group list

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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	LB Server Group name Example : `ServerGroup01`	any of [string, null]	None
query	protocol optional	Protocol Example : `['TCP', 'UDP']`	any of [array[enum (TCP, UDP)], enum (TCP, UDP), null]	None
query	subnet_id optional	Service Subnet ID Example : `60fba45cb6c811efba41ba92e4fe7200`	any of [string, null]	None
query	vpc_id optional	VPC ID Example : `8acceeb6920c4fc494490d864f67f0b5`	any of [string, null]	None
query	lb_health_check_id optional	LB Health Check ID Example : `46c681018e33453085ca7c8db54e0076`	string	None
query	lb_method optional	LB Method Example : `ROUND_ROBIN`	any of [array[enum (ROUND_ROBIN, LEAST_CONNECTION, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION)], enum (ROUND_ROBIN, LEAST_CONNECTION, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION), null]	None

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "lb_server_groups": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
            "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
            "lb_name": "Test-LB-01",
            "lb_server_group_member_count": 2,
            "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ServerGroup01",
            "protocol": "TCP",
            "state": "ACTIVE",
            "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.17.2 - 1.2

get /v1/lb-server-groups

Description

Get LB Server Group list

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

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	LB Server Group name Example : `ServerGroup01`	any of [string, null]	None
query	protocol optional	Protocol Example : `['TCP', 'UDP']`	any of [array[enum (TCP, UDP)], enum (TCP, UDP), null]	None
query	subnet_id optional	Service Subnet ID Example : `60fba45cb6c811efba41ba92e4fe7200`	any of [string, null]	None
query	vpc_id optional	VPC ID Example : `8acceeb6920c4fc494490d864f67f0b5`	any of [string, null]	None
query	lb_health_check_id optional	LB Health Check ID Example : `46c681018e33453085ca7c8db54e0076`	string	None
query	lb_method optional	LB Method Example : `ROUND_ROBIN`	any of [array[enum (ROUND_ROBIN, LEAST_CONNECTION, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION)], enum (ROUND_ROBIN, LEAST_CONNECTION, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION), null]	None

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "lb_server_groups": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
            "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
            "lb_name": "Test-LB-01",
            "lb_server_group_member_count": 2,
            "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ServerGroup01",
            "protocol": "TCP",
            "state": "ACTIVE",
            "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.17.3 - 1.1

get /v1/lb-server-groups

Description

Get LB Server Group list

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

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	LB Server Group name Example : `ServerGroup01`	any of [string, null]	None
query	protocol optional	Protocol Example : `['TCP', 'UDP']`	any of [array[enum (TCP, UDP)], enum (TCP, UDP), null]	None
query	subnet_id optional	Service Subnet ID Example : `60fba45cb6c811efba41ba92e4fe7200`	any of [string, null]	None
query	vpc_id optional	VPC ID Example : `8acceeb6920c4fc494490d864f67f0b5`	any of [string, null]	None
query	lb_health_check_id optional	LB Health Check ID Example : `46c681018e33453085ca7c8db54e0076`	string	None
query	lb_method optional	LB Method Example : `ROUND_ROBIN`	any of [array[enum (ROUND_ROBIN, LEAST_CONNECTION, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION)], enum (ROUND_ROBIN, LEAST_CONNECTION, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION), null]	None

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "lb_server_groups": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
            "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
            "lb_name": "Test-LB-01",
            "lb_server_group_member_count": 2,
            "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ServerGroup01",
            "protocol": "TCP",
            "state": "ACTIVE",
            "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.18 - ListLoadbalancerCertificates

6.1.18.1 - 1.3

get /v1/loadbalancers/certificates

Description

get Load Balancer certificate list

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/certificates

Request header

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

Example HTTP response

Response 200

{
    "certificates": [
        {
            "cert_kind": "",
            "cn": "",
            "created_at": "",
            "created_by": "",
            "id": "",
            "modified_at": "",
            "modified_by": "",
            "name": "",
            "not_after_dt": "2026-04-14T15:03:17.946Z",
            "not_before_dt": "2026-04-14T15:03:17.946Z",
            "state": ""
        }
    ],
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

6.1.18.2 - 1.2

get /v1/loadbalancers/certificates

Description

get Load Balancer certificate list

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/certificates

Request header

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

Example HTTP response

Response 200

{
    "certificates": [
        {
            "cert_kind": "",
            "cn": "",
            "created_at": "",
            "created_by": "",
            "id": "",
            "modified_at": "",
            "modified_by": "",
            "name": "",
            "not_after_dt": "2026-04-14T15:03:17.406Z",
            "not_before_dt": "2026-04-14T15:03:17.406Z",
            "state": ""
        }
    ],
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

6.1.18.3 - 1.1

get /v1/loadbalancers/certificates

Description

get Load Balancer certificate list

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/certificates

Request header

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

Example HTTP response

Response 200

{
    "certificates": [
        {
            "cert_kind": "",
            "cn": "",
            "created_at": "",
            "created_by": "",
            "id": "",
            "modified_at": "",
            "modified_by": "",
            "name": "",
            "not_after_dt": "2026-04-14T15:03:16.865Z",
            "not_before_dt": "2026-04-14T15:03:16.865Z",
            "state": ""
        }
    ],
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

6.1.19 - ListLoadbalancers

6.1.19.1 - 1.3

get /v1/loadbalancers

Description

get Load Balancer list

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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	The name of the load balancer. Example :	any of [string, null]	None
query	state optional	The state of the load balancer. Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), array[enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)]]
query	service_ip optional	The service IP of the load balancer. Example :	any of [string, null]	None
query	subnet_id optional	Subnet ID Example :	any of [string, null]	None
query	layer_type optional	Layer type Example :	any of [enum (L4, L7), array[enum (L4, L7)]]
query	vpc_id optional	VPC ID Example :	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/loadbalancers

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "loadbalancers": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "firewall_id": "",
            "id": "",
            "layer_type": "",
            "listener_count": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "public_nat_enabled": "",
            "service_ip": "",
            "source_nat_ip": "",
            "state": "",
            "subnet_id": "",
            "vpc_id": ""
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.19.2 - 1.2

get /v1/loadbalancers

Description

get Load Balancer list

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

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	The name of the load balancer. Example :	any of [string, null]	None
query	state optional	The state of the load balancer. Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), array[enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)]]
query	service_ip optional	The service IP of the load balancer. Example :	any of [string, null]	None
query	subnet_id optional	Subnet ID Example :	any of [string, null]	None
query	layer_type optional	Layer type Example :	any of [enum (L4, L7), array[enum (L4, L7)]]
query	vpc_id optional	VPC ID Example :	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/loadbalancers

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "loadbalancers": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "firewall_id": "",
            "id": "",
            "layer_type": "",
            "listener_count": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "public_nat_enabled": "",
            "service_ip": "",
            "source_nat_ip": "",
            "state": "",
            "subnet_id": "",
            "vpc_id": ""
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.19.3 - 1.1

get /v1/loadbalancers

Description

get Load Balancer list

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

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	The name of the load balancer. Example :	any of [string, null]	None
query	state optional	The state of the load balancer. Example :	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), array[enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)]]
query	service_ip optional	The service IP of the load balancer. Example :	any of [string, null]	None
query	subnet_id optional	Subnet ID Example :	any of [string, null]	None
query	layer_type optional	Layer type Example :	any of [enum (L4, L7), array[enum (L4, L7)]]
query	vpc_id optional	VPC ID Example :	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/loadbalancers

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "loadbalancers": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "firewall_id": "",
            "id": "",
            "layer_type": "",
            "listener_count": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "",
            "public_nat_enabled": "",
            "service_ip": "",
            "source_nat_ip": "",
            "state": "",
            "subnet_id": "",
            "vpc_id": ""
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

6.1.20 - RemoveLbServerGroupMember

6.1.20.1 - 1.3

delete /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}

Description

Remove Lb Server Group Member

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	ID of Lb Server Group Example :	string	None
path	member_id required	ID of Member 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/lb-server-groups/{lb_server_group_id}/members/{member_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 = loadbalancer 1.3"

Example HTTP response

Response 202

6.1.20.2 - 1.2

delete /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}

Description

Remove Lb Server Group Member

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	ID of Lb Server Group Example :	string	None
path	member_id required	ID of Member 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/lb-server-groups/{lb_server_group_id}/members/{member_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 = loadbalancer 1.2"

Example HTTP response

Response 202

6.1.20.3 - 1.1

delete /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}

Description

Remove Lb Server Group Member

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	ID of Lb Server Group Example :	string	None
path	member_id required	ID of Member 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/lb-server-groups/{lb_server_group_id}/members/{member_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 = loadbalancer 1.1"

Example HTTP response

Response 202

6.1.21 - RemoveLbServerGroupMembers

6.1.21.1 - 1.3

delete /v1/lb-server-groups/{lb_server_group_id}/members

Description

Remove Lb Server Group Members

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	ID of Lb Server Group Example :	string	None
body	body required		MemberDeleteBulkRequestV1Dot2

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/lb-server-groups/{lb_server_group_id}/members

Request header

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

Request body

{
    "member_id_list": [
        ""
    ]
}

Example HTTP response

Response 202

6.1.21.2 - 1.2

delete /v1/lb-server-groups/{lb_server_group_id}/members

Description

Remove Lb Server Group Members

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	ID of Lb Server Group Example :	string	None
body	body required		MemberDeleteBulkRequestV1Dot2

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/lb-server-groups/{lb_server_group_id}/members

Request header

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

Request body

{
    "member_id_list": [
        ""
    ]
}

Example HTTP response

Response 202

6.1.22 - SetLBHealthCheck

6.1.22.1 - 1.3

put /v1/lb-health-checks/{lb_health_check_id}

Description

Set LB Health Check

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	lb_health_check_id required	LB Health Check ID Example : `e3cd678b11784734bc366148aa37580e`	string	None
body	body required		LbHealthCheckSetRequest

Responses

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

Example HTTP request

Request path

/v1/lb-health-checks/{lb_health_check_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 = loadbalancer 1.3"

Request body

{
    "lb_health_check": {
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_url": "/test",
        "http_method": "GET",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200"
    }
}

Example HTTP response

Response 202

{
    "lb_health_check": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_type": "DEFAULT",
        "health_check_url": "/test",
        "http_method": "GET",
        "id": "46c681018e33453085ca7c8db54e0076",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "Test-LbMonitor-01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.22.2 - 1.2

put /v1/lb-health-checks/{lb_health_check_id}

Description

Set LB Health Check

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Type	Name	Description	Schema	Default
path	lb_health_check_id required	LB Health Check ID Example : `e3cd678b11784734bc366148aa37580e`	string	None
body	body required		LbHealthCheckSetRequest

Responses

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

Example HTTP request

Request path

/v1/lb-health-checks/{lb_health_check_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 = loadbalancer 1.2"

Request body

{
    "lb_health_check": {
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_url": "/test",
        "http_method": "GET",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200"
    }
}

Example HTTP response

Response 202

{
    "lb_health_check": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_type": "DEFAULT",
        "health_check_url": "/test",
        "http_method": "GET",
        "id": "46c681018e33453085ca7c8db54e0076",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "Test-LbMonitor-01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.22.3 - 1.1

put /v1/lb-health-checks/{lb_health_check_id}

Description

Set LB Health Check

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Type	Name	Description	Schema	Default
path	lb_health_check_id required	LB Health Check ID Example : `e3cd678b11784734bc366148aa37580e`	string	None
body	body required		LbHealthCheckSetRequest

Responses

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

Example HTTP request

Request path

/v1/lb-health-checks/{lb_health_check_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 = loadbalancer 1.1"

Request body

{
    "lb_health_check": {
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_url": "/test",
        "http_method": "GET",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200"
    }
}

Example HTTP response

Response 202

{
    "lb_health_check": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_type": "DEFAULT",
        "health_check_url": "/test",
        "http_method": "GET",
        "id": "46c681018e33453085ca7c8db54e0076",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "Test-LbMonitor-01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.23 - SetLbListener

6.1.23.1 - 1.3

put /v1/lb-listeners/{listener_id}

Description

set loadbalancer listener

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	listener_id required	The ID of the listener. Example :	string	None
body	body required		LbListenerSetRequestV1Dot3

Responses

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

Example HTTP request

Request path

/v1/lb-listeners/{listener_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 = loadbalancer 1.3"

Request body

{
    "listener": {
        "condition_type": "URL_PATH",
        "description": "",
        "hsts_max_age": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "idle_timeout": "",
        "insert_client_ip": "",
        "persistence": "",
        "response_timeout": "",
        "server_group_id": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "not_after_dt": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "support_http2": "",
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

Example HTTP response

Response 200

{
    "listener": {
        "condition_type": "URL_PATH",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "hsts_max_age": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "idle_timeout": "",
        "insert_client_ip": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "persistence": "",
        "protocol": "TCP",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "server_group_name": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "not_after_dt": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "state": "",
        "support_http2": false,
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

6.1.23.2 - 1.2

put /v1/lb-listeners/{listener_id}

Description

set loadbalancer listener

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Type	Name	Description	Schema	Default
path	listener_id required	The ID of the listener. Example :	string	None
body	body required		LbListenerSetRequestV1Dot2

Responses

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

Example HTTP request

Request path

/v1/lb-listeners/{listener_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 = loadbalancer 1.2"

Request body

{
    "listener": {
        "condition_type": "URL_PATH",
        "description": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "insert_client_ip": "",
        "persistence": "",
        "response_timeout": "",
        "server_group_id": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "not_after_dt": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "support_http2": "",
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

Example HTTP response

Response 200

{
    "listener": {
        "condition_type": "URL_PATH",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "insert_client_ip": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "persistence": "",
        "protocol": "",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "server_group_name": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "not_after_dt": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "state": "",
        "support_http2": false,
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

6.1.23.3 - 1.1

put /v1/lb-listeners/{listener_id}

Description

set loadbalancer listener

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Type	Name	Description	Schema	Default
path	listener_id required	The ID of the listener. Example :	string	None
body	body required		LbListenerSetRequest

Responses

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

Example HTTP request

Request path

/v1/lb-listeners/{listener_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 = loadbalancer 1.1"

Request body

{
    "listener": {
        "condition_type": "URL_PATH",
        "description": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "insert_client_ip": "",
        "persistence": "",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "not_after_dt": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "support_http2": "",
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

Example HTTP response

Response 200

{
    "listener": {
        "condition_type": "URL_PATH",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "insert_client_ip": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "persistence": "",
        "protocol": "",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "server_group_name": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "not_after_dt": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "state": "",
        "support_http2": false,
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

6.1.24 - SetLBServerGroup

6.1.24.1 - 1.3

put /v1/lb-server-groups/{lb_server_group_id}

Description

Set LB Server Group

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	LB Server Group ID Example : `3d8d8754d0d54683a29f3dcc3dd95d5b`	string	None
body	body required		LbServerGroupSetRequest

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_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 = loadbalancer 1.3"

Request body

{
    "lb_server_group": {
        "description": "this is an lb server group",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN"
    }
}

Example HTTP response

Response 202

{
    "lb_server_group": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "lb_name": "Test-LB-01",
        "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.24.2 - 1.2

put /v1/lb-server-groups/{lb_server_group_id}

Description

Set LB Server Group

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	LB Server Group ID Example : `3d8d8754d0d54683a29f3dcc3dd95d5b`	string	None
body	body required		LbServerGroupSetRequest

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_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 = loadbalancer 1.2"

Request body

{
    "lb_server_group": {
        "description": "this is an lb server group",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN"
    }
}

Example HTTP response

Response 202

{
    "lb_server_group": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "lb_name": "Test-LB-01",
        "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.24.3 - 1.1

put /v1/lb-server-groups/{lb_server_group_id}

Description

Set LB Server Group

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	LB Server Group ID Example : `3d8d8754d0d54683a29f3dcc3dd95d5b`	string	None
body	body required		LbServerGroupSetRequest

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_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 = loadbalancer 1.1"

Request body

{
    "lb_server_group": {
        "description": "this is an lb server group",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN"
    }
}

Example HTTP response

Response 202

{
    "lb_server_group": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "lb_name": "Test-LB-01",
        "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.25 - SetLbServerGroupMember

6.1.25.1 - 1.3

put /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}

Description

Set Lb Server Group Member

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	ID of Lb Server Group Example :	string	None
path	member_id required	ID of Member Example :	string	None
body	body required		MemberSetRequest

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_id}/members/{member_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 = loadbalancer 1.3"

Request body

{
    "member": {
        "member_port": 80,
        "member_state": "ENABLE",
        "member_weight": 100
    }
}

Example HTTP response

Response 202

{
    "member": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "lb_server_group_id": "",
        "member_ip": "",
        "member_port": "",
        "member_state": "",
        "member_weight": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "object_id": "",
        "object_type": "VM",
        "state": "CREATING",
        "subnet_id": "",
        "uuid": ""
    }
}

6.1.25.2 - 1.2

put /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}

Description

Set Lb Server Group Member

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	ID of Lb Server Group Example :	string	None
path	member_id required	ID of Member Example :	string	None
body	body required		MemberSetRequest

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_id}/members/{member_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 = loadbalancer 1.2"

Request body

{
    "member": {
        "member_port": 80,
        "member_state": "ENABLE",
        "member_weight": 100
    }
}

Example HTTP response

Response 202

{
    "member": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "lb_server_group_id": "",
        "member_ip": "",
        "member_port": "",
        "member_state": "",
        "member_weight": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "object_id": "",
        "object_type": "VM",
        "state": "CREATING",
        "subnet_id": "",
        "uuid": ""
    }
}

6.1.25.3 - 1.1

put /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}

Description

Set Lb Server Group Member

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	ID of Lb Server Group Example :	string	None
path	member_id required	ID of Member Example :	string	None
body	body required		MemberSetRequest

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_id}/members/{member_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 = loadbalancer 1.1"

Request body

{
    "member": {
        "member_port": 80,
        "member_state": "ENABLE",
        "member_weight": 100
    }
}

Example HTTP response

Response 202

{
    "member": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "lb_server_group_id": "",
        "member_ip": "",
        "member_port": "",
        "member_state": "",
        "member_weight": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "object_id": "",
        "object_type": "VM",
        "state": "CREATING",
        "subnet_id": "",
        "uuid": ""
    }
}

6.1.26 - SetLoadbalancer

6.1.26.1 - 1.3

put /v1/loadbalancers/{loadbalancer_id}

Description

Set Load Balancer

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	ID Example :	string	None
body	body required		LoadbalancerUpdateRequest

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_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 = loadbalancer 1.3"

Request body

{
    "loadbalancer": {
        "description": ""
    }
}

Example HTTP response

Response 202

{
    "loadbalancer": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "health_check_ip": [
            ""
        ],
        "id": "",
        "layer_type": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "public_nat_enabled": "",
        "service_ip": "",
        "source_nat_ip": "",
        "state": "",
        "subnet_id": "",
        "vpc_id": ""
    }
}

6.1.26.2 - 1.2

put /v1/loadbalancers/{loadbalancer_id}

Description

Set Load Balancer

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	ID Example :	string	None
body	body required		LoadbalancerUpdateRequest

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_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 = loadbalancer 1.2"

Request body

{
    "loadbalancer": {
        "description": ""
    }
}

Example HTTP response

Response 202

{
    "loadbalancer": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "health_check_ip": [
            ""
        ],
        "id": "",
        "layer_type": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "public_nat_enabled": "",
        "service_ip": "",
        "source_nat_ip": "",
        "state": "",
        "subnet_id": "",
        "vpc_id": ""
    }
}

6.1.26.3 - 1.1

put /v1/loadbalancers/{loadbalancer_id}

Description

Set Load Balancer

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Type	Name	Description	Schema	Default
path	loadbalancer_id required	ID Example :	string	None
body	body required		LoadbalancerUpdateRequest

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_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 = loadbalancer 1.1"

Request body

{
    "loadbalancer": {
        "description": ""
    }
}

Example HTTP response

Response 202

{
    "loadbalancer": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "health_check_ip": [
            ""
        ],
        "id": "",
        "layer_type": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "public_nat_enabled": "",
        "service_ip": "",
        "source_nat_ip": "",
        "state": "",
        "subnet_id": "",
        "vpc_id": ""
    }
}

6.1.27 - ShowLBHealthCheck

6.1.27.1 - 1.3

get /v1/lb-health-checks/{lb_health_check_id}

Description

Get LB Health Check

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	lb_health_check_id required	LB Health Check ID Example : `e3cd678b11784734bc366148aa37580e`	string	None

Responses

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

Example HTTP request

Request path

/v1/lb-health-checks/{lb_health_check_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 = loadbalancer 1.3"

Example HTTP response

Response 200

{
    "lb_health_check": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_type": "DEFAULT",
        "health_check_url": "/test",
        "http_method": "GET",
        "id": "46c681018e33453085ca7c8db54e0076",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "Test-LbMonitor-01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.27.2 - 1.2

get /v1/lb-health-checks/{lb_health_check_id}

Description

Get LB Health Check

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Type	Name	Description	Schema	Default
path	lb_health_check_id required	LB Health Check ID Example : `e3cd678b11784734bc366148aa37580e`	string	None

Responses

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

Example HTTP request

Request path

/v1/lb-health-checks/{lb_health_check_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 = loadbalancer 1.2"

Example HTTP response

Response 200

{
    "lb_health_check": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_type": "DEFAULT",
        "health_check_url": "/test",
        "http_method": "GET",
        "id": "46c681018e33453085ca7c8db54e0076",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "Test-LbMonitor-01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.27.3 - 1.1

get /v1/lb-health-checks/{lb_health_check_id}

Description

Get LB Health Check

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Type	Name	Description	Schema	Default
path	lb_health_check_id required	LB Health Check ID Example : `e3cd678b11784734bc366148aa37580e`	string	None

Responses

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

Example HTTP request

Request path

/v1/lb-health-checks/{lb_health_check_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 = loadbalancer 1.1"

Example HTTP response

Response 200

{
    "lb_health_check": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "health_check_count": 3,
        "health_check_interval": 5,
        "health_check_port": 80,
        "health_check_timeout": 5,
        "health_check_type": "DEFAULT",
        "health_check_url": "/test",
        "http_method": "GET",
        "id": "46c681018e33453085ca7c8db54e0076",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "Test-LbMonitor-01",
        "protocol": "TCP",
        "request_data": "username=admin&password=1234",
        "response_code": "200",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.28 - ShowLbListener

6.1.28.1 - 1.3

get /v1/lb-listeners/{listener_id}

Description

show LB listener

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	listener_id required	The ID of the listener. Example :	string	None

Responses

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

Example HTTP request

Request path

/v1/lb-listeners/{listener_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 = loadbalancer 1.3"

Example HTTP response

Response 200

{
    "listener": {
        "condition_type": "URL_PATH",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "hsts_max_age": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "idle_timeout": "",
        "insert_client_ip": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "persistence": "",
        "protocol": "TCP",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "server_group_name": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "not_after_dt": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "state": "",
        "support_http2": false,
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

6.1.28.2 - 1.2

get /v1/lb-listeners/{listener_id}

Description

show LB listener

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Type	Name	Description	Schema	Default
path	listener_id required	The ID of the listener. Example :	string	None

Responses

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

Example HTTP request

Request path

/v1/lb-listeners/{listener_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 = loadbalancer 1.2"

Example HTTP response

Response 200

{
    "listener": {
        "condition_type": "URL_PATH",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "insert_client_ip": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "persistence": "",
        "protocol": "",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "server_group_name": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "not_after_dt": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "state": "",
        "support_http2": false,
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

6.1.28.3 - 1.1

get /v1/lb-listeners/{listener_id}

Description

show LB listener

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Type	Name	Description	Schema	Default
path	listener_id required	The ID of the listener. Example :	string	None

Responses

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

Example HTTP request

Request path

/v1/lb-listeners/{listener_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 = loadbalancer 1.1"

Example HTTP response

Response 200

{
    "listener": {
        "condition_type": "URL_PATH",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "https_redirection": {
            "port": "",
            "protocol": "",
            "response_code": ""
        },
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "insert_client_ip": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "persistence": "",
        "protocol": "",
        "response_timeout": "",
        "routing_action": "LB_SERVER_GROUP",
        "server_group_id": "",
        "server_group_name": "",
        "service_port": "",
        "session_duration_time": "",
        "sni_certificate": [
            {
                "domain_name": "",
                "not_after_dt": "",
                "sni_cert_id": ""
            }
        ],
        "ssl_certificate": {
            "client_cert_id": "",
            "client_cert_level": "",
            "server_cert_level": ""
        },
        "state": "",
        "support_http2": false,
        "url_handler": "",
        "url_redirection": "",
        "x_forwarded_for": "",
        "x_forwarded_port": "",
        "x_forwarded_proto": ""
    }
}

6.1.29 - ShowLBServerGroup

6.1.29.1 - 1.3

get /v1/lb-server-groups/{lb_server_group_id}

Description

Show LB Server Group

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	LB Server Group ID Example : `3d8d8754d0d54683a29f3dcc3dd95d5b`	string	None

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_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 = loadbalancer 1.3"

Example HTTP response

Response 200

{
    "lb_server_group": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "lb_name": "Test-LB-01",
        "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.29.2 - 1.2

get /v1/lb-server-groups/{lb_server_group_id}

Description

Show LB Server Group

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	LB Server Group ID Example : `3d8d8754d0d54683a29f3dcc3dd95d5b`	string	None

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_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 = loadbalancer 1.2"

Example HTTP response

Response 200

{
    "lb_server_group": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "lb_name": "Test-LB-01",
        "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.29.3 - 1.1

get /v1/lb-server-groups/{lb_server_group_id}

Description

Show LB Server Group

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	LB Server Group ID Example : `3d8d8754d0d54683a29f3dcc3dd95d5b`	string	None

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_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 = loadbalancer 1.1"

Example HTTP response

Response 200

{
    "lb_server_group": {
        "account_id": "e3cd678b11784734bc366148aa37580e",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "this is an lb server group",
        "id": "3d8d8754d0d54683a29f3dcc3dd95d5b",
        "lb_health_check_id": "46c681018e33453085ca7c8db54e0076",
        "lb_method": "ROUND_ROBIN",
        "lb_name": "Test-LB-01",
        "loadbalancer_id": "82efa35c88834bc083020443e57faa10",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServerGroup01",
        "protocol": "TCP",
        "state": "ACTIVE",
        "subnet_id": "60fba45cb6c811efba41ba92e4fe7200",
        "vpc_id": "8acceeb6920c4fc494490d864f67f0b5"
    }
}

6.1.30 - ShowLbServerGroupMember

6.1.30.1 - 1.3

get /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}

Description

Show Lb Server Group Member

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	ID of Lb Server Group Example :	string	None
path	member_id required	ID of Member Example :	string	None

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_id}/members/{member_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 = loadbalancer 1.3"

Example HTTP response

Response 200

{
    "member": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "lb_server_group_id": "",
        "member_ip": "",
        "member_port": "",
        "member_state": "",
        "member_weight": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "object_id": "",
        "object_type": "VM",
        "state": "CREATING",
        "subnet_id": "",
        "uuid": ""
    }
}

6.1.30.2 - 1.2

get /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}

Description

Show Lb Server Group Member

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	ID of Lb Server Group Example :	string	None
path	member_id required	ID of Member Example :	string	None

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_id}/members/{member_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 = loadbalancer 1.2"

Example HTTP response

Response 200

{
    "member": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "lb_server_group_id": "",
        "member_ip": "",
        "member_port": "",
        "member_state": "",
        "member_weight": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "object_id": "",
        "object_type": "VM",
        "state": "CREATING",
        "subnet_id": "",
        "uuid": ""
    }
}

6.1.30.3 - 1.1

get /v1/lb-server-groups/{lb_server_group_id}/members/{member_id}

Description

Show Lb Server Group Member

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Type	Name	Description	Schema	Default
path	lb_server_group_id required	ID of Lb Server Group Example :	string	None
path	member_id required	ID of Member Example :	string	None

Responses

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

Example HTTP request

Request path

/v1/lb-server-groups/{lb_server_group_id}/members/{member_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 = loadbalancer 1.1"

Example HTTP response

Response 200

{
    "member": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "lb_server_group_id": "",
        "member_ip": "",
        "member_port": "",
        "member_state": "",
        "member_weight": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "object_id": "",
        "object_type": "VM",
        "state": "CREATING",
        "subnet_id": "",
        "uuid": ""
    }
}

6.1.31 - ShowLoadbalancer

6.1.31.1 - 1.3

get /v1/loadbalancers/{loadbalancer_id}

Description

show Load Balancer

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_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 = loadbalancer 1.3"

Example HTTP response

Response 200

{
    "loadbalancer": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "health_check_ip": [
            ""
        ],
        "id": "",
        "layer_type": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "public_nat_enabled": "",
        "service_ip": "",
        "source_nat_ip": "",
        "state": "",
        "subnet_id": "",
        "vpc_id": ""
    }
}

6.1.31.2 - 1.2

get /v1/loadbalancers/{loadbalancer_id}

Description

show Load Balancer

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_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 = loadbalancer 1.2"

Example HTTP response

Response 200

{
    "loadbalancer": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "health_check_ip": [
            ""
        ],
        "id": "",
        "layer_type": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "public_nat_enabled": "",
        "service_ip": "",
        "source_nat_ip": "",
        "state": "",
        "subnet_id": "",
        "vpc_id": ""
    }
}

6.1.31.3 - 1.1

get /v1/loadbalancers/{loadbalancer_id}

Description

show Load Balancer

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_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 = loadbalancer 1.1"

Example HTTP response

Response 200

{
    "loadbalancer": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "firewall_id": "",
        "health_check_ip": [
            ""
        ],
        "id": "",
        "layer_type": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "public_nat_enabled": "",
        "service_ip": "",
        "source_nat_ip": "",
        "state": "",
        "subnet_id": "",
        "vpc_id": ""
    }
}

6.1.32 - ShowLoadbalancerCertificate

6.1.32.1 - 1.3

get /v1/loadbalancers/certificates/{lb_certificate_id}

Description

show Load Balancer certificate

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
path	lb_certificate_id required	The ID of the certificate Example :	string	None

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/certificates/{lb_certificate_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 = loadbalancer 1.3"

Example HTTP response

Response 200

{
    "certificate": {
        "account_id": "",
        "cert_body": "",
        "cert_chain": "",
        "cert_kind": "",
        "cn": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "not_after_dt": "2026-04-14T15:03:17.963Z",
        "not_before_dt": "2026-04-14T15:03:17.963Z",
        "organization": "",
        "private_key": "",
        "state": ""
    }
}

6.1.32.2 - 1.2

get /v1/loadbalancers/certificates/{lb_certificate_id}

Description

show Load Balancer certificate

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

Type	Name	Description	Schema	Default
path	lb_certificate_id required	The ID of the certificate Example :	string	None

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/certificates/{lb_certificate_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 = loadbalancer 1.2"

Example HTTP response

Response 200

{
    "certificate": {
        "account_id": "",
        "cert_body": "",
        "cert_chain": "",
        "cert_kind": "",
        "cn": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "not_after_dt": "2026-04-14T15:03:17.424Z",
        "not_before_dt": "2026-04-14T15:03:17.424Z",
        "organization": "",
        "private_key": "",
        "state": ""
    }
}

6.1.32.3 - 1.1

get /v1/loadbalancers/certificates/{lb_certificate_id}

Description

show Load Balancer certificate

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

Type	Name	Description	Schema	Default
path	lb_certificate_id required	The ID of the certificate Example :	string	None

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/certificates/{lb_certificate_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 = loadbalancer 1.1"

Example HTTP response

Response 200

{
    "certificate": {
        "account_id": "",
        "cert_body": "",
        "cert_chain": "",
        "cert_kind": "",
        "cn": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "not_after_dt": "2026-04-14T15:03:16.883Z",
        "not_before_dt": "2026-04-14T15:03:16.883Z",
        "organization": "",
        "private_key": "",
        "state": ""
    }
}

6.1.33 - ShowLoadbalancerPrivateNatIp

6.1.33.1 - 1.3

get /v1/loadbalancers/{loadbalancer_id}/private-static-nats

Description

Show Load Balancer Private NAT IP

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_id}/private-static-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 = loadbalancer 1.3"

Example HTTP response

Response 200

{
    "static_nat": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "external_ip_address": "",
        "id": "",
        "internal_ip_address": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "private_nat_ip_id": "",
        "state": ""
    }
}

6.1.34 - ShowLoadbalancerPublicNatIp

6.1.34.1 - 1.3

get /v1/loadbalancers/{loadbalancer_id}/static-nats

Description

Show Load Balancer Public NAT IP

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_id}/static-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 = loadbalancer 1.3"

Example HTTP response

Response 200

{
    "static_nat": {
        "external_ip_address": "",
        "publicip_id": "",
        "state": ""
    }
}

6.1.34.2 - 1.2

get /v1/loadbalancers/{loadbalancer_id}/static-nats

Description

Show Load Balancer Public NAT IP

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.2	20260319

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_id}/static-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 = loadbalancer 1.2"

Example HTTP response

Response 200

{
    "static_nat": {
        "external_ip_address": "",
        "publicip_id": "",
        "state": ""
    }
}

6.1.34.3 - 1.1

get /v1/loadbalancers/{loadbalancer_id}/static-nats

Description

Show Load Balancer Public NAT IP

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260319

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/loadbalancers/{loadbalancer_id}/static-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 = loadbalancer 1.1"

Example HTTP response

Response 200

{
    "static_nat": {
        "external_ip_address": "",
        "publicip_id": "",
        "state": ""
    }
}

6.2 - Models

6.2.1 - HttpsRedirection

Name	Description	Schema
port optional	port Example :	any of [string, null]
protocol optional	protocol Example :	any of [string, null]
response_code optional	response_code Example :	any of [string, null]

6.2.2 - LbCertificateForShow

Name	Description	Schema
account_id required	The project ID of the certificate Example :	string
cert_body required	The body of the certificate Example :	string
cert_chain optional	The chain of the certificate Example :	any of [string, null]
cert_kind optional	Example :	string
cn optional	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
name optional	Example :	string
not_after_dt optional	Example :	string (date-time)
not_before_dt optional	Example :	string (date-time)
organization required	The organization of the certificate Example :	string
private_key required	The private key of the certificate Example :	string
state optional	Example :	string

6.2.3 - LbCertificateListResponse

Name	Description	Schema
certificates required		array[LbCertificateListResponseDetail]
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]

6.2.4 - LbCertificateListResponseDetail

Name	Description	Schema
cert_kind required	Kind of certificate Example :	string
cn required	Common Name of certificate Example :	string
created_at optional	Created At Example :	any of [string (date-time), null]
created_by optional	Created By Example :	any of [string, null]
id required	ID of the certificate Example :	string
modified_at optional	Modified At Example :	any of [string (date-time), null]
modified_by optional	Modified By Example :	any of [string, null]
name required	Name of the certificate Example :	string
not_after_dt required	Expiration date and time of the certificate Example :	string (date-time)
not_before_dt required	Start date and time when the certificate becomes valid Example :	string (date-time)
state required	State of the certificate Example :	string

6.2.5 - LbCertificateShowResponse

Name	Description	Schema	Default
certificate required		LbCertificateForShow

6.2.6 - LbHealthCheckCreate

Name	Description	Schema	Default
description optional	Description Example : `this is an lb server group`	any of [string, null]
health_check_count optional	LB Health Check count Example : `3` Minimum : `1` Maximum : `10`	integer	3
health_check_interval optional	LB Health Check interval Example : `5` Minimum : `1` Maximum : `180`	integer	5
health_check_port optional	LB Health Check port Example : `80`	any of [integer, null]
health_check_timeout optional	LB Health Check timeout Example : `5` Minimum : `1` Maximum : `180`	integer	5
health_check_url optional	LB Health Check URL Example : `/test` Pattern : `^\/[A-Za-z0-9/._?&=-]*$`	any of [string, null]
http_method optional	LB Health Check HTTP Method Example : `GET`	any of [enum (GET, POST), null]
name required	LB Health Check name Example : `ServerGroup01` Pattern : `^[a-zA-Z0-9][-a-zA-Z0-9_][a-zA-Z0-9]$` Minimum length* : `3` Maximum length : `63`	string
protocol required	LB Health Check Protocol Example : `TCP`	enum (TCP, HTTP, HTTPS)
request_data optional	LB Health Check Request data Example : `username=admin&password=1234` Pattern : `^[a-zA-Z0-9_\W]*$`	any of [string, null]
response_code optional	LB Health Check Response code Example : `200`	any of [string, null]
subnet_id required	Service Subnet ID Example : `60fba45cb6c811efba41ba92e4fe7200`	string
tags optional	Tag List	array[Tag]
vpc_id required	VPC ID Example : `8acceeb6920c4fc494490d864f67f0b5`	string

6.2.7 - LbHealthCheckCreateRequest

Name	Description	Schema	Default
lb_health_check required		LbHealthCheckCreate

6.2.8 - LbHealthCheckList

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
health_check_type required	LB Health Check type Example : `DEFAULT`	enum (DEFAULT, CUSTOM)
id required	LB Health Check ID Example : `46c681018e33453085ca7c8db54e0076`	string
lb_server_group_count required	LB Server Group count Example : `2`	integer
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	LB Health Check name Example : `Test-LbMonitor-01`	string
protocol required	LB Health Check Protocol Example : `TCP`	enum (TCP, HTTP, HTTPS)
state required	LB Health Check state Example : `ACTIVE`	string
subnet_id required	Service Subnet ID Example : `60fba45cb6c811efba41ba92e4fe7200`	string

6.2.9 - LbHealthCheckListResponse

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

6.2.10 - LbHealthCheckSet

Name	Description	Schema
description optional	Description Example : `this is an lb server group`	any of [string, null]
health_check_count optional	LB Health Check count Example : `3`	any of [integer, null]
health_check_interval optional	LB Health Check interval Example : `5`	any of [integer, null]
health_check_port optional	LB Health Check port Example : `80`	any of [integer, null]
health_check_timeout optional	LB Health Check timeout Example : `5`	any of [integer, null]
health_check_url optional	LB Health Check URL Example : `/test` Pattern : `^\/[A-Za-z0-9/._?&=-]*$`	any of [string, null]
http_method optional	LB Health Check HTTP Method Example : `GET`	any of [enum (GET, POST), null]
protocol optional	LB Health Check Protocol Example : `TCP`	any of [enum (TCP, HTTP, HTTPS), null]
request_data optional	LB Health Check Request data Example : `username=admin&password=1234` Pattern : `^[a-zA-Z0-9_\W]*$`	any of [string, null]
response_code optional	LB Health Check Response code Example : `200`	any of [string, null]

6.2.11 - LbHealthCheckSetRequest

Name	Description	Schema	Default
lb_health_check required		LbHealthCheckSet

6.2.12 - LbHealthCheckShow

Name	Description	Schema	Default
account_id required	Account ID Example : `e3cd678b11784734bc366148aa37580e`	any of [string, 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	Description Example : `this is an lb server group`	any of [string, null]
health_check_count optional	LB Health Check count Example : `3`	integer	3
health_check_interval optional	LB Health Check interval Example : `5`	integer	5
health_check_port required	LB Health Check port Example : `80`	any of [integer, null]
health_check_timeout optional	LB Health Check timeout Example : `5`	integer	5
health_check_type required	LB Health Check type Example : `DEFAULT`	enum (DEFAULT, CUSTOM)
health_check_url required	LB Health Check URL Example : `/test`	any of [string, null]
http_method required	LB Health Check HTTP Method Example : `GET`	any of [string, null]
id required	LB Health Check ID Example : `46c681018e33453085ca7c8db54e0076`	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	LB Health Check name Example : `Test-LbMonitor-01`	string
protocol optional	LB Health Check Protocol Example : `TCP`	enum (TCP, HTTP, HTTPS)	TCP
request_data required	LB Health Check Request data Example : `username=admin&password=1234`	any of [string, null]
response_code required	LB Health Check Response code Example : `200`	any of [string, null]
state required	LB Health Check state Example : `ACTIVE`	string
subnet_id required	Service Subnet ID Example : `60fba45cb6c811efba41ba92e4fe7200`	any of [string, null]
vpc_id required	VPC ID Example : `8acceeb6920c4fc494490d864f67f0b5`	any of [string, null]

6.2.13 - LbHealthCheckShowResponse

Name	Description	Schema	Default
lb_health_check required		LbHealthCheckShow

6.2.14 - LbListenerCreateRequest

Name	Description	Schema	Default
listener required		ListenerForCreate

6.2.15 - LbListenerCreateRequestV1Dot2

Name	Description	Schema	Default
listener required		ListenerForCreateV1Dot2

6.2.16 - LbListenerCreateRequestV1Dot3

Name	Description	Schema	Default
listener required		ListenerForCreateV1Dot3

6.2.17 - LbListenerListResponse

Name	Description	Schema
count required	count Example : `20`	integer
listeners required	The list of the listener.	array[ListenerForList]
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

6.2.18 - LbListenerSetRequest

Name	Description	Schema	Default
listener required		ListenerForSet

6.2.19 - LbListenerSetRequestV1Dot2

Name	Description	Schema	Default
listener required		ListenerForSetV1Dot2

6.2.20 - LbListenerSetRequestV1Dot3

Name	Description	Schema	Default
listener required		ListenerForSetV1Dot3

6.2.21 - LbListenerShowResponse

Name	Description	Schema	Default
listener required		ListenerForShow

6.2.22 - LbListenerShowResponseV1Dot3

Name	Description	Schema	Default
listener required		ListenerForShowV1Dot3

6.2.23 - LbListenerSslCertificate

Name	Description	Schema
client_cert_id optional	Certificate id for client ssl Example :	any of [string, null]
client_cert_level optional	Certificate level for client ssl Example :	any of [string, null]
server_cert_level optional	Certificate level for server ssl Example :	any of [string, null]

6.2.24 - LbServerGroup

Name	Description	Schema
account_id required	Account ID Example : `e3cd678b11784734bc366148aa37580e`	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 : `this is an lb server group`	any of [string, null]
id required	LB Server Group ID Example : `3d8d8754d0d54683a29f3dcc3dd95d5b`	string
lb_health_check_id required	LB Health Check ID Example : `46c681018e33453085ca7c8db54e0076`	any of [string, null]
lb_method required	LB Method Example : `ROUND_ROBIN`	enum (ROUND_ROBIN, LEAST_CONNECTION, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION)
lb_name optional	Load Balancer name Example : `Test-LB-01`	any of [string, null]
loadbalancer_id optional	Load Balancer ID Example : `82efa35c88834bc083020443e57faa10`	any of [string, null]
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	LB Server Group name Example : `ServerGroup01`	string
protocol required	Protocol Example : `TCP`	enum (TCP, UDP)
state required	LB Server Group state Example : `ACTIVE`	string
subnet_id required	Service Subnet ID Example : `60fba45cb6c811efba41ba92e4fe7200`	string
vpc_id required	VPC ID Example : `8acceeb6920c4fc494490d864f67f0b5`	string

6.2.25 - LbServerGroupCreate

Name	Description	Schema
description optional	Description Example : `this is an lb server group`	any of [string, null]
lb_health_check_id optional	LB Health Check ID Example : `46c681018e33453085ca7c8db54e0076`	any of [string, null]
lb_method required	LB Method Example : `ROUND_ROBIN`	enum (ROUND_ROBIN, LEAST_CONNECTION, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION)
name required	LB Health Check name Example : `ServerGroup01` Pattern : `^[a-zA-Z0-9][-a-zA-Z0-9_][a-zA-Z0-9]$` Minimum length* : `3` Maximum length : `63`	string
protocol required	Protocol Example : `TCP`	enum (TCP, UDP)
subnet_id required	Service Subnet ID Example : `60fba45cb6c811efba41ba92e4fe7200`	string
tags optional	Tag List	array[Tag]
vpc_id required	VPC ID Example : `8acceeb6920c4fc494490d864f67f0b5`	string

6.2.26 - LbServerGroupCreateRequest

Name	Description	Schema	Default
lb_server_group required		LbServerGroupCreate

6.2.27 - LbServerGroupList

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	LB Server Group ID Example : `3d8d8754d0d54683a29f3dcc3dd95d5b`	string
lb_health_check_id required	LB Health Check ID Example : `46c681018e33453085ca7c8db54e0076`	any of [string, null]
lb_name optional	Load Balancer name Example : `Test-LB-01`	any of [string, null]
lb_server_group_member_count required	LB Server Group Member count Example : `2`	integer
loadbalancer_id optional	Load Balancer ID Example : `82efa35c88834bc083020443e57faa10`	any of [string, null]
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	LB Server Group name Example : `ServerGroup01`	string
protocol required	Protocol Example : `TCP`	enum (TCP, UDP)
state required	LB Server Group state Example : `ACTIVE`	string
vpc_id required	VPC ID Example : `8acceeb6920c4fc494490d864f67f0b5`	string

6.2.28 - LbServerGroupListResponse

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

6.2.29 - LbServerGroupSet

Name	Description	Schema
description optional	Description Example : `this is an lb server group`	any of [string, null]
lb_health_check_id optional	LB Health Check ID Example : `46c681018e33453085ca7c8db54e0076`	any of [string, null]
lb_method optional	LB Method Example : `ROUND_ROBIN`	any of [enum (ROUND_ROBIN, LEAST_CONNECTION, IP_HASH, WEIGHTED_ROUND_ROBIN, WEIGHTED_LEAST_CONNECTION), null]

6.2.30 - LbServerGroupSetRequest

Name	Description	Schema	Default
lb_server_group required		LbServerGroupSet

6.2.31 - LbServerGroupShowResponse

Name	Description	Schema	Default
lb_server_group required		LbServerGroup

6.2.32 - ListenerForCreate

Name	Description	Schema
condition_type optional	The condition type of the listener. Example : `URL_PATH`	any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null]
description optional	description Example :	any of [string, null]
https_redirection optional	The https redirection of the listener.	any of [HttpsRedirection, null]
insert_client_ip optional	Whether the client IP should be inserted. Example :	any of [boolean, null]
loadbalancer_id required	The ID of the load balancer. Example :	string
name required	The name of the listener. Example : Pattern : `^[a-zA-Z0-9-_]$` Minimum length* : `3` Maximum length : `63`	string
persistence optional	The persistence of the listener. Example :	any of [string, null]
protocol required	The protocol of the listener. Example :	string
response_timeout optional	The response timeout of the listener. Example :	any of [integer, null]
routing_action optional	The routing action of the listener. Example : `LB_SERVER_GROUP`	any of [enum (LB_SERVER_GROUP, URL_REDIRECT), null]
server_group_id optional	The ID of the server group. Example :	any of [string, null]
service_port required	The port of the listener. Example : Minimum : `1` Maximum : `65534`	integer
session_duration_time optional	The session duration time. Example :	any of [integer, null]
sni_certificate optional	The sni certificate of the listener.	any of [array[SniCertificate], null]
ssl_certificate optional	The ssl certificate of the listener.	any of [SslCertificate, null]
support_http2 optional	Whether the HTTP 2.0 is supported Example : `False`	any of [boolean, null]
tags optional	Tag List	array[Tag]
url_handler optional	The URL handler of the listener. Example :	any of [array[object], null]
url_redirection optional	The URL redirect of the listener. Example :	any of [string, null]
x_forwarded_for optional	Whether the X-Forwarded-For should be inserted. Example :	any of [boolean, null]
x_forwarded_port optional	Whether the X-Forwarded-Port should be inserted. Example :	any of [boolean, null]
x_forwarded_proto optional	Whether the X-Forwarded-Protocol should be inserted. Example :	any of [boolean, null]

6.2.33 - ListenerForCreateV1Dot2

Name	Description	Schema
condition_type optional	The condition type of the listener. Example : `URL_PATH`	any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null]
description optional	description Example :	any of [string, null]
https_redirection optional	The https redirection of the listener.	any of [HttpsRedirection, null]
insert_client_ip optional	Whether the client IP should be inserted. Example :	any of [boolean, null]
loadbalancer_id required	The ID of the load balancer. Example :	string
name required	The name of the listener. Example : Pattern : `^[a-zA-Z0-9-_]$` Minimum length* : `3` Maximum length : `63`	string
persistence optional	The persistence of the listener. Example :	any of [string, null]
protocol required	The protocol of the listener. Example :	string
response_timeout optional	The response timeout of the listener. Example :	any of [integer, null]
routing_action required	The routing action of the listener. Example : `LB_SERVER_GROUP`	enum (LB_SERVER_GROUP, URL_REDIRECT)
server_group_id optional	The ID of the server group. Example :	any of [string, null]
service_port required	The port of the listener. Example : Minimum : `1` Maximum : `65534`	integer
session_duration_time optional	The session duration time. Example :	any of [integer, null]
sni_certificate optional	The sni certificate of the listener.	any of [array[SniCertificate], null]
ssl_certificate optional	The ssl certificate of the listener.	any of [SslCertificate, null]
support_http2 optional	Whether the HTTP 2.0 is supported Example : `False`	any of [boolean, null]
tags optional	Tag List	array[Tag]
url_handler optional	The URL handler of the listener. Example :	any of [array[object], null]
url_redirection optional	The URL redirect of the listener. Example :	any of [string, null]
x_forwarded_for optional	Whether the X-Forwarded-For should be inserted. Example :	any of [boolean, null]
x_forwarded_port optional	Whether the X-Forwarded-Port should be inserted. Example :	any of [boolean, null]
x_forwarded_proto optional	Whether the X-Forwarded-Protocol should be inserted. Example :	any of [boolean, null]

6.2.34 - ListenerForCreateV1Dot3

Name	Description	Schema
condition_type optional	The condition type of the listener. Example : `URL_PATH`	any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null]
description optional	description Example :	any of [string, null]
hsts_max_age optional	The hsts_max_age of the listener. Example :	any of [integer, null]
https_redirection optional	The https redirection of the listener.	any of [HttpsRedirection, null]
idle_timeout optional	The idle timeout(L7) of the listener. Example :	any of [integer, null]
insert_client_ip optional	Whether the client IP should be inserted. Example :	any of [boolean, null]
loadbalancer_id required	The ID of the load balancer. Example :	string
name required	The name of the listener. Example : Pattern : `^[a-zA-Z0-9-_]$` Minimum length* : `3` Maximum length : `63`	string
persistence optional	The persistence of the listener. Example :	any of [string, null]
protocol required	The protocol of the listener. Example : `TCP`	enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY)
response_timeout optional	The response timeout of the listener. Example :	any of [integer, null]
routing_action required	The routing action of the listener. Example : `LB_SERVER_GROUP`	enum (LB_SERVER_GROUP, URL_REDIRECT)
server_group_id optional	The ID of the server group. Example :	any of [string, null]
service_port required	The port of the listener. Example : Minimum : `1` Maximum : `65534`	integer
session_duration_time optional	The session duration time. Example :	any of [integer, null]
sni_certificate optional	The sni certificate of the listener.	any of [array[SniCertificate], null]
ssl_certificate optional	The ssl certificate of the listener.	any of [SslCertificate, null]
support_http2 optional	Whether the HTTP 2.0 is supported Example : `False`	any of [boolean, null]
tags optional	Tag List	array[Tag]
url_handler optional	The URL handler of the listener. Example :	any of [array[object], null]
url_redirection optional	The URL redirect of the listener. Example :	any of [string, null]
x_forwarded_for optional	Whether the X-Forwarded-For should be inserted. Example :	any of [boolean, null]
x_forwarded_port optional	Whether the X-Forwarded-Port should be inserted. Example :	any of [boolean, null]
x_forwarded_proto optional	Whether the X-Forwarded-Protocol should be inserted. Example :	any of [boolean, null]

6.2.35 - ListenerForList

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	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	The name of the listener. Example : Pattern : `^[a-zA-Z0-9-_]$` Minimum length* : `3` Maximum length : `63`	string
protocol required	The protocol of the listener. Example : `TCP`	enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY)
service_port required	The port of the listener. Example : Minimum : `1` Maximum : `65534`	integer
state optional	The State of the listener. Example :	any of [string, null]

6.2.36 - ListenerForSet

Name	Description	Schema
condition_type optional	The condition type of the listener. Example : `URL_PATH`	any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null]
description optional	description Example :	any of [string, null]
https_redirection optional	The https redirection of the listener.	any of [HttpsRedirection, null]
insert_client_ip optional	Whether the client IP should be inserted. Example :	any of [boolean, null]
persistence optional	The persistence of the listener. Example :	any of [string, null]
response_timeout optional	The response timeout of the listener. Example :	any of [integer, null]
routing_action optional	The routing action of the listener. Example : `LB_SERVER_GROUP`	any of [enum (LB_SERVER_GROUP, URL_REDIRECT), null]
server_group_id optional	The ID of the server group. Example :	any of [string, null]
session_duration_time optional	The session duration time. Example :	any of [integer, null]
sni_certificate optional	The sni certificate of the listener.	any of [array[SniCertificate], null]
ssl_certificate optional	The ssl certificate of the listener.	any of [LbListenerSslCertificate, null]
support_http2 optional	Whether the HTTP 2.0 is supported Example :	boolean
url_handler optional	The URL handler of the listener. Example :	any of [array[object], null]
url_redirection optional	The URL redirect of the listener. Example :	any of [string, null]
x_forwarded_for optional	Whether the X-Forwarded-For should be inserted. Example :	any of [boolean, null]
x_forwarded_port optional	Whether the X-Forwarded-Port should be inserted. Example :	any of [boolean, null]
x_forwarded_proto optional	Whether the X-Forwarded-Protocol should be inserted. Example :	any of [boolean, null]

6.2.37 - ListenerForSetV1Dot2

Name	Description	Schema
condition_type optional	The condition type of the listener. Example : `URL_PATH`	any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null]
description optional	description Example :	any of [string, null]
https_redirection optional	The https redirection of the listener.	any of [HttpsRedirection, null]
insert_client_ip optional	Whether the client IP should be inserted. Example :	any of [boolean, null]
persistence optional	The persistence of the listener. Example :	any of [string, null]
response_timeout optional	The response timeout of the listener. Example :	any of [integer, null]
server_group_id optional	The ID of the server group. Example :	any of [string, null]
session_duration_time optional	The session duration time. Example :	any of [integer, null]
sni_certificate optional	The sni certificate of the listener.	any of [array[SniCertificate], null]
ssl_certificate optional	The ssl certificate of the listener.	any of [LbListenerSslCertificate, null]
support_http2 optional	Whether the HTTP 2.0 is supported Example :	boolean
url_handler optional	The URL handler of the listener. Example :	any of [array[object], null]
url_redirection optional	The URL redirect of the listener. Example :	any of [string, null]
x_forwarded_for optional	Whether the X-Forwarded-For should be inserted. Example :	any of [boolean, null]
x_forwarded_port optional	Whether the X-Forwarded-Port should be inserted. Example :	any of [boolean, null]
x_forwarded_proto optional	Whether the X-Forwarded-Protocol should be inserted. Example :	any of [boolean, null]

6.2.38 - ListenerForSetV1Dot3

Name	Description	Schema
condition_type optional	The condition type of the listener. Example : `URL_PATH`	any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), null]
description optional	description Example :	any of [string, null]
hsts_max_age optional	The hsts_max_age of the listener. Example :	any of [integer, null]
https_redirection optional	The https redirection of the listener.	any of [HttpsRedirection, null]
idle_timeout optional	The idle timeout(L7) of the listener. Example :	any of [integer, null]
insert_client_ip optional	Whether the client IP should be inserted. Example :	any of [boolean, null]
persistence optional	The persistence of the listener. Example :	any of [string, null]
response_timeout optional	The response timeout of the listener. Example :	any of [integer, null]
server_group_id optional	The ID of the server group. Example :	any of [string, null]
session_duration_time optional	The session duration time. Example :	any of [integer, null]
sni_certificate optional	The sni certificate of the listener.	any of [array[SniCertificate], null]
ssl_certificate optional	The ssl certificate of the listener.	any of [LbListenerSslCertificate, null]
support_http2 optional	Whether the HTTP 2.0 is supported Example :	boolean
url_handler optional	The URL handler of the listener. Example :	any of [array[object], null]
url_redirection optional	The URL redirect of the listener. Example :	any of [string, null]
x_forwarded_for optional	Whether the X-Forwarded-For should be inserted. Example :	any of [boolean, null]
x_forwarded_port optional	Whether the X-Forwarded-Port should be inserted. Example :	any of [boolean, null]
x_forwarded_proto optional	Whether the X-Forwarded-Protocol should be inserted. Example :	any of [boolean, null]

6.2.39 - ListenerForShow

Name	Description	Schema
condition_type optional	The condition type of the listener. Example : `URL_PATH`	any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), 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	description Example :	any of [string, null]
https_redirection optional	The https redirection of the listener.	any of [HttpsRedirection, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
insert_client_ip optional	Whether the client IP should be inserted. Example :	any of [boolean, null]
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	The name of the listener. Example : Pattern : `^[a-zA-Z0-9-_]$` Minimum length* : `3` Maximum length : `63`	string
persistence optional	The persistence of the listener. Example :	any of [string, null]
protocol required	The protocol of the listener. Example :	string
response_timeout optional	The response timeout of the listener. Example :	any of [integer, null]
routing_action optional	The routing action of the listener. Example : `LB_SERVER_GROUP`	any of [enum (LB_SERVER_GROUP, URL_REDIRECT), null]
server_group_id optional	The ID of the server group. Example :	any of [string, null]
server_group_name optional	The Name of the server group. Example :	any of [string, null]
service_port required	The port of the listener. Example : Minimum : `1` Maximum : `65534`	integer
session_duration_time optional	The session duration time. Example :	any of [integer, null]
sni_certificate optional	The sni certificate of the listener.	any of [array[SniCertificate], null]
ssl_certificate optional	The ssl certificate of the listener.	any of [SslCertificate, null]
state required	The State of the listener. Example :	string
support_http2 optional	Whether the HTTP 2.0 is supported Example : `False`	any of [boolean, null]
url_handler optional	The URL handler of the listener. Example :	any of [array[object], null]
url_redirection optional	The URL redirect of the listener. Example :	any of [string, null]
x_forwarded_for optional	Whether the X-Forwarded-For should be inserted. Example :	any of [boolean, null]
x_forwarded_port optional	Whether the X-Forwarded-Port should be inserted. Example :	any of [boolean, null]
x_forwarded_proto optional	Whether the X-Forwarded-Protocol should be inserted. Example :	any of [boolean, null]

6.2.40 - ListenerForShowV1Dot3

Name	Description	Schema
condition_type optional	The condition type of the listener. Example : `URL_PATH`	any of [enum (URL_PATH, HOST_HEADER, PROTOCOL_PORT), 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	description Example :	any of [string, null]
hsts_max_age optional	The hsts_max_age of the listener. Example :	any of [integer, null]
https_redirection optional	The https redirection of the listener.	any of [HttpsRedirection, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
idle_timeout optional	The idle timeout(L7) of the listener. Example :	any of [integer, null]
insert_client_ip optional	Whether the client IP should be inserted. Example :	any of [boolean, null]
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	The name of the listener. Example : Pattern : `^[a-zA-Z0-9-_]$` Minimum length* : `3` Maximum length : `63`	string
persistence optional	The persistence of the listener. Example :	any of [string, null]
protocol required	The protocol of the listener. Example : `TCP`	enum (TCP, UDP, HTTP, HTTPS, TLS, TCP_PROXY)
response_timeout optional	The response timeout of the listener. Example :	any of [integer, null]
routing_action required	The routing action of the listener. Example : `LB_SERVER_GROUP`	enum (LB_SERVER_GROUP, URL_REDIRECT)
server_group_id optional	The ID of the server group. Example :	any of [string, null]
server_group_name optional	The Name of the server group. Example :	any of [string, null]
service_port required	The port of the listener. Example : Minimum : `1` Maximum : `65534`	integer
session_duration_time optional	The session duration time. Example :	any of [integer, null]
sni_certificate optional	The sni certificate of the listener.	any of [array[SniCertificate], null]
ssl_certificate optional	The ssl certificate of the listener.	any of [SslCertificate, null]
state required	The State of the listener. Example :	string
support_http2 optional	Whether the HTTP 2.0 is supported Example : `False`	any of [boolean, null]
url_handler optional	The URL handler of the listener. Example :	any of [array[object], null]
url_redirection optional	The URL redirect of the listener. Example :	any of [string, null]
x_forwarded_for optional	Whether the X-Forwarded-For should be inserted. Example :	any of [boolean, null]
x_forwarded_port optional	Whether the X-Forwarded-Port should be inserted. Example :	any of [boolean, null]
x_forwarded_proto optional	Whether the X-Forwarded-Protocol should be inserted. Example :	any of [boolean, null]

6.2.41 - Loadbalancer

Name	Description	Schema
account_id required	The account ID of the load balancer. 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]
health_check_ip required	Health check IP	array[string]
id required	ID Example :	string
layer_type required	Layer type 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	name Example :	string
public_nat_enabled optional	Public NAT Enabled Status Example :	any of [boolean, null]
service_ip optional	The service IP of the load balancer. Example :	any of [string, null]
source_nat_ip optional	Source NAT IP Example :	any of [string, null]
state required	The state of the load balancer. Example :	string
subnet_id required	Subnet ID Example :	string
vpc_id required	VPC ID Example :	string

6.2.42 - LoadbalancerCreateRequest

Name	Description	Schema	Default
loadbalancer required		LoadbalancerCreateRequestDetail

6.2.43 - LoadbalancerCreateRequestDetail

Name	Description	Schema	Default
description optional	description Example :	any of [string, null]
firewall_enabled optional	Firewall enabled Example : `True`	any of [boolean, null]	True
firewall_logging_enabled optional	Firewall logging enabled Example : `True`	any of [boolean, null]	True
health_check_ip_1 optional	Health check IP Example :	any of [string, null]
health_check_ip_2 optional	Health check IP Example :	any of [string, null]
layer_type required	Layer type Example :	string
name required	name Example : Pattern : `^[a-zA-Z0-9-_]$` Minimum length* : `3` Maximum length : `63`	string
publicip_id optional	Public IP ID Example :	any of [string, null]
service_ip optional	The service IP of the load balancer. Example :	any of [string, null]
source_nat_ip optional	Source NAT IP Example :	any of [string, null]
subnet_id required	Subnet ID Example :	string
tags optional	Tag List	array[Tag]
vpc_id required	VPC ID Example :	string

6.2.44 - LoadbalancerCreateResponse

Name	Description	Schema	Default
loadbalancer required		LoadbalancerCreateResponseDetail

6.2.45 - LoadbalancerCreateResponseDetail

Name	Description	Schema
account_id required	The account ID of the load balancer. 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]
id required	ID Example :	string
layer_type required	Layer type 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	name Example :	string
state required	The state of the load balancer. Example :	string
subnet_id required	Subnet ID Example :	string
vpc_id required	VPC ID Example :	string

6.2.46 - LoadbalancerListResponse

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

6.2.47 - LoadbalancerListResponseDetail

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
firewall_id optional	Firewall ID Example :	any of [string, null]
id required	ID Example :	string
layer_type optional	Layer type Example :	any of [string, null]
listener_count optional	The number of listeners. Example :	any of [integer, null]
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name optional	The name of the load balancer. Example :	any of [string, null]
public_nat_enabled optional	Public NAT Enabled Status Example :	any of [boolean, null]
service_ip optional	The service IP of the load balancer. Example :	any of [string, null]
source_nat_ip optional	Source NAT IP Example :	any of [string, null]
state optional	The state of the load balancer. Example :	any of [string, null]
subnet_id optional	Subnet ID Example :	any of [string, null]
vpc_id optional	VPC ID Example :	any of [string, null]

6.2.48 - LoadbalancerShowResponse

Name	Description	Schema	Default
loadbalancer required		Loadbalancer

6.2.49 - LoadbalancerStaticNatResponse

Name	Description	Schema	Default
static_nat required		StaticNat

6.2.50 - LoadbalancerUpdateRequest

Name	Description	Schema	Default
loadbalancer required		LoadbalancerUpdateRequestDetail

6.2.51 - LoadbalancerUpdateRequestDetail

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

6.2.52 - Member

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	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
lb_server_group_id required	ID of Lb Server Group Example :	string
member_ip required	IP of Member Example :	string
member_port required	Protocol port of Member Example :	integer
member_state required	Member State of Member Example :	string
member_weight required	Weight of Member Example :	integer
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Name of Member Example :	string
object_id optional	Object ID of Member Example :	any of [string, null]
object_type required	Object Type of Member Example : `VM`	enum (VM, BM, MANUAL, MNGC)
state required	State of Member Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
subnet_id required	ID of Subnet Example :	string
uuid required	UUID of Member Example :	string

6.2.53 - MemberCreateRequestV1Dot1

Name	Description	Schema
member_ip required	IP of Member Example : `192.168.0.1`	string
member_port required	Protocol port of Member Example : `80` Minimum : `1` Maximum : `65534`	integer
member_state optional	Member State of Member Example : `ENABLE`	any of [enum (ENABLE, DISABLE), null]
member_weight optional	Weight of Member Example : `100` Minimum : `1` Maximum : `1000`	integer
name required	Name of Member Example : `virtualserver-1` Pattern : `^[a-zA-Z0-9\s\-_\.]$` Minimum length* : `1` Maximum length : `63`	string
object_id optional	Object ID of Member Example : `1`	string
object_type required	Object Type of Member Example : `VM`	string

6.2.54 - MemberDeleteBulkRequestV1Dot2

Name	Description	Schema	Default
member_id_list required	ID list of Member	array[string]

6.2.55 - MemberListCreateRequestV1Dot1

Name	Description	Schema	Default
members required		array[MemberCreateRequestV1Dot1]

6.2.56 - MemberListResponse

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]
members required		array[Member]

6.2.57 - MemberSet

Name	Description	Schema
member_port optional	Protocol port of Member Example : `80`	any of [integer, null]
member_state optional	Member State of Member Example : `ENABLE`	any of [enum (ENABLE, DISABLE), null]
member_weight optional	Weight of Member Example : `100`	any of [integer, null]

6.2.58 - MemberSetRequest

Name	Description	Schema	Default
member required		MemberSet

6.2.59 - MemberShowResponse

Name	Description	Schema	Default
member required		any of [Member, null]

6.2.60 - MemberWithHealthState

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
health_state required	Health State of Member Example :	string
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
lb_server_group_id required	ID of Lb Server Group Example :	string
member_ip required	IP of Member Example :	string
member_port required	Protocol port of Member Example :	integer
member_state required	Member State of Member Example :	string
member_weight required	Weight of Member Example :	integer
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	Name of Member Example :	string
object_id required	Object ID of Member Example :	any of [string, null]
object_type required	Object Type of Member Example : `VM`	enum (VM, BM, MANUAL, MNGC)
state required	State of Member Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)

6.2.61 - MemberWithHealthStateListResponse

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

6.2.62 - PrivateStaticNatCreateRequest

Name	Description	Schema	Default
static_nat required		PrivateStaticNatCreateRequestDetail

6.2.63 - PrivateStaticNatCreateRequestDetail

Name	Description	Schema	Default
private_nat_id required	private_nat_id Example :	string
private_nat_ip_id required	private_nat_ip_id Example :	string

6.2.64 - PrivateStaticNatCreateResponse

Name	Description	Schema	Default
static_nat required		PrivateStaticNatCreateResponseDetail

6.2.65 - PrivateStaticNatCreateResponseDetail

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
external_ip_address optional	external_ip_address Example :	any of [string, null]
id optional	ID Example :	any of [string, null]
internal_ip_address optional	internal_ip_address Example :	any of [string, null]
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
private_nat_ip_id optional	private_nat_ip_id Example :	any of [string, null]
state optional	state Example :	any of [string, null]
subnet_id optional	subnet_id Example :	any of [string, null]

6.2.66 - PrivateStaticNatShowResponse

Name	Description	Schema	Default
static_nat required		any of [PrivateStaticNatShowResponseDetail, null]

6.2.67 - PrivateStaticNatShowResponseDetail

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
external_ip_address optional	external_ip_address Example :	any of [string, null]
id optional	ID Example :	any of [string, null]
internal_ip_address optional	internal_ip_address Example :	any of [string, null]
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
private_nat_ip_id optional	private_nat_ip_id Example :	any of [string, null]
state optional	state Example :	any of [string, null]

6.2.68 - SniCertificate

Name	Description	Schema
domain_name optional	Domain name for sni ssl Example : Pattern : `^[a-zA-Z0-9](?:[a-zA-Z0-9.-]{0,61}[a-zA-Z0-9])?$`	any of [string, null]
not_after_dt optional	The expiration date and time of the certificate Example :	any of [string (date-time), null]
sni_cert_id optional	Certificate id for sni ssl Example :	any of [string, null]

6.2.69 - SslCertificate

Name	Description	Schema
client_cert_id optional	Certificate id for client ssl Example :	any of [string, null]
client_cert_level optional	Certificate level for client ssl Example :	any of [string, null]
server_cert_level optional	Certificate level for server ssl Example :	any of [string, null]

6.2.70 - StaticNat

Name	Description	Schema
external_ip_address required	Static Nat External Ip Address Example :	string
publicip_id optional	Publicip ID Example :	any of [string, null]
state required	Static Nat State Example :	string

6.2.71 - StaticNatCreateRequest

Name	Description	Schema	Default
static_nat required		StaticNatCreateRequestDetail

6.2.72 - StaticNatCreateRequestDetail

Name	Description	Schema	Default
publicip_id required	publicip_id Example :	string

6.2.73 - StaticNatCreateResponse

Name	Description	Schema	Default
static_nat required		StaticNatCreateResponseDetail

6.2.74 - StaticNatCreateResponseDetail

Name	Description	Schema
account_id optional	account_id Example :	any of [string, null]
action_type optional	action_type Example :	any of [string, 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	description Example :	any of [string, null]
external_ip_address optional	external_ip_address Example :	any of [string, null]
id optional	ID Example :	any of [string, null]
internal_ip_address optional	internal_ip_address Example :	any of [string, null]
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name optional	name Example :	any of [string, null]
owner_id optional	owner_id Example :	any of [string, null]
owner_name optional	owner_name Example :	any of [string, null]
owner_type optional	owner_type Example :	any of [string, null]
publicip_id optional	publicip_id Example :	any of [string, null]
service_ip_port_id optional	service_ip_port_id Example :	any of [string, null]
state optional	state Example :	any of [string, null]
subnet_id optional	subnet_id Example :	any of [string, null]
type optional	type Example :	any of [string, null]
vpc_id optional	vpc_id Example :	any of [string, null]

6.2.75 - Tag

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

7 - Security Group

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 Security Group service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.

Version

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

Version	Status	Not Before
1.0	CURRENT	-

OpenAPI URL

https://security-group.{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

7.1 - APIs

7.1.1 - Create Security Group

7.1.1.1 - 1.0

post /v1/security-groups

Description

Create Security Group.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Type	Name	Description	Schema	Default
body	body required		SecurityGroupCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	SecurityGroupShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/security-groups

Request header

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

Request body

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

Example HTTP response

Response 201

{
    "security_group": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "loggable": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "rule_count": 0,
        "state": ""
    }
}

7.1.2 - Create Security Group Rule

7.1.2.1 - 1.0

post /v1/security-group-rules

Description

Create Security Group rule.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Type	Name	Description	Schema	Default
body	body required		SecurityGroupRuleCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	SecurityGroupRuleShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/security-group-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 = security-group 1.0"

Request body

{
    "description": "",
    "direction": "",
    "ethertype": "IPv4",
    "port_range_max": "",
    "port_range_min": "",
    "protocol": "",
    "remote_group_id": "",
    "remote_ip_prefix": "",
    "security_group_id": ""
}

Example HTTP response

Response 201

{
    "security_group_rule": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "direction": "ingress",
        "ethertype": "IPv4",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "port_range_max": "",
        "port_range_min": "",
        "protocol": "",
        "remote_group_id": "",
        "remote_group_name": "",
        "remote_ip_prefix": "",
        "security_group_id": ""
    }
}

7.1.3 - Delete Security Group

7.1.3.1 - 1.0

delete /v1/security-groups/{security_group_id}

Description

Delete Security Group.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	security_group_id required	Security Group ID Example :	string	None

Responses

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

Example HTTP request

Request path

/v1/security-groups/{security_group_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 = security-group 1.0"

Example HTTP response

Response 204

7.1.4 - Delete Security Group Rule

7.1.4.1 - 1.0

delete /v1/security-group-rules/{security_group_rule_id}

Description

Delete Security Group rule.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	security_group_rule_id required	Security Group Rule ID Example :	string	None

Responses

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

Example HTTP request

Request path

/v1/security-group-rules/{security_group_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 = security-group 1.0"

Example HTTP response

Response 204

7.1.5 - List Security Group Rules

7.1.5.1 - 1.0

get /v1/security-group-rules

Description

Get Security Group rule list.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

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	Security Group Rule ID Example :	string	None
query	security_group_id required	Security Group ID Example :	string	None
query	remote_ip_prefix optional	Security Group Rule Remote IP Address Example :	string	None
query	remote_group_id optional	Security Group Rule Remote Group ID Example :	string	None
query	description optional	Security Group Rule Description Example :	string	None
query	direction optional	Security Group Rule Direction (Ingress, Egress) Example :	string	None
query	service optional	Security Group Rule Service Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	SecurityGroupRuleListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/security-group-rules?security_group_id={security_group_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 = security-group 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "security_group_rules": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "",
            "direction": "ingress",
            "ethertype": "IPv4",
            "id": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "port_range_max": "",
            "port_range_min": "",
            "protocol": "",
            "remote_group_id": "",
            "remote_group_name": "",
            "remote_ip_prefix": "",
            "security_group_id": ""
        }
    ]
}

7.1.6 - List Security Groups

7.1.6.1 - 1.0

get /v1/security-groups

Description

Get Security Group list.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

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	Security Group ID Example :	string	None
query	name optional	Security Group Name Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	SecurityGroupListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/security-groups

Request header

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

Example HTTP response

Response 200

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

7.1.7 - Set Security Group

7.1.7.1 - 1.0

put /v1/security-groups/{security_group_id}

Description

Set Security Group.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	security_group_id required	Security Group ID Example :	string	None
body	body required		SecurityGroupSetRequest

Responses

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

Example HTTP request

Request path

/v1/security-groups/{security_group_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 = security-group 1.0"

Request body

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

Example HTTP response

Response 200

7.1.8 - Show Security Group

7.1.8.1 - 1.0

get /v1/security-groups/{security_group_id}

Description

Show Security Group.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	security_group_id required	Security Group ID Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	SecurityGroupShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/security-groups/{security_group_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 = security-group 1.0"

Example HTTP response

Response 200

{
    "security_group": {
        "account_id": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "id": "",
        "loggable": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "",
        "rule_count": 0,
        "state": ""
    }
}

7.1.9 - Show Security Group Rule

7.1.9.1 - 1.0

get /v1/security-group-rules/{security_group_rule_id}

Description

Show Security Group rule.

State ACTIVE (CURRENT)

Version	Not Before
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	security_group_rule_id required	Security Group Rule ID Example :	string	None
query	fields optional	Field Name Example :	any of [array[object], string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	SecurityGroupRuleShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/security-group-rules/{security_group_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 = security-group 1.0"

Example HTTP response

Response 200

{
    "security_group_rule": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "",
        "direction": "ingress",
        "ethertype": "IPv4",
        "id": "",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "port_range_max": "",
        "port_range_min": "",
        "protocol": "",
        "remote_group_id": "",
        "remote_group_name": "",
        "remote_ip_prefix": "",
        "security_group_id": ""
    }
}

7.2 - Models

7.2.1 - SecurityGroup

Name	Description	Schema
account_id required	Security Group 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	Security Group Description Example :	any of [string, null]
id required	Security Group ID Example :	string
loggable required	Security Group 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	Security Group Name Example :	string
rule_count optional	Security Group Rule Count Example : `0`	integer
state required	Security Group State Example :	string

7.2.2 - SecurityGroupCreateRequest

Name	Description	Schema
description optional	Security Group Description Example :	any of [string, null]
loggable optional	Security Group Loggable Example : `False`	any of [boolean, null]
name required	Security Group Name Example : Maximum length : `255`	string
tags optional	Tag List	array[Tag]

7.2.3 - SecurityGroupListResponse

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]
security_groups required		array[SecurityGroup]

7.2.4 - SecurityGroupRule

Name	Description	Schema	Default
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
description required	Security Group Rule Description Example :	any of [string, null]
direction required	Security Group Rule Direction (Ingress, Egress) Example : `ingress`	enum (ingress, egress)
ethertype optional	Security Group Rule Ethertype (IPV4, IPV6) Example : `IPv4`	any of [string, null]	IPv4
id required	Security Group 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
port_range_max required	Security Group Rule Port Range Max Example :	any of [integer, null]
port_range_min required	Security Group Rule Port Range Min Example :	any of [integer, null]
protocol required	Security Group Rule Protocol Example :	any of [string, null]
remote_group_id required	Security Group Rule Remote Group ID Example :	any of [string, null]
remote_group_name optional	Security Group Rule Remote Group Name Example :	any of [string, null]
remote_ip_prefix required	Security Group Rule Remote IP Address Example :	any of [string, null]
security_group_id required	Security Group ID Example :	string

7.2.5 - SecurityGroupRuleCreateRequest

Name	Description	Schema	Default
description optional	Security Group Rule Description Example :	any of [string, null]
direction required	Security Group Rule Direction (Ingress, Egress) Example :	string
ethertype optional	Security Group Rule Ethertype (IPV4, IPV6) Example : `IPv4`	any of [string, null]	IPv4
port_range_max optional	Security Group Rule Port Range Max Example :	any of [integer, null]
port_range_min optional	Security Group Rule Port Range Min Example :	any of [integer, null]
protocol optional	Security Group Rule Protocol Example :	any of [string, null]
remote_group_id optional	Security Group Rule Remote Group ID Example :	any of [string, null]
remote_ip_prefix optional	Security Group Rule Remote IP Address Example :	any of [string, null]
security_group_id required	Security Group ID Example :	string

7.2.6 - SecurityGroupRuleListResponse

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]
security_group_rules required		array[SecurityGroupRule]

7.2.7 - SecurityGroupRuleShowResponse

Name	Description	Schema	Default
security_group_rule required		SecurityGroupRule

7.2.8 - SecurityGroupSetRequest

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

7.2.9 - SecurityGroupShowResponse

Name	Description	Schema	Default
security_group required		SecurityGroup

7.2.10 - Tag

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

8 - VPC

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

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

Version	Status	Not Before
1.2	CURRENT	-
1.1	SUPPORTED	20261130
1.0	DEPRECATED	20251231

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

8.1 - APIs

8.1.1 - Add VPC CIDR

8.1.1.1 - 1.2

post /v1/vpcs/{vpc_id}/cidrs

Description

Add VPC CIDR.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/vpcs/{vpc_id}/cidrs

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.2"

Request body

{
    "cidr": "192.167.0.0/18"
}

Example HTTP response

Response 201

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr_count": 20,
        "cidrs": [
            {
                "cidr": "192.167.0.0/18",
                "created_at": "2024-05-17T00:23:17Z",
                "created_by": "7df8abb4912e4709b1cb237daccca7a8",
                "id": "7df8abb4912e4709b1cb237daccca7a8"
            }
        ],
        "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"
    }
}

8.1.2 - Approval VPC Peering

8.1.2.1 - 1.2

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

Description

Approval VPC Peering.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example : `023c57b14f11483689338d085e061492`	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.2"

Request body

{
    "type": "CREATE_APPROVE"
}

Example HTTP response

Response 200

{
    "vpc_peering": {
        "account_type": "SAME",
        "approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "approver_vpc_name": "vpcName",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "description": "vpcPeering Description",
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcPeeringName",
        "requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "requester_vpc_name": "vpcName",
        "state": "CREATING"
    }
}

8.1.2.2 - 1.1

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

Description

Approval VPC Peering.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example : `023c57b14f11483689338d085e061492`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "approver_vpc_name": "vpcName",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "description": "vpcPeering Description",
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcPeeringName",
        "requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "requester_vpc_name": "vpcName",
        "state": "CREATING"
    }
}

8.1.3 - Approve PrivateLink Endpoint

8.1.3.1 - 1.2

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

Description

Approve PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example : `bba6d4de3ad64e41b3a1b6c88983ec02`	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.2"

Request body

{
    "type": "APPROVE"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "created_at": "2024-06-16T02:55:13Z",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "state": "ACTIVE"
    }
}

8.1.3.2 - 1.1

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

Description

Approve PrivateLink Endpoint

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example : `bba6d4de3ad64e41b3a1b6c88983ec02`	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": "2024-06-16T02:55:13Z",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "state": "ACTIVE"
    }
}

8.1.4 - Connect PrivateLink Endpoint

8.1.4.1 - 1.2

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

Description

Connect PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example : `bba6d4de3ad64e41b3a1b6c88983ec02`	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.2"

Request body

{
    "type": "DISCONNECT"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "created_at": "2024-06-16T02:55:13Z",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "state": "ACTIVE"
    }
}

8.1.4.2 - 1.1

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

Description

Connect PrivateLink Endpoint

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example : `bba6d4de3ad64e41b3a1b6c88983ec02`	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": "2024-06-16T02:55:13Z",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "state": "ACTIVE"
    }
}

8.1.5 - Connect Subnet VIP Port

8.1.5.1 - 1.2

post /v1/subnets/{subnet_id}/vips/{vip_id}/connected-ports

Description

Connect Subnet Vip Port

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	subnet_id required	Subnet ID Example : `023c57b14f11483689338d085e061492`	string	None
path	vip_id required	Subnet Vip Id Example : `0466a9448d9a4411a86055939e451c8f`	string	None
body	body required		VipPortRequest

Responses

HTTP Code	Description	Schema
201	Created	VipPortResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/subnets/{subnet_id}/vips/{vip_id}/connected-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.2"

Request body

{
    "port_id": "35268a9f2eda4cde83b1d85c1f61f67d"
}

Example HTTP response

Response 201

{
    "id": "35268a9f2eda4cde83b1d85c1f61f67d",
    "subnet_vip_id": "0466a9448d9a4411a86055939e451c8f"
}

8.1.6 - Create Internet Gateway

8.1.6.1 - 1.2

post /v1/internet-gateways

Description

Create Internet Gateway.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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.2"

Request body

{
    "description": "Internet Gateway Description",
    "firewall_enabled": false,
    "firewall_loggable": false,
    "tags": [],
    "type": "IGW",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "internet_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Internet Gateway Description",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "023c57b14f11483689338d085e061492",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "IGW_VPCname",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.6.2 - 1.1

post /v1/internet-gateways

Description

Create Internet Gateway.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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": "Internet Gateway Description",
    "firewall_enabled": false,
    "firewall_loggable": false,
    "tags": [],
    "type": "IGW",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "internet_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Internet Gateway Description",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "023c57b14f11483689338d085e061492",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "IGW_VPCname",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.6.3 - 1.0

post /v1/internet-gateways

Description

Create Internet Gateway.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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": "Internet Gateway Description",
    "firewall_enabled": false,
    "firewall_loggable": false,
    "tags": [],
    "type": "IGW",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "internet_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Internet Gateway Description",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "023c57b14f11483689338d085e061492",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "IGW_VPCname",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.7 - Create NAT Gateway

8.1.7.1 - 1.2

post /v1/nat-gateways

Description

Create NAT Gateway.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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.2"

Request body

{
    "description": "VpcEndpoint Description",
    "publicip_id": "12f56e27070248a6a240a497e43fbe18",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "nat_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "NatGatewayName",
        "nat_gateway_ip_address": "192.167.0.5",
        "publicip_id": "12f56e27070248a6a240a497e43fbe18",
        "state": "ACTIVE",
        "subnet_cidr": "192.167.1.0/24",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.7.2 - 1.1

post /v1/nat-gateways

Description

Create NAT Gateway.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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": "VpcEndpoint Description",
    "publicip_id": "12f56e27070248a6a240a497e43fbe18",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "nat_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "NatGatewayName",
        "nat_gateway_ip_address": "192.167.0.5",
        "publicip_id": "12f56e27070248a6a240a497e43fbe18",
        "state": "ACTIVE",
        "subnet_cidr": "192.167.1.0/24",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.7.3 - 1.0

post /v1/nat-gateways

Description

Create NAT Gateway.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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": "VpcEndpoint Description",
    "publicip_id": "12f56e27070248a6a240a497e43fbe18",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "nat_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "NatGatewayName",
        "nat_gateway_ip_address": "192.167.0.5",
        "publicip_id": "12f56e27070248a6a240a497e43fbe18",
        "state": "ACTIVE",
        "subnet_cidr": "192.167.1.0/24",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.8 - Create Port

8.1.8.1 - 1.2

post /v1/ports

Description

Create port.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		PortCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	PortShowResponseV1Dot2
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.2"

Request body

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

Example HTTP response

Response 201

{
    "port": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
        "attached_resource_type": "",
        "created_at": "2026-04-14T15:07:04.882Z",
        "description": "Port Description",
        "fixed_ip_address": "192.168.1.100",
        "id": "023c57b1-4f11-4836-8933-8d085e061492",
        "mac_address": "fa:16:3e:00:00:01",
        "modified_at": "2026-04-14T15:07:04.882Z",
        "name": "portName",
        "security_groups": [
            {
                "id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
                "name": "sgName"
            }
        ],
        "state": "",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "virtual_ip_addresses": [
            ""
        ],
        "vpc_id": "071bc63b767444c9afaab1c972d302d5",
        "vpc_name": "vpcName"
    }
}

8.1.8.2 - 1.1

post /v1/ports

Description

Create port.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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": "Port Description",
    "fixed_ip_address": "",
    "name": "portName",
    "security_groups": [],
    "subnet_id": "",
    "tags": []
}

Example HTTP response

Response 201

{
    "port": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
        "attached_resource_type": "",
        "created_at": "2026-04-14T15:07:03.191Z",
        "description": "Port Description",
        "fixed_ip_address": "192.168.1.100",
        "id": "023c57b1-4f11-4836-8933-8d085e061492",
        "mac_address": "fa:16:3e:00:00:01",
        "modified_at": "2026-04-14T15:07:03.191Z",
        "name": "portName",
        "security_groups": [
            {
                "id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
                "name": "sgName"
            }
        ],
        "state": "",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "071bc63b767444c9afaab1c972d302d5",
        "vpc_name": "vpcName"
    }
}

8.1.8.3 - 1.0

post /v1/ports

Description

Create port.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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": "Port Description",
    "fixed_ip_address": "",
    "name": "portName",
    "security_groups": [],
    "subnet_id": "",
    "tags": []
}

Example HTTP response

Response 201

{
    "port": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
        "attached_resource_type": "",
        "created_at": "2026-04-14T15:07:01.815Z",
        "description": "Port Description",
        "fixed_ip_address": "192.168.1.100",
        "id": "023c57b1-4f11-4836-8933-8d085e061492",
        "mac_address": "fa:16:3e:00:00:01",
        "modified_at": "2026-04-14T15:07:01.815Z",
        "name": "portName",
        "security_groups": [
            {
                "id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
                "name": "sgName"
            }
        ],
        "state": "",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "071bc63b767444c9afaab1c972d302d5",
        "vpc_name": "vpcName"
    }
}

8.1.9 - Create Private NAT

8.1.9.1 - 1.2

post /v1/private-nats

Description

Create Private NAT.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		PrivateNatCreateRequestV1Dot2

Responses

HTTP Code	Description	Schema
202	Accepted	PrivateNatShowResponseV1Dot2
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.2"

Request body

{
    "cidr": "192.167.0.0/24",
    "description": "PrivateNat Description",
    "name": "PrivateNatName",
    "service_resource_id": "3f342bf9a557405b997c2cf48c89cbc2",
    "service_type": "DIRECT_CONNECT",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "private_nat": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateNat Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "PrivateNatName",
        "service_resource_id": "3f342bf9a557405b997c2cf48c89cbc2",
        "service_resource_name": "PrivateNatName",
        "service_type": "DIRECT_CONNECT",
        "state": "ACTIVE"
    }
}

8.1.9.2 - 1.1

post /v1/private-nats

Description

Create Private NAT.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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": "192.167.0.0/24",
    "description": "PrivateNat Description",
    "direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
    "name": "PrivateNatName",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "private_nat": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateNat Description",
        "direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
        "direct_connect_name": "DirectConnectName",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "PrivateNatName",
        "state": "ACTIVE",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.9.3 - 1.0

post /v1/private-nats

Description

Create Private NAT.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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": "192.167.0.0/24",
    "description": "PrivateNat Description",
    "direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
    "name": "PrivateNatName",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "private_nat": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateNat Description",
        "direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
        "direct_connect_name": "DirectConnectName",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "PrivateNatName",
        "state": "ACTIVE",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.10 - Create Private NAT IP

8.1.10.1 - 1.2

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

Description

Create Private NAT IP.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example : `12f56e27070248a6a240a497e43fbe18`	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.2"

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"
    }
}

8.1.10.2 - 1.1

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

Description

Create Private NAT IP.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example : `12f56e27070248a6a240a497e43fbe18`	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"
    }
}

8.1.10.3 - 1.0

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

Description

Create Private NAT IP.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example : `12f56e27070248a6a240a497e43fbe18`	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"
    }
}

8.1.11 - Create PrivateLink Endpoint

8.1.11.1 - 1.2

post /v1/privatelink-endpoints

Description

Create PrivateLink Endpoint.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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.2"

Request body

{
    "description": "PrivateLink Endpoint Description",
    "endpoint_ip_address": "192.167.1.5",
    "name": "EndpointName",
    "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
    "security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "privatelink_endpoint": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Endpoint Description",
        "endpoint_ip_address": "192.167.1.5",
        "endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "EndpointName",
        "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

8.1.11.2 - 1.1

post /v1/privatelink-endpoints

Description

Create PrivateLink Endpoint.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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": "PrivateLink Endpoint Description",
    "endpoint_ip_address": "192.167.1.5",
    "name": "EndpointName",
    "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
    "security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "privatelink_endpoint": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Endpoint Description",
        "endpoint_ip_address": "192.167.1.5",
        "endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "EndpointName",
        "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

8.1.12 - Create PrivateLink Service

8.1.12.1 - 1.2

post /v1/privatelink-services

Description

Create PrivateLink Service.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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.2"

Request body

{
    "approval_type": "AUTO",
    "connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
    "connected_resource_ip_address": "192.167.0.10",
    "connected_resource_type": "LB",
    "description": "PrivateLink Service Description",
    "high_speed_transfer": false,
    "name": "ServiceName",
    "security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
    "service_ip_address": "192.167.0.5",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "privatelink_service": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
        "connected_resource_ip_address": "192.167.0.10",
        "connected_resource_name": "lbResourceName",
        "connected_resource_type": "LB",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Service Description",
        "high_speed_transfer": false,
        "id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServiceName",
        "security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
        "service_ip_address": "192.167.0.5",
        "service_ip_port_id": "d21a4b81-f52a-43a8-b985-341e763458bb",
        "state": "CREATING",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

8.1.12.2 - 1.1

post /v1/privatelink-services

Description

Create PrivateLink Service.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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": "AUTO",
    "connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
    "connected_resource_ip_address": "192.167.0.10",
    "connected_resource_type": "LB",
    "description": "PrivateLink Service Description",
    "high_speed_transfer": false,
    "name": "ServiceName",
    "security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
    "service_ip_address": "192.167.0.5",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "privatelink_service": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
        "connected_resource_ip_address": "192.167.0.10",
        "connected_resource_name": "lbResourceName",
        "connected_resource_type": "LB",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Service Description",
        "high_speed_transfer": false,
        "id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServiceName",
        "security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
        "service_ip_address": "192.167.0.5",
        "service_ip_port_id": "d21a4b81-f52a-43a8-b985-341e763458bb",
        "state": "CREATING",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

8.1.13 - Create PublicIP

8.1.13.1 - 1.2

post /v1/publicips

Description

Create PublicIP.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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.2"

Request body

{
    "description": "Public IP Description",
    "tags": "[{'key': 'key', 'value': 'value'}]",
    "type": "IGW"
}

Example HTTP response

Response 201

{
    "publicip": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
        "attached_resource_name": "Attached NAT Gateway Name",
        "attached_resource_type": "NAT_GW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Public IP Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "ip_address": "192.167.0.5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ATTACHED",
        "type": "IGW"
    }
}

8.1.13.2 - 1.1

post /v1/publicips

Description

Create PublicIP.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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": "Public IP Description",
    "tags": "[{'key': 'key', 'value': 'value'}]",
    "type": "IGW"
}

Example HTTP response

Response 201

{
    "publicip": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
        "attached_resource_name": "Attached NAT Gateway Name",
        "attached_resource_type": "NAT_GW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Public IP Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "ip_address": "192.167.0.5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ATTACHED",
        "type": "IGW"
    }
}

8.1.13.3 - 1.0

post /v1/publicips

Description

Create PublicIP.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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": "Public IP Description",
    "tags": "[{'key': 'key', 'value': 'value'}]",
    "type": "IGW"
}

Example HTTP response

Response 201

{
    "publicip": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
        "attached_resource_name": "Attached NAT Gateway Name",
        "attached_resource_type": "NAT_GW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Public IP Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "ip_address": "192.167.0.5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ATTACHED",
        "type": "IGW"
    }
}

8.1.14 - Create Subnet

8.1.14.1 - 1.2

post /v1/subnets

Description

Create subnet.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		SubnetCreateRequestV1Dot2

Responses

HTTP Code	Description	Schema
202	Accepted	SubnetShowResponseV1Dot2
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.2"

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\"]",
    "gateway_ip_address": "192.167.1.1",
    "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",
        "dhcp_ip_address": "",
        "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"
    }
}

8.1.14.2 - 1.1

post /v1/subnets

Description

Create subnet.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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"
    }
}

8.1.14.3 - 1.0

post /v1/subnets

Description

Create subnet.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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"
    }
}

8.1.15 - Create Subnet VIP

8.1.15.1 - 1.2

post /v1/subnets/{subnet_id}/vips

Description

Create Subnet Vip

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

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

Responses

HTTP Code	Description	Schema
201	Created	VipCreateResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/subnets/{subnet_id}/vips

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.2"

Request body

{
    "description": "Subnet VIP Description",
    "virtual_ip_address": "192.168.20.6"
}

Example HTTP response

Response 201

{
    "subnet_vip": {
        "connected_ports": [
            {
                "attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
                "attached_resource_type": "Virtual Server",
                "id": "13e2a5a1acbe4713a9a2c70ce226e822",
                "port_id": "8b4705d3-43b7-4fad-8648-a5a1a90c31d0",
                "port_ip_address": "192.168.20.5",
                "port_name": "Port name"
            }
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet VIP Description",
        "id": "0466a9448d9a4411a86055939e451c8f",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ACTIVE",
        "static_nat": {
            "external_ip_address": "100.112.9.84",
            "id": "0009e49548154745948e9722adefbf40",
            "publicip_id": "12f56e27070248a6a240a497e43fbe18",
            "state": "ACTIVE"
        },
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vip_port_id": "35268a9f2eda4cde83b1d85c1f61f67d",
        "virtual_ip_address": "192.168.20.6"
    }
}

8.1.16 - Create Subnet VIP NAT IP

8.1.16.1 - 1.2

post /v1/subnets/{subnet_id}/vips/{vip_id}/static-nat-ips

Description

Create Subnet Vip Nat Ip

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	subnet_id required	Subnet ID Example : `023c57b14f11483689338d085e061492`	string	None
path	vip_id required	Subnet Vip Id Example : `0466a9448d9a4411a86055939e451c8f`	string	None
body	body required		VipNatCreateRequest

Responses

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

Example HTTP request

Request path

/v1/subnets/{subnet_id}/vips/{vip_id}/static-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.2"

Request body

{
    "nat_type": "PUBLIC",
    "publicip_id": "12f56e27070248a6a240a497e43fbe18"
}

Example HTTP response

Response 202

{
    "id": "0009e49548154745948e9722adefbf40",
    "publicip_id": "12f56e27070248a6a240a497e43fbe18",
    "state": "ACTIVE"
}

8.1.17 - Create Transit Gateway

8.1.17.1 - 1.2

post /v1/transit-gateways

Description

Create Transit Gateway.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		TransitGatewayCreateRequest

Responses

HTTP Code	Description	Schema
202	Accepted	TransitGatewayShowResponseV1Dot2
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.2"

Request body

{
    "description": "TransitGateway Description",
    "name": "TransitGatewayName",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "transit_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "firewall_connection_state": "INACTIVE",
        "firewall_ids": "['bbb93aca123f4bb2b2c0f206f4a86b2b']",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "TransitGatewayName",
        "state": "ACTIVE",
        "uplink_enabled": "False"
    }
}

8.1.17.2 - 1.1

post /v1/transit-gateways

Description

Create Transit Gateway.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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": "TransitGateway Description",
    "name": "TransitGatewayName",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "transit_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "firewall_ids": "['bbb93aca123f4bb2b2c0f206f4a86b2b']",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "TransitGatewayName",
        "state": "ACTIVE",
        "uplink_enabled": "False"
    }
}

8.1.17.3 - 1.0

post /v1/transit-gateways

Description

Create Transit Gateway.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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": "TransitGateway Description",
    "name": "TransitGatewayName",
    "tags": "[{'key': 'key', 'value': 'value'}]"
}

Example HTTP response

Response 202

{
    "transit_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "firewall_ids": "['bbb93aca123f4bb2b2c0f206f4a86b2b']",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "TransitGatewayName",
        "state": "ACTIVE",
        "uplink_enabled": "False"
    }
}

8.1.18 - Create Transit Gateway Firewall

8.1.18.1 - 1.2

post /v1/transit-gateways/{transit_gateway_id}/firewalls

Description

Create Transit Gateway Firewall.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

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

Responses

HTTP Code	Description	Schema
201	Created	TransitGatewayShowResponseV1Dot2
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/firewalls

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.2"

Request body

{
    "product_type": "TGW_DGW"
}

Example HTTP response

Response 201

{
    "transit_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "firewall_connection_state": "INACTIVE",
        "firewall_ids": "['bbb93aca123f4bb2b2c0f206f4a86b2b']",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "TransitGatewayName",
        "state": "ACTIVE",
        "uplink_enabled": "False"
    }
}

8.1.19 - Create Transit Gateway Firewall Connection

8.1.19.1 - 1.2

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

Description

Create Transit Gateway Firewall Connection.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/firewall-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.2"

Example HTTP response

Response 202

{
    "transit_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "firewall_connection_state": "INACTIVE",
        "firewall_ids": "['bbb93aca123f4bb2b2c0f206f4a86b2b']",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "TransitGatewayName",
        "state": "ACTIVE",
        "uplink_enabled": "False"
    }
}

8.1.20 - Create Transit Gateway Rule

8.1.20.1 - 1.2

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

Description

Create Transit Gateway Rule.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	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.2"

Request body

{
    "description": "Routing Rule Description",
    "destination_cidr": "192.167.5.0/24",
    "destination_type": "VPC",
    "tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34"
}

Example HTTP response

Response 202

{
    "transit_gateway_rule": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "description": "Routing Rule Description",
        "destination_cidr": "192.167.5.0/24",
        "destination_resource_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "destination_resource_name": "VpcName",
        "destination_type": "VPC",
        "id": "43772aff4539403d9ba74bf1fdaa00c8",
        "source_resource_id": "8582cc5d89994a42ad53282fd4a8d8be",
        "source_resource_name": "TgwName",
        "source_type": "TGW",
        "state": "ACTIVE",
        "tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34",
        "tgw_connection_vpc_name": "ConnectedVpcName"
    }
}

8.1.20.2 - 1.1

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

Description

Create Transit Gateway Rule.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	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": "Routing Rule Description",
    "destination_cidr": "192.167.5.0/24",
    "destination_type": "VPC",
    "tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34"
}

Example HTTP response

Response 202

{
    "transit_gateway_rule": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "description": "Routing Rule Description",
        "destination_cidr": "192.167.5.0/24",
        "destination_resource_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "destination_resource_name": "VpcName",
        "destination_type": "VPC",
        "id": "43772aff4539403d9ba74bf1fdaa00c8",
        "source_resource_id": "8582cc5d89994a42ad53282fd4a8d8be",
        "source_resource_name": "TgwName",
        "source_type": "TGW",
        "state": "ACTIVE",
        "tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34",
        "tgw_connection_vpc_name": "ConnectedVpcName"
    }
}

8.1.20.3 - 1.0

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

Description

Create Transit Gateway Rule.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	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": "Routing Rule Description",
    "destination_cidr": "192.167.5.0/24",
    "destination_type": "VPC",
    "tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34"
}

Example HTTP response

Response 202

{
    "transit_gateway_rule": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "description": "Routing Rule Description",
        "destination_cidr": "192.167.5.0/24",
        "destination_resource_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "destination_resource_name": "VpcName",
        "destination_type": "VPC",
        "id": "43772aff4539403d9ba74bf1fdaa00c8",
        "source_resource_id": "8582cc5d89994a42ad53282fd4a8d8be",
        "source_resource_name": "TgwName",
        "source_type": "TGW",
        "state": "ACTIVE",
        "tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34",
        "tgw_connection_vpc_name": "ConnectedVpcName"
    }
}

8.1.21 - Create Transit Gateway Uplink Rule

8.1.21.1 - 1.2

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

Description

Create Transit Gateway Uplink Rule.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/uplink-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.2"

Request body

{
    "description": "Routing Rule Description",
    "destination_cidr": "192.167.5.0/24",
    "destination_type": "ON_PREMISE"
}

Example HTTP response

Response 202

{
    "transit_gateway_rule": {
        "description": "Routing Rule Description",
        "destination_cidr": "192.167.5.0/24",
        "destination_type": "ON_PREMISE",
        "id": "43772aff4539403d9ba74bf1fdaa00c8",
        "state": "ACTIVE"
    }
}

8.1.21.2 - 1.1

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

Description

Create Transit Gateway Uplink Rule.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/uplink-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": "Routing Rule Description",
    "destination_cidr": "192.167.5.0/24",
    "destination_type": "ON_PREMISE"
}

Example HTTP response

Response 202

{
    "transit_gateway_rule": {
        "description": "Routing Rule Description",
        "destination_cidr": "192.167.5.0/24",
        "destination_type": "ON_PREMISE",
        "id": "43772aff4539403d9ba74bf1fdaa00c8",
        "state": "ACTIVE"
    }
}

8.1.21.3 - 1.0

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

Description

Create Transit Gateway Uplink Rule.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/uplink-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": "Routing Rule Description",
    "destination_cidr": "192.167.5.0/24",
    "destination_type": "ON_PREMISE"
}

Example HTTP response

Response 202

{
    "transit_gateway_rule": {
        "description": "Routing Rule Description",
        "destination_cidr": "192.167.5.0/24",
        "destination_type": "ON_PREMISE",
        "id": "43772aff4539403d9ba74bf1fdaa00c8",
        "state": "ACTIVE"
    }
}

8.1.22 - Create Transit Gateway VPC Connection

8.1.22.1 - 1.2

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

Description

Create Transit Gateway VPC Connection.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	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.2"

Request body

{
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "transit_gateway_vpc_connection": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "ffeced8e191c478eabd66b6e2cab8e34",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ACTIVE",
        "transit_gateway_id": "fe860e0af0c04dcd8182b84f907f31f4",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.22.2 - 1.1

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

Description

Create Transit Gateway VPC Connection.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	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": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "transit_gateway_vpc_connection": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "ffeced8e191c478eabd66b6e2cab8e34",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ACTIVE",
        "transit_gateway_id": "fe860e0af0c04dcd8182b84f907f31f4",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.22.3 - 1.0

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

Description

Create Transit Gateway VPC Connection.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	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": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "transit_gateway_vpc_connection": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "ffeced8e191c478eabd66b6e2cab8e34",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ACTIVE",
        "transit_gateway_id": "fe860e0af0c04dcd8182b84f907f31f4",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.23 - Create VPC

8.1.23.1 - 1.2

post /v1/vpcs

Description

Create VPC.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
body	body required		VpcCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	VpcShowResponseV1Dot2
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.2"

Request body

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

Example HTTP response

Response 201

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr_count": 20,
        "cidrs": [
            {
                "cidr": "192.167.0.0/18",
                "created_at": "2024-05-17T00:23:17Z",
                "created_by": "7df8abb4912e4709b1cb237daccca7a8",
                "id": "7df8abb4912e4709b1cb237daccca7a8"
            }
        ],
        "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"
    }
}

8.1.23.2 - 1.1

post /v1/vpcs

Description

Create VPC.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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"
    }
}

8.1.23.3 - 1.0

post /v1/vpcs

Description

Create VPC.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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"
    }
}

8.1.24 - Create VPC Endpoint

8.1.24.1 - 1.2

post /v1/vpc-endpoints

Description

Create VPC Endpoint.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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.2"

Request body

{
    "description": "VpcEndpoint Description",
    "endpoint_ip_address": "192.167.0.5",
    "name": "VpcEndpointName",
    "resource_info": "x.samsungsdscloud.com(Registry)",
    "resource_key": "07c5364702384471b650147321b52173",
    "resource_type": "FS",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": "[{'key': 'key', 'value': 'value'}]",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "vpc_endpoint": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "endpoint_ip_address": "192.167.0.5",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "VpcEndpointName",
        "resource_info": "x.samsungsdscloud.com(Registry)",
        "resource_key": "07c5364702384471b650147321b52173",
        "resource_type": "FS",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.24.2 - 1.1

post /v1/vpc-endpoints

Description

Create VPC Endpoint.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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": "VpcEndpoint Description",
    "endpoint_ip_address": "192.167.0.5",
    "name": "VpcEndpointName",
    "resource_info": "x.samsungsdscloud.com(Registry)",
    "resource_key": "07c5364702384471b650147321b52173",
    "resource_type": "FS",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": "[{'key': 'key', 'value': 'value'}]",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "vpc_endpoint": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "endpoint_ip_address": "192.167.0.5",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "VpcEndpointName",
        "resource_info": "x.samsungsdscloud.com(Registry)",
        "resource_key": "07c5364702384471b650147321b52173",
        "resource_type": "FS",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.24.3 - 1.0

post /v1/vpc-endpoints

Description

Create VPC Endpoint.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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": "VpcEndpoint Description",
    "endpoint_ip_address": "192.167.0.5",
    "name": "VpcEndpointName",
    "resource_info": "x.samsungsdscloud.com(Registry)",
    "resource_key": "07c5364702384471b650147321b52173",
    "resource_type": "FS",
    "subnet_id": "023c57b14f11483689338d085e061492",
    "tags": "[{'key': 'key', 'value': 'value'}]",
    "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
}

Example HTTP response

Response 202

{
    "vpc_endpoint": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "endpoint_ip_address": "192.167.0.5",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "VpcEndpointName",
        "resource_info": "x.samsungsdscloud.com(Registry)",
        "resource_key": "07c5364702384471b650147321b52173",
        "resource_type": "FS",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.25 - Create VPC Peering

8.1.25.1 - 1.2

post /v1/vpc-peerings

Description

Create VPC Peering.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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.2"

Request body

{
    "approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
    "approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
    "description": "vpcPeering Description",
    "name": "vpcPeeringName",
    "requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
    "tags": []
}

Example HTTP response

Response 202

{
    "vpc_peering": {
        "account_type": "SAME",
        "approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "approver_vpc_name": "vpcName",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "description": "vpcPeering Description",
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcPeeringName",
        "requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "requester_vpc_name": "vpcName",
        "state": "CREATING"
    }
}

8.1.25.2 - 1.1

post /v1/vpc-peerings

Description

Create VPC Peering.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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": "f1e6c81a2b054582878cb9724dc2ce9f",
    "approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
    "description": "vpcPeering Description",
    "name": "vpcPeeringName",
    "requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
    "tags": []
}

Example HTTP response

Response 202

{
    "vpc_peering": {
        "account_type": "SAME",
        "approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "approver_vpc_name": "vpcName",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "description": "vpcPeering Description",
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcPeeringName",
        "requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "requester_vpc_name": "vpcName",
        "state": "CREATING"
    }
}

8.1.25.3 - 1.0

post /v1/vpc-peerings

Description

Create VPC Peering.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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": "f1e6c81a2b054582878cb9724dc2ce9f",
    "approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
    "description": "vpcPeering Description",
    "name": "vpcPeeringName",
    "requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
    "tags": []
}

Example HTTP response

Response 202

{
    "vpc_peering": {
        "account_type": "SAME",
        "approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "approver_vpc_name": "vpcName",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "description": "vpcPeering Description",
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcPeeringName",
        "requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "requester_vpc_name": "vpcName",
        "state": "CREATING"
    }
}

8.1.26 - Create Vpc Peering Rule

8.1.26.1 - 1.2

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

Description

Create a VPC Peering Rule.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example : `023c57b14f11483689338d085e061492`	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.2"

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": ""
    }
}

8.1.26.2 - 1.1

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

Description

Create a VPC Peering Rule.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example : `023c57b14f11483689338d085e061492`	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": ""
    }
}

8.1.26.3 - 1.0

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

Description

Create a VPC Peering Rule.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example : `023c57b14f11483689338d085e061492`	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": ""
    }
}

8.1.27 - Delete Internet Gateway

8.1.27.1 - 1.2

delete /v1/internet-gateways/{internet_gateway_id}

Description

Delete Internet Gateway.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	internet_gateway_id required	Internet Gateway ID Example : `023c57b14f11483689338d085e061492`	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.2"

Example HTTP response

Response 202

8.1.27.2 - 1.1

delete /v1/internet-gateways/{internet_gateway_id}

Description

Delete Internet Gateway.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	internet_gateway_id required	Internet Gateway ID Example : `023c57b14f11483689338d085e061492`	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

8.1.27.3 - 1.0

delete /v1/internet-gateways/{internet_gateway_id}

Description

Delete Internet Gateway.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	internet_gateway_id required	Internet Gateway ID Example : `023c57b14f11483689338d085e061492`	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

8.1.28 - Delete NAT Gateway

8.1.28.1 - 1.2

delete /v1/nat-gateways/{nat_gateway_id}

Description

Delete NAT Gateway.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	nat_gateway_id required	NAT Gateway ID Example : `12f56e27070248a6a240a497e43fbe18`	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.2"

Example HTTP response

Response 202

8.1.28.2 - 1.1

delete /v1/nat-gateways/{nat_gateway_id}

Description

Delete NAT Gateway.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	nat_gateway_id required	NAT Gateway ID Example : `12f56e27070248a6a240a497e43fbe18`	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

8.1.28.3 - 1.0

delete /v1/nat-gateways/{nat_gateway_id}

Description

Delete NAT Gateway.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	nat_gateway_id required	NAT Gateway ID Example : `12f56e27070248a6a240a497e43fbe18`	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

8.1.29 - Delete Port

8.1.29.1 - 1.2

delete /v1/ports/{port_id}

Description

Delete port.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	port_id required	Port ID Example : `023c57b1-4f11-4836-8933-8d085e061492`	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.2"

Example HTTP response

Response 204

8.1.29.2 - 1.1

delete /v1/ports/{port_id}

Description

Delete port.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	port_id required	Port ID Example : `023c57b1-4f11-4836-8933-8d085e061492`	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

8.1.29.3 - 1.0

delete /v1/ports/{port_id}

Description

Delete port.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	port_id required	Port ID Example : `023c57b1-4f11-4836-8933-8d085e061492`	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

8.1.30 - Delete Private NAT

8.1.30.1 - 1.2

delete /v1/private-nats/{private_nat_id}

Description

Delete Private NAT.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example : `12f56e27070248a6a240a497e43fbe18`	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.2"

Example HTTP response

Response 202

8.1.30.2 - 1.1

delete /v1/private-nats/{private_nat_id}

Description

Delete Private NAT.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example : `12f56e27070248a6a240a497e43fbe18`	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

8.1.30.3 - 1.0

delete /v1/private-nats/{private_nat_id}

Description

Delete Private NAT.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example : `12f56e27070248a6a240a497e43fbe18`	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

8.1.31 - Delete Private NAT IP

8.1.31.1 - 1.2

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

Description

Delete Private NAT IP.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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.2"

Example HTTP response

Response 204

8.1.31.2 - 1.1

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

Description

Delete Private NAT IP.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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

8.1.31.3 - 1.0

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

Description

Delete Private NAT IP.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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

8.1.32 - Delete PrivateLink Endpoint

8.1.32.1 - 1.2

delete /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

Delete PrivateLink Endpoint.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example : `bba6d4de3ad64e41b3a1b6c88983ec02`	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.2"

Example HTTP response

Response 202

8.1.32.2 - 1.1

delete /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

Delete PrivateLink Endpoint.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example : `bba6d4de3ad64e41b3a1b6c88983ec02`	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

8.1.33 - Delete PrivateLink Service

8.1.33.1 - 1.2

delete /v1/privatelink-services/{privatelink_service_id}

Description

Delete PrivateLink Service.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_service_id required	PrivateLink Service ID Example : `e3df2e8e3b374fbb81d4e322b52ca50d`	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.2"

Example HTTP response

Response 202

8.1.33.2 - 1.1

delete /v1/privatelink-services/{privatelink_service_id}

Description

Delete PrivateLink Service.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	privatelink_service_id required	PrivateLink Service ID Example : `e3df2e8e3b374fbb81d4e322b52ca50d`	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

8.1.34 - Delete PublicIP

8.1.34.1 - 1.2

delete /v1/publicips/{publicip_id}

Description

Delete PublicIP.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	publicip_id required	PublicIP ID Example : `12f56e27070248a6a240a497e43fbe18`	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.2"

Example HTTP response

Response 204

8.1.34.2 - 1.1

delete /v1/publicips/{publicip_id}

Description

Delete PublicIP.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	publicip_id required	PublicIP ID Example : `12f56e27070248a6a240a497e43fbe18`	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

8.1.34.3 - 1.0

delete /v1/publicips/{publicip_id}

Description

Delete PublicIP.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	publicip_id required	PublicIP ID Example : `12f56e27070248a6a240a497e43fbe18`	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

8.1.35 - Delete Subnet

8.1.35.1 - 1.2

delete /v1/subnets/{subnet_id}

Description

Delete subnet.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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.2"

Example HTTP response

Response 202

8.1.35.2 - 1.1

delete /v1/subnets/{subnet_id}

Description

Delete subnet.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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

8.1.35.3 - 1.0

delete /v1/subnets/{subnet_id}

Description

Delete subnet.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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

8.1.36 - Delete Subnet Vip

8.1.36.1 - 1.2

delete /v1/subnets/{subnet_id}/vips/{vip_id}

Description

Delete Subnet Vip

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	subnet_id required	Subnet ID Example : `023c57b14f11483689338d085e061492`	string	None
path	vip_id required	Subnet Vip Id Example : `0466a9448d9a4411a86055939e451c8f`	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/subnets/{subnet_id}/vips/{vip_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.2"

Example HTTP response

Response 204

8.1.37 - Delete Subnet Vip Connected Port

8.1.37.1 - 1.2

delete /v1/subnets/{subnet_id}/vips/{vip_id}/connected-ports/{connected_port_id}

Description

Delete Subnet Vip Connected Port

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	subnet_id required	Subnet ID Example : `023c57b14f11483689338d085e061492`	string	None
path	vip_id required	Subnet Vip Id Example : `0466a9448d9a4411a86055939e451c8f`	string	None
path	connected_port_id required	Subnet Vip Connected Port Id Example : `13e2a5a1acbe4713a9a2c70ce226e822`	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/subnets/{subnet_id}/vips/{vip_id}/connected-ports/{connected_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.2"

Example HTTP response

Response 204

8.1.38 - Delete Subnet VIP NAT IP

8.1.38.1 - 1.2

delete /v1/subnets/{subnet_id}/vips/{vip_id}/static-nat-ips/{static_nat_id}

Description

Delete Subnet Vip Nat Ip

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	subnet_id required	Subnet ID Example : `023c57b14f11483689338d085e061492`	string	None
path	vip_id required	Subnet Vip Id Example : `0466a9448d9a4411a86055939e451c8f`	string	None
path	static_nat_id required	Static NAT ID Example : `0009e49548154745948e9722adefbf40`	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/subnets/{subnet_id}/vips/{vip_id}/static-nat-ips/{static_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.2"

Example HTTP response

Response 202

8.1.39 - Delete Transit Gateway

8.1.39.1 - 1.2

delete /v1/transit-gateways/{transit_gateway_id}

Description

Delete Transit Gateway.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	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.2"

Example HTTP response

Response 202

8.1.39.2 - 1.1

delete /v1/transit-gateways/{transit_gateway_id}

Description

Delete Transit Gateway.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	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

8.1.39.3 - 1.0

delete /v1/transit-gateways/{transit_gateway_id}

Description

Delete Transit Gateway.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	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

8.1.40 - Delete Transit Gateway Firewall

8.1.40.1 - 1.2

delete /v1/transit-gateways/{transit_gateway_id}/firewalls/{firewall_id}

Description

Delete Transit Gateway Firewall.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	string	None
path	firewall_id required	Firewall ID Example : `bbb93aca123f4bb2b2c0f206f4a86b2b`	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/transit-gateways/{transit_gateway_id}/firewalls/{firewall_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.2"

Example HTTP response

Response 204

8.1.41 - Delete Transit Gateway Firewall Connection

8.1.41.1 - 1.2

delete /v1/transit-gateways/{transit_gateway_id}/firewall-connections

Description

Delete Transit Gateway Firewall Connection.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

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

Responses

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

Example HTTP request

Request path

/v1/transit-gateways/{transit_gateway_id}/firewall-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.2"

Example HTTP response

Response 202

{
    "transit_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "firewall_connection_state": "INACTIVE",
        "firewall_ids": "['bbb93aca123f4bb2b2c0f206f4a86b2b']",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "TransitGatewayName",
        "state": "ACTIVE",
        "uplink_enabled": "False"
    }
}

8.1.42 - Delete Transit Gateway Rule

8.1.42.1 - 1.2

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

Description

Delete Transit Gateway Rule.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	string	None
path	routing_rule_id required	Routing Rule ID Example : `43772aff4539403d9ba74bf1fdaa00c8`	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.2"

Example HTTP response

Response 202

8.1.42.2 - 1.1

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

Description

Delete Transit Gateway Rule.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	string	None
path	routing_rule_id required	Routing Rule ID Example : `43772aff4539403d9ba74bf1fdaa00c8`	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

8.1.42.3 - 1.0

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

Description

Delete Transit Gateway Rule.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	string	None
path	routing_rule_id required	Routing Rule ID Example : `43772aff4539403d9ba74bf1fdaa00c8`	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

8.1.43 - Delete Transit Gateway Uplink Rule

8.1.43.1 - 1.2

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

Description

Delete Transit Gateway Uplink Rule.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	string	None
path	routing_rule_id required	Routing Rule ID Example : `43772aff4539403d9ba74bf1fdaa00c8`	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}/uplink-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.2"

Example HTTP response

Response 202

8.1.43.2 - 1.1

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

Description

Delete Transit Gateway Uplink Rule.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	string	None
path	routing_rule_id required	Routing Rule ID Example : `43772aff4539403d9ba74bf1fdaa00c8`	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}/uplink-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

8.1.43.3 - 1.0

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

Description

Delete Transit Gateway Uplink Rule.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	string	None
path	routing_rule_id required	Routing Rule ID Example : `43772aff4539403d9ba74bf1fdaa00c8`	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}/uplink-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

8.1.44 - Delete Transit Gateway VPC Connection

8.1.44.1 - 1.2

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

Description

Delete Transit Gateway VPC Connection.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	string	None
path	vpc_connection_id required	Transit Gateway VPC Connection ID Example : `ffeced8e191c478eabd66b6e2cab8e34`	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.2"

Example HTTP response

Response 202

8.1.44.2 - 1.1

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

Description

Delete Transit Gateway VPC Connection.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	string	None
path	vpc_connection_id required	Transit Gateway VPC Connection ID Example : `ffeced8e191c478eabd66b6e2cab8e34`	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

8.1.44.3 - 1.0

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

Description

Delete Transit Gateway VPC Connection.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	string	None
path	vpc_connection_id required	Transit Gateway VPC Connection ID Example : `ffeced8e191c478eabd66b6e2cab8e34`	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

8.1.45 - Delete VPC

8.1.45.1 - 1.2

delete /v1/vpcs/{vpc_id}

Description

Delete VPC.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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.2"

Example HTTP response

Response 204

8.1.45.2 - 1.1

delete /v1/vpcs/{vpc_id}

Description

Delete VPC.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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

8.1.45.3 - 1.0

delete /v1/vpcs/{vpc_id}

Description

Delete VPC.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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

8.1.46 - Delete VPC Endpoint

8.1.46.1 - 1.2

delete /v1/vpc-endpoints/{vpc_endpoint_id}

Description

Delete VPC Endpoint.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_endpoint_id required	VPC Endpoint ID Example : `12f56e27070248a6a240a497e43fbe18`	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.2"

Example HTTP response

Response 202

8.1.46.2 - 1.1

delete /v1/vpc-endpoints/{vpc_endpoint_id}

Description

Delete VPC Endpoint.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	vpc_endpoint_id required	VPC Endpoint ID Example : `12f56e27070248a6a240a497e43fbe18`	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

8.1.46.3 - 1.0

delete /v1/vpc-endpoints/{vpc_endpoint_id}

Description

Delete VPC Endpoint.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_endpoint_id required	VPC Endpoint ID Example : `12f56e27070248a6a240a497e43fbe18`	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

8.1.47 - Delete VPC Peering

8.1.47.1 - 1.2

delete /v1/vpc-peerings/{vpc_peering_id}

Description

Delete VPC Peering.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example : `023c57b14f11483689338d085e061492`	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.2"

Example HTTP response

Response 202

8.1.47.2 - 1.1

delete /v1/vpc-peerings/{vpc_peering_id}

Description

Delete VPC Peering.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example : `023c57b14f11483689338d085e061492`	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

8.1.47.3 - 1.0

delete /v1/vpc-peerings/{vpc_peering_id}

Description

Delete VPC Peering.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example : `023c57b14f11483689338d085e061492`	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

8.1.48 - Delete VPC Peering Rule

8.1.48.1 - 1.2

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

Description

Delete a VPC Peering Rule.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example : `023c57b14f11483689338d085e061492`	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.2"

Example HTTP response

Response 202

8.1.48.2 - 1.1

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

Description

Delete a VPC Peering Rule.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example : `023c57b14f11483689338d085e061492`	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

8.1.48.3 - 1.0

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

Description

Delete a VPC Peering Rule.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example : `023c57b14f11483689338d085e061492`	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

8.1.49 - List Connected PrivateLink Endpoints

8.1.49.1 - 1.2

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

Description

Get Connected PrivateLink Endpoint List.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_service_id required	PrivateLink Service ID Example : `e3df2e8e3b374fbb81d4e322b52ca50d`	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.2"

Example HTTP response

Response 200

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

8.1.49.2 - 1.1

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

Description

Get Connected PrivateLink Endpoint List.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	privatelink_service_id required	PrivateLink Service ID Example : `e3df2e8e3b374fbb81d4e322b52ca50d`	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": "bba6d4de3ad64e41b3a1b6c88983ec02",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
            "state": "ACTIVE"
        }
    ],
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

8.1.50 - List Internet Gateways

8.1.50.1 - 1.2

get /v1/internet-gateways

Description

Get Internet Gateway list.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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	Internet Gateway ID Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	name optional	Internet Gateway Name Example : `IGW_VPCname`	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 : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]
query	vpc_name optional	VPC Name Example : `vpcName`	any of [string, null]

Responses

HTTP Code	Description	Schema
200	OK	InternetGatewayListResponseV1Dot2
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.2"

Example HTTP response

Response 200

{
    "count": 20,
    "internet_gateways": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Internet Gateway Description",
            "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
            "id": "023c57b14f11483689338d085e061492",
            "loggable": false,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "IGW_VPCname",
            "state": "CREATING",
            "type": "IGW",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

8.1.50.2 - 1.1

get /v1/internet-gateways

Description

Get Internet Gateway list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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 : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	name optional	Internet Gateway Name Example : `IGW_VPCname`	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 : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]
query	vpc_name optional	VPC Name Example : `vpcName`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Internet Gateway Description",
            "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
            "id": "023c57b14f11483689338d085e061492",
            "loggable": false,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "IGW_VPCname",
            "state": "CREATING",
            "type": "IGW",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ],
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

8.1.50.3 - 1.0

get /v1/internet-gateways

Description

Get Internet Gateway list.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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 : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	name optional	Internet Gateway Name Example : `IGW_VPCname`	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 : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]
query	vpc_name optional	VPC Name Example : `vpcName`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Internet Gateway Description",
            "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
            "id": "023c57b14f11483689338d085e061492",
            "loggable": false,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "IGW_VPCname",
            "state": "CREATING",
            "type": "IGW",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ],
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

8.1.51 - List NAT Gateways

8.1.51.1 - 1.2

get /v1/nat-gateways

Description

Get NAT Gateway list.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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	NAT Gateway Name Example : `NatGatewayName`	any of [string, null]	None
query	vpc_id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	vpc_name optional	VPC Name Example : `vpcName`	any of [string, null]	None
query	subnet_id optional	Subnet Id Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	subnet_name optional	Subnet Name Example : `subnetName`	any of [string, null]	None
query	nat_gateway_ip_address optional	NAT Gateway IP Address Example : `192.167.0.5`	any of [string, null]	None
query	state optional	NAT Gateway State Example : `ACTIVE`	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	NatGatewayListResponseV1Dot2
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.2"

Example HTTP response

Response 200

{
    "count": 20,
    "nat_gateways": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "VpcEndpoint Description",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "NatGatewayName",
            "nat_gateway_ip_address": "192.167.0.5",
            "publicip_id": "12f56e27070248a6a240a497e43fbe18",
            "state": "ACTIVE",
            "subnet_cidr": "192.167.1.0/24",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "subnet_name": "subnetName",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

8.1.51.2 - 1.1

get /v1/nat-gateways

Description

Get NAT Gateway list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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 : `NatGatewayName`	any of [string, null]	None
query	vpc_id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	vpc_name optional	VPC Name Example : `vpcName`	any of [string, null]	None
query	subnet_id optional	Subnet Id Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	subnet_name optional	Subnet Name Example : `subnetName`	any of [string, null]	None
query	nat_gateway_ip_address optional	NAT Gateway IP Address Example : `192.167.0.5`	any of [string, null]	None
query	state optional	NAT Gateway State Example : `ACTIVE`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "VpcEndpoint Description",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "NatGatewayName",
            "nat_gateway_ip_address": "192.167.0.5",
            "publicip_id": "12f56e27070248a6a240a497e43fbe18",
            "state": "ACTIVE",
            "subnet_cidr": "192.167.1.0/24",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "subnet_name": "subnetName",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

8.1.51.3 - 1.0

get /v1/nat-gateways

Description

Get NAT Gateway list.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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 : `NatGatewayName`	any of [string, null]	None
query	vpc_id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	vpc_name optional	VPC Name Example : `vpcName`	any of [string, null]	None
query	subnet_id optional	Subnet Id Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	subnet_name optional	Subnet Name Example : `subnetName`	any of [string, null]	None
query	nat_gateway_ip_address optional	NAT Gateway IP Address Example : `192.167.0.5`	any of [string, null]	None
query	state optional	NAT Gateway State Example : `ACTIVE`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "VpcEndpoint Description",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "NatGatewayName",
            "nat_gateway_ip_address": "192.167.0.5",
            "publicip_id": "12f56e27070248a6a240a497e43fbe18",
            "state": "ACTIVE",
            "subnet_cidr": "192.167.1.0/24",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "subnet_name": "subnetName",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

8.1.52 - List Ports

8.1.52.1 - 1.2

get /v1/ports

Description

Get port list.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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 : `portName`	any of [string, null]	None
query	subnet_id optional	Subnet Id Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	subnet_name optional	Subnet Name Example : `subnetName`	any of [string, null]	None
query	id optional	Port ID Example : `023c57b1-4f11-4836-8933-8d085e061492`	any of [string, null]	None
query	attached_resource_id optional	Connected resource ID Example : `9387e8f51de04a03994de8a9c3524935`	any of [string, null]	None
query	fixed_ip_address optional	Fixed IP Example : `192.168.1.100`	any of [string, null]	None
query	mac_address optional	MAC Address Example : `fa:16:3e:00:00:01`	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
query	attached_resource_types optional	Attached Resource Type Example :	any of [enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED), array[enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED)]]	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.2"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "ports": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
            "attached_resource_type": "",
            "created_at": "2026-04-14T15:07:04.864Z",
            "description": "Port Description",
            "fixed_ip_address": "192.168.1.100",
            "id": "023c57b1-4f11-4836-8933-8d085e061492",
            "mac_address": "fa:16:3e:00:00:01",
            "modified_at": "2026-04-14T15:07:04.864Z",
            "name": "portName",
            "state": "",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "subnet_name": "subnetName",
            "vpc_id": "071bc63b767444c9afaab1c972d302d5",
            "vpc_name": "vpcName"
        }
    ]
}

8.1.52.2 - 1.1

get /v1/ports

Description

Get port list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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 : `portName`	any of [string, null]	None
query	subnet_id optional	Subnet Id Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	subnet_name optional	Subnet Name Example : `subnetName`	any of [string, null]	None
query	id optional	Port ID Example : `023c57b1-4f11-4836-8933-8d085e061492`	any of [string, null]	None
query	attached_resource_id optional	Connected resource ID Example : `9387e8f51de04a03994de8a9c3524935`	any of [string, null]	None
query	fixed_ip_address optional	Fixed IP Example : `192.168.1.100`	any of [string, null]	None
query	mac_address optional	MAC Address Example : `fa:16:3e:00:00:01`	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
query	attached_resource_types optional	Attached Resource Type Example :	any of [enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED), array[enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED)]]	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": "f1e6c81a2b054582878cb9724dc2ce9f",
            "attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
            "attached_resource_type": "",
            "created_at": "2026-04-14T15:07:03.173Z",
            "description": "Port Description",
            "fixed_ip_address": "192.168.1.100",
            "id": "023c57b1-4f11-4836-8933-8d085e061492",
            "mac_address": "fa:16:3e:00:00:01",
            "modified_at": "2026-04-14T15:07:03.173Z",
            "name": "portName",
            "state": "",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "subnet_name": "subnetName",
            "vpc_id": "071bc63b767444c9afaab1c972d302d5",
            "vpc_name": "vpcName"
        }
    ]
}

8.1.52.3 - 1.0

get /v1/ports

Description

Get port list.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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 : `portName`	any of [string, null]	None
query	subnet_id optional	Subnet Id Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	subnet_name optional	Subnet Name Example : `subnetName`	any of [string, null]	None
query	id optional	Port ID Example : `023c57b1-4f11-4836-8933-8d085e061492`	any of [string, null]	None
query	attached_resource_id optional	Connected resource ID Example : `9387e8f51de04a03994de8a9c3524935`	any of [string, null]	None
query	fixed_ip_address optional	Fixed IP Example : `192.168.1.100`	any of [string, null]	None
query	mac_address optional	MAC Address Example : `fa:16:3e:00:00:01`	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
query	attached_resource_types optional	Attached Resource Type Example :	any of [enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED), array[enum (VIRTUAL_SERVER, PRIVATELINKE, UNATTACHED)]]	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": "f1e6c81a2b054582878cb9724dc2ce9f",
            "attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
            "attached_resource_type": "",
            "created_at": "2026-04-14T15:07:01.797Z",
            "description": "Port Description",
            "fixed_ip_address": "192.168.1.100",
            "id": "023c57b1-4f11-4836-8933-8d085e061492",
            "mac_address": "fa:16:3e:00:00:01",
            "modified_at": "2026-04-14T15:07:01.797Z",
            "name": "portName",
            "state": "",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "subnet_name": "subnetName",
            "vpc_id": "071bc63b767444c9afaab1c972d302d5",
            "vpc_name": "vpcName"
        }
    ]
}

8.1.53 - List Private NAT

8.1.53.1 - 1.2

get /v1/private-nats

Description

Get Private NAT list.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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 : `PrivateNatName`	any of [string, null]	None
query	cidr optional	Private NAT IP range Example : `192.167.0.0/24`	any of [string, null]	None
query	vpc_id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	service_resource_id optional	Private NAT connected Service Resource ID Example : `3f342bf9a557405b997c2cf48c89cbc2`	any of [string, null]	None
query	service_type optional	Private NAT connected Service Type Example : `DIRECT_CONNECT`	enum (DIRECT_CONNECT, TRANSIT_GATEWAY)	None
query	service_resource_name optional	Private NAT connected Service Resource Name Example : `Service Resource Name`	any of [string, null]	None
query	state optional	Private NAT State Example : `ACTIVE`	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	PrivateNatListResponseV1Dot2
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.2"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_nats": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "cidr": "192.167.0.0/24",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "PrivateNat Description",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "PrivateNatName",
            "service_resource_id": "3f342bf9a557405b997c2cf48c89cbc2",
            "service_resource_name": "PrivateNatName",
            "service_type": "DIRECT_CONNECT",
            "state": "ACTIVE"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

8.1.53.2 - 1.1

get /v1/private-nats

Description

Get Private NAT list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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 : `PrivateNatName`	any of [string, null]	None
query	cidr optional	Private NAT IP range Example : `192.167.0.0/24`	any of [string, null]	None
query	vpc_id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	vpc_name optional	VPC Name Example : `vpcName`	any of [string, null]	None
query	direct_connect_id optional	Direct Connect ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	any of [string, null]	None
query	direct_connect_name optional	Direct Connect Name Example : `DirectConnectName`	any of [string, null]	None
query	state optional	Private NAT State Example : `ACTIVE`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
            "cidr": "192.167.0.0/24",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "PrivateNat Description",
            "direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
            "direct_connect_name": "DirectConnectName",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "PrivateNatName",
            "state": "ACTIVE",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

8.1.53.3 - 1.0

get /v1/private-nats

Description

Get Private NAT list.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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 : `PrivateNatName`	any of [string, null]	None
query	cidr optional	Private NAT IP range Example : `192.167.0.0/24`	any of [string, null]	None
query	vpc_id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	vpc_name optional	VPC Name Example : `vpcName`	any of [string, null]	None
query	direct_connect_id optional	Direct Connect ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	any of [string, null]	None
query	direct_connect_name optional	Direct Connect Name Example : `DirectConnectName`	any of [string, null]	None
query	state optional	Private NAT State Example : `ACTIVE`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
            "cidr": "192.167.0.0/24",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "PrivateNat Description",
            "direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
            "direct_connect_name": "DirectConnectName",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "PrivateNatName",
            "state": "ACTIVE",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

8.1.54 - List Private NAT IP

8.1.54.1 - 1.2

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

Description

Get Private NAT IP list.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example : `12f56e27070248a6a240a497e43fbe18`	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, ALB, GPU_SERVER), 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.2"

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"
    ]
}

8.1.54.2 - 1.1

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

Description

Get Private NAT IP list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example : `12f56e27070248a6a240a497e43fbe18`	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, ALB, GPU_SERVER), 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"
    ]
}

8.1.54.3 - 1.0

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

Description

Get Private NAT IP list.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example : `12f56e27070248a6a240a497e43fbe18`	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, ALB, GPU_SERVER), 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"
    ]
}

8.1.55 - List PrivateLink Endpoint

8.1.55.1 - 1.2

get /v1/privatelink-endpoints

Description

Get PrivateLink Endpoint List.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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 : `bba6d4de3ad64e41b3a1b6c88983ec02`	any of [string, null]	None
query	name optional	PrivateLink Endpoint Name Example : `EndpointName`	any of [string, null]	None
query	vpc_id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	subnet_id optional	Subnet Id Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	privatelink_service_id optional	PrivateLink Service ID Example : `e3df2e8e3b374fbb81d4e322b52ca50d`	any of [string, null]	None
query	endpoint_ip_address optional	Endpoint IP Address Example : `192.167.1.5`	any of [string, null]	None
query	state optional	PrivateLink Endpoint State Example : `ACTIVE`	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.2"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "privatelink_endpoints": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "approval_type": "AUTO",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "endpoint_ip_address": "192.167.1.5",
            "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "EndpointName",
            "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
            "state": "ACTIVE",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

8.1.55.2 - 1.1

get /v1/privatelink-endpoints

Description

Get PrivateLink Endpoint List.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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 : `bba6d4de3ad64e41b3a1b6c88983ec02`	any of [string, null]	None
query	name optional	PrivateLink Endpoint Name Example : `EndpointName`	any of [string, null]	None
query	vpc_id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	subnet_id optional	Subnet Id Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	privatelink_service_id optional	PrivateLink Service ID Example : `e3df2e8e3b374fbb81d4e322b52ca50d`	any of [string, null]	None
query	endpoint_ip_address optional	Endpoint IP Address Example : `192.167.1.5`	any of [string, null]	None
query	state optional	PrivateLink Endpoint State Example : `ACTIVE`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
            "approval_type": "AUTO",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "endpoint_ip_address": "192.167.1.5",
            "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "EndpointName",
            "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
            "state": "ACTIVE",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

8.1.56 - List PrivateLink Service

8.1.56.1 - 1.2

get /v1/privatelink-services

Description

Get PrivateLink Service List.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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 : `e3df2e8e3b374fbb81d4e322b52ca50d`	any of [string, null]	None
query	name optional	PrivateLink Service Name Example : `ServiceName`	any of [string, null]	None
query	vpc_id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	subnet_id optional	Subnet Id Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	service_ip_address optional	Service IP Address Example : `192.167.0.5`	any of [string, null]	None
query	connected_resource_id optional	Connected Resource ID Example : `a3e3a662a4f34442a94166df5ff9f577`	any of [string, null]	None
query	connected_resource_type optional	Connected Resource Type Example : `LB`	any of [enum (LB, IP), null]	None
query	connected_resource_name optional	Connected Resource Name Example : `lbResourceName`	any of [string, null]	None
query	connected_resource_ip_address optional	Connected Resource IP Address Example : `192.167.0.10`	any of [string, null]	None
query	state optional	PrivateLink Service State Example : `ACTIVE`	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.2"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "privatelink_services": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "approval_type": "AUTO",
            "connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
            "connected_resource_ip_address": "192.167.0.10",
            "connected_resource_name": "lbResourceName",
            "connected_resource_type": "LB",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "e3df2e8e3b374fbb81d4e322b52ca50d",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ServiceName",
            "service_ip_address": "192.167.0.5",
            "state": "CREATING",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

8.1.56.2 - 1.1

get /v1/privatelink-services

Description

Get PrivateLink Service List.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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 : `e3df2e8e3b374fbb81d4e322b52ca50d`	any of [string, null]	None
query	name optional	PrivateLink Service Name Example : `ServiceName`	any of [string, null]	None
query	vpc_id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	subnet_id optional	Subnet Id Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	service_ip_address optional	Service IP Address Example : `192.167.0.5`	any of [string, null]	None
query	connected_resource_id optional	Connected Resource ID Example : `a3e3a662a4f34442a94166df5ff9f577`	any of [string, null]	None
query	connected_resource_type optional	Connected Resource Type Example : `LB`	any of [enum (LB, IP), null]	None
query	connected_resource_name optional	Connected Resource Name Example : `lbResourceName`	any of [string, null]	None
query	connected_resource_ip_address optional	Connected Resource IP Address Example : `192.167.0.10`	any of [string, null]	None
query	state optional	PrivateLink Service State Example : `ACTIVE`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
            "approval_type": "AUTO",
            "connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
            "connected_resource_ip_address": "192.167.0.10",
            "connected_resource_name": "lbResourceName",
            "connected_resource_type": "LB",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "e3df2e8e3b374fbb81d4e322b52ca50d",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ServiceName",
            "service_ip_address": "192.167.0.5",
            "state": "CREATING",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

8.1.57 - List PublicIPs

8.1.57.1 - 1.2

get /v1/publicips

Description

Get PublicIP list.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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	ip_address optional	IP Address Example : `192.167.0.5`	any of [string, null]	None
query	state optional	PublicIP State Example : `ATTACHED`	any of [string, null]	None
query	attached_resource_type optional	PublicIP Attached Resource Type Example : `NAT_GW`	any of [string, null]	None
query	attached_resource_id optional	PublicIP Attached Resource ID Example : `37e6db41f5124184a43251a63124cdc9`	any of [string, null]	None
query	attached_resource_name optional	PublicIP Attached Resource Name Example : `Attached NAT Gateway Name`	any of [string, null]	None
query	vpc_id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	type optional	PublicIP Type Example : `IGW`	any of [enum (IGW, GGW, SIGW), null]	None

Responses

HTTP Code	Description	Schema
200	OK	PublicipListResponseV1Dot2
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.2"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "publicips": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
            "attached_resource_name": "Attached NAT Gateway Name",
            "attached_resource_type": "NAT_GW",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Public IP Description",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "ip_address": "192.167.0.5",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "ATTACHED",
            "type": "IGW"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

8.1.57.2 - 1.1

get /v1/publicips

Description

Get PublicIP list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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 : `192.167.0.5`	any of [string, null]	None
query	state optional	PublicIP State Example : `ATTACHED`	any of [string, null]	None
query	attached_resource_type optional	PublicIP Attached Resource Type Example : `NAT_GW`	any of [string, null]	None
query	attached_resource_id optional	PublicIP Attached Resource ID Example : `37e6db41f5124184a43251a63124cdc9`	any of [string, null]	None
query	attached_resource_name optional	PublicIP Attached Resource Name Example : `Attached NAT Gateway Name`	any of [string, null]	None
query	vpc_id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	type optional	PublicIP Type Example : `IGW`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
            "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
            "attached_resource_name": "Attached NAT Gateway Name",
            "attached_resource_type": "NAT_GW",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Public IP Description",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "ip_address": "192.167.0.5",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "ATTACHED",
            "type": "IGW"
        }
    ]
}

8.1.57.3 - 1.0

get /v1/publicips

Description

Get PublicIP list.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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 : `192.167.0.5`	any of [string, null]	None
query	state optional	PublicIP State Example : `ATTACHED`	any of [string, null]	None
query	attached_resource_type optional	PublicIP Attached Resource Type Example : `NAT_GW`	any of [string, null]	None
query	attached_resource_id optional	PublicIP Attached Resource ID Example : `37e6db41f5124184a43251a63124cdc9`	any of [string, null]	None
query	attached_resource_name optional	PublicIP Attached Resource Name Example : `Attached NAT Gateway Name`	any of [string, null]	None
query	vpc_id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	type optional	PublicIP Type Example : `IGW`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
            "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
            "attached_resource_name": "Attached NAT Gateway Name",
            "attached_resource_type": "NAT_GW",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Public IP Description",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "ip_address": "192.167.0.5",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "ATTACHED",
            "type": "IGW"
        }
    ]
}

8.1.58 - List SAP Secondary Subnets

8.1.58.1 - 1.2

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

Description

List SAP Secondary Subnets

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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.2"

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"
    ]
}

8.1.58.2 - 1.1

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

Description

List SAP Secondary Subnets

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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"
    ]
}

8.1.59 - List Subnet Vips

8.1.59.1 - 1.2

get /v1/subnets/{subnet_id}/vips

Description

Get list Subnet Vip

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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
query	virtual_ip_address optional	Virtual IP Address Example : `192.168.20.6`	any of [string, null]	None
query	public_ip_address optional	Public IP Address Example : `100.112.9.84`	any of [string, null]	None

Responses

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

Example HTTP request

Request path

/v1/subnets/{subnet_id}/vips

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.2"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "subnet_vips": [
        {
            "connected_port_count": 2,
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0466a9448d9a4411a86055939e451c8f",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "ACTIVE",
            "static_nat": {
                "external_ip_address": "100.112.9.84",
                "id": "0009e49548154745948e9722adefbf40",
                "publicip_id": "12f56e27070248a6a240a497e43fbe18",
                "state": "ACTIVE"
            },
            "virtual_ip_address": "192.168.20.6"
        }
    ]
}

8.1.60 - List Subnets

8.1.60.1 - 1.2

get /v1/subnets

Description

Get subnet list.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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	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	cidr optional	Subnet Cidr Example : `192.167.1.0/24`	any of [string, null]	None
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	SubnetListResponseV1Dot2
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.2"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "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"
        }
    ]
}

8.1.60.2 - 1.1

get /v1/subnets

Description

Get subnet list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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"
        }
    ]
}

8.1.60.3 - 1.0

get /v1/subnets

Description

Get subnet list.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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"
        }
    ]
}

8.1.61 - List Transit Gateway Rules

8.1.61.1 - 1.2

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

Description

Get Transit Gateway Rule list.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	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 : `43772aff4539403d9ba74bf1fdaa00c8`	any of [string, null]	None
query	tgw_connection_vpc_id optional	VPC ID Connected to Transit Gateway. Example : `ffeced8e191c478eabd66b6e2cab8e34`	any of [string, null]	None
query	tgw_connection_vpc_name optional	VPC Name Connected to Transit Gateway. Example : `ConnectedVpcName`	any of [string, null]	None
query	source_type optional	Source Type Example : `TGW`	enum (VPC, TGW, ON_PREMISE)	None
query	destination_type optional	Destination Type Example : `VPC`	enum (VPC, TGW, ON_PREMISE)	None
query	destination_cidr optional	Destination CIDR Example : `192.167.5.0/24`	any of [string, null]	None
query	state optional	State Example : `ACTIVE`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)	None
query	rule_type optional	Rule Type Example : `TGW_VPC`	enum (TGW_VPC, TGW_UPLINK)	None

Responses

HTTP Code	Description	Schema
200	OK	TransitGatewayRuleListResponseV1Dot2
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.2"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "transit_gateway_rules": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Routing Rule Description",
            "destination_cidr": "192.167.5.0/24",
            "destination_resource_id": "ceb44ea5ecb34a49b16495f9a63b0718",
            "destination_resource_name": "VpcName",
            "destination_type": "VPC",
            "id": "43772aff4539403d9ba74bf1fdaa00c8",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "rule_type": "TGW_VPC",
            "source_resource_id": "8582cc5d89994a42ad53282fd4a8d8be",
            "source_resource_name": "TgwName",
            "source_type": "TGW",
            "state": "ACTIVE",
            "tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34",
            "tgw_connection_vpc_name": "ConnectedVpcName"
        }
    ]
}

8.1.61.2 - 1.1

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

Description

Get Transit Gateway Rule list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	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 : `43772aff4539403d9ba74bf1fdaa00c8`	any of [string, null]	None
query	tgw_connection_vpc_id optional	VPC ID Connected to Transit Gateway. Example : `ffeced8e191c478eabd66b6e2cab8e34`	any of [string, null]	None
query	tgw_connection_vpc_name optional	VPC Name Connected to Transit Gateway. Example : `ConnectedVpcName`	any of [string, null]	None
query	source_type optional	Source Type Example : `TGW`	enum (VPC, TGW, ON_PREMISE)	None
query	destination_type optional	Destination Type Example : `VPC`	enum (VPC, TGW, ON_PREMISE)	None
query	destination_cidr optional	Destination CIDR Example : `192.167.5.0/24`	any of [string, null]	None
query	state optional	State Example : `ACTIVE`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Routing Rule Description",
            "destination_cidr": "192.167.5.0/24",
            "destination_resource_id": "ceb44ea5ecb34a49b16495f9a63b0718",
            "destination_resource_name": "VpcName",
            "destination_type": "VPC",
            "id": "43772aff4539403d9ba74bf1fdaa00c8",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "source_resource_id": "8582cc5d89994a42ad53282fd4a8d8be",
            "source_resource_name": "TgwName",
            "source_type": "TGW",
            "state": "ACTIVE",
            "tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34",
            "tgw_connection_vpc_name": "ConnectedVpcName"
        }
    ]
}

8.1.61.3 - 1.0

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

Description

Get Transit Gateway Rule list.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	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 : `43772aff4539403d9ba74bf1fdaa00c8`	any of [string, null]	None
query	tgw_connection_vpc_id optional	VPC ID Connected to Transit Gateway. Example : `ffeced8e191c478eabd66b6e2cab8e34`	any of [string, null]	None
query	tgw_connection_vpc_name optional	VPC Name Connected to Transit Gateway. Example : `ConnectedVpcName`	any of [string, null]	None
query	source_type optional	Source Type Example : `TGW`	enum (VPC, TGW, ON_PREMISE)	None
query	destination_type optional	Destination Type Example : `VPC`	enum (VPC, TGW, ON_PREMISE)	None
query	destination_cidr optional	Destination CIDR Example : `192.167.5.0/24`	any of [string, null]	None
query	state optional	State Example : `ACTIVE`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Routing Rule Description",
            "destination_cidr": "192.167.5.0/24",
            "destination_resource_id": "ceb44ea5ecb34a49b16495f9a63b0718",
            "destination_resource_name": "VpcName",
            "destination_type": "VPC",
            "id": "43772aff4539403d9ba74bf1fdaa00c8",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "source_resource_id": "8582cc5d89994a42ad53282fd4a8d8be",
            "source_resource_name": "TgwName",
            "source_type": "TGW",
            "state": "ACTIVE",
            "tgw_connection_vpc_id": "ffeced8e191c478eabd66b6e2cab8e34",
            "tgw_connection_vpc_name": "ConnectedVpcName"
        }
    ]
}

8.1.62 - List Transit Gateway VPC Connections

8.1.62.1 - 1.2

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

Description

Get Transit Gateway VPC Connection list.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	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 : `ffeced8e191c478eabd66b6e2cab8e34`	any of [string, null]	None
query	vpc_id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	vpc_name optional	VPC Name Example : `vpcName`	any of [string, null]	None
query	state optional	State Example : `ACTIVE`	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.2"

Example HTTP response

Response 200

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

8.1.62.2 - 1.1

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

Description

Get Transit Gateway VPC Connection list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	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 : `ffeced8e191c478eabd66b6e2cab8e34`	any of [string, null]	None
query	vpc_id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	vpc_name optional	VPC Name Example : `vpcName`	any of [string, null]	None
query	state optional	State Example : `ACTIVE`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "ffeced8e191c478eabd66b6e2cab8e34",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "ACTIVE",
            "transit_gateway_id": "fe860e0af0c04dcd8182b84f907f31f4",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

8.1.62.3 - 1.0

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

Description

Get Transit Gateway VPC Connection list.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	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 : `ffeced8e191c478eabd66b6e2cab8e34`	any of [string, null]	None
query	vpc_id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	vpc_name optional	VPC Name Example : `vpcName`	any of [string, null]	None
query	state optional	State Example : `ACTIVE`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "ffeced8e191c478eabd66b6e2cab8e34",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "state": "ACTIVE",
            "transit_gateway_id": "fe860e0af0c04dcd8182b84f907f31f4",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

8.1.63 - List Transit Gateways

8.1.63.1 - 1.2

get /v1/transit-gateways

Description

Get Transit Gateway list.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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 : `fe860e0af0c04dcd8182b84f907f31f4`	any of [string, null]	None
query	name optional	Transit Gateway Name Example : `TransitGatewayName`	any of [string, null]	None
query	state optional	State Example : `ACTIVE`	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING), null]	None
query	firewall_connection_state optional	Firewall Connection State Example : `INACTIVE`	any of [enum (ATTACHING, ACTIVE, DETACHING, DELETED, INACTIVE, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	TransitGatewayListResponseV1Dot2
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.2"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "transit_gateways": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "bandwidth": 1,
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "TransitGateway Description",
            "firewall_connection_state": "INACTIVE",
            "firewall_ids": "['bbb93aca123f4bb2b2c0f206f4a86b2b']",
            "id": "fe860e0af0c04dcd8182b84f907f31f4",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "TransitGatewayName",
            "state": "ACTIVE",
            "uplink_enabled": "False"
        }
    ]
}

8.1.63.2 - 1.1

get /v1/transit-gateways

Description

Get Transit Gateway list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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 : `fe860e0af0c04dcd8182b84f907f31f4`	any of [string, null]	None
query	name optional	Transit Gateway Name Example : `TransitGatewayName`	any of [string, null]	None
query	state optional	State Example : `ACTIVE`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
            "bandwidth": 1,
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "TransitGateway Description",
            "firewall_ids": "['bbb93aca123f4bb2b2c0f206f4a86b2b']",
            "id": "fe860e0af0c04dcd8182b84f907f31f4",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "TransitGatewayName",
            "state": "ACTIVE",
            "uplink_enabled": "False"
        }
    ]
}

8.1.63.3 - 1.0

get /v1/transit-gateways

Description

Get Transit Gateway list.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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 : `fe860e0af0c04dcd8182b84f907f31f4`	any of [string, null]	None
query	name optional	Transit Gateway Name Example : `TransitGatewayName`	any of [string, null]	None
query	state optional	State Example : `ACTIVE`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
            "bandwidth": 1,
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "TransitGateway Description",
            "firewall_ids": "['bbb93aca123f4bb2b2c0f206f4a86b2b']",
            "id": "fe860e0af0c04dcd8182b84f907f31f4",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "TransitGatewayName",
            "state": "ACTIVE",
            "uplink_enabled": "False"
        }
    ]
}

8.1.64 - List VPC Endpoint

8.1.64.1 - 1.2

get /v1/vpc-endpoints

Description

Get VPC Endpoint list.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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 Endpoint ID Example : `12f56e27070248a6a240a497e43fbe18`	any of [string, null]	None
query	name optional	VPC Endpoint Name Example : `VpcEndpointName`	any of [string, null]	None
query	vpc_id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	vpc_name optional	VPC Name Example : `vpcName`	any of [string, null]	None
query	subnet_id optional	Subnet Id Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	resource_key optional	VPC Endpoint Resource Key Example : `07c5364702384471b650147321b52173`	any of [string, null]	None
query	resource_type optional	VPC Endpoint Resource Type Example : `FS`	any of [enum (FS, OBS, SCR, DNS), null]	None
query	endpoint_ip_address optional	VPC Endpoint IP Address Example : `192.167.0.5`	any of [string, null]	None
query	state optional	VPC Endpoint State Example : `ACTIVE`	any of [enum (CREATING, ACTIVE, DELETING, DELETED, ERROR), null]	None

Responses

HTTP Code	Description	Schema
200	OK	VpcEndpointListResponseV1Dot2
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.2"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpc_endpoints": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "VpcEndpoint Description",
            "endpoint_ip_address": "192.167.0.5",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "VpcEndpointName",
            "resource_info": "x.samsungsdscloud.com(Registry)",
            "resource_key": "07c5364702384471b650147321b52173",
            "resource_type": "FS",
            "state": "ACTIVE",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "subnet_name": "subnetName",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

8.1.64.2 - 1.1

get /v1/vpc-endpoints

Description

Get VPC Endpoint list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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 : `12f56e27070248a6a240a497e43fbe18`	any of [string, null]	None
query	name optional	VPC Endpoint Name Example : `VpcEndpointName`	any of [string, null]	None
query	vpc_id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	vpc_name optional	VPC Name Example : `vpcName`	any of [string, null]	None
query	subnet_id optional	Subnet Id Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	resource_key optional	VPC Endpoint Resource Key Example : `07c5364702384471b650147321b52173`	any of [string, null]	None
query	resource_type optional	VPC Endpoint Resource Type Example : `FS`	any of [enum (FS, OBS, SCR, DNS), null]	None
query	endpoint_ip_address optional	VPC Endpoint IP Address Example : `192.167.0.5`	any of [string, null]	None
query	state optional	VPC Endpoint State Example : `ACTIVE`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "VpcEndpoint Description",
            "endpoint_ip_address": "192.167.0.5",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "VpcEndpointName",
            "resource_info": "x.samsungsdscloud.com(Registry)",
            "resource_key": "07c5364702384471b650147321b52173",
            "resource_type": "FS",
            "state": "ACTIVE",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "subnet_name": "subnetName",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

8.1.64.3 - 1.0

get /v1/vpc-endpoints

Description

Get VPC Endpoint list.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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 : `12f56e27070248a6a240a497e43fbe18`	any of [string, null]	None
query	name optional	VPC Endpoint Name Example : `VpcEndpointName`	any of [string, null]	None
query	vpc_id optional	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	vpc_name optional	VPC Name Example : `vpcName`	any of [string, null]	None
query	subnet_id optional	Subnet Id Example : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	resource_key optional	VPC Endpoint Resource Key Example : `07c5364702384471b650147321b52173`	any of [string, null]	None
query	resource_type optional	VPC Endpoint Resource Type Example : `FS`	any of [enum (FS, OBS, SCR, DNS), null]	None
query	endpoint_ip_address optional	VPC Endpoint IP Address Example : `192.167.0.5`	any of [string, null]	None
query	state optional	VPC Endpoint State Example : `ACTIVE`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "VpcEndpoint Description",
            "endpoint_ip_address": "192.167.0.5",
            "id": "12f56e27070248a6a240a497e43fbe18",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "VpcEndpointName",
            "resource_info": "x.samsungsdscloud.com(Registry)",
            "resource_key": "07c5364702384471b650147321b52173",
            "resource_type": "FS",
            "state": "ACTIVE",
            "subnet_id": "023c57b14f11483689338d085e061492",
            "subnet_name": "subnetName",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

8.1.65 - List VPC Endpoint Connectable Resources

8.1.65.1 - 1.2

get /v1/vpc-endpoints/connectable-resources

Description

List VpcEndpoint connectable resources

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

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

Responses

HTTP Code	Description	Schema
200	OK	VpcEndpointConnectableResourceListResponseV1Dot2
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.2"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpc_endpoint_connectable_resources": [
        {
            "resource_info": "x.samsungsdscloud.com(Registry)",
            "resource_key": "07c5364702384471b650147321b52173",
            "resource_type": "FS"
        }
    ]
}

8.1.65.2 - 1.1

get /v1/vpc-endpoints/connectable-resources

Description

List VpcEndpoint connectable resources

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
query	resource_type required	VPC Endpoint Resource Type Example : `FS`	enum (FS, OBS, SCR, DNS)	None
query	vpc_id optional	VPC ID(required if resource_type is DNS) Example : `7df8abb4912e4709b1cb237daccca7a8`	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": "x.samsungsdscloud.com(Registry)",
            "resource_key": "07c5364702384471b650147321b52173",
            "resource_type": "FS"
        }
    ]
}

8.1.65.3 - 1.0

get /v1/vpc-endpoints/connectable-resources

Description

List VpcEndpoint connectable resources

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	resource_type required	VPC Endpoint Resource Type Example : `FS`	enum (FS, OBS, SCR, DNS)	None
query	vpc_id optional	VPC ID(required if resource_type is DNS) Example : `7df8abb4912e4709b1cb237daccca7a8`	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": "x.samsungsdscloud.com(Registry)",
            "resource_key": "07c5364702384471b650147321b52173",
            "resource_type": "FS"
        }
    ]
}

8.1.66 - List VPC Peering

8.1.66.1 - 1.2

get /v1/vpc-peerings

Description

Get VPC Peering list.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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 : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	name optional	VPC Peering Name Example : `vpcPeeringName`	any of [string, null]	None
query	requester_vpc_id optional	Requester VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	requester_vpc_name optional	Requester VPC Name Example : `vpcName`	any of [string, null]	None
query	approver_vpc_id optional	Approver VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	approver_vpc_name optional	Approver VPC Name Example : `vpcName`	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.2"

Example HTTP response

Response 200

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

8.1.66.2 - 1.1

get /v1/vpc-peerings

Description

Get VPC Peering list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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 : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	name optional	VPC Peering Name Example : `vpcPeeringName`	any of [string, null]	None
query	requester_vpc_id optional	Requester VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	requester_vpc_name optional	Requester VPC Name Example : `vpcName`	any of [string, null]	None
query	approver_vpc_id optional	Approver VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	approver_vpc_name optional	Approver VPC Name Example : `vpcName`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
            "approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "approver_vpc_name": "vpcName",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "description": "vpcPeering Description",
            "id": "023c57b14f11483689338d085e061492",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "vpcPeeringName",
            "requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "requester_vpc_name": "vpcName",
            "state": "CREATING"
        }
    ]
}

8.1.66.3 - 1.0

get /v1/vpc-peerings

Description

Get VPC Peering list.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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 : `023c57b14f11483689338d085e061492`	any of [string, null]	None
query	name optional	VPC Peering Name Example : `vpcPeeringName`	any of [string, null]	None
query	requester_vpc_id optional	Requester VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	requester_vpc_name optional	Requester VPC Name Example : `vpcName`	any of [string, null]	None
query	approver_vpc_id optional	Approver VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	approver_vpc_name optional	Approver VPC Name Example : `vpcName`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
            "approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "approver_vpc_name": "vpcName",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "description": "vpcPeering Description",
            "id": "023c57b14f11483689338d085e061492",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "vpcPeeringName",
            "requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "requester_vpc_name": "vpcName",
            "state": "CREATING"
        }
    ]
}

8.1.67 - List VPC Peering Rules

8.1.67.1 - 1.2

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

Description

Get VPC Peering Rule list.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering 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
query	id optional	VPC Peering Rule ID 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.2"

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": ""
        }
    ]
}

8.1.67.2 - 1.1

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

Description

Get VPC Peering Rule list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering 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
query	id optional	VPC Peering Rule ID 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
query	name optional	VPC Peering Name Example :	any of [string, 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": ""
        }
    ]
}

8.1.67.3 - 1.0

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

Description

Get VPC Peering Rule list.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering 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
query	id optional	VPC Peering Rule ID 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
query	name optional	VPC Peering Name Example :	any of [string, 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": ""
        }
    ]
}

8.1.68 - List VPCs

8.1.68.1 - 1.2

get /v1/vpcs

Description

Get VPC list.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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 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	VpcListResponseV1Dot2
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.2"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "vpcs": [
        {
            "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
            "cidr_count": 20,
            "cidrs": [
                {
                    "cidr": "192.167.0.0/18",
                    "created_at": "2024-05-17T00:23:17Z",
                    "created_by": "7df8abb4912e4709b1cb237daccca7a8",
                    "id": "7df8abb4912e4709b1cb237daccca7a8"
                }
            ],
            "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"
        }
    ]
}

8.1.68.2 - 1.1

get /v1/vpcs

Description

Get VPC list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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"
        }
    ]
}

8.1.68.3 - 1.0

get /v1/vpcs

Description

Get VPC list.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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"
        }
    ]
}

8.1.69 - Request PrivateLink Endpoint

8.1.69.1 - 1.2

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

Description

Request PrivateLink Endpoint

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example : `bba6d4de3ad64e41b3a1b6c88983ec02`	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.2"

Request body

{
    "type": "CANCEL"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Endpoint Description",
        "endpoint_ip_address": "192.167.1.5",
        "endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "EndpointName",
        "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

8.1.69.2 - 1.1

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

Description

Request PrivateLink Endpoint

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example : `bba6d4de3ad64e41b3a1b6c88983ec02`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Endpoint Description",
        "endpoint_ip_address": "192.167.1.5",
        "endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "EndpointName",
        "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

8.1.70 - Set Internet Gateway

8.1.70.1 - 1.2

put /v1/internet-gateways/{internet_gateway_id}

Description

Set Internet Gateway.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	internet_gateway_id required	Internet Gateway ID Example : `023c57b14f11483689338d085e061492`	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.2"

Request body

{
    "description": "Internet Gateway Description",
    "loggable": ""
}

Example HTTP response

Response 200

{
    "internet_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Internet Gateway Description",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "023c57b14f11483689338d085e061492",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "IGW_VPCname",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.70.2 - 1.1

put /v1/internet-gateways/{internet_gateway_id}

Description

Set Internet Gateway.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	internet_gateway_id required	Internet Gateway ID Example : `023c57b14f11483689338d085e061492`	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": "Internet Gateway Description",
    "loggable": ""
}

Example HTTP response

Response 200

{
    "internet_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Internet Gateway Description",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "023c57b14f11483689338d085e061492",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "IGW_VPCname",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.70.3 - 1.0

put /v1/internet-gateways/{internet_gateway_id}

Description

Set Internet Gateway.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	internet_gateway_id required	Internet Gateway ID Example : `023c57b14f11483689338d085e061492`	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": "Internet Gateway Description",
    "loggable": ""
}

Example HTTP response

Response 200

{
    "internet_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Internet Gateway Description",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "023c57b14f11483689338d085e061492",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "IGW_VPCname",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.71 - Set NAT Gateway

8.1.71.1 - 1.2

put /v1/nat-gateways/{nat_gateway_id}

Description

Set NAT Gateway.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	nat_gateway_id required	NAT Gateway ID Example : `12f56e27070248a6a240a497e43fbe18`	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.2"

Request body

{
    "description": "VpcEndpoint Description"
}

Example HTTP response

Response 200

{
    "nat_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "NatGatewayName",
        "nat_gateway_ip_address": "192.167.0.5",
        "publicip_id": "12f56e27070248a6a240a497e43fbe18",
        "state": "ACTIVE",
        "subnet_cidr": "192.167.1.0/24",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.71.2 - 1.1

put /v1/nat-gateways/{nat_gateway_id}

Description

Set NAT Gateway.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	nat_gateway_id required	NAT Gateway ID Example : `12f56e27070248a6a240a497e43fbe18`	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": "VpcEndpoint Description"
}

Example HTTP response

Response 200

{
    "nat_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "NatGatewayName",
        "nat_gateway_ip_address": "192.167.0.5",
        "publicip_id": "12f56e27070248a6a240a497e43fbe18",
        "state": "ACTIVE",
        "subnet_cidr": "192.167.1.0/24",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.71.3 - 1.0

put /v1/nat-gateways/{nat_gateway_id}

Description

Set NAT Gateway.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	nat_gateway_id required	NAT Gateway ID Example : `12f56e27070248a6a240a497e43fbe18`	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": "VpcEndpoint Description"
}

Example HTTP response

Response 200

{
    "nat_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "NatGatewayName",
        "nat_gateway_ip_address": "192.167.0.5",
        "publicip_id": "12f56e27070248a6a240a497e43fbe18",
        "state": "ACTIVE",
        "subnet_cidr": "192.167.1.0/24",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.72 - Set Port

8.1.72.1 - 1.2

put /v1/ports/{port_id}

Description

Set port.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	port_id required	Port ID Example : `023c57b1-4f11-4836-8933-8d085e061492`	string	None
body	body required		PortSetRequest

Responses

HTTP Code	Description	Schema
200	OK	PortShowResponseV1Dot2
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.2"

Request body

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

Example HTTP response

Response 200

{
    "port": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
        "attached_resource_type": "",
        "created_at": "2026-04-14T15:07:04.958Z",
        "description": "Port Description",
        "fixed_ip_address": "192.168.1.100",
        "id": "023c57b1-4f11-4836-8933-8d085e061492",
        "mac_address": "fa:16:3e:00:00:01",
        "modified_at": "2026-04-14T15:07:04.958Z",
        "name": "portName",
        "security_groups": [
            {
                "id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
                "name": "sgName"
            }
        ],
        "state": "",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "virtual_ip_addresses": [
            ""
        ],
        "vpc_id": "071bc63b767444c9afaab1c972d302d5",
        "vpc_name": "vpcName"
    }
}

8.1.72.2 - 1.1

put /v1/ports/{port_id}

Description

Set port.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	port_id required	Port ID Example : `023c57b1-4f11-4836-8933-8d085e061492`	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": "Port Description",
    "security_groups": [
        ""
    ]
}

Example HTTP response

Response 200

{
    "port": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
        "attached_resource_type": "",
        "created_at": "2026-04-14T15:07:03.265Z",
        "description": "Port Description",
        "fixed_ip_address": "192.168.1.100",
        "id": "023c57b1-4f11-4836-8933-8d085e061492",
        "mac_address": "fa:16:3e:00:00:01",
        "modified_at": "2026-04-14T15:07:03.265Z",
        "name": "portName",
        "security_groups": [
            {
                "id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
                "name": "sgName"
            }
        ],
        "state": "",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "071bc63b767444c9afaab1c972d302d5",
        "vpc_name": "vpcName"
    }
}

8.1.72.3 - 1.0

put /v1/ports/{port_id}

Description

Set port.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	port_id required	Port ID Example : `023c57b1-4f11-4836-8933-8d085e061492`	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": "Port Description",
    "security_groups": [
        ""
    ]
}

Example HTTP response

Response 200

{
    "port": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
        "attached_resource_type": "",
        "created_at": "2026-04-14T15:07:01.889Z",
        "description": "Port Description",
        "fixed_ip_address": "192.168.1.100",
        "id": "023c57b1-4f11-4836-8933-8d085e061492",
        "mac_address": "fa:16:3e:00:00:01",
        "modified_at": "2026-04-14T15:07:01.889Z",
        "name": "portName",
        "security_groups": [
            {
                "id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
                "name": "sgName"
            }
        ],
        "state": "",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "071bc63b767444c9afaab1c972d302d5",
        "vpc_name": "vpcName"
    }
}

8.1.73 - Set Private NAT

8.1.73.1 - 1.2

put /v1/private-nats/{private_nat_id}

Description

Set Private NAT.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

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

Responses

HTTP Code	Description	Schema
200	OK	PrivateNatShowResponseV1Dot2
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.2"

Request body

{
    "description": "PrivateNat Description"
}

Example HTTP response

Response 200

{
    "private_nat": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateNat Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "PrivateNatName",
        "service_resource_id": "3f342bf9a557405b997c2cf48c89cbc2",
        "service_resource_name": "PrivateNatName",
        "service_type": "DIRECT_CONNECT",
        "state": "ACTIVE"
    }
}

8.1.73.2 - 1.1

put /v1/private-nats/{private_nat_id}

Description

Set Private NAT.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example : `12f56e27070248a6a240a497e43fbe18`	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": "PrivateNat Description"
}

Example HTTP response

Response 200

{
    "private_nat": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateNat Description",
        "direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
        "direct_connect_name": "DirectConnectName",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "PrivateNatName",
        "state": "ACTIVE",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.73.3 - 1.0

put /v1/private-nats/{private_nat_id}

Description

Set Private NAT.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example : `12f56e27070248a6a240a497e43fbe18`	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": "PrivateNat Description"
}

Example HTTP response

Response 200

{
    "private_nat": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateNat Description",
        "direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
        "direct_connect_name": "DirectConnectName",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "PrivateNatName",
        "state": "ACTIVE",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.74 - Set PrivateLink Endpoint

8.1.74.1 - 1.2

put /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

Set PrivateLink Endpoint.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example : `bba6d4de3ad64e41b3a1b6c88983ec02`	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.2"

Request body

{
    "description": "PrivateLink Endpoint Description"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Endpoint Description",
        "endpoint_ip_address": "192.167.1.5",
        "endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "EndpointName",
        "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

8.1.74.2 - 1.1

put /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

Set PrivateLink Endpoint.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example : `bba6d4de3ad64e41b3a1b6c88983ec02`	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": "PrivateLink Endpoint Description"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Endpoint Description",
        "endpoint_ip_address": "192.167.1.5",
        "endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "EndpointName",
        "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

8.1.75 - Set PrivateLink Service

8.1.75.1 - 1.2

put /v1/privatelink-services/{privatelink_service_id}

Description

Set PrivateLink Service.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_service_id required	PrivateLink Service ID Example : `e3df2e8e3b374fbb81d4e322b52ca50d`	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.2"

Request body

{
    "description": "PrivateLink Service Description"
}

Example HTTP response

Response 200

{
    "privatelink_service": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
        "connected_resource_ip_address": "192.167.0.10",
        "connected_resource_name": "lbResourceName",
        "connected_resource_type": "LB",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Service Description",
        "high_speed_transfer": false,
        "id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServiceName",
        "security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
        "service_ip_address": "192.167.0.5",
        "service_ip_port_id": "d21a4b81-f52a-43a8-b985-341e763458bb",
        "state": "CREATING",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

8.1.75.2 - 1.1

put /v1/privatelink-services/{privatelink_service_id}

Description

Set PrivateLink Service.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	privatelink_service_id required	PrivateLink Service ID Example : `e3df2e8e3b374fbb81d4e322b52ca50d`	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": "PrivateLink Service Description"
}

Example HTTP response

Response 200

{
    "privatelink_service": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
        "connected_resource_ip_address": "192.167.0.10",
        "connected_resource_name": "lbResourceName",
        "connected_resource_type": "LB",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Service Description",
        "high_speed_transfer": false,
        "id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServiceName",
        "security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
        "service_ip_address": "192.167.0.5",
        "service_ip_port_id": "d21a4b81-f52a-43a8-b985-341e763458bb",
        "state": "CREATING",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

8.1.76 - Set PublicIP

8.1.76.1 - 1.2

put /v1/publicips/{publicip_id}

Description

Set PublicIP.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	publicip_id required	PublicIP ID Example : `12f56e27070248a6a240a497e43fbe18`	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.2"

Request body

{
    "description": "Public IP Description"
}

Example HTTP response

Response 200

{
    "publicip": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
        "attached_resource_name": "Attached NAT Gateway Name",
        "attached_resource_type": "NAT_GW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Public IP Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "ip_address": "192.167.0.5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ATTACHED",
        "type": "IGW"
    }
}

8.1.76.2 - 1.1

put /v1/publicips/{publicip_id}

Description

Set PublicIP.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	publicip_id required	PublicIP ID Example : `12f56e27070248a6a240a497e43fbe18`	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": "Public IP Description"
}

Example HTTP response

Response 200

{
    "publicip": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
        "attached_resource_name": "Attached NAT Gateway Name",
        "attached_resource_type": "NAT_GW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Public IP Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "ip_address": "192.167.0.5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ATTACHED",
        "type": "IGW"
    }
}

8.1.76.3 - 1.0

put /v1/publicips/{publicip_id}

Description

Set PublicIP.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	publicip_id required	PublicIP ID Example : `12f56e27070248a6a240a497e43fbe18`	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": "Public IP Description"
}

Example HTTP response

Response 200

{
    "publicip": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
        "attached_resource_name": "Attached NAT Gateway Name",
        "attached_resource_type": "NAT_GW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Public IP Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "ip_address": "192.167.0.5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ATTACHED",
        "type": "IGW"
    }
}

8.1.77 - Set Subnet

8.1.77.1 - 1.2

put /v1/subnets/{subnet_id}

Description

Set subnet.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

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

Responses

HTTP Code	Description	Schema
200	OK	SubnetShowResponseV1Dot2
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.2"

Request body

{
    "description": "Subnet Description",
    "dhcp_ip_address": ""
}

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",
        "dhcp_ip_address": "",
        "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"
    }
}

8.1.77.2 - 1.1

put /v1/subnets/{subnet_id}

Description

Set subnet.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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"
    }
}

8.1.77.3 - 1.0

put /v1/subnets/{subnet_id}

Description

Set subnet.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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"
    }
}

8.1.78 - Set Subnet Vip

8.1.78.1 - 1.2

put /v1/subnets/{subnet_id}/vips/{vip_id}

Description

Set Subnet Vip

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	subnet_id required	Subnet ID Example : `023c57b14f11483689338d085e061492`	string	None
path	vip_id required	Subnet Vip Id Example : `0466a9448d9a4411a86055939e451c8f`	string	None
body	body required		VipSetRequest

Responses

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

Example HTTP request

Request path

/v1/subnets/{subnet_id}/vips/{vip_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.2"

Request body

{
    "description": "Subnet VIP Description"
}

Example HTTP response

Response 200

{
    "subnet_vip": {
        "connected_ports": [
            {
                "attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
                "attached_resource_type": "Virtual Server",
                "id": "13e2a5a1acbe4713a9a2c70ce226e822",
                "port_id": "8b4705d3-43b7-4fad-8648-a5a1a90c31d0",
                "port_ip_address": "192.168.20.5",
                "port_name": "Port name"
            }
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet VIP Description",
        "id": "0466a9448d9a4411a86055939e451c8f",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ACTIVE",
        "static_nat": {
            "external_ip_address": "100.112.9.84",
            "id": "0009e49548154745948e9722adefbf40",
            "publicip_id": "12f56e27070248a6a240a497e43fbe18",
            "state": "ACTIVE"
        },
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vip_port_id": "35268a9f2eda4cde83b1d85c1f61f67d",
        "virtual_ip_address": "192.168.20.6"
    }
}

8.1.79 - Set Transit Gateway

8.1.79.1 - 1.2

put /v1/transit-gateways/{transit_gateway_id}

Description

Set Transit Gateway.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

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

Responses

HTTP Code	Description	Schema
200	OK	TransitGatewayShowResponseV1Dot2
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.2"

Request body

{
    "description": "TransitGateway Description"
}

Example HTTP response

Response 200

{
    "transit_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "firewall_connection_state": "INACTIVE",
        "firewall_ids": "['bbb93aca123f4bb2b2c0f206f4a86b2b']",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "TransitGatewayName",
        "state": "ACTIVE",
        "uplink_enabled": "False"
    }
}

8.1.79.2 - 1.1

put /v1/transit-gateways/{transit_gateway_id}

Description

Set Transit Gateway.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	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": "TransitGateway Description"
}

Example HTTP response

Response 200

{
    "transit_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "firewall_ids": "['bbb93aca123f4bb2b2c0f206f4a86b2b']",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "TransitGatewayName",
        "state": "ACTIVE",
        "uplink_enabled": "False"
    }
}

8.1.79.3 - 1.0

put /v1/transit-gateways/{transit_gateway_id}

Description

Set Transit Gateway.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	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": "TransitGateway Description"
}

Example HTTP response

Response 200

{
    "transit_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "firewall_ids": "['bbb93aca123f4bb2b2c0f206f4a86b2b']",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "TransitGatewayName",
        "state": "ACTIVE",
        "uplink_enabled": "False"
    }
}

8.1.80 - Set VPC

8.1.80.1 - 1.2

put /v1/vpcs/{vpc_id}

Description

Set VPC.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

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	VpcShowResponseV1Dot2
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.2"

Request body

{
    "description": "vpcDescription"
}

Example HTTP response

Response 200

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr_count": 20,
        "cidrs": [
            {
                "cidr": "192.167.0.0/18",
                "created_at": "2024-05-17T00:23:17Z",
                "created_by": "7df8abb4912e4709b1cb237daccca7a8",
                "id": "7df8abb4912e4709b1cb237daccca7a8"
            }
        ],
        "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"
    }
}

8.1.80.2 - 1.1

put /v1/vpcs/{vpc_id}

Description

Set VPC.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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"
    }
}

8.1.80.3 - 1.0

put /v1/vpcs/{vpc_id}

Description

Set VPC.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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"
    }
}

8.1.81 - Set VPC Endpoint

8.1.81.1 - 1.2

put /v1/vpc-endpoints/{vpc_endpoint_id}

Description

Set VPC Endpoint.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_endpoint_id required	VPC Endpoint ID Example : `12f56e27070248a6a240a497e43fbe18`	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.2"

Request body

{
    "description": "VpcEndpoint Description"
}

Example HTTP response

Response 200

{
    "vpc_endpoint": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "endpoint_ip_address": "192.167.0.5",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "VpcEndpointName",
        "resource_info": "x.samsungsdscloud.com(Registry)",
        "resource_key": "07c5364702384471b650147321b52173",
        "resource_type": "FS",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.81.2 - 1.1

put /v1/vpc-endpoints/{vpc_endpoint_id}

Description

Set VPC Endpoint.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	vpc_endpoint_id required	VPC Endpoint ID Example : `12f56e27070248a6a240a497e43fbe18`	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": "VpcEndpoint Description"
}

Example HTTP response

Response 200

{
    "vpc_endpoint": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "endpoint_ip_address": "192.167.0.5",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "VpcEndpointName",
        "resource_info": "x.samsungsdscloud.com(Registry)",
        "resource_key": "07c5364702384471b650147321b52173",
        "resource_type": "FS",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.81.3 - 1.0

put /v1/vpc-endpoints/{vpc_endpoint_id}

Description

Set VPC Endpoint.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_endpoint_id required	VPC Endpoint ID Example : `12f56e27070248a6a240a497e43fbe18`	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": "VpcEndpoint Description"
}

Example HTTP response

Response 200

{
    "vpc_endpoint": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "endpoint_ip_address": "192.167.0.5",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "VpcEndpointName",
        "resource_info": "x.samsungsdscloud.com(Registry)",
        "resource_key": "07c5364702384471b650147321b52173",
        "resource_type": "FS",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.82 - Set VPC Peering

8.1.82.1 - 1.2

put /v1/vpc-peerings/{vpc_peering_id}

Description

Set VPC Peering.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example : `023c57b14f11483689338d085e061492`	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.2"

Request body

{
    "description": "vpcPeering Description"
}

Example HTTP response

Response 200

{
    "vpc_peering": {
        "account_type": "SAME",
        "approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "approver_vpc_name": "vpcName",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "description": "vpcPeering Description",
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcPeeringName",
        "requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "requester_vpc_name": "vpcName",
        "state": "CREATING"
    }
}

8.1.82.2 - 1.1

put /v1/vpc-peerings/{vpc_peering_id}

Description

Set VPC Peering.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example : `023c57b14f11483689338d085e061492`	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": "vpcPeering Description"
}

Example HTTP response

Response 200

{
    "vpc_peering": {
        "account_type": "SAME",
        "approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "approver_vpc_name": "vpcName",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "description": "vpcPeering Description",
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcPeeringName",
        "requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "requester_vpc_name": "vpcName",
        "state": "CREATING"
    }
}

8.1.82.3 - 1.0

put /v1/vpc-peerings/{vpc_peering_id}

Description

Set VPC Peering.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example : `023c57b14f11483689338d085e061492`	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": "vpcPeering Description"
}

Example HTTP response

Response 200

{
    "vpc_peering": {
        "account_type": "SAME",
        "approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "approver_vpc_name": "vpcName",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "description": "vpcPeering Description",
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcPeeringName",
        "requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "requester_vpc_name": "vpcName",
        "state": "CREATING"
    }
}

8.1.83 - Show Internet Gateway

8.1.83.1 - 1.2

get /v1/internet-gateways/{internet_gateway_id}

Description

Show Internet Gateway.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	internet_gateway_id required	Internet Gateway ID Example : `023c57b14f11483689338d085e061492`	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.2"

Example HTTP response

Response 200

{
    "internet_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Internet Gateway Description",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "023c57b14f11483689338d085e061492",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "IGW_VPCname",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.83.2 - 1.1

get /v1/internet-gateways/{internet_gateway_id}

Description

Show Internet Gateway.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	internet_gateway_id required	Internet Gateway ID Example : `023c57b14f11483689338d085e061492`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Internet Gateway Description",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "023c57b14f11483689338d085e061492",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "IGW_VPCname",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.83.3 - 1.0

get /v1/internet-gateways/{internet_gateway_id}

Description

Show Internet Gateway.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	internet_gateway_id required	Internet Gateway ID Example : `023c57b14f11483689338d085e061492`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Internet Gateway Description",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "023c57b14f11483689338d085e061492",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "IGW_VPCname",
        "state": "CREATING",
        "type": "IGW",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.84 - Show NAT Gateway

8.1.84.1 - 1.2

get /v1/nat-gateways/{nat_gateway_id}

Description

Show NAT Gateway.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	nat_gateway_id required	NAT Gateway ID Example : `12f56e27070248a6a240a497e43fbe18`	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.2"

Example HTTP response

Response 200

{
    "nat_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "NatGatewayName",
        "nat_gateway_ip_address": "192.167.0.5",
        "publicip_id": "12f56e27070248a6a240a497e43fbe18",
        "state": "ACTIVE",
        "subnet_cidr": "192.167.1.0/24",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.84.2 - 1.1

get /v1/nat-gateways/{nat_gateway_id}

Description

Show NAT Gateway.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	nat_gateway_id required	NAT Gateway ID Example : `12f56e27070248a6a240a497e43fbe18`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "NatGatewayName",
        "nat_gateway_ip_address": "192.167.0.5",
        "publicip_id": "12f56e27070248a6a240a497e43fbe18",
        "state": "ACTIVE",
        "subnet_cidr": "192.167.1.0/24",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.84.3 - 1.0

get /v1/nat-gateways/{nat_gateway_id}

Description

Show NAT Gateway.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	nat_gateway_id required	NAT Gateway ID Example : `12f56e27070248a6a240a497e43fbe18`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "NatGatewayName",
        "nat_gateway_ip_address": "192.167.0.5",
        "publicip_id": "12f56e27070248a6a240a497e43fbe18",
        "state": "ACTIVE",
        "subnet_cidr": "192.167.1.0/24",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.85 - Show Port

8.1.85.1 - 1.2

get /v1/ports/{port_id}

Description

Show port.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	port_id required	Port ID Example : `023c57b1-4f11-4836-8933-8d085e061492`	string	None

Responses

HTTP Code	Description	Schema
200	OK	PortShowResponseV1Dot2
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.2"

Example HTTP response

Response 200

{
    "port": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
        "attached_resource_type": "",
        "created_at": "2026-04-14T15:07:04.940Z",
        "description": "Port Description",
        "fixed_ip_address": "192.168.1.100",
        "id": "023c57b1-4f11-4836-8933-8d085e061492",
        "mac_address": "fa:16:3e:00:00:01",
        "modified_at": "2026-04-14T15:07:04.940Z",
        "name": "portName",
        "security_groups": [
            {
                "id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
                "name": "sgName"
            }
        ],
        "state": "",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "virtual_ip_addresses": [
            ""
        ],
        "vpc_id": "071bc63b767444c9afaab1c972d302d5",
        "vpc_name": "vpcName"
    }
}

8.1.85.2 - 1.1

get /v1/ports/{port_id}

Description

Show port.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	port_id required	Port ID Example : `023c57b1-4f11-4836-8933-8d085e061492`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
        "attached_resource_type": "",
        "created_at": "2026-04-14T15:07:03.247Z",
        "description": "Port Description",
        "fixed_ip_address": "192.168.1.100",
        "id": "023c57b1-4f11-4836-8933-8d085e061492",
        "mac_address": "fa:16:3e:00:00:01",
        "modified_at": "2026-04-14T15:07:03.247Z",
        "name": "portName",
        "security_groups": [
            {
                "id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
                "name": "sgName"
            }
        ],
        "state": "",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "071bc63b767444c9afaab1c972d302d5",
        "vpc_name": "vpcName"
    }
}

8.1.85.3 - 1.0

get /v1/ports/{port_id}

Description

Show port.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	port_id required	Port ID Example : `023c57b1-4f11-4836-8933-8d085e061492`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
        "attached_resource_type": "",
        "created_at": "2026-04-14T15:07:01.872Z",
        "description": "Port Description",
        "fixed_ip_address": "192.168.1.100",
        "id": "023c57b1-4f11-4836-8933-8d085e061492",
        "mac_address": "fa:16:3e:00:00:01",
        "modified_at": "2026-04-14T15:07:01.872Z",
        "name": "portName",
        "security_groups": [
            {
                "id": "02fb574c-f30f-40e1-9f43-4d1572dee5bd",
                "name": "sgName"
            }
        ],
        "state": "",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "071bc63b767444c9afaab1c972d302d5",
        "vpc_name": "vpcName"
    }
}

8.1.86 - Show Private NAT

8.1.86.1 - 1.2

get /v1/private-nats/{private_nat_id}

Description

Show Private NAT.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

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

Responses

HTTP Code	Description	Schema
200	OK	PrivateNatShowResponseV1Dot2
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.2"

Example HTTP response

Response 200

{
    "private_nat": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateNat Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "PrivateNatName",
        "service_resource_id": "3f342bf9a557405b997c2cf48c89cbc2",
        "service_resource_name": "PrivateNatName",
        "service_type": "DIRECT_CONNECT",
        "state": "ACTIVE"
    }
}

8.1.86.2 - 1.1

get /v1/private-nats/{private_nat_id}

Description

Show Private NAT.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example : `12f56e27070248a6a240a497e43fbe18`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateNat Description",
        "direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
        "direct_connect_name": "DirectConnectName",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "PrivateNatName",
        "state": "ACTIVE",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.86.3 - 1.0

get /v1/private-nats/{private_nat_id}

Description

Show Private NAT.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	private_nat_id required	Private NAT ID Example : `12f56e27070248a6a240a497e43fbe18`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr": "192.167.0.0/24",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateNat Description",
        "direct_connect_id": "fe860e0af0c04dcd8182b84f907f31f4",
        "direct_connect_name": "DirectConnectName",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "PrivateNatName",
        "state": "ACTIVE",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.87 - Show PrivateLink Endpoint

8.1.87.1 - 1.2

get /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

Show PrivateLink Endpoint.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example : `bba6d4de3ad64e41b3a1b6c88983ec02`	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.2"

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Endpoint Description",
        "endpoint_ip_address": "192.167.1.5",
        "endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "EndpointName",
        "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

8.1.87.2 - 1.1

get /v1/privatelink-endpoints/{privatelink_endpoint_id}

Description

Show PrivateLink Endpoint.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	privatelink_endpoint_id required	PrivateLink Endpoint ID Example : `bba6d4de3ad64e41b3a1b6c88983ec02`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Endpoint Description",
        "endpoint_ip_address": "192.167.1.5",
        "endpoint_ip_port_id": "b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e",
        "id": "bba6d4de3ad64e41b3a1b6c88983ec02",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "EndpointName",
        "privatelink_service_id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "security_group_ids": "['17776b52-0a64-440d-9e93-b4fc37be935b']",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

8.1.88 - Show PrivateLink Service

8.1.88.1 - 1.2

get /v1/privatelink-services/{privatelink_service_id}

Description

Show PrivateLink Service.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	privatelink_service_id required	PrivateLink Service ID Example : `e3df2e8e3b374fbb81d4e322b52ca50d`	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.2"

Example HTTP response

Response 200

{
    "privatelink_service": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
        "connected_resource_ip_address": "192.167.0.10",
        "connected_resource_name": "lbResourceName",
        "connected_resource_type": "LB",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Service Description",
        "high_speed_transfer": false,
        "id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServiceName",
        "security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
        "service_ip_address": "192.167.0.5",
        "service_ip_port_id": "d21a4b81-f52a-43a8-b985-341e763458bb",
        "state": "CREATING",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

8.1.88.2 - 1.1

get /v1/privatelink-services/{privatelink_service_id}

Description

Show PrivateLink Service.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	privatelink_service_id required	PrivateLink Service ID Example : `e3df2e8e3b374fbb81d4e322b52ca50d`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approval_type": "AUTO",
        "connected_resource_id": "a3e3a662a4f34442a94166df5ff9f577",
        "connected_resource_ip_address": "192.167.0.10",
        "connected_resource_name": "lbResourceName",
        "connected_resource_type": "LB",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "PrivateLink Service Description",
        "high_speed_transfer": false,
        "id": "e3df2e8e3b374fbb81d4e322b52ca50d",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ServiceName",
        "security_group_ids": "['00b6af37-73b5-4de2-b080-c295a1a0382e']",
        "service_ip_address": "192.167.0.5",
        "service_ip_port_id": "d21a4b81-f52a-43a8-b985-341e763458bb",
        "state": "CREATING",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8"
    }
}

8.1.89 - Show PublicIP

8.1.89.1 - 1.2

get /v1/publicips/{publicip_id}

Description

Show PublicIP.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	publicip_id required	PublicIP ID Example : `12f56e27070248a6a240a497e43fbe18`	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.2"

Example HTTP response

Response 200

{
    "publicip": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
        "attached_resource_name": "Attached NAT Gateway Name",
        "attached_resource_type": "NAT_GW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Public IP Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "ip_address": "192.167.0.5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ATTACHED",
        "type": "IGW"
    }
}

8.1.89.2 - 1.1

get /v1/publicips/{publicip_id}

Description

Show PublicIP.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	publicip_id required	PublicIP ID Example : `12f56e27070248a6a240a497e43fbe18`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
        "attached_resource_name": "Attached NAT Gateway Name",
        "attached_resource_type": "NAT_GW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Public IP Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "ip_address": "192.167.0.5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ATTACHED",
        "type": "IGW"
    }
}

8.1.89.3 - 1.0

get /v1/publicips/{publicip_id}

Description

Show PublicIP.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	publicip_id required	PublicIP ID Example : `12f56e27070248a6a240a497e43fbe18`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
        "attached_resource_id": "37e6db41f5124184a43251a63124cdc9",
        "attached_resource_name": "Attached NAT Gateway Name",
        "attached_resource_type": "NAT_GW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Public IP Description",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "ip_address": "192.167.0.5",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ATTACHED",
        "type": "IGW"
    }
}

8.1.90 - Show Subnet

8.1.90.1 - 1.2

get /v1/subnets/{subnet_id}

Description

Show subnet.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

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

Responses

HTTP Code	Description	Schema
200	OK	SubnetShowResponseV1Dot2
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.2"

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",
        "dhcp_ip_address": "",
        "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"
    }
}

8.1.90.2 - 1.1

get /v1/subnets/{subnet_id}

Description

Show subnet.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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"
    }
}

8.1.90.3 - 1.0

get /v1/subnets/{subnet_id}

Description

Show subnet.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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"
    }
}

8.1.91 - Show Subnet Vip

8.1.91.1 - 1.2

get /v1/subnets/{subnet_id}/vips/{vip_id}

Description

Show Subnet Vip

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	subnet_id required	Subnet ID Example : `023c57b14f11483689338d085e061492`	string	None
path	vip_id required	Subnet Vip Id Example : `0466a9448d9a4411a86055939e451c8f`	string	None

Responses

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

Example HTTP request

Request path

/v1/subnets/{subnet_id}/vips/{vip_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.2"

Example HTTP response

Response 200

{
    "subnet_vip": {
        "connected_ports": [
            {
                "attached_resource_id": "9387e8f51de04a03994de8a9c3524935",
                "attached_resource_type": "Virtual Server",
                "id": "13e2a5a1acbe4713a9a2c70ce226e822",
                "port_id": "8b4705d3-43b7-4fad-8648-a5a1a90c31d0",
                "port_ip_address": "192.168.20.5",
                "port_name": "Port name"
            }
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Subnet VIP Description",
        "id": "0466a9448d9a4411a86055939e451c8f",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "state": "ACTIVE",
        "static_nat": {
            "external_ip_address": "100.112.9.84",
            "id": "0009e49548154745948e9722adefbf40",
            "publicip_id": "12f56e27070248a6a240a497e43fbe18",
            "state": "ACTIVE"
        },
        "subnet_id": "023c57b14f11483689338d085e061492",
        "vip_port_id": "35268a9f2eda4cde83b1d85c1f61f67d",
        "virtual_ip_address": "192.168.20.6"
    }
}

8.1.92 - Show Transit Gateway

8.1.92.1 - 1.2

get /v1/transit-gateways/{transit_gateway_id}

Description

Show Transit Gateway.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

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

Responses

HTTP Code	Description	Schema
200	OK	TransitGatewayShowResponseV1Dot2
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.2"

Example HTTP response

Response 200

{
    "transit_gateway": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "firewall_connection_state": "INACTIVE",
        "firewall_ids": "['bbb93aca123f4bb2b2c0f206f4a86b2b']",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "TransitGatewayName",
        "state": "ACTIVE",
        "uplink_enabled": "False"
    }
}

8.1.92.2 - 1.1

get /v1/transit-gateways/{transit_gateway_id}

Description

Show Transit Gateway.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "firewall_ids": "['bbb93aca123f4bb2b2c0f206f4a86b2b']",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "TransitGatewayName",
        "state": "ACTIVE",
        "uplink_enabled": "False"
    }
}

8.1.92.3 - 1.0

get /v1/transit-gateways/{transit_gateway_id}

Description

Show Transit Gateway.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
        "bandwidth": 1,
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "TransitGateway Description",
        "firewall_ids": "['bbb93aca123f4bb2b2c0f206f4a86b2b']",
        "id": "fe860e0af0c04dcd8182b84f907f31f4",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "TransitGatewayName",
        "state": "ACTIVE",
        "uplink_enabled": "False"
    }
}

8.1.93 - Show VPC

8.1.93.1 - 1.2

get /v1/vpcs/{vpc_id}

Description

Show VPC.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

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

Responses

HTTP Code	Description	Schema
200	OK	VpcShowResponseV1Dot2
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.2"

Example HTTP response

Response 200

{
    "vpc": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "cidr_count": 20,
        "cidrs": [
            {
                "cidr": "192.167.0.0/18",
                "created_at": "2024-05-17T00:23:17Z",
                "created_by": "7df8abb4912e4709b1cb237daccca7a8",
                "id": "7df8abb4912e4709b1cb237daccca7a8"
            }
        ],
        "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"
    }
}

8.1.93.2 - 1.1

get /v1/vpcs/{vpc_id}

Description

Show VPC.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

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"
    }
}

8.1.93.3 - 1.0

get /v1/vpcs/{vpc_id}

Description

Show VPC.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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"
    }
}

8.1.94 - Show VPC Endpoint

8.1.94.1 - 1.2

get /v1/vpc-endpoints/{vpc_endpoint_id}

Description

Show VPC Endpoint.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_endpoint_id required	VPC Endpoint ID Example : `12f56e27070248a6a240a497e43fbe18`	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.2"

Example HTTP response

Response 200

{
    "vpc_endpoint": {
        "account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "endpoint_ip_address": "192.167.0.5",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "VpcEndpointName",
        "resource_info": "x.samsungsdscloud.com(Registry)",
        "resource_key": "07c5364702384471b650147321b52173",
        "resource_type": "FS",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.94.2 - 1.1

get /v1/vpc-endpoints/{vpc_endpoint_id}

Description

Show VPC Endpoint.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	vpc_endpoint_id required	VPC Endpoint ID Example : `12f56e27070248a6a240a497e43fbe18`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "endpoint_ip_address": "192.167.0.5",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "VpcEndpointName",
        "resource_info": "x.samsungsdscloud.com(Registry)",
        "resource_key": "07c5364702384471b650147321b52173",
        "resource_type": "FS",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.94.3 - 1.0

get /v1/vpc-endpoints/{vpc_endpoint_id}

Description

Show VPC Endpoint.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_endpoint_id required	VPC Endpoint ID Example : `12f56e27070248a6a240a497e43fbe18`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "VpcEndpoint Description",
        "endpoint_ip_address": "192.167.0.5",
        "id": "12f56e27070248a6a240a497e43fbe18",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "VpcEndpointName",
        "resource_info": "x.samsungsdscloud.com(Registry)",
        "resource_key": "07c5364702384471b650147321b52173",
        "resource_type": "FS",
        "state": "ACTIVE",
        "subnet_id": "023c57b14f11483689338d085e061492",
        "subnet_name": "subnetName",
        "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "vpc_name": "vpcName"
    }
}

8.1.95 - Show VPC Peering

8.1.95.1 - 1.2

get /v1/vpc-peerings/{vpc_peering_id}

Description

Show VPC Peering.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example : `023c57b14f11483689338d085e061492`	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.2"

Example HTTP response

Response 200

{
    "vpc_peering": {
        "account_type": "SAME",
        "approver_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "approver_vpc_name": "vpcName",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "description": "vpcPeering Description",
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcPeeringName",
        "requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "requester_vpc_name": "vpcName",
        "state": "CREATING"
    }
}

8.1.95.2 - 1.1

get /v1/vpc-peerings/{vpc_peering_id}

Description

Show VPC Peering.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20261130

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example : `023c57b14f11483689338d085e061492`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "approver_vpc_name": "vpcName",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "description": "vpcPeering Description",
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcPeeringName",
        "requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "requester_vpc_name": "vpcName",
        "state": "CREATING"
    }
}

8.1.95.3 - 1.0

get /v1/vpc-peerings/{vpc_peering_id}

Description

Show VPC Peering.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpc_peering_id required	VPC Peering ID Example : `023c57b14f11483689338d085e061492`	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": "f1e6c81a2b054582878cb9724dc2ce9f",
        "approver_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "approver_vpc_name": "vpcName",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "delete_requester_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "description": "vpcPeering Description",
        "id": "023c57b14f11483689338d085e061492",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "vpcPeeringName",
        "requester_vpc_account_id": "f1e6c81a2b054582878cb9724dc2ce9f",
        "requester_vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
        "requester_vpc_name": "vpcName",
        "state": "CREATING"
    }
}

8.2 - Models

8.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]

8.2.2 - ConnectedPortInfo

Name	Description	Schema
attached_resource_id required	Connected resource ID Example : `9387e8f51de04a03994de8a9c3524935`	string
attached_resource_type required	Connected resource Type Example : `Virtual Server`	string
id required	Connected Port Id Example : `13e2a5a1acbe4713a9a2c70ce226e822`	string
port_id required	Port ID Example : `8b4705d3-43b7-4fad-8648-a5a1a90c31d0`	string
port_ip_address required	Port IP Address Example : `192.168.20.5`	string
port_name required	Port Name Example : `Port name`	string

8.2.3 - 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 : `bba6d4de3ad64e41b3a1b6c88983ec02`	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 : `e3df2e8e3b374fbb81d4e322b52ca50d`	string
state required	PrivateLink Endpoint State Example : `ACTIVE`	enum (REQUESTING, CREATING, REJECTED, CANCELED, ACTIVE, DISCONNECTED, DELETING, DELETED, ERROR)

8.2.4 - InternetGateway

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	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 : `Internet Gateway Description`	any of [string, null]
firewall_id optional	Firewall ID Example : `b156740b6335468d8354eb9ef8eddf5a`	any of [string, null]
id required	Internet Gateway ID Example : `023c57b14f11483689338d085e061492`	string
loggable optional	NAT Loggable Example : `False`	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 : `IGW_VPCname`	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 : `7df8abb4912e4709b1cb237daccca7a8`	string
vpc_name required	VPC Name Example : `vpcName`	string

8.2.5 - InternetGatewayCreateRequest

Name	Description	Schema
description optional	Description Example : `Internet Gateway Description`	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 : `7df8abb4912e4709b1cb237daccca7a8`	string

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

8.2.7 - InternetGatewayListResponseV1Dot2

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

8.2.8 - InternetGatewaySetRequest

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

8.2.9 - InternetGatewayShowResponse

Name	Description	Schema	Default
internet_gateway required		InternetGateway

8.2.10 - NatGateway

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	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 : `VpcEndpoint Description`	any of [string, null]
id required	NAT Gateway ID Example : `12f56e27070248a6a240a497e43fbe18`	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 : `NatGatewayName`	string
nat_gateway_ip_address required	NAT Gateway IP Address Example : `192.167.0.5`	string
publicip_id optional	PublicIP ID Example : `12f56e27070248a6a240a497e43fbe18`	any of [string, null]
state required	NAT Gateway State Example : `ACTIVE`	string
subnet_cidr required	Subnet Cidr Example : `192.167.1.0/24`	string
subnet_id required	Subnet Id Example : `023c57b14f11483689338d085e061492`	string
subnet_name required	Subnet Name Example : `subnetName`	string
vpc_id required	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	string
vpc_name required	VPC Name Example : `vpcName`	string

8.2.11 - NatGatewayCreateRequest

Name	Description	Schema
description optional	NAT Gateway Description Example : `VpcEndpoint Description` Maximum length : `50`	string
publicip_id required	PublicIP ID Example : `12f56e27070248a6a240a497e43fbe18`	string
subnet_id required	Subnet CIDR Example : `023c57b14f11483689338d085e061492`	string
tags optional	Tag List Example : `[{'key': 'key', 'value': 'value'}]`	array[Tag]

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

8.2.13 - NatGatewayListResponseV1Dot2

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

8.2.14 - NatGatewaySetRequest

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

8.2.15 - NatGatewayShowResponse

Name	Description	Schema	Default
nat_gateway required		NatGateway

8.2.16 - Port

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	string
attached_resource_id required	Connected resource ID Example : `9387e8f51de04a03994de8a9c3524935`	string
attached_resource_type required	Connected resource Type Example :	string
created_at required	Created date Example :	string (date-time)
description required	Description Example : `Port Description` Maximum length : `50`	string
fixed_ip_address required	Fixed IP Example : `192.168.1.100`	string
id required	Port ID Example : `023c57b1-4f11-4836-8933-8d085e061492`	string
mac_address required	MAC Address Example : `fa:16:3e:00:00:01`	string
modified_at required	Modified date Example :	string (date-time)
name required	Port Name Example : `portName`	string
security_groups required	Security Group List	array[PortSecurityGroup]
state required	State Example :	string
subnet_id required	Subnet Id Example : `023c57b14f11483689338d085e061492`	string
subnet_name required	Subnet Name Example : `subnetName`	string
vpc_id required	VPC Id Example : `071bc63b767444c9afaab1c972d302d5`	string
vpc_name required	VPC Name Example : `vpcName`	string

8.2.17 - PortCreateRequest

Name	Description	Schema
description optional	Description Example : `Port Description`	any of [string, null]
fixed_ip_address optional	Fixed IP Example :	any of [string, null]
name required	Port Name Example : `portName` 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]

8.2.18 - PortList

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	string
attached_resource_id required	Connected resource ID Example : `9387e8f51de04a03994de8a9c3524935`	string
attached_resource_type required	Connected resource Type Example :	string
created_at required	Created date Example :	string (date-time)
description required	Description Example : `Port Description` Maximum length : `50`	string
fixed_ip_address required	Fixed IP Example : `192.168.1.100`	string
id required	Port ID Example : `023c57b1-4f11-4836-8933-8d085e061492`	string
mac_address required	MAC Address Example : `fa:16:3e:00:00:01`	string
modified_at required	Modified date Example :	string (date-time)
name required	Port Name Example : `portName`	string
state required	State Example :	string
subnet_id required	Subnet Id Example : `023c57b14f11483689338d085e061492`	string
subnet_name required	Subnet Name Example : `subnetName`	string
vpc_id required	VPC Id Example : `071bc63b767444c9afaab1c972d302d5`	string
vpc_name required	VPC Name Example : `vpcName`	string

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

8.2.20 - PortSecurityGroup

Name	Description	Schema	Default
id optional	Security Group ID Example : `02fb574c-f30f-40e1-9f43-4d1572dee5bd`	any of [string, null]
name optional	Security Group Name Example : `sgName`	any of [string, null]

8.2.21 - PortSetRequest

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

8.2.22 - PortShowResponse

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

8.2.23 - PortShowResponseV1Dot2

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

8.2.24 - PortV1Dot2

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	string
attached_resource_id required	Connected resource ID Example : `9387e8f51de04a03994de8a9c3524935`	string
attached_resource_type required	Connected resource Type Example :	string
created_at required	Created date Example :	string (date-time)
description required	Description Example : `Port Description` Maximum length : `50`	string
fixed_ip_address required	Fixed IP Example : `192.168.1.100`	string
id required	Port ID Example : `023c57b1-4f11-4836-8933-8d085e061492`	string
mac_address required	MAC Address Example : `fa:16:3e:00:00:01`	string
modified_at required	Modified date Example :	string (date-time)
name required	Port Name Example : `portName`	string
security_groups required	Security Group List	array[PortSecurityGroup]
state required	State Example :	string
subnet_id required	Subnet Id Example : `023c57b14f11483689338d085e061492`	string
subnet_name required	Subnet Name Example : `subnetName`	string
virtual_ip_addresses required	Virtual IP Address	array[string]
vpc_id required	VPC Id Example : `071bc63b767444c9afaab1c972d302d5`	string
vpc_name required	VPC Name Example : `vpcName`	string

8.2.25 - PrivateLinkEndpoint

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	string
approval_type required	PrivateLink Service Approval Type Example : `AUTO`	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 : `192.167.1.5`	string
id required	PrivateLink Endpoint ID Example : `bba6d4de3ad64e41b3a1b6c88983ec02`	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 : `EndpointName`	string
privatelink_service_id required	PrivateLink Service ID Example : `e3df2e8e3b374fbb81d4e322b52ca50d`	string
state required	PrivateLink Endpoint State Example : `ACTIVE`	enum (REQUESTING, CREATING, REJECTED, CANCELED, ACTIVE, DISCONNECTED, DELETING, DELETED, ERROR)
subnet_id required	Subnet Id Example : `023c57b14f11483689338d085e061492`	string
vpc_id required	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	string

8.2.26 - PrivateLinkEndpointApprovalRequest

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

8.2.27 - PrivateLinkEndpointConnectionRequest

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

8.2.28 - PrivateLinkEndpointCreateRequest

Name	Description	Schema
description optional	Description Example : `PrivateLink Endpoint Description` Maximum length : `50`	string
endpoint_ip_address required	Endpoint IP Address Example : `192.167.1.5`	string
name required	PrivateLink Endpoint Name Example : `EndpointName` Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
privatelink_service_id optional	PrivateLink Service ID Example : `e3df2e8e3b374fbb81d4e322b52ca50d`	string
security_group_ids optional	Security Group List Example : `['17776b52-0a64-440d-9e93-b4fc37be935b']`	array[string]
subnet_id required	Subnet Id Example : `023c57b14f11483689338d085e061492`	string
tags optional	Tag List Example : `[{'key': 'key', 'value': 'value'}]`	array[Tag]

8.2.29 - PrivateLinkEndpointDetail

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	string
approval_type required	PrivateLink Service Approval Type Example : `AUTO`	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 : `PrivateLink Endpoint Description`	any of [string, null]
endpoint_ip_address required	Endpoint IP Address Example : `192.167.1.5`	string
endpoint_ip_port_id optional	Endpoint IP Port ID Example : `b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e`	any of [string, null]
id required	PrivateLink Endpoint ID Example : `bba6d4de3ad64e41b3a1b6c88983ec02`	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 : `EndpointName`	string
privatelink_service_id required	PrivateLink Service ID Example : `e3df2e8e3b374fbb81d4e322b52ca50d`	string
security_group_ids optional	Security Group List Example : `['17776b52-0a64-440d-9e93-b4fc37be935b']`	array[string]
state required	PrivateLink Endpoint State Example : `ACTIVE`	enum (REQUESTING, CREATING, REJECTED, CANCELED, ACTIVE, DISCONNECTED, DELETING, DELETED, ERROR)
subnet_id required	Subnet Id Example : `023c57b14f11483689338d085e061492`	string
vpc_id required	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	string

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

8.2.31 - PrivateLinkEndpointRequest

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

8.2.32 - PrivateLinkEndpointSetRequest

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

8.2.33 - PrivateLinkEndpointShowResponse

Name	Description	Schema	Default
privatelink_endpoint required		PrivateLinkEndpointDetail

8.2.34 - PrivateLinkEndpointSummary

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

8.2.35 - PrivateLinkEndpointSummaryShowResponse

Name	Description	Schema	Default
privatelink_endpoint required		PrivateLinkEndpointSummary

8.2.36 - PrivateLinkService

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	string
approval_type required	PrivateLink Service Approval Type Example : `AUTO`	enum (MANUAL, AUTO)
connected_resource_id optional	Connected Resource ID Example : `a3e3a662a4f34442a94166df5ff9f577`	any of [string, null]
connected_resource_ip_address required	Connected Resource IP Address Example : `192.167.0.10`	string
connected_resource_name required	Connected Resource Name Example : `lbResourceName`	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 : `e3df2e8e3b374fbb81d4e322b52ca50d`	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 : `ServiceName`	string
service_ip_address required	Service IP Address Example : `192.167.0.5`	string
state required	PrivateLink Service State Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
subnet_id required	Subnet Id Example : `023c57b14f11483689338d085e061492`	string
vpc_id required	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	string

8.2.37 - PrivateLinkServiceCreateRequest

Name	Description	Schema
approval_type required	PrivateLink Service Approval Type Example : `AUTO`	enum (MANUAL, AUTO)
connected_resource_id optional	Connected Resource ID Example : `a3e3a662a4f34442a94166df5ff9f577`	string
connected_resource_ip_address optional	Connected Resource IP Address Example : `192.167.0.10`	string
connected_resource_type required	Connected Resource Type Example : `LB`	enum (LB, IP)
description optional	Description Example : `PrivateLink Service Description` Maximum length : `50`	string
high_speed_transfer optional	High Speed Data Transfer Use Example : `False`	boolean
name required	PrivateLink Service Name Example : `ServiceName` Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
security_group_ids optional	Security Group List Example : `['00b6af37-73b5-4de2-b080-c295a1a0382e']`	array[string]
service_ip_address required	Service IP Address Example : `192.167.0.5`	string
subnet_id required	Subnet Id Example : `023c57b14f11483689338d085e061492`	string
tags optional	Tag List Example : `[{'key': 'key', 'value': 'value'}]`	array[Tag]

8.2.38 - PrivateLinkServiceDetail

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	string
approval_type required	PrivateLink Service Approval Type Example : `AUTO`	enum (MANUAL, AUTO)
connected_resource_id optional	Connected Resource ID Example : `a3e3a662a4f34442a94166df5ff9f577`	any of [string, null]
connected_resource_ip_address required	Connected Resource IP Address Example : `192.167.0.10`	string
connected_resource_name required	Connected Resource Name Example : `lbResourceName`	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 : `PrivateLink Service Description`	any of [string, null]
high_speed_transfer required	High Speed Data Transfer Use Example : `False`	boolean
id required	PrivateLink Service ID Example : `e3df2e8e3b374fbb81d4e322b52ca50d`	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 : `ServiceName`	string
security_group_ids optional	Security Group List Example : `['00b6af37-73b5-4de2-b080-c295a1a0382e']`	array[string]
service_ip_address required	Service IP Address Example : `192.167.0.5`	string
service_ip_port_id optional	Service IP Port ID Example : `d21a4b81-f52a-43a8-b985-341e763458bb`	any of [string, null]
state required	PrivateLink Service State Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
subnet_id required	Subnet Id Example : `023c57b14f11483689338d085e061492`	string
vpc_id required	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	string

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

8.2.40 - PrivateLinkServiceSetRequest

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

8.2.41 - PrivateLinkServiceShowResponse

Name	Description	Schema	Default
privatelink_service required		PrivateLinkServiceDetail

8.2.42 - PrivateNat

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	string
cidr required	Private NAT IP range Example : `192.167.0.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 : `PrivateNat Description`	any of [string, null]
direct_connect_id required	Direct Connect ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	string
direct_connect_name optional	Direct Connect Name Example : `DirectConnectName`	any of [string, null]
id required	Private NAT ID Example : `12f56e27070248a6a240a497e43fbe18`	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 : `PrivateNatName`	string
state required	Private NAT State Example : `ACTIVE`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
vpc_id required	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	string
vpc_name optional	VPC Name Example : `vpcName`	any of [string, null]

8.2.43 - PrivateNatCreateRequest

Name	Description	Schema
cidr required	Private NAT IP range Example : `192.167.0.0/24`	string
description optional	Description Example : `PrivateNat Description` Maximum length : `50`	string
direct_connect_id required	Direct Connect ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	string
name required	Private NAT Name Example : `PrivateNatName` Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
tags optional	Tag List Example : `[{'key': 'key', 'value': 'value'}]`	array[Tag]

8.2.44 - PrivateNatCreateRequestV1Dot2

Name	Description	Schema
cidr required	Private NAT IP range Example : `192.167.0.0/24`	string
description optional	Description Example : `PrivateNat Description` Maximum length : `50`	string
name required	Private NAT Name Example : `PrivateNatName` Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
service_resource_id required	Private NAT connected Service Resource ID Example : `3f342bf9a557405b997c2cf48c89cbc2`	string
service_type required	Private NAT connected Service Type Example : `DIRECT_CONNECT`	enum (DIRECT_CONNECT, TRANSIT_GATEWAY)
tags optional	Tag List Example : `[{'key': 'key', 'value': 'value'}]`	array[Tag]

8.2.45 - 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, ALB, GPU_SERVER), 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)

8.2.46 - PrivateNatIpCreateRequest

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

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

8.2.48 - PrivateNatIpShowResponse

Name	Description	Schema	Default
private_nat_ip required		PrivateNatIp

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

8.2.50 - PrivateNatListResponseV1Dot2

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

8.2.51 - PrivateNatSetRequest

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

8.2.52 - PrivateNatShowResponse

Name	Description	Schema	Default
private_nat required		PrivateNat

8.2.53 - PrivateNatShowResponseV1Dot2

Name	Description	Schema	Default
private_nat required		PrivateNatV1Dot2

8.2.54 - PrivateNatV1Dot2

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	string
cidr required	Private NAT IP range Example : `192.167.0.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 : `PrivateNat Description`	any of [string, null]
id required	Private NAT ID Example : `12f56e27070248a6a240a497e43fbe18`	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 : `PrivateNatName`	string
service_resource_id required	Private NAT connected Service Resource ID Example : `3f342bf9a557405b997c2cf48c89cbc2`	string
service_resource_name required	Private NAT connected Service Resource Name Example : `PrivateNatName`	string
service_type required	Private NAT connected Service Type Example : `DIRECT_CONNECT`	enum (DIRECT_CONNECT, TRANSIT_GATEWAY)
state required	Private NAT State Example : `ACTIVE`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)

8.2.55 - Publicip

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	string
attached_resource_id optional	PublicIP Attached Resource ID Example : `37e6db41f5124184a43251a63124cdc9`	any of [string, null]
attached_resource_name optional	PublicIP Attached Resource Name Example : `Attached NAT Gateway Name`	any of [string, null]
attached_resource_type optional	PublicIP Attached Resource Type Example : `NAT_GW`	any of [enum (VM, ALB, LB, BM, DB, NAT_GW, GPU_NODE, VPN, GPU_SERVER, EPAS, POSTGRESQL, MARIADB, SQLSERVER, CACHESTORE, SCALABLEDB, EVENTSTREAMS, SEARCHENGINE, VERTICA, SUBNET), 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 : `Public IP Description`	any of [string, null]
id required	PublicIP ID Example : `12f56e27070248a6a240a497e43fbe18`	string
ip_address required	IP Address Example : `192.167.0.5`	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 : `ATTACHED`	enum (RESERVED, ATTACHED, DELETED)
type required	PublicIP Type Example : `IGW`	enum (IGW, GGW, SIGW)

8.2.56 - PublicipCreateRequest

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

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

8.2.58 - PublicipListResponseV1Dot2

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

8.2.59 - PublicipSetRequest

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

8.2.60 - PublicipShowResponse

Name	Description	Schema	Default
publicip required		Publicip

8.2.61 - 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

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

8.2.63 - StaticNatSummary

Name	Description	Schema
external_ip_address required	Static Nat External Ip Address Example : `100.112.9.84`	string
id required	Static Nat Id Example : `0009e49548154745948e9722adefbf40`	string
publicip_id required	Publicip ID Example : `12f56e27070248a6a240a497e43fbe18`	string
state required	Static Nat State Example : `ACTIVE`	string

8.2.64 - 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

8.2.65 - 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

8.2.66 - SubnetCreateRequestV1Dot2

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]
gateway_ip_address optional	Gateway IP Address Example : `192.167.1.1`	any of [string, null]
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

8.2.67 - 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

8.2.68 - SubnetDetailV1Dot2

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]
dhcp_ip_address optional	DHCP IP Address Example :	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

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

8.2.70 - SubnetListResponseV1Dot2

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]
subnets required		array[Subnet]

8.2.71 - SubnetSetRequest

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

8.2.72 - SubnetSetRequestV1Dot2

Name	Description	Schema	Default
description optional	Description Example : `Subnet Description`	any of [string, null]
dhcp_ip_address optional	DHCP IP Address Example :	any of [string, null]

8.2.73 - SubnetShowResponse

Name	Description	Schema	Default
subnet required		SubnetDetail

8.2.74 - SubnetShowResponseV1Dot2

Name	Description	Schema	Default
subnet required		SubnetDetailV1Dot2

8.2.75 - SubnetVipDetail

Name	Description	Schema
connected_ports required		array[ConnectedPortInfo]
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 VIP Description`	any of [string, null]
id required	Subnet Vip Id Example : `0466a9448d9a4411a86055939e451c8f`	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 : `ACTIVE`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
static_nat optional	Static NAT Info	any of [StaticNatSummary, null]
subnet_id required	Subnet ID Example : `023c57b14f11483689338d085e061492`	string
vip_port_id required	Vip Port Id Example : `35268a9f2eda4cde83b1d85c1f61f67d`	string
virtual_ip_address required	Virtual IP Address Example : `192.168.20.6`	string

8.2.76 - SubnetVipSummary

Name	Description	Schema
connected_port_count optional	Connected Port Count Example : `2`	integer
created_at required	Created At Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	Created By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
id required	Subnet Vip Id Example : `0466a9448d9a4411a86055939e451c8f`	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 : `ACTIVE`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
static_nat optional	Static NAT Info	any of [StaticNatSummary, null]
virtual_ip_address required	Virtual IP Address Example : `192.168.20.6`	string

8.2.77 - Tag

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

8.2.78 - TransitGateway

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	string
bandwidth optional	Transit Gateway Port Bandwidth Example : `1`	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 : `TransitGateway Description`	any of [string, null]
firewall_ids optional	Firewall ID Example : `['bbb93aca123f4bb2b2c0f206f4a86b2b']`	any of [string, null]
id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	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 : `TransitGatewayName` Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
state required	State Example : `ACTIVE`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING)
uplink_enabled optional	Uplink Enabled Example : `False`	boolean

8.2.79 - TransitGatewayCreateRequest

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

8.2.80 - TransitGatewayFirewallCreateRequest

Name	Description	Schema	Default
product_type required	Fw Product Type Example : `TGW_DGW`	enum (TGW_IGW, TGW_GGW, TGW_DGW, TGW_BM)

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

8.2.82 - TransitGatewayListResponseV1Dot2

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[TransitGatewayV1Dot2]

8.2.83 - TransitGatewayRule

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	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 : `Routing Rule Description`	string
destination_cidr required	Destination CIDR Example : `192.167.5.0/24`	string
destination_resource_id required	Destination Resource ID Example : `ceb44ea5ecb34a49b16495f9a63b0718`	any of [string, null]
destination_resource_name optional	Destination Resource Name Example : `VpcName`	any of [string, null]
destination_type required	Destination Type Example : `VPC`	enum (VPC, TGW, ON_PREMISE)
id required	Routing Rule ID Example : `43772aff4539403d9ba74bf1fdaa00c8`	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 : `8582cc5d89994a42ad53282fd4a8d8be`	any of [string, null]
source_resource_name optional	Source Resource Name Example : `TgwName`	any of [string, null]
source_type required	Source Type Example : `TGW`	enum (VPC, TGW, ON_PREMISE)
state required	State Example : `ACTIVE`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
tgw_connection_vpc_id required	VPC ID Connected to Transit Gateway. Example : `ffeced8e191c478eabd66b6e2cab8e34`	any of [string, null]
tgw_connection_vpc_name optional	VPC Name Connected to Transit Gateway. Example : `ConnectedVpcName`	any of [string, null]

8.2.84 - TransitGatewayRuleCreateRequest

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

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

8.2.86 - TransitGatewayRuleListResponseV1Dot2

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[TransitGatewayRuleV1Dot2]

8.2.87 - TransitGatewayRuleShowResponse

Name	Description	Schema	Default
transit_gateway_rule required		TransitGatewayVpcRule

8.2.88 - TransitGatewayRuleV1Dot2

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	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 : `Routing Rule Description`	string
destination_cidr required	Destination CIDR Example : `192.167.5.0/24`	string
destination_resource_id required	Destination Resource ID Example : `ceb44ea5ecb34a49b16495f9a63b0718`	any of [string, null]
destination_resource_name optional	Destination Resource Name Example : `VpcName`	any of [string, null]
destination_type required	Destination Type Example : `VPC`	enum (VPC, TGW, ON_PREMISE)
id required	Routing Rule ID Example : `43772aff4539403d9ba74bf1fdaa00c8`	string
modified_at required	Modified At Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	Modified By Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
rule_type required	Rule Type Example : `TGW_VPC`	enum (TGW_VPC, TGW_UPLINK)
source_resource_id required	Source Resource ID Example : `8582cc5d89994a42ad53282fd4a8d8be`	any of [string, null]
source_resource_name optional	Source Resource Name Example : `TgwName`	any of [string, null]
source_type required	Source Type Example : `TGW`	enum (VPC, TGW, ON_PREMISE)
state required	State Example : `ACTIVE`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
tgw_connection_vpc_id required	VPC ID Connected to Transit Gateway. Example : `ffeced8e191c478eabd66b6e2cab8e34`	any of [string, null]
tgw_connection_vpc_name optional	VPC Name Connected to Transit Gateway. Example : `ConnectedVpcName`	any of [string, null]

8.2.89 - TransitGatewaySetRequest

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

8.2.90 - TransitGatewayShowResponse

Name	Description	Schema	Default
transit_gateway required		TransitGateway

8.2.91 - TransitGatewayShowResponseV1Dot2

Name	Description	Schema	Default
transit_gateway required		TransitGatewayV1Dot2

8.2.92 - TransitGatewayUplinkRule

Name	Description	Schema
description required	Description Example : `Routing Rule Description`	string
destination_cidr required	Destination CIDR Example : `192.167.5.0/24`	string
destination_type required	Destination Type Example : `ON_PREMISE`	enum (TGW, ON_PREMISE)
id required	Routing Rule ID Example : `43772aff4539403d9ba74bf1fdaa00c8`	string
state required	State Example : `ACTIVE`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)

8.2.93 - TransitGatewayUplinkRuleCreateRequest

Name	Description	Schema
description optional	Description Example : `Routing Rule Description` Maximum length : `50`	string
destination_cidr required	Destination CIDR Example : `192.167.5.0/24`	string
destination_type required	Destination Type Example : `ON_PREMISE`	enum (TGW, ON_PREMISE)

8.2.94 - TransitGatewayUplinkRuleCreateResponse

Name	Description	Schema	Default
transit_gateway_rule required		TransitGatewayUplinkRule

8.2.95 - TransitGatewayV1Dot2

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	string
bandwidth optional	Transit Gateway Port Bandwidth Example : `1`	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 : `TransitGateway Description`	any of [string, null]
firewall_connection_state optional	Firewall Connection State Example : `INACTIVE`	any of [enum (ATTACHING, ACTIVE, DETACHING, DELETED, INACTIVE, ERROR), null]
firewall_ids optional	Firewall ID Example : `['bbb93aca123f4bb2b2c0f206f4a86b2b']`	any of [string, null]
id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	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 : `TransitGatewayName` Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
state required	State Example : `ACTIVE`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING)
uplink_enabled optional	Uplink Enabled Example : `False`	boolean

8.2.96 - TransitGatewayVpcConnection

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	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 : `ffeced8e191c478eabd66b6e2cab8e34`	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 : `ACTIVE`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
transit_gateway_id required	Transit Gateway ID Example : `fe860e0af0c04dcd8182b84f907f31f4`	string
vpc_id required	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	string
vpc_name required	VPC Name Example : `vpcName`	string

8.2.97 - TransitGatewayVpcConnectionCreateRequest

Name	Description	Schema	Default
vpc_id required	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	string

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

8.2.99 - TransitGatewayVpcConnectionShowResponse

Name	Description	Schema	Default
transit_gateway_vpc_connection required		TransitGatewayVpcConnection

8.2.100 - TransitGatewayVpcRule

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	string
description required	Description Example : `Routing Rule Description`	string
destination_cidr required	Destination CIDR Example : `192.167.5.0/24`	string
destination_resource_id required	Destination Resource ID Example : `ceb44ea5ecb34a49b16495f9a63b0718`	any of [string, null]
destination_resource_name optional	Destination Resource Name Example : `VpcName`	any of [string, null]
destination_type required	Destination Type Example : `VPC`	enum (VPC, TGW)
id required	Routing Rule ID Example : `43772aff4539403d9ba74bf1fdaa00c8`	string
source_resource_id required	Source Resource ID Example : `8582cc5d89994a42ad53282fd4a8d8be`	any of [string, null]
source_resource_name optional	Source Resource Name Example : `TgwName`	any of [string, null]
source_type required	Source Type Example : `TGW`	enum (VPC, TGW)
state required	State Example : `ACTIVE`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
tgw_connection_vpc_id required	VPC ID Connected to Transit Gateway. Example : `ffeced8e191c478eabd66b6e2cab8e34`	any of [string, null]
tgw_connection_vpc_name optional	VPC Name Connected to Transit Gateway. Example : `ConnectedVpcName`	any of [string, null]

8.2.101 - VipCreateRequest

Name	Description	Schema	Default
description optional	Description Example : `Subnet VIP Description`	any of [string, null]
virtual_ip_address optional	Virtual IP Address Example : `192.168.20.6`	any of [string, null]

8.2.102 - VipCreateResponse

Name	Description	Schema	Default
subnet_vip required		SubnetVipDetail

8.2.103 - VipListResponse

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]
subnet_vips required		array[SubnetVipSummary]

8.2.104 - VipNatCreateRequest

Name	Description	Schema	Default
nat_type required	NAT Type Example : `PUBLIC`	string
publicip_id required	Publicip ID Example : `12f56e27070248a6a240a497e43fbe18`	string

8.2.105 - VipNatCreateResponse

Name	Description	Schema
id required	Static Nat Id Example : `0009e49548154745948e9722adefbf40`	string
publicip_id required	Publicip ID Example : `12f56e27070248a6a240a497e43fbe18`	string
state required	Static Nat State Example : `ACTIVE`	string

8.2.106 - VipPortRequest

Name	Description	Schema	Default
port_id required	Port ID Example : `35268a9f2eda4cde83b1d85c1f61f67d`	string

8.2.107 - VipPortResponse

Name	Description	Schema	Default
id required	Connected Port Id Example : `35268a9f2eda4cde83b1d85c1f61f67d`	string
subnet_vip_id required	Subnet Vip Id Example : `0466a9448d9a4411a86055939e451c8f`	string

8.2.108 - VipSetRequest

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

8.2.109 - VipShowResponse

Name	Description	Schema	Default
subnet_vip required		SubnetVipDetail

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

8.2.111 - VpcCidr

Name	Description	Schema
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 : `7df8abb4912e4709b1cb237daccca7a8`	string
id required	Cidr ID Example : `7df8abb4912e4709b1cb237daccca7a8`	string

8.2.112 - VpcCidrCreateRequest

Name	Description	Schema	Default
cidr required	VPC Cidr Example : `192.167.0.0/18`	string

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

8.2.114 - VpcEndpoint

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	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 : `VpcEndpoint Description`	any of [string, null]
endpoint_ip_address required	VPC Endpoint IP Address Example : `192.167.0.5`	string
id required	VPC Endpoint ID Example : `12f56e27070248a6a240a497e43fbe18`	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 : `VpcEndpointName`	string
resource_info required	VPC Endpoint Resource Key Info Example : `x.samsungsdscloud.com(Registry)`	string
resource_key required	VPC Endpoint Resource Key Example : `07c5364702384471b650147321b52173`	string
resource_type required	VPC Endpoint Resource Type Example : `FS`	enum (FS, OBS, SCR, DNS)
state required	VPC Endpoint State Example : `ACTIVE`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR)
subnet_id required	Subnet Id Example : `023c57b14f11483689338d085e061492`	string
subnet_name required	Subnet Name Example : `subnetName`	string
vpc_id required	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	string
vpc_name required	VPC Name Example : `vpcName`	string

8.2.115 - VpcEndpointConnectableResourceDetail

Name	Description	Schema
resource_info required	VPC Endpoint Resource Key Info Example : `x.samsungsdscloud.com(Registry)`	string
resource_key required	VPC Endpoint Resource Key Example : `07c5364702384471b650147321b52173`	string
resource_type required	VPC Endpoint Resource Type Example : `FS`	enum (FS, OBS, SCR, DNS)

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

8.2.117 - VpcEndpointConnectableResourceListResponseV1Dot2

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_endpoint_connectable_resources required		array[VpcEndpointConnectableResourceDetail]

8.2.118 - VpcEndpointCreateRequest

Name	Description	Schema
description optional	Description Example : `VpcEndpoint Description` Maximum length : `50`	string
endpoint_ip_address required	VPC Endpoint IP Address Example : `192.167.0.5`	string
name required	VPC Endpoint Name Example : `VpcEndpointName` Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
resource_info required	VPC Endpoint Resource Key Info Example : `x.samsungsdscloud.com(Registry)` Maximum length : `200`	string
resource_key required	VPC Endpoint Resource Key Example : `07c5364702384471b650147321b52173`	string
resource_type required	VPC Endpoint Resource Type Example : `FS`	enum (FS, OBS, SCR, DNS)
subnet_id required	Subnet Id Example : `023c57b14f11483689338d085e061492`	string
tags optional	Tag List Example : `[{'key': 'key', 'value': 'value'}]`	array[Tag]
vpc_id required	VPC Id Example : `7df8abb4912e4709b1cb237daccca7a8`	string

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

8.2.120 - VpcEndpointListResponseV1Dot2

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_endpoints required		array[VpcEndpoint]

8.2.121 - VpcEndpointSetRequest

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

8.2.122 - VpcEndpointShowResponse

Name	Description	Schema	Default
vpc_endpoint required		VpcEndpoint

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

8.2.124 - VpcListResponseV1Dot2

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]
vpcs required		array[VpcV1Dot2]

8.2.125 - VpcPeering

Name	Description	Schema
account_type required	Account Type Example : `SAME`	enum (SAME, DIFFERENT)
approver_vpc_account_id required	Approver VPC Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	string
approver_vpc_id required	Approver VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	string
approver_vpc_name required	Approver VPC Name Example : `vpcName`	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 : `f1e6c81a2b054582878cb9724dc2ce9f`	any of [string, null]
description optional	VPC Peering Description Example : `vpcPeering Description`	any of [string, null]
id required	VPC Peering 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	VPC Peering Name Example : `vpcPeeringName` Pattern : `^[a-zA-Z0-9-]$` Minimum length* : `3` Maximum length : `20`	string
requester_vpc_account_id required	Requester VPC Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	string
requester_vpc_id required	Requester VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	string
requester_vpc_name required	Requester VPC Name Example : `vpcName`	string
state required	State Example : `CREATING`	enum (CREATING, ACTIVE, DELETING, DELETED, ERROR, EDITING, CREATING_REQUESTING, REJECTED, CANCELED, DELETING_REQUESTING)

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

8.2.127 - VpcPeeringCreateRequest

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

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

8.2.129 - 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

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

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

8.2.132 - VpcPeeringRuleShowResponse

Name	Description	Schema	Default
vpc_peering_rule required		VpcPeeringRule

8.2.133 - VpcPeeringSetRequest

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

8.2.134 - VpcPeeringShowResponse

Name	Description	Schema	Default
vpc_peering required		VpcPeering

8.2.135 - VpcSetRequest

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

8.2.136 - VpcShowResponse

Name	Description	Schema	Default
vpc required		Vpc

8.2.137 - VpcShowResponseV1Dot2

Name	Description	Schema	Default
vpc required		VpcV1Dot2

8.2.138 - VpcV1Dot2

Name	Description	Schema
account_id required	Account ID Example : `f1e6c81a2b054582878cb9724dc2ce9f`	string
cidr_count required	Cidr Count Example : `20`	integer
cidrs required		array[VpcCidr]
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)

9 - VPN

Overview

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

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

Version

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

Version	Status	Not Before
1.1	CURRENT	-
1.0	DEPRECATED	20251231

OpenAPI URL

https://vpn.{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

9.1 - APIs

9.1.1 - Create VPN Gateway

9.1.1.1 - 1.1

post /v1/vpn-gateways

Description

Create VPN gateway.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		VpnGatewayCreateRequest

Responses

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

Example HTTP request

Request path

/v1/vpn-gateways

Request header

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

Request body

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

Example HTTP response

Response 202

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

9.1.1.2 - 1.0

post /v1/vpn-gateways

Description

Create VPN gateway.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		VpnGatewayCreateRequest

Responses

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

Example HTTP request

Request path

/v1/vpn-gateways

Request header

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

Request body

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

Example HTTP response

Response 202

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

9.1.2 - Create VPN Tunnel

9.1.2.1 - 1.1

post /v1/vpn-tunnels

Description

Create VPN tunnel.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		VpnTunnelCreateRequestV1Dot1

Responses

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

Example HTTP request

Request path

/v1/vpn-tunnels

Request header

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

Request body

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

Example HTTP response

Response 202

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

9.1.2.2 - 1.0

post /v1/vpn-tunnels

Description

Create VPN tunnel.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
body	body required		VpnTunnelCreateRequest

Responses

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

Example HTTP request

Request path

/v1/vpn-tunnels

Request header

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

Request body

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

Example HTTP response

Response 202

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

9.1.3 - Delete VPN Gateway

9.1.3.1 - 1.1

delete /v1/vpn-gateways/{vpn_gateway_id}

Description

Delete VPN gateway.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpn_gateway_id required	VPN Gateway ID Example : `b156740b6335468d8354eb9ef8eddf5a`	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/vpn-gateways/{vpn_gateway_id}

Request header

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

Example HTTP response

Response 202

9.1.3.2 - 1.0

delete /v1/vpn-gateways/{vpn_gateway_id}

Description

Delete VPN gateway.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpn_gateway_id required	VPN Gateway ID Example : `b156740b6335468d8354eb9ef8eddf5a`	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/vpn-gateways/{vpn_gateway_id}

Request header

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

Example HTTP response

Response 202

9.1.4 - Delete VPN Tunnel

9.1.4.1 - 1.1

delete /v1/vpn-tunnels/{vpn_tunnel_id}

Description

Delete VPN tunnel.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpn_tunnel_id required	VPN Tunnel ID Example : `2ade2919287040bc92e557fbbe6709c1`	string	None

Responses

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

Example HTTP request

Request path

/v1/vpn-tunnels/{vpn_tunnel_id}

Request header

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

Example HTTP response

Response 202

9.1.4.2 - 1.0

delete /v1/vpn-tunnels/{vpn_tunnel_id}

Description

Delete VPN tunnel.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpn_tunnel_id required	VPN Tunnel ID Example : `2ade2919287040bc92e557fbbe6709c1`	string	None

Responses

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

Example HTTP request

Request path

/v1/vpn-tunnels/{vpn_tunnel_id}

Request header

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

Example HTTP response

Response 202

9.1.5 - List VPN Gateways

9.1.5.1 - 1.1

get /v1/vpn-gateways

Description

Get VPN gateway list.

State ACTIVE (CURRENT)

Version	Not Before
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	VPN Gateway Name Example : `ExampleVpnGW1`	string	None
query	ip_address optional	VPN Gateway IP Address Example : `123.0.0.1`	string	None
query	vpc_id optional	VPC Id Example : `ceb44ea5ecb34a49b16495f9a63b0718`	string	None
query	vpc_name optional	VPC Name Example : `ExampleVPC1`	string	None

Responses

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

Example HTTP request

Request path

/v1/vpn-gateways

Request header

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

Example HTTP response

Response 200

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

9.1.5.2 - 1.0

get /v1/vpn-gateways

Description

Get VPN gateway list.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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	VPN Gateway Name Example : `ExampleVpnGW1`	string	None
query	ip_address optional	VPN Gateway IP Address Example : `123.0.0.1`	string	None
query	vpc_id optional	VPC Id Example : `ceb44ea5ecb34a49b16495f9a63b0718`	string	None
query	vpc_name optional	VPC Name Example : `ExampleVPC1`	string	None

Responses

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

Example HTTP request

Request path

/v1/vpn-gateways

Request header

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

Example HTTP response

Response 200

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

9.1.6 - List VPN Tunnels

9.1.6.1 - 1.1

get /v1/vpn-tunnels

Description

Get VPN tunnel list.

State ACTIVE (CURRENT)

Version	Not Before
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	VPN Tunnel Name Example : `ExampleVpnTunnel1`	string	None
query	vpn_gateway_id optional	VPN Gateway ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string	None
query	vpn_gateway_name optional	VPN Gateway Name Example : `ExampleVpnGW1`	string	None

Responses

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

Example HTTP request

Request path

/v1/vpn-tunnels

Request header

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

Example HTTP response

Response 200

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

9.1.6.2 - 1.0

get /v1/vpn-tunnels

Description

Get VPN tunnel list.

State ACTIVE (DEPRECATED)

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

Version	Not Before
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	VPN Tunnel Name Example : `ExampleVpnTunnel1`	string	None
query	vpn_gateway_id optional	VPN Gateway ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string	None
query	vpn_gateway_name optional	VPN Gateway Name Example : `ExampleVpnGW1`	string	None
query	peer_gateway_ip optional	VPN Tunnel Peer Gateway IP Address Example : `123.0.0.2`	string	None
query	remote_subnet optional	VPN Tunnel IPSec Remote Subnet Example : `10.1.0.0/16`	string	None

Responses

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

Example HTTP request

Request path

/v1/vpn-tunnels

Request header

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

Example HTTP response

Response 200

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

9.1.7 - Set VPN Gateway

9.1.7.1 - 1.1

put /v1/vpn-gateways/{vpn_gateway_id}

Description

Set VPN gateway.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpn_gateway_id required	VPN Gateway ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string	None
body	body required		VpnGatewaySetRequest

Responses

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

Example HTTP request

Request path

/v1/vpn-gateways/{vpn_gateway_id}

Request header

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

Request body

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

Example HTTP response

Response 200

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

9.1.7.2 - 1.0

put /v1/vpn-gateways/{vpn_gateway_id}

Description

Set VPN gateway.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpn_gateway_id required	VPN Gateway ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string	None
body	body required		VpnGatewaySetRequest

Responses

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

Example HTTP request

Request path

/v1/vpn-gateways/{vpn_gateway_id}

Request header

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

Request body

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

Example HTTP response

Response 200

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

9.1.8 - Set VPN Tunnel

9.1.8.1 - 1.1

put /v1/vpn-tunnels/{vpn_tunnel_id}

Description

Set VPN tunnel.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpn_tunnel_id required	VPN Tunnel ID Example : `2ade2919287040bc92e557fbbe6709c1`	string	None
body	body required		VpnTunnelSetRequestV1Dot1

Responses

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

Example HTTP request

Request path

/v1/vpn-tunnels/{vpn_tunnel_id}

Request header

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

Request body

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

Example HTTP response

Response 202

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

9.1.8.2 - 1.0

put /v1/vpn-tunnels/{vpn_tunnel_id}

Description

Set VPN tunnel.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpn_tunnel_id required	VPN Tunnel ID Example : `2ade2919287040bc92e557fbbe6709c1`	string	None
body	body required		VpnTunnelSetRequest

Responses

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

Example HTTP request

Request path

/v1/vpn-tunnels/{vpn_tunnel_id}

Request header

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

Request body

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

Example HTTP response

Response 202

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

9.1.9 - Show VPN Gateway

9.1.9.1 - 1.1

get /v1/vpn-gateways/{vpn_gateway_id}

Description

Show VPN gateway.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpn_gateway_id required	VPN Gateway ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string	None

Responses

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

Example HTTP request

Request path

/v1/vpn-gateways/{vpn_gateway_id}

Request header

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

Example HTTP response

Response 200

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

9.1.9.2 - 1.0

get /v1/vpn-gateways/{vpn_gateway_id}

Description

Show VPN gateway.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpn_gateway_id required	VPN Gateway ID Example : `b156740b6335468d8354eb9ef8eddf5a`	string	None

Responses

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

Example HTTP request

Request path

/v1/vpn-gateways/{vpn_gateway_id}

Request header

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

Example HTTP response

Response 200

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

9.1.10 - Show VPN Tunnel

9.1.10.1 - 1.1

get /v1/vpn-tunnels/{vpn_tunnel_id}

Description

Show VPN tunnel.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	vpn_tunnel_id required	VPN Tunnel ID Example : `2ade2919287040bc92e557fbbe6709c1`	string	None

Responses

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

Example HTTP request

Request path

/v1/vpn-tunnels/{vpn_tunnel_id}

Request header

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

Example HTTP response

Response 200

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

9.1.10.2 - 1.0

get /v1/vpn-tunnels/{vpn_tunnel_id}

Description

Show VPN tunnel.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
path	vpn_tunnel_id required	VPN Tunnel ID Example : `2ade2919287040bc92e557fbbe6709c1`	string	None

Responses

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

Example HTTP request

Request path

/v1/vpn-tunnels/{vpn_tunnel_id}

Request header

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

Example HTTP response

Response 200

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

9.2 - Models

9.2.1 - Tag

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

9.2.2 - VpnGateway

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

9.2.3 - VpnGatewayCreateRequest

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

9.2.4 - VpnGatewayListResponse

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]
vpn_gateways required		array[VpnGateway]

9.2.5 - VpnGatewaySetRequest

Name	Description	Schema	Default
description optional	Description Example : `Example Description for VPN Gateway`	string

9.2.6 - VpnGatewayShowResponse

Name	Description	Schema	Default
vpn_gateway required		VpnGateway

9.2.7 - VpnPhase1

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

9.2.8 - VpnPhase1CreateRequest

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

9.2.9 - VpnPhase1CreateRequestV1Dot1

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

9.2.10 - VpnPhase1Detail

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

9.2.11 - VpnPhase1DetailV1Dot1

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

9.2.12 - VpnPhase1SetRequest

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

9.2.13 - VpnPhase1SetRequestV1Dot1

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

9.2.14 - VpnPhase1V1Dot1

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

9.2.15 - VpnPhase2

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

9.2.16 - VpnPhase2CreateRequest

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

9.2.17 - VpnPhase2CreateRequestV1Dot1

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

9.2.18 - VpnPhase2Detail

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

9.2.19 - VpnPhase2DetailV1Dot1

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

9.2.20 - VpnPhase2SetRequest

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

9.2.21 - VpnPhase2SetRequestV1Dot1

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

9.2.22 - VpnPhase2V1Dot1

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

9.2.23 - VpnTunnel

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

9.2.24 - VpnTunnelCreateRequest

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

9.2.25 - VpnTunnelCreateRequestV1Dot1

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

9.2.26 - VpnTunnelDetail

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

9.2.27 - VpnTunnelDetailV1Dot1

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

9.2.28 - VpnTunnelDetailWithStatus

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

9.2.29 - VpnTunnelDetailWithStatusV1Dot1

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

9.2.30 - VpnTunnelListResponse

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]
vpn_tunnels required		array[VpnTunnel]

9.2.31 - VpnTunnelListResponseV1Dot1

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]
vpn_tunnels required		array[VpnTunnelV1Dot1]

9.2.32 - VpnTunnelSetRequest

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

9.2.33 - VpnTunnelSetRequestV1Dot1

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

9.2.34 - VpnTunnelShowResponse

Name	Description	Schema	Default
vpn_tunnel required		VpnTunnelDetail

9.2.35 - VpnTunnelShowResponseV1Dot1

Name	Description	Schema	Default
vpn_tunnel required		VpnTunnelDetailV1Dot1

9.2.36 - VpnTunnelShowWithStatusResponse

Name	Description	Schema	Default
vpn_tunnel required		VpnTunnelDetailWithStatus

9.2.37 - VpnTunnelShowWithStatusResponseV1Dot1

Name	Description	Schema	Default
vpn_tunnel required		VpnTunnelDetailWithStatusV1Dot1

9.2.38 - VpnTunnelV1Dot1

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