---
title: "GET /getwork"
method: GET
path: "/getwork"
---

# GET /getwork

`GET /getwork`

## Query parameters

- `target` string

## Response `200`

Get a job

- ScanAssignment
  - `scan_id` string — A randomly generated identifier for the agent to store work on disk temporarily
  - `scan_reason` 'automatic' | 'manual' | 'requested' — The reason for performing this scan.
  - `target` string — The target IP address to scan
  - `tags` string[] — A list of tags for the result to be tagged with
  - `agent_config` object
    - `versionDetection` boolean — Tell nmap to attempt version detection (-sV)
    - `osDetection` boolean — Tell nmap to attempt OS detection (-O)
    - `enableScripts` boolean — Tell nmap to use it's scripting engine (--script). Loads all 'scripts'
    - `onlyOpens` boolean — Tell nmap to only report open ports (--open)
    - `scanTimeout` integer — Kill nmap if it takes more than this many seconds
    - `webScreenshots` boolean — Attempt to take screenshots of web servers
    - `vncScreenshots` boolean — Attempt to take screenshots of vnc servers
    - `webScreenshotTimeout` integer — Kill web screenshot process if it takes more than this many seconds
    - `vncScreenshotTimeout` integer — Kill vnc process if it takes more than this many seconds
    - `scriptTimeout` integer — Nmap script timeout (--script-timeout) in seconds
    - `hostTimeout` integer — Nmap host timeout (--host-timeout) in seconds
    - `osScanLimit` boolean — Limit attempts to identify OS (--osscan-limit)
    - `noPing` boolean — Tell nmap to ignore host discovery (-Pn)
    - `udpScan` boolean — Tell nmap to do UDP scan in addition to TCP SYN (-sSU)
    - `scripts` string — The list of scripts to run if enableScripts is true

## Other responses

- `403` — Not authorized. Please provide a valid agent token

---

[API](https://skmtc.net/natlas/apis/natlas-agent-api.md) · [All operations](https://skmtc.net/natlas/apis/natlas-agent-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/natlas/natlas-agent-api/versions/053873ac3f27/schema)