eks.addons.create

Install a managed add-on

POST /eks/api/clusters/{cluster}/addonsIAM eks:CreateAddonChanges state

The DNS add-ons (external-dns, cert-manager with zones) also need dns:ChangeRecords on every zone they list: the cluster may then change records there, without any stored credential. 409 when the cluster already has it.

Request syntax

POST /eks/api/clusters/{cluster}/addons
{
  "name": "enum",
  "version": "string",
  "config": "map of string"
}

Path parameters

  • clusterRequired

    string

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

Request body

  • nameRequired

    enum

    metrics-server, traefik, cert-manager or external-dns

    One of: metrics-server, traefik, cert-manager, external-dns

  • versionOptional

    string

    Default: the newest that supports the cluster’s Kubernetes

    Constraints: max 32 chars

  • configOptional

    map of string

    The add-on’s options. traefik: replicas, proxyProtocol, loadBalancerType, defaultIngressClass. cert-manager: zones, email. external-dns: zones (required), policy, sources. metrics-server: none

    Constraints: key=<json>

Response

201 with the add-on: name, version, system, status, statusMessage, config, health, namespace, latestVersion, upgradeAvailable, createdBy, createdAt, updatedAt; the cluster applies it in the background. 400 for a version not offered or options it does not take; 404 for a DNS zone not in the organization; 409 when the cluster is being deleted, its control plane was built before managed add-ons, the version (or, without one, every version) does not support the cluster’s minor, the cluster already has it, or the quota is full. 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:CreateAddon 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 addons create cluster --name metrics-server

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