Link Search Menu Expand Document

Generic

Table of Contents

  1. Introduction
  2. Endpoints

Introduction

Generic actions such as shutdown, reboot, and getting the device status.

Endpoints

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 device status:

{
    "versionString": string,
    "version": string,
    "uptime": number,
    "hostname": string,
    "time": number
    "warnings": PineappleWarnings,
    "errors" PineappleErrors
}

If unsuccessful: See REST Error Responses

Response

If successful, returns device model:

{
    "device": string
}

If unsuccessful: See REST Error Responses

Request Body

{
    "filename": string
}

Response

If successful, returns stream of specified file
If unsuccessful: See REST Error Responses

Response

If successful, returns an OUI vendor:

{
    "available": true,
    "vendor": string
}

If unsuccessful: See REST Error Responses

Response

If successful, returns internet connectivity status:

{
    "online": boolean
}

If unsuccessful: See REST Error Responses