ScyllaDB University Live | Free Virtual Training Event
Learn more
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
ScyllaDB Docs ScyllaDB Cloud API Documentation (BETA) Get Started with the ScyllaDB Cloud API

Get Started with the ScyllaDB Cloud API¶

ScyllaDB Cloud exposes a REST API, which offers programmatic access to the information available via the ScyllaDB Cloud UI and allows you to automate deployment.

Before accessing the API, you must obtain an API access token - a secret key for authenticating calls to the API endpoints that determines your privileges. The privileges enforced by the API key match the permissions granted to your role as a user (Admin, Maintainer, or Viewer).

Obtaining an API Key Beta¶

To get your API key, open a support ticket with your request:

Subject: Request for the API key

Was this page helpful?

PREVIOUS
API Documentation (BETA)
NEXT
Terraform Provider for ScyllaDB Cloud
ScyllaDB Cloud
  • New to ScyllaDB? Start here!
  • Quick Start Guide to ScyllaDB Cloud
  • About ScyllaDB Cloud as a Service
    • Benefits
    • Backups
    • Best Practices
    • Managing ScyllaDB Versions
    • Support, Alerts, and SLA Commitments
    • Costs
  • Deployment
    • Cloud Providers
    • Deploy ScyllaDB Cloud to Your Own AWS Account
    • AWS Virtual Private Network (VPC) Peering Setup Guide
    • GCP Virtual Private Network (VPC) Peering Setup Guide
  • Access Management
    • SAML Single Sign-On (SSO)
    • User Management
  • Managing Clusters
    • Maintenance Windows
    • Scaling a Cluster
    • Deleting a Cluster
  • Using ScyllaDB
    • Apache Cassandra Query Language (CQL)
    • ScyllaDB Drivers
    • Tracing
    • Role Based Access Control (RBAC)
    • ScyllaDB Integrations
  • Monitoring
    • Extracting Cluster Metrics
  • Security
    • ScyllaDB Cloud Security Best Practices
    • ScyllaDB Cloud Compliance
    • ScyllaDB Cloud Security Concepts
  • Serverless
  • Free Trial
  • Tutorials
  • API Documentation
    • Get Started with the ScyllaDB Cloud API
    • API Reference (BETA)
  • Terraform Provider
  • Getting Help
    • ScyllaDB Cloud FAQ
  • Create an issue

On this page

  • Get Started with the ScyllaDB Cloud API
    • Obtaining an API Key Beta
Logo
Docs University Contact Us About Us
Mail List Icon Slack Icon Forum Icon
© 2023, ScyllaDB. All rights reserved.
Last updated on 05 Jun 2023.
Powered by Sphinx 4.3.2 & ScyllaDB Theme 1.5.1