> ## Documentation Index
> Fetch the complete documentation index at: https://docs.techslayers.ca/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Start a Senthrex scan, monitor progress, and retrieve reports and JSON results.

# Quickstart

This guide shows the standard Senthrex workflow using the bearer token and the scan UUID returned from `/scan`.

## 1) Set your bearer token

```bash theme={null}
export SENTHREX_TOKEN="YOUR_BEARER_TOKEN"
```

## 2) Start a scan (recommended: POST)

```bash theme={null}
curl -X POST "https://rts-senthrex.slayers.tech/scan" \
  -H "Authorization: Bearer $SENTHREX_TOKEN" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "domain=example.com" \
  --data-urlencode "mode=full"
```

`mode` is optional and defaults to `full`. Use `discovery` for a lighter scan profile.

The response includes a `uuid` (scan UUID). Use it as `scan_uuid` in all follow-up requests.

## 3) Check scan status

```bash theme={null}
curl -X GET "https://rts-senthrex.slayers.tech/status/YOUR_SCAN_UUID" \
  -H "Authorization: Bearer $SENTHREX_TOKEN"
```

## 4) Retrieve outputs

### Structured results

```bash theme={null}
curl -X GET "https://rts-senthrex.slayers.tech/results/YOUR_SCAN_UUID" \
  -H "Authorization: Bearer $SENTHREX_TOKEN"
```

### Logs

```bash theme={null}
curl -X GET "https://rts-senthrex.slayers.tech/logs/YOUR_SCAN_UUID" \
  -H "Authorization: Bearer $SENTHREX_TOKEN"
```

### Report archive

```bash theme={null}
curl -X GET "https://rts-senthrex.slayers.tech/report/YOUR_SCAN_UUID" \
  -H "Authorization: Bearer $SENTHREX_TOKEN"
```

### Raw JSON artifact

```bash theme={null}
curl -X GET "https://rts-senthrex.slayers.tech/json/YOUR_SCAN_UUID" \
  -H "Authorization: Bearer $SENTHREX_TOKEN"
```

## 5) Stop a running scan (optional)

```bash theme={null}
curl -X POST "https://rts-senthrex.slayers.tech/scan/YOUR_SCAN_UUID/stop" \
  -H "Authorization: Bearer $SENTHREX_TOKEN"
```

## Next steps

* `/senthrex/api/start-scan-post`
* `/senthrex/api/get-status`
* `/senthrex/api/get-results`
* `/senthrex/api/get-scan-json`
* `/senthrex/api/list-scans`