Clusters
List Addons
Clusters
Applications
Models
Artifacts
Prompts
Secret Groups
Model Deployments
Users
Personal Access Tokens
Virtual Accounts
Clusters
List Addons
List addons for the provided cluster.Pagination is available based on query parameters.
GET
/
api
/
svc
/
v1
/
clusters
/
{id}
/
get-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": {
"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
Required range:
1 <= x <= 1000
Example:
10
Number of items to skip
Required range:
x >= 0
Example:
0
Response
200
application/json
Returns the list of addons for the cluster And also response includes paginated data
The response is of type object
.
Was this page helpful?
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
}
}