# Nmap: check whether ports are open



Check whether ports are open.



## 1. Run the example



[Download the Nmap example](https://www.security.run/docs/examples/nmap.zip). Extract it, install `httpx`, set your API URL and token, then run `python client.py`. The client uploads the included inputs, submits the command, and saves the result under `results/RUN_ID`.



## 2. Check the result



Read report.xml. The example target listens on port 8000; port 8001 is closed.



Read the native exit code and cleanup status printed by the client. [Read results and save reports](https://www.security.run/docs/visibility.html) explains the returned files.



## 3. Use your own inputs



Edit `example.json` to change the command arguments, requested outputs or deadline. Replace the files under `inputs/` with your own data, keeping the staged paths aligned with the command. The client creates the artifact IDs for you; illustrative IDs shown here must not be copied into a live request.



This example selects the isolated `web-fixture` target. To use a reachable target of your own, change the target arguments or driver and remove `target_profile`. See [Run a check against a target](https://www.security.run/docs/targets.html) for network setup.



Qualified version: `7.95+dfsg-3`. Commands: `nmap`.



Inspect `GET /v1/tools/nmap` for the current installed version and readiness. The published snapshot has 1 functional case(s), plus timeout and cancellation checks. These examples demonstrate the native path; other flags and inputs are supported within the tool’s runtime limits.

## Command submitted by the example

```json
{
  "tool": "nmap",
  "timeout_seconds": 90,
  "invocation": {
    "args": [
      "-sT",
      "-Pn",
      "-n",
      "-p",
      "8000,8001",
      "--reason",
      "-oX",
      "report.xml",
      "127.0.0.1"
    ],
    "outputs": [
      "report.xml"
    ],
    "success_exit_codes": [
      0
    ],
    "executable": "nmap",
    "files": []
  },
  "target_profile": "web-fixture"
}
```