Spectro Cloud edge-mgmt API
The edge-mgmt API from Spectro Cloud — 64 operation(s) for edge-mgmt.
Spectro Cloud edge-mgmt 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 edge-mgmt. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 84 operations across 64 paths, and defines 139 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.
84 operations
64 paths
139 schemas
7 DELETE43 GET3 PATCH20 POST11 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Spectro Cloud edge-mgmt 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 84
Across 64 paths, the API surfaces 84 operations — 7 DELETE, 43 GET, 3 PATCH, 20 POST, 11 PUT. Each is listed below with its method, path, parameters, and response codes.
edge-mgmt 84
GET
/v1/edge-mgmt/cluster
Get the details of the cluster.
POST
/v1/edge-mgmt/cluster
Creates a cluster with the provided cluster configuration
DELETE
/v1/edge-mgmt/cluster
Delete a cluster
PATCH
/v1/edge-mgmt/clusterdeprecated
DEPRECATED - This endpoint is deprecated and will be removed in future versions. Use /v1/edge-mgmt/cluster/{clusterName} instead
GET
/v1/edge-mgmt/cluster/applications
list the details of the cluster’s packs.
GET
/v1/edge-mgmt/cluster/certificates
Get Cluster Certificates Info
GET
/v1/edge-mgmt/cluster/details
Get Edge Cluster details
GET
/v1/edge-mgmt/cluster/events
List cluster events
POST
/v1/edge-mgmt/cluster/pair
Creates a pairing request
GET
/v1/edge-mgmt/cluster/pair/details
Get all existing pairing requests
POST
/v1/edge-mgmt/cluster/pair/reject
Rejects a pairing request
POST
/v1/edge-mgmt/cluster/pair/verify-connection
Verifies whether all cluster hosts are able to connect to palette
PUT
/v1/edge-mgmt/cluster/profiles
Updates a cluster with the provided cluster configuration
POST
/v1/edge-mgmt/cluster/profiles/variables/validate
Validate cluster profile variables
GET
/v1/edge-mgmt/cluster/registry/content/details
List existing Harbor Content Details
GET
/v1/edge-mgmt/cluster/registry/content/sync-status/details
List Harbor Content Sync Status
GET
/v1/edge-mgmt/cluster/registry/health
Gets the harbor health status
POST
/v1/edge-mgmt/cluster/renew-certificates
Renew Cluster Certificates
PUT
/v1/edge-mgmt/cluster/settings
Update cluster settings
PUT
/v1/edge-mgmt/cluster/{clusterName}
Updates a cluster with the provided cluster configuration
PATCH
/v1/edge-mgmt/cluster/{clusterName}
Patch a cluster with the provided cluster configuration
GET
/v1/edge-mgmt/clusters/archive/embedded/details
parses the preloaded cluster-config archive if it was included in the ISO.
GET
/v1/edge-mgmt/clusters/archive/overridden/details
parses the cluster-config archive if it exists.
DELETE
/v1/edge-mgmt/clusters/archive/update
Delete or reject the cluster update archive
GET
/v1/edge-mgmt/clusters/archive/update/details
parses the cluster-config update archive if it was included in the uploaded content-bundle.
GET
/v1/edge-mgmt/clusters/current/machinepools
Fetch the cluster node pool details including edge host details.
POST
/v1/edge-mgmt/clusters/current/machinepools
Create a machine pool
PUT
/v1/edge-mgmt/clusters/current/machinepools/{poolName}
Update machine pools
DELETE
/v1/edge-mgmt/clusters/current/machinepools/{poolName}
Delete machine pools
PATCH
/v1/edge-mgmt/clusters/current/machinepools/{poolName}
Patch machine pools
DELETE
/v1/edge-mgmt/clusters/current/machinepools/{poolName}/nodes/{nodeName}
Delete a machine pool node
GET
/v1/edge-mgmt/clusters/current/nodes
A list of the K8s Cluster Nodes
GET
/v1/edge-mgmt/edgehosts/connectivity/ping
Ping an endpoint
GET
/v1/edge-mgmt/edgehosts/connectivity/traceroute
Display route that IP packets take to a network host
GET
/v1/edge-mgmt/edgehosts/current
Get edge host info
GET
/v1/edge-mgmt/edgehosts/current/actions/content/signing-public-key
Get the public key used to verify the signed content.
POST
/v1/edge-mgmt/edgehosts/current/actions/reboot
Reboot edge host
POST
/v1/edge-mgmt/edgehosts/current/actions/reset
Reset edge host
POST
/v1/edge-mgmt/edgehosts/current/actions/shutdown
Shutdown edge host
POST
/v1/edge-mgmt/edgehosts/current/actions/upload-clusterconfig
Uploads the cluster config archive and extracts it to the required location on the edge host.
POST
/v1/edge-mgmt/edgehosts/current/actions/upload-content
Uploads an archive file and extracts it to the required location on the edge host.
GET
/v1/edge-mgmt/edgehosts/current/audits
Retrieves the list of audit logs
GET
/v1/edge-mgmt/edgehosts/current/audits/download
Download audit logs
GET
/v1/edge-mgmt/edgehosts/current/audits/filters
Retrieves the list of filter options to display on audit ui page
GET
/v1/edge-mgmt/edgehosts/current/configurations
Get edge host configurations.
PUT
/v1/edge-mgmt/edgehosts/current/configurations
Update Edge Host configurations
GET
/v1/edge-mgmt/edgehosts/current/configurations/status
Edge host configurations status
GET
/v1/edge-mgmt/edgehosts/current/download-logs
Download edge host Logs
GET
/v1/edge-mgmt/edgehosts/current/error-logs
List last 'logCount' edge host error logs
GET
/v1/edge-mgmt/edgehosts/current/file-download/files
List custom files from the '/var/log/files' directory
GET
/v1/edge-mgmt/edgehosts/current/file-download/{filePath}
Download a custom file from the user-defined or default directory
POST
/v1/edge-mgmt/edgehosts/current/generate-logs
Start edge host log collection
GET
/v1/edge-mgmt/edgehosts/current/generate-logs-status
Edge host log collection status
POST
/v1/edge-mgmt/edgehosts/current/link
Link edge host to another edge host
POST
/v1/edge-mgmt/edgehosts/current/link/generate-token
Generate a link token for linking edge hosts
GET
/v1/edge-mgmt/edgehosts/current/link/status
Get the status of the edge host link
POST
/v1/edge-mgmt/edgehosts/current/unlink
Unlink edge host from other edge hosts
GET
/v1/edge-mgmt/edgehosts/current/uploaded-content/details
Get metadata of last uploaded content archive file
GET
/v1/edge-mgmt/edgehosts/current/userdata
Get edge host userdata
PUT
/v1/edge-mgmt/edgehosts/current/userdata
Update edge host userdata
POST
/v1/edge-mgmt/edgehosts/current/userdata
Update edge host userdata
GET
/v1/edge-mgmt/events/lifecycle
Get life cycle events of cluster and edge host
GET
/v1/edge-mgmt/network/bonds
List bonds
GET
/v1/edge-mgmt/network/bonds/{name}
Get bond
PUT
/v1/edge-mgmt/network/bonds/{name}
Create or update bond
POST
/v1/edge-mgmt/network/bonds/{name}
Create bond
DELETE
/v1/edge-mgmt/network/bonds/{name}
Delete bond
GET
/v1/edge-mgmt/network/bridges
List bridges
GET
/v1/edge-mgmt/network/bridges/{name}
Get bridge
PUT
/v1/edge-mgmt/network/bridges/{name}
Create or update bridge
POST
/v1/edge-mgmt/network/bridges/{name}
Create bridge
DELETE
/v1/edge-mgmt/network/bridges/{name}
Delete bridge
GET
/v1/edge-mgmt/network/config-options
Get network config options
GET
/v1/edge-mgmt/network/interfaces
List NICs
GET
/v1/edge-mgmt/network/interfaces/{name}
Get NIC
PUT
/v1/edge-mgmt/network/interfaces/{name}/config
Update NIC config
GET
/v1/edge-mgmt/network/management-interface
Get the currently selected management interface and the candidate list
PUT
/v1/edge-mgmt/network/management-interface
Set the management interface
GET
/v1/edge-mgmt/network/vlans
List VLANs
GET
/v1/edge-mgmt/network/vlans/{name}
Get VLAN
PUT
/v1/edge-mgmt/network/vlans/{name}
Create or update VLAN
POST
/v1/edge-mgmt/network/vlans/{name}
Create VLAN
DELETE
/v1/edge-mgmt/network/vlans/{name}
Delete VLAN
GET
/v1/edge-mgmt/settings
Get general settings
Schemas 139
The contract defines 139 schemas that model the data the API accepts and returns. The most detailed are v1Bond (16 properties), v1EdgeNativeMachinePoolConfig (16 properties), v1NicSummary (14 properties), v1VLAN (13 properties). Each schema is shown below with its type and property counts.
v1Pack
object
4 properties
v1EdgeHostInfo
object
EdgeHostInfo is the information about the edge host.
3 properties
v1EdgeHostConfigurations
object
4 properties
v1OS
object
4 properties
v1AuditMeta
object
2 properties
v1EdgeNativeCloudConfig
object
EdgeNativeCloudConfig is the Schema for the edgenativecloudconfigs API
2 properties
v1EdgeHostConfigurationStatus
object
2 properties
v1BadRequest
Bad request
v1EdgeNativeClusterConfig
object
EdgeNativeClusterConfig defines Edge Native Cluster specific Spec
6 properties
v1ClusterNodePoolSpec
object
ClusterNodePool provides details about cluster node pool.
2 properties
v1ClusterSpec
object
ClusterSpec is the specification of the cluster.
6 properties
uploadResponse
object
2 properties
v1HarborHealthDetails
object
6 properties
v1EdgeNativeMachinePoolConfig
object
16 properties
1 required
v1ContentSigningKey
object
3 properties
v1MachinePoolPatch
object
1 property
v1HarborContentsSyncStatus
object
3 properties
v1NTP
object
7 properties
v1CPU
object
1 property
v1Bond
object
Bond interface configuration
16 properties
v1NodeInfo
object
8 properties
v1NetworkInterface
object
4 properties
1 required
v1LinkToken
object
3 properties
v1ManagementInterfaceCandidate
object
4 properties
2 required
v1UpdateStrategy
object
UpdatesStrategy will be used to translate to RollingUpdateStrategy of a MachineDeployment We'll start with default values for the translation, can expose more…
1 property
v1BondConfigOptions
object
Valid configuration options for bond interfaces
3 properties
v1ClusterNodes
object
1 property
v1CA
object
4 properties
v1LinkStatus
object
3 properties
v1EventSource
object
Event source info
2 properties
v1VLAN
object
VLAN interface configuration
13 properties
v1HarborContentsDetails
object
1 property
v1ListMetaData
object
ListMeta describes metadata for the resource listing
3 properties
v1ClusterPairVerifiedConnectionResponse
object
2 properties
v1ClusterPairInfoResponse
object
Cluster Pair Info received from palette
1 property
v1Memory
object
1 property
v1ValidateVariableResponse
object
6 properties
v1Error
object
4 properties
v1ClusterCurrentApplications
object
1 property
v1ValidateVariablesResponse
object
1 property
v1NodeRole
string
v1NicSummary
object
14 properties
v1Health
object
Health provides details about the resource health.
2 properties
v1ObjectMeta
object
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
10 properties
v1ManagementInterfaceUpdateRequest
object
1 property
1 required
v1ClusterConfiguration
object
v1ClusterConfiguration is the configuration required to create a cluster.
2 properties
v1Condition
object
6 properties
2 required
v1CloudInit
object
6 properties
v1Management
object
5 properties
1 required
v1Variable
object
13 properties
v1ClusterStatus
object
ClusterStatus provides the status of the cluster.
12 properties
v1EdgeHostGenerateLogsStatus
object
Edge host log collection status
2 properties
v1ValidateVariables
object
v1 Validate Variables is for validating the variables
3 properties
v1EdgeNativeClusterSettings
object
EdgeNativeClusterSettings defines Edge Native Cluster specific settings
2 properties
v1HarborContentSyncStatus
object
10 properties
v1State
string
v1AuditResourceReference
object
Audit resource object
3 properties
v1VLANRequest
object
VLAN interface request payload
9 properties
3 required
v1CertificateDetails
object
3 properties
v1ConditionOrder
object
5 properties
v1ClusterNodePoolStatus
object
2 properties
v1PackInfo
object
11 properties
v1ClusterPatch
object
1 property
v1EdgeHostSpec
object
EdgeHostSpec is the specification of the edge host.
7 properties
v1NotFoundResponseWithMessage
object
Resource not found with message
1 property
v1EdgeHostStatus
object
EdgeHostStatus is the status of the edge host.
6 properties
v1EdgeNativeControlPlaneEndPoint
object
3 properties
v1PackCondition
object
4 properties
v1Events
object
1 property
1 required
v1Disk
object
Disk is the specification of the disks on the edge host.
4 properties
v1ClusterNodeStatus
object
7 properties
v1HttpPatch
object
3 properties
2 required
apiError
string
v1ArchType
string
Architecture type of the edge host
v1LifecycleEvents
object
events representing lifecycle of cluster and edge host
3 properties
v1ClusterNodePool
object
3 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…
v1Event
object
Event information organized by tags
7 properties
v1PingResponse
object
1 property
v1ClusterProfileTemplate
object
7 properties
v1NotFound
Resource not found
v1ManagementMode
string
v1ConditionCategoryOrder
object
3 properties
v1ClusterProfileDetail
object
8 properties
v1FileMetadataList
object
1 property
v1Port
object
Port provides details about port.
6 properties
v1ClusterNode
object
11 properties
v1ClusterPairMeta
object
3 properties
v1HostInfo
object
3 properties
v1EdgeNativeOverlayNetworkConfiguration
object
2 properties
v1BondList
object
Collection of bond interfaces
1 property
v1ClusterNodeCondition
object
4 properties
v1AuditFilterObect
object
v1ValidataVariable
object
3 properties
v1Audit
object
Audit response payload
2 properties
v1AuditActor
object
Audit actor object
2 properties
v1NetworkInterfaceUpdateRequest
object
8 properties
1 required
v1AcceptedResponseWithMessage
object
Accepted response with message
1 property
v1EdgeNativeHost
object
EdgeNativeHost is the underlying appliance
12 properties
v1UploadedContentDetails
object
6 properties
v1AuditsList
object
2 properties
1 required
v1ChildCerts
object
4 properties
v1BridgeRequest
object
Bridge interface request payload
9 properties
1 required
v1ObjectReference
object
ObjectReference contains enough information to let you inspect or modify the referred object.
7 properties
v1AuditSpec
object
Audit specifications
4 properties
v1ManagementInterface
object
2 properties
2 required
v1Settings
object
3 properties
v1TraceRouteResponse
object
1 property
v1Cluster
object
Cluster provides details about cluster.
3 properties
v1NetworkConfigOptions
object
Valid configuration options for network components
1 property
v1RelatedObject
object
The object for which the event is related
3 properties
v1BondRequest
object
Bond interface request payload
13 properties
1 required
v1Partition
object
Partition is the specification of the partitions on the disk.
5 properties
v1PackContent
object
4 properties
v1MetaData
object
MetaData defines the metadata for the resource.
6 properties
v1HardwareSpec
object
HardwareSpec is the specification of the hardware of the edge host.
6 properties
v1ClusterProfileConfiguration
object
v1ClusterProfileConfiguration is the configuration required to update a cluster's profiles.
2 properties
v1FileMetadata
object
4 properties
v1GPUDeviceSpec
object
7 properties
v1Bridge
object
Bridge interface configuration
11 properties
v1RegistryCredentials
object
7 properties
v1EdgeNativeCloudConfigSpec
object
EdgeNativeCloudConfigSpec defines the desired state of EdgeNativeCloudConfig
2 properties
2 required
v1DNS
object
3 properties
v1NetworkConfig
object
5 properties
v1ConnectionMode
string
v1MachinePoolProperties
object
Machine pool specific properties
1 property
v1Taint
object
Taint
4 properties
v1Nic
object
Nic is the specification of the network interface card on the edge host.
7 properties
v1BridgeList
object
Collection of bridge interfaces
1 property
v1Service
object
ClusterService provides details about services in cluster.
3 properties
v1HarborContentDetails
object
5 properties
v1ClusterConfigArchiveDetails
object
2 properties
v1EdgeHost
object
4 properties
v1LinkPeer
object
10 properties
v1VLANList
object
Collection of VLAN interfaces
1 property
v1ProfileVariable
object
3 properties
v1ClusterPairDetailsResponse
object
6 properties
v1NicSummaryList
object
1 property
v1Configuration
string
Configuration status of the edge host.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Spectro Cloud 12
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
#edge-mgmt
Where this information came from
This is an independent, third-party profile of Spectro Cloud edge-mgmt 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.