Spectro Cloud overlords API
The overlords API from Spectro Cloud — 29 operation(s) for overlords.
Spectro Cloud overlords 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 overlords. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 40 operations across 29 paths, and defines 97 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.
40 operations
29 paths
97 schemas
3 DELETE14 GET13 POST10 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Spectro Cloud overlords 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 40
Across 29 paths, the API surfaces 40 operations — 3 DELETE, 14 GET, 13 POST, 10 PUT. Each is listed below with its method, path, parameters, and response codes.
overlords 40
GET
/v1/overlords
Retrieves a list of overlords owned by the tenant
GET
/v1/overlords/apache-cloudstack/manifest
Returns the manifests required for the private gateway installation
POST
/v1/overlords/apache-cloudstack/{uid}/account
create the CloudStack cloudaccount for the private gateway
PUT
/v1/overlords/apache-cloudstack/{uid}/account
update the CloudStack cloudaccount for the private gateway
POST
/v1/overlords/apache-cloudstack/{uid}/account/validate
validate the CloudStack cloudaccount for the private gateway
POST
/v1/overlords/apache-cloudstack/{uid}/cloudconfig
create the CloudStack cloud config for the private gateway
PUT
/v1/overlords/apache-cloudstack/{uid}/cloudconfig
update the CloudStack cloud config for the private gateway
GET
/v1/overlords/apache-cloudstack/{uid}/clusterprofile
Returns the specified CloudStack private gateway cluster profile
GET
/v1/overlords/maas/manifest
Returns the manifests required for the private gateway installation
POST
/v1/overlords/maas/{uid}/account
create the maas cloudaccount for the private gateway
PUT
/v1/overlords/maas/{uid}/account
update the maas cloudaccount for the private gateway
POST
/v1/overlords/maas/{uid}/account/validate
validate the maas cloudaccount for the private gateway
POST
/v1/overlords/maas/{uid}/cloudconfig
create the maas cloud config for the private gateway
PUT
/v1/overlords/maas/{uid}/cloudconfig
update the maas cloud config for the private gateway
GET
/v1/overlords/maas/{uid}/clusterprofile
Returns the specified maas private gateway cluster profile
GET
/v1/overlords/maas/{uid}/pools
Retrieves a list of IP Pools for the specified maas private gateway
POST
/v1/overlords/maas/{uid}/pools
Creates an IP pool definition for the specified maas private gateway
DELETE
/v1/overlords/maas/{uid}/pools/{poolUid}
Deletes the maas private gateway's specified IP Pool data
PUT
/v1/overlords/maas/{uid}/pools/{poolUid}
Updates the maas private gateway's specified IP Pool data
POST
/v1/overlords/migrate
migrate all the clusters from source overlord to target overlord
GET
/v1/overlords/pairing/code
Returns the pairing code for the private gateway
GET
/v1/overlords/vsphere/manifest
Returns the manifests required for the private gateway installation
GET
/v1/overlords/vsphere/ova
Returns overlord's ova information
POST
/v1/overlords/vsphere/tenants/{tenantUid}/system
Creates the system private gateway for the specified tenant
POST
/v1/overlords/vsphere/{uid}/account
create the vSphere cloudaccount for the private gateway
PUT
/v1/overlords/vsphere/{uid}/account
update the vSphere cloudaccount for the private gateway
POST
/v1/overlords/vsphere/{uid}/account/validate
validate the vSphere cloudaccount for the private gateway
POST
/v1/overlords/vsphere/{uid}/cloudconfig
create the vSphere cloud config for the private gateway
PUT
/v1/overlords/vsphere/{uid}/cloudconfig
update the vSphere cloud config for the private gateway
GET
/v1/overlords/vsphere/{uid}/clusterprofile
Returns the specified vsphere private gateway cluster profile
GET
/v1/overlords/vsphere/{uid}/pools
Retrieves a list of IP Pools for the specified private gateway
POST
/v1/overlords/vsphere/{uid}/pools
Creates an IP pool defintion for the sepcified private gateway
DELETE
/v1/overlords/vsphere/{uid}/pools/{poolUid}
Deletes the private gateways's specified IP Pool data
PUT
/v1/overlords/vsphere/{uid}/pools/{poolUid}
Updates the private gateways's specified IP Pool data
GET
/v1/overlords/vsphere/{uid}/properties/computecluster/resources
Retrieves the vSphere computecluster resources for the specified private gateway's account
GET
/v1/overlords/vsphere/{uid}/properties/datacenters
Retrieves the vSphere datacenters & datacluster for the specified private gateway's account
DELETE
/v1/overlords/{uid}
delete the private gateway
GET
/v1/overlords/{uid}
Returns the specified private gateway's for the given uid
PUT
/v1/overlords/{uid}/metadata
update the private gateway's metadata
PUT
/v1/overlords/{uid}/reset
reset the private gateway by disaaociating the private gateway's resources
Schemas 97
The contract defines 97 schemas that model the data the API accepts and returns. The most detailed are v1PackRef (18 properties), v1ClusterProfileTemplate (10 properties), v1ClusterConfigEntity (10 properties), v1VspherePlacementConfigEntity (9 properties). Each schema is shown below with its type and property counts.
v1VspherePlacementConfigEntity
object
Both ClusterConfig and MachinePoolConfig will have PlacementConfig MachinePoolconfig.Placements will overwrite values defined in ClusterConfig Currently the co…
9 properties
v1OverlordVsphereAccountEntity
object
2 properties
v1IpPoolStatus
object
IP Pool status
4 properties
v1ClusterRbacSpec
object
Cluster RBAC spec
3 properties
v1IpPoolEntity
object
IP Pool entity definition
3 properties
v1ObjectMetaUpdateEntity
object
ObjectMeta update entity with uid as input
4 properties
v1OverlordMigrateEntity
object
2 properties
v1SpectroClusterHealthCondition
object
Spectro cluster health condition
3 properties
v1VsphereCloudAccount
object
4 properties
3 required
v1DeletedMsg
object
Deleted response with message
1 property
v1GpuConfig
object
GPU configuration for resource allocation
2 properties
v1PairingCode
object
Pairing code response
1 property
v1MaasClusterConfig
object
Cluster level configuration for MAAS cloud and applicable for all the machine pools
5 properties
1 required
v1UpdatedMsg
object
Update response with message
1 property
v1OverlordMaasCloudConfig
object
5 properties
v1OverlordVsphereCloudConfig
object
4 properties
v1LifecycleConfig
object
1 property
v1OverloadVsphereOva
object
Overload ova details
1 property
v1ProjectResourceReference
object
Project-scoped resource reference
4 properties
v1OverlordMaasAccountEntity
object
2 properties
v1IpPoolInputEntity
object
IP Pool input entity definition
2 properties
v1ClusterRbacBinding
object
Cluster RBAC binding
4 properties
v1VsphereDatacenter
object
List of Datacenter with computeclusters
3 properties
v1ObjectResReference
object
Object resource reference
5 properties
v1ObjectMeta
object
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
7 properties
v1Uid
object
1 property
1 required
v1ObjectMetaInputEntity
object
ObjectMeta input entity for object creation
3 properties
v1MachineManagementConfig
object
1 property
v1VsphereDatacenters
object
List of Datacenters with computeclusters
1 property
1 required
v1MaasMachineConfigEntity
object
5 properties
v1SpectroClusterHealthStatus
object
Spectro cluster health status
4 properties
v1SpectroClusterProfileEntity
object
Cluster profile request payload
4 properties
v1Pool
object
Pool defines IP ranges or with CIDR for available IPs Gateway, Prefix and Nameserver if provided, will overwrite values in IPPool
6 properties
v1PackType
string
v1CloudStackNetworkSpec
object
Enhanced network configuration for CloudStack
8 properties
v1ClusterNamespaceResourceInputEntity
object
Cluster Namespace resource definition
2 properties
v1ClusterConfigEntity
object
10 properties
v1OverlordVsphereAccountCreate
object
3 properties
v1HostClusterEndpointConfig
object
2 properties
v1ClusterRoleRef
object
Cluster role ref
2 properties
v1ClusterProfileSpec
object
ClusterProfileTemplate can be in draft mode, or published mode User only see the latest published template, and (or) the draft template User can apply either t…
4 properties
v1ClusterNamespaceSpec
object
Cluster namespace spec
3 properties
v1SpectroClusterVariable
object
Variable with value which will be used within the packs of cluster profile
2 properties
1 required
v1OverlordManifest
object
overlord manifest
1 property
v1Nameserver
object
Nameserver define search domains and nameserver addresses
2 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
v1OsPatchConfig
object
4 properties
v1PackValuesEntity
object
Pack values entity to refer the existing pack for the values override
5 properties
1 required
v1ClusterRbacSubjects
object
Cluster role ref
3 properties
v1InstanceConfig
object
6 properties
v1OverlordCloudStackAccountCreate
object
3 properties
v1VsphereOverlordClusterConfigEntity
object
5 properties
v1CloudStackVPCSpec
object
VPC configuration for CloudStack networks
4 properties
v1CloudStackResource
object
Cloud stack resource information
2 properties
v1OverloadStatus
object
Overload status
6 properties
v1ControlPlaneEndPoint
object
3 properties
v1MaasCloudAccount
object
3 properties
2 required
v1HostClusterEndpoint
object
2 properties
v1Overlords
object
Array of Overlords
1 property
1 required
v1PackSchema
object
PackSchema defines the schema definition, hints for the pack values
8 properties
v1ClusterProfileVersion
object
Cluster profile with version
2 properties
v1LoadBalancerConfig
object
Load balancer configuration for exposing the virtual cluster's kube-apiserver
3 properties
v1ObjectReference
object
ObjectReference contains enough information to let you inspect or modify the referred object.
3 properties
v1OverloadSpec
object
Overload spec
7 properties
v1ObjectMetaInputEntitySchema
object
Resource metadata
1 property
1 required
v1RelatedObject
object
Object for which the resource is related
3 properties
v1IngressConfig
object
Ingress configuration for exposing the virtual cluster's kube-apiserver
2 properties
v1CloudStackZoneSpec
object
CloudStack zone with its network configuration
3 properties
v1ClusterNamespaceResourceAllocation
object
Cluster namespace resource allocation
3 properties
v1VsphereComputeCluster
object
Vsphere compute cluster
4 properties
v1CloudStackClusterConfig
object
Cluster level configuration for CloudStack cloud, same for all machinepools
6 properties
v1ClusterProfile
object
ClusterProfile is the Schema for the clusterprofiles API
5 properties
v1HyperShiftConfig
object
HyperShiftConfig defines the configuration for HyperShift and OpenShift clusters. This configuration is only applicable to MaaS clusters.
2 properties
v1CloudStackNetworkConfig
object
Network configuration for CloudStack instances
2 properties
v1VsphereComputeClusterResources
object
Datacenter and its resources like datastore, resoucepool, folders
2 properties
v1HostClusterConfig
object
4 properties
v1OverlordCloudStackAccountEntity
object
2 properties
v1CloudStackMachineConfigEntity
object
4 properties
1 required
v1ManifestRefUpdateEntity
object
Manifest update request payload
3 properties
1 required
v1OverlordMaasAccountCreate
object
3 properties
v1ClusterLocation
object
Cluster location information
5 properties
v1OverlordCloudStackCloudConfig
object
5 properties
v1PackPreset
object
PackPreset defines the preset pack values
5 properties
v1ClusterNotificationStatus
object
Cluster notifications status
2 properties
v1VsphereNetworkConfigEntity
object
3 properties
1 required
v1IpPools
object
1 property
1 required
v1ClusterRbacInputEntity
object
Cluster RBAC role binding defintion
2 properties
v1ClusterDeploymentType
string
Defines the deployment type for HyperShift-enabled clusters. - 'hypershift': Indicates a HyperShift management cluster that hosts control planes for other clus…
v1GeolocationLatlong
object
Geolocation Latlong entity
2 properties
v1ClusterProfileStatus
object
ClusterProfileStatus defines the observed state of ClusterProfile
5 properties
v1ClusterResourcesEntity
object
2 properties
v1MaasNetworkConfigEntity
object
3 properties
1 required
v1CloudStackCloudAccount
object
CloudStack cloud account credentials
5 properties
3 required
v1MaasInstanceType
object
3 properties
v1Overlord
object
Overlord defintiion
4 properties
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
#overlords
Where this information came from
This is an independent, third-party profile of Spectro Cloud overlords 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.