> For the complete documentation index, see [llms.txt](https://vssl.gitbook.io/vssl-rest-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://vssl.gitbook.io/vssl-rest-api/master.md).

# Introduction

The VSSL API is packaged in a Ubuntu SNAP container that can be installed on many Linux platforms.

> The VSSL API provides a single IP address to interface with any VSSL zone on the network. The VSSL agent needs to be installed and running on a Linus device on the network.

This documentation covers:

* Downloading the VSSL agent and setting up the VSSL API using SNAP on Linux
* Configuring a Raspberry Pi to run the VSSL agent
* API documentation

Learn more about VSSL here: <https://vssl.com>

Works with:

* [A.6](https://vssl.com/product/a-6)
* [A.3](https://vssl.com/product/a-3)

## What is REST?

REST is a ubiquitous standard for API's on the web. It allows for a stateless transfer of data. Every major coding library has simple method for communicating with REST based API's. Natively VSSL doesn't implement a REST api on it's products. Hence the use of the VSSL agent.

## Why do I need this?

**Easier integration:** Integrating with the VSSL is a complicated process of maintaining multiple IP connections, monitoring events, and multiple connections.

**Better reliability:** The VSSL agent is a self updating package that is officially maintained by VSSL. We test all methods to ensure reliability with VSSL products.

**Better support for new features:** When VSSL rolls out new features or necessary bug fixes, the VSSL agent is automatically updated by VSSL in conjunction with new FW so your integrations won't break.

## Why not use IP Commands? (We are!)

REST is implemented on HTTP which runs over IP. So this is an IP interface. You can read more about sending IP commands [here](/vssl-rest-api/getting-started/sending-requests.md#tcpip).

This API just takes out all the head ache. Take a look at the documentation.

Give it a try we promise you'll like it!\
[Submit a feature request](https://goo.gl/forms/yh4rzrPEbW7raU0C3)\
[Contact us](https://vssl.com/contact)