# Cast AI External Cluster API

**Canonical:** https://apis.io/apis/kimchi/kimchi-externalclusterapi-api/  
**Provider:** Cast AI — https://apis.io/providers/kimchi/  
**Base URL:** https://api.cast.ai/

Cast AI External Cluster API is one of 137 APIs that [Cast AI](https://apis.io/providers/kimchi/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include ExternalClusterAPI. The published artifact set on APIs.io includes an OpenAPI specification.

Manages external cluster resources

## Operations (36)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/kubernetes/external-clusters` | Lists clusters for current user's organization |
| POST | `/v1/kubernetes/external-clusters` | Registers new external cluster |
| GET | `/v1/kubernetes/external-clusters/filters/nodes` | Returns list of available filters for nodes list |
| POST | `/v1/kubernetes/external-clusters/impersonation-service-account` | Get or create service account for impersonation authentication setup |
| GET | `/v1/kubernetes/external-clusters/onboarding/connect-and-enable-castai-cmd` | Returns single command for getting the script for one-pass onboarding |
| DELETE | `/v1/kubernetes/external-clusters/{clusterId}` | Deletes the cluster from CAST console. |
| GET | `/v1/kubernetes/external-clusters/{clusterId}` | Gets the details of a specific cluster |
| POST | `/v1/kubernetes/external-clusters/{clusterId}` | Updates configuration of a specific cluster |
| POST | `/v1/kubernetes/external-clusters/{clusterId}/assume-role-principal` | Create AWS cross role user for assume role |
| DELETE | `/v1/kubernetes/external-clusters/{clusterId}/assume-role-principal` | Delete AWS cross role user for assume role |
| GET | `/v1/kubernetes/external-clusters/{clusterId}/assume-role-principal` | Return AWS cross role user for assume role |
| GET | `/v1/kubernetes/external-clusters/{clusterId}/assume-role-user` | Returns AWS user arn used for assume role |
| GET | `/v1/kubernetes/external-clusters/{clusterId}/cleanup-script` | Returns single command for external cluster cleanup script |
| GET | `/v1/kubernetes/external-clusters/{clusterId}/credentials-script` | Returns single command for external cluster credentials onboarding |
| POST | `/v1/kubernetes/external-clusters/{clusterId}/disconnect` | Disconnects cluster by removing all CAST dependencies from cloud provider's… |
| POST | `/v1/kubernetes/external-clusters/{clusterId}/events` | Handles cloud spot interruption events for a cluster |
| POST | `/v1/kubernetes/external-clusters/{clusterId}/gcp-create-sa` | Deprecated. Migrate to ImpersonationServiceAccount flows instead. |
| POST | `/v1/kubernetes/external-clusters/{clusterId}/gcp-disable-sa` | Deprecated. Migrate to ImpersonationServiceAccount flows instead. |
| POST | `/v1/kubernetes/external-clusters/{clusterId}/gke-create-sa` | Deprecated. Migrate to ImpersonationServiceAccount flows instead. |
| POST | `/v1/kubernetes/external-clusters/{clusterId}/gke-disable-sa` | Deprecated. Migrate to ImpersonationServiceAccount flows instead. |
| POST | `/v1/kubernetes/external-clusters/{clusterId}/hibernate` | Hiberantes cluster |
| POST | `/v1/kubernetes/external-clusters/{clusterId}/instances/{instanceId}/logs` | Ingest node join logs including kubelet and cloud init logs |
| POST | `/v1/kubernetes/external-clusters/{clusterId}/node-batches` | Adds a batch of nodes to the cluster |
| GET | `/v1/kubernetes/external-clusters/{clusterId}/node-batches/{nodeBatchId}` | Gets the status of add node batch operation |
| POST | `/v1/kubernetes/external-clusters/{clusterId}/nodes` | Adds a node to the cluster |
| GET | `/v1/kubernetes/external-clusters/{clusterId}/nodes` | Lists the nodes for a cluster |
| DELETE | `/v1/kubernetes/external-clusters/{clusterId}/nodes/{nodeId}` | Deletes the specified cluster node |
| GET | `/v1/kubernetes/external-clusters/{clusterId}/nodes/{nodeId}` | Gets a single node by ID |
| POST | `/v1/kubernetes/external-clusters/{clusterId}/nodes/{nodeId}/drain` | Drains the specified cluster node |
| POST | `/v1/kubernetes/external-clusters/{clusterId}/reconcile` | Reconciles cluster |
| POST | `/v1/kubernetes/external-clusters/{clusterId}/resume` | Resumes cluster |
| POST | `/v1/kubernetes/external-clusters/{clusterId}/tags` | Updates tags of a specific cluster |
| POST | `/v1/kubernetes/external-clusters/{clusterId}/token` | Returns cluster token that is used for agent and cluster controller |
| GET | `/v1/scripts/connect-and-enable-castai.sh` | Returns the script for one-pass onboarding |
| GET | `/v1/scripts/{provider}/cleanup.sh` | Returns cleanup script for the specified provider |
| GET | `/v1/scripts/{provider}/onboarding.sh` | Returns credentials onboarding script for the specified provider |

## Machine-readable artifacts (1)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/kimchi/refs/heads/main/openapi/kimchi-externalclusterapi-api-openapi.yml

## Other Cast AI APIs (12)

- [Cast AI Addons API](https://apis.io/apis/kimchi/kimchi-addonsapi-api/)
- [Cast AI Advisor API](https://apis.io/apis/kimchi/kimchi-advisorapi-api/)
- [Cast AI AI Enabler API](https://apis.io/apis/kimchi/kimchi-aienablerapi-api/)
- [Cast AI AI Enabler Playground API](https://apis.io/apis/kimchi/kimchi-aienablerplaygroundapi-api/)
- [Cast AI AI Enabler Providers API](https://apis.io/apis/kimchi/kimchi-aienablerprovidersapi-api/)
- [Cast AI AI Enabler Settings API](https://apis.io/apis/kimchi/kimchi-aienablersettingsapi-api/)
- [Cast AI Allocation Group API](https://apis.io/apis/kimchi/kimchi-allocationgroupapi-api/)
- [Cast AI Analytics API](https://apis.io/apis/kimchi/kimchi-analyticsapi-api/)
- [Cast AI API Keys API](https://apis.io/apis/kimchi/kimchi-apikeysapi-api/)
- [Cast AI Audit API](https://apis.io/apis/kimchi/kimchi-auditapi-api/)
- [Cast AI Audit V2API API](https://apis.io/apis/kimchi/kimchi-auditv2api-api/)
- [Cast AI Auth API](https://apis.io/apis/kimchi/kimchi-authapi-api/)

## Tags

ExternalClusterAPI

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/kimchi/kimchi-externalclusterapi-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/kimchi/.