---
title: "show details of an addon"
method: GET
path: "/api/v1/addons/{addonName}"
tags: ["addon"]
---

# show details of an addon

`GET /api/v1/addons/{addonName}`

## Path parameters

- `addonName` string, required

## Query parameters

- `version` string
- `registry` string

## Response `200`

OK

- V1DetailAddonResponse
  - `annotations` object
  - `availableVersions` string[], required
  - `definitions` V1AddonDefinition[], required
    - `description` string
    - `name` string
    - `type` string
  - `dependencies` AddonDependency[]
    - `name` string
    - `version` string
  - `deployTo` AddonDeployTo
    - `disableControlPlane` boolean, required
    - `runtimeCluster` boolean, required
  - `description` string, required
  - `detail` string
  - `icon` string, required
  - `invisible` boolean, required
  - `name` string, required
  - `needNamespace` string[]
  - `registryName` string
  - `schema` string, required
  - `system` AddonSystemRequirements
    - `kubernetes` string
    - `vela` string
  - `tags` string[]
  - `uiSchema` SchemaUIParameter[], required
    - `additional` boolean
    - `additionalParameter` SchemaUIParameter — recursive
    - `conditions` SchemaCondition[]
      - `action` string
      - `jsonKey` string, required
      - `op` string
      - `value` unknown, required
    - `description` string, required
    - `disable` boolean
    - `jsonKey` string, required
    - `label` string, required
    - `sort` integer, required
    - `style` SchemaStyle
      - `colSpan` integer, required
    - `subParameterGroupOption` SchemaGroupOption[]
      - `keys` string[], required
      - `label` string, required
    - `subParameters` SchemaUIParameter[]
    - `uiType` string, required
    - `validate` SchemaValidate
      - `defaultValue` unknown
      - `immutable` boolean, required
      - `max` number, double
      - `maxLength` integer
      - `min` number, double
      - `minLength` integer
      - `options` SchemaOption[]
        - `label` string, required
        - `value` unknown, required
      - `pattern` string
      - `required` boolean
  - `url` string
  - `uxPlugins` object
  - `version` string, required

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.net/kubevela/apis/kubevela-api-doc.md) · [All operations](https://skmtc.net/kubevela/apis/kubevela-api-doc/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kubevela/kubevela-api-doc/versions/8e41615b25d5/schema)