API REFERENCE · GET · STABLE

Common Ports Catalogue API — /api/v1/ip/common-ports

Returns the catalogue used by the port-scan UI to label well-known services. Cache forever — it's a static list.

01 · OVERVIEW

What Common Ports Catalogue does

Returns the catalogue used by the port-scan UI to label well-known services. Cache forever — it's a static list.

  • Method GET
  • Path /api/v1/ip/common-ports
  • Stability STABLE
  • Version v2026-05-15
  • Summary Static reference list of well-known TCP ports.
03 · RESPONSE

Response schema

All successful responses follow the standard `{ success: true, data: {...} }` envelope. Notable fields on the data object for this endpoint:

  • data.server_ports[] — array<object> Each: `{port, protocol, description}`.
04 · EXAMPLE

Example response

Truncated but representative example for a real lookup:

Sample response
{
  "success": true,
  "data": {
    "server_ports": [
      {
        "port": 22,
        "protocol": "SSH",
        "description": "Secure Shell"
      },
      {
        "port": 80,
        "protocol": "HTTP",
        "description": "Hypertext Transfer Protocol"
      },
      {
        "port": 443,
        "protocol": "HTTPS",
        "description": "Secure HTTP"
      }
    ]
  }
}
06 · BEST PRACTICES

Implementation tips

Patterns we recommend when integrating this endpoint:

  • Fetch once and cache in localStorage — zero churn.