API Reference

Integrate vncdesktop's powerful remote access capabilities into your applications

Enterprise API Access

The vncdesktop API is exclusively available for Enterprise customers. Upgrade your plan to access our powerful API capabilities.

Upgrade to Enterprise

API Overview

The vncdesktop API provides programmatic access to our remote desktop functionality, allowing you to integrate remote access capabilities directly into your applications.

Secure Authentication

Enterprise-grade security with token-based authentication and granular access controls.

RESTful Design

Intuitive endpoints following REST principles for easy integration with any platform.

Comprehensive SDKs

Official clients for JavaScript, Python, and more to accelerate your development.

Base URL

https://api.vncdesktop.com

All API requests must use HTTPS. Non-secure HTTP requests will be rejected.

Authentication

The vncdesktop API uses token-based authentication. You'll need to obtain an access token which must be included in the Authorization header of your requests:

Authorization: Bearer your-access-token

Authentication Example

Here's how to authenticate with our API and get an access token in different languages:

curl -X POST https://api.vncdesktop.com/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "your-email@example.com",
    "password": "your-secure-password",
    "apiKey": "your-enterprise-api-key"
  }'

API Endpoints

Here are some of the core endpoints available in the vncdesktop API:

Authentication

Authenticate with the vncdesktop API to get an access token

POST/api/v1/auth/login

Request

{
  "email": "your-email@example.com",
  "password": "your-secure-password",
  "apiKey": "your-enterprise-api-key"
}

Response

{
  "success": true,
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "expiresIn": 3600,
    "refreshToken": "abc123def456..."
  }
}

Devices

Retrieve a list of all registered devices for your account

GET/api/v1/devices

Request

// Headers
{
  "Authorization": "Bearer your-access-token"
}

Response

{
  "success": true,
  "data": {
    "devices": [
      {
        "id": "dev_12345",
        "name": "Office Workstation",
        "status": "online",
        "lastSeen": "2023-08-15T14:32:10Z",
        "os": "Windows 10 Pro",
        "ip": "192.168.1.105"
      },
      {
        "id": "dev_67890",
        "name": "Development Server",
        "status": "offline",
        "lastSeen": "2023-08-14T23:12:45Z",
        "os": "Ubuntu 22.04 LTS",
        "ip": "192.168.1.110"
      }
    ],
    "total": 2,
    "page": 1,
    "perPage": 10
  }
}

Sessions

Start a new remote desktop session with a device

POST/api/v1/sessions

Request

{
  "deviceId": "dev_12345",
  "sessionConfig": {
    "quality": "high",
    "enableAudio": true,
    "enableClipboard": true,
    "resolution": {
      "width": 1920,
      "height": 1080
    }
  }
}

Response

{
  "success": true,
  "data": {
    "sessionId": "sess_abc123",
    "connectionUrl": "wss://api.vncdesktop.com/remote/sess_abc123",
    "authToken": "sess_token_xyz789",
    "expiresAt": "2023-08-15T16:30:00Z"
  }
}

Additional API Resources

The vncdesktop API provides a wide range of endpoints for full control over your remote access infrastructure.

User Management

Manage user accounts, permissions, and access controls.

Related Endpoints:

/api/v1/users
/api/v1/permissions
/api/v1/roles

Device Management

Related Endpoints:

/api/v1/devices
/api/v1/devices/:id
/api/v1/device-groups

Session Control

Create, monitor, and terminate remote sessions.

Related Endpoints:

/api/v1/sessions
/api/v1/sessions/:id
/api/v1/sessions/:id/actions

Analytics

Retrieve usage statistics and connection data.

Related Endpoints:

/api/v1/analytics
/api/v1/reports
/api/v1/events

Ready to Integrate with vncdesktop?

Upgrade to our Enterprise plan to unlock full API access and take your remote desktop solution to the next level.

Explore Enterprise Plan Contact Sales