Skip to content

Main Navigation Home Install

Appearance

Sidebar Navigation

Documentation

Home

Screenshots

Install

SSL/HTTPS

Reverse Proxy

Remote Browser

Authentication

OIDC / SSO

LDAP

Custom Sources

Scripts & Snippets

Scripting Variables & Directives

CLI

Server CLI

Contributing

API Reference

Account

GET Search Users

GET Get Current User Information

POST Upload Profile Picture

DELETE Remove Profile Picture

GET Get Profile Picture

PATCH Update Password

PATCH Update User Name

POST Register New Account

GET Get TOTP Secret

POST Enable TOTP

POST Disable TOTP

PATCH Update Session Synchronization

PATCH Update User Preferences

GET List API Keys

POST Create API Key

DELETE Delete API Key

GET List Passkeys

POST Get Passkey Registration Options

POST Verify Passkey Registration

DELETE Delete Passkey

PATCH Rename Passkey

AI

GET Get AI Settings

PATCH Update AI Settings

POST Test AI Connection

POST Generate a Terminal Command

GET List Supported AI Providers

GET Get Available AI Models

POST Start Subscription OAuth

POST Complete Subscription OAuth

POST Disconnect Subscription

Audit

GET Get Audit Logs

GET Get Audit Metadata

GET Get Organization Audit Settings

PATCH Update Organization Audit Settings

GET Download Session Recording

Authentication

POST User Authentication

POST User Logout

POST Get Passkey Authentication Options

POST Verify Passkey Authentication

Device Authentication

POST Create Device Authorization Code

POST Poll Device Authorization Status

POST Get Device Code Information

POST Authorize Device Code

POST Check Device Link Status

Auth Providers

GET List Public Auth Providers

GET List All Auth Providers (Admin)

GET Get OIDC Provider

DELETE Delete OIDC Provider

PATCH Update OIDC Provider

PUT Create OIDC Provider

GET Get LDAP Provider

DELETE Delete LDAP Provider

PATCH Update LDAP Provider

PUT Create LDAP Provider

POST Test LDAP Connection

POST Initiate OIDC Login

GET OIDC Callback

Backup

GET List files in recordings or logs directory

DELETE Delete a file from recordings or logs

GET Get Backup Settings

PATCH Update Backup Settings

POST Add Backup Provider

DELETE Delete Backup Provider

PATCH Update Backup Provider

GET Get Storage Statistics

GET List Backups for Provider

POST Create Backup

POST Restore Backup

GET Export the database file

GET Download a specific file from recordings or logs

Engine

GET List Engines

PUT Create New Engine

DELETE Delete Engine

POST Regenerate Engine Token

Entry

GET Get Recent Connections

GET List User Entries

GET Get Entry Details

DELETE Delete Entry

PATCH Update Entry Configuration

PUT Create New Entry

POST Duplicate Entry

POST Import SSH Config

PATCH Reposition Entry

POST Wake Entry Server

Folder

GET List User Folders

PUT Create New Folder

DELETE Delete Folder

PATCH Update Folder

Identity

GET List User Identities

PUT Create New Identity

DELETE Delete Identity

PATCH Update Identity

POST Move Identity to Organization

Integration

GET Get Integration Details

DELETE Delete Integration

PATCH Update Integration

PUT Create Integration

POST Sync Integration Resources

POST Start VM/Container by Entry ID

POST Force Stop VM/Container by Entry ID

POST Graceful Shutdown VM/Container by Entry ID

Keymaps

GET Get User Keymaps

PATCH Update Keymap

POST Reset All Keymaps

POST Reset Single Keymap

Monitoring

GET Get All Servers Monitoring

GET Get Monitoring Settings

PATCH Update Monitoring Settings

GET Get Integration Monitoring

GET Get Server Monitoring

Organization

GET List Organizations

PUT Create Organization

GET Get Organization Details

DELETE Delete Organization

PATCH Update Organization

GET List Organization Members

POST Invite User to Organization

DELETE Remove Organization Member

GET Get Member Permissions

PUT Set Member Permissions

GET Get Live Session Settings

PATCH Update Live Session Settings

GET List Pending Invitations

POST Respond to Organization Invitation

POST Leave Organization

Permissions

GET Permission Catalog

GET List Permission Groups

POST Create Permission Group

PUT Reorder Permission Groups

GET Get Permission Group

DELETE Delete Permission Group

PATCH Update Permission Group

PUT Set Group Permissions

POST Add Group Member

DELETE Remove Group Member

GET Get User Permissions

PUT Set User Groups

PUT Set User Permission Overrides

Scripts

GET Get Scripts

POST Create Custom Script

GET List All Accessible Scripts

GET List All Source Scripts

GET Get Script Details

PUT Update Custom Script

DELETE Delete Custom Script

PATCH Reposition Script

Connection

GET Get Connections

POST Create Connection

GET Get Connection

DELETE Delete Connection

POST Hibernate Connection

POST Resume Connection

POST Start Sharing

DELETE Stop Sharing

PATCH Update Share Permissions

POST Duplicate Connection

POST Paste identity password into session

POST Execute Command

Service

GET Check Status

GET Get Version

Session

GET List Active Sessions

DELETE Destroy Session

SFTP

POST Upload File via SFTP

GET Download or Preview File via SFTP

POST Download Multiple Files via SFTP

Share

GET Get Shared Session Details

Snippet

GET List All Accessible Snippets

GET List All Source Snippets

GET Get Snippet Details

DELETE Delete Snippet

PATCH Update Snippet

PUT Create New Snippet

PATCH Reposition Snippet

Sources

GET List All Sources

POST Create New Source

GET Get Source Details

DELETE Delete Source

PATCH Update Source

POST Validate Source URL

POST Sync Source

POST Sync All Sources

Tag

GET List User Tags

PUT Create New Tag

DELETE Delete Tag

PATCH Update Tag

POST Assign Tag to Entry

DELETE Remove Tag from Entry

GET Get Entry Tags

Theme

GET List All Themes

PUT Create Custom Theme

GET Get Active Theme CSS

GET Get Theme Details

DELETE Delete Theme

PATCH Update Theme

GET Get Theme CSS

PUT Set Active Theme

Users

GET List All Users

PUT Create User Account

POST Impersonate User

DELETE Delete User Account

PATCH Update User Password

Delete Backup Provider

DELETE

/backup/providers/:providerId

Authorizations

BearerAuth

Enter your session token to authenticate API requests

Type

HTTP (bearer)

Responses

Success

Content-Type

application/json

JSON

{

}

DELETE

/backup/providers/:providerId

Playground

Server

Authorization

BearerAuth

Samples

Powered by VitePress OpenAPI

Last updated:

Pager

Previous page POST Add Backup Provider

Next page PATCH Update Backup Provider

Distributed under the MIT License

© 2024 Mathias Wagner