Retrieves a list of workspace

GET 
/v1/dashboard/workspaces

Retrieves a list of workspace

Request

Header Parameters

ProjectUid string

Scope the request to the specified project uid

Responses

200

An array of workspace

application/json

Schema

Schema

cpuUnitstring

items

undefined[]

required

Array [

meta

Deprecated. Workspace meta data

clusterNamesstring[]

Deprecated. Use clusterRefs

clusterRefs

undefined[]

Array [

namestring

uidstring

]

creationTimedate-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

namespacesstring[]

uidstring

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 spec summary

clusterRefs

undefined[]

Array [

namestring

uidstring

]

namespacesstring[]

quota

Workspace resource quota

resourceAllocation

Workspace quota resource allocation

cpunumber

memorynumber

status

Workspace status

namespaces

undefined[]

Array [

namestring

total

Workspace allocation

cpu

Workspace resource allocation

allocatedfloat64

usagefloat64

memory

Workspace resource allocation

allocatedfloat64

usagefloat64

]

total

Workspace allocation

cpu

Workspace resource allocation

allocatedfloat64

usagefloat64

memory

Workspace resource allocation

allocatedfloat64

usagefloat64

]

memoryUnitstring

Example (from schema)

{
  "cpuUnit": "string",
  "items": [
    {
      "meta": {
        "clusterNames": [
          "string"
        ],
        "clusterRefs": [
          {
            "name": "string",
            "uid": "string"
          }
        ],
        "creationTime": "2024-07-26T20:10:09.763Z",
        "name": "string",
        "namespaces": [
          "string"
        ],
        "uid": "string"
      },
      "metadata": {
        "annotations": {},
        "creationTimestamp": "2024-07-26T20:10:09.763Z",
        "deletionTimestamp": "2024-07-26T20:10:09.763Z",
        "labels": {},
        "lastModifiedTimestamp": "2024-07-26T20:10:09.763Z",
        "name": "string",
        "uid": "string"
      },
      "spec": {
        "clusterRefs": [
          {
            "name": "string",
            "uid": "string"
          }
        ],
        "namespaces": [
          "string"
        ],
        "quota": {
          "resourceAllocation": {
            "cpu": 0,
            "memory": 0
          }
        }
      },
      "status": {
        "namespaces": [
          {
            "name": "string",
            "total": {
              "cpu": {
                "allocated": 0,
                "usage": 0
              },
              "memory": {
                "allocated": 0,
                "usage": 0
              }
            }
          }
        ],
        "total": {
          "cpu": {
            "allocated": 0,
            "usage": 0
          },
          "memory": {
            "allocated": 0,
            "usage": 0
          }
        }
      }
    }
  ],
  "memoryUnit": "string"
}

Loading...