Clusters

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

summary:
Retrieves a list of clusters
Parameters:
NameTypeDescriptionRequired
fieldsstringSet of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.nameno
filtersstringFilters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws Server will be restricted to certain fields based on the indexed data for each resource.no
orderBystringSpecify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1no
limitintegerlimit is a maximum number of responses to return for a list call. 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
continuestringcontinue token for the datasetno
200
An array of cluster items
{
"items": [
{
"apiVersion": "string",
"kind": "string",
"spec": {
"cloudType": "string",
"clusterConfig": {
"clusterRbac": [
{
"kind": "string",
"name": "string",
"uid": "string"
}
],
"controlPlaneHealthCheckTimeout": "string",
"machineHealthConfig": {
"healthCheckMaxUnhealthy": "string",
"networkReadyHealthCheckDuration": "string",
"nodeReadyHealthCheckDuration": "string"
},
"machineManagementConfig": {
"osPatchConfig": {
"onDemandPatchAfter": "date-time",
"patchOnBoot": "boolean",
"schedule": "string"
}
},
"updateWorkerPoolsInParallel": "boolean"
},
"clusterProfileTemplates": [
{
"cloudType": "string",
"name": "string",
"packServerRefs": [
null
],
"packServerSecret": "string",
"packs": [
{
"annotations": "object",
"digest": "string",
"inValidReason": "string",
"isInvalid": "boolean",
"layer": "string",
"manifests": [
null
],
"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"
}
],
"clusterType": "string"
},
"status": {
"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"
}
],
"services": [
{
"host": "string",
"name": "string",
"ports": [
{
"port": "integer",
"protocol": "string"
}
]
}
],
"state": "string"
}
}
],
"listmeta": {
"continue": "string",
"count": "integer"
}
}

https://api.spectrocloud.com/v1/spectroclusters/acquire/create

summary:
Returns the spectro cluster for creation with lock
Parameters:
NameTypeDescriptionRequired
overlordUidstringno
overlordModestringno
jetUidstringno
200
OK
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"cloudConfigRef": {
"apiVersion": "string",
"fieldPath": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"uid": "string"
},
"cloudType": "string",
"clusterConfig": {
"clusterRbac": [
{
"kind": "string",
"name": "string",
"uid": "string"
}
],
"controlPlaneHealthCheckTimeout": "string",
"machineHealthConfig": {
"healthCheckMaxUnhealthy": "string",
"networkReadyHealthCheckDuration": "string",
"nodeReadyHealthCheckDuration": "string"
},
"machineManagementConfig": {
"osPatchConfig": {
"onDemandPatchAfter": "date-time",
"patchOnBoot": "boolean",
"schedule": "string"
}
},
"updateWorkerPoolsInParallel": "boolean"
},
"clusterProfileTemplates": [
{
"cloudType": "string",
"name": "string",
"packServerRefs": [
{
"apiVersion": "string",
"fieldPath": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"uid": "string"
}
],
"packServerSecret": "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"
}
],
"clusterType": "string"
},
"status": {
"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"
}
],
"services": [
{
"host": "string",
"name": "string",
"ports": [
{
"port": "integer",
"protocol": "string"
}
]
}
],
"state": "string"
}
}

https://api.spectrocloud.com/v1/spectroclusters/acquire/delete

summary:
Returns the spectro cluster for deletion with lock
Parameters:
NameTypeDescriptionRequired
overlordUidstringno
overlordModestringno
jetUidstringno
200
OK
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"cloudConfigRef": {
"apiVersion": "string",
"fieldPath": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"uid": "string"
},
"cloudType": "string",
"clusterConfig": {
"clusterRbac": [
{
"kind": "string",
"name": "string",
"uid": "string"
}
],
"controlPlaneHealthCheckTimeout": "string",
"machineHealthConfig": {
"healthCheckMaxUnhealthy": "string",
"networkReadyHealthCheckDuration": "string",
"nodeReadyHealthCheckDuration": "string"
},
"machineManagementConfig": {
"osPatchConfig": {
"onDemandPatchAfter": "date-time",
"patchOnBoot": "boolean",
"schedule": "string"
}
},
"updateWorkerPoolsInParallel": "boolean"
},
"clusterProfileTemplates": [
{
"cloudType": "string",
"name": "string",
"packServerRefs": [
{
"apiVersion": "string",
"fieldPath": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"uid": "string"
}
],
"packServerSecret": "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"
}
],
"clusterType": "string"
},
"status": {
"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"
}
],
"services": [
{
"host": "string",
"name": "string",
"ports": [
{
"port": "integer",
"protocol": "string"
}
]
}
],
"state": "string"
}
}

https://api.spectrocloud.com/v1/spectroclusters/aks

summary:
Creates an AKS cluster
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"cloudAccountUid": "string",
"cloudConfig": {
"aadProfile": {
"adminGroupObjectIDs": [
"string"
],
"managed": "boolean"
},
"controlPlaneSubnet": {
"cidrBlock": "string",
"name": "string",
"securityGroupName": "string"
},
"location": "string",
"resourceGroup": "string",
"sshKey": "string",
"subscriptionId": "string",
"vnetCidrBlock": "string",
"vnetName": "string",
"workerSubnet": {
"cidrBlock": "string",
"name": "string",
"securityGroupName": "string"
}
},
"clusterConfig": {
"clusterRbac": [
{
"kind": "string",
"name": "string",
"uid": "string"
}
],
"controlPlaneHealthCheckTimeout": "string",
"machineHealthConfig": {
"healthCheckMaxUnhealthy": "string",
"networkReadyHealthCheckDuration": "string",
"nodeReadyHealthCheckDuration": "string"
},
"machineManagementConfig": {
"osPatchConfig": {
"onDemandPatchAfter": "date-time",
"patchOnBoot": "boolean",
"schedule": "string"
}
},
"updateWorkerPoolsInParallel": "boolean"
},
"machinepoolconfig": [
{
"cloudConfig": {
"azs": [
"string"
],
"instanceType": "string",
"isSystemNodePool": "boolean",
"osDisk": {
"diskSizeGB": "integer",
"managedDisk": {
"storageAccountType": "string"
},
"osType": "string"
}
},
"managedPoolConfig": {
"isSystemNodePool": "boolean"
},
"poolConfig": {
"additionalTags": "object",
"isControlPlane": "boolean",
"labels": [
"string"
],
"maxSize": "integer",
"minSize": "integer",
"name": "string",
"size": "integer",
"updateStrategy": {
"type": "string"
},
"useControlPlaneAsWorker": "boolean"
},
"profileConfig": {
"infraProfileUid": "string",
"packValues": [
{
"manifests": [
{
"content": "string",
"name": "string",
"uid": "string"
}
],
"name": "string",
"tag": "string",
"type": "string",
"values": "string"
}
]
}
}
],
"policies": {
"backupPolicy": {
"backupLocationUid": "string",
"backupName": "string",
"backupPrefix": "string",
"durationInHours": "number",
"includeAllDisks": "boolean",
"includeClusterResources": "boolean",
"locationType": "string",
"namespaces": [
"string"
],
"schedule": {
"scheduledRunTime": "string"
}
},
"scanPolicy": {
"kubeBench": {
"schedule": {
"scheduledRunTime": "string"
}
},
"kubeHunter": {
"schedule": {
"scheduledRunTime": "string"
}
},
"sonobuoy": {
"schedule": {
"scheduledRunTime": "string"
}
}
}
},
"profiles": [
{
"packValues": [
{
"manifests": [
{
"content": "string",
"name": "string",
"uid": "string"
}
],
"name": "string",
"tag": "string",
"type": "string",
"values": "string"
}
],
"uid": "string"
}
]
}
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/spectroclusters/aks/rate

summary:
Get aks spectro cluster estimated rate information
Parameters:
NameTypeDescriptionRequired
periodTypestringno
{
"cloudConfig": {
"aadProfile": {
"adminGroupObjectIDs": [
"string"
],
"managed": "boolean"
},
"controlPlaneSubnet": {
"cidrBlock": "string",
"name": "string",
"securityGroupName": "string"
},
"location": "string",
"resourceGroup": "string",
"sshKey": "string",
"subscriptionId": "string",
"vnetCidrBlock": "string",
"vnetName": "string",
"workerSubnet": {
"cidrBlock": "string",
"name": "string",
"securityGroupName": "string"
}
},
"machinepoolconfig": [
{
"cloudConfig": {
"azs": [
"string"
],
"instanceType": "string",
"isSystemNodePool": "boolean",
"osDisk": {
"diskSizeGB": "integer",
"managedDisk": {
"storageAccountType": "string"
},
"osType": "string"
}
},
"managedPoolConfig": {
"isSystemNodePool": "boolean"
},
"poolConfig": {
"additionalTags": "object",
"isControlPlane": "boolean",
"labels": [
"string"
],
"maxSize": "integer",
"minSize": "integer",
"name": "string",
"size": "integer",
"updateStrategy": {
"type": "string"
},
"useControlPlaneAsWorker": "boolean"
},
"profileConfig": {
"infraProfileUid": "string",
"packValues": [
{
"manifests": [
{
"content": "string",
"name": "string",
"uid": "string"
}
],
"name": "string",
"tag": "string",
"type": "string",
"values": "string"
}
]
}
}
]
}
200
Aks Cluster estimated rate response
{
"machinePools": [
{
"name": "string",
"nodesCount": "integer",
"rate": {
"compute": {
"rate": "number",
"type": "string"
},
"storage": [
{
"iops": "number",
"rate": "number",
"sizeGB": "number",
"throughput": "number",
"type": "string"
}
],
"total": "number"
}
}
],
"name": "string",
"rate": {
"compute": "number",
"storage": "number",
"total": "number"
},
"resourceMetadata": {
"instanceTypes": "object",
"storageTypes": "object"
}
}

https://api.spectrocloud.com/v1/spectroclusters/aks/validate

summary:
Validate aks spectro cluster create
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"cloudAccountUid": "string",
"cloudConfig": {
"aadProfile": {
"adminGroupObjectIDs": [
"string"
],
"managed": "boolean"
},
"controlPlaneSubnet": {
"cidrBlock": "string",
"name": "string",
"securityGroupName": "string"
},
"location": "string",
"resourceGroup": "string",
"sshKey": "string",
"subscriptionId": "string",
"vnetCidrBlock": "string",
"vnetName": "string",
"workerSubnet": {
"cidrBlock": "string",
"name": "string",
"securityGroupName": "string"
}
},
"clusterConfig": {
"clusterRbac": [
{
"kind": "string",
"name": "string",
"uid": "string"
}
],
"controlPlaneHealthCheckTimeout": "string",
"machineHealthConfig": {
"healthCheckMaxUnhealthy": "string",
"networkReadyHealthCheckDuration": "string",
"nodeReadyHealthCheckDuration": "string"
},
"machineManagementConfig": {
"osPatchConfig": {
"onDemandPatchAfter": "date-time",
"patchOnBoot": "boolean",
"schedule": "string"
}
},
"updateWorkerPoolsInParallel": "boolean"
},
"machinepoolconfig": [
{
"cloudConfig": {
"azs": [
"string"
],
"instanceType": "string",
"isSystemNodePool": "boolean",
"osDisk": {
"diskSizeGB": "integer",
"managedDisk": {
"storageAccountType": "string"
},
"osType": "string"
}
},
"managedPoolConfig": {
"isSystemNodePool": "boolean"
},
"poolConfig": {
"additionalTags": "object",
"isControlPlane": "boolean",
"labels": [
"string"
],
"maxSize": "integer",
"minSize": "integer",
"name": "string",
"size": "integer",
"updateStrategy": {
"type": "string"
},
"useControlPlaneAsWorker": "boolean"
},
"profileConfig": {
"infraProfileUid": "string",
"packValues": [
{
"manifests": [
{
"content": "string",
"name": "string",
"uid": "string"
}
],
"name": "string",
"tag": "string",
"type": "string",
"values": "string"
}
]
}
}
],
"policies": {
"backupPolicy": {
"backupLocationUid": "string",
"backupName": "string",
"backupPrefix": "string",
"durationInHours": "number",
"includeAllDisks": "boolean",
"includeClusterResources": "boolean",
"locationType": "string",
"namespaces": [
"string"
],
"schedule": {
"scheduledRunTime": "string"
}
},
"scanPolicy": {
"kubeBench": {
"schedule": {
"scheduledRunTime": "string"
}
},
"kubeHunter": {
"schedule": {
"scheduledRunTime": "string"
}
},
"sonobuoy": {
"schedule": {
"scheduledRunTime": "string"
}
}
}
},
"profiles": [
{
"packValues": [
{
"manifests": [
{
"content": "string",
"name": "string",
"uid": "string"
}
],
"name": "string",
"tag": "string",
"type": "string",
"values": "string"
}
],
"uid": "string"
}
]
}
}
200
Aks Cluster validation response
{
"machinePools": {
"results": [
{
"displayName": "string",
"errors": [
{
"code": "string",
"message": "string"
}
],
"name": "string"
}
]
},
"profiles": [
{
"packs": {
"results": [
{
"displayName": "string",
"errors": [
{
"code": "string",
"message": "string"
}
],
"name": "string"
}
]
},
"uid": "string"
}
]
}

https://api.spectrocloud.com/v1/spectroclusters/aws

summary:
Creates an AWS cluster
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"cloudAccountUid": "string",
"cloudConfig": {
"bastionDisabled": "boolean",
"controlPlaneLoadBalancer": "string",
"region": "string",
"sshKeyName": "string",
"vpcId": "string"
},
"clusterConfig": {
"clusterRbac": [
{
"kind": "string",
"name": "string",
"uid": "string"
}
],
"controlPlaneHealthCheckTimeout": "string",
"machineHealthConfig": {
"healthCheckMaxUnhealthy": "string",
"networkReadyHealthCheckDuration": "string",
"nodeReadyHealthCheckDuration": "string"
},
"machineManagementConfig": {
"osPatchConfig": {
"onDemandPatchAfter": "date-time",
"patchOnBoot": "boolean",
"schedule": "string"
}
},
"updateWorkerPoolsInParallel": "boolean"
},
"machinepoolconfig": [
{
"cloudConfig": {
"azs": [
"string"
],
"capacityType": "string",
"instanceType": "string",
"rootDeviceSize": "integer",
"spotMarketOptions": {
"maxPrice": "string"
},
"subnets": [
{
"az": "string",
"id": "string"
}
]
},
"poolConfig": {
"additionalTags": "object",
"isControlPlane": "boolean",
"labels": [
"string"
],
"maxSize": "integer",
"minSize": "integer",
"name": "string",
"size": "integer",
"updateStrategy": {
"type": "string"
},
"useControlPlaneAsWorker": "boolean"
},
"profileConfig": {
"infraProfileUid": "string",
"packValues": [
{
"manifests": [
{
"content": "string",
"name": "string",
"uid": "string"
}
],
"name": "string",
"tag": "string",
"type": "string",
"values": "string"
}
]
}
}
],
"policies": {
"backupPolicy": {
"backupLocationUid": "string",
"backupName": "string",
"backupPrefix": "string",
"durationInHours": "number",
"includeAllDisks": "boolean",
"includeClusterResources": "boolean",
"locationType": "string",
"namespaces": [
"string"
],
"schedule": {
"scheduledRunTime": "string"
}
},
"scanPolicy": {
"kubeBench": {
"schedule": {
"scheduledRunTime": "string"
}
},
"kubeHunter": {
"schedule": {
"scheduledRunTime": "string"
}
},
"sonobuoy": {
"schedule": {
"scheduledRunTime": "string"
}
}
}
},
"profiles": [
{
"packValues": [
{
"manifests": [
{
"content": "string",
"name": "string",
"uid": "string"
}
],
"name": "string",
"tag": "string",
"type": "string",
"values": "string"
}
],
"uid": "string"
}
]
}
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/spectroclusters/aws/import

summary:
Import a AWS cluster
{
"metadata": {
"annotations": "object",
"labels": "object",
"name": "string"
},
"spec": {
"clusterConfig": {
"proxy": {
"httpProxy": "string",
"httpsProxy": "string",
"noProxy": "string"
}
}
}
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/spectroclusters/aws/rate

summary:
Get aws spectro cluster estimated rate information
Parameters:
NameTypeDescriptionRequired
periodTypestringno
{
"cloudConfig": {
"bastionDisabled": "boolean",
"controlPlaneLoadBalancer": "string",
"region": "string",
"sshKeyName": "string",
"vpcId": "string"
},
"machinepoolconfig": [
{
"cloudConfig": {
"azs": [
"string"
],
"capacityType": "string",
"instanceType": "string",
"rootDeviceSize": "integer",
"spotMarketOptions": {
"maxPrice": "string"
},
"subnets": [
{
"az": "string",
"id": "string"
}
]
},
"poolConfig": {
"additionalTags": "object",
"isControlPlane": "boolean",
"labels": [
"string"
],
"maxSize": "integer",
"minSize": "integer",
"name": "string",
"size": "integer",
"updateStrategy": {
"type": "string"
},
"useControlPlaneAsWorker": "boolean"