1.1
1.1
get /v1/ports
Description
Get port list.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | with_count optional | with count Example : true | any of [string, null] | None |
| query | limit optional | Port Limit Example : | any of [integer, null] | None |
| query | marker optional | Port Marker Example : | any of [string, null] | None |
| query | sort optional | Port Sort Example : | any of [string, null] | None |
| query | name optional | Port Name Example : | any of [string, null] | None |
| query | subnet_id optional | Subnet Id Example : | any of [string, null] | None |
| query | subnet_name optional | Subnet Name Example : | any of [string, null] | None |
| query | id optional | Port ID Example : | any of [string, null] | None |
| query | attached_resource_id optional | Connected resource ID Example : | any of [string, null] | None |
| query | fixed_ip_address optional | Fixed IP Example : | any of [string, null] | None |
| query | mac_address optional | MAC Address Example : | any of [string, null] | None |
| query | state optional | State Example : | any of [string, null] | None |
| query | security_groups optional | Security Group List Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PortListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/ports
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.1"
Example HTTP response
Response 200
{
"count": 20,
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/notices",
"rel": "self"
}
],
"ports": [
{
"account_id": "",
"attached_resource_id": "",
"attached_resource_type": "",
"created_at": "2026-02-11T06:45:07.029Z",
"description": "",
"fixed_ip_address": "",
"id": "",
"mac_address": "",
"modified_at": "2026-02-11T06:45:07.029Z",
"name": "",
"state": "",
"subnet_id": "",
"subnet_name": "",
"vpc_id": "",
"vpc_name": ""
}
]
}