Truefoundry Docs

List Addons

curl --request GET \
  --url https://{controlPlaneURL}/api/svc/v1/clusters/{id}/get-addons \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "name": "ARGOCD",
      "appName": "<string>",
      "namespace": "<string>",
      "applicationId": "<string>",
      "description": "<string>",
      "path": "<string>",
      "addonFolder": "<string>",
      "installed": true,
      "status": {
        "installed": true,
        "healthStatus": "<string>",
        "syncStatus": "<string>"
      },
      "version": "<string>",
      "manifest": {},
      "installationSource": "<string>",
      "unsupportedClusterTypes": [
        "aws-eks"
      ],
      "required": true,
      "knownCRDs": [
        "<string>"
      ],
      "source": {
        "repo_url": "<string>",
        "chart": "<string>"
      },
      "upgrades": {
        "diff": [
          {
            "type": "REMOVE",
            "key": "<string>",
            "value": {},
            "oldValue": {},
            "changes": "<array>"
          }
        ],
        "currentManifest": {
          "type": "helm",
          "name": "<string>",
          "source": {
            "type": "helm-repo",
            "repo_url": "<string>",
            "chart": "<string>",
            "version": "<string>",
            "integration_fqn": "<string>"
          },
          "labels": {},
          "values": {},
          "kustomize": {
            "patch": {},
            "additions": [
              {}
            ]
          },
          "ignoreDifferences": [
            {}
          ],
          "workspace_fqn": "<string>"
        },
        "desiredManifest": {
          "type": "helm",
          "name": "<string>",
          "source": {
            "type": "helm-repo",
            "repo_url": "<string>",
            "chart": "<string>",
            "version": "<string>",
            "integration_fqn": "<string>"
          },
          "labels": {},
          "values": {},
          "kustomize": {
            "patch": {},
            "additions": [
              {}
            ]
          },
          "ignoreDifferences": [
            {}
          ],
          "workspace_fqn": "<string>"
        },
        "upgradePossible": true,
        "conflictFields": [
          "<string>"
        ],
        "hasConflict": true
      },
      "labels": [
        "<string>"
      ],
      "recommendations": [
        {
          "recommendationData": {},
          "recommendationType": "<string>",
          "expiryTimestamp": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "clusterId": "<string>",
          "applicationId": "<string>",
          "deploymentId": "<string>",
          "applicationVersion": 123,
          "appliedDeploymentId": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "workspaceId": "<string>"
    }
  ],
  "pagination": {
    "total": 100,
    "offset": 0,
    "limit": 10
  }
}

GET

api

svc

clusters

{id}

get-addons

List Addons

curl --request GET \
  --url https://{controlPlaneURL}/api/svc/v1/clusters/{id}/get-addons \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "name": "ARGOCD",
      "appName": "<string>",
      "namespace": "<string>",
      "applicationId": "<string>",
      "description": "<string>",
      "path": "<string>",
      "addonFolder": "<string>",
      "installed": true,
      "status": {
        "installed": true,
        "healthStatus": "<string>",
        "syncStatus": "<string>"
      },
      "version": "<string>",
      "manifest": {},
      "installationSource": "<string>",
      "unsupportedClusterTypes": [
        "aws-eks"
      ],
      "required": true,
      "knownCRDs": [
        "<string>"
      ],
      "source": {
        "repo_url": "<string>",
        "chart": "<string>"
      },
      "upgrades": {
        "diff": [
          {
            "type": "REMOVE",
            "key": "<string>",
            "value": {},
            "oldValue": {},
            "changes": "<array>"
          }
        ],
        "currentManifest": {
          "type": "helm",
          "name": "<string>",
          "source": {
            "type": "helm-repo",
            "repo_url": "<string>",
            "chart": "<string>",
            "version": "<string>",
            "integration_fqn": "<string>"
          },
          "labels": {},
          "values": {},
          "kustomize": {
            "patch": {},
            "additions": [
              {}
            ]
          },
          "ignoreDifferences": [
            {}
          ],
          "workspace_fqn": "<string>"
        },
        "desiredManifest": {
          "type": "helm",
          "name": "<string>",
          "source": {
            "type": "helm-repo",
            "repo_url": "<string>",
            "chart": "<string>",
            "version": "<string>",
            "integration_fqn": "<string>"
          },
          "labels": {},
          "values": {},
          "kustomize": {
            "patch": {},
            "additions": [
              {}
            ]
          },
          "ignoreDifferences": [
            {}
          ],
          "workspace_fqn": "<string>"
        },
        "upgradePossible": true,
        "conflictFields": [
          "<string>"
        ],
        "hasConflict": true
      },
      "labels": [
        "<string>"
      ],
      "recommendations": [
        {
          "recommendationData": {},
          "recommendationType": "<string>",
          "expiryTimestamp": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "clusterId": "<string>",
          "applicationId": "<string>",
          "deploymentId": "<string>",
          "applicationVersion": 123,
          "appliedDeploymentId": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "workspaceId": "<string>"
    }
  ],
  "pagination": {
    "total": 100,
    "offset": 0,
    "limit": 10
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Cluster id of the cluster

Query Parameters

limit

integer

default:100

Number of items per page

Required range: 1 <= x <= 1000

Example:

10

offset

integer

default:0

Number of items to skip

Required range: x >= 0

Example:

0

Response

Returns a paginated list of addons for the cluster

data

AddonComponent · object[]

required

Array of Cluster Addons

Show child attributes

data.name

enum<string>

required

Available options:

ARGOCD,

ARGO_ROLLOUT,

ARGO_WORKFLOW,

TFY_AGENT,

ISTIO_BASE,

ISTIO_DISCOVERY,

TFY_ISTIO_INGRESS,

AWS_LOAD_BALANCER_CONTROLLER,

CERT_MANAGER,

KARPENTER,

KARPENTER_CONFIG,

PROMETHEUS,

METRICS_SERVER,

KUBECOST,

KEDA,

AWS_EFS_CSI_DRIVER,

AWS_EBS_CSI_DRIVER,

TFY_GPU_OPERATOR,

TFY_INFERENTIA_OPERATOR,

ELASTI,

TFY_WORKFLOW_PROPELLER,

GRAFANA,

TRUEFOUNDRY,

TFY_PROMETHEUS_CONFIG,

SPARK_OPERATOR,

TFY_LOGS

data.appName

string

data.namespace

string

data.applicationId

string

data.description

string

data.path

string

data.addonFolder

string

data.installed

boolean

data.status

AddonComponentStatus · object

Show child attributes

data.status.installed

boolean

required

Indicates whether the addon is installed

data.status.healthStatus

string

Health status of the addon

data.status.syncStatus

string

Sync status of the addon

data.version

string

data.manifest

object

data.installationSource

string

data.unsupportedClusterTypes

enum<string>[]

Available options:

aws-eks,

gcp-gke-standard,

azure-aks,

generic,

civo-talos

data.required

boolean

data.knownCRDs

string[]

data.source

AddOnComponentSource · object

Show child attributes

data.source.repo_url

string

required

Repository URL of the source

data.source.chart

string

required

Chart of the source

data.upgrades

UpgradeData · object

Show child attributes

data.upgrades.diff

IChange · object[]

Show child attributes

data.upgrades.diff.type

enum<string>

required

Available options:

REMOVE,

ADD,

UPDATE

data.upgrades.diff.key

string

required

data.upgrades.diff.value

object

data.upgrades.diff.oldValue

object

data.upgrades.diff.changes

array

data.upgrades.currentManifest

Helm · object

Show child attributes

data.upgrades.currentManifest.type

enum<string>

required

+value=helm

Available options:

helm

data.upgrades.currentManifest.name

string

required

+sort=1 +message=3 to 32 lower case characters long alphanumeric word, may contain - in between, cannot start with a number +usage=Name of the Helm deployment. This will be set as the release name of the chart you are deploying.

data.upgrades.currentManifest.source

HelmRepo · object

required

+label=Source helm repository +sort=2

HelmRepo
OCIRepo
GitHelmRepo

Show child attributes

data.upgrades.currentManifest.source.type

enum<string>

required

+value=helm-repo

Available options:

helm-repo

data.upgrades.currentManifest.source.repo_url

string

required

+label=Helm repository URL +sort=1 +message=Needs to be a valid URL.

data.upgrades.currentManifest.source.chart

string

required

+label=Chart name +sort=3 +usage=The helm chart name +uiType=InputSelect +uiProps={"creatable":true, "searchable":true}

data.upgrades.currentManifest.source.version

string

required

+label=Version +sort=4 +usage=Helm chart version +uiType=InputSelect +uiProps={"creatable":true, "searchable":true}

data.upgrades.currentManifest.source.integration_fqn

string

+docs=FQN of the helm repo integration. You can use the FQN of your desired helm integration (or add one) in the Integrations pageIntegrations page +label=Helm repo integration +sort=2 +usage=FQN of the helm repo integration. If you can't find your integration here, add it through the Integrations page +uiType=IntegrationSelect +uiProps={"integrationType":"helm-repo"}

data.upgrades.currentManifest.labels

object

+label=Labels +usage=Add labels to base argo app

Show child attributes

data.upgrades.currentManifest.labels.{key}

string

data.upgrades.currentManifest.values

object

+label=Values +usage=Values file as block file

data.upgrades.currentManifest.kustomize

Kustomize · object

Show child attributes

data.upgrades.currentManifest.kustomize.patch

object

+label=Patch +usage=Content of kustomization.yaml to perform kustomize operation. Please do not include the resources section. It is filled in automatically

data.upgrades.currentManifest.kustomize.additions

object[]

+label=Additional Manifests +usage=Additional kubernetes manifests to be included in the application

data.upgrades.currentManifest.ignoreDifferences

object[]

data.upgrades.currentManifest.workspace_fqn

string

+label=Workspace FQN +docs=Fully qualified name of the workspace +uiType=Hidden

data.upgrades.desiredManifest

Helm · object

Show child attributes

data.upgrades.desiredManifest.type

enum<string>

required

+value=helm

Available options:

helm

data.upgrades.desiredManifest.name

string

required

data.upgrades.desiredManifest.source

HelmRepo · object

required

+label=Source helm repository +sort=2

HelmRepo
OCIRepo
GitHelmRepo

Show child attributes

data.upgrades.desiredManifest.source.type

enum<string>

required

+value=helm-repo

Available options:

helm-repo

data.upgrades.desiredManifest.source.repo_url

string

required

+label=Helm repository URL +sort=1 +message=Needs to be a valid URL.

data.upgrades.desiredManifest.source.chart

string

required

+label=Chart name +sort=3 +usage=The helm chart name +uiType=InputSelect +uiProps={"creatable":true, "searchable":true}

data.upgrades.desiredManifest.source.version

string

required

+label=Version +sort=4 +usage=Helm chart version +uiType=InputSelect +uiProps={"creatable":true, "searchable":true}

data.upgrades.desiredManifest.source.integration_fqn

string

data.upgrades.desiredManifest.labels

object

+label=Labels +usage=Add labels to base argo app

Show child attributes

data.upgrades.desiredManifest.labels.{key}

string

data.upgrades.desiredManifest.values

object

+label=Values +usage=Values file as block file

data.upgrades.desiredManifest.kustomize

Kustomize · object

Show child attributes

data.upgrades.desiredManifest.kustomize.patch

object

+label=Patch +usage=Content of kustomization.yaml to perform kustomize operation. Please do not include the resources section. It is filled in automatically

data.upgrades.desiredManifest.kustomize.additions

object[]

+label=Additional Manifests +usage=Additional kubernetes manifests to be included in the application

data.upgrades.desiredManifest.ignoreDifferences

object[]

data.upgrades.desiredManifest.workspace_fqn

string

+label=Workspace FQN +docs=Fully qualified name of the workspace +uiType=Hidden

data.upgrades.upgradePossible

boolean

data.upgrades.conflictFields

string[]

data.upgrades.hasConflict

boolean

data.labels

string[]

data.recommendations

Recommendation · object[]

Recommendations

Show child attributes

data.recommendations.recommendationData

object

required

data.recommendations.recommendationType

string

required

data.recommendations.expiryTimestamp

string<date-time>

required

data.recommendations.id

string

data.recommendations.clusterId

string

data.recommendations.applicationId

string

data.recommendations.deploymentId

string

data.recommendations.applicationVersion

integer

data.recommendations.appliedDeploymentId

string

data.recommendations.createdAt

string<date-time>

data.recommendations.updatedAt

string<date-time>

data.workspaceId

string

pagination

Pagination · object

required

Pagination information

Show child attributes

pagination.total

integer

required

Total number of items

Example:

100

pagination.offset

integer

Number of items skipped

Example:

0

pagination.limit

integer

Number of items per page

Example:

10

Delete cluster Get Cluster status

⌘I

TrueFoundry SDK

TrueFoundry ML Client

Apply API Guides

Applications

Apply

Artifacts

Audit Logs

Clusters

Jobs

Logs

MLRepos

Model Deployments

Models

Personal Access Tokens

Prompts

Provider Integrations

Secret Groups

Secrets

Teams

Traces

Users

Virtual Accounts

Workspaces

List Addons

Authorizations

Path Parameters

Query Parameters

Response