Skip to content
Skip to content

REST API

v2.1

Full programmatic access to VRSJO resources over HTTPS. All responses are JSON.

Quick Start

curl -X GET \
  -H "Authorization: Bearer TOKEN" \
  -H "Accept: application/json" \
  https://api.VRSJO.io/v2/devices

Authentication

All API requests require a Bearer token in the Authorization header. Generate tokens from the VRSJO Admin under Settings → API Keys. Tokens are scoped to roles and expire after 90 days by default.

Endpoints Overview

MethodPathDescription
GET/v2/devicesList all devices
GET/v2/devices/:idGet device by ID
POST/v2/devicesCreate a device
PATCH/v2/devices/:idUpdate a device
DELETE/v2/devices/:idDelete a device

Rate Limits

The API enforces a default rate limit of 1,000 requests per minute per token. Burst allowance is 200 requests. When exceeded, the API returns 429 Too Many Requests with aRetry-After header indicating when you may resume.

Error Codes

CodeMeaning
400Bad Request — invalid parameters
401Unauthorized — missing or invalid token
403Forbidden — insufficient permissions
404Not Found — resource does not exist
429Too Many Requests — rate limit exceeded
500Internal Server Error