→
https://api.spectrocloud.com/v1alpha1/spectroclusters
summary:
Retrieves a list of clustersParameters:
| Name | Type | Description | Required |
|---|---|---|---|
| fields | string | Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name | no |
| filters | string | Filters 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 |
| orderBy | string | Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1 | no |
| limit | integer | limit 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 |
| continue | string | continue token for the dataset | no |
200
An array of cluster items
An array of cluster items
{"items": [{"apiVersion": "string","kind": "string","spec": {"cloudType": "string","clusterConfig": {"controlPlaneHealthCheckTimeout": "string","machineHealthConfig": {"healthCheckMaxUnhealthy": "string","networkReadyHealthCheckDuration": "string","nodeReadyHealthCheckDuration": "string"},"machineManagementConfig": {"osPatchConfig": {"onDemandPatchAfter": "date-time","patchOnBoot": "boolean","schedule": "string"}}},"clusterProfileTemplate":deprecated {"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","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","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","regex": "string","required": "boolean","type": "string"}],"server": "string","tag": "string","type": "string","values": "string","version": "string"}],"type": "string","uid": "string","version": "integer"}]},"status": {"apiEndpoints": [{"host": "string","port": "integer"}],"clusterImport": {"importLink": "string","isBrownfield": "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/v1alpha1/spectroclusters/acquire
summary:
Acquires a cluster with a lockdescription:
To orchestrate the cluster for the K8 deployment, a lock will be applied on the cluster for 5 minutes, so that the same cluster can't be acquired for orchestration
Parameters:
| Name | Type | Description | Required |
|---|---|---|---|
| filters | string | Filters 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 |
200
OK
OK
{"items": [{"apiVersion": "string","kind": "string","spec": {"cloudType": "string","clusterConfig": {"controlPlaneHealthCheckTimeout": "string","machineHealthConfig": {"healthCheckMaxUnhealthy": "string","networkReadyHealthCheckDuration": "string","nodeReadyHealthCheckDuration": "string"},"machineManagementConfig": {"osPatchConfig": {"onDemandPatchAfter": "date-time","patchOnBoot": "boolean","schedule": "string"}}},"clusterProfileTemplate":deprecated {"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","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","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","regex": "string","required": "boolean","type": "string"}],"server": "string","tag": "string","type": "string","values": "string","version": "string"}],"type": "string","uid": "string","version": "integer"}]},"status": {"apiEndpoints": [{"host": "string","port": "integer"}],"clusterImport": {"importLink": "string","isBrownfield": "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/v1alpha1/spectroclusters/acquire/create
summary:
Returns the spectro cluster for creation with lockParameters:
| Name | Type | Description | Required |
|---|---|---|---|
| overlordUid | string | no | |
| overlordMode | string | no | |
| jetUid | string | no |
200
OK
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": {"controlPlaneHealthCheckTimeout": "string","machineHealthConfig": {"healthCheckMaxUnhealthy": "string","networkReadyHealthCheckDuration": "string","nodeReadyHealthCheckDuration": "string"},"machineManagementConfig": {"osPatchConfig": {"onDemandPatchAfter": "date-time","patchOnBoot": "boolean","schedule": "string"}}},"clusterProfileRef": {"apiVersion": "string","fieldPath": "string","kind": "string","name": "string","namespace": "string","resourceVersion": "string","uid": "string"},"clusterProfileTemplate": {"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","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","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","regex": "string","required": "boolean","type": "string"}],"server": "string","tag": "string","type": "string","values": "string","version": "string"}],"type": "string","uid": "string","version": "integer"}]},"status": {"apiEndpoints": [{"host": "string","port": "integer"}],"clusterImport": {"importLink": "string","isBrownfield": "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/v1alpha1/spectroclusters/acquire/delete
summary:
Returns the spectro cluster for deletion with lockParameters:
| Name | Type | Description | Required |
|---|---|---|---|
| overlordUid | string | no | |
| overlordMode | string | no | |
| jetUid | string | no |
200
OK
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": {"controlPlaneHealthCheckTimeout": "string","machineHealthConfig": {"healthCheckMaxUnhealthy": "string","networkReadyHealthCheckDuration": "string","nodeReadyHealthCheckDuration": "string"},"machineManagementConfig": {"osPatchConfig": {"onDemandPatchAfter": "date-time","patchOnBoot": "boolean","schedule": "string"}}},"clusterProfileRef": {"apiVersion": "string","fieldPath": "string","kind": "string","name": "string","namespace": "string","resourceVersion": "string","uid": "string"},"clusterProfileTemplate": {"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","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","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","regex": "string","required": "boolean","type": "string"}],"server": "string","tag": "string","type": "string","values": "string","version": "string"}],"type": "string","uid": "string","version": "integer"}]},"status": {"apiEndpoints": [{"host": "string","port": "integer"}],"clusterImport": {"importLink": "string","isBrownfield": "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/v1alpha1/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": {"bastionEnabled": "boolean","controlPlaneLoadBalancer": "string","region": "string","sshKeyName": "string","vpcId": "string"},"clusterConfig": {"controlPlaneHealthCheckTimeout": "string","machineHealthConfig": {"healthCheckMaxUnhealthy": "string","networkReadyHealthCheckDuration": "string","nodeReadyHealthCheckDuration": "string"},"machineManagementConfig": {"osPatchConfig": {"onDemandPatchAfter": "date-time","patchOnBoot": "boolean","schedule": "string"}}},"machinepoolconfig": [{"cloudConfig": {"azs": ["string"],"instanceType": "string","rootDeviceSize": "integer","spotMarketOptions": {"maxPrice": "string"},"subnets": [{"az": "string","id": "string"}]},"poolConfig": {"isControlPlane": "boolean","labels": ["string"],"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"}]}}],"packValues": [{"manifests": [{"content": "string","name": "string","uid": "string"}],"name": "string","tag": "string","type": "string","values": "string"}],"profileUid": "string","profiles": [{"packValues": [{"manifests": [{"content": "string","name": "string","uid": "string"}],"name": "string","tag": "string","type": "string","values": "string"}],"uid": "string"}]}}
201
Created successfully
Created successfully
{"uid": "string"}
→
https://api.spectrocloud.com/v1alpha1/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
Created successfully
{"uid": "string"}
→
https://api.spectrocloud.com/v1alpha1/spectroclusters/aws/validate
summary:
Validate aws 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": {"bastionEnabled": "boolean","controlPlaneLoadBalancer": "string","region": "string","sshKeyName": "string","vpcId": "string"},"clusterConfig": {"controlPlaneHealthCheckTimeout": "string","machineHealthConfig": {"healthCheckMaxUnhealthy": "string","networkReadyHealthCheckDuration": "string","nodeReadyHealthCheckDuration": "string"},"machineManagementConfig": {"osPatchConfig": {"onDemandPatchAfter": "date-time","patchOnBoot": "boolean","schedule": "string"}}},"machinepoolconfig": [{"cloudConfig": {"azs": ["string"],"instanceType": "string","rootDeviceSize": "integer","spotMarketOptions": {"maxPrice": "string"},"subnets": [{"az": "string","id": "string"}]},"poolConfig": {"isControlPlane": "boolean","labels": ["string"],"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"}]}}],"packValues": [{"manifests": [{"content": "string","name": "string","uid": "string"}],"name": "string","tag": "string","type": "string","values": "string"}],"profileUid": "string","profiles": [{"packValues": [{"manifests": [{"content": "string","name": "string","uid": "string"}],"name": "string","tag": "string","type": "string","values": "string"}],"uid": "string"}]}}
200
Aws Cluster validation response
Aws Cluster validation response
{"machinePools": {"results": [{"displayName": "string","errors": [{"code": "string","message": "string"}],"name": "string"}]},"packs": {"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/v1alpha1/spectroclusters/aws/{uid}
summary:
Updates the specified AWS ClusterPath parameters:
| Name | Type | Description | Required |
|---|---|---|---|
| uid | string | yes |
{"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": {"bastionEnabled": "boolean","controlPlaneLoadBalancer": "string","region": "string","sshKeyName": "string","vpcId": "string"},"clusterConfig": {"controlPlaneHealthCheckTimeout": "string","machineHealthConfig": {"healthCheckMaxUnhealthy": "string","networkReadyHealthCheckDuration": "string","nodeReadyHealthCheckDuration": "string"},"machineManagementConfig": {"osPatchConfig": {"onDemandPatchAfter": "date-time","patchOnBoot": "boolean","schedule": "string"}}},"machinepoolconfig": [{"cloudConfig": {"azs": ["string"],"instanceType": "string","rootDeviceSize": "integer","spotMarketOptions": {"maxPrice": "string"},"subnets": [{"az": "string","id": "string"}]},"poolConfig": {"isControlPlane": "boolean","labels": ["string"],"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"}]}}],"packValues": [{"manifests": [{"content": "string","name": "string","uid": "string"}],"name": "string","tag": "string","type": "string","values": "string"}],"profileUid": "string","profiles": [{"packValues": [{"manifests": [{"content": "string","name": "string","uid": "string"}],"name": "string","tag": "string","type": "string","values": "string"}],"uid": "string"}]}}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1alpha1/spectroclusters/aws/{uid}/validate
summary:
Validate aws spectro cluster updateParameters:
| Name | Type | Description | Required |
|---|---|---|---|
| uid | string | yes |
{"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": {"bastionEnabled": "boolean","controlPlaneLoadBalancer": "string","region": "string","sshKeyName": "string","vpcId": "string"},"clusterConfig": {"controlPlaneHealthCheckTimeout": "string","machineHealthConfig": {"healthCheckMaxUnhealthy": "string","networkReadyHealthCheckDuration": "string","nodeReadyHealthCheckDuration": "string"},"machineManagementConfig": {"osPatchConfig": {"onDemandPatchAfter": "date-time","patchOnBoot": "boolean","schedule": "string"}}},"machinepoolconfig": [{"cloudConfig": {"azs": ["string"],"instanceType": "string","rootDeviceSize": "integer","spotMarketOptions": {"maxPrice": "string"},"subnets": [{"az": "string","id": "string"}]},