Link Search Menu Expand Document
WiFi Pineapple Mark 7 Developer Docs

Campaigns

Table of Contents

  1. Introduction
  2. Types
  3. Endpoints

Introduction

Manage Campaigns

Types 

export interface Campaign {
    enabled?: boolean;
    content?: string;
    name: string;
    created: number;
    type: number;
    timeout?: boolean;
}


export interface CampaignReport {
    fileName: string;
    fullPath: string;
}

Endpoints

Response

If successful, returns all campaigns:

{
    "campaigns": Campaign[]
}

If unsuccessful: See REST Error Responses

Response

If successful, returns all campaign reports:

{
    "fullPath": string,
    "fileName": string
}

If unsuccessful: See REST Error Responses

Response

If successful, returns success state:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Request Body 

{
    "name": string,
    "mode": number,
    "autoRun": bool,
    "interval": string,
    "plainReport": bool,
    "htmlReport": bool,
    "storagePath": string,
    "enableC2": bool,
    "enableC2Exfil": bool
}

Response

If successful, returns success state:

{
    "success": true
}

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 requested campaign:

{
    "campaign": Campaign
}

If unsuccessful: See REST Error Responses

Request Body 

{
    "name": string,
    "content": string
}

Response

If successful, returns success state:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns success state:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns success state:

{
    "success": true
}

If unsuccessful: See REST Error Responses