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

Return to the regular view of this page.

CLIs

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

scp-cli security-group address-group-cidr add
--address_group_id <value>
--addresses <value>

Description

Add IP addresses to address group.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
address_group_id required	string	Address Group ID	`4b18494930bf4c5dbb97a9eb2ef68fe1`
addresses required	array	Address Group IP Address List	`10.1.1.1/32`

2 - Create Address Group

2.1 - 1.1

scp-cli security-group address-group create
--name <value>
[--addresses <value>]
[--description <value>]
[--tags <value>]

Description

Create Address Group.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
name required	string	Address Group Name	`ExampleAG1`
addresses optional	array	Address Group IP Address	`10.1.1.1/32`
description optional	string	Address Group Description	`Example Description for Address Group`
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	Address Group ID	4b18494930bf4c5dbb97a9eb2ef68fe1
account_id	Account ID	0e3dffc50eb247a1adf4f2e5c82c4f99
address_count	Address Group Address Count	10
address_limit	Address Group Address Limit	1000
addresses	Address Group IP Address	[‘10.1.1.1/32’, ‘10.1.2.0/24’, ‘10.1.3.0/24’]
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	Example Description for Address Group
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Address Group Name	ExampleAG1
state	Address Group State	ACTIVE

3 - Create Security Group

3.1 - 1.1

scp-cli security-group security-group create
--name <value>
[--description <value>]
[--loggable <value>]
[--tags <value>]

Description

Create Security Group.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
name required	string	Security Group Name	`ExampleSG1`
description optional	string	Security Group Description	`Example Description for Security Group`
loggable optional	boolean	Security Group Loggable	`False`
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	Security Group ID	06e5d676-f330-485a-94e9-47ac91cce09a
account_id	Security Group Account ID	0e3dffc50eb247a1adf4f2e5c82c4f99
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Security Group Description	Example Description for Security Group
loggable	Security Group Loggable	False
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Security Group Name	ExampleSG1
rule_count	Security Group Rule Count	200
state	Security Group State	ACTIVE

3.2 - 1.0

scp-cli security-group security-group create
--name <value>
[--description <value>]
[--loggable <value>]
[--tags <value>]

Description

Create Security Group.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20270131

Parameters

Name	Type	Description	Example
name required	string	Security Group Name	`ExampleSG1`
description optional	string	Security Group Description	`Example Description for Security Group`
loggable optional	boolean	Security Group Loggable	`False`
tags optional	array	Tag List	`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
id	Security Group ID	06e5d676-f330-485a-94e9-47ac91cce09a
account_id	Security Group Account ID	0e3dffc50eb247a1adf4f2e5c82c4f99
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Security Group Description	Example Description for Security Group
loggable	Security Group Loggable	False
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Security Group Name	ExampleSG1
rule_count	Security Group Rule Count	200
state	Security Group State	ACTIVE

4 - Create Security Group Rule

4.1 - 1.1

scp-cli security-group security-group-rule create
--security_group_id <value>
--direction <value>
[--description <value>]
[--ethertype <value>]
[--port_range_max <value>]
[--port_range_min <value>]
[--protocol <value>]
[--remote_address_group_id <value>]
[--remote_group_id <value>]
[--remote_ip_prefix <value>]

Description

Create Security Group rule.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
security_group_id required	string	Security Group ID	`06e5d676-f330-485a-94e9-47ac91cce09a`
direction required	string	Security Group Rule Direction (Ingress, Egress)	`Ingress`
description optional	string	Security Group Rule Description	`Example Description for Security Group Rule`
ethertype optional	string	Security Group Rule Ethertype (IPV4)	`IPv4`
port_range_max optional	integer	Security Group Rule Maximum Port Number(None/1-65535). For ICMP and IP Protocol, None	`22`
port_range_min optional	integer	Security Group Rule Minimum Port Number(None, 1-65535). For ICMP, 0-255. For IP Protocol, None	`22`
protocol optional	string	Security Group Rule Protocol (None, TCP, UDP, ICMP, IP Protocol Number 1-254)	`TCP`
remote_address_group_id optional	string	Security Group Rule Address Group ID	`4b18494930bf4c5dbb97a9eb2ef68fe1`
remote_group_id optional	string	Security Group Rule Remote Group ID	`06e5d676-f330-485a-94e9-47ac91cce09a`
remote_ip_prefix optional	string	Security Group Rule Remote IP Address	`1.1.1.1/32`

Responses

Name	Description	Example
id	Security Group Rule ID	10d8250e-f4eb-453a-96af-b50b5b514a1a
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Security Group Rule Description	Example Description for Security Group Rule
direction	Security Group Rule Direction (Ingress, Egress)	Ingress
ethertype	Security Group Rule Ethertype (IPV4)	IPv4
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
port_range_max	Security Group Rule Maximum Port Number(None/1-65535). For ICMP and IP Protocol, None	22
port_range_min	Security Group Rule Minimum Port Number(None, 1-65535). For ICMP, 0-255. For IP Protocol, None	22
protocol	Security Group Rule Protocol (None, TCP, UDP, ICMP, IP Protocol Number 1-254)	TCP
remote_address_group_id	Address Group ID	4b18494930bf4c5dbb97a9eb2ef68fe1
remote_address_group_name	Address Group Name	ExampleAG1
remote_group_id	Security Group Rule Remote Group ID	06e5d676-f330-485a-94e9-47ac91cce09a
remote_group_name	Security Group Rule Remote Group Name	ExampleSG2
remote_ip_prefix	Security Group Rule Remote IP Address	1.1.1.1/32
security_group_id	Security Group ID	06e5d676-f330-485a-94e9-47ac91cce09a

4.2 - 1.0

scp-cli security-group security-group-rule create
--security_group_id <value>
--direction <value>
[--description <value>]
[--ethertype <value>]
[--port_range_max <value>]
[--port_range_min <value>]
[--protocol <value>]
[--remote_group_id <value>]
[--remote_ip_prefix <value>]

Description

Create Security Group rule.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20270131

Parameters

Name	Type	Description	Example
security_group_id required	string	Security Group ID	`06e5d676-f330-485a-94e9-47ac91cce09a`
direction required	string	Security Group Rule Direction (Ingress, Egress)	`Ingress`
description optional	string	Security Group Rule Description	`Example Description for Security Group Rule`
ethertype optional	string	Security Group Rule Ethertype (IPV4)	`IPv4`
port_range_max optional	integer	Security Group Rule Maximum Port Number(None/1-65535). For ICMP and IP Protocol, None	`22`
port_range_min optional	integer	Security Group Rule Minimum Port Number(None, 1-65535). For ICMP, 0-255. For IP Protocol, None	`22`
protocol optional	string	Security Group Rule Protocol (None, TCP, UDP, ICMP, IP Protocol Number 1-254)	`TCP`
remote_group_id optional	string	Security Group Rule Remote Group ID	`06e5d676-f330-485a-94e9-47ac91cce09a`
remote_ip_prefix optional	string	Security Group Rule Remote IP Address	`1.1.1.1/32`

Responses

Name	Description	Example
id	Security Group Rule ID	10d8250e-f4eb-453a-96af-b50b5b514a1a
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Security Group Rule Description	Example Description for Security Group Rule
direction	Security Group Rule Direction (Ingress, Egress)	Ingress
ethertype	Security Group Rule Ethertype (IPV4)	IPv4
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
port_range_max	Security Group Rule Maximum Port Number(None/1-65535). For ICMP and IP Protocol, None	22
port_range_min	Security Group Rule Minimum Port Number(None, 1-65535). For ICMP, 0-255. For IP Protocol, None	22
protocol	Security Group Rule Protocol (None, TCP, UDP, ICMP, IP Protocol Number 1-254)	TCP
remote_group_id	Security Group Rule Remote Group ID	06e5d676-f330-485a-94e9-47ac91cce09a
remote_group_name	Security Group Rule Remote Group Name	ExampleSG2
remote_ip_prefix	Security Group Rule Remote IP Address	1.1.1.1/32
security_group_id	Security Group ID	06e5d676-f330-485a-94e9-47ac91cce09a

5 - Delete Address Group

5.1 - 1.1

scp-cli security-group address-group delete
--address_group_id <value>

Description

Delete Address Group.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
address_group_id required	string	Address Group ID	`4b18494930bf4c5dbb97a9eb2ef68fe1`

6 - Delete Security Group

6.1 - 1.1

scp-cli security-group security-group delete
--security_group_id <value>

Description

Delete Security Group.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
security_group_id required	string	Security Group ID	-

6.2 - 1.0

scp-cli security-group security-group delete
--security_group_id <value>

Description

Delete Security Group.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20270131

Parameters

Name	Type	Description	Example
security_group_id required	string	Security Group ID	-

7 - Delete Security Group Rule

7.1 - 1.1

scp-cli security-group security-group-rule delete
--security_group_rule_id <value>

Description

Delete Security Group rule.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
security_group_rule_id required	string	Security Group Rule ID	`10d8250e-f4eb-453a-96af-b50b5b514a1a`

7.2 - 1.0

scp-cli security-group security-group-rule delete
--security_group_rule_id <value>

Description

Delete Security Group rule.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20270131

Parameters

Name	Type	Description	Example
security_group_rule_id required	string	Security Group Rule ID	`10d8250e-f4eb-453a-96af-b50b5b514a1a`

8 - List Address Group IPs

8.1 - 1.1

scp-cli security-group address-group-cidr list
--address_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--address <value>]

Description

Get Address Group IP list.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
address_group_id required	string	Address Group ID	`4b18494930bf4c5dbb97a9eb2ef68fe1`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
address optional	string	Address Group IP Address	`10.1.1.1/32`

Responses

Name	Description	Example
addresses	Address Group IP Address List	[‘10.1.1.1/32’, ‘10.1.2.0/24’, ‘10.1.3.0/24’]
count	total count	20
links	links	[{‘href’: ‘http://scp.samsungsdscloud.com/v1/notices’, ‘rel’: ‘self’}]

9 - List Address Groups

9.1 - 1.1

scp-cli security-group address-group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]

Description

Get Address Group list.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
id optional	string	Address Group ID	`4b18494930bf4c5dbb97a9eb2ef68fe1`
name optional	string	Address Group Name	`ExampleAG1`

Responses

Name	Description	Example
id	Address Group ID	4b18494930bf4c5dbb97a9eb2ef68fe1
account_id	Account ID	0e3dffc50eb247a1adf4f2e5c82c4f99
address_count	Address Group Address Count	10
address_limit	Address Group Address Limit	1000
addresses	Address Group IP Address	[‘10.1.1.1/32’, ‘10.1.2.0/24’, ‘10.1.3.0/24’]
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	Example Description for Address Group
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Address Group Name	ExampleAG1
state	Address Group State	ACTIVE

10 - List Security Group Rules

10.1 - 1.1

scp-cli security-group security-group-rule list
--security_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--remote_ip_prefix <value>]
[--remote_group_id <value>]
[--description <value>]
[--direction <value>]
[--service <value>]

Description

Get Security Group rule list.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
security_group_id required	string	Security Group ID	`06e5d676-f330-485a-94e9-47ac91cce09a`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
id optional	string	Security Group Rule ID	`10d8250e-f4eb-453a-96af-b50b5b514a1a`
remote_ip_prefix optional	string	Security Group Rule Remote IP Address	`1.1.1.1/32`
remote_group_id optional	string	Security Group Rule Remote Group ID	`06e5d676-f330-485a-94e9-47ac91cce09a`
description optional	string	Security Group Rule Description	`Example Description for Security Group Rule`
direction optional	string	Security Group Rule Direction (Ingress, Egress)	`Ingress`
service optional	string	Security Group Rule Service	`TCP 22`

Responses

Name	Description	Example
id	Security Group Rule ID	10d8250e-f4eb-453a-96af-b50b5b514a1a
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Security Group Rule Description	Example Description for Security Group Rule
direction	Security Group Rule Direction (Ingress, Egress)	Ingress
ethertype	Security Group Rule Ethertype (IPV4)	IPv4
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
port_range_max	Security Group Rule Maximum Port Number(None/1-65535). For ICMP and IP Protocol, None	22
port_range_min	Security Group Rule Minimum Port Number(None, 1-65535). For ICMP, 0-255. For IP Protocol, None	22
protocol	Security Group Rule Protocol (None, TCP, UDP, ICMP, IP Protocol Number 1-254)	TCP
remote_address_group_id	Address Group ID	4b18494930bf4c5dbb97a9eb2ef68fe1
remote_address_group_name	Address Group Name	ExampleAG1
remote_group_id	Security Group Rule Remote Group ID	06e5d676-f330-485a-94e9-47ac91cce09a
remote_group_name	Security Group Rule Remote Group Name	ExampleSG2
remote_ip_prefix	Security Group Rule Remote IP Address	1.1.1.1/32
security_group_id	Security Group ID	06e5d676-f330-485a-94e9-47ac91cce09a

10.2 - 1.0

scp-cli security-group security-group-rule list
--security_group_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--remote_ip_prefix <value>]
[--remote_group_id <value>]
[--description <value>]
[--direction <value>]
[--service <value>]

Description

Get Security Group rule list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20270131

Parameters

Name	Type	Description	Example
security_group_id required	string	Security Group ID	`06e5d676-f330-485a-94e9-47ac91cce09a`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
id optional	string	Security Group Rule ID	`10d8250e-f4eb-453a-96af-b50b5b514a1a`
remote_ip_prefix optional	string	Security Group Rule Remote IP Address	`1.1.1.1/32`
remote_group_id optional	string	Security Group Rule Remote Group ID	`06e5d676-f330-485a-94e9-47ac91cce09a`
description optional	string	Security Group Rule Description	`Example Description for Security Group Rule`
direction optional	string	Security Group Rule Direction (Ingress, Egress)	`Ingress`
service optional	string	Security Group Rule Service	`TCP 22`

Responses

Name	Description	Example
id	Security Group Rule ID	10d8250e-f4eb-453a-96af-b50b5b514a1a
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Security Group Rule Description	Example Description for Security Group Rule
direction	Security Group Rule Direction (Ingress, Egress)	Ingress
ethertype	Security Group Rule Ethertype (IPV4)	IPv4
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
port_range_max	Security Group Rule Maximum Port Number(None/1-65535). For ICMP and IP Protocol, None	22
port_range_min	Security Group Rule Minimum Port Number(None, 1-65535). For ICMP, 0-255. For IP Protocol, None	22
protocol	Security Group Rule Protocol (None, TCP, UDP, ICMP, IP Protocol Number 1-254)	TCP
remote_group_id	Security Group Rule Remote Group ID	06e5d676-f330-485a-94e9-47ac91cce09a
remote_group_name	Security Group Rule Remote Group Name	ExampleSG2
remote_ip_prefix	Security Group Rule Remote IP Address	1.1.1.1/32
security_group_id	Security Group ID	06e5d676-f330-485a-94e9-47ac91cce09a

11 - List Security Groups

11.1 - 1.1

scp-cli security-group security-group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]

Description

Get Security Group list.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
id optional	string	Security Group ID	-
name optional	string	Security Group Name	-

Responses

Name	Description	Example
id	Security Group ID	06e5d676-f330-485a-94e9-47ac91cce09a
account_id	Security Group Account ID	0e3dffc50eb247a1adf4f2e5c82c4f99
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Security Group Description	Example Description for Security Group
loggable	Security Group Loggable	False
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Security Group Name	ExampleSG1
rule_count	Security Group Rule Count	200
state	Security Group State	ACTIVE

11.2 - 1.0

scp-cli security-group security-group list
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--name <value>]

Description

Get Security Group list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20270131

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
id optional	string	Security Group ID	-
name optional	string	Security Group Name	-

Responses

Name	Description	Example
id	Security Group ID	06e5d676-f330-485a-94e9-47ac91cce09a
account_id	Security Group Account ID	0e3dffc50eb247a1adf4f2e5c82c4f99
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Security Group Description	Example Description for Security Group
loggable	Security Group Loggable	False
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Security Group Name	ExampleSG1
rule_count	Security Group Rule Count	200
state	Security Group State	ACTIVE

12 - Remove Address Group IPs

12.1 - 1.1

scp-cli security-group address-group-cidr remove
--address_group_id <value>
--addresses <value>

Description

Remove IP addresses to address group.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
address_group_id required	string	Address Group ID	`4b18494930bf4c5dbb97a9eb2ef68fe1`
addresses required	array	Address Group IP Address List	`10.1.1.1/32`

13 - Set Address Group

13.1 - 1.1

scp-cli security-group address-group set
--address_group_id <value>
[--description <value>]

Description

Set Address Group.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
address_group_id required	string	Address Group ID	`4b18494930bf4c5dbb97a9eb2ef68fe1`
description optional	string	Address Group Description	`Example Description for Address Group`

14 - Set Security Group

14.1 - 1.1

scp-cli security-group security-group set
--security_group_id <value>
[--description <value>]
[--loggable <value>]

Description

Set Security Group.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
security_group_id required	string	Security Group ID	-
description optional	string	Security Group Description	`Example Description for Security Group`
loggable optional	boolean	Security Group Loggable	`False`

14.2 - 1.0

scp-cli security-group security-group set
--security_group_id <value>
[--description <value>]
[--loggable <value>]

Description

Set Security Group.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20270131

Parameters

Name	Type	Description	Example
security_group_id required	string	Security Group ID	-
description optional	string	Security Group Description	`Example Description for Security Group`
loggable optional	boolean	Security Group Loggable	`False`

15 - Show Address Group

15.1 - 1.1

scp-cli security-group address-group show
--address_group_id <value>

Description

Show Address Group.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
address_group_id required	string	Address Group ID	`4b18494930bf4c5dbb97a9eb2ef68fe1`

Responses

Name	Description	Example
id	Address Group ID	4b18494930bf4c5dbb97a9eb2ef68fe1
account_id	Account ID	0e3dffc50eb247a1adf4f2e5c82c4f99
address_count	Address Group Address Count	10
address_limit	Address Group Address Limit	1000
addresses	Address Group IP Address	[‘10.1.1.1/32’, ‘10.1.2.0/24’, ‘10.1.3.0/24’]
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Description	Example Description for Address Group
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Address Group Name	ExampleAG1
state	Address Group State	ACTIVE

16 - Show Security Group

16.1 - 1.1

scp-cli security-group security-group show
--security_group_id <value>

Description

Show Security Group.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
security_group_id required	string	Security Group ID	-

Responses

Name	Description	Example
id	Security Group ID	06e5d676-f330-485a-94e9-47ac91cce09a
account_id	Security Group Account ID	0e3dffc50eb247a1adf4f2e5c82c4f99
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Security Group Description	Example Description for Security Group
loggable	Security Group Loggable	False
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Security Group Name	ExampleSG1
rule_count	Security Group Rule Count	200
state	Security Group State	ACTIVE

16.2 - 1.0

scp-cli security-group security-group show
--security_group_id <value>

Description

Show Security Group.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20270131

Parameters

Name	Type	Description	Example
security_group_id required	string	Security Group ID	-

Responses

Name	Description	Example
id	Security Group ID	06e5d676-f330-485a-94e9-47ac91cce09a
account_id	Security Group Account ID	0e3dffc50eb247a1adf4f2e5c82c4f99
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Security Group Description	Example Description for Security Group
loggable	Security Group Loggable	False
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Security Group Name	ExampleSG1
rule_count	Security Group Rule Count	200
state	Security Group State	ACTIVE

17 - Show Security Group Rule

17.1 - 1.1

scp-cli security-group security-group-rule show
--security_group_rule_id <value>
[--fields <value>]

Description

Show Security Group rule.

State ACTIVE (CURRENT)

Version	Not Before
1.1	-

Parameters

Name	Type	Description	Example
security_group_rule_id required	string	Security Group Rule ID	`10d8250e-f4eb-453a-96af-b50b5b514a1a`
fields optional	array	Field Name	-

Responses

Name	Description	Example
id	Security Group Rule ID	10d8250e-f4eb-453a-96af-b50b5b514a1a
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Security Group Rule Description	Example Description for Security Group Rule
direction	Security Group Rule Direction (Ingress, Egress)	Ingress
ethertype	Security Group Rule Ethertype (IPV4)	IPv4
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
port_range_max	Security Group Rule Maximum Port Number(None/1-65535). For ICMP and IP Protocol, None	22
port_range_min	Security Group Rule Minimum Port Number(None, 1-65535). For ICMP, 0-255. For IP Protocol, None	22
protocol	Security Group Rule Protocol (None, TCP, UDP, ICMP, IP Protocol Number 1-254)	TCP
remote_address_group_id	Address Group ID	4b18494930bf4c5dbb97a9eb2ef68fe1
remote_address_group_name	Address Group Name	ExampleAG1
remote_group_id	Security Group Rule Remote Group ID	06e5d676-f330-485a-94e9-47ac91cce09a
remote_group_name	Security Group Rule Remote Group Name	ExampleSG2
remote_ip_prefix	Security Group Rule Remote IP Address	1.1.1.1/32
security_group_id	Security Group ID	06e5d676-f330-485a-94e9-47ac91cce09a

17.2 - 1.0

scp-cli security-group security-group-rule show
--security_group_rule_id <value>
[--fields <value>]

Description

Show Security Group rule.

State ACTIVE (SUPPORTED)

Version	Not Before
1.0	20270131

Parameters

Name	Type	Description	Example
security_group_rule_id required	string	Security Group Rule ID	`10d8250e-f4eb-453a-96af-b50b5b514a1a`
fields optional	array	Field Name	-

Responses

Name	Description	Example
id	Security Group Rule ID	10d8250e-f4eb-453a-96af-b50b5b514a1a
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
description	Security Group Rule Description	Example Description for Security Group Rule
direction	Security Group Rule Direction (Ingress, Egress)	Ingress
ethertype	Security Group Rule Ethertype (IPV4)	IPv4
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
port_range_max	Security Group Rule Maximum Port Number(None/1-65535). For ICMP and IP Protocol, None	22
port_range_min	Security Group Rule Minimum Port Number(None, 1-65535). For ICMP, 0-255. For IP Protocol, None	22
protocol	Security Group Rule Protocol (None, TCP, UDP, ICMP, IP Protocol Number 1-254)	TCP
remote_group_id	Security Group Rule Remote Group ID	06e5d676-f330-485a-94e9-47ac91cce09a
remote_group_name	Security Group Rule Remote Group Name	ExampleSG2
remote_ip_prefix	Security Group Rule Remote IP Address	1.1.1.1/32
security_group_id	Security Group ID	06e5d676-f330-485a-94e9-47ac91cce09a