Skip to main content
Skip table of contents

API Commands

Route/EndPoint

Method

Function

Description

Example Results

api/recording | api/anomalies

GET

/isrecording

Collect recording status.

CODE
{
  "IsRecording": false
}

api/recording | api/anomalies

GET

/start

Send the start command.

Nothing

api/recording | api/anomalies

GET

/stop

Send the stop command.

Nothing

api/stats

GET

/ping

Replies with true/false if the ping was complete.

CODE
{
  "Ping": true
}

api/framegrabs

GET

/fileextension

Replies with a JSON showing “.{extension}”.

CODE
{
  "FileExtension", ".jpg"
}

api/framegrabs

POST

/take

Replies with status 200 when operation is valid.

CODE
{
  "Path":"D:\\picture_name.png"
}

api/recording | api/anomalies

POST

/filename

Adds a filename

CODE
{
  "Filename":"D:\\folder\\filename.mp4"
}

api/recording | api/anomalies

GET

/fileextension

Collect the file extension.

CODE
{
  "FileExtension": "mp4"
}

api/recording | api/anomalies

GET

/filename

Collect the filename.

CODE
{
  "Filename":"D:\\folder\\filename.mp4"
}

api/recording | api/anomalies

GET

/status

Collect current status.

CODE
{
  "IsRecording":false,
  "DriveSpace":41
}

api/recordersettings

POST

/apply

Apply the settings to the recording VMs.

CODE
{
  **PENDING**
}

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.