---
title: "disable an addon"
method: POST
path: "/api/v1/addons/{addonName}/disable"
tags: ["addon"]
---

# disable an addon

`POST /api/v1/addons/{addonName}/disable`

## Path parameters

- `addonName` string, required

## Query parameters

- `force` boolean

## Response `200`

OK

- V1AddonStatusResponse
  - `allClusters` V1NameAlias[]
    - `alias` string, required
    - `name` string, required
  - `appStatus` CommonAppStatus
    - `appliedResources` CommonClusterObjectReference[]
      - `apiVersion` string — API version of the referent.
      - `cluster` string
      - `creator` string
      - `fieldPath` string — If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
      - `kind` string — Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
      - `name` string — Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
      - `namespace` string — Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
      - `resourceVersion` string — Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
      - `uid` string — UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
    - `components` V1ObjectReference[]
      - `apiVersion` string — API version of the referent.
      - `fieldPath` string — If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
      - `kind` string — Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
      - `name` string — Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
      - `namespace` string — Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
      - `resourceVersion` string — Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
      - `uid` string — UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
    - `conditions` ConditionCondition[]
      - `lastTransitionTime` string, required
      - `message` string
      - `reason` string, required
      - `status` string, required
      - `type` string, required
    - `latestRevision` CommonRevision
      - `name` string, required
      - `revision` integer, required
      - `revisionHash` string
    - `observedGeneration` integer
    - `policy` CommonPolicyStatus[]
      - `name` string, required
      - `status` string
      - `type` string, required
    - `services` CommonApplicationComponentStatus[]
      - `cluster` string
      - `env` string
      - `healthy` boolean, required
      - `message` string
      - `name` string, required
      - `namespace` string
      - `scopes` V1ObjectReference[]
        - `apiVersion` string — API version of the referent.
        - `fieldPath` string — If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
        - `kind` string — Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
        - `name` string — Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
        - `namespace` string — Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
        - `resourceVersion` string — Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
        - `uid` string — UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
      - `traits` CommonApplicationTraitStatus[]
        - `healthy` boolean, required
        - `message` string
        - `type` string, required
      - `workloadDefinition` CommonWorkloadGVK
        - `apiVersion` string, required
        - `kind` string, required
    - `status` string
    - `workflow` CommonWorkflowStatus
      - `appRevision` string
      - `contextBackend` V1ObjectReference — ObjectReference contains enough information to let you inspect or modify the referred object.
        - `apiVersion` string — API version of the referent.
        - `fieldPath` string — If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
        - `kind` string — Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
        - `name` string — Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
        - `namespace` string — Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
        - `resourceVersion` string — Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
        - `uid` string — UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
      - `endTime` string
      - `finished` boolean, required
      - `message` string
      - `mode` string, required
      - `startTime` string
      - `status` string
      - `steps` V1alpha1WorkflowStepStatus[]
        - `firstExecuteTime` string
        - `id` string, required
        - `lastExecuteTime` string
        - `message` string
        - `name` string
        - `phase` string
        - `reason` string
        - `subSteps` V1alpha1StepStatus[]
          - `firstExecuteTime` string
          - `id` string, required
          - `lastExecuteTime` string
          - `message` string
          - `name` string
          - `phase` string
          - `reason` string
          - `type` string
        - `type` string
      - `suspend` boolean, required
      - `suspendState` string
      - `terminated` boolean, required
  - `args` object, required
  - `clusters` object
  - `enabling_progress` V1EnablingProgress
    - `enabled_components` integer, required
    - `total_components` integer, required
  - `installedVersion` string
  - `name` string, required
  - `phase` 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)