Appliances (Edge Hosts)

→

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

summary:

Retrieves a list of registered edge host devices

Parameters:

Name	Type	Description	Required
type	string		no

HTTP code: 200
Description: An array of edge host device items
Response body:

{
  "items": [
    {
      "aclmeta": {
        "ownerUid": "string",
        "projectUid": "string",
        "tenantUid": "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": {
        "cloudProperties": {
          "vsphere": {
            "datacenters": [
              {
                "computeClusters": [
                  {
                    "datastores": [
                      "string"
                    ],
                    "name": "string",
                    "networks": [
                      "string"
                    ],
                    "resourcePools": [
                      "string"
                    ]
                  }
                ],
                "folders": [
                  "string"
                ],
                "name": "string"
              }
            ]
          }
        },
        "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"
                    ]
                  }
                ],
                "registryUid": "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"
              }
            ],
            "profileVersion": "string",
            "type": "string",
            "uid": "string",
            "version":deprecated "integer"
          }
        ],
        "device": {
          "cpu": {
            "cores": "integer"
          },
          "disks": [
            {
              "controller": "string",
              "partitions": [
                {
                  "fileSystemType": "string",
                  "freeSpace": "integer",
                  "mountPoint": "string",
                  "totalSpace": "integer",
                  "usedSpace": "integer"
                }
              ],
              "size": "integer",
              "vendor": "string"
            }
          ],
          "gpus": [
            {
              "addresses": "object",
              "model": "string",
              "vendor": "string"
            }
          ],
          "memory": {
            "sizeInMB": "integer"
          },
          "nics": [
            {
              "dns": [
                "string"
              ],
              "gateway": "string",
              "ip": "string",
              "macAddr": "string",
              "subnet": "string"
            }
          ],
          "os": {
            "family": "string",
            "version": "string"
          },
          "type": "string"
        },
        "host": {
          "hostAddress": "string",
          "hostChecksum": "string",
          "hostIdentity": {
            "caCert": "string",
            "mode": "string",
            "socketPath": "string",
            "sshSecret": {
              "name": "string",
              "privateKey": "string"
            }
          },
          "hostPairingKey": "string",
          "hostUid": "string"
        },
        "properties": {
          "networks": [
            {
              "networkName": "string",
              "networkType": "string"
            }
          ],
          "storagePools": [
            {
              "name": "string"
            }
          ]
        },
        "type": "string",
        "version": "string"
      },
      "status": {
        "health": {
          "agentVersion": "string",
          "message": "string",
          "state": "string"
        },
        "inUseClusters": [
          {
            "name": "string",
            "uid": "string"
          }
        ],
        "packs": [
          {
            "condition": {
              "lastProbeTime": "date-time",
              "lastTransitionTime": "date-time",
              "message": "string",
              "reason": "string",
              "status": "string",
              "type": "string"
            },
            "endTime": "date-time",
            "manifests": [
              {
                "condition": {
                  "lastProbeTime": "date-time",
                  "lastTransitionTime": "date-time",
                  "message": "string",
                  "reason": "string",
                  "status": "string",
                  "type": "string"
                },
                "name": "string",
                "uid": "string"
              }
            ],
            "name": "string",
            "profileUid": "string",
            "services": [
              {
                "host": "string",
                "name": "string",
                "ports": [
                  {
                    "port": "integer",
                    "protocol": "string"
                  }
                ]
              }
            ],
            "startTime": "date-time",
            "type": "string",
            "version": "string"
          }
        ],
        "profileStatus": {
          "hasUserMacros": "boolean"
        },
        "state": "string"
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": "integer",
    "limit": "integer",
    "offset": "integer"
  }
}

→

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

summary:

Create the edge host device

Body

{
  "metadata": {
    "labels": "object",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "hostPairingKey": "string"
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

https://api.spectrocloud.com/v1/edgehosts/register

summary:

Registers the edge host device

Body

{
  "aclmeta": {
    "ownerUid": "string",
    "projectUid": "string",
    "tenantUid": "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": {
    "cloudProperties": {
      "vsphere": {
        "datacenters": [
          {
            "computeClusters": [
              {
                "datastores": [
                  "string"
                ],
                "name": "string",
                "networks": [
                  "string"
                ],
                "resourcePools": [
                  "string"
                ]
              }
            ],
            "folders": [
              "string"
            ],
            "name": "string"
          }
        ]
      }
    },
    "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"
                ]
              }
            ],
            "registryUid": "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"
          }
        ],
        "profileVersion": "string",
        "type": "string",
        "uid": "string",
        "version":deprecated "integer"
      }
    ],
    "device": {
      "cpu": {
        "cores": "integer"
      },
      "disks": [
        {
          "controller": "string",
          "partitions": [
            {
              "fileSystemType": "string",
              "freeSpace": "integer",
              "mountPoint": "string",
              "totalSpace": "integer",
              "usedSpace": "integer"
            }
          ],
          "size": "integer",
          "vendor": "string"
        }
      ],
      "gpus": [
        {
          "addresses": "object",
          "model": "string",
          "vendor": "string"
        }
      ],
      "memory": {
        "sizeInMB": "integer"
      },
      "nics": [
        {
          "dns": [
            "string"
          ],
          "gateway": "string",
          "ip": "string",
          "macAddr": "string",
          "subnet": "string"
        }
      ],
      "os": {
        "family": "string",
        "version": "string"
      },
      "type": "string"
    },
    "host": {
      "hostAddress": "string",
      "hostChecksum": "string",
      "hostIdentity": {
        "caCert": "string",
        "mode": "string",
        "socketPath": "string",
        "sshSecret": {
          "name": "string",
          "privateKey": "string"
        }
      },
      "hostPairingKey": "string",
      "hostUid": "string"
    },
    "properties": {
      "networks": [
        {
          "networkName": "string",
          "networkType": "string"
        }
      ],
      "storagePools": [
        {
          "name": "string"
        }
      ]
    },
    "type": "string",
    "version": "string"
  },
  "status": {
    "health": {
      "agentVersion": "string",
      "message": "string",
      "state": "string"
    },
    "inUseClusters": [
      {
        "name": "string",
        "uid": "string"
      }
    ],
    "packs": [
      {
        "condition": {
          "lastProbeTime": "date-time",
          "lastTransitionTime": "date-time",
          "message": "string",
          "reason": "string",
          "status": "string",
          "type": "string"
        },
        "endTime": "date-time",
        "manifests": [
          {
            "condition": {
              "lastProbeTime": "date-time",
              "lastTransitionTime": "date-time",
              "message": "string",
              "reason": "string",
              "status": "string",
              "type": "string"
            },
            "name": "string",
            "uid": "string"
          }
        ],
        "name": "string",
        "profileUid": "string",
        "services": [
          {
            "host": "string",
            "name": "string",
            "ports": [
              {
                "port": "integer",
                "protocol": "string"
              }
            ]
          }
        ],
        "startTime": "date-time",
        "type": "string",
        "version": "string"
      }
    ],
    "profileStatus": {
      "hasUserMacros": "boolean"
    },
    "state": "string"
  }
}

HTTP code: 200
Description: OK
Response body:

{
  "aclmeta": {
    "ownerUid": "string",
    "projectUid": "string",
    "tenantUid": "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": {
    "cloudProperties": {
      "vsphere": {
        "datacenters": [
          {
            "computeClusters": [
              {
                "datastores": [
                  "string"
                ],
                "name": "string",
                "networks": [
                  "string"
                ],
                "resourcePools": [
                  "string"
                ]
              }
            ],
            "folders": [
              "string"
            ],
            "name": "string"
          }
        ]
      }
    },
    "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"
                ]
              }
            ],
            "registryUid": "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"
          }
        ],
        "profileVersion": "string",
        "type": "string",
        "uid": "string",
        "version":deprecated "integer"
      }
    ],
    "device": {
      "cpu": {
        "cores": "integer"
      },
      "disks": [
        {
          "controller": "string",
          "partitions": [
            {
              "fileSystemType": "string",
              "freeSpace": "integer",
              "mountPoint": "string",
              "totalSpace": "integer",
              "usedSpace": "integer"
            }
          ],
          "size": "integer",
          "vendor": "string"
        }
      ],
      "gpus": [
        {
          "addresses": "object",
          "model": "string",
          "vendor": "string"
        }
      ],
      "memory": {
        "sizeInMB": "integer"
      },
      "nics": [
        {
          "dns": [
            "string"
          ],
          "gateway": "string",
          "ip": "string",
          "macAddr": "string",
          "subnet": "string"
        }
      ],
      "os": {
        "family": "string",
        "version": "string"
      },
      "type": "string"
    },
    "host": {
      "hostAddress": "string",
      "hostChecksum": "string",
      "hostIdentity": {
        "caCert": "string",
        "mode": "string",
        "socketPath": "string",
        "sshSecret": {
          "name": "string",
          "privateKey": "string"
        }
      },
      "hostPairingKey": "string",
      "hostUid": "string"
    },
    "properties": {
      "networks": [
        {
          "networkName": "string",
          "networkType": "string"
        }
      ],
      "storagePools": [
        {
          "name": "string"
        }
      ]
    },
    "type": "string",
    "version": "string"
  },
  "status": {
    "health": {
      "agentVersion": "string",
      "message": "string",
      "state": "string"
    },
    "inUseClusters": [
      {
        "name": "string",
        "uid": "string"
      }
    ],
    "packs": [
      {
        "condition": {
          "lastProbeTime": "date-time",
          "lastTransitionTime": "date-time",
          "message": "string",
          "reason": "string",
          "status": "string",
          "type": "string"
        },
        "endTime": "date-time",
        "manifests": [
          {
            "condition": {
              "lastProbeTime": "date-time",
              "lastTransitionTime": "date-time",
              "message": "string",
              "reason": "string",
              "status": "string",
              "type": "string"
            },
            "name": "string",
            "uid": "string"
          }
        ],
        "name": "string",
        "profileUid": "string",
        "services": [
          {
            "host": "string",
            "name": "string",
            "ports": [
              {
                "port": "integer",
                "protocol": "string"
              }
            ]
          }
        ],
        "startTime": "date-time",
        "type": "string",
        "version": "string"
      }
    ],
    "profileStatus": {
      "hasUserMacros": "boolean"
    },
    "state": "string"
  }
}

→

https://api.spectrocloud.com/v1/edgehosts/{uid}

summary:

Deletes the specified edge host device

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/edgehosts/{uid}

summary:

Returns the specified edge host device

Parameters:

Name	Type	Description	Required
resolvePackValues	boolean		no

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "aclmeta": {
    "ownerUid": "string",
    "projectUid": "string",
    "tenantUid": "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": {
    "cloudProperties": {
      "vsphere": {
        "datacenters": [
          {
            "computeClusters": [
              {
                "datastores": [
                  "string"
                ],
                "name": "string",
                "networks": [
                  "string"
                ],
                "resourcePools": [
                  "string"
                ]
              }
            ],
            "folders": [
              "string"
            ],
            "name": "string"
          }
        ]
      }
    },
    "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"
                ]
              }
            ],
            "registryUid": "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"
          }
        ],
        "profileVersion": "string",
        "type": "string",
        "uid": "string",
        "version":deprecated "integer"
      }
    ],
    "device": {
      "cpu": {
        "cores": "integer"
      },
      "disks": [
        {
          "controller": "string",
          "partitions": [
            {
              "fileSystemType": "string",
              "freeSpace": "integer",
              "mountPoint": "string",
              "totalSpace": "integer",
              "usedSpace": "integer"
            }
          ],
          "size": "integer",
          "vendor": "string"
        }
      ],
      "gpus": [
        {
          "addresses": "object",
          "model": "string",
          "vendor": "string"
        }
      ],
      "memory": {
        "sizeInMB": "integer"
      },
      "nics": [
        {
          "dns": [
            "string"
          ],
          "gateway": "string",
          "ip": "string",
          "macAddr": "string",
          "subnet": "string"
        }
      ],
      "os": {
        "family": "string",
        "version": "string"
      },
      "type": "string"
    },
    "host": {
      "hostAddress": "string",
      "hostChecksum": "string",
      "hostIdentity": {
        "caCert": "string",
        "mode": "string",
        "socketPath": "string",
        "sshSecret": {
          "name": "string",
          "privateKey": "string"
        }
      },
      "hostPairingKey": "string",
      "hostUid": "string"
    },
    "properties": {
      "networks": [
        {
          "networkName": "string",
          "networkType": "string"
        }
      ],
      "storagePools": [
        {
          "name": "string"
        }
      ]
    },
    "type": "string",
    "version": "string"
  },
  "status": {
    "health": {
      "agentVersion": "string",
      "message": "string",
      "state": "string"
    },
    "inUseClusters": [
      {
        "name": "string",
        "uid": "string"
      }
    ],
    "packs": [
      {
        "condition": {
          "lastProbeTime": "date-time",
          "lastTransitionTime": "date-time",
          "message": "string",
          "reason": "string",
          "status": "string",
          "type": "string"
        },
        "endTime": "date-time",
        "manifests": [
          {
            "condition": {
              "lastProbeTime": "date-time",
              "lastTransitionTime": "date-time",
              "message": "string",
              "reason": "string",
              "status": "string",
              "type": "string"
            },
            "name": "string",
            "uid": "string"
          }
        ],
        "name": "string",
        "profileUid": "string",
        "services": [
          {
            "host": "string",
            "name": "string",
            "ports": [
              {
                "port": "integer",
                "protocol": "string"
              }
            ]
          }
        ],
        "startTime": "date-time",
        "type": "string",
        "version": "string"
      }
    ],
    "profileStatus": {
      "hasUserMacros": "boolean"
    },
    "state": "string"
  }
}

→

https://api.spectrocloud.com/v1/edgehosts/{uid}

summary:

Updates the specified edge host device

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "aclmeta": {
    "ownerUid": "string",
    "projectUid": "string",
    "tenantUid": "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": {
    "cloudProperties": {
      "vsphere": {
        "datacenters": [
          {
            "computeClusters": [
              {
                "datastores": [
                  "string"
                ],
                "name": "string",
                "networks": [
                  "string"
                ],
                "resourcePools": [
                  "string"
                ]
              }
            ],
            "folders": [
              "string"
            ],
            "name": "string"
          }
        ]
      }
    },
    "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"
                ]
              }
            ],
            "registryUid": "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"
          }
        ],
        "profileVersion": "string",
        "type": "string",
        "uid": "string",
        "version":deprecated "integer"
      }
    ],
    "device": {
      "cpu": {
        "cores": "integer"
      },
      "disks": [
        {
          "controller": "string",
          "partitions": [
            {
              "fileSystemType": "string",
              "freeSpace": "integer",
              "mountPoint": "string",
              "totalSpace": "integer",
              "usedSpace": "integer"
            }
          ],
          "size": "integer",
          "vendor": "string"
        }
      ],
      "gpus": [
        {
          "addresses": "object",
          "model": "string",
          "vendor": "string"
        }
      ],
      "memory": {
        "sizeInMB": "integer"
      },
      "nics": [
        {
          "dns": [
            "string"
          ],
          "gateway": "string",
          "ip": "string",
          "macAddr": "string",
          "subnet": "string"
        }
      ],
      "os": {
        "family": "string",
        "version": "string"
      },
      "type": "string"
    },
    "host": {
      "hostAddress": "string",
      "hostChecksum": "string",
      "hostIdentity": {
        "caCert": "string",
        "mode": "string",
        "socketPath": "string",
        "sshSecret": {
          "name": "string",
          "privateKey": "string"
        }
      },
      "hostPairingKey": "string",
      "hostUid": "string"
    },
    "properties": {
      "networks": [
        {
          "networkName": "string",
          "networkType": "string"
        }
      ],
      "storagePools": [
        {
          "name": "string"
        }
      ]
    },
    "type": "string",
    "version": "string"
  },
  "status": {
    "health": {
      "agentVersion": "string",
      "message": "string",
      "state": "string"
    },
    "inUseClusters": [
      {
        "name": "string",
        "uid": "string"
      }
    ],
    "packs": [
      {
        "condition": {
          "lastProbeTime": "date-time",
          "lastTransitionTime": "date-time",
          "message": "string",
          "reason": "string",
          "status": "string",
          "type": "string"
        },
        "endTime": "date-time",
        "manifests": [
          {
            "condition": {
              "lastProbeTime": "date-time",
              "lastTransitionTime": "date-time",
              "message": "string",
              "reason": "string",
              "status": "string",
              "type": "string"
            },
            "name": "string",
            "uid": "string"
          }
        ],
        "name": "string",
        "profileUid": "string",
        "services": [
          {
            "host": "string",
            "name": "string",
            "ports": [
              {
                "port": "integer",
                "protocol": "string"
              }
            ]
          }
        ],
        "startTime": "date-time",
        "type": "string",
        "version": "string"
      }
    ],
    "profileStatus": {
      "hasUserMacros": "boolean"
    },
    "state": "string"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/edgehosts/{uid}/cluster/associate

summary:

Deassociate the clusters to the edge host

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

https://api.spectrocloud.com/v1/edgehosts/{uid}/cluster/associate

summary:

Associate the clusters to the edge host

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "clusterUid": "string"
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/edgehosts/{uid}/health

summary:

Updates the edge host health

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "agentVersion": "string",
  "message": "string",
  "state": "string"
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/edgehosts/{uid}/hostCheckSum

summary:

Update the specified edge host device host check sum

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "hostCheckSum": "string"
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/edgehosts/{uid}/hostPairingKey

summary:

Update the specified edge host device host pairing key

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "hostPairingKey": "string"
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/edgehosts/{uid}/meta

summary:

Updates the specified edge host device meta

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "metadata": {
    "labels": "object",
    "name": "string",
    "uid": "string"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/edgehosts/{uid}/pack/manifests/{manifestUid}

summary:

Returns the specified edge host's manifest

Parameters:

Name	Type	Description	Required
uid	string	edge host uid	yes
manifestUid	string	manifest uid which is part of the pack ref	yes
resolveManifestValues	boolean		no

HTTP code: 200
Description: Pack manifest content
Response 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": {
    "published": {
      "content": "string",
      "digest": "string"
    }
  }
}

→

https://api.spectrocloud.com/v1/edgehosts/{uid}/packs/status

summary:

Patch update specified edge host's packs status

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "packs": [
    {
      "condition": {
        "message": "string",
        "reason": "string",
        "status": "string",
        "type": "string"
      },
      "endTime": "date-time",
      "name": "string",
      "profileUid": "string",
      "startTime": "date-time",
      "type": "string",
      "version": "string"
    }
  ]
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/edgehosts/{uid}/profiles

summary:

Returns the associated profiles of a specified edge host device

Parameters:

Name	Type	Description	Required
includePackMeta	string	includes pack meta such as schema, presets	no

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: OK
Response body:

{
  "profiles": [
    {
      "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": {
        "cloudType": "string",
        "packs": [
          {
            "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": {
              "addonType": "string",
              "annotations": "object",
              "cloudTypes": [
                "string"
              ],
              "digest": "string",
              "displayName": "string",
              "eol": "string",
              "group": "string",
              "layer": "string",
              "logoUrl": "string",
              "manifests": [
                {
                  "apiVersion": "string",
                  "fieldPath": "string",
                  "kind": "string",
                  "name": "string",
                  "namespace": "string",
                  "resourceVersion": "string",
                  "uid": "string"
                }
              ],
              "name": "string",
              "presets": [
                {
                  "add": "string",
                  "displayName": "string",
                  "group": "string",
                  "name": "string",
                  "remove": [
                    "string"
                  ]
                }
              ],
              "registryUid": "string",
              "schema": [
                {
                  "format": "string",
                  "hints": [
                    "string"
                  ],
                  "listOptions": [
                    "string"
                  ],
                  "name": "string",
                  "readonly": "boolean",
                  "regex": "string",
                  "required": "boolean",
                  "type": "string"
                }
              ],
              "type": "string",
              "values": "string",
              "version": "string"
            },
            "status": "object"
          }
        ],
        "type": "string",
        "version": "integer"
      }
    }
  ]
}

→

https://api.spectrocloud.com/v1/edgehosts/{uid}/profiles

summary:

Associate cluster profiles to the specified edge host device

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "profiles": [
    {
      "packValues": [
        {
          "manifests": [
            {
              "content": "string",
              "name": "string",
              "uid": "string"
            }
          ],
          "name": "string",
          "tag": "string",
          "type": "string",
          "values": "string"
        }
      ],
      "replaceWithProfile": "string",
      "uid": "string"
    }
  ],
  "spcApplySettings": {
    "actionType": "string"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

https://api.spectrocloud.com/v1/edgehosts/{uid}/spc/download

summary:

Download the specified edge host device spc

Path parameters:

Name	Type	Description	Required
uid	string		yes

HTTP code: 200
Description: download spc archive file

→

https://api.spectrocloud.com/v1/edgehosts/{uid}/vsphere/properties

summary:

Updates the specified edge host device vsphere properties

Path parameters:

Name	Type	Description	Required
uid	string		yes

Body

{
  "datacenters": [
    {
      "computeClusters": [
        {
          "datastores": [
            "string"
          ],
          "name": "string",
          "networks": [
            "string"
          ],
          "resourcePools": [
            "string"
          ]
        }
      ],
      "folders": [
        "string"
      ],
      "name": "string"
    }
  ]
}

HTTP code: 204
Description: The resource was updated successfully

Edit on GitHub