→
https://api.spectrocloud.com/v1/edgehosts
summary:
Retrieves a list of registered edge host devicesParameters:
Name | Type | Description | Required |
---|---|---|---|
type | string | no |
200
An array of edge host device items
An array of edge host device items
{"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"]}],"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"}],"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","hostIdentity": {"caCert": "string","mode": "string","socketPath": "string","sshSecret": {"name": "string","privateKey": "string"}},"hostUid": "string"},"properties": {"networks": [{"networkName": "string","networkType": "string"}],"storagePools": [{"name": "string"}]},"type": "string","version": "string"},"status": {"health": {"message": "string","state": "string"},"inUseClusters": [{"name": "string","uid": "string"}],"state": "string"}}],"listmeta": {"continue": "string","count": "integer","limit": "integer","offset": "integer"}}
→
https://api.spectrocloud.com/v1/edgehosts
summary:
Create the edge host device{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","lastModifiedTimestamp": "date-time","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"}}
201
Created successfully
Created successfully
{"uid": "string"}
→
https://api.spectrocloud.com/v1/edgehosts/register
summary:
Registers the edge host device{"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"]}],"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"}],"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","hostIdentity": {"caCert": "string","mode": "string","socketPath": "string","sshSecret": {"name": "string","privateKey": "string"}},"hostUid": "string"},"properties": {"networks": [{"networkName": "string","networkType": "string"}],"storagePools": [{"name": "string"}]},"type": "string","version": "string"},"status": {"health": {"message": "string","state": "string"},"inUseClusters": [{"name": "string","uid": "string"}],"state": "string"}}
200
OK
OK
{"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"]}],"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"}],"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","hostIdentity": {"caCert": "string","mode": "string","socketPath": "string","sshSecret": {"name": "string","privateKey": "string"}},"hostUid": "string"},"properties": {"networks": [{"networkName": "string","networkType": "string"}],"storagePools": [{"name": "string"}]},"type": "string","version": "string"},"status": {"health": {"message": "string","state": "string"},"inUseClusters": [{"name": "string","uid": "string"}],"state": "string"}}
→
https://api.spectrocloud.com/v1/edgehosts/{uid}
summary:
Returns the specified edge host deviceParameters:
Name | Type | Description | Required |
---|---|---|---|
resolvePackValues | boolean | no |
Path parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
200
OK
OK
{"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"]}],"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"}],"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","hostIdentity": {"caCert": "string","mode": "string","socketPath": "string","sshSecret": {"name": "string","privateKey": "string"}},"hostUid": "string"},"properties": {"networks": [{"networkName": "string","networkType": "string"}],"storagePools": [{"name": "string"}]},"type": "string","version": "string"},"status": {"health": {"message": "string","state": "string"},"inUseClusters": [{"name": "string","uid": "string"}],"state": "string"}}
→
https://api.spectrocloud.com/v1/edgehosts/{uid}
summary:
Updates the specified edge host devicePath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"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"]}],"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"}],"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","hostIdentity": {"caCert": "string","mode": "string","socketPath": "string","sshSecret": {"name": "string","privateKey": "string"}},"hostUid": "string"},"properties": {"networks": [{"networkName": "string","networkType": "string"}],"storagePools": [{"name": "string"}]},"type": "string","version": "string"},"status": {"health": {"message": "string","state": "string"},"inUseClusters": [{"name": "string","uid": "string"}],"state": "string"}}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1/edgehosts/{uid}
summary:
Deletes the specified edge host devicePath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
204
The resource was deleted successfully
The resource was deleted successfully
→
https://api.spectrocloud.com/v1/edgehosts/{uid}/health
summary:
Updates the edge host healthPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"message": "string","state": "string"}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1/edgehosts/{uid}/meta
summary:
Updates the specified edge host device metaPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","lastModifiedTimestamp": "date-time","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"}}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1/edgehosts/{uid}/pack/manifests/{manifestUid}
summary:
Returns the specified edge host's manifestParameters:
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 |
200
Pack manifest content
Pack manifest content
{"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}/profiles
summary:
Returns the associated profiles of a specified edge host deviceParameters:
Name | Type | Description | Required |
---|---|---|---|
includePackMeta | string | includes pack meta such as schema, presets | no |
Path parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
200
OK
OK
{"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 devicePath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"profiles": [{"packValues": [{"manifests": [{"content": "string","name": "string","uid": "string"}],"name": "string","tag": "string","type": "string","values": "string"}],"uid": "string"}]}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1/edgehosts/{uid}/spc/download
summary:
Download the specified edge host device spcPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
200
download spc archive file
download spc archive file
→
https://api.spectrocloud.com/v1/edgehosts/{uid}/vsphere/properties
summary:
Updates the specified edge host device vsphere propertiesPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"datacenters": [{"computeClusters": [{"datastores": ["string"],"name": "string","networks": ["string"],"resourcePools": ["string"]}],"folders": ["string"],"name": "string"}]}
204
The resource was updated successfully
The resource was updated successfully