ScyllaDB Documentation Logo Documentation
  • Server
    • ScyllaDB Open Source
    • ScyllaDB Enterprise
    • ScyllaDB Alternator
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
Download
Menu

Caution

You're viewing documentation for a previous version of Scylla Manager. Switch to the latest stable version.

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.

PREVIOUS
Scylla Manager Agent Config
NEXT
Scylla Monitoring
  • 2.5
    • master
    • 3.0
    • 2.6
    • 2.5
    • 2.4
    • 2.3
    • 2.2
  • Docker
  • Install Scylla Manager
  • Install Scylla Manager Agent
  • Add a Cluster
  • Backup
    • Setup AWS S3
    • Setup S3 compatible storage
    • Setup Google Cloud Storage
    • Setup Azure Blob Storage
    • Examples
    • Specification
  • Restore
    • Download files command
  • Repair
    • Repair faster
    • Repair slower
    • Examples
  • Health Check
  • CLI sctool
    • Global flags and variables
    • Cluster
    • Backup
    • Repair
    • Status
    • Suspend & Resume
    • Task
    • Version
  • Configuration Files
    • Scylla Manager Config
    • Scylla Manager Agent Config
  • Swagger File
  • Scylla Monitoring
  • Troubleshooting
  • Older Versions
  • Slack
  • Create an issue
  • Edit this page

On this page

  • Swagger File
    • Launch UI in your browser
Logo
Docs Contact Us About Us
Mail List Icon Slack Icon Forum Icon
© 2023, ScyllaDB. All rights reserved.
Last updated on 15 February 2023.
Powered by Sphinx 4.3.2 & ScyllaDB Theme 1.3.4