Returns the specified workspace

GET 
/v1/workspaces/:uid

Returns the specified workspace

Request

Path Parameters

uid stringrequired

Header Parameters

ProjectUid string

Scope the request to the specified project uid

Responses

200

OK

application/json

Schema

Schema

metadata

object

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

annotations

object

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

property name*string

creationTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

deletionTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

labels

object

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

property name*string

lastModifiedTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

namestring

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

uidstring

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

spec

Workspace specifications

clusterNamespaces

undefined[]

Array [

image

Workspace namespace image information

blackListedImagesstring[]

isRegexboolean

namestring

namespaceResourceAllocation

Workspace namespace resource allocation

clusterResourceAllocations

undefined[]

Array [

clusterUidstring

resourceAllocation

Workspace resource allocation

cpuCoresnumber

Possible values: >= -1

memoryMiBnumber

Possible values: >= -1

]

defaultResourceAllocation

Workspace resource allocation

cpuCoresnumber

Possible values: >= -1

memoryMiBnumber

Possible values: >= -1

]

clusterRbacs

object[]

Array [

metadata

object

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

annotations

object

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

property name*string

creationTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

deletionTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

labels

object

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

property name*string

lastModifiedTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

namestring

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

uidstring

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

spec

object

Cluster RBAC spec

bindings

object[]

Array [

namespacestring

role

object

Cluster role ref

kindstring

Possible values: [Role, ClusterRole]

namestring

subjects

object[]

Array [

namestring

namespacestring

typestring

Possible values: [User, Group, ServiceAccount]

]

typestring

Possible values: [RoleBinding, ClusterRoleBinding]

]

relatedObject

object

Object for which the resource is related

kindstring

Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]

namestring

uidstring

status

Cluster rbac status

errors

undefined[]

Array [

msgstring

namestring

resourceTypestring

]

]

clusterRefs

undefined[]

Array [

clusterNamestring

clusterUidstring

]

policies

Workspace policies

backupPolicy

Cluster backup config

backupConfig

Cluster backup config

backupLocationNamestring

backupLocationUidstring

backupNamestring

backupPrefixstring

durationInHoursint64

includeAllDisksboolean

includeClusterResourcesboolean

locationTypestring

namespacesstring[]

schedule

Cluster feature schedule

scheduledRunTimestring

clusterUidsstring[]

includeAllClustersboolean

quota

Workspace resource quota

resourceAllocation

Workspace resource allocation

cpuCoresnumber

Possible values: >= -1

memoryMiBnumber

Possible values: >= -1

status

Workspace status

errors

undefined[]

Array [

clusterUidstring

msgstring

namestring

resourceTypestring

]

Example (from schema)

{
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2024-07-26T20:10:12.860Z",
    "deletionTimestamp": "2024-07-26T20:10:12.860Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-07-26T20:10:12.860Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "clusterNamespaces": [
      {
        "image": {
          "blackListedImages": [
            "string"
          ]
        },
        "isRegex": true,
        "name": "string",
        "namespaceResourceAllocation": {
          "clusterResourceAllocations": [
            {
              "clusterUid": "string",
              "resourceAllocation": {
                "cpuCores": 0,
                "memoryMiB": 0
              }
            }
          ],
          "defaultResourceAllocation": {
            "cpuCores": 0,
            "memoryMiB": 0
          }
        }
      }
    ],
    "clusterRbacs": [
      {
        "metadata": {
          "annotations": {},
          "creationTimestamp": "2024-07-26T20:10:12.861Z",
          "deletionTimestamp": "2024-07-26T20:10:12.861Z",
          "labels": {},
          "lastModifiedTimestamp": "2024-07-26T20:10:12.861Z",
          "name": "string",
          "uid": "string"
        },
        "spec": {
          "bindings": [
            {
              "namespace": "string",
              "role": {
                "kind": "Role",
                "name": "string"
              },
              "subjects": [
                {
                  "name": "string",
                  "namespace": "string",
                  "type": "User"
                }
              ],
              "type": "RoleBinding"
            }
          ],
          "relatedObject": {
            "kind": "spectrocluster",
            "name": "string",
            "uid": "string"
          }
        },
        "status": {
          "errors": [
            {
              "msg": "string",
              "name": "string",
              "resourceType": "string"
            }
          ]
        }
      }
    ],
    "clusterRefs": [
      {
        "clusterName": "string",
        "clusterUid": "string"
      }
    ],
    "policies": {
      "backupPolicy": {
        "backupConfig": {
          "backupLocationName": "string",
          "backupLocationUid": "string",
          "backupName": "string",
          "backupPrefix": "string",
          "durationInHours": 0,
          "includeAllDisks": true,
          "includeClusterResources": true,
          "locationType": "string",
          "namespaces": [
            "string"
          ],
          "schedule": {
            "scheduledRunTime": "string"
          }
        },
        "clusterUids": [
          "string"
        ],
        "includeAllClusters": true
      }
    },
    "quota": {
      "resourceAllocation": {
        "cpuCores": 0,
        "memoryMiB": 0
      }
    }
  },
  "status": {
    "errors": [
      {
        "clusterUid": "string",
        "msg": "string",
        "name": "string",
        "resourceType": "string"
      }
    ]
  }
}

Loading...