Asset Fingerprint of a Server - Open Port Information
Function
This API is used to check open port information in the asset fingerprints of a server.
URI
GET /v5/{project_id}/asset/ports
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
User ID Minimum: 1 Maximum: 256 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
host_id |
No |
String |
Server ID Minimum: 0 Maximum: 128 |
host_name |
No |
String |
Server name Minimum: 0 Maximum: 128 |
host_ip |
No |
String |
Server IP address Minimum: 0 Maximum: 128 |
port |
No |
Integer |
Port number Minimum: 1 Maximum: 65535 |
type |
No |
String |
Port type Minimum: 0 Maximum: 128 |
enterprise_project_id |
No |
String |
Enterprise project Minimum: 0 Maximum: 256 |
limit |
No |
Integer |
Default value: 10 Minimum: 10 Maximum: 100 Default: 10 |
offset |
No |
Integer |
Default value: 0 Minimum: 0 Maximum: 10000 Default: 0 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
x-auth-token |
Yes |
String |
iam token Minimum: 32 Maximum: 4096 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_num |
Integer |
Total number Minimum: 0 Maximum: 10000 |
data_list |
Array of PortResponseInfo objects |
Port information list |
Parameter |
Type |
Description |
---|---|---|
host_id |
String |
Server ID Minimum: 1 Maximum: 128 |
laddr |
String |
Listening IP address Minimum: 1 Maximum: 128 |
status |
String |
Port status.
Minimum: 1 Maximum: 10 |
port |
Integer |
Port number Minimum: 0 Maximum: 65535 |
type |
String |
Type Minimum: 1 Maximum: 64 |
pid |
Integer |
Process ID Minimum: 1 Maximum: 65535 |
path |
String |
Program file Minimum: 1 Maximum: 256 |
Example Requests
None
Example Responses
Status code: 200
Port information list
{ "total_num" : 1, "data_list" : [ { "host_id" : "3702fbd6-xxxx-xxxx-xxxx-6715770bxxxx", "laddr" : "0.0.0.0", "path" : "/usr/sbin/", "pid" : 1554, "port" : 22, "status" : "unknown", "type" : "TCP" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Port information list |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackFor any further questions, feel free to contact us through the chatbot.
Chatbot