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 are system generated key value metadata for the resource. As an input certain annotations like description can be set
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
Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag
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 of the resource
uidstring
UID is the unique identifier generated for the resource. This is not an input field for any request.
Populated by the system. Read-only.
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": "2023-12-01T21:31:48.590Z",
        "name": "string",
        "namespaces": [
          "string"
        ],
        "uid": "string"
      },
      "metadata": {
        "annotations": {},
        "creationTimestamp": "2023-12-01T21:31:48.590Z",
        "deletionTimestamp": "2023-12-01T21:31:48.590Z",
        "labels": {},
        "lastModifiedTimestamp": "2023-12-01T21:31:48.590Z",
        "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...