Cloud Config

→

https://api.spectrocloud.com/v1/cloudconfigs/aks/{configUid}

summary:

Returns the specified AKS cloud config

Path parameters:

Name	Type	Description	Required
configUid	string		yes

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": {
    "cloudAccountRef": {
      "apiVersion": "string",
      "fieldPath": "string",
      "kind": "string",
      "name": "string",
      "namespace": "string",
      "resourceVersion": "string",
      "uid": "string"
    },
    "clusterConfig": {
      "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": [
      {
        "additionalLabels": "object",
        "additionalTags": "object",
        "azs": [
          "string"
        ],
        "infraProfileRef": {
          "apiVersion": "string",
          "fieldPath": "string",
          "kind": "string",
          "name": "string",
          "namespace": "string",
          "resourceVersion": "string",
          "uid": "string"
        },
        "infraProfileTemplate": {
          "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"
        },
        "instanceType": "string",
        "isControlPlane": "boolean",
        "isSystemNodePool": "boolean",
        "labels": [
          "string"
        ],
        "maxSize": "integer",
        "minSize": "integer",
        "name": "string",
        "osDisk": {
          "diskSizeGB": "integer",
          "managedDisk": {
            "storageAccountType": "string"
          },
          "osType": "string"
        },
        "size": "integer",
        "spotVMOptions": {
          "maxPrice": "string"
        },
        "taints": [
          {
            "effect": "string",
            "key": "string",
            "timeAdded": "date-time",
            "value": "string"
          }
        ],
        "updateStrategy": {
          "type": "string"
        },
        "useControlPlaneAsWorker": "boolean"
      }
    ]
  },
  "status": {
    "ansibleRoleDigest": "string",
    "conditions": [
      {
        "lastProbeTime": "date-time",
        "lastTransitionTime": "date-time",
        "message": "string",
        "reason": "string",
        "status": "string",
        "type": "string"
      }
    ],
    "images": {
      "gallery": "string",
      "name": "string",
      "resourceGroup": "string",
      "state": "string",
      "subscriptionID": "string",
      "version": "string"
    },
    "isAddonLayer": "boolean",
    "roleDigest": "object",
    "sourceImageId": "string",
    "useCapiImage": "boolean",
    "vhdImage": {
      "id": "string",
      "name": "string",
      "os": "string",
      "region": "string",
      "state": "string"
    }
  }
}

→

https://api.spectrocloud.com/v1/cloudconfigs/aks/{configUid}/clusterConfig

summary:

Updates the cluster configuration information

Path parameters:

Name	Type	Description	Required
configUid	string		yes

Body

{
  "clusterConfig": {
    "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"
    }
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/cloudconfigs/aks/{configUid}/machinePools

summary:

Creates an AKS cloud config's machine pool

Path parameters:

Name	Type	Description	Required
configUid	string		yes

Body

{
  "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: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/cloudconfigs/aks/{configUid}/machinePools/{machinePoolName}

summary:

Updates the specified AKS cloud config's machine pool

Path parameters:

Name	Type	Description	Required
configUid	string		yes
machinePoolName	string		yes

Body

{
  "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: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/cloudconfigs/aks/{configUid}/machinePools/{machinePoolName}

summary:

Deletes the specified machine pool

Path parameters:

Name	Type	Description	Required
configUid	string		yes
machinePoolName	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/cloudconfigs/aks/{configUid}/machinePools/{machinePoolName}/machines

summary:

Retrieves a list of AKS machines

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

Path parameters:

Name	Type	Description	Required
configUid	string		yes
machinePoolName	string		yes

HTTP code: 200
Description: An array of AKS machine 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": {
        "additionalTags": "object",
        "allocatePublicIP": "boolean",
        "availabilityZone": {
          "enabled": "boolean",
          "id": "string"
        },
        "image": {
          "gallery": "string",
          "id": "string",
          "name": "string",
          "offer": "string",
          "publisher": "string",
          "resourceGroup": "string",
          "sku": "string",
          "subscriptionId": "string",
          "version": "string"
        },
        "instanceType": "string",
        "location": "string",
        "nics": [
          {
            "index": "integer",
            "privateIPs": [
              "string"
            ],
            "publicIp": "string"
          }
        ],
        "osDisk": {
          "diskSizeGB": "integer",
          "managedDisk": {
            "storageAccountType": "string"
          },
          "osType": "string"
        },
        "sshPublicKey": "string"
      },
      "status": {
        "health": {
          "conditions": [
            {
              "message": "string",
              "reason": "string",
              "status": "string",
              "type": "string"
            }
          ],
          "state": "string"
        },
        "instanceState": "string"
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": "integer",
    "limit": "integer",
    "offset": "integer"
  }
}

→

https://api.spectrocloud.com/v1/cloudconfigs/aks/{configUid}/machinePools/{machinePoolName}/machines

summary:

Adds the machine to cloud config's machine pool

Path parameters:

Name	Type	Description	Required
configUid	string		yes
machinePoolName	string		yes

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": {
    "additionalTags": "object",
    "allocatePublicIP": "boolean",
    "availabilityZone": {
      "enabled": "boolean",
      "id": "string"
    },
    "image": {
      "gallery": "string",
      "id": "string",
      "name": "string",
      "offer": "string",
      "publisher": "string",
      "resourceGroup": "string",
      "sku": "string",
      "subscriptionId": "string",
      "version": "string"
    },
    "instanceType": "string",
    "location": "string",
    "nics": [
      {
        "index": "integer",
        "privateIPs": [
          "string"
        ],
        "publicIp": "string"
      }
    ],
    "osDisk": {
      "diskSizeGB": "integer",
      "managedDisk": {
        "storageAccountType": "string"
      },
      "osType": "string"
    },
    "sshPublicKey": "string"
  },
  "status": {
    "health": {
      "conditions": [
        {
          "message": "string",
          "reason": "string",
          "status": "string",
          "type": "string"
        }
      ],
      "state": "string"
    },
    "instanceState": "string"
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/cloudconfigs/aks/{configUid}/machinePools/{machinePoolName}/machines/{machineUid}

summary:

Returns the specified AKS machine

Path parameters:

Name	Type	Required
configUid	string	yes
machinePoolName	string	yes
machineUid	string	yes

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": {
    "additionalTags": "object",
    "allocatePublicIP": "boolean",
    "availabilityZone": {
      "enabled": "boolean",
      "id": "string"
    },
    "image": {
      "gallery": "string",
      "id": "string",
      "name": "string",
      "offer": "string",
      "publisher": "string",
      "resourceGroup": "string",
      "sku": "string",
      "subscriptionId": "string",
      "version": "string"
    },
    "instanceType": "string",
    "location": "string",
    "nics": [
      {
        "index": "integer",
        "privateIPs": [
          "string"
        ],
        "publicIp": "string"
      }
    ],
    "osDisk": {
      "diskSizeGB": "integer",
      "managedDisk": {
        "storageAccountType": "string"
      },
      "osType": "string"
    },
    "sshPublicKey": "string"
  },
  "status": {
    "health": {
      "conditions": [
        {
          "message": "string",
          "reason": "string",
          "status": "string",
          "type": "string"
        }
      ],
      "state": "string"
    },
    "instanceState": "string"
  }
}

→

https://api.spectrocloud.com/v1/cloudconfigs/aks/{configUid}/machinePools/{machinePoolName}/machines/{machineUid}

summary:

Updates the specified machine to the cloud config's machine pool

Path parameters:

Name	Type	Required
configUid	string	yes
machinePoolName	string	yes
machineUid	string	yes

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": {
    "additionalTags": "object",
    "allocatePublicIP": "boolean",
    "availabilityZone": {
      "enabled": "boolean",
      "id": "string"
    },
    "image": {
      "gallery": "string",
      "id": "string",
      "name": "string",
      "offer": "string",
      "publisher": "string",
      "resourceGroup": "string",
      "sku": "string",
      "subscriptionId": "string",
      "version": "string"
    },
    "instanceType": "string",
    "location": "string",
    "nics": [
      {
        "index": "integer",
        "privateIPs": [
          "string"
        ],
        "publicIp": "string"
      }
    ],
    "osDisk": {
      "diskSizeGB": "integer",
      "managedDisk": {
        "storageAccountType": "string"
      },
      "osType": "string"
    },
    "sshPublicKey": "string"
  },
  "status": {
    "health": {
      "conditions": [
        {
          "message": "string",
          "reason": "string",
          "status": "string",
          "type": "string"
        }
      ],
      "state": "string"
    },
    "instanceState": "string"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/cloudconfigs/aks/{configUid}/machinePools/{machinePoolName}/machines/{machineUid}

summary:

Deletes the specified Azure machine

Path parameters:

Name	Type	Required
configUid	string	yes
machinePoolName	string	yes
machineUid	string	yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/cloudconfigs/aws/{configUid}

summary:

Returns the specified AWS cloud config

Path parameters:

Name	Type	Description	Required
configUid	string		yes

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": {
    "cloudAccountRef": {
      "apiVersion": "string",
      "fieldPath": "string",
      "kind": "string",
      "name": "string",
      "namespace": "string",
      "resourceVersion": "string",
      "uid": "string"
    },
    "clusterConfig": {
      "bastionDisabled": "boolean",
      "controlPlaneLoadBalancer": "string",
      "region": "string",
      "sshKeyName": "string",
      "vpcId": "string"
    },
    "machinePoolConfig": [
      {
        "additionalLabels": "object",
        "additionalTags": "object",
        "azs": [
          "string"
        ],
        "capacityType": "string",
        "infraProfileRef": {
          "apiVersion": "string",
          "fieldPath": "string",
          "kind": "string",
          "name": "string",
          "namespace": "string",
          "resourceVersion": "string",
          "uid": "string"
        },
        "infraProfileTemplate": {
          "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"
        },
        "instanceType": "string",
        "isControlPlane": "boolean",
        "labels": [
          "string"
        ],
        "maxSize": "integer",
        "minSize": "integer",
        "name": "string",
        "rootDeviceSize": "integer",
        "size": "integer",
        "spotMarketOptions": {
          "maxPrice": "string"
        },
        "subnetIds": "object",
        "taints": [
          {
            "effect": "string",
            "key": "string",
            "timeAdded": "date-time",
            "value": "string"
          }
        ],
        "updateStrategy": {
          "type": "string"
        },
        "useControlPlaneAsWorker": "boolean"
      }
    ]
  },
  "status": {
    "ansibleRoleDigest": "string",
    "conditions": [
      {
        "lastProbeTime": "date-time",
        "lastTransitionTime": "date-time",
        "message": "string",
        "reason": "string",
        "status": "string",
        "type": "string"
      }
    ],
    "images": [
      {
        "id": "string",
        "os": "string",
        "region": "string",
        "state": "string"
      }
    ],
    "isAddonLayer": "boolean",
    "roleDigest": "object",
    "sourceImageId": "string",
    "useCapiImage": "boolean"
  }
}

→

https://api.spectrocloud.com/v1/cloudconfigs/aws/{configUid}/clusterConfig

summary:

Updates the cluster configuration information

Path parameters:

Name	Type	Description	Required
configUid	string		yes

Body

{
  "clusterConfig": {
    "bastionDisabled": "boolean",
    "controlPlaneLoadBalancer": "string",
    "region": "string",
    "sshKeyName": "string",
    "vpcId": "string"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/cloudconfigs/aws/{configUid}/machinePools

summary:

Creates an AWS cloud config's machine pool

Path parameters:

Name	Type	Description	Required
configUid	string		yes

Body

{
  "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: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/cloudconfigs/aws/{configUid}/machinePools/{machinePoolName}

summary:

Updates the specified AWS cloud config's machine pool

Path parameters:

Name	Type	Description	Required
configUid	string		yes
machinePoolName	string		yes

Body

{
  "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: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/cloudconfigs/aws/{configUid}/machinePools/{machinePoolName}

summary:

Deletes the specified machine pool

Path parameters:

Name	Type	Description	Required
configUid	string		yes
machinePoolName	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/cloudconfigs/aws/{configUid}/machinePools/{machinePoolName}/machines

summary:

Retrieves a list of AWS machines

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

Path parameters:

Name	Type	Description	Required
configUid	string		yes
machinePoolName	string		yes

HTTP code: 200
Description: An array of AWS machine 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": {
        "ami": "string",
        "az": "string",
        "dnsName": "string",
        "iamProfile": "string",
        "instanceType": "string",
        "nics": [
          {
            "index": "integer",
            "privateIPs": [
              "string"
            ],
            "publicIp": "string"
          }
        ],
        "phase": "string",
        "sshKeyName": "string",
        "subnetId": "string",
        "type": "string",
        "vpcId": "string"
      },
      "status": {
        "health": {
          "conditions": [
            {
              "message": "string",
              "reason": "string",
              "status": "string",
              "type": "string"
            }
          ],
          "state": "string"
        },
        "instanceState": "string"
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": "integer",
    "limit": "integer",
    "offset": "integer"
  }
}

→

https://api.spectrocloud.com/v1/cloudconfigs/aws/{configUid}/machinePools/{machinePoolName}/machines

summary:

Adds the machine to cloud config's machine pool

Path parameters:

Name	Type	Description	Required
configUid	string		yes
machinePoolName	string		yes

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": {
    "ami": "string",
    "az": "string",
    "dnsName": "string",
    "iamProfile": "string",
    "instanceType": "string",
    "nics": [
      {
        "index": "integer",
        "privateIPs": [
          "string"
        ],
        "publicIp": "string"
      }
    ],
    "phase": "string",
    "sshKeyName": "string",
    "subnetId": "string",
    "type": "string",
    "vpcId": "string"
  },
  "status": {
    "health": {
      "conditions": [
        {
          "message": "string",
          "reason": "string",
          "status": "string",
          "type": "string"
        }
      ],
      "state": "string"
    },
    "instanceState": "string"
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/cloudconfigs/aws/{configUid}/machinePools/{machinePoolName}/machines/{machineUid}

summary:

Returns the specified AWS machine

Path parameters:

Name	Type	Required
configUid	string	yes
machinePoolName	string	yes
machineUid	string	yes

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": {
    "ami": "string",
    "az": "string",
    "dnsName": "string",
    "iamProfile": "string",
    "instanceType": "string",
    "nics": [
      {
        "index": "integer",
        "privateIPs": [
          "string"
        ],
        "publicIp": "string"
      }
    ],
    "phase": "string",
    "sshKeyName": "string",
    "subnetId": "string",
    "type": "string",
    "vpcId": "string"
  },
  "status": {
    "health": {
      "conditions": [
        {
          "message": "string",
          "reason": "string",
          "status": "string",
          "type": "string"
        }
      ],
      "state": "string"
    },
    "instanceState": "string"
  }
}

→

https://api.spectrocloud.com/v1/cloudconfigs/aws/{configUid}/machinePools/{machinePoolName}/machines/{machineUid}

summary:

Updates the specified machine to the cloud config's machine pool

Path parameters:

Name	Type	Required
configUid	string	yes
machinePoolName	string	yes
machineUid	string	yes

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": {
    "ami": "string",
    "az": "string",
    "dnsName": "string",
    "iamProfile": "string",
    "instanceType": "string",
    "nics": [
      {
        "index": "integer",
        "privateIPs": [
          "string"
        ],
        "publicIp": "string"
      }
    ],
    "phase": "string",
    "sshKeyName": "string",
    "subnetId": "string",
    "type": "string",
    "vpcId": "string"
  },
  "status": {
    "health": {
      "conditions": [
        {
          "message": "string",
          "reason": "string",
          "status": "string",
          "type": "string"
        }
      ],
      "state": "string"
    },
    "instanceState": "string"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/cloudconfigs/aws/{configUid}/machinePools/{machinePoolName}/machines/{machineUid}

summary:

Deletes the specified AWS machine

Path parameters:

Name	Type	Required
configUid	string	yes
machinePoolName	string	yes
machineUid	string	yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/cloudconfigs/azure/{configUid}

summary:

Returns the specified Azure cloud config

Path parameters:

Name	Type	Description	Required
configUid	string		yes

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": {
    "cloudAccountRef": {
      "apiVersion": "string",
      "fieldPath": "string",
      "kind": "string",
      "name": "string",
      "namespace": "string",
      "resourceVersion": "string",
      "uid": "string"
    },
    "clusterConfig": {
      "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": [
      {
        "additionalLabels": "object",
        "additionalTags": "object",
        "azs": [
          "string"
        ],
        "infraProfileRef": {
          "apiVersion": "string",
          "fieldPath": "string",
          "kind": "string",
          "name": "string",
          "namespace": "string",
          "resourceVersion": "string",
          "uid": "string"
        },
        "infraProfileTemplate": {
          "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"
        },
        "instanceType": "string",
        "isControlPlane": "boolean",
        "isSystemNodePool": "boolean",
        "labels": [
          "string"
        ],
        "maxSize": "integer",
        "minSize": "integer",
        "name": "string",
        "osDisk": {
          "diskSizeGB": "integer",
          "managedDisk": {
            "storageAccountType": "string"
          },
          "osType": "string"
        },
        "size": "integer",
        "spotVMOptions": {
          "maxPrice": "string"
        },
        "taints": [
          {
            "effect": "string",
            "key": "string",
            "timeAdded": "date-time",
            "value": "string"
          }
        ],
        "updateStrategy": {
          "type": "string"
        },
        "useControlPlaneAsWorker": "boolean"
      }
    ]
  },
  "status": {
    "ansibleRoleDigest": "string",
    "conditions": [
      {
        "lastProbeTime": "date-time",
        "lastTransitionTime": "date-time",
        "message": "string",
        "reason": "string",
        "status": "string",
        "type": "string"
      }
    ],
    "images": {
      "gallery": "string",
      "name": "string",
      "resourceGroup": "string",
      "state": "string",
      "subscriptionID": "string",
      "version": "string"
    },
    "isAddonLayer": "boolean",
    "roleDigest": "object",
    "sourceImageId": "string",
    "useCapiImage": "boolean",
    "vhdImage": {
      "id": "string",
      "name": "string",
      "os": "string",
      "region": "string",
      "state": "string"
    }
  }
}

→

https://api.spectrocloud.com/v1/cloudconfigs/azure/{configUid}/clusterConfig

summary:

Updates the cluster configuration information

Path parameters:

Name	Type	Description	Required
configUid	string		yes

Body

{
  "clusterConfig": {
    "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"
    }
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/cloudconfigs/azure/{configUid}/machinePools

summary:

Creates an Azure cloud config's machine pool

Path parameters:

Name	Type	Description	Required
configUid	string		yes

Body

{
  "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: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/cloudconfigs/azure/{configUid}/machinePools/{machinePoolName}

summary:

Updates the specified Azure cloud config's machine pool

Path parameters:

Name	Type	Description	Required
configUid	string		yes
machinePoolName	string		yes

Body

{
  "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: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/cloudconfigs/azure/{configUid}/machinePools/{machinePoolName}

summary:

Deletes the specified machine pool

Path parameters:

Name	Type	Description	Required
configUid	string		yes
machinePoolName	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/cloudconfigs/azure/{configUid}/machinePools/{machinePoolName}/machines

summary:

Retrieves a list of Azure machines

description:

Returns all the Azure machines restricted to the user role and filters.

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

Path parameters:

Name	Type	Description	Required
configUid	string		yes
machinePoolName	string		yes

HTTP code: 200
Description: An array of AWS machine 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": {
        "additionalTags": "object",
        "allocatePublicIP": "boolean",
        "availabilityZone": {
          "enabled": "boolean",
          "id": "string"
        },
        "image": {
          "gallery": "string",
          "id": "string",
          "name": "string",
          "offer": "string",
          "publisher": "string",
          "resourceGroup": "string",
          "sku": "string",
          "subscriptionId": "string",
          "version": "string"
        },
        "instanceType": "string",
        "location": "string",
        "nics": [
          {
            "index": "integer",
            "privateIPs": [
              "string"
            ],
            "publicIp": "string"
          }
        ],
        "osDisk": {
          "diskSizeGB": "integer",
          "managedDisk": {
            "storageAccountType": "string"
          },
          "osType": "string"
        },
        "sshPublicKey": "string"
      },
      "status": {
        "health": {
          "conditions": [
            {
              "message": "string",
              "reason": "string",
              "status": "string",
              "type": "string"
            }
          ],
          "state": "string"
        },
        "instanceState": "string"
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": "integer",
    "limit": "integer",
    "offset": "integer"
  }
}

→

https://api.spectrocloud.com/v1/cloudconfigs/azure/{configUid}/machinePools/{machinePoolName}/machines

summary:

Adds the machine to cloud config's machine pool

Path parameters:

Name	Type	Description	Required
configUid	string		yes
machinePoolName	string		yes

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": {
    "additionalTags": "object",
    "allocatePublicIP": "boolean",
    "availabilityZone": {
      "enabled": "boolean",
      "id": "string"
    },
    "image": {
      "gallery": "string",
      "id": "string",
      "name": "string",
      "offer": "string",
      "publisher": "string",
      "resourceGroup": "string",
      "sku": "string",
      "subscriptionId": "string",
      "version": "string"
    },
    "instanceType": "string",
    "location": "string",
    "nics": [
      {
        "index": "integer",
        "privateIPs": [
          "string"
        ],
        "publicIp": "string"
      }
    ],
    "osDisk": {
      "diskSizeGB": "integer",
      "managedDisk": {
        "storageAccountType": "string"
      },
      "osType": "string"
    },
    "sshPublicKey": "string"
  },
  "status": {
    "health": {
      "conditions": [
        {
          "message": "string",
          "reason": "string",
          "status": "string",
          "type": "string"
        }
      ],
      "state": "string"
    },
    "instanceState": "string"
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/cloudconfigs/azure/{configUid}/machinePools/{machinePoolName}/machines/{machineUid}

summary:

Returns the specified Azure machine

description:

Returns a Azure machine for the specified uid.

Path parameters:

Name	Type	Required
configUid	string	yes
machinePoolName	string	yes
machineUid	string	yes

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": {
    "additionalTags": "object",
    "allocatePublicIP": "boolean",
    "availabilityZone": {
      "enabled": "boolean",
      "id": "string"
    },
    "image": {
      "gallery": "string",
      "id": "string",
      "name": "string",
      "offer": "string",
      "publisher": "string",
      "resourceGroup": "string",
      "sku": "string",
      "subscriptionId": "string",
      "version": "string"
    },
    "instanceType": "string",
    "location": "string",
    "nics": [
      {
        "index": "integer",
        "privateIPs": [
          "string"
        ],
        "publicIp": "string"
      }
    ],
    "osDisk": {
      "diskSizeGB": "integer",
      "managedDisk": {
        "storageAccountType": "string"
      },
      "osType": "string"
    },
    "sshPublicKey": "string"
  },
  "status": {
    "health": {
      "conditions": [
        {
          "message": "string",
          "reason": "string",
          "status": "string",
          "type": "string"
        }
      ],
      "state": "string"
    },
    "instanceState": "string"
  }
}

→

https://api.spectrocloud.com/v1/cloudconfigs/azure/{configUid}/machinePools/{machinePoolName}/machines/{machineUid}

summary:

Updates the specified machine to cloud config's machine pool

Path parameters:

Name	Type	Required
configUid	string	yes
machinePoolName	string	yes
machineUid	string	yes

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": {
    "additionalTags": "object",
    "allocatePublicIP": "boolean",
    "availabilityZone": {
      "enabled": "boolean",
      "id": "string"
    },
    "image": {
      "gallery": "string",
      "id": "string",
      "name": "string",
      "offer": "string",
      "publisher": "string",
      "resourceGroup": "string",
      "sku": "string",
      "subscriptionId": "string",
      "version": "string"
    },
    "instanceType": "string",
    "location": "string",
    "nics": [
      {
        "index": "integer",
        "privateIPs": [
          "string"
        ],
        "publicIp": "string"
      }
    ],
    "osDisk": {
      "diskSizeGB": "integer",
      "managedDisk": {
        "storageAccountType": "string"
      },
      "osType": "string"
    },
    "sshPublicKey": "string"
  },
  "status": {
    "health": {
      "conditions": [
        {
          "message": "string",
          "reason": "string",
          "status": "string",
          "type": "string"
        }
      ],
      "state": "string"
    },
    "instanceState": "string"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/cloudconfigs/azure/{configUid}/machinePools/{machinePoolName}/machines/{machineUid}

summary:

Deletes the specified Azure machine

Path parameters:

Name	Type	Required
configUid	string	yes
machinePoolName	string	yes
machineUid	string	yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/cloudconfigs/edge/{configUid}

summary:

Returns the specified edge cloud config

Path parameters:

Name	Type	Description	Required
configUid	string		yes

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": {
    "clusterConfig": {
      "sshKeys": [
        "string"
      ]
    },
    "machinePoolConfig": [
      {
        "additionalLabels": "object",
        "additionalTags": "object",
        "hosts": [
          {
            "hostAddress": "string",
            "hostIdentity": {
              "caCert": "string",
              "socketPath": "string"
            },
            "hostName": "string",
            "hostUid": "string"
          }
        ],
        "infraProfileRef": {
          "apiVersion": "string",
          "fieldPath": "string",
          "kind": "string",
          "name": "string",
          "namespace": "string",
          "resourceVersion": "string",
          "uid": "string"
        },
        "infraProfileTemplate": {
          "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"
        },
        "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"
      }
    ]
  },
  "status": {
    "conditions": [
      {
        "lastProbeTime": "date-time",
        "lastTransitionTime": "date-time",
        "message": "string",
        "reason": "string",
        "status": "string",
        "type": "string"
      }
    ],
    "nodeImage": "string",
    "sourceImageId": "string",
    "useCapiImage": "boolean"
  }
}

→

https://api.spectrocloud.com/v1/cloudconfigs/edge/{configUid}/clusterConfig

summary:

Updates the cluster configuration information

Path parameters:

Name	Type	Description	Required
configUid	string		yes

Body

{
  "clusterConfig": {
    "sshKeys": [
      "string"
    ]
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/cloudconfigs/edge/{configUid}/machinePools

summary:

Creates a edge cloud config's machine pool

Path parameters:

Name	Type	Description	Required
configUid	string		yes

Body

{
  "cloudConfig": {
    "edgeHosts": [
      {
        "hostUid": "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: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/cloudconfigs/edge/{configUid}/machinePools/{machinePoolName}

summary:

Updates the specified Edge cloud config's machine pool

Path parameters:

Name	Type	Description	Required
configUid	string		yes
machinePoolName	string		yes

Body

{
  "cloudConfig": {
    "edgeHosts": [
      {
        "hostUid": "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: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/cloudconfigs/edge/{configUid}/machinePools/{machinePoolName}

summary:

Deletes the specified machine pool

Path parameters:

Name	Type	Description	Required
configUid	string		yes
machinePoolName	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/cloudconfigs/edge/{configUid}/machinePools/{machinePoolName}/machines

summary:

Retrieves a list of Edge machines

Path parameters:

Name	Type	Description	Required
configUid	string		yes
machinePoolName	string		yes

HTTP code: 200
Description: An array of Edge machine 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":