CMDesk API

Use the CMDesk API to manage remote access sessions programmatically, control users and devices, and pull detailed reports.

Authentication

Getting and using an API key

Session API

Starting and managing sessions

Webhooks

Real-time event notifications

Quick Start

example.js

// API Anahtarı ile Kimlik Doğrulama
const cmdesk = require('@cmdesk/sdk');

const client = new cmdesk.Client({
  apiKey: 'your_api_key_here',
  region: 'eu-central'
});

// Yeni bir oturum başlat
const session = await client.sessions.create({
  targetDeviceId: 'device_123',
  options: {
    quality: 'high',
    recordSession: true
  }
});

console.log('Oturum ID:', session.id);

Sample Webhook Payload

{
  "event": "session.connected",
  "timestamp": "2026-03-28T10:30:00Z",
  "data": {
    "session_id": "sess_abc123",
    "user_id": "usr_xyz789",
    "device_id": "dev_def456",
    "ip_address": "203.0.113.1",
    "started_at": "2026-03-28T10:30:00Z"
  }
}

Rate Limits

Plan	Limit	Burst
Free	100 req/hour	10
Pro	10,000 req/hour	100
Enterprise	Unlimited	1000

Need help?

API Support Security Statement