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 tenants API

The tenants API from Spectro Cloud — 51 operation(s) for tenants.

Spectro Cloud tenants 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 Tenants. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 80 operations across 51 paths, and defines 124 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.

80 operations 51 paths 124 schemas 7 DELETE37 GET6 PATCH16 POST14 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 tenants 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 80

Across 51 paths, the API surfaces 80 operations — 7 DELETE, 37 GET, 6 PATCH, 16 POST, 14 PUT. Each is listed below with its method, path, parameters, and response codes.

tenants 80
GET
/v1/tenants
Retrieves a list of tenants
v1TenantsList 7 params → 200
POST
/v1/tenants
Creates a tenant
v1TenantsCreate 1 param body → 201
POST
/v1/tenants/marketplace/aws/setup
Validates the AWS Marketplace token and redirects the browser to the UI setup page
v1MarketplaceAwsSetup body → 303
POST
/v1/tenants/marketplace/register
Registers a marketplace user by resolving the registration token, verifying entitlements, and provisioning a tenant
v1MarketplaceRegister body → 201
POST
/v1/tenants/signup
Self signing up
v1TenantsSelfSignUp body → 204
POST
/v1/tenants/signup/{signupToken}/activate
Activates the self signed tenant using the password token
v1TenantsSelfSignUpActivate 1 param → 204
POST
/v1/tenants/validate
Validate tenant
v1TenantsValidate body → 204
DELETE
/v1/tenants/{tenantUid}
Deletes the specified tenant
v1TenantsDelete 1 param → 204
GET
/v1/tenants/{tenantUid}
Returns the specified tenant
v1TenantsGet 1 param → 200
PATCH
/v1/tenants/{tenantUid}/activate
activates the specified tenant
V1TenantsUidActivate 1 param body → 204
PATCH
/v1/tenants/{tenantUid}/address
Update tenant address
v1PatchTenantAddress 1 param body → 204
GET
/v1/tenants/{tenantUid}/assets/certs
lists the certificates for the tenant
V1TenantUIdAssetsCertsList 1 param → 200
POST
/v1/tenants/{tenantUid}/assets/certs
create the tenant certificate
V1TenantUidAssetsCertsCreate 1 param body → 201
DELETE
/v1/tenants/{tenantUid}/assets/certs/{certificateUid}
deletes the tenant certificate
V1TenantUidAssetsCertsUidDelete 2 params → 204
GET
/v1/tenants/{tenantUid}/assets/certs/{certificateUid}
Returns the ca certificate for the tenant
V1TenantUidAssetsCertsUidGet 2 params → 200
PUT
/v1/tenants/{tenantUid}/assets/certs/{certificateUid}
updates the tenant certificate
V1TenantUidAssetsCertsUidUpdate 2 params body → 204
DELETE
/v1/tenants/{tenantUid}/assets/dataSinks
deletes the tenant data sink config
V1TenantUidAssetsDataSinksDelete 1 param → 204
GET
/v1/tenants/{tenantUid}/assets/dataSinks
Returns data sink config of tenant
V1TenantUidAssetsDataSinksGet 1 param → 200
POST
/v1/tenants/{tenantUid}/assets/dataSinks
create data sink config
V1TenantUidAssetsDataSinksCreate 1 param body → 201
PUT
/v1/tenants/{tenantUid}/assets/dataSinks
updates the tenant data sink config
V1TenantUidAssetsDataSinksUpdate 1 param body → 204
GET
/v1/tenants/{tenantUid}/authTokenSettings
Get tenant auth token settings
v1TenantUidAuthTokenSettingsGet 1 param → 200
PUT
/v1/tenants/{tenantUid}/authTokenSettings
Update tenant auth token settings
v1TenantUidAuthTokenSettingsUpdate 1 param body → 204
DELETE
/v1/tenants/{tenantUid}/cleanUp
Clean up tenant resources
v1TenantsCleanUp 3 params → 204
PUT
/v1/tenants/{tenantUid}/contract
Updates the tenant contract settings
v1TenantsUidContractUpdate 1 param body → 204
PATCH
/v1/tenants/{tenantUid}/contract/accept
Tenant to accept the contract agreement
v1TenantsUidContractAccept 1 param → 204
DELETE
/v1/tenants/{tenantUid}/creditAccount/aws
Deletes the aws credit account for tenants
v1TenantsCreditAccountDelete 2 params → 204
GET
/v1/tenants/{tenantUid}/creditAccount/aws
Get the credit accounts for the tenants with free tier access
v1TenantsCreditAccountGet 1 param → 200
POST
/v1/tenants/{tenantUid}/datasinks/splunk
Creates the Splunk HEC data sink for the specified tenant
V1TenantUidDatasinksSplunkCreate 1 param body → 201400401403409
POST
/v1/tenants/{tenantUid}/datasinks/splunk/validate
Validates the Splunk HEC data sink connection for the specified tenant
V1TenantUidDatasinksSplunkValidate 1 param body → 204400401403504
DELETE
/v1/tenants/{tenantUid}/datasinks/splunk/{uid}
Deletes the Splunk HEC data sink for the specified tenant
V1TenantUidDatasinksSplunkDelete 2 params → 204401403404
GET
/v1/tenants/{tenantUid}/datasinks/splunk/{uid}
Returns the Splunk HEC data sink for the specified tenant
V1TenantUidDatasinksSplunkGet 2 params → 200401403404
PUT
/v1/tenants/{tenantUid}/datasinks/splunk/{uid}
Updates the Splunk HEC data sink for the specified tenant
V1TenantUidDatasinksSplunkUpdate 2 params body → 204400401403404
GET
/v1/tenants/{tenantUid}/datasinks/summary
Returns a summary of all data sinks configured for the specified tenant
V1TenantUidDatasinksSummaryGet 1 param → 200401403
GET
/v1/tenants/{tenantUid}/domains
retrieves the domains for tenant
V1TenantUidDomainsGet 1 param → 200
POST
/v1/tenants/{tenantUid}/domains
creates or updates domains for tenant
V1TenantUidDomainsUpdate 1 param body → 204
PATCH
/v1/tenants/{tenantUid}/emailId
Update tenant emailId
v1PatchTenantEmailId 1 param body → 204
GET
/v1/tenants/{tenantUid}/freemium
Get tenant level freemium configuration
v1TenantFreemiumGet 1 param → 200
PUT
/v1/tenants/{tenantUid}/freemium
Update tenant freemium configuration
v1TenantFreemiumUpdate 1 param body → 204
GET
/v1/tenants/{tenantUid}/freemiumUsage
Get tenant freemium usage
v1TenantFreemiumUsageGet 1 param → 200
GET
/v1/tenants/{tenantUid}/idp/palette/config
Returns the Palette IDP config for the tenant
V1TenantUidIdpPaletteConfigGet 1 param → 200
GET
/v1/tenants/{tenantUid}/invoices/{invoiceUid}
Returns a specified invoice
v1InvoicesUidGet 2 params → 200
GET
/v1/tenants/{tenantUid}/invoices/{invoiceUid}/report/invoice/pdf
Downloads the specified invoice report
V1InvoiceUidReportInvoicePdf 2 params → 200
GET
/v1/tenants/{tenantUid}/invoices/{invoiceUid}/report/pdf
Downloads the specified monthly invoice report
V1InvoiceUidReportPdf 2 params → 200
GET
/v1/tenants/{tenantUid}/invoices/{invoiceUid}/report/usage/pdf
Downloads the specified tenant usage
V1InvoiceUidReportUsagePdf 2 params → 200
GET
/v1/tenants/{tenantUid}/isCleanedUp
Get cleaned up tenant resources
v1TenantsIsCleanedUp 1 param → 200
GET
/v1/tenants/{tenantUid}/loginBanner
Get tenant login banner settings
v1TenantUidLoginBannerGet 1 param → 200
PUT
/v1/tenants/{tenantUid}/loginBanner
Update tenant login banner settings
v1TenantUidLoginBannerUpdate 1 param body → 204
DELETE
/v1/tenants/{tenantUid}/macros
Delete the macros for the specified tenant by given macro name
v1TenantsUidMacrosDeleteByMacroName 1 param body → 204
GET
/v1/tenants/{tenantUid}/macros
List the macros of the specified tenant
v1TenantsUidMacrosList 1 param → 200
PATCH
/v1/tenants/{tenantUid}/macros
Update the macros for the specified tenant by given macro name
v1TenantsUidMacrosUpdateByMacroName 1 param body → 204
POST
/v1/tenants/{tenantUid}/macros
Create or add new macros for the specified tenant
v1TenantsUidMacrosCreate 1 param body → 204
PUT
/v1/tenants/{tenantUid}/macros
Update the macros of the specified tenant
v1TenantsUidMacrosUpdate 1 param body → 204
GET
/v1/tenants/{tenantUid}/oidc/config
Returns the oidc Spec for tenant
V1TenantUidOidcConfigGet 1 param → 200
POST
/v1/tenants/{tenantUid}/oidc/config
Associates the oidc Spec for the tenant
V1TenantUidOidcConfigUpdate 1 param body → 204
GET
/v1/tenants/{tenantUid}/password/policy
retrieves the password policy for tenant
V1TenantUidPasswordPolicyGet 1 param → 200
POST
/v1/tenants/{tenantUid}/password/policy
creates or updates a password policy for tenant
V1TenantUidPasswordPolicyUpdate 1 param body → 204
GET
/v1/tenants/{tenantUid}/plan
Returns the current tenant's plan
v1TenantsUidPlanGet 1 param → 200
GET
/v1/tenants/{tenantUid}/plans/usage/monthly
Returns the tenant's monthly planUsage grouped by projects
v1PlansUsageMonthlyGet 3 params → 200
GET
/v1/tenants/{tenantUid}/preferences/clusterGroup
Get is cluster group enabled for a specific tenant
V1TenantPrefClusterGroupGet 1 param → 200
PUT
/v1/tenants/{tenantUid}/preferences/clusterGroup
Enable or Disable cluster group for a specific tenant
V1TenantPrefClusterGroupUpdate 1 param body → 204
GET
/v1/tenants/{tenantUid}/preferences/clusterRbacSettings
Get tenant cluster RBAC settings
v1TenantClusterRbacSettingsGet 1 param → 200
PUT
/v1/tenants/{tenantUid}/preferences/clusterRbacSettings
Update tenant cluster RBAC settings
v1TenantClusterRbacSettingsUpdate 1 param body → 204
GET
/v1/tenants/{tenantUid}/preferences/clusterSettings
Get tenant cluster settings
v1TenantClusterSettingsGet 1 param → 200
PUT
/v1/tenants/{tenantUid}/preferences/clusterSettings/nodesAutoRemediationSetting
Update tenant clusters nodes auto remediation setting
v1TenantClustersNodesAutoRemediationSettingUpdate 1 param body → 204
GET
/v1/tenants/{tenantUid}/preferences/developerCredit
Get developer credit enabled for a specific tenant
V1TenantDeveloperCreditGet 1 param → 200
PUT
/v1/tenants/{tenantUid}/preferences/developerCredit
update developer credit for a specific tenant
V1TenantDeveloperCreditUpdate 1 param body → 204
GET
/v1/tenants/{tenantUid}/preferences/fips
Get tenant fips settings
v1TenantFipsSettingsGet 1 param → 200
PUT
/v1/tenants/{tenantUid}/preferences/fips
Update tenant fips setting
v1TenantFipsSettingsUpdate 1 param body → 204
GET
/v1/tenants/{tenantUid}/rateConfig
Get all rate config for public and private cloud
v1RateConfigGet 1 param → 200
PUT
/v1/tenants/{tenantUid}/rateConfig
updates the rate config for public and private cloud
v1RateConfigUpdate 1 param body → 204
GET
/v1/tenants/{tenantUid}/resourceLimits
Get tenant level resource limits configuration
v1TenantResourceLimitsGet 1 param → 200
PATCH
/v1/tenants/{tenantUid}/resourceLimits
Update tenant resource limits configuration
v1TenantResourceLimitsUpdate 1 param body → 204
GET
/v1/tenants/{tenantUid}/saml/config
Returns the specified service provider metadata and Saml Spec for tenant
V1TenantUidSamlConfigSpecGet 1 param → 200
POST
/v1/tenants/{tenantUid}/saml/config
Associates the specified federation metadata for the tenant
V1TenantUidSamlConfigUpdate 1 param body → 204
GET
/v1/tenants/{tenantUid}/sso/auth/providers
get sso logins for the tenants
V1TenantUidSsoAuthProvidersGet 1 param → 200
POST
/v1/tenants/{tenantUid}/sso/auth/providers
enable sso logins for the tenants
V1TenantUidSsoAuthProvidersUpdate 1 param body → 204
GET
/v1/tenants/{tenantUid}/subscriptions/aws/{uid}
Returns the details of a specific AWS marketplace subscription
v1TenantSubscriptionsAwsGet 2 params → 200
GET
/v1/tenants/{tenantUid}/subscriptions/metadata
Returns the metadata of marketplace subscriptions for the tenant
v1TenantSubscriptionsMetadataList 1 param → 200
GET
/v1/tenants/{tenantUid}/usage/cpuCoreHours
Returns the tenant's cpu corehours usages grouped by projects
v1UsageCpuCoreHours 3 params → 200
GET
/v1/tenants/{tenantUid}/user
Returns the user object of the specified tenant
v1TenantsUserGet 1 param → 200

Schemas 124

The contract defines 124 schemas that model the data the API accepts and returns. The most detailed are v1TenantSamlSpec (15 properties), v1TenantOidcClientSpec (13 properties), v1TenantPasswordPolicyEntity (12 properties), v1InvoiceProductData (11 properties). Each schema is shown below with its type and property counts.

v1MarketplaceSubscriptionSummaries
object
List of marketplace subscription summaries
1 property 1 required
v1DataSinkConfig
object
Data sink
2 properties
v1TenantEntity
object
Tenant Entity
2 properties
v1Address
object
Tenant Address
6 properties
v1CustomCloudRateConfig
object
Private cloud rate config
2 properties
v1TenantClusterRbacSettings
object
Tenant cluster RBAC settings
1 property
v1ResourceLimitType
string
v1TotalResourceUsage
object
Total Resource Usage
3 properties
v1TenantSpec
object
Tenant Spec
6 properties
v1TenantSelfSignUpSpec
object
Tenant sign up data
6 properties 4 required
v1ProjectMeta
object
2 properties
v1Tenant
object
Tenant
3 properties
v1TenantContractSpec
object
Tenant contract settings
3 properties 2 required
v1ResourceUsage
object
ResourceUsage
4 properties
v1ProjectResourceUsage
object
project resource usage
3 properties
v1AwsMarketplaceSubscription
object
AWS marketplace subscription with metadata, spec, and status
3 properties
v1Plan
object
Plan
3 properties
v1SplunkSinkEntity
object
Input payload for creating or updating a Splunk HEC sink.
2 properties 2 required
v1InvoiceState
object
Invoice state object
3 properties
v1TenantSpecEntity
object
Tenant Entity input
10 properties
v1RateConfig
object
Rate config
10 properties
v1OidcIssuerTls
object
2 properties
v1TenantFreemiumUsage
object
4 properties
v1TenantDomains
object
Tenant domains
1 property
v1DeveloperCredit
object
Credits allocated for each tenant/user
4 properties
v1InvoicePlanCredit
object
Invoice plan credit object
2 properties
v1TenantResourceLimit
object
4 properties
v1InvoiceProduct
object
Product invoice object
2 properties
v1OidcUserInfo
object
2 properties
v1PlanCost
object
Plan Cost
2 properties
v1ListMetaData
object
ListMeta describes metadata for the resource listing
4 properties
v1TenantAssetCerts
object
1 property 1 required
v1CloudWatch
object
4 properties
v1Error
object
4 properties
v1TenantEmailPatch
object
Tenant EmailId
1 property
v1ProjectUsageData
object
Project usage data object
3 properties
v1SplunkSink
object
Splunk HEC audit-log sink configuration.
3 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
v1TenantPaletteIdpConfigSpec
object
Palette IDP configuration for the tenant
4 properties
v1Macro
object
2 properties
v1TlsCA
object
3 properties
v1DataSinksSummary
object
Summary of all sinks configured for a tenant, across kinds.
1 property 1 required
v1Uid
object
1 property 1 required
v1AwsCloudAccountCredentialType
string
Allowed Values [secret, sts, pod-identity]. STS type will be used for role assumption for sts type, accessKey/secretKey contains the source account, Arn is the…
v1FreemiumUsage
object
1 property
v1TenantSamlSpecAttribute
object
4 properties
v1InvoiceProject
object
Invoice project object
4 properties
v1PlanCpuCoreHoursUsages
object
1 property
v1TenantClusterSettings
object
1 property
v1Invoice
object
Invoice object
3 properties
v1InvoiceSpec
object
Invoice specification
7 properties
v1CleanUpResource
object
Resources of tenant
2 properties
v1NodesAutoRemediationSettings
object
2 properties
v1AwsPodIdentityCredentials
object
AWS EKS Pod Identity credentials for role assumption
2 properties
v1AwsStsCredentials
object
Aws sts credentials
2 properties
v1AwsUserCloudAccount
object
2 properties
v1MarketplacePlanLimit
object
Marketplace plan limit
1 property
v1InvoiceStatus
object
Invoice Status
5 properties
v1DataSinkableSpec
object
2 properties
v1TenantEnableClusterGroup
object
Enable or Disable cluster group for a tenant
2 properties
v1TenantFreemium
object
Tenant freemium configuration
5 properties
v1User
object
User
3 properties
v1Macros
object
1 property
v1AwsMarketplaceSubscriptionSpec
object
AWS marketplace subscription specification
3 properties
v1TenantOidcClaims
object
4 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…
v1MarketplaceEntitlement
object
Entitlement details from the marketplace contract
3 properties
v1PlanRenewal
object
Plan Renewal
4 properties 3 required
v1AwsSecretTlsConfig
object
TLS configuration for the AWS secret
3 properties
v1TierPrice
object
tier price
2 properties
v1ActiveTenantResources
object
Active resources of tenant
1 property
v1SinkSyncStatus
object
Status of the data sink delivery sync loop
4 properties
v1TenantActivate
object
Activate/Deactivate tenant
1 property
v1InvoiceBillingPeriod
object
Invoice billing period object
2 properties
v1TenantAssetCert
object
tenant cert
2 properties
v1TenantResourceLimits
object
Tenant resource limits
1 property
v1PrivateCloudRateConfig
object
Private cloud rate config
4 properties
v1AwsSecretSpec
object
AWS cloud account which includes access key and secret key in case of 'secret' credentials type. It includes policyARNS, ARN and externalId in case of sts. Par…
9 properties
v1PlanLimitSpec
object
Monthly Plan Limit spec
3 properties
v1SplunkSinkSpec
object
Splunk HEC connection configuration.
5 properties 2 required
v1TenantSamlRequestSpec
object
Tenant
8 properties
v1PlanStatus
object
1 property
v1PublicCloudRateConfig
object
Public cloud rate config
2 properties
v1DataSinkSummary
object
Data sink summary
3 properties
v1TenantResourceLimitsEntity
object
Tenant resource limits. Supported resources keys are 'user','project','apiKey','team','role','cloudaccount','clusterprofile','workspace','registry','privategat…
1 property
v1TenantStatus
object
Tenant Status
3 properties
v1Cert
object
3 properties
v1TenantSamlSpec
object
Tenant
15 properties
v1TenantBasicEntity
object
Tenant Basic param
2 properties
v1AwsMarketplaceSubscriptionStatus
object
AWS marketplace subscription status
1 property
v1PlanLimit
object
Monthly Plan Limit
4 properties
v1PlanCredit
object
Plan Credit
6 properties 1 required
v1LoginBannerSettings
object
3 properties
v1UserStatus
object
User status
4 properties
v1AwsMarketplaceSubscriptionMetadata
object
Subscription metadata
2 properties
v1UserSpec
object
User specifications
4 properties
v1MarketplaceRegisterResponse
object
Response returned after successful marketplace registration.
1 property
v1InvoiceCredits
object
Invoice credits object
2 properties
v1MarketplaceRegisterEntity
object
Registration request submitted when a marketplace user is redirected to Palette after purchasing a SaaS contract (e.g., from AWS Marketplace). Contains the tem…
6 properties 5 required
v1TenantResourceLimitEntity
object
2 properties
v1TenantSsoAuthProvidersEntity
object
2 properties
v1Tenants
object
Tenants list
2 properties 1 required
v1TenantOidcClientSpec
object
Tenant
13 properties
v1PriceRange
object
tier price range
5 properties
v1AwsCloudAccount
object
AWS cloud account which includes access key and secret key in case of 'secret' credentials type. It includes policyARNS, ARN and externalId in case of sts. It…
9 properties
v1PlanSpec
object
Plan specifications
10 properties 3 required
v1FreemiumUsageLimit
object
3 properties
v1TenantCleanUpStatus
object
Tenant CleanUp Status
6 properties
v1ProjectUsage
object
Project usage object
2 properties
v1PlanMonthlyUsage
object
Plan monthly usage entity
6 properties
v1TenantPasswordPolicyEntity
object
Tenant Password Policy Entity
12 properties
v1TenantAddressPatch
object
Tenant Address
1 property
v1SinkStatus
object
Data sink status
1 property
v1AwsLoginCredentials
object
2 properties
v1DataSinkSpec
object
1 property
v1NonFipsConfig
object
Non-FIPS configuration
1 property
v1MarketplaceSubscriptionSummary
object
Summary of a marketplace subscription for the tenant
3 properties
v1CloudInstanceRateConfig
object
Cloud instance rate config
2 properties
v1InvoiceProductData
object
Product invoice data
11 properties
v1AwsCreditAccountEntity
object
4 properties
v1PlanMonthlyUsages
object
1 property
v1FipsSettings
object
FIPS configuration
3 properties
v1InvoicePlan
object
Invoice plan object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

spectro-cloud-tenants-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 tenants 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.