HTTP API Reference¶

The HTTP API allows you to integrate remote access and device management capabilities into your own services, applications, or internal systems. It enables you to automate work with devices, connections, users, and other platform entities without the need to perform actions manually in the control panel. The API is suitable for partners, developers, and companies that need to embed remote access functionality into their business processes or products.

Requests¶

All requests must be made over the HTTPS (not HTTP) protocol with an appropriate method for each command at URL:

https://api.getscreen.me/v1/

Authentication¶

API is RESTful: the server doesn't store the client connection state. That's why the client must send authorization data each time a request is sent. An API key is used as such data. Add the key in each request in the X-Api-Key HTTP header:

GET /
Host: https://api.getscreen.me
X-Api-Key: YOUR_API_KEY

curl -X GET "https://api.getscreen.me/" \
-H "X-Api-Key: YOUR_API_KEY" \

Responses¶

Data responses are returned in JSON UTF-8 with ContentType: application/json. Each response wraps data in the data JSON container.

The API server may return the following HTTP response codes:

Available Methods¶

You can find detailed descriptions of the available methods on separate pages. For your convenience, we have grouped these methods by system function so that they match the structure of the control panel interface: