How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ScyllaDB Cluster API

The Cluster API from ScyllaDB — 10 operation(s) for cluster.

ScyllaDB Cluster API is one of 9 APIs that ScyllaDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Cluster. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 3 JSON Schemas.

This API exposes 10 operations across 10 paths, and defines 38 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, /.

10 operations 10 paths 38 schemas 4 GET1 PATCH4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.cloud.scylladb.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

ScyllaDB Cluster API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Authorization). By default, every request must be authenticated.

  • Authorization — Authorization header, required in all authenticated requests. Header format: Authorization: Bearer

Paths & Operations 10

Across 10 paths, the API surfaces 10 operations — 4 GET, 1 PATCH, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Cluster 10
GET
/account/{accountId}/clusters
Get the list of all clusters belonging to given account
getClusters 4 params → 200400404500
POST
/account/{accountId}/cluster/{clusterId}/delete
Delete cluster (async)
deleteCluster 3 params body → 200400404500
POST
/account/{accountId}/cluster/{clusterId}/resize
Resize cluster (async)
resizeCluster 3 params body → 200400404500
PUT
/account/{accountId}/cluster/{clusterId}/dc/{dcId}/scaling
Update datacenter scaling policy
updateDcScalingPolicy 4 params body → 200
POST
/account/{accountId}/cluster
Create cluster-create request (async)
createCluster 2 params body → 200400404500
GET
/account/{accountId}/cluster/{clusterId}
Get cluster details
getClusterDetails 4 params → 200400404500
GET
/account/{accountId}/cluster/{clusterId}/nodes
Get cluster nodes
getClusterNodes 4 params → 200
GET
/account/{accountId}/cluster/{clusterId}/dcs
Get cluster data centers
getClusterDCs 4 params → 200
PATCH
/account/{accountId}/cluster/{clusterId}/name
Update cluster name (async).
updateClusterName 3 params body → 200400404500
POST
/account/{accountId}/cluster/{clusterId}/notifications/email
Set cluster notification emails
setClusterNotificationEmail 2 params body → 200400401429500502

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are instance (26 properties), ClusterCreateRequestV1 (25 properties), ClusterInfo (24 properties), NodeInfo (17 properties). Each schema is shown below with its type and property counts.

APIDCScalingPolicyVCPU
object
1 property
ClusterWithMetrics
ClusterDetailedInfo
MetricName
string
Available metric names for cluster monitoring
region
object
Region and continent description
13 properties
ClusterEnriched
NodeInfo
object
17 properties
ClusterCreateResponse
ClusterNetwork
object
5 properties
VectorSearch
object
2 properties
ClusterVPCPeeringInfo
object
13 properties
EncryptionAtRest
object
2 properties
NotificationEmail
object
3 properties
ClusterConnection
object
Peering details information
14 properties
APIDCScalingPolicyStorage
object
2 properties
ClusterInfo
object
Information about the cluster
24 properties 6 required
ClusterConnectionAwaitingData
object
APIDCScalingPolicies
object
2 properties
cloudProvider
object
Cloud provider description
3 properties
DealsInUse
object
2 properties
ProvisionType
string
type of the cluster provisioning
ClusterMaintenanceWindow
object
2 properties
scyllaVersion
object
Represent version of the ScyllaDB installed on nodes
6 properties
ClusterRequestProgress
object
2 properties
instance
object
Cloud provider instance pricing description
26 properties
ClusterRequest
object
14 properties
ClusterNotification
object
3 properties
ClusterResizeDCNodes
object
3 properties 2 required
APIDCScaling
object
3 properties
ClusterDCInfoEnriched
ClusterResizeResponse
object
12 properties
ScalingMode
string
Scaling mode of the cluster
FirewallRule
object
3 properties
ClusterDCInfo
object
11 properties
CIDR
string
CIDR block in the form of ip/mask
NodeInfoEnriched
ClusterCreateRequestV1
object
25 properties
ClusterResizeRequest
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

scylladb-cluster-api-openapi.yml Raw ↑

Other APIs ScyllaDB publishes across the network.

ScyllaDB Admin REST API
ScyllaDB Account API
ScyllaDB Account Cluster Network API
ScyllaDB Account network cluster connection API
ScyllaDB Cluster Request API
ScyllaDB Deployment API
ScyllaDB Pricing API
ScyllaDB VectorSearch API
Where this information came from

This is an independent, third-party profile of ScyllaDB Cluster API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.