REST API#
The Jump Desktop REST API is an HTTPS JSON API for automating Jump Desktop for Teams administration. The API is served at https://api.jumpdesktop.com and manages computers, users, Access Groups, installers, activity, and connection history. Use it to integrate Jump Desktop with your own systems, for example to provision computers from an asset database or export connection history.
For command-line automation, Jump CLI Beta wraps the REST API in commands; the --json option produces output that scripts and tools can parse.
- Get started with the REST API: create an API token, find your team ID, and make your first call.
- Manage computers with the REST API: find, rename, and remove computers, create Connect installers, and control access to computers.
- Manage users and access with the REST API: invite and remove users, change roles, and manage Access Groups.
- Read activity, connection history, and billing events: export team logs and billing events to other systems.
- REST API reference: every endpoint, parameter, and response field.
REST API or Jump CLI?#
| Use | When |
|---|---|
| REST API | You are integrating Jump Desktop with your own code or systems, such as provisioning computers from an asset database or exporting connection history. |
| Jump CLI Beta | You want to automate tasks from a terminal or shell script without writing HTTP requests, such as configuring a computer for unattended access (with or without a team), managing a team, or letting an AI agent control hosts through MCP. |
Both use the same API tokens, created in the Teams dashboard.
OpenAPI specification#
The OpenAPI 3.0 specification is a machine-readable description of the REST API. Use it to generate clients or import the API into tools such as Postman.
The REST API reference notes each difference between the specification and the service.