Link Search Menu Expand Document

Settings

Table of Contents

  1. Introduction
  2. Types
  3. Endpoints

Introduction

Manage Device Settings

Types

export interface Handshake {
    "mac" string,
    "type": string,
    "extension" string,
    "source": string
}

export interface ClientModeNetwork {
    bssid: string;
    channel: string;
    encryption: boolean;
    password: string;
    quality: string;
    ssid: string;
    hidden: boolean;
    signal: string;
}

Endpoints

Request Body

{
    "old_password": string,
    "new_password": string,
    "confirm_password": string,
}

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns:

{
    "timezone": string
}

If unsuccessful: See REST Error Responses

Request Body

{
    "timezone": string
}

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Request Body

{
    "timestamp": string
}

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns:

{
    "button_script": string
}

If unsuccessful: See REST Error Responses

Request Body

{
    "button_script": string
}

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns Resources: If unsuccessful: See REST Error Responses

Response

If successful, returns:

{
    "devices": string
}

If unsuccessful: See REST Error Responses

Response

If successful, returns:

{
    "channel": string
}

If unsuccessful: See REST Error Responses

Request Body

{
    "channel": string
}

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns:

{
    "update_found": bool,
    "update_version": string,
    "update_changelog": string,
    "channel_closed": bool,
}

If unsuccessful: See REST Error Responses

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Form Body

  • `c2config`: Cloud C2 Configuration

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:

{
    "enrolled": bool
}

If unsuccessful: See REST Error Responses

Response

If successful, returns:

{
    "routes": string
}

If unsuccessful: See REST Error Responses

Response

If successful, returns:

{
    "ssid": string,
    "password": string,
    "hidden": bool,
    "disabled": bool
}

If unsuccessful: See REST Error Responses

Request Body

{
    "ssid": string,
    "password": string,
    "confirm_password": string,
    "hidden": bool,
    "disabled": bool
}

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns:

{
    "ssid": string,
    "country": string,
    "channel": number,
    "hidden": bool
}

If unsuccessful: See REST Error Responses

Request Body

{
    "ssid": string,
    "country": string,
    "channel": number,
    "hidden": bool
}

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns:

{
    "ssid": string,
    "bssid": string,
    "auth": string,
    "password": string,
    "hidden": bool,
    "disabled": bool,
    "capture_handshakes": bool
}

If unsuccessful: See REST Error Responses

Request Body

{
    "ssid": string,
    "bssid": string,
    "auth": string,
    "password": string,
    "confirm_password": string,
    "hidden": bool,
    "disabled": bool,
    "capture_handshakes": bool
}

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns:

{
    "interfaces": string[],
    "connected": bool,
    "ssid": string,
    "ip": string
}

If unsuccessful: See REST Error Responses

Request Body

{
    "interface": string
}

Response

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

Request Body

{
    "ssid": string,
    "bssid": string,
    "encryption": string,
    "password": string,
    "hidden": bool,
    "interface": string
}

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 an array of network interfaces. If unsuccessful: See REST Error Responses

Response

If successful, returns:

{
    "success": true
}

If unsuccessful: See REST Error Responses

Response

If successful, returns:

{
    "completed": bool,
    "output": string
}

If unsuccessful: See REST Error Responses