System

→

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

summary:

email reset for system admin

Body

{
  "email": "string",
  "password": "string"
}

HTTP code: 204
Description: (empty)

→

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

summary:

password reset for system admin

Body

{
  "newPassword": "string",
  "oldPassword": "string"
}

HTTP code: 204
Description: (empty)

→

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

summary:

get the alerts specified for the system

HTTP code: 200
Description: (empty)
Response body:

{
  "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:

Name	Type	Description	Required
component	string		yes

Body

{
  "channels": [
    {
      "alertAllUsers": "boolean",
      "http": {
        "body": "string",
        "method": "string",
        "url": "string"
      },
      "identifiers": [
        "string"
      ],
      "isActive": "boolean",
      "type": "string"
    }
  ]
}

HTTP code: 204
Description: The resource was updated successfully

→

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

summary:

Deletes the specified alert to the specified system

Path parameters:

Name	Type	Description	Required
component	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

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

summary:

get the system config aws devops account

HTTP code: 200
Description: (empty)
Response body:

{
  "spec": {
    "accessKey": "string",
    "secretKey": "string"
  }
}

→

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

summary:

updates the system config aws devops account

Body

{
  "spec": {
    "accessKey": "string",
    "secretKey": "string"
  }
}

HTTP code: 204
Description: (empty)

→

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

summary:

get the system aws image

HTTP code: 200
Description: (empty)
Response body:

{
  "spec": {
    "goldenImageRegion": "string"
  }
}

→

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

summary:

updates the system default aws devops image

Body

{
  "spec": {
    "goldenImageRegion": "string"
  }
}

HTTP code: 204
Description: (empty)

→

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

summary:

get the system config aws sts devops account

HTTP code: 200
Description: (empty)
Response body:

{
  "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

Body

{
  "accessKey": "string",
  "accountId": "string",
  "secretKey": "string"
}

HTTP code: 204
Description: (empty)

→

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

summary:

get the system azure account

HTTP code: 200
Description: (empty)
Response body:

{
  "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

Body

{
  "spec": {
    "clientId": "string",
    "clientSecret": "string",
    "subscriptionId": "string",
    "tenantId": "string"
  }
}

HTTP code: 204
Description: (empty)

→

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

summary:

get the system azure storage

HTTP code: 200
Description: (empty)
Response body:

{
  "spec": {
    "accessKey": "string",
    "container": "string",
    "storageName": "string"
  }
}

→

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

summary:

updates the system default azure devops storage

Body

{
  "spec": {
    "accessKey": "string",
    "container": "string",
    "storageName": "string"
  }
}

HTTP code: 204
Description: (empty)

→

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

summary:

get the system certificates

HTTP code: 200
Description: (empty)
Response body:

{
  "crt": "string",
  "key": "string"
}

→

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

summary:

updates the system certificate

Body

{
  "crt": "string",
  "key": "string"
}

HTTP code: 204
Description: (empty)

deprecated→

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

description:

Deprecated. Use the config specific apis.

HTTP code: 200
Description: (empty)
Response body:

{
  "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.

Body

{
  "ftp": {
    "dir": "string",
    "password": "string",
    "server": "string",
    "username": "string"
  },
  "hourOfTheDay": "integer",
  "interval": "integer",
  "retentionPeriod": "integer"
}

HTTP code: 204
Description: (empty)

→

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

summary:

get the system backup interval config

HTTP code: 200
Description: (empty)
Response body:

{
  "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

Body

{
  "backupSpec": {
    "hourOfTheDay": "integer",
    "interval": "integer",
    "retentionPeriod": "integer"
  },
  "ftp": {
    "dir": "string",
    "password": "string",
    "server": "string",
    "username": "string"
  }
}

HTTP code: 204
Description: (empty)

→

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

summary:

get the system backup s3 config

HTTP code: 200
Description: (empty)
Response body:

{
  "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

Body

{
  "backupSpec": {
    "hourOfTheDay": "integer",
    "interval": "integer",
    "retentionPeriod": "integer"
  },
  "s3": {
    "accessKey": "string",
    "bucket": "string",
    "folder": "string",
    "region": "string",
    "secretKey": "string"
  }
}

HTTP code: 204
Description: (empty)

→

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

summary:

get the system domain config

HTTP code: 200
Description: (empty)
Response body:

{
  "apiServer": "string",
  "derivedApiServer": "string",
  "derivedRootDomain": "string",
  "rootDomain": "string",
  "urlProtocol": "string"
}

→

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

summary:

updates the system domain config

Body

{
  "apiServer": "string",
  "derivedApiServer": "string",
  "derivedRootDomain": "string",
  "rootDomain": "string",
  "urlProtocol": "string"
}

HTTP code: 204
Description: (empty)

→

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

summary:

update domain host url

Body

{
  "host": "string"
}

HTTP code: 204
Description: (empty)

→

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

summary:

validates the ftp config

Parameters:

Name	Type	Description	Required
permission	string		no

Body

{
  "dir": "string",
  "password": "string",
  "server": "string",
  "username": "string"
}

HTTP code: 204
Description: Ok reponse without content

→

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

summary:

get the system gcp account

HTTP code: 200
Description: (empty)
Response body:

{
  "spec": {
    "json": "string"
  }
}

→

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

summary:

updates the system default gcp devops account

Body

{
  "spec": {
    "json": "string"
  }
}

HTTP code: 204
Description: (empty)

→

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

summary:

get the system gcp image

HTTP code: 200
Description: (empty)
Response body:

{
  "spec": {
    "imageProject": "string"
  }
}

→

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

summary:

updates the system default gcp devops image

Body

{
  "spec": {
    "imageProject": "string"
  }
}

HTTP code: 204
Description: (empty)

→

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

summary:

get the system logger

HTTP code: 200
Description: (empty)
Response body:

{
  "format": "string",
  "level": "string"
}

→

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

summary:

updates the system logger

Body

{
  "format": "string",
  "level": "string"
}

HTTP code: 204
Description: (empty)

→

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

summary:

get the system maas image

HTTP code: 200
Description: (empty)
Response body:

{
  "spec": {
    "imagesHostEndpoint": "string"
  }
}

→

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

summary:

updates the system default maas devops image

Body

{
  "spec": {
    "imagesHostEndpoint": "string"
  }
}

HTTP code: 204
Description: (empty)

→

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

summary:

get the system openstack image

HTTP code: 200
Description: (empty)
Response body:

{
  "spec": {
    "imagesHostEndpoint": "string"
  }
}

→

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

summary:

updates the system default openstack devops image

Body

{
  "spec": {
    "imagesHostEndpoint": "string"
  }
}

HTTP code: 204
Description: (empty)

→

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

summary:

updates the payment secrets

Body

{
  "publishableKey": "string",
  "secretKey": "string"
}

HTTP code: 204
Description: (empty)

→

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

summary:

get the billing preference

HTTP code: 200
Description: (empty)
Response body:

{
  "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

Body

{
  "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"
      }
    ]
  }
}

HTTP code: 204
Description: (empty)

→

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

summary:

get the cluster preference

HTTP code: 200
Description: (empty)
Response body:

{
  "archivalInterval": "integer",
  "deletePeriod": "integer",
  "monitorInterval": "integer"
}

→

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

summary:

updates the cluster preference

Body

{
  "archivalInterval": "integer",
  "deletePeriod": "integer",
  "monitorInterval": "integer"
}

HTTP code: 204
Description: (empty)

→

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

summary:

get the system proxy

HTTP code: 200
Description: (empty)
Response body:

{
  "httpProxy": "string",
  "httpsProxy": "string",
  "noProxy": "string"
}

→

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

summary:

updates the system proxy

Body

{
  "httpProxy": "string",
  "httpsProxy": "string",
  "noProxy": "string"
}

HTTP code: 204
Description: (empty)

→

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

summary:

get the system config reverse proxy

HTTP code: 200
Description: (empty)
Response body:

{
  "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

Body

{
  "caCert": "string",
  "clientCert": "string",
  "clientKey": "string",
  "port": "integer",
  "protocol": "string",
  "server": "string"
}

HTTP code: 204
Description: (empty)

→

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

summary:

validates the s3 config

Parameters:

Name	Type	Description	Required
permission	string		no

Body

{
  "accessKey": "string",
  "bucket": "string",
  "folder": "string",
  "region": "string",
  "secretKey": "string"
}

HTTP code: 204
Description: Ok reponse without content

→

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

summary:

get the system Spectro repository

HTTP code: 200
Description: (empty)
Response body:

{
  "endpoint": "string",
  "password": "string",
  "username": "string"
}

→

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

summary:

updates the system Spectro repository

Body

{
  "endpoint": "string",
  "password": "string",
  "username": "string"
}

HTTP code: 204
Description: (empty)

→

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

summary:

get the system smtp

HTTP code: 200
Description: (empty)
Response body:

{
  "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

Body

{
  "fromEmailId": "string",
  "insecureSkipVerifyTls": "boolean",
  "password": "string",
  "smtpPort": "integer",
  "smtpServer": "string",
  "userName": "string"
}

HTTP code: 204
Description: (empty)

→

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

summary:

validates the system smtp

Body

{
  "fromEmailId": "string",
  "insecureSkipVerifyTls": "boolean",
  "password": "string",
  "smtpPort": "integer",
  "smtpServer": "string",
  "userName": "string"
}

HTTP code: 204
Description: Ok reponse without content

→

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

summary:

get the system sso

HTTP code: 200
Description: (empty)
Response body:

{
  "acsUrlRoot": "string",
  "acsUrlScheme": "string",
  "apiVersion": "string",
  "audienceUrl": "string",
  "entityId": "string"
}

→

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

summary:

updates the system sso

Body

{
  "acsUrlRoot": "string",
  "acsUrlScheme": "string",
  "apiVersion": "string",
  "audienceUrl": "string",
  "entityId": "string"
}

HTTP code: 204
Description: (empty)

→

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

summary:

get the system timeseries

HTTP code: 200
Description: (empty)
Response body:

{
  "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

Body

{
  "machine": {
    "archivalInterval": "integer",
    "batchInterval": "integer",
    "enabled": "boolean",
    "retentionPeriod": "integer"
  },
  "pod": {
    "archivalInterval": "integer",
    "batchInterval": "integer",
    "enabled": "boolean",
    "retentionPeriod": "integer"
  }
}

HTTP code: 204
Description: (empty)

→

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

summary:

get the system vsphere image

HTTP code: 200
Description: (empty)
Response body:

{
  "spec": {
    "imagesHostEndpoint": "string",
    "overlordOvaLocation": "string"
  }
}

→

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

summary:

updates the system default vsphere devops image

Body

{
  "spec": {
    "imagesHostEndpoint": "string",
    "overlordOvaLocation": "string"
  }
}

HTTP code: 204
Description: (empty)

→

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

summary:

backup the database

Parameters:

Name	Type	Description	Required
mode	string		no

HTTP code: 204
Description: (empty)

→

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

summary:

get the database status

Parameters:

Name	Type	Description	Required
mode	string		no

HTTP code: 200
Description: (empty)
Response body:

{
  "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:

Name	Type	Description	Required
backupUid	string		yes
mode	string		no

HTTP code: 204
Description: The resource was deleted successfully

→

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

summary:

recover the database

Parameters:

Name	Type	Description	Required
backupUid	string		yes
mode	string		yes

HTTP code: 204
Description: (empty)

→

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

summary:

restore the database

Parameters:

Name	Type	Description	Required
backupUid	string		yes
mode	string		no

HTTP code: 204
Description: (empty)

→

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

summary:

encrypt the system data

Body

{
  "input": "string"
}

HTTP code: 200
Description: (empty)
Response body:

{
  "input": "string",
  "result": "string"
}

→

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

summary:

get the system password policy

HTTP code: 200
Description: (empty)
Response body:

{
  "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

Body

{
  "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"
}

HTTP code: 204
Description: (empty)

→

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

summary:

get the system plan

HTTP code: 200
Description: (empty)
Response body:

{
  "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:

Name	Type	Description	Required
creditUid	string		yes

Body

{
  "credit": {
    "cpuCoreHours": "number",
    "expiry": "date-time",
    "name": "string",
    "start": "date-time",
    "type": "string"
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

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

summary:

Deletes the specified Plan's credit data

Path parameters:

Name	Type	Description	Required
creditUid	string		yes

HTTP code: 204
Description: The resource was deleted successfully

→

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

summary:

Add system free credit

Body

{
  "credit": {
    "cpuCoreHours": "number",
    "expiry": "date-time",
    "name": "string",
    "start": "date-time",
    "type": "string"
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

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

summary:

Updates the specified system plan's limit

Body

{
  "planLimit": {
    "alloy": {
      "cpuCoreHours": "integer",
      "overageLimitPercentage": "integer",
      "warnLimitPercentage": "integer"
    },
    "isUnlimited": "boolean",
    "pure": {
      "cpuCoreHours": "integer",
      "overageLimitPercentage": "integer",
      "warnLimitPercentage": "integer"
    }
  }
}

HTTP code: 204
Description: The resource was updated successfully

→

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

summary:

Adds system sla breach credit

Body

{
  "credit": {
    "cpuCoreHours": "number",
    "expiry": "date-time",
    "name": "string",
    "start": "date-time",
    "type": "string"
  }
}

HTTP code: 201
Description: Created successfully
Response body:

{
  "uid": "string"
}

→

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

summary:

updates the system start date

Body

{
  "systemStartDate": "date-time"
}

HTTP code: 204
Description: (empty)

→

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

summary:

get the system installed version

HTTP code: 200
Description: (empty)
Response body:

{
  "version": "string"
}

→

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

summary:

get the system latest available version

HTTP code: 200
Description: (empty)
Response body:

{
  "version": "string"
}

Edit on GitHub