System

https://api.spectrocloud.com/v1/system/admin/email

summary:
email reset for system admin
{
"email": "string",
"password": "string"
}
204
(empty)

https://api.spectrocloud.com/v1/system/admin/password/reset

summary:
password reset for system admin
{
"newPassword": "string",
"oldPassword": "string"
}
204
(empty)

https://api.spectrocloud.com/v1/system/alerts

summary:
get the alerts specified for the system
200
(empty)
{
"items": {
"channels": [
{
"alertAllUsers": "boolean",
"http": {
"body": "string",
"method": "string",
"url": "string"
},
"identifiers": [
"string"
],
"isActive": "boolean",
"type": "string"
}
],
"component": "string"
}
}

https://api.spectrocloud.com/v1/system/alerts/{component}

summary:
Upsert the specified alert to the specified system
Path parameters:
NameTypeDescriptionRequired
componentstringyes
{
"channels": [
{
"alertAllUsers": "boolean",
"http": {
"body": "string",
"method": "string",
"url": "string"
},
"identifiers": [
"string"
],
"isActive": "boolean",
"type": "string"
}
]
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/system/alerts/{component}

summary:
Deletes the specified alert to the specified system
Path parameters:
NameTypeDescriptionRequired
componentstringyes
204
The resource was deleted successfully

https://api.spectrocloud.com/v1/system/config/aws/account

summary:
get the system config aws devops account
200
(empty)
{
"spec": {
"accessKey": "string",
"secretKey": "string"
}
}

https://api.spectrocloud.com/v1/system/config/aws/account

summary:
updates the system config aws devops account
{
"spec": {
"accessKey": "string",
"secretKey": "string"
}
}
204
(empty)

https://api.spectrocloud.com/v1/system/config/aws/image

summary:
get the system aws image
200
(empty)
{
"spec": {
"goldenImageRegion": "string"
}
}

https://api.spectrocloud.com/v1/system/config/aws/image

summary:
updates the system default aws devops image
{
"spec": {
"goldenImageRegion": "string"
}
}
204
(empty)

https://api.spectrocloud.com/v1/system/config/aws/sts/account

summary:
get the system config aws sts devops account
200
(empty)
{
"accessKey": "string",
"accountId": "string",
"secretKey": "string"
}

https://api.spectrocloud.com/v1/system/config/aws/sts/account

summary:
updates the system config aws sts devops account
{
"accessKey": "string",
"accountId": "string",
"secretKey": "string"
}
204
(empty)

https://api.spectrocloud.com/v1/system/config/azure/account

summary:
get the system azure account
200
(empty)
{
"spec": {
"clientId": "string",
"clientSecret": "string",
"subscriptionId": "string",
"tenantId": "string"
}
}

https://api.spectrocloud.com/v1/system/config/azure/account

summary:
updates the system default azure devops account
{
"spec": {
"clientId": "string",
"clientSecret": "string",
"subscriptionId": "string",
"tenantId": "string"
}
}
204
(empty)

https://api.spectrocloud.com/v1/system/config/azure/storage

summary:
get the system azure storage
200
(empty)
{
"spec": {
"accessKey": "string",
"container": "string",
"storageName": "string"
}
}

https://api.spectrocloud.com/v1/system/config/azure/storage

summary:
updates the system default azure devops storage
{
"spec": {
"accessKey": "string",
"container": "string",
"storageName": "string"
}
}
204
(empty)

https://api.spectrocloud.com/v1/system/config/certificate

summary:
get the system certificates
200
(empty)
{
"crt": "string",
"key": "string"
}

https://api.spectrocloud.com/v1/system/config/certificate

summary:
updates the system certificate
{
"crt": "string",
"key": "string"
}
204
(empty)

deprecated

https://api.spectrocloud.com/v1/system/config/database/backup/

description:
Deprecated. Use the config specific apis.
200
(empty)
{
"ftp": {
"dir": "string",
"password": "string",
"server": "string",
"username": "string"
},
"hourOfTheDay": "integer",
"interval": "integer",
"retentionPeriod": "integer"
}

deprecated

https://api.spectrocloud.com/v1/system/config/database/backup/

summary:
updates the system backup config
description:
Deprecated. Use the config specific apis.
{
"ftp": {
"dir": "string",
"password": "string",
"server": "string",
"username": "string"
},
"hourOfTheDay": "integer",
"interval": "integer",
"retentionPeriod": "integer"
}
204
(empty)

https://api.spectrocloud.com/v1/system/config/database/backup/ftp

summary:
get the system backup interval config
200
(empty)
{
"backupSpec": {
"hourOfTheDay": "integer",
"interval": "integer",
"retentionPeriod": "integer"
},
"ftp": {
"dir": "string",
"password": "string",
"server": "string",
"username": "string"
}
}

https://api.spectrocloud.com/v1/system/config/database/backup/ftp

summary:
updates the system backup interval config
{
"backupSpec": {
"hourOfTheDay": "integer",
"interval": "integer",
"retentionPeriod": "integer"
},
"ftp": {
"dir": "string",
"password": "string",
"server": "string",
"username": "string"
}
}
204
(empty)

https://api.spectrocloud.com/v1/system/config/database/backup/s3

summary:
get the system backup s3 config
200
(empty)
{
"backupSpec": {
"hourOfTheDay": "integer",
"interval": "integer",
"retentionPeriod": "integer"
},
"s3": {
"accessKey": "string",
"bucket": "string",
"folder": "string",
"region": "string",
"secretKey": "string"
}
}

https://api.spectrocloud.com/v1/system/config/database/backup/s3

summary:
updates the system backup ftp storage config
{
"backupSpec": {
"hourOfTheDay": "integer",
"interval": "integer",
"retentionPeriod": "integer"
},
"s3": {
"accessKey": "string",
"bucket": "string",
"folder": "string",
"region": "string",
"secretKey": "string"
}
}
204
(empty)

https://api.spectrocloud.com/v1/system/config/domain

summary:
get the system domain config
200
(empty)
{
"apiServer": "string",
"derivedApiServer": "string",
"derivedRootDomain": "string",
"rootDomain": "string",
"urlProtocol": "string"
}

https://api.spectrocloud.com/v1/system/config/domain

summary:
updates the system domain config
{
"apiServer": "string",
"derivedApiServer": "string",
"derivedRootDomain": "string",
"rootDomain": "string",
"urlProtocol": "string"
}
204
(empty)

https://api.spectrocloud.com/v1/system/config/domain

summary:
update domain host url
{
"host": "string"
}
204
(empty)

https://api.spectrocloud.com/v1/system/config/ftp/validate

summary:
validates the ftp config
Parameters:
NameTypeDescriptionRequired
permissionstringno
{
"dir": "string",
"password": "string",
"server": "string",
"username": "string"
}
204
Ok reponse without content

https://api.spectrocloud.com/v1/system/config/gcp/account

summary:
get the system gcp account
200
(empty)
{
"spec": {
"json": "string"
}
}

https://api.spectrocloud.com/v1/system/config/gcp/account

summary:
updates the system default gcp devops account
{
"spec": {
"json": "string"
}
}
204
(empty)

https://api.spectrocloud.com/v1/system/config/gcp/image

summary:
get the system gcp image
200
(empty)
{
"spec": {
"imageProject": "string"
}
}

https://api.spectrocloud.com/v1/system/config/gcp/image

summary:
updates the system default gcp devops image
{
"spec": {
"imageProject": "string"
}
}
204
(empty)

https://api.spectrocloud.com/v1/system/config/logger

summary:
get the system logger
200
(empty)
{
"format": "string",
"level": "string"
}

https://api.spectrocloud.com/v1/system/config/logger

summary:
updates the system logger
{
"format": "string",
"level": "string"
}
204
(empty)

https://api.spectrocloud.com/v1/system/config/maas/image

summary:
get the system maas image
200
(empty)
{
"spec": {
"imagesHostEndpoint": "string"
}
}

https://api.spectrocloud.com/v1/system/config/maas/image

summary:
updates the system default maas devops image
{
"spec": {
"imagesHostEndpoint": "string"
}
}
204
(empty)

https://api.spectrocloud.com/v1/system/config/openstack/image

summary:
get the system openstack image
200
(empty)
{
"spec": {
"imagesHostEndpoint": "string"
}
}

https://api.spectrocloud.com/v1/system/config/openstack/image

summary:
updates the system default openstack devops image
{
"spec": {
"imagesHostEndpoint": "string"
}
}
204
(empty)

https://api.spectrocloud.com/v1/system/config/paymentsecrets

summary:
updates the payment secrets
{
"publishableKey": "string",
"secretKey": "string"
}
204
(empty)

https://api.spectrocloud.com/v1/system/config/preferences/billing

summary:
get the billing preference
200
(empty)
{
"billingDay": "integer",
"tierPricing": {
"alloyPricing": [
{
"discount": "number",
"startFrom": "number",
"unitAmount": "number",
"upTo": "number",
"upToInfinity": "boolean"
}
],
"purePricing": [
{
"discount": "number",
"startFrom": "number",
"unitAmount": "number",
"upTo": "number",
"upToInfinity": "boolean"
}
]
}
}

https://api.spectrocloud.com/v1/system/config/preferences/billing

summary:
updates the billing preference
{
"billingDay": "integer",
"tierPricing": {
"alloyPricing": [
{
"discount": "number",
"startFrom": "number",
"unitAmount": "number",
"upTo": "number",
"upToInfinity": "boolean"
}
],
"purePricing": [
{
"discount": "number",
"startFrom": "number",
"unitAmount": "number",
"upTo": "number",
"upToInfinity": "boolean"
}
]
}
}
204
(empty)

https://api.spectrocloud.com/v1/system/config/preferences/cluster

summary:
get the cluster preference
200
(empty)
{
"archivalInterval": "integer",
"deletePeriod": "integer",
"monitorInterval": "integer"
}

https://api.spectrocloud.com/v1/system/config/preferences/cluster

summary:
updates the cluster preference
{
"archivalInterval": "integer",
"deletePeriod": "integer",
"monitorInterval": "integer"
}
204
(empty)

https://api.spectrocloud.com/v1/system/config/proxy

summary:
get the system proxy
200
(empty)
{
"httpProxy": "string",
"httpsProxy": "string",
"noProxy": "string"
}

https://api.spectrocloud.com/v1/system/config/proxy

summary:
updates the system proxy
{
"httpProxy": "string",
"httpsProxy": "string",
"noProxy": "string"
}
204
(empty)

https://api.spectrocloud.com/v1/system/config/reverseproxy

summary:
get the system config reverse proxy
200
(empty)
{
"caCert": "string",
"clientCert": "string",
"clientKey": "string",
"port": "integer",
"protocol": "string",
"server": "string"
}

https://api.spectrocloud.com/v1/system/config/reverseproxy

summary:
updates the system config reverse proxy
{
"caCert": "string",
"clientCert": "string",
"clientKey": "string",
"port": "integer",
"protocol": "string",
"server": "string"
}
204
(empty)

https://api.spectrocloud.com/v1/system/config/s3/validate

summary:
validates the s3 config
Parameters:
NameTypeDescriptionRequired
permissionstringno
{
"accessKey": "string",
"bucket": "string",
"folder": "string",
"region": "string",
"secretKey": "string"
}
204
Ok reponse without content

https://api.spectrocloud.com/v1/system/config/scar

summary:
get the system Spectro repository
200
(empty)
{
"endpoint": "string",
"password": "string",
"username": "string"
}

https://api.spectrocloud.com/v1/system/config/scar

summary:
updates the system Spectro repository
{
"endpoint": "string",
"password": "string",
"username": "string"
}
204
(empty)

https://api.spectrocloud.com/v1/system/config/smtp

summary:
get the system smtp
200
(empty)
{
"fromEmailId": "string",
"insecureSkipVerifyTls": "boolean",
"password": "string",
"smtpPort": "integer",
"smtpServer": "string",
"userName": "string"
}

https://api.spectrocloud.com/v1/system/config/smtp

summary:
updates the system smtp
{
"fromEmailId": "string",
"insecureSkipVerifyTls": "boolean",
"password": "string",
"smtpPort": "integer",
"smtpServer": "string",
"userName": "string"
}
204
(empty)

https://api.spectrocloud.com/v1/system/config/smtp/validate

summary:
validates the system smtp
{
"fromEmailId": "string",
"insecureSkipVerifyTls": "boolean",
"password": "string",
"smtpPort": "integer",
"smtpServer": "string",
"userName": "string"
}
204
Ok reponse without content

https://api.spectrocloud.com/v1/system/config/sso

summary:
get the system sso
200
(empty)
{
"acsUrlRoot": "string",
"acsUrlScheme": "string",
"apiVersion": "string",
"audienceUrl": "string",
"entityId": "string"
}

https://api.spectrocloud.com/v1/system/config/sso

summary:
updates the system sso
{
"acsUrlRoot": "string",
"acsUrlScheme": "string",
"apiVersion": "string",
"audienceUrl": "string",
"entityId": "string"
}
204
(empty)

https://api.spectrocloud.com/v1/system/config/timeseries

summary:
get the system timeseries
200
(empty)
{
"machine": {
"archivalInterval": "integer",
"batchInterval": "integer",
"enabled": "boolean",
"retentionPeriod": "integer"
},
"pod": {
"archivalInterval": "integer",
"batchInterval": "integer",
"enabled": "boolean",
"retentionPeriod": "integer"
}
}

https://api.spectrocloud.com/v1/system/config/timeseries

summary:
updates the system timeseries
{
"machine": {
"archivalInterval": "integer",
"batchInterval": "integer",
"enabled": "boolean",
"retentionPeriod": "integer"
},
"pod": {
"archivalInterval": "integer",
"batchInterval": "integer",
"enabled": "boolean",
"retentionPeriod": "integer"
}
}
204
(empty)

https://api.spectrocloud.com/v1/system/config/vsphere/image

summary:
get the system vsphere image
200
(empty)
{
"spec": {
"imagesHostEndpoint": "string",
"overlordOvaLocation": "string"
}
}

https://api.spectrocloud.com/v1/system/config/vsphere/image

summary:
updates the system default vsphere devops image
{
"spec": {
"imagesHostEndpoint": "string",
"overlordOvaLocation": "string"
}
}
204
(empty)

https://api.spectrocloud.com/v1/system/database/backup

summary:
backup the database
Parameters:
NameTypeDescriptionRequired
modestringno
204
(empty)

https://api.spectrocloud.com/v1/system/database/backups

summary:
get the database status
Parameters:
NameTypeDescriptionRequired
modestringno
200
(empty)
{
"backups": [
{
"backupStatus": {
"finishTime": "date-time",
"folder": "string",
"isCompleted": "boolean",
"message": [
"string"
],
"startTime": "date-time",
"state": "string",
"status": [
"string"
]
},
"backupUid": "string",
"mode": "string"
}
],
"isActive": "boolean"
}

https://api.spectrocloud.com/v1/system/database/backups/{backupUid}

summary:
delete the database backup
Parameters:
NameTypeDescriptionRequired
backupUidstringyes
modestringno
204
The resource was deleted successfully

https://api.spectrocloud.com/v1/system/database/recovery/{backupUid}/{mode}

summary:
recover the database
Parameters:
NameTypeDescriptionRequired
backupUidstringyes
modestringyes
204
(empty)

https://api.spectrocloud.com/v1/system/database/restore/{backupUid}

summary:
restore the database
Parameters:
NameTypeDescriptionRequired
backupUidstringyes
modestringno
204
(empty)

https://api.spectrocloud.com/v1/system/encrypt

summary:
encrypt the system data
{
"input": "string"
}
200
(empty)
{
"input": "string",
"result": "string"
}

https://api.spectrocloud.com/v1/system/password/policy/default

summary:
get the system password policy
200
(empty)
{
"creationTimestamp": "date-time",
"expiryDurationInDays": "integer",
"firstReminderInDays": "integer",
"isRegex": "boolean",
"minLength": "integer",
"minNumOfBlockLetters": "integer",
"minNumOfDigits": "integer",
"minNumOfSmallLetters": "integer",
"minNumOfSpecialCharacters": "integer",
"regex": "string",
"reminderFrequency": "integer",
"updateTimestamp": "date-time"
}

https://api.spectrocloud.com/v1/system/password/policy/default

summary:
updates the system admin
{
"creationTimestamp": "date-time",
"expiryDurationInDays": "integer",
"firstReminderInDays": "integer",
"isRegex": "boolean",
"minLength": "integer",
"minNumOfBlockLetters": "integer",
"minNumOfDigits": "integer",
"minNumOfSmallLetters": "integer",
"minNumOfSpecialCharacters": "integer",
"regex": "string",
"reminderFrequency": "integer",
"updateTimestamp": "date-time"
}
204
(empty)

https://api.spectrocloud.com/v1/system/plan

summary:
get the system plan
200
(empty)
{
"freeCredits": [
{
"cpuCoreHours": "number",
"creditUid": "string",
"expiry": "date-time",
"name": "string",
"start": "date-time",
"type": "string"
}
],
"planLimit": {
"alloy": {
"cpuCoreHours": "integer",
"overageLimitPercentage": "integer",
"warnLimitPercentage": "integer"
},
"isUnlimited": "boolean",
"pure": {
"cpuCoreHours": "integer",
"overageLimitPercentage": "integer",
"warnLimitPercentage": "integer"
}
},
"slaCredits": [
{
"cpuCoreHours": "number",
"creditUid": "string",
"expiry": "date-time",
"name": "string",
"start": "date-time",
"type": "string"
}
],
"systemStartDate": "date-time"
}

https://api.spectrocloud.com/v1/system/plan/credits/{creditUid}

summary:
Updates the specified Plan's credit data
Path parameters:
NameTypeDescriptionRequired
creditUidstringyes
{
"credit": {
"cpuCoreHours": "number",
"expiry": "date-time",
"name": "string",
"start": "date-time",
"type": "string"
}
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/system/plan/credits/{creditUid}

summary:
Deletes the specified Plan's credit data
Path parameters:
NameTypeDescriptionRequired
creditUidstringyes
204
The resource was deleted successfully

https://api.spectrocloud.com/v1/system/plan/freeCredit

summary:
Add system free credit
{
"credit": {
"cpuCoreHours": "number",
"expiry": "date-time",
"name": "string",
"start": "date-time",
"type": "string"
}
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/system/plan/planLimit

summary:
Updates the specified system plan's limit
{
"planLimit": {
"alloy": {
"cpuCoreHours": "integer",
"overageLimitPercentage": "integer",
"warnLimitPercentage": "integer"
},
"isUnlimited": "boolean",
"pure": {
"cpuCoreHours": "integer",
"overageLimitPercentage": "integer",
"warnLimitPercentage": "integer"
}
}
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/system/plan/slaCredit

summary:
Adds system sla breach credit
{
"credit": {
"cpuCoreHours": "number",
"expiry": "date-time",
"name": "string",
"start": "date-time",
"type": "string"
}
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/system/plan/startDate

summary:
updates the system start date
{
"systemStartDate": "date-time"
}
204
(empty)

https://api.spectrocloud.com/v1/system/version/installed

summary:
get the system installed version
200
(empty)
{
"version": "string"
}

https://api.spectrocloud.com/v1/system/version/latest

summary:
get the system latest available version
200
(empty)
{
"version": "string"
}