How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Spectro Cloud edgehosts API

The edgehosts API from Spectro Cloud — 22 operation(s) for edgehosts.

Spectro Cloud edgehosts API is one of 42 APIs that Spectro Cloud publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include edgehosts. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 30 operations across 22 paths, and defines 95 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://edge-host-ip:5080.

30 operations 22 paths 95 schemas 3 DELETE10 GET7 PATCH3 POST7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.spectrocloud.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Spectro Cloud edgehosts API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Authorization).

  • Authorization — JWT authorization token obtained using /v1/users/default/login API

Paths & Operations 30

Across 22 paths, the API surfaces 30 operations — 3 DELETE, 10 GET, 7 PATCH, 3 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

edgehosts 30
GET
/v1/edgehosts
Retrieve the Complete Edgehost Metadata List
v1EdgeHostDevicesList 2 params → 200
POST
/v1/edgehosts
Create the edge host device
v1EdgeHostDevicesCreate 1 param body → 201
GET
/v1/edgehosts/metadata
Retrieves a list of edge hosts metadata matching the filter condition
v1EdgeHostsMetadataQuickFilterGet 3 params → 200
POST
/v1/edgehosts/register
Registers the edge host device
v1EdgeHostDevicesRegister 1 param body → 200
GET
/v1/edgehosts/tags
Retrieves a list of edge hosts tags
v1EdgeHostsTagsGet 1 param → 200
GET
/v1/edgehosts/tokens
Retrieves a list of edge tokens
v1EdgeTokensList 1 param → 200
POST
/v1/edgehosts/tokens
Create the edge token
v1EdgeTokensCreate 1 param body → 201
DELETE
/v1/edgehosts/tokens/{uid}
Deletes the specified edge token
v1EdgeTokensUidDelete 2 params → 204
GET
/v1/edgehosts/tokens/{uid}
Returns the specified edge token
v1EdgeTokensUidGet 2 params → 200
PUT
/v1/edgehosts/tokens/{uid}
Updates the specified edge token
v1EdgeTokensUidUpdate 2 params body → 204
PUT
/v1/edgehosts/tokens/{uid}/state
Revoke or re-activate the edge token access
v1EdgeTokensUidState 2 params body → 204
DELETE
/v1/edgehosts/{uid}
Deletes the specified edge host device
v1EdgeHostDevicesUidDelete 2 params → 204
GET
/v1/edgehosts/{uid}
Returns the specified edge host device
v1EdgeHostDevicesUidGet 3 params → 200
PUT
/v1/edgehosts/{uid}
Updates the specified edge host device
v1EdgeHostDevicesUidUpdate 2 params body → 204
DELETE
/v1/edgehosts/{uid}/cluster/associate
Deassociate the clusters to the edge host
v1EdgeHostDevicesUidClusterDeassociate 2 params → 204
PATCH
/v1/edgehosts/{uid}/cluster/associate
Associate the clusters to the edge host
v1EdgeHostDevicesUidClusterAssociate 2 params body → 204
GET
/v1/edgehosts/{uid}/config
Get the specified edge host device configuration
v1EdgeHostDevicesUidConfigGet 2 params → 200
PATCH
/v1/edgehosts/{uid}/health
Updates the edge host health
v1EdgeHostDevicesHealthUpdate 2 params body → 204
PATCH
/v1/edgehosts/{uid}/hostCheckSum
Update the specified edge host device host check sum
v1EdgeHostDeviceHostCheckSumUpdate 2 params body → 204
PATCH
/v1/edgehosts/{uid}/hostPairingKey
Update the specified edge host device host pairing key
v1EdgeHostDeviceHostPairingKeyUpdate 2 params body → 204
PUT
/v1/edgehosts/{uid}/meta
Updates the specified edge host device meta
v1EdgeHostDevicesUidMetaUpdate 2 params body → 204
GET
/v1/edgehosts/{uid}/pack/manifests/{manifestUid}
Returns the specified edge host's manifest
v1EdgeHostDevicesUidPackManifestsUidGet 4 params → 200
PATCH
/v1/edgehosts/{uid}/packs/status
Patch update specified edge host's packs status
v1EdgeHostDevicesUidPacksStatusPatch 2 params body → 204
GET
/v1/edgehosts/{uid}/profiles
Returns the associated profiles of a specified edge host device
v1EdgeHostDevicesUidProfilesGet 3 params → 200
PUT
/v1/edgehosts/{uid}/profiles
Associate cluster profiles to the specified edge host device
v1EdgeHostDevicesUidProfilesUpdate 2 params body → 204
PUT
/v1/edgehosts/{uid}/reset
Reset the cluster through edge host
V1EdgeHostsUidReset 2 params → 204
GET
/v1/edgehosts/{uid}/spc/download
Download the specified edge host device spc
v1EdgeHostDevicesUidSpcDownload 2 params → 200
PATCH
/v1/edgehosts/{uid}/tunnelConfig
Updates the specified edge host device tunnel configuration
v1EdgeHostDevicesUidTunnelConfigUpdate 2 params body → 204
PATCH
/v1/edgehosts/{uid}/tunnelStatus
Updates the edge host tunnel status
v1EdgeHostDevicesUidTunnelStatusUpdate 2 params body → 204
PUT
/v1/edgehosts/{uid}/vsphere/properties
Updates the specified edge host device vsphere properties
v1EdgeHostDevicesUidVspherePropertiesUpdate 2 params body → 204

Schemas 95

The contract defines 95 schemas that model the data the API accepts and returns. The most detailed are v1PackSummarySpec (19 properties), v1PackRef (18 properties), v1PackTemplateParameter (13 properties), v1DeviceSpec (10 properties). Each schema is shown below with its type and property counts.

v1ClusterProfilePacksEntity
object
Cluster profile packs object
3 properties
v1EdgeHostProperties
object
Additional properties of edge host
2 properties
v1PackSummarySpec
object
Pack object
19 properties
v1OS
object
4 properties
v1SpectroTunnelStatus
object
SpectroTunnelStatus is the status of the tunnel
1 property
v1EdgeHostsMeta
object
1 property
v1SshUserStatus
object
4 properties
v1EdgeHostDevice
object
4 properties
v1DeviceSpec
object
DeviceSpec defines the desired state of Device
10 properties
v1ManifestData
object
Published manifest object
2 properties
v1EdgeTokenSpecEntity
object
Edge token specification
2 properties
v1CPU
object
1 property
v1ClusterCondition
object
6 properties 2 required
v1PackTemplateParameterOption
object
Pack template parameter option
3 properties
v1HybridClusterMeta
object
Object identity meta of hybrid cluster
2 properties
v1EdgeTokenProject
object
Edge token project information
2 properties
v1EdgeHostNetwork
object
Network defines the network configuration for a virtual machine
2 properties 2 required
v1PackLayer
string
v1ListMetaData
object
ListMeta describes metadata for the resource listing
4 properties
v1Memory
object
1 property
v1EdgeTokenActiveState
object
Edge token active state
1 property
v1SpectroClusterProfiles
object
2 properties 1 required
v1ObjectMeta
object
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
7 properties
v1EdgeHostStoragePool
object
StoragePool is the storage pool for the vm image
1 property
v1ManifestPublishedSpec
object
Manifest spec
1 property
v1Uid
object
1 property 1 required
v1EdgeHostsTags
object
1 property
v1AclMeta
object
Resource access control information (Read-only response data)
3 properties
v1SshUserCredentials
object
3 properties
v1SpectroClusterProfileSpec
object
Cluster profile spec response
5 properties
v1EdgeTokenUpdate
object
Edge token update request payload
2 properties
v1EdgeHostDeviceSpecEntity
object
Edge host device spec
3 properties
v1ServiceSpec
object
ServiceSpec defines the specification of service registering edge
2 properties
v1EdgeHostCloudProperties
object
Additional cloud properties of the edge host (applicable based on the cloud type)
1 property
v1EdgeHostVsphereCloudProperties
object
Vsphere cloud properties of edge host
1 property
v1SpectroClusterProfileEntity
object
Cluster profile request payload
4 properties
v1PackDependency
object
Pack template dependency
3 properties
v1PackTemplateParameter
object
Pack template parameter
13 properties
v1ObjectTagsEntity
object
Object identity meta with tags
3 properties
v1PackType
string
v1EdgeHostDeviceHostCheckSum
object
1 property
v1EdgeHostDeviceStatus
object
EdgeHostDeviceStatus defines the observed state of EdgeHostDevice
8 properties
v1Disk
object
4 properties
v1SpectroClusterVariable
object
Variable with value which will be used within the packs of cluster profile
2 properties 1 required
v1EdgeHostDeviceHostPairingKey
object
1 property
v1SpectroTunnelConfig
object
Spectro tunnel configuration
2 properties
v1ArchType
string
v1PackTemplateParameters
object
Pack template parameters
2 properties
v1EdgeHostDeviceSpec
object
EdgeHostDeviceSpec defines the desired state of EdgeHostDevice
9 properties
v1Time
string
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time pack…
v1ClusterProfileTemplate
object
ClusterProfileTemplate contains details of a clusterprofile definition
10 properties
v1PackRef
object
PackRef server/name:tag to point to a pack PackRef is used when construct a ClusterProfile PackSpec is used for UI to render the parameters form ClusterProfile…
18 properties 2 required
v1EdgeHostClusterEntity
object
1 property
v1Manifest
object
Manifest object
2 properties
v1EdgeTokenStatus
object
Edge token status
1 property
v1EdgeHostIdentity
object
4 properties
v1PackValuesEntity
object
Pack values entity to refer the existing pack for the values override
5 properties 1 required
v1ServicePort
object
2 properties 1 required
v1EdgeHostHealth
object
EdgeHostHealth defines the desired health state of EdgeHostDevice
3 properties
v1EdgeHostMeta
object
6 properties
v1SpectroClusterProfile
object
Cluster profile response
2 properties
v1EdgeTokenSpec
object
Edge token specification
3 properties
v1SpectroClusterPacksStatusEntity
object
1 property
v1EdgeTokenSpecUpdate
object
Edge token spec to be updated
2 properties
v1EdgeHostDeviceMetaUpdateEntity
object
Edge host device uid and name
1 property
v1EdgeTokenEntity
object
Edge token request payload
2 properties
v1PackSchema
object
PackSchema defines the schema definition, hints for the pack values
8 properties
v1ObjectReference
object
ObjectReference contains enough information to let you inspect or modify the referred object.
3 properties
v1SpectroClusterProfileList
object
1 property 1 required
v1ClusterPackStatus
object
9 properties
v1EdgeHostConfig
object
2 properties
v1EdgeHostSSHSecret
object
2 properties
v1EdgeHostDeviceEntity
object
Edge host device information
2 properties
v1PackTemplate
object
Pack template configuration
3 properties
v1VsphereComputeCluster
object
Vsphere compute cluster
4 properties
v1SpectroClusterPackStatusEntity
object
7 properties
v1Partition
object
5 properties
v1SpcApplySettings
object
1 property
v1EdgeTokens
object
1 property 1 required
v1EdgeHostDevices
object
2 properties 1 required
v1GPUDeviceSpec
object
7 properties
v1ObjectEntity
object
Object identity meta
2 properties
v1ManifestRefUpdateEntity
object
Manifest update request payload
3 properties 1 required
v1VsphereCloudDatacenter
object
Vsphere datacenter
3 properties
v1EdgeClusterObjectEntity
object
Object identity meta of the cluster
3 properties
v1SshTunnelStatus
object
4 properties
v1Nic
object
7 properties
v1PackPreset
object
PackPreset defines the preset pack values
5 properties
v1ProfileStatus
object
1 property
v1PackSummaryStatus
object
Pack status
v1EdgeHost
object
EdgeHost is the underlying appliance
10 properties 2 required
v1ClusterPackManifestStatus
object
3 properties
v1LoadBalancerService
object
3 properties
v1SpectroClusterPackCondition
object
4 properties
v1EdgeToken
object
Edge token information
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

spectro-cloud-edgehosts-api-openapi.yml Raw ↑

Other APIs Spectro Cloud publishes across the network.

Spectro Cloud activations API
Spectro Cloud apiKeys API
Spectro Cloud appDeployments API
Spectro Cloud appProfiles API
Spectro Cloud audits API
Spectro Cloud auth API
Spectro Cloud cloudaccounts API
Spectro Cloud cloudconfigs API
Spectro Cloud clouds API
Spectro Cloud clustergroups API
Spectro Cloud clusterprofiles API
Spectro Cloud clusterTemplates API
Where this information came from

This is an independent, third-party profile of Spectro Cloud edgehosts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.