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

Release Clusters API

The Clusters API from Release — 10 operation(s) for clusters.

Release Clusters API is one of 9 APIs that Release 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, API documentation, and an API reference.

This API exposes 14 operations across 10 paths, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.release.com.

14 operations 10 paths 1 schemas 1 DELETE7 GET2 PATCH3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.release.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Release Clusters API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-User-Email (userEmail). An API key is passed in the header as X-User-Token (userToken). By default, every request must be authenticated.

  • userEmail — User's email address for authentication
  • userToken — User's authentication token (from ~/.release.yaml)

Paths & Operations 14

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

Clusters 14
GET
/accounts/{account_id}/clusters/{id}/kubeconfig
Download kubeconfig
clusters_kubeconfig 2 params → 200401404
GET
/accounts/{account_id}/clusters/{id}/database_snapshots
List database snapshots
clusters_database_snapshots 2 params → 200401404
GET
/accounts/{account_id}/clusters/{id}/verify
Verify cluster
clusters_verify 2 params → 200401404
POST
/accounts/{account_id}/clusters/{id}/certificate
Generate cluster certificate
clusters_certificate 2 params → 200401404
POST
/accounts/{account_id}/clusters/{id}/upgrade
Upgrade cluster
clusters_upgrade 2 params → 200401404
PATCH
/accounts/{account_id}/clusters/{id}/patch_refresh_node_groups
Patch refresh node groups Cluster
clusters_patch_refresh_node_groups 2 params → 200401404
GET
/accounts/{account_id}/clusters
List Clusters
clusters_index 1 param → 200401404
POST
/accounts/{account_id}/clusters
Create Cluster
clusters_create 1 param body → 201401404
GET
/accounts/{account_id}/clusters/new
New Cluster
clusters_new 1 param → 200401404
GET
/accounts/{account_id}/clusters/{id}/edit
Edit Cluster
clusters_edit 2 params → 200401404
GET
/accounts/{account_id}/clusters/{id}
Get Cluster
clusters_show 2 params → 200401404
PATCH
/accounts/{account_id}/clusters/{id}
Update Cluster
clusters_update 2 params body → 200401404
PUT
/accounts/{account_id}/clusters/{id}
Update Cluster
clusters_put_update 2 params body → 200401404
DELETE
/accounts/{account_id}/clusters/{id}
Delete Cluster
clusters_destroy 2 params → 200401404

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Error (3 properties). Each schema is shown below with its type and property counts.

Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

release-clusters-api-openapi.yml Raw ↑

Other APIs Release publishes across the network.

Release Accounts API
Release Apps API
Release Builds API
Release Configs API
Release Deploys API
Release Environments API
Release Instances API
Release Remote Development API