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 - APIs

1.1 - Create Direct Connect

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.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.2 - Create Routing Rule

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.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.3 - Delete Direct Connect

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.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.4 - Delete Routing Rule

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.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.5 - List Direct Connects

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.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.6 - List Routing Rules

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.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.7 - Set Direct Connect

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.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.8 - Show Direct Connect

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.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"
    }
}

2 - Models

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

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

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]

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]

2.5 - DirectConnectSetRequest

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

2.6 - DirectConnectShowResponse

Name	Description	Schema	Default
direct_connect required		DirectConnect

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)

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)

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]

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]

2.11 - RoutingRuleShowResponse

Name	Description	Schema	Default
routing_rule required		RoutingRule

2.12 - Tag

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