eks.clusters.restore

Restore the control plane from one of the cluster’s etcd snapshots

POST /eks/api/clusters/{cluster}/restoreIAM eks:RestoreClusterChanges stateDestructive

Every Kubernetes object returns to the snapshot; objects created since are gone. A pre-restore snapshot is taken first, so a restore can be undone. Then every control-plane machine is replaced: the API is down until the first new one has restored etcd (about 5–10 minutes), worker nodes keep running their pods and reconnect, kubeconfigs keep working (same CA and endpoint). Only verified snapshots; `confirm` must be the cluster’s name. 409 unless the cluster is active (one restore at a time, none during an upgrade or a deletion). A customer’s restore is excluded from the SLA for its first 30 minutes.

Request syntax

POST /eks/api/clusters/{cluster}/restore
{
  "snapshotId": "string",
  "confirm": "string"
}

Path parameters

  • clusterRequired

    string

    Constraints: /^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$/

Request body

  • snapshotIdRequired

    string

    A verified snapshot of this cluster (`dcloud eks snapshots list`)

    Constraints: /^etcds-[0-9a-f]{12}$/

  • confirmRequired

    string

    The cluster’s name, to confirm: every object created after the snapshot is lost

    Constraints: 1-100 chars

Response

202 with the cluster, status `restoring`: id, name, regionId, tier, version, kubernetesVersion, availableVersion, latestPatch, status, reconcileError, endpoint, endpointIpv4, allowedCidrs, endpointPublicAccess, endpointPrivateAccess, endpointPrivateIpv4, serviceAccountIssuer, vpcId, podCidr, serviceCidr, controlPlaneNodes, deletionProtection, autoscaler, logging, support, forcedUpgrade, slaPercent, createdAt, …; the restore runs in the background (follow it with `events`). 400 when `confirm` is not the cluster’s name; 404 for a snapshot not of this cluster; 409 unless the cluster is active, or for a snapshot that is not verified. 404 when no cluster has that id or name, 403 without the permission on it.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow eks:RestoreCluster on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud eks clusters restore cluster --snapshot-id example --confirm example

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_eks_clusters_restore.