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,
"conflictFields": [
"<string>"
],
"hasConflict": 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
}
}
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,
"conflictFields": [
"<string>"
],
"hasConflict": 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
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Cluster id of the cluster
Number of items per page
1 <= x <= 1000
10
Number of items to skip
x >= 0
0
Returns the list of addons for the cluster And also response includes paginated data
The response is of type object
.
Was this page helpful?