→
https://api.spectrocloud.com/v1/dashboard/appDeployments
summary:
Retrieves a list of application deployments filter summary Supported filter fields - ["appDeploymentName", "clusterUid", "tags"] Supported sort fields - ["appDeploymentName", "creationTimestamp", "lastModifiedTimestamp"]Parameters:
| Name | Type | Description | Required |
|---|---|---|---|
| limit | integer | limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. | no |
| offset | integer | offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination. | no |
| continue | string | continue token to paginate the subsequent data items | no |
{"filter": {"appDeploymentName": {"beginsWith": "string","contains": "string","eq": "string","ignoreCase": "boolean","ne": "string"},"clusterUids": {"beginsWith": ["string"],"eq": ["string"],"ignoreCase": "boolean","ne": ["string"]},"tags": {"beginsWith": ["string"],"eq": ["string"],"ignoreCase": "boolean","ne": ["string"]}},"sort": [{"field": "string","order": "string"}]}
200
An array of application deployment summary items
An array of application deployment summary items
{"appDeployments": [{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","lastModifiedTimestamp": "date-time","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"spec": {"config": {"target": {"clusterRef": {"name": "string","uid": "string"}}},"profile": {"metadata": {"name": "string","uid": "string","version": "string"},"template": {"appTiers": [{"name": "string","source": {"addonSubType": "string","addonType": "string","logoUrl": "string","name": "string","type": "string","uid": "string"},"type": "string","uid": "string","version": "string"}]}}},"status": {"notifications": {"isAvailable": "boolean"},"state": "string"}}],"listmeta": {"continue": "string","count": "integer","limit": "integer","offset": "integer"}}
→
https://api.spectrocloud.com/v1/dashboard/appProfiles
summary:
Retrieves a list of application profiles filter summary Supported filter fields - ["profileName", "tags"] Supported sort fields - ["profileName", "creationTimestamp", "lastModifiedTimestamp"]Parameters:
| Name | Type | Description | Required |
|---|---|---|---|
| limit | integer | limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. | no |
| offset | integer | offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination. | no |
| continue | string | continue token to paginate the subsequent data items | no |
{"filter": {"profileName": {"beginsWith": "string","contains": "string","eq": "string","ignoreCase": "boolean","ne": "string"},"tags": {"beginsWith": ["string"],"eq": ["string"],"ignoreCase": "boolean","ne": ["string"]},"version": {"beginsWith": "string","eq": "string","gt": "string","lt": "string","ne": "string"}},"sort": [{"field": "string","order": "string"}]}
200
An array of application profiles summary items
An array of application profiles summary items
{"appProfiles": [{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","lastModifiedTimestamp": "date-time","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"spec": {"parentUid": "string","template": {"appTiers": [{"name": "string","source": {"addonSubType": "string","addonType": "string","logoUrl": "string","name": "string","type": "string","uid": "string"},"type": "string","uid": "string","version": "string"}]},"version": "string","versions": [{"uid": "string","version": "string"}]}}],"listmeta": {"continue": "string","count": "integer","limit": "integer","offset": "integer"}}
→
https://api.spectrocloud.com/v1/dashboard/appProfiles/metadata
summary:
Retrieves a list of application profile metadata 200
An array of application profile summary items
An array of application profile summary items
{"appProfiles": [{"metadata": {"name": "string","uid": "string"},"spec": {"version": "string"}}]}
→
https://api.spectrocloud.com/v1/dashboard/appliances/metadata
summary:
Retrieves a list of edgehosts summary{"filter": {"name": {"beginsWith": "string","contains": "string","eq": "string","ignoreCase": "boolean","ne": "string"},"states": ["string"]},"sort": [{"field": "string","order": "string"}]}
200
An array of edgehost summary items
An array of edgehost summary items
{"items": [{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","lastModifiedTimestamp": "date-time","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"spec": {"clusterProfileTemplates": [{"cloudType": "string","name": "string","packs": [{"addonType": "string","annotations": "object","displayName": "string","layer": "string","logoUrl": "string","name": "string","packUid": "string","tag": "string","type": "string","version": "string"}],"type": "string","uid": "string","version": "string"}],"device": {"cpu": {"cores": "integer"},"disks": [{"controller": "string","partitions": [{"fileSystemType": "string","freeSpace": "integer","mountPoint": "string","totalSpace": "integer","usedSpace": "integer"}],"size": "integer","vendor": "string"}],"gpus": [{"addresses": "object","model": "string","vendor": "string"}],"memory": {"sizeInMB": "integer"},"nics": [{"dns": ["string"],"gateway": "string","ip": "string","macAddr": "string","subnet": "string"}],"os": {"family": "string","version": "string"},"type": "string"},"type": "string"},"status": {"health": {"agentVersion": "string","message": "string","state": "string"},"inUseClusters": [{"name": "string","uid": "string"}],"state": "string"}}]}
→
https://api.spectrocloud.com/v1/dashboard/clustergroups/{uid}/hostClusters
summary:
Retrieves a list of cluster summary for a given cluster groupParameters:
| Name | Type | Description | Required |
|---|---|---|---|
| uid | string | yes | |
| limit | integer | limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. | no |
| offset | integer | offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination. | no |
| continue | string | continue token to paginate the subsequent data items | no |
{"filter": {"conjunction": "string","filterGroups": [{"conjunction": "string","filters": [{"condition": {"bool": {"value": "boolean"},"date": {"match": {"conjunction": "string","values": ["date-time"]},"negation": "boolean","operator": "string"},"float": {"match": {"conjunction": "string","values": ["number"]},"negation": "boolean","operator": "string"},"int": {"match": {"conjunction": "string","values": ["integer"]},"negation": "boolean","operator": "string"},"string": {"ignoreCase": "boolean","match": {"conjunction": "string","values": ["string"]},"negation": "boolean","operator": "string"}},"property": "string","type": "string"}]}]},"sort": [{"field": "string","order": "string"}]}
200
An array of cluster summary items
An array of cluster summary items
{"items": [{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","lastModifiedTimestamp": "date-time","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"specSummary": {"cloudAccountMeta": {"name": "string","uid": "string"},"cloudConfig": {"cloudType": "string","machinePools": [{"cloudType": "string","healthy": "integer","infraProfileTemplate": {"cloudType": "string","name": "string","packs": [{"annotations": "object","digest": "string","inValidReason": "string","isInvalid": "boolean","layer": "string","manifests": [{"apiVersion": "string","fieldPath": "string","kind": "string","name": "string","namespace": "string","resourceVersion": "string","uid": "string"}],"name": "string","packUid": "string","params": "object","presets": [{"add": "string","displayName": "string","group": "string","name": "string","remove": ["string"]}],"registryUid": "string","schema": [{"format": "string","hints": ["string"],"listOptions": ["string"],"name": "string","readonly": "boolean","regex": "string","required": "boolean","type": "string"}],"server": "string","tag": "string","type": "string","values": "string","version": "string"}],"type": "string","uid": "string","version": "integer"},"labels": ["string"],"size": "integer"}]},"clusterProfileTemplate": {"cloudType": "string","name": "string","packs": [{"annotations": "object","digest": "string","inValidReason": "string","isInvalid": "boolean","layer": "string","manifests": [{"apiVersion": "string","fieldPath": "string","kind": "string","name": "string","namespace": "string","resourceVersion": "string","uid": "string"}],"name": "string","packUid": "string","params": "object","presets": [{"add": "string","displayName": "string","group": "string","name": "string","remove": ["string"]}],"registryUid": "string","schema": [{"format": "string","hints": ["string"],"listOptions": ["string"],"name": "string","readonly": "boolean","regex": "string","required": "boolean","type": "string"}],"server": "string","tag": "string","type": "string","values": "string","version": "string"}],"type": "string","uid": "string","version": "integer"},"clusterProfileTemplates": [{"cloudType": "string","name": "string","packs": [{"annotations": "object","digest": "string","inValidReason": "string","isInvalid": "boolean","layer": "string","manifests": [{"apiVersion": "string","fieldPath": "string","kind": "string","name": "string","namespace": "string","resourceVersion": "string","uid": "string"}],"name": "string","packUid": "string","params": "object","presets": [{"add": "string","displayName": "string","group": "string","name": "string","remove": ["string"]}],"registryUid": "string","schema": [{"format": "string","hints": ["string"],"listOptions": ["string"],"name": "string","readonly": "boolean","regex": "string","required": "boolean","type": "string"}],"server": "string","tag": "string","type": "string","values": "string","version": "string"}],"type": "string","uid": "string","version": "integer"}],"projectMeta": {"name": "string","uid": "string"}},"status": {"clusterImport": {"importLink": "string","isBrownfield":deprecated "boolean","state": "string"},"cost": {"cloud": {"compute": "number","storage": "number","total": "number"},"total": "number"},"health": {"agentVersion": "string","conditions": [{"message": "string","relatedObject": {"kind": "string","name": "string","uid": "string"},"type": "string"}],"lastHeartBeatTimestamp": "date-time","state": "string"},"hourlyRate": {"cloud": {"compute": "number","storage": "number","total": "number"},"total": "number"},"location": {"coordinates": ["number"],"countryCode": "string","countryName": "string","regionCode": "string","regionName": "string"},"metrics": {"cpu": {"lastUpdatedTime": "date-time","limit": "number","request": "number","total": "number","unit": "string","usage": "number"},"memory": {"lastUpdatedTime": "date-time","limit": "number","request": "number","total": "number","unit": "string","usage": "number"}},"nested": {"appDeployments": [{"kind": "string","name": "string","projectUid": "string","tenantUid": "string","uid": "string"}],"hostCluster": {"apiVersion": "string","fieldPath": "string","kind": "string","name": "string","namespace": "string","resourceVersion": "string","uid": "string"},"lifecycleStatus": {"msg": "string","status": "string"},"nestedClusters": [{"kind": "string","name": "string","projectUid": "string","tenantUid": "string","uid": "string"}],"state": "string"},"notifications": {"isAvailable": "boolean"},"state": "string"}}],"listmeta": {"continue": "string","count": "integer","limit": "integer","offset": "integer"}}
→
https://api.spectrocloud.com/v1/dashboard/clustergroups/{uid}/nestedClusters
summary:
Retrieves a list of cluster summary for a given cluster groupParameters:
| Name | Type | Description | Required |
|---|---|---|---|
| uid | string | yes | |
| limit | integer | limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. | no |
| offset | integer | offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination. | no |
| continue | string | continue token to paginate the subsequent data items | no |
{"filter": {"conjunction": "string","filterGroups": [{"conjunction": "string","filters": [{"condition": {"bool": {"value": "boolean"},"date": {"match": {"conjunction": "string","values": ["date-time"]},"negation": "boolean","operator": "string"},"float": {"match": {"conjunction": "string","values": ["number"]},"negation": "boolean","operator": "string"},"int": {"match": {"conjunction": "string","values": ["integer"]},"negation": "boolean","operator": "string"},"string": {"ignoreCase": "boolean","match": {"conjunction": "string","values": ["string"]},"negation": "boolean","operator": "string"}},"property": "string","type": "string"}]}]},"sort": [{"field": "string","order": "string"}]}
200
An array of cluster summary items
An array of cluster summary items
{"items": [{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","lastModifiedTimestamp": "date-time","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"specSummary": {"cloudAccountMeta": {"name": "string","uid": "string"},"cloudConfig": {"cloudType": "string","machinePools": [{"cloudType": "string","healthy": "integer","infraProfileTemplate": {"cloudType": "string","name": "string","packs": [{"annotations": "object","digest": "string","inValidReason": "string","isInvalid": "boolean","layer": "string","manifests": [{"apiVersion": "string","fieldPath": "string","kind": "string","name": "string","namespace": "string","resourceVersion": "string","uid": "string"}],"name": "string","packUid": "string","params": "object","presets": [{"add": "string","displayName": "string","group": "string","name": "string","remove": ["string"]}],"registryUid": "string","schema": [{"format": "string","hints": ["string"],"listOptions": ["string"],"name": "string","readonly": "boolean","regex": "string","required": "boolean","type": "string"}],"server": "string","tag": "string","type": "string","values": "string","version": "string"}],"type": "string","uid": "string","version": "integer"},"labels": ["string"],"size": "integer"}]},"clusterProfileTemplate": {"cloudType": "string","name": "string","packs": [{"annotations": "object","digest": "string","inValidReason": "string","isInvalid": "boolean","layer": "string","manifests": [{"apiVersion": "string","fieldPath": "string","kind": "string","name": "string","namespace": "string","resourceVersion": "string","uid": "string"}],"name": "string","packUid": "string","params": "object","presets": [{"add": "string","displayName": "string","group": "string","name": "string","remove": ["string"]}],"registryUid": "string","schema": [{"format": "string","hints": ["string"],"listOptions": ["string"],"name": "string","readonly": "boolean","regex": "string","required": "boolean","type": "string"}],"server": "string","tag": "string","type": "string","values": "string","version": "string"}],"type": "string","uid": "string","version": "integer"},"clusterProfileTemplates": [{"cloudType": "string","name": "string","packs": [{"annotations": "object","digest": "string","inValidReason": "string","isInvalid": "boolean","layer": "string","manifests": [{"apiVersion": "string","fieldPath": "string","kind": "string","name": "string","namespace": "string","resourceVersion": "string","uid": "string"}],"name": "string","packUid": "string","params": "object","presets": [{"add": "string","displayName": "string","group": "string","name": "string","remove": ["string"]}],"registryUid": "string","schema": [{"format": "string","hints": ["string"],"listOptions": ["string"],"name": "string","readonly": "boolean","regex": "string","required": "boolean","type": "string"}],"server": "string","tag": "string","type": "string","values": "string","version": "string"}],"type": "string","uid": "string","version": "integer"}],"projectMeta": {"name": "string","uid": "string"}},"status": {"clusterImport": {"importLink": "string","isBrownfield":deprecated "boolean","state": "string"},"cost": {"cloud": {"compute": "number","storage": "number","total": "number"},"total": "number"},"health": {"agentVersion": "string","conditions": [{"message": "string","relatedObject": {"kind": "string","name": "string","uid": "string"},"type": "string"}],"lastHeartBeatTimestamp": "date-time","state": "string"},"hourlyRate": {"cloud": {"compute": "number","storage": "number","total": "number"},"total": "number"},"location": {"coordinates": ["number"],"countryCode": "string","countryName": "string","regionCode": "string","regionName": "string"},"metrics": {"cpu": {"lastUpdatedTime": "date-time","limit": "number","request": "number","total": "number","unit": "string","usage": "number"},"memory": {"lastUpdatedTime": "date-time","limit": "number","request": "number","total": "number","unit": "string","usage": "number"}},"nested": {"appDeployments": [{"kind": "string","name": "string","projectUid": "string","tenantUid": "string","uid": "string"}],"hostCluster": {"apiVersion": "string","fieldPath": "string","kind": "string","name": "string","namespace": "string","resourceVersion": "string","uid": "string"},"lifecycleStatus": {"msg": "string","status": "string"},"nestedClusters": [{"kind": "string","name": "string","projectUid": "string","tenantUid": "string","uid": "string"}],"state": "string"},"notifications": {"isAvailable": "boolean"},"state": "string"}}],"listmeta": {"continue": "string","count": "integer","limit": "integer","offset": "integer"}}
→
https://api.spectrocloud.com/v1/dashboard/clusterprofiles
summary:
Retrieves a list of cluster profiles filter summary Supported filter fields - ["profileName", "tags", "profileType", "environment"] Supported sort fields - ["profileName", "environment", "profileType", "creationTimestamp", "lastModifiedTimestamp"]Parameters:
| Name | Type | Description | Required |
|---|---|---|---|
| limit | integer | limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. | no |
| offset | integer | offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination. | no |
| continue | string | continue token to paginate the subsequent data items | no |
{"filter": {"environment": ["string"],"profileName": {"beginsWith": "string","contains": "string","eq": "string","ignoreCase": "boolean","ne": "string"},"profileType": ["string"],"tags": {"beginsWith": ["string"],"eq": ["string"],"ignoreCase": "boolean","ne": ["string"]},"version": {"beginsWith": "string","eq": "string","gt": "string","lt": "string","ne": "string"}},"sort": [{"field": "string","order": "string"}]}
200
An array of cluster profiles summary items
An array of cluster profiles summary items
{"items": [{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","lastModifiedTimestamp": "date-time","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"specSummary": {"draft": {"cloudType": "string","packs": [{"addonType": "string","annotations": "object","displayName": "string","layer": "string","logoUrl": "string","name": "string","packUid": "string","tag": "string","type": "string","version": "string"}],"type": "string"},"published": {"cloudType": "string","packs": [{"addonType": "string","annotations": "object","displayName": "string","layer": "string","logoUrl": "string","name": "string","packUid": "string","tag": "string","type": "string","version": "string"}],"type": "string"},"version": "string","versions": [{"uid": "string","version": "string"}]},"status": {"inUseClusterUids":deprecated ["string"],"inUseClusters": [{"name": "string","uid": "string"}],"isPublished": "boolean"}}],"listmeta": {"continue": "string","count": "integer","limit": "integer","offset": "integer"}}
→
https://api.spectrocloud.com/v1/dashboard/clusterprofiles/metadata
summary:
Retrieves a list of cluster profiles metadata 200
An array of cluster summary items
An array of cluster summary items
{"items": [{"metadata": {"name": "string","uid": "string"},"spec": {"cloudType": "string","version": "string"}}]}
→
https://api.spectrocloud.com/v1/dashboard/clusterprofiles/{uid}
summary:
Retrieves a specified cluster profile summaryPath parameters:
| Name | Type | Description | Required |
|---|---|---|---|
| uid | string | yes |
200
Cluster profile summary response
Cluster profile summary response
{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","lastModifiedTimestamp": "date-time","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"specSummary": {"draft": {"cloudType": "string","packs": [{"addonType": "string","annotations": "object","displayName": "string","layer": "string","logoUrl": "string","name": "string","packUid": "string","tag": "string","type": "string","version": "string"}],"type": "string"},"published": {"cloudType": "string","packs": [{"addonType": "string","annotations": "object","displayName": "string","layer": "string","logoUrl": "string","name": "string","packUid": "string","tag": "string","type": "string","version": "string"}],"type": "string"},"version": "string","versions": [{"uid": "string","version": "string"}]},"status": {"inUseClusterUids":deprecated ["string"],"inUseClusters": [{"name": "string","uid": "string"}],"isPublished": "boolean"}}
→
https://api.spectrocloud.com/v1/dashboard/projects
summary:
Retrieves a list of project summaryParameters:
| Name | Type | Description | Required |
|---|---|---|---|
| limit | integer | limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. | no |
| offset | integer | offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination. | no |
| continue | string | continue token to paginate the subsequent data items | no |
| metricPeriod | integer | Metric period in minutes defines latest metrics by period | no |
200
An array of project summary items
An array of project summary items
{"items": [{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","lastModifiedTimestamp": "date-time","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"specSummary": {"logoUrl": "string","teams": [{"name": "string","uid": "string"}],"users": [{"name": "string","uid": "string"}]},"status": {"clustersHealth": {"errored": "integer","healthy": "integer","running": "integer","unhealthy": "integer"},"usage": {"alloyCpuCores": "number","clusters": [{"cpuCores": "number","isAlloy": "boolean","name": "string","uid": "string"}],"pureCpuCores": "number"}}}],"listmeta": {"continue": "string","count": "integer","limit": "integer","offset": "integer"}}
→
https://api.spectrocloud.com/v1/dashboard/projects
Parameters:
| Name | Type | Description | Required |
|---|---|---|---|
| limit | integer | limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. | no |
| offset | integer | offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination. | no |
| continue | string | continue token to paginate the subsequent data items | no |
{"filter": {"name": {"beginsWith": "string","contains": "string","eq": "string","ignoreCase": "boolean","ne": "string"}},"sort": [{"field": "string","order": "string"}]}
200
An array of project filter summary items
An array of project filter summary items
{"items": [{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","lastModifiedTimestamp": "date-time","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"specSummary": {"logoUrl": "string","teams": [{"name": "string","uid": "string"}],"users": [{"name": "string","uid": "string"}]},"status": {"clustersHealth": {"errored": "integer","healthy": "integer","running": "integer","unhealthy": "integer"},"usage": {"alloyCpuCores": "number","clusters": [{"cpuCores": "number","isAlloy": "boolean","name": "string","uid": "string"}],"pureCpuCores": "number"}}}],"listmeta": {"continue": "string","count": "integer","limit": "integer","offset": "integer"}}
→
https://api.spectrocloud.com/v1/dashboard/projects/metadata
summary:
Retrieves a list of projects metadataParameters:
| Name | Type | Description | Required |
|---|---|---|---|
| name | string | Name of the project | no |
200
An array of project metadata items
An array of project metadata items
{"items": [{"metadata": {"name": "string","uid": "string"}}]}
→
https://api.spectrocloud.com/v1/dashboard/spectroclusters
summary:
Retrieves a list of cluster summary with provided filter spec Supported filter fields - ["cpuUsage", "memoryUsage", "clusterName", "tags", "healthState", "clusterStates", "isDeleted", "environments", "metricPeriod"] Supported sort fields - ["environment", "clusterName", "memoryUsage", "healthState", "creationTimestamp", "lastModifiedTimestamp"]Parameters:
| Name | Type | Description | Required |
|---|---|---|---|
| limit | integer | limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. | no |
| offset | integer | offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination. | no |
| continue | string | continue token to paginate the subsequent data items | no |
{"filter": {"cloudAccounts": ["string"],"clusterName": {"beginsWith": "string","contains": "string","eq": "string","ignoreCase": "boolean","ne": "string"},"clusterProfiles": ["string"],"clusterState":deprecated "string","clusterStates": ["string"],"cpuUsage": {"eq": "integer","gt": "integer","gte": "integer","lt": "integer","lte": "integer","ne": "integer"},"environment":deprecated ["string"],"environments": ["string"],"healthState": "string","isDeleted": "boolean","isHostCluster": "boolean","memoryUsage": {"eq": "number","gt": "number","gte": "number","lt": "number","lte": "number","ne": "number"},"metricPeriod": "integer","projectUids": ["string"],"tags": {"beginsWith": ["string"],"eq": ["string"],"ignoreCase": "boolean","ne": ["string"]}},"sort": [{"field": "string","order": "string"}]}
200
An array of cluster summary items
An array of cluster summary items
{"items": [{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","lastModifiedTimestamp": "date-time","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"specSummary": {"cloudAccountMeta": {"name": "string","uid": "string"},"cloudConfig": {"cloudType": "string","machinePools": [{"cloudType": "string","healthy": "integer","infraProfileTemplate": {"cloudType": "string","name": "string","packs": [{"annotations": "object","digest": "string","inValidReason": "string","isInvalid": "boolean","layer": "string","manifests": [{"apiVersion": "string","fieldPath": "string","kind": "string","name": "string","namespace": "string","resourceVersion": "string","uid": "string"}],"name": "string","packUid": "string","params": "object","presets": [{"add": "string","displayName": "string","group": "string","name": "string","remove": ["string"]}],"registryUid": "string","schema": [{"format": "string","hints": ["string"],"listOptions": ["string"],"name": "string","readonly": "boolean","regex": "string","required": "boolean","type": "string"}],"server": "string","tag": "string","type": "string","values": "string","version": "string"}],"type": "string","uid": "string","version": "integer"},"labels": ["string"],"size": "integer"}]},"clusterProfileTemplate": {"cloudType": "string","name": "string","packs": [{"annotations": "object","digest": "string","inValidReason": "string","isInvalid": "boolean","layer": "string","manifests": [{"apiVersion": "string","fieldPath": "string","kind": "string","name": "string","namespace": "string","resourceVersion": "string","uid": "string"}],"name": "string","packUid": "string","params": "object","presets": [{"add": "string","displayName": "string","group": "string","name": "string","remove": ["string"]}],"registryUid": "string","schema": [{"format": "string","hints": ["string"],"listOptions": ["string"],"name": "string","readonly": "boolean","regex": "string","required": "boolean","type": "string"}],"server": "string","tag": "string","type": "string","values": "string","version": "string"}],"type": "string","uid": "string","version": "integer"},"clusterProfileTemplates": [{"cloudType": "string","name": "string","packs": [{"annotations": "object","digest": "string","inValidReason": "string","isInvalid": "boolean","layer": "string","manifests": [{"apiVersion": "string","fieldPath": "string","kind": "string","name": "string","namespace": "string","resourceVersion": "string","uid": "string"}],"name": "string","packUid": "string","params": "object","presets": [{"add": "string","displayName": "string","group": "string","name": "string","remove": ["string"]}],"registryUid": "string","schema": [{"format": "string","hints": ["string"],"listOptions": ["string"],"name": "string","readonly": "boolean","regex": "string","required": "boolean","type": "string"}],"server": "string","tag": "string","type": "string","values": "string","version": "string"}],"type": "string","uid": "string","version": "integer"}],"projectMeta": {"name": "string","uid": "string"}},"status": {"clusterImport": {"importLink": "string","isBrownfield":deprecated "boolean","state": "string"},"cost": {"cloud": {"compute": "number","storage": "number","total": "number"},"total": "number"},"health": {"agentVersion": "string","conditions": [{"message": "string","relatedObject": {"kind": "string","name": "string","uid": "string"},"type": "string"}],"lastHeartBeatTimestamp": "date-time","state": "string"},"hourlyRate": {"cloud": {"compute": "number","storage": "number","total": "number"},"total": "number"},"location": {"coordinates": ["number"],"countryCode": "string","countryName": "string","regionCode": "string","regionName": "string"},"metrics": {"cpu": {"lastUpdatedTime": "date-time","limit": "number","request": "number","total": "number","unit": "string","usage": "number"},"memory": {"lastUpdatedTime": "date-time","limit": "number","request": "number","total": "number","unit": "string","usage": "number"}},"nested": {"appDeployments": [{"kind": "string","name": "string","projectUid": "string","tenantUid": "string","uid": "string"}],"hostCluster": {"apiVersion": "string","fieldPath": "string","kind": "string","name": "string","namespace": "string","resourceVersion": "string","uid": "string"},"lifecycleStatus": {"msg": "string","status": "string"},"nestedClusters": [{"kind": "string","name": "string","projectUid": "string","tenantUid": "string","uid": "string"}],"state": "string"},"notifications": {"isAvailable": "boolean"},"state": "string"}}],"listmeta": {"continue": "string","count": "integer","limit": "integer","offset": "integer"}}
→
https://api.spectrocloud.com/v1/dashboard/spectroclusters/cost
summary:
Retrieves spectro clusters cloud cost summary information{"filter": {"clouds": ["string"],"endTime": "date-time","projects": ["string"],"startTime": "date-time","workspaces": ["string"]},"options": {"groupBy": "string","period": "integer"}}
200
An array of resources cloud cost summary items
An array of resources cloud cost summary items
{"resources": [{"data": [{"compute": "number","storage": "number","timestamp": "number","total": "number"}],"entity": {"kind": "string","name": "string","uid": "string"},"total": {"compute": "number","storage": "number","total": "number"}}],"total": {"compute": "number","storage": "number","total": "number"}}
→
https://api.spectrocloud.com/v1/dashboard/spectroclusters/filters/workspace
summary:
Retrieves a list of running, non rbac configured clusters in a workspaceParameters:
| Name | Type | Description | Required |
|---|---|---|---|
| limit | integer | limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. | no |
| offset | integer | offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination. | no |
| continue | string | continue token to paginate the subsequent data items | no |
200
An array of cluster summary items
An array of cluster summary items
{"items": [{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","lastModifiedTimestamp": "date-time","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"specSummary": {"cloudAccountMeta": {"name": "string","uid": "string"},"cloudConfig": {"cloudType": "string","machinePools": [{"cloudType": "string","healthy": "integer","infraProfileTemplate": {"cloudType": "string","name": "string","packs": [{"annotations": "object","digest": "string","inValidReason": "string","isInvalid": "boolean","layer": "string","manifests": [{"apiVersion": "string","fieldPath": "string","kind": "string","name": "string","namespace": "string","resourceVersion": "string","uid": "string"}],"name": "string","packUid": "string","params": "object","presets": [{"add": "string","displayName": "string","group": "string","name": "string","remove": ["string"]}],"registryUid": "string","schema": [{"format": "string","hints": ["string"],"listOptions": ["string"],"name": "string","readonly": "boolean","regex": "string","required": "boolean","type": "string"}],"server": "string","tag": "string","type": "string","values": "string","version": "string"}],"type": "string","uid": "string","version": "integer"},"labels": ["string"],"size": "integer"}]},"clusterProfileTemplate": {"cloudType": "string","name": "string","packs": [{"annotations": "object","digest": "string","inValidReason": "string","isInvalid": "boolean","layer": "string","manifests": [{"apiVersion": "string","fieldPath": "string","kind": "string","name": "string","namespace": "string","resourceVersion": "string","uid": "string"}],"name": "string","packUid": "string","params": "object","presets": [{"add": "string","displayName": "string","group": "string","name": "string","remove": ["string"]}],"registryUid": "string","schema": [{"format": "string","hints": ["string"],"listOptions": ["string"],"name": "string","readonly": "boolean","regex": "string","required": "boolean","type": "string"}],"server": "string","tag": "string","type": "string","values": "string","version": "string"}],"type": "string","uid": "string","version": "integer"},"clusterProfileTemplates": [{"cloudType": "string","name": "string","packs": [{"annotations": "object","digest": "string","inValidReason": "string","isInvalid": "boolean","layer": "string","manifests": [{"apiVersion": "string","fieldPath": "string","kind": "string","name": "string","namespace": "string","resourceVersion": "string","uid": "string"}],"name": "string","packUid": "string","params": "object","presets": [{"add": "string","displayName": "string","group": "string","name": "string","remove": ["string"]}],"registryUid": "string","schema": [{"format": "string","hints": ["string"],"listOptions": ["string"],"name": "string","readonly": "boolean","regex": "string","required":