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

CAST AI External Clusters API

Manage external Kubernetes clusters connected to CAST AI, including listing nodes, draining nodes, and cluster operations.

CAST AI External Clusters API is one of 17 APIs that CAST AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include External Clusters. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a changelog, a JSON-LD context, and 6 JSON Schemas.

This API exposes 3 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.cast.ai/v1.

3 operations 3 paths 5 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.cast.ai
Authentication
API Key
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

CAST AI External Clusters API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key for authentication. Create access keys from the CAST AI console under API API access keys.

Paths & Operations 3

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

External Clusters 3

Manage external Kubernetes clusters connected to CAST AI, including listing nodes, draining nodes, and cluster operations.

GET
/kubernetes/external-clusters/{clusterId}/nodes
CAST AI List cluster nodes
ExternalClusterAPI_ListNodes 1 param → 200401404
POST
/kubernetes/external-clusters/{clusterId}/nodes/{nodeId}/drain
CAST AI Drain cluster node
ExternalClusterAPI_DrainNode 2 params body → 200401404
DELETE
/kubernetes/external-clusters/{clusterId}/nodes/{nodeId}
CAST AI Delete cluster node
ExternalClusterAPI_DeleteNode 2 params → 200401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Node (6 properties), Error (2 properties), DrainNodeResponse (2 properties), DrainNodeRequest (2 properties). Each schema is shown below with its type and property counts.

Node
object
6 properties
DrainNodeRequest
object
2 properties
DrainNodeResponse
object
2 properties
Error
object
2 properties
ListNodesResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cast-ai-external-clusters-api-openapi.yml Raw ↑

Other APIs CAST AI publishes across the network.

CAST AI AI Enabler API
CAST AI Allocation Groups API
CAST AI Autoscaler API
CAST AI Cluster Actions API
CAST AI Cost Reports API
CAST AI Hibernation Schedules API
CAST AI Insights API
CAST AI Inventory API
CAST AI Node Configuration API
CAST AI Node Templates API
CAST AI Operations API
CAST AI Policies API