Apache Guacamole

Apache Guacamole is a clientless remote desktop gateway that supports standard protocols like VNC, RDP, and SSH. It requires no plugins or client software and provides access to remote desktops through a web browser with a comprehensive REST API for connection, user, and session management.

Apache Guacamole publishes 6 APIs on the APIs.io network, including Active Connections API, Authentication API, Connections API, and 3 more. Tagged areas include Apache, Open Source, RDP, Remote Access, and Remote Desktop.

The Apache Guacamole catalog on APIs.io includes 1 JSON-LD context and 2 Spectral governance rulesets.

Apache Guacamole’s developer surface includes authentication, documentation, getting-started guide, and 7 more developer resources.

🌐 Visit website 📡 Source on GitHub

49.4/100 developing ▼ -5.9 Agent 34/100 agent aware Full breakdown ↓
scored 2026-07-28 · rubric v0.6

AccessFreemiumSelf serve⚡ Free to try

7 APIs 8 Features 5 Use Cases

ApacheOpen SourceRDPRemote AccessRemote DesktopSSHVNCWeb Gateway

Kin Score

Kin Score How this is scored →
scored 2026-07-28 · rubric v0.6

Composite quality — 49.4/100 · developing

Contract Quality 15.9 / 25

Developer Ergonomics 6.1 / 20

Commercial Clarity 7.9 / 20

Operational Transparency 4.8 / 13

Governance 8.3 / 12

Discoverability 6.5 / 10

Agent readiness — 34/100 · agent aware

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

MCP Server 0 / 12

Machine-Readable Auth 10 / 10

Idempotency 0 / 9

Stable Error Semantics 0 / 8

Request/Response Examples 7 / 7

Rate-Limit Signaling 7 / 7

Typed Event Surface 0 / 6

Agent Skills 0 / 5

Well-Known Catalog 0 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 0 / 8

Dry-Run / Simulate Mode 0 / 4

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/apache-guacamole: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 7

Individual APIs this provider publishes, each with its own machine-readable definition.

Apache Guacamole JavaScript Client API

JavaScript client library for embedding the Guacamole remote desktop client in web applications, with APIs for protocol tunneling, display rendering, and user input handling.

Apache Guacamole Active Connections API

Active connection session management

Apache Guacamole Authentication API

Authentication token management

Apache Guacamole Connections API

Remote desktop connection management

Apache Guacamole History API

Connection history and audit logs

Apache Guacamole User Groups API

User group management

Apache Guacamole Users API

User account management

Scroll for all 7

Open Collections 1

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

Apache Guacamole REST API

OPEN COLLECTION

Pricing Plans 1

Published pricing tiers and plan structures.

Apache Guacamole Plans Pricing

3 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Apache Guacamole Rate Limits

5 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Apache Guacamole Finops

FINOPS

Features 8

Notable capabilities this provider offers.

Clientless Remote Desktop

Access remote desktops through any HTML5 web browser with no client software or plugins required.

Multi-Protocol Support

Supports VNC, RDP, SSH, and Telnet protocols through a unified web gateway.

Token-Based Authentication

Stateless REST API authentication using time-limited tokens from the /api/tokens endpoint.

Connection Management

REST API for creating, updating, and organizing remote desktop connections and connection groups.

User and Group Management

Fine-grained user and group permissions for controlling access to connections and administrative functions.

Active Session Monitoring

Monitor and terminate active remote desktop sessions through the REST API.

Connection History

Audit log of all remote desktop sessions with timestamps and user attribution.

Extension API

Java extension API for implementing custom authentication providers, event listeners, and protocol extensions.

Scroll for all 8

Semantic Vocabularies 1

JSON-LD contexts and semantic vocabularies used across these APIs.

Apache Guacamole Rest Context

9 classes · 17 properties

JSON-LD

Spectral Rules 2

Spectral governance rulesets for linting and validating these APIs.

Apache Guacamole API Rules

5 rules · 3 warnings 2 info

SPECTRAL

Apache Guacamole API Rules

16 rules · 4 errors 10 warnings 2 info

SPECTRAL

JSON Schema 7

Standalone JSON Schema definitions for this provider's data models.

ActiveConnection

5 properties

JSON SCHEMA

AuthToken

4 properties

JSON SCHEMA

ConnectionGroup

5 properties

JSON SCHEMA

ConnectionHistoryEntry

6 properties

JSON SCHEMA

Connection

6 properties

JSON SCHEMA

UserGroup

2 properties

JSON SCHEMA

User

4 properties

JSON SCHEMA

Scroll for all 7

JSON Structure 7

JSON Structure definitions describing this provider's data shapes.

Guacamole Rest Active Connection Structure

5 properties

JSON STRUCTURE

Guacamole Rest Auth Token Structure

4 properties

JSON STRUCTURE

Guacamole Rest Connection Group Structure

5 properties

JSON STRUCTURE

Guacamole Rest Connection History Entry Structure

6 properties

JSON STRUCTURE

Guacamole Rest Connection Structure

6 properties

JSON STRUCTURE

Guacamole Rest User Group Structure

2 properties

JSON STRUCTURE

Guacamole Rest User Structure

4 properties

JSON STRUCTURE

Scroll for all 7

Examples 7

Example request and response payloads for these APIs.

Guacamole Rest Active Connection Example

5 fields

EXAMPLE

Guacamole Rest Auth Token Example

4 fields

EXAMPLE

Guacamole Rest Connection Example

6 fields

EXAMPLE

Guacamole Rest Connection Group Example

5 fields

EXAMPLE

Guacamole Rest Connection History Entry Example

6 fields

EXAMPLE

Guacamole Rest User Example

4 fields

EXAMPLE

Guacamole Rest User Group Example

2 fields

EXAMPLE

Scroll for all 7

Security Posture 3

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Apache Guacamole Authentication

apiKey · 1 scheme

SECURITY

Apache Guacamole Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Apache Guacamole Vulnerability Disclosure

security.txt · contact published

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Apache Guacamole Agentic Access

14 operations · 7 acting

AGENTIC

Use Cases 5

What developers build with this provider.

Remote Desktop Access

Provide browser-based access to Linux and Windows desktops for remote workers.

Cloud Server Management

Access cloud VMs and servers through SSH and RDP via browser without installing VPN or client software.

Secure Bastion Host

Use Guacamole as a protocol-proxying bastion host to isolate internal systems from direct network access.

Development Environment Access

Provide developers with browser-based access to containerized or virtualized development environments.

IT Support Tooling

Enable IT helpdesk teams to access and troubleshoot user desktops through the browser.

Integrations 5

Pre-built integrations with other platforms and tools.

Apache Tomcat

Runs as a Java web application on Apache Tomcat or any Java Servlet container.

LDAP / Active Directory

LDAP extension for authenticating users against directory services like Active Directory.

TOTP / Duo MFA

Multi-factor authentication extensions supporting TOTP apps and Duo Security.

MySQL / PostgreSQL

Database authentication extensions for storing connections and users in relational databases.

Kubernetes

Guacamole can be deployed on Kubernetes with the guacamole-client Docker image.

Resources

Get Started 1

Portal, sign-up, and the first successful call

GettingStarted

GettingStarted

Documentation 1

Reference material describing how the API behaves

Documentation

Documentation

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess

AgenticAccess

Design & Contract 2

Pagination, idempotency, versioning, errors, and events

SpectralRules

SpectralRules

Vocabulary

Vocabulary

Build 2

SDKs, sample code, and the tooling you integrate with

GitHubOrganization

GitHubOrganization

GitHubRepository

GitHubRepository

Access & Security 3

Authentication, authorization, and security posture

VulnerabilityDisclosure

VulnerabilityDisclosure

DomainSecurity

DomainSecurity

Authentication

Authentication

Source (apis.yml)

aid: apache-guacamole
name: Apache Guacamole
description: Apache Guacamole is a clientless remote desktop gateway that supports standard protocols like VNC, RDP, and SSH.
  It requires no plugins or client software and provides access to remote desktops through a web browser with a comprehensive
  REST API for connection, user, and session management.
type: Index
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  label: Freemium · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
position: Consumer
access: 3rd-Party
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/apache-guacamole.png
tags:
- Apache
- Open Source
- RDP
- Remote Access
- Remote Desktop
- SSH
- VNC
- Web Gateway
created: '2026-03-16'
modified: '2026-05-19'
url: https://raw.githubusercontent.com/api-evangelist/apache-guacamole/refs/heads/main/apis.yml
specificationVersion: '0.19'
apis:
- aid: apache-guacamole:apache-guacamole-javascript-api
  name: Apache Guacamole JavaScript Client API
  description: JavaScript client library for embedding the Guacamole remote desktop client in web applications, with APIs
    for protocol tunneling, display rendering, and user input handling.
  humanURL: https://guacamole.apache.org/doc/gug/writing-you-own-guacamole-app.html
  tags:
  - JavaScript
  - Remote Desktop
  - SDK
  properties:
  - type: Documentation
    url: https://guacamole.apache.org/doc/gug/writing-you-own-guacamole-app.html
- aid: apache-guacamole:apache-guacamole-active-connections-api
  name: Apache Guacamole Active Connections API
  description: Active connection session management
  humanURL: https://guacamole.apache.org/doc/gug/guacamole-rest-api.html
  baseURL: http://localhost:8080
  tags:
  - Active Connections
  properties:
  - type: OpenAPI
    url: openapi/apache-guacamole-active-connections-api-openapi.yml
  - type: Documentation
    url: https://guacamole.apache.org/doc/gug/guacamole-rest-api.html
  - type: JSONSchema
    url: json-schema/guacamole-rest-auth-token-schema.json
  - type: JSONLD
    url: json-ld/apache-guacamole-rest-context.jsonld
- aid: apache-guacamole:apache-guacamole-authentication-api
  name: Apache Guacamole Authentication API
  description: Authentication token management
  humanURL: https://guacamole.apache.org/doc/gug/guacamole-rest-api.html
  baseURL: http://localhost:8080
  tags:
  - Authentication
  properties:
  - type: OpenAPI
    url: openapi/apache-guacamole-authentication-api-openapi.yml
  - type: Documentation
    url: https://guacamole.apache.org/doc/gug/guacamole-rest-api.html
  - type: JSONSchema
    url: json-schema/guacamole-rest-auth-token-schema.json
  - type: JSONLD
    url: json-ld/apache-guacamole-rest-context.jsonld
- aid: apache-guacamole:apache-guacamole-connections-api
  name: Apache Guacamole Connections API
  description: Remote desktop connection management
  humanURL: https://guacamole.apache.org/doc/gug/guacamole-rest-api.html
  baseURL: http://localhost:8080
  tags:
  - Connections
  properties:
  - type: OpenAPI
    url: openapi/apache-guacamole-connections-api-openapi.yml
  - type: Documentation
    url: https://guacamole.apache.org/doc/gug/guacamole-rest-api.html
  - type: JSONSchema
    url: json-schema/guacamole-rest-auth-token-schema.json
  - type: JSONLD
    url: json-ld/apache-guacamole-rest-context.jsonld
- aid: apache-guacamole:apache-guacamole-history-api
  name: Apache Guacamole History API
  description: Connection history and audit logs
  humanURL: https://guacamole.apache.org/doc/gug/guacamole-rest-api.html
  baseURL: http://localhost:8080
  tags:
  - History
  properties:
  - type: OpenAPI
    url: openapi/apache-guacamole-history-api-openapi.yml
  - type: Documentation
    url: https://guacamole.apache.org/doc/gug/guacamole-rest-api.html
  - type: JSONSchema
    url: json-schema/guacamole-rest-auth-token-schema.json
  - type: JSONLD
    url: json-ld/apache-guacamole-rest-context.jsonld
- aid: apache-guacamole:apache-guacamole-user-groups-api
  name: Apache Guacamole User Groups API
  description: User group management
  humanURL: https://guacamole.apache.org/doc/gug/guacamole-rest-api.html
  baseURL: http://localhost:8080
  tags:
  - User Groups
  properties:
  - type: OpenAPI
    url: openapi/apache-guacamole-user-groups-api-openapi.yml
  - type: Documentation
    url: https://guacamole.apache.org/doc/gug/guacamole-rest-api.html
  - type: JSONSchema
    url: json-schema/guacamole-rest-auth-token-schema.json
  - type: JSONLD
    url: json-ld/apache-guacamole-rest-context.jsonld
- aid: apache-guacamole:apache-guacamole-users-api
  name: Apache Guacamole Users API
  description: User account management
  humanURL: https://guacamole.apache.org/doc/gug/guacamole-rest-api.html
  baseURL: http://localhost:8080
  tags:
  - Users
  properties:
  - type: OpenAPI
    url: openapi/apache-guacamole-users-api-openapi.yml
  - type: Documentation
    url: https://guacamole.apache.org/doc/gug/guacamole-rest-api.html
  - type: JSONSchema
    url: json-schema/guacamole-rest-auth-token-schema.json
  - type: JSONLD
    url: json-ld/apache-guacamole-rest-context.jsonld
common:
- type: AgenticAccess
  url: agentic-access/apache-guacamole-agentic-access.yml
- type: VulnerabilityDisclosure
  url: security/apache-guacamole-vulnerability-disclosure.yml
- type: DomainSecurity
  url: security/apache-guacamole-domain-security.yml
- type: Authentication
  url: authentication/apache-guacamole-authentication.yml
- type: Documentation
  url: https://guacamole.apache.org/doc/gug/
- type: GettingStarted
  url: https://guacamole.apache.org/doc/gug/users-guide.html
- type: GitHubOrganization
  url: https://github.com/apache
- type: GitHubRepository
  url: https://github.com/apache/guacamole-client
- type: SpectralRules
  url: rules/apache-guacamole-spectral-rules.yml
- type: Vocabulary
  url: vocabulary/apache-guacamole-vocabulary.yaml
- type: Features
  data:
  - name: Clientless Remote Desktop
    description: Access remote desktops through any HTML5 web browser with no client software or plugins required.
  - name: Multi-Protocol Support
    description: Supports VNC, RDP, SSH, and Telnet protocols through a unified web gateway.
  - name: Token-Based Authentication
    description: Stateless REST API authentication using time-limited tokens from the /api/tokens endpoint.
  - name: Connection Management
    description: REST API for creating, updating, and organizing remote desktop connections and connection groups.
  - name: User and Group Management
    description: Fine-grained user and group permissions for controlling access to connections and administrative functions.
  - name: Active Session Monitoring
    description: Monitor and terminate active remote desktop sessions through the REST API.
  - name: Connection History
    description: Audit log of all remote desktop sessions with timestamps and user attribution.
  - name: Extension API
    description: Java extension API for implementing custom authentication providers, event listeners, and protocol extensions.
- type: UseCases
  data:
  - name: Remote Desktop Access
    description: Provide browser-based access to Linux and Windows desktops for remote workers.
  - name: Cloud Server Management
    description: Access cloud VMs and servers through SSH and RDP via browser without installing VPN or client software.
  - name: Secure Bastion Host
    description: Use Guacamole as a protocol-proxying bastion host to isolate internal systems from direct network access.
  - name: Development Environment Access
    description: Provide developers with browser-based access to containerized or virtualized development environments.
  - name: IT Support Tooling
    description: Enable IT helpdesk teams to access and troubleshoot user desktops through the browser.
- type: Integrations
  data:
  - name: Apache Tomcat
    description: Runs as a Java web application on Apache Tomcat or any Java Servlet container.
  - name: LDAP / Active Directory
    description: LDAP extension for authenticating users against directory services like Active Directory.
  - name: TOTP / Duo MFA
    description: Multi-factor authentication extensions supporting TOTP apps and Duo Security.
  - name: MySQL / PostgreSQL
    description: Database authentication extensions for storing connections and users in relational databases.
  - name: Kubernetes
    description: Guacamole can be deployed on Kubernetes with the guacamole-client Docker image.
maintainers:
- FN: Kin Lane
  email: info@apievangelist.com