ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Server
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
  • Resources
    • ScyllaDB University
    • Community Forum
    • Tutorials
Download
ScyllaDB Docs Scylla Manager Swagger File

Swagger File¶

Scylla Manager Server ships with Swagger UI that is served under /ui/ URL path. The UI can be used to issue API calls against Scylla Manager Server. It also provides scylla-manager.json API spec file. Using the file you can generate Scylla Manager clients in various programming languages.

../_images/swagger.png

Launch UI in your browser¶

The following procedure instructs how to access a remote Scylla Manager Server UI from your workstation.

Prerequisites

  1. SSH access to host running Scylla Manager Server.

Procedure

  1. Get to know address and port Scylla Manager Server is listening on. By default it’s localhost and port 5080. If that is not the case check the http and https configuration options in the config file.

  2. Open SSH tunnel from your workstation to the Scylla Manager Server host. The following example works with the default settings. If needed adjust address and port.

    ssh -L 5080:localhost:5080 <host>
    
  3. Open http://localhost:5080/ui/ in your browser.

Was this page helpful?

PREVIOUS
Scylla Manager Agent Config
NEXT
ScyllaDB Monitoring
  • Create an issue
  • Edit this page

On this page

  • Swagger File
    • Launch UI in your browser
Scylla Manager
  • 3.5
    • master
    • 3.5
    • 3.4
    • 3.3
  • Docker
  • Install ScyllaDB Manager
  • Install ScyllaDB Manager Agent
  • ScyllaDB Manager Upgrade
  • Compatibility Matrix
  • Add a Cluster
  • Backup
    • Setup Amazon S3
    • Setup S3 compatible storage
    • Setup Google Cloud Storage
    • Setup Azure Blob Storage
    • Examples
    • Specification
  • Restore
    • Restore tables
    • Restore schema for ScyllaDB 6.0/2024.2 or newer
    • Restore schema for ScyllaDB 5.4/2024.1 or older
    • Examples
  • Repair
    • Repair faster
    • Repair slower
    • Examples
  • Health Check
  • CLI sctool
    • Environment variables
    • Completion
    • Download files
    • Backup
    • Restore
    • Cluster
    • Info
    • Progress
    • Repair
    • Start
    • Status
    • Stop
    • Suspend & Resume
    • Tasks
    • Version
  • Configuration Files
    • Scylla Manager Config
    • Scylla Manager Agent Config
  • Swagger File
  • ScyllaDB Monitoring
  • Troubleshooting
  • Slack
Docs Tutorials University Contact Us About Us
© 2025, ScyllaDB. All rights reserved. | Terms of Service | Privacy Policy | ScyllaDB, and ScyllaDB Cloud, are registered trademarks of ScyllaDB, Inc.
Last updated on 07 May 2025.
Powered by Sphinx 7.4.7 & ScyllaDB Theme 1.8.6