Clusters

→

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

summary:

Retrieves a list of clusters

Parameters:

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. 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

HTTP code: 200
Description: An array of cluster items
Response body:

{
  "items": [
    {
      "apiVersion": "string",
      "kind": "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": {
        "cloudConfigRef": {
          "apiVersion": "string",
          "fieldPath": "string",
          "kind": "string",
          "name": "string",
          "namespace": "string",
          "resourceVersion": "string",
          "uid": "string"
        },
        "cloudType": "string",
        "clusterConfig": {
          "clusterRbac":deprecated [
            {
              "kind": "string",
              "name": "string",
              "uid": "string"
            }
          ],
          "clusterResources": {
            "namespaces": [
              {
                "kind": "string",
                "name": "string",
                "uid": "string"
              }
            ],
            "rbacs": [
              {
                "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": {
        "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"
          }
        ],
        "services": [
          {
            "host": "string",
            "name": "string",
            "ports": [
              {
                "port": "integer",
                "protocol": "string"
              }
            ]
          }
        ],
        "state": "string",
        "upgrades": [
          {
            "reason": [
              "string"
            ],
            "timestamp": "date-time"
          }
        ]
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": "integer",
    "limit": "integer",
    "offset": "integer"
  }
}

→

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

summary:

Returns the spectro cluster for creation with lock

Parameters:

Name	Type	Required
overlordUid	string	no
edgeHostUid	string	no
overlordMode	string	no
jetUid	string	no
authKey	string	no

HTTP code: 200
Description: OK
Response body:

{
  "apiVersion": "string",
  "kind": "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": {
    "cloudConfigRef": {
      "apiVersion": "string",
      "fieldPath": "string",
      "kind": "string",
      "name": "string",
      "namespace": "string",
      "resourceVersion": "string",
      "uid": "string"
    },
    "cloudType": "string",
    "clusterConfig": {
      "clusterRbac":deprecated [
        {
          "kind": "string",
          "name": "string",
          "uid": "string"
        }
      ],
      "clusterResources": {
        "namespaces": [
          {
            "kind": "string",
            "name": "string",
            "uid": "string"
          }
        ],
        "rbacs": [
          {
            "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": {
    "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"
      }
    ],
    "services": [
      {
        "host": "string",
        "name": "string",
        "ports": [
          {
            "port": "integer",
            "protocol": "string"
          }
        ]
      }
    ],
    "state": "string",
    "upgrades": [
      {
        "reason": [
          "string"
        ],
        "timestamp": "date-time"
      }
    ]
  }
}

→

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

summary:

Returns the spectro cluster for deletion with lock

Parameters:

Name	Type	Required
overlordUid	string	no
edgeHostUid	string	no
overlordMode	string	no
jetUid	string	no
authKey	string	no

HTTP code: 200
Description: OK
Response body:

{
  "apiVersion": "string",
  "kind": "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": {
    "cloudConfigRef": {
      "apiVersion": "string",
      "fieldPath": "string",
      "kind": "string",
      "name": "string",
      "namespace": "string",
      "resourceVersion": "string",
      "uid": "string"
    },
    "cloudType": "string",
    "clusterConfig": {
      "clusterRbac":deprecated [
        {
          "kind": "string",
          "name": "string",
          "uid": "string"
        }
      ],
      "clusterResources": {
        "namespaces": [
          {
            "kind": "string",
            "name": "string",
            "uid": "string"
          }
        ],
        "rbacs": [
          {
            "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": {
    "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"
      }
    ],
    "services": [
      {
        "host": "string",
        "name": "string",
        "ports": [
          {
            "port": "integer",
            "protocol": "string"
          }
        ]
      }
    ],
    "state": "string",
    "upgrades": [
      {
        "reason": [
          "string"
        ],
        "timestamp": "date-time"
      }
    ]
  }
}

→

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

summary:

Creates an AKS cluster

Body

{
  "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": {
    "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": {
      "machineManagementConfig": {
        "osPatchConfig": {
          "onDemandPatchAfter": "date-time",
          "patchOnBoot": "boolean",
          "schedule": "string"
        }
      },
      "resources": {
        "namespaces": [
          {
            "metadata": {
              "annotations": "object",
              "labels": "object",
              "name": "string",
              "uid": "string"
            },
            "spec": {
              "relatedObject": {
                "kind": "string",
                "name": "string",
                "uid": "string"
              },
              "resourceAllocation": {
                "cpuCores": "number",
                "memoryMiB": "number"
              }
            }
          }
        ],
        "rbacs": [
          {
            "metadata": {
              "annotations": "object",
              "labels": "object",
              "name": "string",
              "uid": "string"
            },
            "spec": {
              "bindings": [
                {
                  "namespace": "string",
                  "role": {
                    "kind": "string",
                    "name": "string"
                  },
                  "subjects": [
                    {
                      "name": "string",
                      "namespace": "string",
                      "type": "string"
                    }
                  ],
                  "type": "string"
                }
              ],
              "relatedObject": {
                "kind": "string",
                "name": "string",
                "uid": "string"
              }
            }
          }
        ]
      },
      "updateWorkerPoolsInParallel": "boolean"
    },
    "machinepoolconfig": [
      {
        "cloudConfig": {
          "azs": [
            "string"
          ],
          "instanceType": "string",
          "isSystemNodePool": "boolean",
          "osDisk": {
            "diskSizeGB": "integer",
            "managedDisk": {
              "storageAccountType": "string"
            },
            "osType": "string"
          }
        },
        "managedPoolConfig": {
          "isSystemNodePool": "boolean"
        },
        "poolConfig": {
          "additionalLabels": "object",
          "additionalTags": "object",
          "isControlPlane": "boolean",
          "labels": [
            "string"
          ],
          "maxSize": "integer",
          "minSize": "integer",
          "name": "string",
          "size": "integer",
          "taints": [
            {
              "effect": "string",
              "key": "string",
              "timeAdded": "date-time",
              "value": "string"
            }
          ],
          "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"
      }
    ]
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

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

summary:

Get aks spectro cluster estimated rate information

Parameters:

Name	Type	Description	Required
periodType	string		no

Body

{
  "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": {
        "additionalLabels": "object",
        "additionalTags": "object",
        "isControlPlane": "boolean",
        "labels": [
          "string"
        ],
        "maxSize": "integer",
        "minSize": "integer",
        "name": "string",
        "size": "integer",
        "taints": [
          {
            "effect": "string",
            "key": "string",
            "timeAdded": "date-time",
            "value": "string"
          }
        ],
        "updateStrategy": {
          "type": "string"
        },
        "useControlPlaneAsWorker": "boolean"
      },
      "profileConfig": {
        "infraProfileUid": "string",
        "packValues": [
          {
            "manifests": [
              {
                "content": "string",
                "name": "string",
                "uid": "string"
              }
            ],
            "name": "string",
            "tag": "string",
            "type": "string",
            "values": "string"
          }
        ]
      }
    }
  ]
}

HTTP code: 200
Description: Aks Cluster estimated rate response
Response body:

{
  "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

Body

{
  "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": {
    "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": {
      "machineManagementConfig": {
        "osPatchConfig": {
          "onDemandPatchAfter": "date-time",
          "patchOnBoot": "boolean",
          "schedule": "string"
        }
      },
      "resources": {
        "namespaces": [
          {
            "metadata": {
              "annotations": "object",
              "labels": "object",
              "name": "string",
              "uid": "string"
            },
            "spec": {
              "relatedObject": {
                "kind": "string",
                "name": "string",
                "uid": "string"
              },
              "resourceAllocation": {
                "cpuCores": "number",
                "memoryMiB": "number"
              }
            }
          }
        ],
        "rbacs": [
          {
            "metadata": {
              "annotations": "object",
              "labels": "object",
              "name": "string",
              "uid": "string"
            },
            "spec": {
              "bindings": [
                {
                  "namespace": "string",
                  "role": {
                    "kind": "string",
                    "name": "string"
                  },
                  "subjects": [
                    {
                      "name": "string",
                      "namespace": "string",
                      "type": "string"
                    }
                  ],
                  "type": "string"
                }
              ],
              "relatedObject": {
                "kind": "string",
                "name": "string",
                "uid": "string"
              }
            }
          }
        ]
      },
      "updateWorkerPoolsInParallel": "boolean"
    },
    "machinepoolconfig": [
      {
        "cloudConfig": {
          "azs": [
            "string"
          ],
          "instanceType": "string",
          "isSystemNodePool": "boolean",
          "osDisk": {
            "diskSizeGB": "integer",
            "managedDisk": {
              "storageAccountType": "string"
            },
            "osType": "string"
          }
        },
        "managedPoolConfig": {
          "isSystemNodePool": "boolean"
        },
        "poolConfig": {
          "additionalLabels": "object",
          "additionalTags": "object",
          "isControlPlane": "boolean",
          "labels": [
            "string"
          ],
          "maxSize": "integer",
          "minSize": "integer",
          "name": "string",
          "size": "integer",
          "taints": [
            {
              "effect": "string",
              "key": "string",
              "timeAdded": "date-time",
              "value": "string"
            }
          ],
          "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"
      }
    ]
  }
}

HTTP code: 200
Description: Aks Cluster validation response
Response body:

{
  "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

Body

{
  "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": {
    "cloudAccountUid": "string",
    "cloudConfig": {
      "bastionDisabled": "boolean",
      "controlPlaneLoadBalancer": "string",
      "region": "string",
      "sshKeyName": "string",
      "vpcId": "string"
    },
    "clusterConfig": {
      "machineManagementConfig": {
        "osPatchConfig": {
          "onDemandPatchAfter": "date-time",
          "patchOnBoot": "boolean",
          "schedule": "string"
        }
      },
      "resources": {
        "namespaces": [
          {
            "metadata": {
              "annotations": "object",
              "labels": "object",
              "name": "string",
              "uid": "string"
            },
            "spec": {
              "relatedObject": {
                "kind": "string",
                "name": "string",
                "uid": "string"
              },
              "resourceAllocation": {
                "cpuCores": "number",
                "memoryMiB": "number"
              }
            }
          }
        ],
        "rbacs": [
          {
            "metadata": {
              "annotations": "object",
              "labels": "object",
              "name": "string",
              "uid": "string"
            },
            "spec": {
              "bindings": [
                {
                  "namespace": "string",
                  "role": {
                    "kind": "string",
                    "name": "string"
                  },
                  "subjects": [
                    {
                      "name": "string",
                      "namespace": "string",
                      "type": "string"
                    }
                  ],
                  "type": "string"
                }
              ],
              "relatedObject": {
                "kind": "string",
                "name": "string",
                "uid": "string"
              }
            }
          }
        ]
      },
      "updateWorkerPoolsInParallel": "boolean"
    },
    "machinepoolconfig": [
      {
        "cloudConfig": {
          "azs": [
            "string"
          ],
          "capacityType": "string",
          "instanceType": "string",
          "rootDeviceSize": "integer",
          "spotMarketOptions": {
            "maxPrice": "string"
          },
          "subnets": [
            {
              "az": "string",
              "id": "string"
            }
          ]
        },
        "poolConfig": {
          "additionalLabels": "object",
          "additionalTags": "object",
          "isControlPlane": "boolean",
          "labels": [
            "string"
          ],
          "maxSize": "integer",
          "minSize": "integer",
          "name": "string",
          "size": "integer",
          "taints": [
            {
              "effect": "string",
              "key": "string",
              "timeAdded": "date-time",
              "value": "string"
            }
          ],
          "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"
      }
    ]
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

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

summary:

Import a AWS cluster

Body

{
  "metadata": {
    "annotations": "object",
    "labels": "object",
    "name": "string"
  },
  "spec": {
    "clusterConfig": {
      "proxy": {
        "httpProxy": "string",
        "httpsProxy": "string",
        "noProxy": "string"
      }
    }
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

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

summary:

Get aws spectro cluster estimated rate information

Parameters:

Name	Type	Description	Required
periodType	string		no

Body

{
  "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": {
        "additionalLabels": "object",
        "additionalTags": "object",
        "isControlPlane": "boolean",
        "labels": [
          "string"
        ],
        "maxSize": "integer",
        "minSize": "integer",
        "name": "string",
        "size": "integer",
        "taints": [
          {
            "effect": "string",
            "key": "string",
            "timeAdded": "date-time",
            "value": "string"
          }
        ],
        "updateStrategy": {
          "type": "string"
        },
        "useControlPlaneAsWorker": "boolean"
      },
      "profileConfig": {
        "infraProfileUid": "string",
        "packValues": [
          {
            "manifests": [
              {
                "content": "string",
                "name": "string",
                "uid": "string"
              }
            ],
            "name": "string",
            "tag": "string",
            "type": "string",
            "values": "string"
          }
        ]
      }
    }
  ]
}

HTTP code: 200
Description: Aws Cluster estimated rate response
Response body:

{
  "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/aws/validate

summary:

Validate aws spectro cluster create

Body

{
  "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": {
    "cloudAccountUid": "string",
    "cloudConfig": {
      "bastionDisabled": "boolean",
      "controlPlaneLoadBalancer": "string",
      "region": "string",
      "sshKeyName": "string",
      "vpcId": "string"
    },
    "clusterConfig": {
      "machineManagementConfig": {
        "osPatchConfig": {
          "onDemandPatchAfter": "date-time",
          "patchOnBoot": "boolean",
          "schedule": "string"
        }
      },
      "resources": {
        "namespaces": [
          {
            "metadata": {
              "annotations": "object",
              "labels": "object",
              "name": "string",
              "uid": "string"
            },
            "spec": {
              "relatedObject": {
                "kind": "string",
                "name": "string",
                "uid": "string"
              },
              "resourceAllocation": {
                "cpuCores": "number",
                "memoryMiB": "number"
              }
            }
          }
        ],
        "rbacs": [
          {
            "metadata": {
              "annotations": "object",
              "labels": "object",
              "name": "string",
              "uid": "string"
            },
            "spec": {
              "bindings": [
                {
                  "namespace": "string",
                  "role": {
                    "kind": "string",
                    "name": "string"
                  },
                  "subjects": [
                    {
                      "name": "string",
                      "namespace": "string",
                      "type": "string"
                    }
                  ],
                  "type": "string"
                }
              ],
              "relatedObject": {
                "kind": "string",
                "name": "string",
                "uid": "string"
              }
            }
          }
        ]
      },
      "updateWorkerPoolsInParallel": "boolean"
    },
    "machinepoolconfig": [
      {
        "cloudConfig": {
          "azs": [
            "string"
          ],
          "capacityType": "string",
          "instanceType": "string",
          "rootDeviceSize": "integer",
          "spotMarketOptions": {
            "maxPrice": "string"
          },
          "subnets": [
            {
              "az": "string",
              "id": "string"
            }
          ]
        },
        "poolConfig": {
          "additionalLabels": "object",
          "additionalTags": "object",
          "isControlPlane": "boolean",
          "labels": [
            "string"
          ],
          "maxSize": "integer",
          "minSize": "integer",
          "name": "string",
          "size": "integer",
          "taints": [
            {
              "effect": "string",
              "key": "string",
              "timeAdded": "date-time",
              "value": "string"
            }
          ],
          "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"
      }
    ]
  }
}

HTTP code: 200
Description: Aws Cluster validation response
Response body:

{
  "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/azure

summary:

Creates an Azure cluster

Body

{
  "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": {
    "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": {
      "machineManagementConfig": {
        "osPatchConfig": {
          "onDemandPatchAfter": "date-time",
          "patchOnBoot": "boolean",
          "schedule": "string"
        }
      },
      "resources": {
        "namespaces": [
          {
            "metadata": {
              "annotations": "object",
              "labels": "object",
              "name": "string",
              "uid": "string"
            },
            "spec": {
              "relatedObject": {
                "kind": "string",
                "name": "string",
                "uid": "string"
              },
              "resourceAllocation": {
                "cpuCores": "number",
                "memoryMiB": "number"
              }
            }
          }
        ],
        "rbacs": [
          {
            "metadata": {
              "annotations": "object",
              "labels": "object",
              "name": "string",
              "uid": "string"
            },
            "spec": {
              "bindings": [
                {
                  "namespace": "string",
                  "role": {
                    "kind": "string",
                    "name": "string"
                  },
                  "subjects": [
                    {
                      "name": "string",
                      "namespace": "string",
                      "type": "string"
                    }
                  ],
                  "type": "string"
                }
              ],
              "relatedObject": {
                "kind": "string",
                "name": "string",
                "uid": "string"
              }
            }
          }
        ]
      },
      "updateWorkerPoolsInParallel": "boolean"
    },
    "machinepoolconfig": [
      {
        "cloudConfig": {
          "azs": [
            "string"
          ],
          "instanceType": "string",
          "isSystemNodePool": "boolean",
          "osDisk": {
            "diskSizeGB": "integer",
            "managedDisk": {
              "storageAccountType": "string"
            },
            "osType": "string"
          }
        },
        "managedPoolConfig": {
          "isSystemNodePool": "boolean"
        },
        "poolConfig": {
          "additionalLabels": "object",
          "additionalTags": "object",
          "isControlPlane": "boolean",
          "labels": [
            "string"
          ],
          "maxSize": "integer",
          "minSize": "integer",
          "name": "string",
          "size": "integer",
          "taints": [
            {
              "effect": "string",
              "key": "string",
              "timeAdded": "date-time",
              "value": "string"
            }
          ],
          "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"
      }
    ]
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

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

summary:

Import a Azure cluster

Body

{
  "metadata": {
    "annotations": "object",
    "labels": "object",
    "name": "string"
  },
  "spec": {
    "clusterConfig": {
      "proxy": {
        "httpProxy": "string",
        "httpsProxy": "string",
        "noProxy": "string"
      }
    }
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

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

summary:

Get azure spectro cluster estimated rate information

Parameters:

Name	Type	Description	Required
periodType	string		no

Body

{
  "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": {
        "additionalLabels": "object",
        "additionalTags": "object",
        "isControlPlane": "boolean",
        "labels": [
          "string"
        ],
        "maxSize": "integer",
        "minSize": "integer",
        "name": "string",
        "size": "integer",
        "taints": [
          {
            "effect": "string",
            "key": "string",
            "timeAdded": "date-time",
            "value": "string"
          }
        ],
        "updateStrategy": {
          "type": "string"
        },
        "useControlPlaneAsWorker": "boolean"
      },
      "profileConfig": {
        "infraProfileUid": "string",
        "packValues": [
          {
            "manifests": [
              {
                "content": "string",
                "name": "string",
                "uid": "string"
              }
            ],
            "name": "string",
            "tag": "string",
            "type": "string",
            "values": "string"
          }
        ]
      }
    }
  ]
}

HTTP code: 200
Description: Azure Cluster estimated rate response
Response body:

{
  "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/azure/validate

summary:

Validate azure spectro cluster create

Body

{
  "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": {
    "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": {
      "machineManagementConfig": {
        "osPatchConfig": {
          "onDemandPatchAfter": "date-time",
          "patchOnBoot": "boolean",
          "schedule": "string"
        }
      },
      "resources": {
        "namespaces": [
          {
            "metadata": {
              "annotations": "object",
              "labels": "object",
              "name": "string",
              "uid": "string"
            },
            "spec": {
              "relatedObject": {
                "kind": "string",
                "name": "string",
                "uid": "string"
              },
              "resourceAllocation": {
                "cpuCores": "number",
                "memoryMiB": "number"
              }
            }
          }
        ],
        "rbacs": [
          {
            "metadata": {
              "annotations": "object",
              "labels": "object",
              "name": "string",
              "uid": "string"
            },
            "spec": {
              "bindings": [
                {
                  "namespace": "string",
                  "role": {
                    "kind": "string",
                    "name": "string"
                  },
                  "subjects": [
                    {
                      "name": "string",
                      "namespace": "string",
                      "type": "string"
                    }
                  ],
                  "type": "string"
                }
              ],
              "relatedObject": {
                "kind": "string",
                "name": "string",
                "uid": "string"
              }
            }
          }
        ]
      },
      "updateWorkerPoolsInParallel": "boolean"
    },
    "machinepoolconfig": [
      {
        "cloudConfig": {
          "azs": [
            "string"
          ],
          "instanceType": "string",
          "isSystemNodePool": "boolean",
          "osDisk": {
            "diskSizeGB": "integer",
            "managedDisk": {
              "storageAccountType": "string"
            },
            "osType": "string"
          }
        },
        "managedPoolConfig": {
          "isSystemNodePool": "boolean"
        },
        "poolConfig": {
          "additionalLabels": "object",
          "additionalTags": "object",
          "isControlPlane": "boolean",
          "labels": [
            "string"
          ],
          "maxSize": "integer",
          "minSize": "integer",
          "name": "string",
          "size": "integer",
          "taints": [
            {
              "effect": "string",
              "key": "string",
              "timeAdded": "date-time",
              "value": "string"
            }
          ],
          "updateStrategy": {</