Spectro Cloud system API
The system API from Spectro Cloud — 95 operation(s) for system.
Spectro Cloud system 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 System. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 150 operations across 95 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.
150 operations
95 paths
139 schemas
8 DELETE62 GET18 PATCH10 POST52 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Spectro Cloud system 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 150
Across 95 paths, the API surfaces 150 operations — 8 DELETE, 62 GET, 18 PATCH, 10 POST, 52 PUT. Each is listed below with its method, path, parameters, and response codes.
system 150
POST
/v1/system/activate
Validates activation key, updates plan, logs activation, updates cache
GET
/v1/system/activation
Returns system activations doc, to be used in sysadmin console
PATCH
/v1/system/admin/email
email reset for system admin
PATCH
/v1/system/admin/password/reset
password reset for system admin
GET
/v1/system/admins
Lists users
POST
/v1/system/admins
Create a System Administrator
PATCH
/v1/system/admins/auth/password/{passwordToken}/activate
Updates and Activates the specified System Administrator password using the password token
DELETE
/v1/system/admins/{uid}
Deletes the specified System Administrator
GET
/v1/system/admins/{uid}
Returns the specified System Administrator information
PATCH
/v1/system/admins/{uid}/changePassword
System Administrator password change request through the verification of the current password
PUT
/v1/system/admins/{uid}/passwordResetLink
Reset password link for a specified System Administrator
PATCH
/v1/system/admins/{uid}/profile
Update User
GET
/v1/system/alerts
get the alerts specified for the system
DELETE
/v1/system/alerts/{component}
Deletes the specified alert to the specified system
PUT
/v1/system/alerts/{component}
Upsert the specified alert to the specified system
GET
/v1/system/appFeatures
Get system app features
PUT
/v1/system/appFeatures
Update system app features
GET
/v1/system/authTokenSettings
Get system auth token settings
PUT
/v1/system/authTokenSettings
Update system auth token settings
GET
/v1/system/classificationBanner
Get system classification banner
PUT
/v1/system/classificationBanner
Update system classification banner
GET
/v1/system/config/apache-cloudstack/image
get the system cloudstack image
PUT
/v1/system/config/apache-cloudstack/image
updates the system default cloudstack devops image
GET
/v1/system/config/auth
get the system config auth
PUT
/v1/system/config/auth
Updates the system config auth
GET
/v1/system/config/aws/account
get the system config aws devops account
PUT
/v1/system/config/aws/account
updates the system config aws devops account
GET
/v1/system/config/aws/apiEndpoints
Get AWS API endpoints configuration
PUT
/v1/system/config/aws/apiEndpoints
Update AWS API endpoints configuration
GET
/v1/system/config/aws/image
get the system aws image
PUT
/v1/system/config/aws/image
updates the system default aws devops image
GET
/v1/system/config/aws/marketplace/account
get the system config aws marketplace account
PUT
/v1/system/config/aws/marketplace/account
updates the system config aws marketplace account
GET
/v1/system/config/aws/sts/account
get the system config aws sts devops account
PUT
/v1/system/config/aws/sts/account
updates the system config AWS sts devops account
GET
/v1/system/config/awsgov/sts/account
get the system config AWS gov sts devops account
POST
/v1/system/config/awsgov/sts/account
Create the system config AWS gov sts devops account
PUT
/v1/system/config/awsgov/sts/account
Updates the system config AWS gov sts devops account
GET
/v1/system/config/azure/account
get the system azure account
PUT
/v1/system/config/azure/account
updates the system default azure devops account
GET
/v1/system/config/azure/storage
get the system azure storage
PUT
/v1/system/config/azure/storage
updates the system default azure devops storage
GET
/v1/system/config/certificate
get the system certificates
PUT
/v1/system/config/certificate
updates the system certificate
GET
/v1/system/config/cluster
get the system config cluster
PUT
/v1/system/config/cluster
Updates the system config cluster
GET
/v1/system/config/database/backup/
Deprecated. Use the config specific apis.
PUT
/v1/system/config/database/backup/
updates the system backup config
GET
/v1/system/config/database/backup/ftp
get the system backup interval config
PUT
/v1/system/config/database/backup/ftp
updates the system backup interval config
GET
/v1/system/config/database/backup/s3
get the system backup s3 config
PUT
/v1/system/config/database/backup/s3
updates the system backup ftp storage config
GET
/v1/system/config/domain
get the system domain config
PATCH
/v1/system/config/domain
update domain host url
GET
/v1/system/config/domain/certificates
get the system domain config
PUT
/v1/system/config/domain/certificates
update domain host url and its certificates
GET
/v1/system/config/edge/image
get the system edge image
PUT
/v1/system/config/edge/image
updates the system default edge devops image
GET
/v1/system/config/edgeNative/image
get the system edge-native image
PUT
/v1/system/config/edgeNative/image
updates the system default edge-native devops image
POST
/v1/system/config/ftp/validate
validates the ftp config
GET
/v1/system/config/gcp/account
get the system gcp account
PUT
/v1/system/config/gcp/account
updates the system default gcp devops account
GET
/v1/system/config/gcp/image
get the system gcp image
PUT
/v1/system/config/gcp/image
updates the system default gcp devops image
GET
/v1/system/config/imagePullSecret
get the system DHI image pull secret config
PUT
/v1/system/config/imagePullSecret
create or update the system DHI image pull secret config
PUT
/v1/system/config/keyValueStore
Updates the specified property for the key
DELETE
/v1/system/config/keyValueStore/{key}
Deletes the specified property for the key
GET
/v1/system/config/keyValueStore/{key}
Gets the specified property for the key
GET
/v1/system/config/kubectl
get the system web kubectl config
PUT
/v1/system/config/kubectl
updates the system web kubectl config
GET
/v1/system/config/logger
get the system logger
PUT
/v1/system/config/logger
updates the system logger
GET
/v1/system/config/maas/image
get the system maas image
PUT
/v1/system/config/maas/image
updates the system default maas devops image
PUT
/v1/system/config/paymentsecrets
updates the payment secrets
GET
/v1/system/config/preferences/billing
get the billing preference
PUT
/v1/system/config/preferences/billing
updates the billing preference
GET
/v1/system/config/preferences/cluster
get the cluster preference
PUT
/v1/system/config/preferences/cluster
updates the cluster preference
GET
/v1/system/config/proxy
get the system proxy
PUT
/v1/system/config/proxy
updates the system proxy
GET
/v1/system/config/registries/oci/image
get the system config oci image registry
PUT
/v1/system/config/registries/oci/image
updates the system config oci image registry
DELETE
/v1/system/config/registries/{registryName}
Deletes the specified Registry
GET
/v1/system/config/registries/{registryName}
Gets the specified Registry
PUT
/v1/system/config/registries/{registryName}
Updates the specified Registry
GET
/v1/system/config/reverseproxy
get the system config reverse proxy
PUT
/v1/system/config/reverseproxy
updates the system config reverse proxy
POST
/v1/system/config/s3/validate
validates the s3 config
GET
/v1/system/config/scar
get the system Spectro repository
PUT
/v1/system/config/scar
updates the system Spectro repository
GET
/v1/system/config/scar/validate
validate existing scar config
GET
/v1/system/config/smtp
get the system smtp
PUT
/v1/system/config/smtp
updates the system smtp
PUT
/v1/system/config/smtp/validate
validates the system smtp
GET
/v1/system/config/sso
get the system sso
PUT
/v1/system/config/sso
updates the system sso
PUT
/v1/system/config/sso/github/validate
validates the system sso for github
PUT
/v1/system/config/sso/oidc/validate
validates the system sso for oidc based logins
GET
/v1/system/config/storage/s3
get the system storage s3 config
PUT
/v1/system/config/storage/s3
updates the system storage config
GET
/v1/system/config/timeseries
get the system timeseries
PUT
/v1/system/config/timeseries
updates the system timeseries
GET
/v1/system/config/vsphere/image
get the system vsphere image
PUT
/v1/system/config/vsphere/image
updates the system default vsphere devops image
PATCH
/v1/system/database/backup
backup the database
GET
/v1/system/database/backups
get the database status
DELETE
/v1/system/database/backups/{backupUid}
delete the database backup
PATCH
/v1/system/database/recovery/{backupUid}/{mode}
recover the database
PATCH
/v1/system/database/restore/{backupUid}
restore the database
POST
/v1/system/encrypt
encrypt the system data
GET
/v1/system/features
Lists all feature flags
PATCH
/v1/system/features/{uid}
Updates the feature permission
GET
/v1/system/loginBanner
Get system login banner settings
PUT
/v1/system/loginBanner
Update system login banner settings
GET
/v1/system/password/policy/default
get the system password policy
PUT
/v1/system/password/policy/default
updates the system admin
DELETE
/v1/system/passwords/blocklist
Delete a list of block listed passwords
PATCH
/v1/system/passwords/blocklist
List of block listed passwords
GET
/v1/system/plan
get the system plan
DELETE
/v1/system/plan/credits/{creditUid}
Deletes the specified Plan's credit data
PUT
/v1/system/plan/credits/{creditUid}
Updates the specified Plan's credit data
POST
/v1/system/plan/freeCredit
Add system free credit
PUT
/v1/system/plan/planLimit
Updates the specified system plan's limit
POST
/v1/system/plan/slaCredit
Adds system sla breach credit
PATCH
/v1/system/plan/startDate
updates the system start date
GET
/v1/system/ratelimit
get the system plan
PATCH
/v1/system/ratelimit
toggles the rate limit
GET
/v1/system/resourceLimits
Get system resource limits
PATCH
/v1/system/resourceLimits
Update system resource limits
GET
/v1/system/security/mode
Get the system security mode
PUT
/v1/system/security/mode
Updates the system security mode
GET
/v1/system/sysplan
Returns system plan document
POST
/v1/system/themes
Stores the theme json fields like logo, name at system level.
GET
/v1/system/themes/active
Returns the active theme
GET
/v1/system/themes/metadata
Returns the metadata of all the themes
DELETE
/v1/system/themes/{uid}
Deletes the theme json fields like logo, name at system level.
GET
/v1/system/themes/{uid}
Get the theme json fields like logo, name at system level.
PUT
/v1/system/themes/{uid}
Updates the theme json fields like logo, name at system level.
PATCH
/v1/system/themes/{uid}/activate
Activates a theme
PATCH
/v1/system/themes/{uid}/deactivate
Deactivates a theme
PATCH
/v1/system/users/email/verify/resend
Re-send the email to the user to be able to verify the email
GET
/v1/system/users/email/{emailToken}/verify
Verifies the system user email using the email token
GET
/v1/system/users/me
Verifies the system user email using the email token
POST
/v1/system/users/password/reset
Creates request to reset system password via email
PATCH
/v1/system/users/password/{passwordToken}/reset
Resets the system user password using the password token
GET
/v1/system/version/installed
get the system installed version
GET
/v1/system/version/latest
get the system latest available version
Schemas 139
The contract defines 139 schemas that model the data the API accepts and returns. The most detailed are v1SystemPasswordPolicySpec (13 properties), v1SystemUserMeStatus (8 properties), v1SystemOciImageRegistry (8 properties), v1Channel (8 properties). Each schema is shown below with its type and property counts.
v1SystemPlanCredit
object
Plan Credit
6 properties
1 required
v1SystemTimeseriesSpec
object
system timeseries config spec
2 properties
v1SystemAwsSpec
object
system aws account specifications
2 properties
v1PaymentSecrets
object
payment secrets
2 properties
v1SystemFeaturesOperation
object
1 property
v1SystemTimeseriesMetrics
object
system timeseries metrics config
4 properties
v1ResourceLimitType
string
v1SystemRetentionPolicy
object
system retention policy
1 property
v1SystemMaasImageSpec
object
system maas account specifications
3 properties
v1ObjectMetaUpdateEntity
object
ObjectMeta update entity with uid as input
4 properties
v1SystemGithubSsoSpec
object
system sso github config spec
4 properties
V1PasswordsBlockList
object
List of blocklisted passwords
1 property
v1SystemPlanLimitSpec
object
Monthly Plan Limit spec
3 properties
v1SystemCryptoInput
object
SystemAdmin
1 property
v1TlsConfiguration
object
TLS configuration
5 properties
v1SystemOidcClientSpec
object
system sso oidc config spec
8 properties
v1SystemResourceLimit
object
3 properties
v1SystemUserMe
object
User information wrt permissions
3 properties
v1SystemCertificatesSpec
object
system certificate in base64 format
4 properties
v1SystemAwsStsAccount
object
System AWS Gov account specifications
3 properties
v1SystemPlanLimitUpdate
object
System Plan limit change update entity
1 property
v1AlertNotificationStatus
object
3 properties
v1SystemAwsImageSpec
object
system aws account specifications
2 properties
v1SystemVersionInfo
object
system version info
1 property
v1AwsApiEndpointsConfig
object
AWS API endpoints configuration containing all partition settings
1 property
v1SystemAzureStorage
object
SystemAdmin
1 property
v1SystemOidcClaims
object
4 properties
v1DeveloperCredit
object
Credits allocated for each tenant/user
4 properties
v1SystemBackupS3ConfigSpec
object
system backup config spec
2 properties
v1SystemProxySpec
object
system proxy config spec
3 properties
v1SystemCertificateSpec
object
system smtp config spec
4 properties
v1SystemAdminActivation
object
System Administrator Activation Specification
2 properties
v1SystemCryptoData
object
SystemAdmin
2 properties
v1Error
object
4 properties
v1SystemEdgeImageSpec
object
system edge account specifications
3 properties
v1SystemSsoAuthSpec
object
system sso config spec
2 properties
v1SystemBackupSpec
object
system backup config spec
3 properties
v1ThemeMetadata
object
Theme metadata
3 properties
v1SystemAdminProfile
object
System Administrator Profile Entity
2 properties
v1AuthTokenSettings
object
System auth token settings
1 property
v1ObjectMeta
object
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
7 properties
v1SystemPlanLimit
object
System Monthly Plan Limit
3 properties
v1Uid
object
1 property
1 required
v1SystemRateLimit
object
system rate-limit
1 property
v1SystemFeature
object
2 properties
v1ObjectMetaInputEntity
object
ObjectMeta input entity for object creation
3 properties
v1SystemStartDate
object
system start date
1 property
v1Theme
object
Theme data entity
3 properties
v1PlanAddSlaCreditUpdate
object
Plan add sla credit update entity
1 property
v1SystemEdgeNativeImage
object
SystemAdmin
1 property
v1RegistryConf
object
Registry configuration
2 properties
v1SystemScarSpec
object
system scar config spec
6 properties
v1SystemAdminEntity
object
System Admin information
2 properties
v1SystemS3Spec
object
system backup s3 storage config spec
5 properties
v1Alert
object
2 properties
v1ThemesMetadata
object
Theme metadata
1 property
v1SystemSysplan
object
2 properties
v1SystemAdminProfileSpec
object
System Administrator Profile Specification
2 properties
v1ThemeCreateEntity
object
Theme data create entity
2 properties
2 required
v1AppFeatures
object
System app features
3 properties
v1SystemLoggerSpec
object
system logger config spec
2 properties
v1AwsRegionEndpoints
object
AWS region endpoint configuration containing DNS suffix and service endpoints
2 properties
v1SystemAdminMfa
object
System Administrator MFA configuration
2 properties
v1SystemGcpImageSpec
object
system gcp account specifications
1 property
v1SystemConfigCluster
object
System config cluster
1 property
v1SystemSecurityMode
object
System service mode
1 property
v1SystemConfigImagePullSecretSpec
object
system DHI image pull secret config spec
1 property
v1SystemGcpImage
object
SystemAdmin
1 property
v1SystemSsoSpec
object
system sso config spec
6 properties
v1SystemGcpSpec
object
system gcp account specifications
1 property
v1SystemFeaturesSpec
object
4 properties
v1SystemAdministratorSpec
object
System Administrator Entity Specification
5 properties
4 required
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…
v1Billing
object
billing preference
2 properties
v1SystemConfigAuth
object
System config auth
2 properties
v1AlertEntity
object
1 property
v1TierPrice
object
tier price
2 properties
v1ThemeStatus
object
1 property
v1ThemeSpec
object
1 property
1 required
v1SystemAwsAccount
object
SystemAdmin
1 property
v1Alerts
array
v1SystemAwsMarketplaceAccount
object
System AWS marketplace account specifications
5 properties
v1SystemGcpAccount
object
SystemAdmin
1 property
v1ClusterPreference
object
cluster preference
4 properties
v1SystemMaasImage
object
SystemAdmin
1 property
v1SystemAdmin
object
System Admin information
3 properties
v1V1SystemAdminEmail
object
SystemAdmin
3 properties
v1SystemAzureSpec
object
system azure account specifications
4 properties
v1SystemAzureStorageSpec
object
system aws account specifications
3 properties
v1SystemAzureAccount
object
SystemAdmin
1 property
v1PlanCreditEntity
object
Plan Credit entity for create/update request
5 properties
1 required
v1SystemStorageS3ConfigSpec
object
system storage s3 config spec
3 properties
v1TransferJob
object
transfer job details
7 properties
v1SystemKubectlSpec
object
system web kubectl config spec
2 properties
v1SystemSmtpSpec
object
system smtp config spec
6 properties
v1SystemReverseProxy
object
system config reverse proxy
7 properties
v1SystemFtpSpec
object
system ftp config spec
4 properties
v1SystemAdministratorStatus
object
System Administrator Status
5 properties
v1AppFeatureFreemium
object
Freemium information
4 properties
v1Channel
object
8 properties
v1LoginBannerSettings
object
3 properties
v1SystemOciImageRegistry
object
system web kubectl config spec
8 properties
v1SystemVsphereImageSpec
object
system vsphere account specifications
4 properties
v1SystemEdgeNativeImageSpec
object
system edge-native account specifications
4 properties
v1ClassificationBanner
object
1 property
v1SystemFeatures
object
1 property
1 required
v1SystemVsphereImage
object
SystemAdmin
1 property
v1SystemConfigStoreEntity
object
2 properties
2 required
v1PlanAddFreeCreditUpdate
object
Plan add free credit update entity
1 property
v1PriceRange
object
tier price range
5 properties
v1AwsServiceEndpoint
object
AWS service endpoint configuration
2 properties
v1SystemBackupFtpConfigSpec
object
system backup config spec
2 properties
v1DomainHost
object
update domain host for application. RootDomain gets dervied from domain host url
1 property
v1SystemBackupConfigSpec
object
system backup config spec
4 properties
v1SystemPlan
object
system plan
4 properties
v1SystemActivateRequest
object
1 property
1 required
v1SystemUserMeStatus
object
User status with permissions
8 properties
v1SystemCloudstackImageSpec
object
system cloudstack account specifications
1 property
v1DatabaseTransferStatus
object
database transfer status
2 properties
v1PasswordsBlockListEntity
object
List of block listed passwords
1 property
v1RegistryAuth
object
Auth credentials of the registry
5 properties
v1PlanCreditUpdate
object
Plan credit update entity
1 property
v1SystemAwsImage
object
SystemAdmin
1 property
v1SystemAdmins
object
List of System Admin information's
1 property
1 required
v1SystemResourceLimits
object
System resource limits. Supported resources keys are 'user','project','apiKey','team','role','cloudaccount','clusterprofile','workspace','registry','privategat…
1 property
v1SystemCloudstackImage
object
SystemAdmin
1 property
v1SystemPasswordPolicySpec
object
system password policy
13 properties
v1DatabaseTransferJob
object
database transfer job details
3 properties
v1SystemScarValidationResponse
object
system proxy config spec
1 property
v1SystemConfigDomainSpec
object
system domain config spec
5 properties
v1ThemeUpdateEntity
object
Theme data update entity
2 properties
v1SystemUserSpec
object
User specifications
2 properties
v1Updated
The resource was updated successfully
v1SystemActivationResponse
object
3 properties
v1SystemConfigDomainCertificatesSpec
object
system domain and its certificate config spec
2 properties
v1SystemEdgeImage
object
SystemAdmin
1 property
v1AwsPartitionEndpoints
object
AWS partition endpoint configuration
3 properties
v1V1SystemAdminPasswordResetEntity
object
SystemAdmin
3 properties
v1SystemRegistry
object
Registry configuration
2 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
#System
Where this information came from
This is an independent, third-party profile of Spectro Cloud system 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.