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

Return to the regular view of this page.

APIs

1: Add Address Group IPs

1.1: 1.1

2: Create Address Group

2.1: 1.1

3: Create Security Group

3.1: 1.1
3.2: 1.0

4: Create Security Group Rule

4.1: 1.1
4.2: 1.0

5: Delete Address Group

5.1: 1.1

6: Delete Security Group

6.1: 1.1
6.2: 1.0

7: Delete Security Group Rule

7.1: 1.1
7.2: 1.0

8: List Address Group IPs

8.1: 1.1

9: List Address Groups

9.1: 1.1

10: List Security Group Rules

10.1: 1.1
10.2: 1.0

11: List Security Groups

11.1: 1.1
11.2: 1.0

12: Remove Address Group IPs

12.1: 1.1

13: Set Address Group

13.1: 1.1

14: Set Security Group

14.1: 1.1
14.2: 1.0

15: Show Address Group

15.1: 1.1

16: Show Security Group

16.1: 1.1
16.2: 1.0

17: Show Security Group Rule

17.1: 1.1
17.2: 1.0

1 - Add Address Group IPs

1.1 - 1.1

put /v1/address-groups/{address_group_id}/add_addresses

Description

Add IP addresses to address group.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	address_group_id required	Address Group ID Example : `4b18494930bf4c5dbb97a9eb2ef68fe1`	string	None
body	body required		AddressGroupCidrsAddRequest

Responses

HTTP Code	Description	Schema
200	OK	AddressGroupCidrsAddRequest
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/address-groups/{address_group_id}/add_addresses

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

Request body

{
    "addresses": [
        "10.1.1.1/32",
        "10.1.2.0/24",
        "10.1.3.0/24"
    ]
}

Example HTTP response

Response 200

{
    "addresses": [
        "10.1.1.1/32",
        "10.1.2.0/24",
        "10.1.3.0/24"
    ]
}

2 - Create Address Group

2.1 - 1.1

post /v1/address-groups

Description

Create Address Group.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		AddressGroupCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	AddressGroupShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
409	Conflict	None

Example HTTP request

Request path

/v1/address-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.1"

Request body

{
    "addresses": [
        "10.1.1.1/32",
        "10.1.2.0/24",
        "10.1.3.0/24"
    ],
    "description": "Example Description for Address Group",
    "name": "ExampleAG1",
    "tags": []
}

Example HTTP response

Response 201

{
    "address_group": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "address_count": 10,
        "address_limit": 1000,
        "addresses": [
            "10.1.1.1/32",
            "10.1.2.0/24",
            "10.1.3.0/24"
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Address Group",
        "id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleAG1",
        "state": "ACTIVE"
    }
}

3 - Create Security Group

3.1 - 1.1

post /v1/security-groups

Description

Create Security Group.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

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

Request body

{
    "description": "Example Description for Security Group",
    "loggable": false,
    "name": "ExampleSG1",
    "tags": []
}

Example HTTP response

Response 201

{
    "security_group": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Security Group",
        "id": "06e5d676-f330-485a-94e9-47ac91cce09a",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleSG1",
        "rule_count": 200,
        "state": "ACTIVE"
    }
}

3.2 - 1.0

post /v1/security-groups

Description

Create Security Group.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20270131

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": "Example Description for Security Group",
    "loggable": false,
    "name": "ExampleSG1",
    "tags": []
}

Example HTTP response

Response 201

{
    "security_group": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Security Group",
        "id": "06e5d676-f330-485a-94e9-47ac91cce09a",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleSG1",
        "rule_count": 200,
        "state": "ACTIVE"
    }
}

4 - Create Security Group Rule

4.1 - 1.1

post /v1/security-group-rules

Description

Create Security Group rule.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		SecurityGroupRuleCreateRequestV1Dot1

Responses

HTTP Code	Description	Schema
201	Created	SecurityGroupRuleShowResponseV1Dot1
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.1"

Request body

{
    "description": "Example Description for Security Group Rule",
    "direction": "Ingress",
    "ethertype": "IPv4",
    "port_range_max": 22,
    "port_range_min": 22,
    "protocol": "TCP",
    "remote_address_group_id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
    "remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
    "remote_ip_prefix": "1.1.1.1/32",
    "security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
}

Example HTTP response

Response 201

{
    "security_group_rule": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Security Group Rule",
        "direction": "Ingress",
        "ethertype": "IPv4",
        "id": "10d8250e-f4eb-453a-96af-b50b5b514a1a",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "port_range_max": 22,
        "port_range_min": 22,
        "protocol": "TCP",
        "remote_address_group_id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
        "remote_address_group_name": "ExampleAG1",
        "remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
        "remote_group_name": "ExampleSG2",
        "remote_ip_prefix": "1.1.1.1/32",
        "security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
    }
}

4.2 - 1.0

post /v1/security-group-rules

Description

Create Security Group rule.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20270131

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": "Example Description for Security Group Rule",
    "direction": "Ingress",
    "ethertype": "IPv4",
    "port_range_max": 22,
    "port_range_min": 22,
    "protocol": "TCP",
    "remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
    "remote_ip_prefix": "1.1.1.1/32",
    "security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
}

Example HTTP response

Response 201

{
    "security_group_rule": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Security Group Rule",
        "direction": "Ingress",
        "ethertype": "IPv4",
        "id": "10d8250e-f4eb-453a-96af-b50b5b514a1a",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "port_range_max": 22,
        "port_range_min": 22,
        "protocol": "TCP",
        "remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
        "remote_group_name": "ExampleSG2",
        "remote_ip_prefix": "1.1.1.1/32",
        "security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
    }
}

5 - Delete Address Group

5.1 - 1.1

delete /v1/address-groups/{address_group_id}

Description

Delete Address Group.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	address_group_id required	Address Group ID Example : `4b18494930bf4c5dbb97a9eb2ef68fe1`	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/address-groups/{address_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.1"

Example HTTP response

Response 204

6 - Delete Security Group

6.1 - 1.1

delete /v1/security-groups/{security_group_id}

Description

Delete Security Group.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

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

Example HTTP response

Response 204

6.2 - 1.0

delete /v1/security-groups/{security_group_id}

Description

Delete Security Group.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20270131

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 - Delete Security Group Rule

7.1 - 1.1

delete /v1/security-group-rules/{security_group_rule_id}

Description

Delete Security Group rule.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	security_group_rule_id required	Security Group Rule ID Example : `10d8250e-f4eb-453a-96af-b50b5b514a1a`	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.1"

Example HTTP response

Response 204

7.2 - 1.0

delete /v1/security-group-rules/{security_group_rule_id}

Description

Delete Security Group rule.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20270131

Parameters

Type	Name	Description	Schema	Default
path	security_group_rule_id required	Security Group Rule ID Example : `10d8250e-f4eb-453a-96af-b50b5b514a1a`	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

8 - List Address Group IPs

8.1 - 1.1

get /v1/address-groups/{address_group_id}/addresses

Description

Get Address Group IP list.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	address_group_id required	Address Group ID Example : `4b18494930bf4c5dbb97a9eb2ef68fe1`	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	address optional	Address Group IP Address Example : `10.1.1.1/32`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	AddressGroupCidrListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/address-groups/{address_group_id}/addresses

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

Example HTTP response

Response 200

{
    "addresses": [
        "10.1.1.1/32",
        "10.1.2.0/24",
        "10.1.3.0/24"
    ],
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

9 - List Address Groups

9.1 - 1.1

get /v1/address-groups

Description

Get Address Group 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	Address Group ID Example : `4b18494930bf4c5dbb97a9eb2ef68fe1`	string	None
query	name optional	Address Group Name Example : `ExampleAG1`	string	None

Responses

HTTP Code	Description	Schema
200	OK	AddressGroupListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/address-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.1"

Example HTTP response

Response 200

{
    "address_groups": [
        {
            "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "address_count": 10,
            "address_limit": 1000,
            "addresses": [
                "10.1.1.1/32",
                "10.1.2.0/24",
                "10.1.3.0/24"
            ],
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Example Description for Address Group",
            "id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ExampleAG1",
            "state": "ACTIVE"
        }
    ],
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

10 - List Security Group Rules

10.1 - 1.1

get /v1/security-group-rules

Description

Get Security Group rule 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	Security Group Rule ID Example : `10d8250e-f4eb-453a-96af-b50b5b514a1a`	string	None
query	security_group_id required	Security Group ID Example : `06e5d676-f330-485a-94e9-47ac91cce09a`	string	None
query	remote_ip_prefix optional	Security Group Rule Remote IP Address Example : `1.1.1.1/32`	string	None
query	remote_group_id optional	Security Group Rule Remote Group ID Example : `06e5d676-f330-485a-94e9-47ac91cce09a`	string	None
query	description optional	Security Group Rule Description Example : `Example Description for Security Group Rule`	string	None
query	direction optional	Security Group Rule Direction (Ingress, Egress) Example : `Ingress`	string	None
query	service optional	Security Group Rule Service Example : `TCP 22`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SecurityGroupRuleListResponseV1Dot1
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.1"

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": "Example Description for Security Group Rule",
            "direction": "Ingress",
            "ethertype": "IPv4",
            "id": "10d8250e-f4eb-453a-96af-b50b5b514a1a",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "port_range_max": 22,
            "port_range_min": 22,
            "protocol": "TCP",
            "remote_address_group_id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
            "remote_address_group_name": "ExampleAG1",
            "remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
            "remote_group_name": "ExampleSG2",
            "remote_ip_prefix": "1.1.1.1/32",
            "security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
        }
    ]
}

10.2 - 1.0

get /v1/security-group-rules

Description

Get Security Group rule list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20270131

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 : `10d8250e-f4eb-453a-96af-b50b5b514a1a`	string	None
query	security_group_id required	Security Group ID Example : `06e5d676-f330-485a-94e9-47ac91cce09a`	string	None
query	remote_ip_prefix optional	Security Group Rule Remote IP Address Example : `1.1.1.1/32`	string	None
query	remote_group_id optional	Security Group Rule Remote Group ID Example : `06e5d676-f330-485a-94e9-47ac91cce09a`	string	None
query	description optional	Security Group Rule Description Example : `Example Description for Security Group Rule`	string	None
query	direction optional	Security Group Rule Direction (Ingress, Egress) Example : `Ingress`	string	None
query	service optional	Security Group Rule Service Example : `TCP 22`	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": "Example Description for Security Group Rule",
            "direction": "Ingress",
            "ethertype": "IPv4",
            "id": "10d8250e-f4eb-453a-96af-b50b5b514a1a",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "port_range_max": 22,
            "port_range_min": 22,
            "protocol": "TCP",
            "remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
            "remote_group_name": "ExampleSG2",
            "remote_ip_prefix": "1.1.1.1/32",
            "security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
        }
    ]
}

11 - List Security Groups

11.1 - 1.1

get /v1/security-groups

Description

Get Security Group 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	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.1"

Example HTTP response

Response 200

{
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ],
    "security_groups": [
        {
            "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Example Description for Security Group",
            "id": "06e5d676-f330-485a-94e9-47ac91cce09a",
            "loggable": false,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ExampleSG1",
            "rule_count": 200,
            "state": "ACTIVE"
        }
    ]
}

11.2 - 1.0

get /v1/security-groups

Description

Get Security Group list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20270131

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": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Example Description for Security Group",
            "id": "06e5d676-f330-485a-94e9-47ac91cce09a",
            "loggable": false,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "ExampleSG1",
            "rule_count": 200,
            "state": "ACTIVE"
        }
    ]
}

12 - Remove Address Group IPs

12.1 - 1.1

put /v1/address-groups/{address_group_id}/remove_addresses

Description

Remove IP addresses to address group.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	address_group_id required	Address Group ID Example : `4b18494930bf4c5dbb97a9eb2ef68fe1`	string	None
body	body required		AddressGroupCidrsAddRequest

Responses

HTTP Code	Description	Schema
200	OK	AddressGroupCidrsAddRequest
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/address-groups/{address_group_id}/remove_addresses

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

Request body

{
    "addresses": [
        "10.1.1.1/32",
        "10.1.2.0/24",
        "10.1.3.0/24"
    ]
}

Example HTTP response

Response 200

{
    "addresses": [
        "10.1.1.1/32",
        "10.1.2.0/24",
        "10.1.3.0/24"
    ]
}

13 - Set Address Group

13.1 - 1.1

put /v1/address-groups/{address_group_id}

Description

Set Address Group.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	address_group_id required	Address Group ID Example : `4b18494930bf4c5dbb97a9eb2ef68fe1`	string	None
body	body required		AddressGroupSetRequest

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/address-groups/{address_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.1"

Request body

{
    "description": "Example Description for Address Group"
}

Example HTTP response

Response 200

14 - Set Security Group

14.1 - 1.1

put /v1/security-groups/{security_group_id}

Description

Set Security Group.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

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

Request body

{
    "description": "Example Description for Security Group",
    "loggable": false
}

Example HTTP response

Response 200

14.2 - 1.0

put /v1/security-groups/{security_group_id}

Description

Set Security Group.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20270131

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": "Example Description for Security Group",
    "loggable": false
}

Example HTTP response

Response 200

15 - Show Address Group

15.1 - 1.1

get /v1/address-groups/{address_group_id}

Description

Show Address Group.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	address_group_id required	Address Group ID Example : `4b18494930bf4c5dbb97a9eb2ef68fe1`	string	None

Responses

HTTP Code	Description	Schema
200	OK	AddressGroupShowResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/address-groups/{address_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.1"

Example HTTP response

Response 200

{
    "address_group": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "address_count": 10,
        "address_limit": 1000,
        "addresses": [
            "10.1.1.1/32",
            "10.1.2.0/24",
            "10.1.3.0/24"
        ],
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Address Group",
        "id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleAG1",
        "state": "ACTIVE"
    }
}

16 - Show Security Group

16.1 - 1.1

get /v1/security-groups/{security_group_id}

Description

Show Security Group.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

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

Example HTTP response

Response 200

{
    "security_group": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Security Group",
        "id": "06e5d676-f330-485a-94e9-47ac91cce09a",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleSG1",
        "rule_count": 200,
        "state": "ACTIVE"
    }
}

16.2 - 1.0

get /v1/security-groups/{security_group_id}

Description

Show Security Group.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20270131

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": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Security Group",
        "id": "06e5d676-f330-485a-94e9-47ac91cce09a",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "ExampleSG1",
        "rule_count": 200,
        "state": "ACTIVE"
    }
}

17 - Show Security Group Rule

17.1 - 1.1

get /v1/security-group-rules/{security_group_rule_id}

Description

Show Security Group rule.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	security_group_rule_id required	Security Group Rule ID Example : `10d8250e-f4eb-453a-96af-b50b5b514a1a`	string	None
query	fields optional	Field Name Example :	any of [array[object], string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	SecurityGroupRuleShowResponseV1Dot1
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.1"

Example HTTP response

Response 200

{
    "security_group_rule": {
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Example Description for Security Group Rule",
        "direction": "Ingress",
        "ethertype": "IPv4",
        "id": "10d8250e-f4eb-453a-96af-b50b5b514a1a",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "port_range_max": 22,
        "port_range_min": 22,
        "protocol": "TCP",
        "remote_address_group_id": "4b18494930bf4c5dbb97a9eb2ef68fe1",
        "remote_address_group_name": "ExampleAG1",
        "remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
        "remote_group_name": "ExampleSG2",
        "remote_ip_prefix": "1.1.1.1/32",
        "security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
    }
}

17.2 - 1.0

get /v1/security-group-rules/{security_group_rule_id}

Description

Show Security Group rule.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20270131

Parameters

Type	Name	Description	Schema	Default
path	security_group_rule_id required	Security Group Rule ID Example : `10d8250e-f4eb-453a-96af-b50b5b514a1a`	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": "Example Description for Security Group Rule",
        "direction": "Ingress",
        "ethertype": "IPv4",
        "id": "10d8250e-f4eb-453a-96af-b50b5b514a1a",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "port_range_max": 22,
        "port_range_min": 22,
        "protocol": "TCP",
        "remote_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a",
        "remote_group_name": "ExampleSG2",
        "remote_ip_prefix": "1.1.1.1/32",
        "security_group_id": "06e5d676-f330-485a-94e9-47ac91cce09a"
    }
}