Tenants

https://api.spectrocloud.com/v1/tenants

summary:
Retrieves a list of tenants
Parameters:
NameTypeDescriptionRequired
fieldsstringSet of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.nameno
filtersstringFilters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws Server will be restricted to certain fields based on the indexed data for each resource.no
orderBystringSpecify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1no
limitintegerlimit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.no
offsetintegeroffset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.no
continuestringcontinue token to paginate the subsequent data itemsno
200
An array of tenants
{
"items": [
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"address": {
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"country": "string",
"pincode": "string",
"state": "string"
},
"authType": "string",
"orgEmailId": "string",
"orgName": "string",
"planUid": "string"
},
"status": {
"cleanUpStatus": {
"cleanUpError": "string",
"cleanUpStages": "string",
"cleanUpTimestamp": "date-time",
"cleanedResources": [
"string"
],
"isCompleted": "boolean",
"isInProgress": "boolean"
},
"isActive": "boolean",
"toBeDeleted": "boolean"
}
}
],
"listmeta": {
"continue": "string",
"count": "integer",
"limit": "integer",
"offset": "integer"
}
}

https://api.spectrocloud.com/v1/tenants

summary:
Creates a tenant
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"address": {
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"country": "string",
"pincode": "string",
"state": "string"
},
"authType": "string",
"emailId": "string",
"firstName": "string",
"lastName": "string",
"orgEmailId": "string",
"orgName": "string",
"roles": [
"string"
]
}
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/tenants/signup

summary:
Self signing up
{
"emailId": "string",
"firstName": "string",
"lastName": "string",
"notifyTenantAdmin": "boolean",
"orgName": "string"
}
204
Ok reponse without content

https://api.spectrocloud.com/v1/tenants/signup/{signupToken}/activate

summary:
Activates the self signed tenant using the password token
Path parameters:
NameTypeDescriptionRequired
signupTokenstringyes
204
The resource was updated successfully

https://api.spectrocloud.com/v1/tenants/validate

summary:
Validate tenant
{
"emailId": "string",
"orgName": "string"
}
204
Ok reponse without content

https://api.spectrocloud.com/v1/tenants/{tenantUid}

summary:
Returns the specified tenant
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
200
OK
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"address": {
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"country": "string",
"pincode": "string",
"state": "string"
},
"authType": "string",
"orgEmailId": "string",
"orgName": "string",
"planUid": "string"
},
"status": {
"cleanUpStatus": {
"cleanUpError": "string",
"cleanUpStages": "string",
"cleanUpTimestamp": "date-time",
"cleanedResources": [
"string"
],
"isCompleted": "boolean",
"isInProgress": "boolean"
},
"isActive": "boolean",
"toBeDeleted": "boolean"
}
}

https://api.spectrocloud.com/v1/tenants/{tenantUid}

summary:
Deletes the specified tenant
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
204
The resource was updated successfully

https://api.spectrocloud.com/v1/tenants/{tenantUid}/activate

summary:
activates the specified tenant
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
{
"isActive": "boolean"
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/tenants/{tenantUid}/address

summary:
Update tenant address
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
{
"address": {
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"country": "string",
"pincode": "string",
"state": "string"
}
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/tenants/{tenantUid}/assets/certs

summary:
lists the certificates for the tenant
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
200
OK
{
"items": [
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"certificate": "string",
"isCA": "boolean",
"key": "string"
}
}
]
}

https://api.spectrocloud.com/v1/tenants/{tenantUid}/assets/certs

summary:
create the tenant certificate
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"certificate": "string",
"isCA": "boolean",
"key": "string"
}
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/tenants/{tenantUid}/assets/certs/{certificateUid}

summary:
Returns the ca certificate for the tenant
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
certificateUidstringyes
200
OK
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"certificate": "string",
"isCA": "boolean",
"key": "string"
}
}

https://api.spectrocloud.com/v1/tenants/{tenantUid}/assets/certs/{certificateUid}

summary:
updates the tenant certificate
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
certificateUidstringyes
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"certificate": "string",
"isCA": "boolean",
"key": "string"
}
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/tenants/{tenantUid}/assets/certs/{certificateUid}

summary:
deletes the tenant certificate
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
certificateUidstringyes
204
The resource was deleted successfully

https://api.spectrocloud.com/v1/tenants/{tenantUid}/assets/dataSinks

summary:
Returns data sink config of tenant
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
200
OK
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"auditDataSinks": [
{
"cloudWatch": {
"credentials": {
"accessKey": "string",
"credentialType": "string",
"secretKey": "string",
"sts": {
"arn": "string",
"externalId": "string"
}
},
"group": "string",
"region": "string",
"stream": "string"
},
"type": "string"
}
]
}
}

https://api.spectrocloud.com/v1/tenants/{tenantUid}/assets/dataSinks

summary:
updates the tenant data sink config
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"auditDataSinks": [
{
"cloudWatch": {
"credentials": {
"accessKey": "string",
"credentialType": "string",
"secretKey": "string",
"sts": {
"arn": "string",
"externalId": "string"
}
},
"group": "string",
"region": "string",
"stream": "string"
},
"type": "string"
}
]
}
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/tenants/{tenantUid}/assets/dataSinks

summary:
create data sink config
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"auditDataSinks": [
{
"cloudWatch": {
"credentials": {
"accessKey": "string",
"credentialType": "string",
"secretKey": "string",
"sts": {
"arn": "string",
"externalId": "string"
}
},
"group": "string",
"region": "string",
"stream": "string"
},
"type": "string"
}
]
}
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/tenants/{tenantUid}/assets/dataSinks

summary:
deletes the tenant data sink config
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
204
The resource was deleted successfully

https://api.spectrocloud.com/v1/tenants/{tenantUid}/cleanUp

summary:
Clean up tenant resources
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
useTenantCtxbooleanno
forceDeletebooleanno
204
The resource was updated successfully

https://api.spectrocloud.com/v1/tenants/{tenantUid}/contract

summary:
Updates the tenant contract settings
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
{
"acceptedTime": "date-time",
"isAccepted": "boolean",
"isRequired": "boolean"
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/tenants/{tenantUid}/contract/accept

summary:
Tenant to accept the contract agreement
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
204
Ok reponse without content

https://api.spectrocloud.com/v1/tenants/{tenantUid}/creditAccount/aws

summary:
Get the credit accounts for the tenants with free tier access
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
200
OK
{
"creditLimitInDollars": "number",
"creditUsedInDollars": "number",
"loginCredentials": {
"iamUser": "string",
"password": "string"
},
"userCloudAccount": {
"accountId": "string",
"cloudAccount": {
"accessKey": "string",
"credentialType": "string",
"secretKey": "string",
"sts": {
"arn": "string",
"externalId": "string"
}
}
}
}

https://api.spectrocloud.com/v1/tenants/{tenantUid}/creditAccount/aws

summary:
Updates the credit account for tenants with free tier access
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
{
"creditLimitInDollars": "number",
"loginCredentials": {
"iamUser": "string",
"password": "string"
},
"userCloudAccount": {
"accountId": "string",
"cloudAccount": {
"accessKey": "string",
"credentialType": "string",
"secretKey": "string",
"sts": {
"arn": "string",
"externalId": "string"
}
}
}
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/tenants/{tenantUid}/creditAccount/aws

summary:
Deletes the aws credit account for tenants
Parameters:
NameTypeDescriptionRequired
forceDeletebooleanno
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
204
The resource was deleted successfully

https://api.spectrocloud.com/v1/tenants/{tenantUid}/domains

summary:
retrieves the domains for tenant
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
200
(empty)
{
"domains": [
"string"
]
}

https://api.spectrocloud.com/v1/tenants/{tenantUid}/domains

summary:
creates or updates domains for tenant
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
{
"domains": [
"string"
]
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/tenants/{tenantUid}/emailId

summary:
Update tenant emailId
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
{
"emailId": "string"
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/tenants/{tenantUid}/freemiumUsage

summary:
Get tenant freemium usage
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
200
OK
{
"isFreemium": "boolean",
"limit": {
"activeClusters": "integer",
"overageUsage": "number",
"usage": "number"
},
"usage": {
"usage": "number"
}
}

https://api.spectrocloud.com/v1/tenants/{tenantUid}/invoice

summary:
Retrieves a invoice for the given month
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
invoiceDatestringTime 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 package offers.yes
forceInvoiceGeneratebooleanno
200
OK
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"address": {
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"country": "string",
"pincode": "string",
"state": "string"
},
"billingPeriod": {
"end": "date-time",
"start": "date-time"
},
"credits": {
"alloyFreeCredits": "number",
"pureFreeCredits": "number"
},
"envType": "string",
"month": "date-time",
"paymentUnit": "string",
"plan": {
"freeCredits": [
{
"planCredit": {
"cpuCoreHours": "number",
"creditUid": "string",
"expiry": "date-time",
"name": "string",
"start": "date-time",
"type": "string"
},
"totalCpuCoreHours": "number"
}
],
"plantype": "string",
"slaCredits": [
{
"planCredit": {
"cpuCoreHours": "number",
"creditUid": "string",
"expiry": "date-time",
"name": "string",
"start": "date-time",
"type": "string"
},
"totalCpuCoreHours": "number"
}
]
}
},
"status": {
"billableAmount": "number",
"productInvoice": {
"alloy": {
"allocatedCredits": "number",
"amount": "number",
"billableCredits": "number",
"breachedCredits": "number",
"discount": "number",
"freeCredits": "number",
"overageLimitPercentage": "number",
"tierName": "string",
"tierPrice": "number",
"totalUsedCredits": "number",
"usedCredits": "number"
},
"pure": {
"allocatedCredits": "number",
"amount": "number",
"billableCredits": "number",
"breachedCredits": "number",
"discount": "number",
"freeCredits": "number",
"overageLimitPercentage": "number",
"tierName": "string",
"tierPrice": "number",
"totalUsedCredits": "number",
"usedCredits": "number"
}
},
"projects": [
{
"amount": "number",
"projectName": "string",
"projectUid": "string",
"usage": {
"alloy": {
"amount": "number",
"tierPrice": "number",
"usedCredits": "number"
},
"pure": {
"amount": "number",
"tierPrice": "number",
"usedCredits": "number"
}
}
}
],
"states": [
{
"paymentMsg": "string",
"state": "string",
"timestamp": "date-time"
}
],
"stripeInvoiceId": "string"
}
}

https://api.spectrocloud.com/v1/tenants/{tenantUid}/invoice/retry

summary:
Retry invoice
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
{
"customerId": "string",
"invoiceUid": "string",
"paymentMethodId": "string"
}
201
The resource was updated successfully

https://api.spectrocloud.com/v1/tenants/{tenantUid}/invoices

summary:
Retrieves a list of invoices
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
200
OK
{
"invoices": [
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"address": {
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"country": "string",
"pincode": "string",
"state": "string"
},
"billingPeriod": {
"end": "date-time",
"start": "date-time"
},
"credits": {
"alloyFreeCredits": "number",
"pureFreeCredits": "number"
},
"envType": "string",
"month": "date-time",
"paymentUnit": "string",
"plan": {
"freeCredits": [
{
"planCredit": {
"cpuCoreHours": "number",
"creditUid": "string",
"expiry": "date-time",
"name": "string",
"start": "date-time",
"type": "string"
},
"totalCpuCoreHours": "number"
}
],
"plantype": "string",
"slaCredits": [
{
"planCredit": {
"cpuCoreHours": "number",
"creditUid": "string",
"expiry": "date-time",
"name": "string",
"start": "date-time",
"type": "string"
},
"totalCpuCoreHours": "number"
}
]
}
},
"status": {
"billableAmount": "number",
"productInvoice": {
"alloy": {
"allocatedCredits": "number",
"amount": "number",
"billableCredits": "number",
"breachedCredits": "number",
"discount": "number",
"freeCredits": "number",
"overageLimitPercentage": "number",
"tierName": "string",
"tierPrice": "number",
"totalUsedCredits": "number",
"usedCredits": "number"
},
"pure": {
"allocatedCredits": "number",
"amount": "number",
"billableCredits": "number",
"breachedCredits": "number",
"discount": "number",
"freeCredits": "number",
"overageLimitPercentage": "number",
"tierName": "string",
"tierPrice": "number",
"totalUsedCredits": "number",
"usedCredits": "number"
}
},
"projects": [
{
"amount": "number",
"projectName": "string",
"projectUid": "string",
"usage": {
"alloy": {
"amount": "number",
"tierPrice": "number",
"usedCredits": "number"
},
"pure": {
"amount": "number",
"tierPrice": "number",
"usedCredits": "number"
}
}
}
],
"states": [
{
"paymentMsg": "string",
"state": "string",
"timestamp": "date-time"
}
],
"stripeInvoiceId": "string"
}
}
],
"listmeta": {
"continue": "string",
"count": "integer",
"limit": "integer",
"offset": "integer"
}
}

https://api.spectrocloud.com/v1/tenants/{tenantUid}/invoices/{invoiceUid}

summary:
Returns the specified invoice
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
invoiceUidstringyes
200
OK
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"address": {
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"country": "string",
"pincode": "string",
"state": "string"
},
"billingPeriod": {
"end": "date-time",
"start": "date-time"
},
"credits": {
"alloyFreeCredits": "number",
"pureFreeCredits": "number"
},
"envType": "string",
"month": "date-time",
"paymentUnit": "string",
"plan": {
"freeCredits": [
{
"planCredit": {
"cpuCoreHours": "number",
"creditUid": "string",
"expiry": "date-time",
"name": "string",
"start": "date-time",
"type": "string"
},
"totalCpuCoreHours": "number"
}
],
"plantype": "string",
"slaCredits": [
{
"planCredit": {
"cpuCoreHours": "number",
"creditUid": "string",
"expiry": "date-time",
"name": "string",
"start": "date-time",
"type": "string"
},
"totalCpuCoreHours": "number"
}
]
}
},
"status": {
"billableAmount": "number",
"productInvoice": {
"alloy": {
"allocatedCredits": "number",
"amount": "number",
"billableCredits": "number",
"breachedCredits": "number",
"discount": "number",
"freeCredits": "number",
"overageLimitPercentage": "number",
"tierName": "string",
"tierPrice": "number",
"totalUsedCredits": "number",
"usedCredits": "number"
},
"pure": {
"allocatedCredits": "number",
"amount": "number",
"billableCredits": "number",
"breachedCredits": "number",
"discount": "number",
"freeCredits": "number",
"overageLimitPercentage": "number",
"tierName": "string",
"tierPrice": "number",
"totalUsedCredits": "number",
"usedCredits": "number"
}
},
"projects": [
{
"amount": "number",
"projectName": "string",
"projectUid": "string",
"usage": {
"alloy": {
"amount": "number",
"tierPrice": "number",
"usedCredits": "number"
},
"pure": {
"amount": "number",
"tierPrice": "number",
"usedCredits": "number"
}
}
}
],
"states": [
{
"paymentMsg": "string",
"state": "string",
"timestamp": "date-time"
}
],
"stripeInvoiceId": "string"
}
}

https://api.spectrocloud.com/v1/tenants/{tenantUid}/invoices/{invoiceUid}/report/invoice/pdf

summary:
Downloads the specified invoice report
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
invoiceUidstringyes
200
OK

https://api.spectrocloud.com/v1/tenants/{tenantUid}/invoices/{invoiceUid}/report/pdf

summary:
Downloads the specified monthly report
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
invoiceUidstringyes
200
OK

https://api.spectrocloud.com/v1/tenants/{tenantUid}/invoices/{invoiceUid}/report/usage/pdf

summary:
Downloads the specified usage
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
invoiceUidstringyes
200
OK

https://api.spectrocloud.com/v1/tenants/{tenantUid}/isCleanedUp

summary:
Get cleaned up tenant resources
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
200
OK
{
"activeResources": {
"activeResources": "object"
},
"tenantStatus": {
"cleanUpError": "string",
"cleanUpStages": "string",
"cleanUpTimestamp": "date-time",
"cleanedResources": [
"string"
],
"isCompleted": "boolean",
"isInProgress": "boolean"
}
}

https://api.spectrocloud.com/v1/tenants/{tenantUid}/macros

summary:
List the macros of the specified tenant
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
200
OK
{
"macros": [
{
"name": "string",
"value": "string"
}
]
}

https://api.spectrocloud.com/v1/tenants/{tenantUid}/macros

summary:
Update the macros of the specified tenant
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
{
"macros": [
{
"name": "string",
"value": "string"
}
]
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/tenants/{tenantUid}/oidc/config

summary:
Returns the oidc Spec for tenant
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
200
OK
{
"callbackUrl": "string",
"clientId": "string",
"clientSecret": "string",
"defaultTeams": [
"string"
],
"isSsoEnabled": "boolean",
"issuerUrl": "string",
"logoutUrl": "string",
"requiredClaims": {
"Email": "string",
"FirstName": "string",
"LastName": "string",
"SpectroTeam": "string"
},
"scopes": [
"string"
],
"syncSsoTeams": "boolean"
}

https://api.spectrocloud.com/v1/tenants/{tenantUid}/oidc/config

summary:
Associates the oidc Spec for the tenant
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
{
"callbackUrl": "string",
"clientId": "string",
"clientSecret": "string",
"defaultTeams": [
"string"
],
"isSsoEnabled": "boolean",
"issuerUrl": "string",
"logoutUrl": "string",
"requiredClaims": {
"Email": "string",
"FirstName": "string",
"LastName": "string",
"SpectroTeam": "string"
},
"scopes": [
"string"
],
"syncSsoTeams": "boolean"
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/tenants/{tenantUid}/password/policy

summary:
retrieves the password policy for tenant
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
200
(empty)
{
"creationTimestamp": "date-time",
"expiryDurationInDays": "integer",
"firstReminderInDays": "integer",
"isRegex": "boolean",
"minLength": "integer",
"minNumOfBlockLetters": "integer",
"minNumOfDigits": "integer",
"minNumOfSmallLetters": "integer",
"minNumOfSpecialCharacters": "integer",
"regex": "string",
"updateTimestamp": "date-time"
}

https://api.spectrocloud.com/v1/tenants/{tenantUid}/password/policy

summary:
creates or updates a password policy for tenant
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
{
"creationTimestamp": "date-time",
"expiryDurationInDays": "integer",
"firstReminderInDays": "integer",
"isRegex": "boolean",
"minLength": "integer",
"minNumOfBlockLetters": "integer",
"minNumOfDigits": "integer",
"minNumOfSmallLetters": "integer",
"minNumOfSpecialCharacters": "integer",
"regex": "string",
"updateTimestamp": "date-time"
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/tenants/{tenantUid}/plan

summary:
Returns the current tenant's plan
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
200
(empty)
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"cost": {
"discount": "number",
"price": "number"
},
"expiry": "date-time",
"freeCredits": [
{
"cpuCoreHours": "number",
"creditUid": "string",
"expiry": "date-time",
"name": "string",
"start": "date-time",
"type": "string"
}
],
"planLimit": {
"alloy": {
"cpuCoreHours": "integer",
"overageLimitPercentage": "integer",
"warnLimitPercentage": "integer"
},
"isOnDemand": "boolean",
"isUnlimited": "boolean",
"pure": {
"cpuCoreHours": "integer",
"overageLimitPercentage": "integer",
"warnLimitPercentage": "integer"
}
},
"renewal": {
"expiry": "date-time",
"planLimit": {
"alloy": {
"cpuCoreHours": "integer",
"overageLimitPercentage": "integer",
"warnLimitPercentage": "integer"
},
"isOnDemand": "boolean",
"isUnlimited": "boolean",
"pure": {
"cpuCoreHours": "integer",
"overageLimitPercentage": "integer",
"warnLimitPercentage": "integer"
}
},
"start": "date-time",
"type": "string"
},
"slaCredits": [
{
"cpuCoreHours": "number",
"creditUid": "string",
"expiry": "date-time",
"name": "string",
"start": "date-time",
"type": "string"
}
],
"start": "date-time",
"tierPricing": {
"alloyPricing": [
{
"discount": "number",
"startFrom": "number",
"unitAmount": "number",
"upTo": "number",
"upToInfinity": "boolean"
}
],
"purePricing": [
{
"discount": "number",
"startFrom": "number",
"unitAmount": "number",
"upTo": "number",
"upToInfinity": "boolean"
}
]
},
"type": "string"
},
"status": {
"changeLogs": [
"string"
]
}
}

https://api.spectrocloud.com/v1/tenants/{tenantUid}/plans/usage/monthly

summary:
Returns the tenant's monthly planUsage grouped by projects
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
endDatestringno
startDatestringyes
200
OK
{
"items": [
{
"dailyUsages": [
{
"projects": [
{
"alloyCpuCoreHours": "number",
"project": {
"name": "string",
"uid": "string"
},
"pureCpuCoreHours": "number"
}
],
"timestamp": "date-time",
"totalAlloyCpuCoreHours": "number",
"totalPureCpuCoreHours": "number"
}
],
"month": "date-time",
"planLimit": {
"alloy": {
"cpuCoreHours": "integer",
"overageLimitPercentage": "integer",
"warnLimitPercentage": "integer"
},
"isOnDemand": "boolean",
"isUnlimited": "boolean",
"pure": {
"cpuCoreHours": "integer",
"overageLimitPercentage": "integer",
"warnLimitPercentage": "integer"
}
},
"planType": "string",
"planUid": "string",
"totalMonthlyUsage": {
"projects": [
{
"alloyCpuCoreHours": "number",
"project": {
"name": "string",
"uid": "string"
},
"pureCpuCoreHours": "number"
}
],
"totalAlloyCpuCoreHours": "number",
"totalPureCpuCoreHours": "number"
}
}
]
}

https://api.spectrocloud.com/v1/tenants/{tenantUid}/rateConfig

summary:
Get all rate config for public and private cloud
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
200
OK
{
"aws": {
"computeOptimized": {
"computeRateProportion": "number",
"memoryRateProportion": "number"
},
"memoryOptimized": {
"computeRateProportion": "number",
"memoryRateProportion": "number"
}
},
"azure": {
"computeOptimized": {
"computeRateProportion": "number",
"memoryRateProportion": "number"
},
"memoryOptimized": {
"computeRateProportion": "number",
"memoryRateProportion": "number"
}
},
"edge": {
"cpuUnitPricePerHour": "number",
"gpuUnitPricePerHour": "number",
"memoryUnitPriceGiBPerHour": "number",
"storageUnitPriceGiBPerHour": "number"
},
"gcp": {
"computeOptimized": {
"computeRateProportion": "number",
"memoryRateProportion": "number"
},
"memoryOptimized": {
"computeRateProportion": "number",
"memoryRateProportion": "number"
}
},
"generic": {
"cpuUnitPricePerHour": "number",
"gpuUnitPricePerHour": "number",
"memoryUnitPriceGiBPerHour": "number",
"storageUnitPriceGiBPerHour": "number"
},
"libvirt": {
"cpuUnitPricePerHour": "number",
"gpuUnitPricePerHour": "number",
"memoryUnitPriceGiBPerHour": "number",
"storageUnitPriceGiBPerHour": "number"
},
"maas": {
"cpuUnitPricePerHour": "number",
"gpuUnitPricePerHour": "number",
"memoryUnitPriceGiBPerHour": "number",
"storageUnitPriceGiBPerHour": "number"
},
"openstack": {
"cpuUnitPricePerHour": "number",
"gpuUnitPricePerHour": "number",
"memoryUnitPriceGiBPerHour": "number",
"storageUnitPriceGiBPerHour": "number"
},
"vsphere": {
"cpuUnitPricePerHour": "number",
"gpuUnitPricePerHour": "number",
"memoryUnitPriceGiBPerHour": "number",
"storageUnitPriceGiBPerHour": "number"
}
}

https://api.spectrocloud.com/v1/tenants/{tenantUid}/rateConfig

summary:
updates the rate config for public and private cloud
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
{
"aws": {
"computeOptimized": {
"computeRateProportion": "number",
"memoryRateProportion": "number"
},
"memoryOptimized": {
"computeRateProportion": "number",
"memoryRateProportion": "number"
}
},
"azure": {
"computeOptimized": {
"computeRateProportion": "number",
"memoryRateProportion": "number"
},
"memoryOptimized": {
"computeRateProportion": "number",
"memoryRateProportion": "number"
}
},
"edge": {
"cpuUnitPricePerHour": "number",
"gpuUnitPricePerHour": "number",
"memoryUnitPriceGiBPerHour": "number",
"storageUnitPriceGiBPerHour": "number"
},
"gcp": {
"computeOptimized": {
"computeRateProportion": "number",
"memoryRateProportion": "number"
},
"memoryOptimized": {
"computeRateProportion": "number",
"memoryRateProportion": "number"
}
},
"generic": {
"cpuUnitPricePerHour": "number",
"gpuUnitPricePerHour": "number",
"memoryUnitPriceGiBPerHour": "number",
"storageUnitPriceGiBPerHour": "number"
},
"libvirt": {
"cpuUnitPricePerHour": "number",
"gpuUnitPricePerHour": "number",
"memoryUnitPriceGiBPerHour": "number",
"storageUnitPriceGiBPerHour": "number"
},
"maas": {
"cpuUnitPricePerHour": "number",
"gpuUnitPricePerHour": "number",
"memoryUnitPriceGiBPerHour": "number",
"storageUnitPriceGiBPerHour": "number"
},
"openstack": {
"cpuUnitPricePerHour": "number",
"gpuUnitPricePerHour": "number",
"memoryUnitPriceGiBPerHour": "number",
"storageUnitPriceGiBPerHour": "number"
},
"vsphere": {
"cpuUnitPricePerHour": "number",
"gpuUnitPricePerHour": "number",
"memoryUnitPriceGiBPerHour": "number",
"storageUnitPriceGiBPerHour": "number"
}
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/tenants/{tenantUid}/saml/config

summary:
Returns the specified service provider metadata and Saml Spec for tenant
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
200
OK
{
"acsUrl": "string",
"attributes": [
{
"attributeValue": "string",
"mappedAttribute": "string",
"name": "string",
"nameFormat": "string"
}
],
"audienceUrl": "string",
"certificate": "string",
"defaultTeams": [
"string"
],
"entityId": "string",
"federationMetadata": "string",
"identityProvider": "string",
"isSingleLogoutEnabled": "boolean",
"isSsoEnabled": "boolean",
"issuer": "string",
"nameIdFormat": "string",
"serviceProviderMetadata": "string",
"singleLogoutUrl": "string",
"syncSsoTeams": "boolean"
}

https://api.spectrocloud.com/v1/tenants/{tenantUid}/saml/config

summary:
Associates the specified federation metadata for the tenant
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
{
"attributes": [
{
"attributeValue": "string",
"mappedAttribute": "string",
"name": "string",
"nameFormat": "string"
}
],
"defaultTeams": [
"string"
],
"federationMetadata": "string",
"identityProvider": "string",
"isSingleLogoutEnabled": "boolean",
"isSsoEnabled": "boolean",
"nameIdFormat": "string",
"syncSsoTeams": "boolean"
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/tenants/{tenantUid}/usage/cpuCoreHours

summary:
Returns the tenant's cpu corehours usages grouped by projects
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
endTimestringTime 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 package offers.no
startTimestringTime 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 package offers.no
200
OK
{
"hourlyUsages": [
{
"projects": [
{
"alloyCpuCoreHours": "number",
"project": {
"name": "string",
"uid": "string"
},
"pureCpuCoreHours": "number"
}
],
"timestamp": "date-time",
"totalAlloyCpuCoreHours": "number",
"totalPureCpuCoreHours": "number"
}
]
}

https://api.spectrocloud.com/v1/tenants/{tenantUid}/user

summary:
Returns the user object of the specified tenant
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
200
OK
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"emailId": "string",
"firstName": "string",
"lastName": "string",
"roles": [
"string"
]
},
"status": {
"activationLink": "string",
"isActive": "boolean",
"lastSignIn": "date-time"
}
}

https://api.spectrocloud.com/v1/tenants/{tenantUid}/user

summary:
Updates the user object of the tenant
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"emailId": "string",
"firstName": "string",
"lastName": "string",
"roles": [
"string"
]
},
"status": {
"activationLink": "string",
"isActive": "boolean",
"lastSignIn": "date-time"
}
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/tenants/{tenantUid}/user

summary:
Creates an user using sysadmin privileges on behalf of the tenant
Path parameters:
NameTypeDescriptionRequired
tenantUidstringyes
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"emailId": "string",
"firstName": "string",
"lastName": "string",
"roles": [
"string"
],
"teams": [
"string"
]
}
}
201
Created successfully
{
"uid": "string"
}