# Port Scanner (`serhattsnmz/port-scanner`) Actor

Get open ports and port vulnerabilities of given IP addresses or hosts.

- **URL**: https://apify.com/serhattsnmz/port-scanner.md
- **Developed by:** [Serhat Sönmez](https://apify.com/serhattsnmz) (community)
- **Categories:** Developer tools, Automation, Integrations
- **Features:** Full permissions
- **Stats:** 58 total users, 0 monthly users, 100.0% runs succeeded, 3 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-usage

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

### Port Scanner

Port Scanner actor helps you to get information on multiple servers/hosts and discover open ports with their vulnerabilities.

You can discover following information:

- Open TCP ports and their vulnerabilities
- Open UDP ports and their vulnerabilities
- IP addresses of the hosts
- Hostnames of the IP addresses
- Current status of the host
- OS information of the host server

### Example Response

```json
[
  {
    "host": "console.apify.com",
    "hostnames": [
      {
        "name": "console.apify.com",
        "type": "user"
      },
      {
        "name": "ec2-100-25-66-255.compute-1.amazonaws.com",
        "type": "PTR"
      }
    ],
    "addresses": {
      "ipv4": "100.25.66.255"
    },
    "status": {
      "state": "up",
      "reason": "syn-ack"
    },
    "uptime": {
      "seconds": "3354905",
      "lastboot": "Sun Dec 31 03:03:11 2023"
    },
    "tcp": {
      "80": {
        "state": "open",
        "reason": "syn-ack",
        "name": "http",
        "product": "awselb/2.0",
        "version": "",
        "extrainfo": "",
        "cpe": "",
        "vulnerability": {...}
      },
      "443": {
        "state": "open",
        "reason": "syn-ack",
        "name": "https",
        "product": "awselb/2.0",
        "version": "",
        "extrainfo": "",
        "cpe": "",
        "vulnerability": {...}
      }
    },
    "osmatch": [
      {
        "name": "Linux 4.2",
        "accuracy": "85",
        "line": "67020",
        "osclass": [
          {
            "type": "general purpose",
            "vendor": "Linux",
            "osfamily": "Linux",
            "osgen": "4.X",
            "accuracy": "85",
            "cpe": [
              "cpe:/o:linux:linux_kernel:4.2"
            ]
          }
        ]
      }
    ]
  }
]
```

# Actor input Schema

## `hosts` (type: `array`):

One or more IP addresses or domains that you want to scan.

## `portRange` (type: `string`):

Select how many ports to scan. Increasing the number of ports will increase the scan time.

## `enableOsDetection` (type: `boolean`):

Try to determine operating system details. Enabling this option will increase the scan time.

## `scanServices` (type: `boolean`):

Probe open ports to determine service/version info. Enabling this option will increase the scan time.

## `includeUdpPorts` (type: `boolean`):

By default only TCP scanning is performed. This option can be checked if UDP scanning is also desired. Enabling this option will increase the scan time.

## `scanVulnerabilities` (type: `boolean`):

Get more informaiton about services on the port and perform vulnerability scanning. Enabling this option will increase the scan time.

## `scanVulnerabilitiesExtended` (type: `boolean`):

Get more informaiton about services on the port and perform vulnerability scanning. This perform like option above but does more test and takes more time. Enabling this option will highly increase the scan time.

## Actor input object example

```json
{
  "hosts": [
    "1.1.1.1",
    "apify.com"
  ],
  "portRange": "top-100",
  "enableOsDetection": false,
  "scanServices": false,
  "includeUdpPorts": false,
  "scanVulnerabilities": false,
  "scanVulnerabilitiesExtended": false
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "hosts": [
        "apify.com"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("serhattsnmz/port-scanner").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "hosts": ["apify.com"] }

# Run the Actor and wait for it to finish
run = client.actor("serhattsnmz/port-scanner").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "hosts": [
    "apify.com"
  ]
}' |
apify call serhattsnmz/port-scanner --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,serhattsnmz/port-scanner"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/mDG8MtKAkf5Cxp0yu/builds/ZY9PEC8hQ8EtoDXdt/openapi.json