Deregister a cluster with the APC API

The examples on this page show common ways to use the APC API — they’re not a complete API reference. For the full, interactive API documentation for your installation, including every available query, mutation, and type, go to https://houston.<your-base-domain>/v1, and click on the Docs tab. See Develop and test APC API queries for more on using the built-in GraphQL explorer.

Send the request to https://houston.<your-base-domain>/v1 with a system service account or System Admin user token in the Authorization header. For details, see Authenticate to the APC API.

mutation {
  deregisterCluster(id: "<cluster-id>") {
    id
    name
  }
}

Argument reference:

Argument	Type	Required	Description
`id`	`Uuid`	Yes	The unique identifier of the cluster to deregister. Find it with the `paginatedClusters` query.

This permanently deletes the cluster record from the control plane. Deregistration doesn’t delete platform resources running in the data plane Kubernetes cluster (namespaces, services, persistent volumes). Remove those by uninstalling the data plane Helm release.

For the full deregistration workflow, including the UI flow and prerequisites, see Deregister a data plane cluster.

⌘I

Overview

Architecture

Upgrade to Astro Private Cloud 2.0

Install Astro Private Cloud

Develop Dags

Airflow administration

Airflow 3

Deploy Dags

Manage Deployments

Platform administration

Manage Platform resources

Security and compliance

APC API

Platform Observability

Release notes

Reference

Deregister a cluster with the APC API