REST API¶
The Jump Desktop REST API is an HTTPS JSON API at https://api.jumpdesktop.com for automating Jump Desktop for Teams administration: computers, users, Access Groups, installers, activity, and connection history. Use it to connect Jump Desktop to your own systems, for example to provision computers from an asset database or export connection history.
Prefer the command line? Jump CLI (beta) wraps the REST API in commands, and --json gives 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 who can connect.
- 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: pull team logs and billing events into other systems.
- REST API reference: every endpoint, parameter, and response field.
REST API or Jump CLI?¶
| Use | When |
|---|---|
| REST API | You're integrating Jump Desktop into 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 calls, such as setting up a computer for unattended access (with or without a team), managing a team, or letting an AI agent control remote computers through MCP. |
Both work with the same API tokens created in the Teams dashboard.
OpenAPI specification¶
The REST API is described by an OpenAPI 3.0 specification. Use it to generate clients or import the API into tools such as Postman.
Where the specification and the service differ, the REST API reference notes it.