This is the multi-page printable view of this section. Click here to print.
List Security Groups
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 |
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 |