List open ports

GEThttps://api.fortwatch.ai/app/ports

Scope issues:readOperation ID listOpenPorts

Open-port issues grouped by port, with the assets each port is open on.

Example request

curl -X GET "https://api.fortwatch.ai/app/ports" \
  -H "Authorization: Bearer $FORTWATCH_API_KEY"

Response 200

The request succeeded.

Field	Type	Description
`ports`required	object[]
`port`required	number
`protocol`required	string
`service`required	object \| null
`severity`required	string
`category`required	string
`issueCategory`required	string
`label`required	string
`issues`required	number
`assets`required	object[]
`id`required	number
`name`required	object \| null
`value`required	string
`type`required	string
`projectName`	string
`projectColor`	object \| null
`issueId`required	number
`seenInLatestScan`required	boolean
`categories`required	object[]
`category`required	string
`label`required	string
`issueCategory`required	string
`total`required	number
`issues`required	number
`critical`required	number
`high`required	number
`medium`required	number
`summary`required	object
`total`required	number
`critical`required	number
`high`required	number
`medium`required	number
`low`required	number
`byCategory`required	object

json

{
  "ports": [
    {
      "port": 1,
      "protocol": "string",
      "service": {},
      "severity": "string",
      "category": "string",
      "issueCategory": "string",
      "label": "string",
      "issues": 1,
      "assets": [
        {}
      ]
    }
  ],
  "categories": [
    {
      "category": "string",
      "label": "string",
      "issueCategory": "string",
      "total": 1,
      "issues": 1,
      "critical": 1,
      "high": 1,
      "medium": 1
    }
  ],
  "summary": {
    "total": 1,
    "critical": 1,
    "high": 1,
    "medium": 1,
    "low": 1,
    "byCategory": {}
  }
}

Errors

`400`	The request is not valid: a field is missing or has the wrong shape (the message names it).
`401`	No valid credentials: the API key or access token is missing, revoked or expired (INVALID_API_KEY, INVALID_TOKEN).
`403`	Not allowed: the key or token lacks this scope (SCOPE_REQUIRED), the route is dashboard-only (SESSION_REQUIRED), or a plan limit applies.
`429`	Too many requests (RATE_LIMITED): wait the seconds Retry-After gives.

Every code is explained in Errors.

This page as Markdown