Spectro Cloud

Spectro Cloud System API

The system API from Spectro Cloud — 95 operation(s) for system.

GitHub OpenAPI

Operations 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… #
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… #
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/ V1 system config database backup get #
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 #

Documentation

📖
Documentation
https://docs.spectrocloud.com/api/introduction/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/spectro-cloud/refs/heads/main/openapi/spectro-cloud-system-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/spectro-cloud/refs/heads/main/json-schema/spectro-cloud-v1-system-password-policy-spec-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/spectro-cloud/refs/heads/main/json-schema/spectro-cloud-v1-system-oidc-client-spec-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/spectro-cloud/refs/heads/main/json-schema/spectro-cloud-v1-cluster-preference-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/spectro-cloud/refs/heads/main/json-schema/spectro-cloud-v1-system-activation-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/spectro-cloud/refs/heads/main/json-schema/spectro-cloud-v1-system-resource-limits-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/spectro-cloud/refs/heads/main/json-schema/spectro-cloud-v1-login-banner-settings-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/spectro-cloud-system-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

spectro-cloud-system-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Spectro Cloud System API
  version: v1
  description: 'Operations tagged system across 2 of this provider''s published API definitions: spectro-cloud-palette-openapi.json, spectrocloud-palette.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.spectrocloud.com
- url: /
tags:


# --- truncated at 32 KB (129 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/spectro-cloud/refs/heads/main/openapi/spectro-cloud-system-api-openapi.yml