Link Search Menu Expand Document
WiFi Pineapple Mark 7 Developer Docs

Recon

Table of Contents

  1. Introduction
  2. Types
  3. Endpoints

Introduction

Manage Recon

Types 

export interface ReconResult {
    "APResults": []APResult
    "OutOfRangeResult": []APClient
    "UnassociatedResult": []APClient
}


export interface APResult {
    "ssid": string
    "bssid": string
    "encryption": number
    "hidden": number
    "wps": number
    "channel": number
    "signal": number
    "data": number
    "last_seen": number
    "probes": number
    "clients": []APClient
}


export interface APClient {
    "client_mac": string
    "ap_mac": string
    "ap_channel": number
    "data": number
    "broadcast_probes": number
    "direct_probes": number
    "last_seen": string
}

Endpoints

Request Body 

{
    "live": bool,
    "scan_time": number,
    "band": string
}

Response

If successful, returns scan status:

{
    "scanRunning": bool,
    "scanID": number
}

If unsuccessful: See REST Error Responses

Response

If successful, returns success state:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns the current scan status:

{
    "captureRunning": bool,
    "scanRunning": bool,
    "continuous": bool,
    "scanPercent": number,
    "scanID": number
}

If unsuccessful: See REST Error Responses

Response

If successful, returns array of previous scans:

[{
    "scan_id": number,
    "date": string
}]

If unsuccessful: See REST Error Responses

Response

If successful, returns specified scan data:

{
    "APResults": APResult[],
    "OutOfRangeClientResults": APClient[],
    "UnassociatedClientResults": APClient[]
}

If unsuccessful: See REST Error Responses

Response

If successful, returns success state:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns a JSON stream of the specified scan
If unsuccessful: See REST Error Responses