Link Search Menu Expand Document
WiFi Pineapple Mark 7 Developer Docs

PineAP

Table of Contents

  1. Introduction
  2. Types
  3. Endpoints

Introduction

Manage PineAP

Types 

export interface PineAPSettings {
    "enablePineAP": bool,
    "autostartPineAP": bool,
    "ap_channel": string,
    "beacon_interval": string,
    "beacon_response_interval": string,
    "beacon_responses": bool,
    "broadcast_ssid_pool": bool,
    "capture_ssids": bool,
    "connect_notifications": bool,
    "disconnect_notifications": bool,
    "karma": bool,
    "logging": bool,
    "pineap_mac": string,
    "target_mac": string,
}


export interface ChallengeResponse {
    "type": string,
    "username": string,
    "challenge": string,
    "response": string
}


export interface BasicResponse {
    "type": string,
    "identity": string,
    "password": string,
}


export interface Log {
    "type": int,
    "mac": string,
    "ssid": string,
    "duplicates": int,
    "created": int,  
    "updated": int,  
}

Endpoints

Response

If successful, returns current PineAP settings:

{
    "enablePineAP": bool,
    "AutoStart": bool,
    "ap_channel": string,
    "beacon_interval": string,
    "beacon_response_interval": string,
    "beacon_responses": bool,
    "broadcast_ssid_pool": bool,
    "capture_ssids": bool,
    "connect_notifications": bool,
    "disconnect_notifications": bool,
    "karma": bool,
    "logging": bool,
    "pineap_mac": string,
    "target_mac": string
}

If unsuccessful: See REST Error Responses

Request Body 

{
    "enablePineAP": bool,
    "AutoStart": bool,
    "ap_channel": string,
    "beacon_interval": string,
    "beacon_response_interval": string,
    "beacon_responses": bool,
    "broadcast_ssid_pool": bool,
    "capture_ssids": bool,
    "connect_notifications": bool,
    "disconnect_notifications": bool,
    "karma": bool,
    "logging": bool,
    "pineap_mac": string,
    "target_mac": string
}

Response

If successful, returns success state:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns a string of SSIDs seperated by newlines. If unsuccessful: See REST Error Responses

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Request Body 

{
    "ssid": string
}

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Request Body 

{
    "ssid": string
}

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns:

{
    "handshakes": Handshake[]
}

If unsuccessful: See REST Error Responses

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Request Body 

{
    "bssid": string,
    "channel": number,
}

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns:

{
    "captureRunning": bool,
    "bssid": string
}

If unsuccessful: See REST Error Responses

Request Body 

{
    "type": string,
    "bssid": bssid
}

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns:

{
    "enabled": bool,
    "associations": bool,
    "ssid": string,
    "mac": string,
    "type": string,
    "downgrade": string
}

If unsuccessful: See REST Error Responses

Request Body 

{
    "enabled": bool,
    "associations": bool,
    "ssid": string,
    "mac": string,
    "type": string,
    "downgrade": string
}

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns:

{
    "installed": bool
}

If unsuccessful: See REST Error Responses

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Request Body 

{
    "state": string,
    "country": string,
    "locality": string,
    "organization": string,
    "email": string,
    "commonname": string
}

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns BasicResponse[] If unsuccessful: See REST Error Responses

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns ChallengeResponse[]. If unsuccessful: See REST Error Responses

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns Client[]. If unsuccessful: See REST Error Responses

Response

If successful, returns number. If unsuccessful: See REST Error Responses

Request Body 

{
    "mac": string
}

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns PreviousClient[]. If unsuccessful: See REST Error Responses

Request Body 

{
    "mac": string
}

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns Log[]. If unsuccessful: See REST Error Responses

Response

If successful, returns:

{
    "mode": string
}

If unsuccessful: See REST Error Responses

Request Body 

{
    "mode": string
}

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns MAC addresses seperated by newlines. If unsuccessful: See REST Error Responses

Request Body 

{
    "mac": string
}

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Request Body 

{
    "mac": string
}

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns:

{
    "mode": string
}

If unsuccessful: See REST Error Responses

Request Body 

{
    "mode": string
}

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns a string of SSIDs seperated by newlines. If unsuccessful: See REST Error Responses

Request Body 

{
    "mac": string
}

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Request Body 

{
    "ssid": string
}

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Request Body 

{
    "bssid": string,
    "multiplier": number,
    "channel": number,
    "clients": string[]
}

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Request Body 

{
    "bssid": string,
    "mac": string,
    "multiplier": number,
    "channel": number
}

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses