Workspaces

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
{
"uid": "string"
}

https://api.spectrocloud.com/v1/workspaces/teams/{teamUid}/roles

summary:
Returns the specified team's workspaces and roles data
Path parameters:
NameTypeDescriptionRequired
teamUidstringyes
200
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 team
Path parameters:
NameTypeDescriptionRequired
teamUidstringyes
{
"workspaces": [
{
"roles": [
"string"
],
"uid": "string"
}
]
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/workspaces/users/{userUid}/roles

summary:
Returns the specified User workspaces and Roles information
description:
Returns a User with workspaces and roles
Path parameters:
NameTypeDescriptionRequired
userUidstringyes
200
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 user
description:
User is updated with workspace roles
Path parameters:
NameTypeDescriptionRequired
userUidstringyes
{
"workspaces": [
{
"roles": [
"string"
],
"uid": "string"
}
]
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/workspaces/validate/name

summary:
Validates the workspace name
Parameters:
NameTypeDescriptionRequired
namestringyes
204
Ok reponse without content

https://api.spectrocloud.com/v1/workspaces/{uid}

summary:
Returns the specified workspace
Path parameters:
NameTypeDescriptionRequired
uidstringyes
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": {
"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 workspace
Path parameters:
NameTypeDescriptionRequired
uidstringyes
204
The resource was deleted successfully

https://api.spectrocloud.com/v1/workspaces/{uid}/backup

summary:
Returns the workspace backup result
Parameters:
NameTypeDescriptionRequired
backupRequestUidstringno
Path parameters:
NameTypeDescriptionRequired
uidstringyes
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": {
"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 settings
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"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

https://api.spectrocloud.com/v1/workspaces/{uid}/backup

summary:
Create workspace backup settings
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"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
{
"uid": "string"
}

https://api.spectrocloud.com/v1/workspaces/{uid}/backup

summary:
Delete workspace backup
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"clusterConfigs": [
{
"backupName": "string",
"clusterUid": "string"
}
],
"requestUid": "string"
}
204
The resource was deleted successfully

https://api.spectrocloud.com/v1/workspaces/{uid}/backup/onDemand

summary:
Create On demand Workspace Backup
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"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
{
"uid": "string"
}

https://api.spectrocloud.com/v1/workspaces/{uid}/clusterRbacs

summary:
Create cluster rbac in workspace
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"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
{
"uid": "string"
}

https://api.spectrocloud.com/v1/workspaces/{uid}/clusterRbacs/{clusterRbacUid}

summary:
Updates the specified workspace cluster rbac
Path parameters:
NameTypeDescriptionRequired
uidstringyes
clusterRbacUidstringyes
{
"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

https://api.spectrocloud.com/v1/workspaces/{uid}/clusterRbacs/{clusterRbacUid}

summary:
Deletes the specified workspace cluster rbac
Path parameters:
NameTypeDescriptionRequired
uidstringyes
clusterRbacUidstringyes
204
The resource was deleted successfully

https://api.spectrocloud.com/v1/workspaces/{uid}/meta

summary:
Updates the specified workspace meta
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"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

https://api.spectrocloud.com/v1/workspaces/{uid}/resourceAllocations

summary:
Updates the specified workspace resource allocations
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"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

https://api.spectrocloud.com/v1/workspaces/{uid}/restore

summary:
Returns the workspace restore result
Parameters:
NameTypeDescriptionRequired
restoreRequestUidstringno
Path parameters:
NameTypeDescriptionRequired
uidstringyes
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": {
"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 Restore
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"backupRequestUid": "string",
"restoreConfigs": [
{
"backupName": "string",
"includeClusterResources": "boolean",
"includeNamespaces": [
"string"
],
"preserveNodePorts": "boolean",
"restorePVs": "boolean",
"sourceClusterUid": "string"
}
]
}
201
Created successfully
{
"uid": "string"
}