Powered by Algolia

    System

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

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

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

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

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

    summary:
    get the system config aws devops account
    200
    (empty)
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "accessKey": "string",
    "secretKey": "string"
    },
    "status": {
    "state": "string"
    }
    }

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

    summary:
    updates the system config aws devops account
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "accessKey": "string",
    "secretKey": "string"
    },
    "status": {
    "state": "string"
    }
    }
    204
    (empty)

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

    summary:
    get the system aws image
    200
    (empty)
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "goldenImageRegion": "string"
    }
    }

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

    summary:
    updates the system default aws devops image
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "goldenImageRegion": "string"
    }
    }
    204
    (empty)

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

    summary:
    get the system azure account
    200
    (empty)
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "clientId": "string",
    "clientSecret": "string",
    "subscriptionId": "string",
    "tenantId": "string"
    },
    "status": {
    "state": "string"
    }
    }

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

    summary:
    updates the system default azure devops account
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "clientId": "string",
    "clientSecret": "string",
    "subscriptionId": "string",
    "tenantId": "string"
    },
    "status": {
    "state": "string"
    }
    }
    204
    (empty)

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

    summary:
    get the system azure storage
    200
    (empty)
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "accessKey": "string",
    "container": "string",
    "storageName": "string"
    }
    }

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

    summary:
    updates the system default azure devops storage
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "accessKey": "string",
    "container": "string",
    "storageName": "string"
    }
    }
    204
    (empty)

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

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

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

    summary:
    updates the system certificate
    Parameters:
    NameTypeDescriptionRequired
    crtFilefileno
    keyFilefileno
    200
    (empty)
    {
    "name": "string",
    "uid": "string"
    }

    deprecated

    https://api.spectrocloud.com/v1alpha1/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/v1alpha1/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/v1alpha1/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/v1alpha1/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/v1alpha1/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",
    "dir": "string",
    "region": "string",
    "secretKey": "string"
    }
    }

    https://api.spectrocloud.com/v1alpha1/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",
    "dir": "string",
    "region": "string",
    "secretKey": "string"
    }
    }
    204
    (empty)

    https://api.spectrocloud.com/v1alpha1/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/v1alpha1/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/v1alpha1/system/config/domain

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

    https://api.spectrocloud.com/v1alpha1/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/v1alpha1/system/config/gcp/account

    summary:
    get the system gcp account
    200
    (empty)
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "json": "string"
    },
    "status": {
    "state": "string"
    }
    }

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

    summary:
    updates the system default gcp devops account
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "json": "string"
    },
    "status": {
    "state": "string"
    }
    }
    204
    (empty)

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

    summary:
    get the system gcp image
    200
    (empty)
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "imageProject": "string"
    }
    }

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

    summary:
    updates the system default gcp devops image
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "imageProject": "string"
    }
    }
    204
    (empty)

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

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

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

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

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

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

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

    summary:
    get the billing preference
    200
    (empty)
    {
    "billingDay": "integer",
    "costPerCoreHour": "number"
    }

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

    summary:
    updates the billing preference
    {
    "billingDay": "integer",
    "costPerCoreHour": "number"
    }
    204
    (empty)

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

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

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

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

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

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

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

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

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

    summary:
    validates the s3 config
    Parameters:
    NameTypeDescriptionRequired
    permissionstringno
    {
    "backupSpec": {
    "hourOfTheDay": "integer",
    "interval": "integer",
    "retentionPeriod": "integer"
    },
    "s3": {
    "accessKey": "string",
    "bucket": "string",
    "dir": "string",
    "region": "string",
    "secretKey": "string"
    }
    }
    204
    Ok reponse without content

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

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

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

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

    https://api.spectrocloud.com/v1alpha1/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/v1alpha1/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/v1alpha1/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/v1alpha1/system/config/sso

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

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

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

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

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

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

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

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

    summary:
    get the system vsphere image
    200
    (empty)
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "imagesHostEndpoint": "string",
    "imagesLoadBalancerEndpoint": "string",
    "overlordOvaLocation": "string"
    }
    }

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

    summary:
    updates the system default vsphere devops image
    {
    "metadata": {
    "annotations": "object",
    "creationTimestamp": "date-time",
    "deletionTimestamp": "date-time",
    "labels": "object",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
    },
    "spec": {
    "imagesHostEndpoint": "string",
    "imagesLoadBalancerEndpoint": "string",
    "overlordOvaLocation": "string"
    }
    }
    204
    (empty)

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

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

    https://api.spectrocloud.com/v1alpha1/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/v1alpha1/system/database/backups/{backupUid}

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

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

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

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

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

    https://api.spectrocloud.com/v1alpha1/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/v1alpha1/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/v1alpha1/system/version/installed

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

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

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