→
https://api.spectrocloud.com/v1/workspaces
summary:
Create workspace{"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": {"clusterNamespaces": [{"name": "string","namespaceResourceAllocation": {"clusterResourceAllocations": [{"clusterUid": "string","resourceAllocation": {"cpuCores": "number","memoryMiB": "number"}}],"defaultResourceAllocation": {"cpuCores": "number","memoryMiB": "number"}}}],"clusterRbacs": [{"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": {"bindings": [{"namespace": "string","role": {"kind": "string","name": "string"},"subjects": [{"name": "string","namespace": "string","type": "string"}],"type": "string"}],"relatedObject": {"kind": "string","name": "string","uid": "string"}},"status": {"errors": [{"msg": "string","name": "string","resourceType": "string"}]}}],"clusterRefs": [{"clusterName": "string","clusterUid": "string"}],"policies": {"backupPolicy": {"backupConfig": {"backupLocationUid": "string","backupName": "string","backupPrefix": "string","durationInHours": "number","includeAllDisks": "boolean","includeClusterResources": "boolean","locationType": "string","namespaces": ["string"],"schedule": {"scheduledRunTime": "string"}},"clusterUids": ["string"],"includeAllClusters": "boolean"}}}}
201
Created successfully
Created successfully
{"uid": "string"}
→
https://api.spectrocloud.com/v1/workspaces/teams/{teamUid}/roles
summary:
Returns the specified team's workspaces and roles dataPath parameters:
Name | Type | Description | Required |
---|---|---|---|
teamUid | string | yes |
200
OK
OK
{"projects": [{"name": "string","uid": "string","workspaces": [{"inheritedRoles": [{"name": "string","uid": "string"}],"name": "string","roles": [{"name": "string","uid": "string"}],"uid": "string"}]}]}
→
https://api.spectrocloud.com/v1/workspaces/teams/{teamUid}/roles
summary:
Updates the workspace roles for the specified teamPath parameters:
Name | Type | Description | Required |
---|---|---|---|
teamUid | string | yes |
{"workspaces": [{"roles": ["string"],"uid": "string"}]}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1/workspaces/users/{userUid}/roles
summary:
Returns the specified User workspaces and Roles informationdescription:
Returns a User with workspaces and rolesPath parameters:
Name | Type | Description | Required |
---|---|---|---|
userUid | string | yes |
200
OK
OK
{"projects": [{"name": "string","uid": "string","workspaces": [{"inheritedRoles": [{"name": "string","uid": "string"}],"name": "string","roles": [{"name": "string","uid": "string"}],"uid": "string"}]}]}
→
https://api.spectrocloud.com/v1/workspaces/users/{userUid}/roles
summary:
Updates the workspace roles for userdescription:
User is updated with workspace rolesPath parameters:
Name | Type | Description | Required |
---|---|---|---|
userUid | string | yes |
{"workspaces": [{"roles": ["string"],"uid": "string"}]}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1/workspaces/validate/name
summary:
Validates the workspace nameParameters:
Name | Type | Description | Required |
---|---|---|---|
name | string | yes |
204
Ok reponse without content
Ok reponse without content
→
https://api.spectrocloud.com/v1/workspaces/{uid}
summary:
Returns the specified workspacePath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
200
OK
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": {"clusterNamespaces": [{"name": "string","namespaceResourceAllocation": {"clusterResourceAllocations": [{"clusterUid": "string","resourceAllocation": {"cpuCores": "number","memoryMiB": "number"}}],"defaultResourceAllocation": {"cpuCores": "number","memoryMiB": "number"}}}],"clusterRbacs": [{"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": {"bindings": [{"namespace": "string","role": {"kind": "string","name": "string"},"subjects": [{"name": "string","namespace": "string","type": "string"}],"type": "string"}],"relatedObject": {"kind": "string","name": "string","uid": "string"}},"status": {"errors": [{"msg": "string","name": "string","resourceType": "string"}]}}],"clusterRefs": [{"clusterName": "string","clusterUid": "string"}],"policies": {"backupPolicy": {"backupConfig": {"backupLocationUid": "string","backupName": "string","backupPrefix": "string","durationInHours": "number","includeAllDisks": "boolean","includeClusterResources": "boolean","locationType": "string","namespaces": ["string"],"schedule": {"scheduledRunTime": "string"}},"clusterUids": ["string"],"includeAllClusters": "boolean"}}},"status": {"errors": [{"clusterUid": "string","msg": "string","name": "string","resourceType": "string"}]}}
→
https://api.spectrocloud.com/v1/workspaces/{uid}
summary:
Deletes the specified workspacePath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
204
The resource was deleted successfully
The resource was deleted successfully
→
https://api.spectrocloud.com/v1/workspaces/{uid}/backup
summary:
Returns the workspace backup resultParameters:
Name | Type | Description | Required |
---|---|---|---|
backupRequestUid | string | no |
Path parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
200
OK
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": {"config": {"backupConfig": {"backupLocationUid": "string","backupName": "string","backupPrefix": "string","durationInHours": "number","includeAllDisks": "boolean","includeClusterResources": "boolean","locationType": "string","namespaces": ["string"],"schedule": {"scheduledRunTime": "string"}},"clusterUids": ["string"],"includeAllClusters": "boolean"},"workspaceUid": "string"},"status": {"workspaceBackupStatuses": [{"actor": {"actorType": "string","uid": "string"},"requestUid": "string","workspaceBackupConfig": {"backupName": "string","backupState": {"deleteState": "string","state": "string"},"backupTime": "date-time","clusterBackupRefs": [{"backupStatusMeta": {"backupName": "string","backupState": {"backupTime": "date-time","deleteState": "string","msg": "string","state": "string"},"backupedNamespaces": ["string"],"expiryDate": "date-time"},"backupUid": "string","clusterName": "string","clusterUid": "string"}],"config": {"backupName": "string","durationInHours": "number","includeAllDisks": "boolean","includeClusterResources": "boolean","namespaces": ["string"]},"requestTime": "date-time"}}]}}
→
https://api.spectrocloud.com/v1/workspaces/{uid}/backup
summary:
Update workspace backup settingsPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"backupConfig": {"backupLocationUid": "string","backupName": "string","backupPrefix": "string","durationInHours": "number","includeAllDisks": "boolean","includeClusterResources": "boolean","locationType": "string","namespaces": ["string"],"schedule": {"scheduledRunTime": "string"}},"clusterUids": ["string"],"includeAllClusters": "boolean"}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1/workspaces/{uid}/backup
summary:
Create workspace backup settingsPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"backupConfig": {"backupLocationUid": "string","backupName": "string","backupPrefix": "string","durationInHours": "number","includeAllDisks": "boolean","includeClusterResources": "boolean","locationType": "string","namespaces": ["string"],"schedule": {"scheduledRunTime": "string"}},"clusterUids": ["string"],"includeAllClusters": "boolean"}
201
Created successfully
Created successfully
{"uid": "string"}
→
https://api.spectrocloud.com/v1/workspaces/{uid}/backup
summary:
Delete workspace backupPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"clusterConfigs": [{"backupName": "string","clusterUid": "string"}],"requestUid": "string"}
204
The resource was deleted successfully
The resource was deleted successfully
→
https://api.spectrocloud.com/v1/workspaces/{uid}/backup/onDemand
summary:
Create On demand Workspace BackupPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"backupConfig": {"backupLocationUid": "string","backupName": "string","backupPrefix": "string","durationInHours": "number","includeAllDisks": "boolean","includeClusterResources": "boolean","locationType": "string","namespaces": ["string"],"schedule": {"scheduledRunTime": "string"}},"clusterUids": ["string"],"includeAllClusters": "boolean"}
201
Created successfully
Created successfully
{"uid": "string"}
→
https://api.spectrocloud.com/v1/workspaces/{uid}/clusterRbacs
summary:
Create cluster rbac in workspacePath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"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": {"bindings": [{"namespace": "string","role": {"kind": "string","name": "string"},"subjects": [{"name": "string","namespace": "string","type": "string"}],"type": "string"}],"relatedObject": {"kind": "string","name": "string","uid": "string"}},"status": {"errors": [{"msg": "string","name": "string","resourceType": "string"}]}}
201
Created successfully
Created successfully
{"uid": "string"}
→
https://api.spectrocloud.com/v1/workspaces/{uid}/clusterRbacs/{clusterRbacUid}
summary:
Updates the specified workspace cluster rbacPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes | |
clusterRbacUid | string | yes |
{"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": {"bindings": [{"namespace": "string","role": {"kind": "string","name": "string"},"subjects": [{"name": "string","namespace": "string","type": "string"}],"type": "string"}],"relatedObject": {"kind": "string","name": "string","uid": "string"}},"status": {"errors": [{"msg": "string","name": "string","resourceType": "string"}]}}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1/workspaces/{uid}/clusterRbacs/{clusterRbacUid}
summary:
Deletes the specified workspace cluster rbacPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes | |
clusterRbacUid | string | yes |
204
The resource was deleted successfully
The resource was deleted successfully
→
https://api.spectrocloud.com/v1/workspaces/{uid}/meta
summary:
Updates the specified workspace metaPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","lastModifiedTimestamp": "date-time","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1/workspaces/{uid}/resourceAllocations
summary:
Updates the specified workspace resource allocationsPath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"clusterNamespaces": [{"name": "string","namespaceResourceAllocation": {"clusterResourceAllocations": [{"clusterUid": "string","resourceAllocation": {"cpuCores": "number","memoryMiB": "number"}}],"defaultResourceAllocation": {"cpuCores": "number","memoryMiB": "number"}}}],"clusterRefs": [{"clusterName": "string","clusterUid": "string"}]}
204
The resource was updated successfully
The resource was updated successfully
→
https://api.spectrocloud.com/v1/workspaces/{uid}/restore
summary:
Returns the workspace restore resultParameters:
Name | Type | Description | Required |
---|---|---|---|
restoreRequestUid | string | no |
Path parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
200
OK
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": {"workspaceUid": "string"},"status": {"workspaceRestoreStatuses": [{"actor": {"actorType": "string","uid": "string"},"requestUid": "string","workspaceRestoreConfig": {"backupName": "string","clusterRestoreRefs": [{"backupName": "string","clusterName": "string","clusterUid": "string","restoreStatusMeta": {"msg": "string","restoreTime": "date-time","state": "string"},"restoreUid": "string"}],"restoreState": {"deleteState": "string","state": "string"},"restoreTime": "date-time"}}]}}
→
https://api.spectrocloud.com/v1/workspaces/{uid}/restore/onDemand
summary:
Create On demand Workspace RestorePath parameters:
Name | Type | Description | Required |
---|---|---|---|
uid | string | yes |
{"backupRequestUid": "string","restoreConfigs": [{"backupName": "string","includeClusterResources": "boolean","includeNamespaces": ["string"],"preserveNodePorts": "boolean","restorePVs": "boolean","sourceClusterUid": "string"}]}
201
Created successfully
Created successfully
{"uid": "string"}