Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Replicated clusters API

The clusters API from Replicated — 18 operation(s) for clusters.

Replicated clusters API is one of 22 APIs that Replicated publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include clusters. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and an API reference.

This API exposes 19 operations across 18 paths, and defines 24 schemas. It is described by OpenAPI 2.0, at version 3.0.0.

Requests are made against the base URL https://api.replicated.com/vendor/v3.

19 operations 18 paths 24 schemas 2 DELETE9 GET5 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
3.0.0
Base URL
https://api.replicated.com/vendor/v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Replicated clusters API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (api_key).

Paths & Operations 19

Across 18 paths, the API surfaces 19 operations — 2 DELETE, 9 GET, 5 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

clusters 19
GET
/app/{app_id}/cluster-usage
List cluster usage.
listClusterUsage 1 param → 200400401403404
POST
/cluster
Create a test cluster.
createCluster 2 params → 200201400401403404
GET
/cluster/filters
Get clusters filters.
getClusterFilters → 200400401403404
GET
/cluster/quotas
List cluster quotas.
listClusterQuotas → 200400401403404
GET
/cluster/stats
Get clusters stats.
getClusterStats → 200400401403404
GET
/cluster/versions
List cluster versions.
listClusterVersions → 200400401403404
GET
/cluster/{cluster_id}
Get the details for a test cluster.
getCluster 1 param → 200400401403404
DELETE
/cluster/{cluster_id}
Delete a test cluster.
deleteCluster 1 param → 200400401403404
GET
/cluster/{cluster_id}/kubeconfig
Get the kubeconfig for a test cluster.
getClusterKubeconfig 1 param → 200400401403404
PUT
/cluster/{cluster_id}/nodegroup/{nodegroup_id}
Update a nodegroup for a cluster.
updateClusterNodegroup 3 params → 200400401403404
POST
/cluster/{cluster_id}/port
Exposes a port on a cluster.
createClusterPort 2 params → 201401403404
DELETE
/cluster/{cluster_id}/port/{port_number}
Deletes a port from a cluster.
deleteClusterPort 3 params → 200400401403404
GET
/cluster/{cluster_id}/ports
Lists ports for a cluster.
listClusterPorts 1 param → 200400401403404
PUT
/cluster/{cluster_id}/tags
Update the tags for a cluster.
updateClusterTags 2 params → 201401403404
PUT
/cluster/{cluster_id}/ttl
Update ttl for a cluster.
updateClusterTTL 2 params → 200400401403404
POST
/cluster/{cluster_id}/upgrade
Upgrade a test cluster.
upgradeCluster 3 params → 200400401403404
GET
/clusters
List test clusters.
listClusters 10 params → 200400401403404
POST
/cmx/credits/buy
Add credits to a team.
addClusterCredits → 200400500
POST
/cmx/quotas/increase
Send a request to increase cluster quota.
increaseClusterQuota 1 param → 200400401403404

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are Cluster (27 properties), CreateClusterParametersBody (16 properties), NodeGroup (15 properties), ClusterPort (11 properties). Each schema is shown below with its type and property counts.

ClusterAddon
object
11 properties
SupportedDistributionAndVersions
object
6 properties
ValidationError
object
2 properties
ClusterAddonPort
object
7 properties
NodeGroup
object
15 properties
IncreaseQuotaRequest
object
2 properties
ClusterPort
object
11 properties
ClusterStatus
string
ClusterDetail
object
10 properties
ClusterExposedPort
object
2 properties
Cluster
object
27 properties
SupportedVersion
object
2 properties
PortProtocol
string
Actor
object
5 properties
ClusterQuota
object
6 properties
CreateClusterParametersBody
object
16 properties
Tag
object
2 properties
CreateNodeGroupParameters
object
6 properties
NodeType
string
ClusterNode
object
9 properties
ClusterAddonStatus
string
ClusterAddonObjectStore
object
5 properties
ClusterDistributionStatus
object
4 properties
CreateClusterError
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

replicated-clusters-api-openapi.yml Raw ↑

Other APIs Replicated publishes across the network.

Replicated apps API
Replicated channelReleases API
Replicated channels API
Replicated clusterAddons API
Replicated cmx API
Replicated customers API
Replicated customHostnames API
Replicated enterprisePortal API
Replicated externalRegistries API
Replicated instances API
Replicated networks API
Replicated notifications API