Request
POST /v1/data/ftp · Required scope: view:ftp (pro and ultra tiers)
At least one of server_contains, start_date, or end_date is required.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
server_contains | string | null | One of the three required | — | Case-insensitive substring match against the FTP server host, e.g. "ftp.acme-corp.com" |
start_date | string (date-time) | null | See above | — | Inclusive start filter, clamped by query_window_days |
end_date | string (date-time) | null | See above | — | Inclusive end filter |
sort_direction | asc | desc | No | desc | Must stay constant across pages |
cursor | string | null | No | — | Pagination token |
limit | integer | No | 25 | 1–500, clamped to your tier’s max_rows |
Example request
Response
200 OK — array of FTPRecord, cursor-paginated.
| Field | Description |
|---|---|
victim_id | SHA-256 victim ID — use with Victim Profiles |
server | FTP server hostname or IP |
username | Masked via partial_login on free tier |
password | Returned as "[REDACTED]" on free tier (ftp_password) |
inserted_at | When the record was ingested |
Pagination
Cursor-paginated — see Pagination.Errors
| Status | code | Cause |
|---|---|---|
| 400 | VALIDATION_ERROR | None of server_contains, start_date, end_date provided |
| 400 | INVALID_CURSOR | Tampered or stale cursor |
| 403 | FORBIDDEN_SCOPE | Key lacks view:ftp (free tier) |
Tier notes
This endpoint requiresview:ftp, which is not included on the free
tier — a free-tier key receives 403 FORBIDDEN_SCOPE. Pro and ultra tiers
receive username and password raw; returning a raw ftp_password is
logged to the api_raw_access audit table.