List Addons
List addons for the provided cluster.Pagination is available based on query parameters.
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": {
"healthStatus": "<string>",
"syncStatus": "<string>",
"installed": true
},
"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": [
{}
]
}
],
"currentManifest": {
"type": "helm",
"name": "<string>",
"labels": {},
"source": {
"type": "helm-repo",
"repo_url": "<string>",
"integration_fqn": "<string>",
"chart": "<string>",
"version": "<string>"
},
"values": {},
"kustomize": {
"patch": {},
"additions": [
{}
]
},
"ignoreDifferences": [
{}
],
"workspace_fqn": "<string>"
},
"desiredManifest": {
"type": "helm",
"name": "<string>",
"labels": {},
"source": {
"type": "helm-repo",
"repo_url": "<string>",
"integration_fqn": "<string>",
"chart": "<string>",
"version": "<string>"
},
"values": {},
"kustomize": {
"patch": {},
"additions": [
{}
]
},
"ignoreDifferences": [
{}
],
"workspace_fqn": "<string>"
},
"upgradePossible": true
},
"labels": [
"<string>"
],
"recommendations": [
{
"id": "<string>",
"clusterId": "<string>",
"applicationId": "<string>",
"deploymentId": "<string>",
"applicationVersion": 123,
"recommendationData": {},
"recommendationType": "<string>",
"appliedDeploymentId": "<string>",
"expiryTimestamp": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"workspaceId": "<string>"
}
],
"pagination": {
"total": 100,
"offset": 0,
"limit": 10
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Cluster id of the cluster
Query Parameters
Number of items per page
1 <= x <= 1000
10
Number of items to skip
x >= 0
0
Response
Array of Cluster Addons
ARGOCD
, ARGO_ROLLOUT
, ARGO_WORKFLOW
, TFY_AGENT
, ISTIO_BASE
, ISTIO_DISCOVERY
, TFY_ISTIO_INGRESS
, AWS_LOAD_BALANCER_CONTROLLER
, CERT_MANAGER
, KARPENTER
, KARPENTER_CONFIG
, PROMETHEUS
, LOKI
, 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
aws-eks
, gcp-gke-standard
, azure-aks
, generic
, civo-talos
REMOVE
, ADD
, UPDATE
+value=helm
helm
+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.
+label=Source helm repository +sort=2
+value=helm-repo
helm-repo
+label=Helm repository URL +sort=1 +message=Needs to be a valid URL.
+label=Chart name +sort=3 +usage=The helm chart name +uiType=InputSelect +uiProps={"creatable":true, "searchable":true}
+label=Version +sort=4 +usage=Helm chart version +uiType=InputSelect +uiProps={"creatable":true, "searchable":true}
+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"}
+label=Labels +usage=Add labels to base argo app
+label=Values +usage=Values file as block file
+label=Patch
+usage=Content of kustomization.yaml to perform kustomize operation. Please do not include the resources
section. It is filled in automatically
+label=Additional Manifests +usage=Additional kubernetes manifests to be included in the application
+label=Workspace FQN +docs=Fully qualified name of the workspace +uiType=Hidden
+value=helm
helm
+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.
+label=Source helm repository +sort=2
+value=helm-repo
helm-repo
+label=Helm repository URL +sort=1 +message=Needs to be a valid URL.
+label=Chart name +sort=3 +usage=The helm chart name +uiType=InputSelect +uiProps={"creatable":true, "searchable":true}
+label=Version +sort=4 +usage=Helm chart version +uiType=InputSelect +uiProps={"creatable":true, "searchable":true}
+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"}
+label=Labels +usage=Add labels to base argo app
+label=Values +usage=Values file as block file
+label=Patch
+usage=Content of kustomization.yaml to perform kustomize operation. Please do not include the resources
section. It is filled in automatically
+label=Additional Manifests +usage=Additional kubernetes manifests to be included in the application
+label=Workspace FQN +docs=Fully qualified name of the workspace +uiType=Hidden
Recommendations
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": {
"healthStatus": "<string>",
"syncStatus": "<string>",
"installed": true
},
"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": [
{}
]
}
],
"currentManifest": {
"type": "helm",
"name": "<string>",
"labels": {},
"source": {
"type": "helm-repo",
"repo_url": "<string>",
"integration_fqn": "<string>",
"chart": "<string>",
"version": "<string>"
},
"values": {},
"kustomize": {
"patch": {},
"additions": [
{}
]
},
"ignoreDifferences": [
{}
],
"workspace_fqn": "<string>"
},
"desiredManifest": {
"type": "helm",
"name": "<string>",
"labels": {},
"source": {
"type": "helm-repo",
"repo_url": "<string>",
"integration_fqn": "<string>",
"chart": "<string>",
"version": "<string>"
},
"values": {},
"kustomize": {
"patch": {},
"additions": [
{}
]
},
"ignoreDifferences": [
{}
],
"workspace_fqn": "<string>"
},
"upgradePossible": true
},
"labels": [
"<string>"
],
"recommendations": [
{
"id": "<string>",
"clusterId": "<string>",
"applicationId": "<string>",
"deploymentId": "<string>",
"applicationVersion": 123,
"recommendationData": {},
"recommendationType": "<string>",
"appliedDeploymentId": "<string>",
"expiryTimestamp": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"workspaceId": "<string>"
}
],
"pagination": {
"total": 100,
"offset": 0,
"limit": 10
}
}