Dashboard

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:
NameTypeDescriptionRequired
limitintegerlimit 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
offsetintegeroffset 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
continuestringcontinue token to paginate the subsequent data itemsno
{
"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"
]
}
},
"sort": [
{
"field": "string",
"order": "string"
}
]
}
200
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",
"displayName": "string",
"layer": "string",
"name": "string",
"packUid": "string",
"tag": "string",
"type": "string",
"version": "string"
}
],
"type": "string",
"version": "integer"
},
"published": {
"cloudType": "string",
"packs": [
{
"addonType": "string",
"displayName": "string",
"layer": "string",
"name": "string",
"packUid": "string",
"tag": "string",
"type": "string",
"version": "string"
}
],
"type": "string",
"version": "integer"
}
},
"status": {
"isPublished": "boolean"
}
}
],
"listmeta": {
"continue": "string",
"count": "integer",
"limit": "integer",
"offset": "integer"
}
}

https://api.spectrocloud.com/v1/dashboard/projects

summary:
Retrieves a list of project summary
Parameters:
NameTypeDescriptionRequired
limitintegerlimit 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
offsetintegeroffset 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
continuestringcontinue token to paginate the subsequent data itemsno
metricPeriodintegerMetric period in minutes defines latest metrics by periodno
200
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/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:
NameTypeDescriptionRequired
limitintegerlimit 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
offsetintegeroffset 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
continuestringcontinue token to paginate the subsequent data itemsno
{
"filter": {
"clusterName": {
"beginsWith": "string",
"contains": "string",
"eq": "string",
"ignoreCase": "boolean",
"ne": "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",
"memoryUsage": {
"eq": "number",
"gt": "number",
"gte": "number",
"lt": "number",
"lte": "number",
"ne": "number"
},
"metricPeriod": "integer",
"tags": {
"beginsWith": [
"string"
],
"eq": [
"string"
],
"ignoreCase": "boolean",
"ne": [
"string"
]
}
},
"sort": [
{
"field": "string",
"order": "string"
}
]
}
200
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": {
"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"
]
}
],
"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"
]
}
],
"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"
]
}
],
"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"
}
],
"state": "string"
},
"hourlyRate": {
"cloud": {
"compute": "number",
"storage": "number",
"total": "number"
},
"total": "number"
},
"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"
}
},
"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
{
"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 workspace
Parameters:
NameTypeDescriptionRequired
limitintegerlimit 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
offsetintegeroffset 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
continuestringcontinue token to paginate the subsequent data itemsno
200
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": {
"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"
]
}
],
"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"
]
}
],
"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"
]
}
],
"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"
}
],
"state": "string"
},
"hourlyRate": {
"cloud": {
"compute": "number",
"storage": "number",
"total": "number"
},
"total": "number"
},
"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"
}
},
"notifications": {
"isAvailable": "boolean"
},
"state": "string"
}
}
],
"listmeta": {
"continue": "string",
"count": "integer",
"limit": "integer",
"offset": "integer"
}
}

https://api.spectrocloud.com/v1/dashboard/spectroclusters/metadata

summary:
Retrieves a list of cluster summary
{
"filter": {
"environment": "string",
"isAlloy": "boolean",
"isImported": "boolean",
"name": {
"beginsWith": "string",
"contains": "string",
"eq": "string",
"ignoreCase": "boolean",
"ne": "string"
},
"state": "string"
},
"sort": "string"
}
200
An array of cluster summary items
{
"items": [
{
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
}
]
}

https://api.spectrocloud.com/v1/dashboard/spectroclusters/resources/consumption

summary:
Retrieves spectro clusters resource consumption
{
"filter": {
"clouds": [
"string"
],
"clusters": [
"string"
],
"endTime": "date-time",
"includeMasterMachines": "boolean",
"namespaces": [
"string"
],
"projects": [
"string"
],
"startTime": "date-time",
"workspaces": [
"string"
]
},
"options": {
"enableSummaryView": "boolean",
"groupBy": "string",
"period": "integer"
}
}
200
An array of resource consumption data items
{
"cpuUnit": "string",
"memoryUnit": "string",
"resources": [
{
"associatedResources": [
{
"kind": "string",
"name": "string",
"uid": "string"
}
],
"data": [
{
"allotted": {
"cpu": "number",
"memory": "number"
},
"timestamp": "number",
"usage": {
"cpu": "number",
"memory": "number"
}
}
],
"entity": {
"kind": "string",
"name": "string",
"uid": "string"
},
"total": {
"allotted": {
"cpu": "number",
"memory": "number"
},
"usage": {
"cpu": "number",
"memory": "number"
}
}
}
],
"total": {
"allotted": {
"cpu": "number",
"memory": "number"
},
"usage": {
"cpu": "number",
"memory": "number"
}
}
}

https://api.spectrocloud.com/v1/dashboard/spectroclusters/resources/cost

summary:
Retrieves spectro clusters resources cost summary information
{
"filter": {
"clouds": [
"string"
],
"clusters": [
"string"
],
"endTime": "date-time",
"includeMasterMachines": "boolean",
"namespaces": [
"string"
],
"projects": [
"string"
],
"startTime": "date-time",
"workspaces": [
"string"
]
},
"options": {
"enableSummaryView": "boolean",
"groupBy": "string",
"period": "integer"
}
}
200
An array of resources cost summary items
{
"resources": [
{
"associatedResources": [
{
"kind": "string",
"name": "string",
"uid": "string"
}
],
"data": [
{
"cpu": "number",
"memory": "number",
"storage": "number",
"timestamp": "number",
"total": "number"
}
],
"entity": {
"kind": "string",
"name": "string",
"uid": "string"
},
"total": {
"cpu": "number",
"memory": "number",
"storage": "number",
"total": "number"
}
}
],
"total": {
"cpu": "number",
"memory": "number",
"storage": "number",
"total": "number"
}
}

https://api.spectrocloud.com/v1/dashboard/spectroclusters/resources/usage

summary:
Retrieves spectro clusters resources usage summary information
{
"filter": {
"clouds": [
"string"
],
"clusters": [
"string"
],
"endTime": "date-time",
"includeMasterMachines": "boolean",
"namespaces": [
"string"
],
"pods": [
"string"
],
"projects": [
"string"
],
"startTime": "date-time",
"workload": {
"names": [
"string"
],
"type": "string"
},
"workspaces": [
"string"
]
},
"options": {
"enableSummaryView": "boolean",
"groupBy": "string",
"period": "integer"
}
}
200
An array of resources usage summary items
{
"cpuUnit": "string",
"memoryUnit": "string",
"resources": [
{
"associatedResources": [
{
"kind": "string",
"name": "string",
"uid": "string"
}
],
"data": [
{
"cpu": "number",
"memory": "number",
"timestamp": "number"
}
],
"entity": {
"kind": "string",
"name": "string",
"uid": "string"
}
}
]
}

https://api.spectrocloud.com/v1/dashboard/spectroclusters/{uid}

summary:
Returns the specified cluster summary
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
An spectro cluster summary
{
"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": {
"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"
]
}
],
"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"
}
]
},
"cloudaccount": {
"name": "string",
"uid": "string"
},
"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"
]
}
],
"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"
]
}
],
"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"
}
]
},
"status": {
"abortTimestamp": "date-time",
"apiEndpoints": [
{
"host": "string",
"port": "integer"
}
],
"clusterImport": {
"importLink": "string",
"isBrownfield":deprecated "boolean",
"state": "string"
},
"conditions": [
{
"lastProbeTime": "date-time",
"lastTransitionTime": "date-time",
"message": "string",
"reason": "string",
"status": "string",
"type": "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"
}
],
"state": "string"
},
"hourlyRate": {
"cloud": {
"compute": "number",
"storage": "number",
"total": "number"
},
"total": "number"
},
"kubeMeta": {
"hasKubeConfig": "boolean",
"hasKubeConfigClient": "boolean",
"hasManifest": "boolean"
},
"services": [
{
"host": "string",
"name": "string",
"ports": [
{
"port": "integer",
"protocol": "string"
}
]
}
],
"state": "string",
"upgrades": [
{
"reason": [
"string"
],
"timestamp": "date-time"
}
],
"workspaces": [
{
"kind": "string",
"name": "string",
"uid": "string"
}
]
}
}

https://api.spectrocloud.com/v1/dashboard/spectroclusters/{uid}/cost

summary:
Retrieves the specified cluster cost summary
Parameters:
NameTypeDescriptionRequired
startTimestringTime is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.no
endTimestringTime is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.no
periodintegerperiod in minutes, group the data point by the specified periodno
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
An spectro cluster cost summary
{
"cluster": {
"cloud": {
"cost": {
"cloud": {
"compute": "number",
"storage": "number",
"total": "number"
},
"total": "number"
},
"data": [
{
"compute": "number",
"storage": "number",
"timestamp": "number",
"total": "number"
}
]
},
"cost": {
"cloud": {
"compute": "number",
"storage": "number",
"total": "number"
},
"total": "number"
},
"name": "string",
"uid": "string"
},
"endTime": "date-time",
"period": "integer",
"startTime": "date-time"
}

https://api.spectrocloud.com/v1/dashboard/spectroclusters/{uid}/resources/consumption

summary:
Retrieves specified spectro cluster resource consumption
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"filter": {
"clouds": [
"string"
],
"clusters": [
"string"
],
"endTime": "date-time",
"includeMasterMachines": "boolean",
"namespaces": [
"string"
],
"projects": [
"string"
],
"startTime": "date-time",
"workspaces": [
"string"
]
},
"options": {
"enableSummaryView": "boolean",
"groupBy": "string",
"period": "integer"
}
}
200
An array of resource consumption data items
{
"cpuUnit": "string",
"memoryUnit": "string",
"resources": [
{
"associatedResources": [
{
"kind": "string",
"name": "string",
"uid": "string"
}
],
"data": [
{
"allotted": {
"cpu": "number",
"memory": "number"
},
"timestamp": "number",
"usage": {
"cpu": "number",
"memory": "number"
}
}
],
"entity": {
"kind": "string",
"name": "string",
"uid": "string"
},
"total": {
"allotted": {
"cpu": "number",
"memory": "number"
},
"usage": {
"cpu": "number",
"memory": "number"
}
}
}
],
"total": {
"allotted": {
"cpu": "number",
"memory": "number"
},
"usage": {
"cpu": "number",
"memory": "number"
}
}
}

https://api.spectrocloud.com/v1/dashboard/spectroclusters/{uid}/workloads

summary:
Retrieves specified cluster workloads
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"filter": {
"namespaces": [
"string"
]
}
}
200
An array of cluster workloads
{
"metadata": {
"annotations": "object",
"labels": "object",
"name": "string"
},
"spec": {
"cronJobs": [
{
"metadata": {
"creationTimestamp": "date-time",
"entity": {
"kind": "string",
"name": "string",
"uid": "string"
},
"labels": "object",
"namespace": "string"
},
"spec": {
"schedule": "string"
},
"status": {
"lastScheduleTime": "date-time"
}
}
],
"daemonSets": [
{
"metadata": {
"creationTimestamp": "date-time",
"entity": {
"kind": "string",
"name": "string",
"uid": "string"
},
"labels": "object",
"namespace": "string"
},
"status": {
"available": "integer",
"currentScheduled": "integer",
"desiredScheduled": "integer",
"misScheduled": "integer",
"ready": "integer",
"updatedScheduled": "integer"
}
}
],
"deployments": [
{
"metadata": {
"creationTimestamp": "date-time",
"entity": {
"kind": "string",
"name": "string",
"uid": "string"
},
"labels": "object",
"namespace": "string"
},
"status": {
"replicas": {
"available": "integer",
"ready": "integer",
"total": "integer",
"updated": "integer"
}
}
}
],
"jobs": [
{
"metadata": {
"creationTimestamp": "date-time",
"entity": {
"kind": "string",
"name": "string",
"uid": "string"
},
"labels": "object",
"namespace": "string"
},
"status": {
"completionTime": "date-time",
"conditions": [
{
"lastTransitionTime": "date-time",
"lastUpdateTime": "date-time",
"message": "string",
"reason": "string",
"status": "string",
"type": "string"
}
],
"startTime": "date-time",
"succeeded": "integer"
}
}
],
"pods": [
{
"metadata": {
"associatedRefs": [
{
"kind": "string",
"name": "string",
"uid": "string"
}
],
"creationTimestamp": "date-time",
"entity": {
"kind": "string",
"name": "string",
"uid": "string"
},
"labels": "object",
"machineUid": "string",
"namespace": "string",
"nodename": "string"
},
"spec": {
"containers": [
{
"image": "string",
"name": "string",
"resources": {
"limits": {
"cpu": "integer",
"cpuUnit": "string",
"memory": "integer",
"memoryUnit": "string"
},
"requests": {
"cpu": "integer",
"cpuUnit": "string",
"memory": "integer",
"memoryUnit": "string"
}
}
}
],
"volumes": [
{
"name": "string"
}
]
},
"status": {
"containers": [
{
"image": "string",
"name": "string",
"ready": "boolean",
"restartCount": "integer",
"started": "boolean",
"state": {
"exitCode": "integer",
"finishedAt": "date-time",
"reason": "string",
"startedAt": "date-time",
"state": "string"
}
}
],
"phase": "string",
"podIp": "string",
"qosClass": "string"
}
}
],
"statefulSets": [
{
"metadata": {
"creationTimestamp": "date-time",
"entity": {
"kind": "string",
"name": "string",
"uid": "string"
},
"labels": "object",
"namespace": "string"
},
"status": {
"replicas": {
"available": "integer",
"ready": "integer",
"total": "integer",
"updated": "integer"
}
}
}
]
}
}

https://api.spectrocloud.com/v1/dashboard/spectroclusters/{uid}/workloads/cronjob

summary:
Retrieves specified cluster workload cronjobs
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"filter": {
"namespaces": [
"string"
]
}
}
200
An array of cluster workload cronjobs
{
"cronJobs": [
{
"metadata": {
"creationTimestamp": "date-time",
"entity": {
"kind": "string",
"name": "string",
"uid": "string"
},
"labels": "object",
"namespace": "string"
},
"spec": {
"schedule": "string"
},
"status": {
"lastScheduleTime": "date-time"
}
}
]
}

https://api.spectrocloud.com/v1/dashboard/spectroclusters/{uid}/workloads/daemonset

summary:
Retrieves specified cluster workload daemonsets
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"filter": {
"namespaces": [
"string"
]
}
}
200
An array of cluster workload daemonsets
{
"daemonSets": [
{
"metadata": {
"creationTimestamp": "date-time",
"entity": {
"kind": "string",
"name": "string",
"uid": "string"
},
"labels": "object",
"namespace": "string"
},
"status": {
"available": "integer",
"currentScheduled": "integer",
"desiredScheduled": "integer",
"misScheduled": "integer",
"ready": "integer",
"updatedScheduled": "integer"
}
}
]
}

https://api.spectrocloud.com/v1/dashboard/spectroclusters/{uid}/workloads/deployment

summary:
Retrieves specified cluster workload deployments
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"filter": {
"namespaces": [
"string"
]
}
}
200
An array of cluster workload deployments
{
"deployments": [
{
"metadata": {
"creationTimestamp": "date-time",
"entity": {
"kind": "string",
"name": "string",
"uid": "string"
},
"labels": "object",
"namespace": "string"
},
"status": {
"replicas": {
"available": "integer",
"ready": "integer",
"total": "integer",
"updated": "integer"
}
}
}
]
}

https://api.spectrocloud.com/v1/dashboard/spectroclusters/{uid}/workloads/job

summary:
Retrieves specified cluster workload jobs
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"filter": {
"namespaces": [
"string"
]
}
}
200
An array of cluster workload jobs
{
"jobs": [
{
"metadata": {
"creationTimestamp": "date-time",
"entity": {
"kind": "string",
"name": "string",
"uid": "string"
},
"labels": "object",
"namespace": "string"
},
"status": {
"completionTime": "date-time",
"conditions": [
{
"lastTransitionTime": "date-time",
"lastUpdateTime": "date-time",
"message": "string",
"reason": "string",
"status": "string",
"type": "string"
}
],
"startTime": "date-time",
"succeeded": "integer"
}
}
]
}

https://api.spectrocloud.com/v1/dashboard/spectroclusters/{uid}/workloads/namespace

summary:
Retrieves specified cluster workload namespaces
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"filter": {
"namespaces": [
"string"
]
}
}
200
An array of cluster workload namespaces
{
"namespaces": [
{
"metadata": {
"creationTimestamp": "date-time",
"entity": {
"kind": "string",
"name": "string",
"uid": "string"
},
"labels": "object",
"namespace": "string"
},
"status": {
"phase": "string"
}
}
]
}

https://api.spectrocloud.com/v1/dashboard/spectroclusters/{uid}/workloads/pod

summary:
Retrieves specified cluster workload pods
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"filter": {
"namespaces": [
"string"
]
}
}
200
An array of cluster workload pods
{
"pods": [
{
"metadata": {
"associatedRefs": [
{
"kind": "string",
"name": "string",
"uid": "string"
}
],
"creationTimestamp": "date-time",
"entity": {
"kind": "string",
"name": "string",
"uid": "string"
},
"labels": "object",
"machineUid": "string",
"namespace": "string",
"nodename": "string"
},
"spec": {
"containers": [
{
"image": "string",
"name": "string",
"resources": {
"limits": {
"cpu": "integer",
"cpuUnit": "string",
"memory": "integer",
"memoryUnit": "string"
},
"requests": {
"cpu": "integer",
"cpuUnit": "string",
"memory": "integer",
"memoryUnit": "string"
}
}
}
],
"volumes": [
{
"name": "string"
}
]
},
"status": {
"containers": [
{
"image": "string",
"name": "string",
"ready": "boolean",
"restartCount": "integer",
"started": "boolean",
"state": {
"exitCode": "integer",
"finishedAt": "date-time",
"reason": "string",
"startedAt": "date-time",
"state": "string"
}
}
],
"phase": "string",
"podIp": "string",
"qosClass": "string"
}
}
]
}

https://api.spectrocloud.com/v1/dashboard/spectroclusters/{uid}/workloads/statefulset

summary:
Retrieves specified cluster workload statefulsets
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"filter": {
"namespaces": [
"string"
]
}
}
200
An array of cluster workload statefulsets
{
"statefulSets": [
{
"metadata": {
"creationTimestamp": "date-time",
"entity": {
"kind": "string",
"name": "string",
"uid": "string"
},
"labels": "object",
"namespace": "string"
},
"status": {
"replicas": {
"available": "integer",
"ready": "integer",
"total": "integer",
"updated": "integer"
}
}
}
]
}

https://api.spectrocloud.com/v1/dashboard/workspaces

summary:
Retrieves a list of workspace
200
An array of workspace
{
"cpuUnit": "string",
"items": [
{
"meta": {
"clusterNames":deprecated [
"string"
],
"clusterRefs": [
{
"name": "string",
"uid": "string"
}
],
"creationTime": "date-time",
"name": "string",
"namespaces": [
"string"
],
"uid": "string"
},
"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": {
"clusterRefs": [
{
"name": "string",
"uid": "string"
}
],
"namespaces": [
"string"
]
},
"status": {
"namespaces": [
{
"name": "string",
"total": {
"cpu": {
"allocated": "number",
"usage": "number"
},
"memory": {
"allocated": "number",
"usage": "number"
}
}
}
],
"total": {
"cpu": {
"allocated": "number",
"usage": "number"
},
"memory": {
"allocated": "number",
"usage": "number"
}
}
}
}
],
"memoryUnit": "string"
}

https://api.spectrocloud.com/v1/dashboard/workspaces/{uid}/spectroclusters/workloads/cronjob

summary:
Retrieves specified workspace clusters workload cronjobs
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"filter": {
"clusters": [
"string"
],
"namespaces": [
"string"
]
}
}
200
An array of clusters workload jobs
{
"clusters": [
{
"cronjobs": [
{
"metadata": {
"creationTimestamp": "date-time",
"entity": {
"kind": "string",
"name": "string",
"uid": "string"
},
"labels": "object",
"namespace": "string"
},
"spec": {
"schedule": "string"
},
"status": {
"lastScheduleTime": "date-time"
}
}
],
"metadata": {
"kind": "string",
"name": "string",
"uid": "string"
}
}
],
"metadata": {
"annotations": "object",
"labels": "object",
"name": "string"
}
}

https://api.spectrocloud.com/v1/dashboard/workspaces/{uid}/spectroclusters/workloads/daemonset

summary:
Retrieves specified workspace clusters workload daemonsets
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"filter": {
"clusters": [
"string"
],
"namespaces": [
"string"
]
}
}
200
An array of clusters workload daemonsets
{
"clusters": [
{
"daemonSets": [
{
"metadata": {
"creationTimestamp": "date-time",
"entity": {
"kind": "string",
"name": "string",
"uid": "string"
},
"labels": "object",
"namespace": "string"
},
"status": {
"available": "integer",
"currentScheduled": "integer",
"desiredScheduled": "integer",
"misScheduled": "integer",
"ready": "integer",
"updatedScheduled": "integer"
}
}
],
"metadata": {
"kind": "string",
"name": "string",
"uid": "string"
}
}
],
"metadata": {
"annotations": "object",
"labels": "object",
"name": "string"
}
}

https://api.spectrocloud.com/v1/dashboard/workspaces/{uid}/spectroclusters/workloads/deployment

summary:
Retrieves specified workspace clusters workload deployments
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"filter": {
"clusters": [
"string"
],
"namespaces": [
"string"
]
}
}
200
An array of clusters workload deployments
{
"clusters": [
{
"deployments": [
{
"metadata": {
"creationTimestamp": "date-time",
"entity": {
"kind": "string",
"name": "string",
"uid": "string"
},
"labels": "object",
"namespace": "string"
},
"status": {
"replicas": {
"available": "integer",
"ready": "integer",
"total": "integer",
"updated": "integer"
}
}
}
],
"metadata": {
"kind": "string",
"name": "string",
"uid": "string"
}
}
],
"metadata": {
"annotations": "object",
"labels": "object",
"name": "string"
}
}

https://api.spectrocloud.com/v1/dashboard/workspaces/{uid}/spectroclusters/workloads/job

summary:
Retrieves specified workspace clusters workload jobs
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"filter": {
"clusters": [
"string"
],
"namespaces": [
"string"
]
}
}
200
An array of clusters workload jobs
{
"clusters": [
{
"jobs": [
{
"metadata": {
"creationTimestamp": "date-time",
"entity": {
"kind": "string",
"name": "string",
"uid": "string"
},
"labels": "object",
"namespace": "string"
},
"status": {
"completionTime": "date-time",
"conditions": [
{
"lastTransitionTime": "date-time",
"lastUpdateTime": "date-time",
"message": "string",
"reason": "string",
"status": "string",
"type": "string"
}
],
"startTime": "date-time",
"succeeded": "integer"
}
}
],
"metadata": {
"kind": "string",
"name": "string",
"uid": "string"
}
}
],
"metadata": {
"annotations": "object",
"labels": "object",
"name": "string"
}
</