DevZero Logo
DevZero

Get workspaces running in a cluster

GET
/teams/{team_id}/clusters/{cluster_id}/workspaces
/teams/{team_id}/clusters/{cluster_id}/workspaces

Path Parameters

cluster_id
Required
string

cluster id

team_id
Required
string

ID of team

Header Parameters

Authorization
Required
string

Value: "Bearer <token>"; visit the "User Settings" page in the DevZero dashboard to generate a token

curl -X GET "https://api.devzero.io/backend/v0/teams/string/clusters/string/workspaces" \
  -H "Authorization: string"

list of workspaces

[
  {
    "cluster_id": "string",
    "cluster_nickname": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "current_hardware_spec": {
      "cpu": 0,
      "memory": 0,
      "storage": 0
    },
    "hostname": "string",
    "id": "string",
    "kubeconfig": "string",
    "modified_at": "2019-08-24T14:15:22Z",
    "mounted_volumes": [
      {
        "created_at": "2019-08-24T14:15:22Z",
        "created_by": {
          "default_region": "string",
          "default_region_name": "string",
          "dora_connection_ids": [
            "string"
          ],
          "dxi_onboarding_checklist": {
            "analyze_own_code": "SKIPPED",
            "development_process_bottlenecks": "SKIPPED",
            "devzero_cli": "SKIPPED",
            "github_token": "SKIPPED",
            "is_dora_repository_connected": true
          },
          "email": "user@example.com",
          "given_name": "string",
          "id": "string",
          "linked_vcss": [
            {
              "link_metadata": "string",
              "vsc_uri": "string"
            }
          ],
          "onboarding_checklist": {
            "has_completed_onboarding": true,
            "has_completed_onboarding_checklist": true,
            "has_completed_recipe_quick_starters": true,
            "has_created_recipe": true,
            "has_dismissed_quickstart": true,
            "has_dismissed_recipe_callout": true,
            "has_forked_quickstart": true,
            "has_launched_workspace": true,
            "has_seen_onboarding_recipe_modal": true,
            "onboarding_path": "undefined"
          },
          "sub": "string",
          "teams": [
            {
              "is_owner": true,
              "name": "string",
              "permissions": "string",
              "team_id": "string",
              "user_id": "string"
            }
          ],
          "timezone": "string",
          "user_scoped_recipe": "string"
        },
        "id": "string",
        "name": "string",
        "region": {
          "id": "string",
          "latitude": 0,
          "longitude": 0,
          "name": "string",
          "provided_by": "string"
        },
        "size": 0,
        "status": "Creating",
        "team_id": "string",
        "usage": {
          "accessed_at": "2019-08-24T14:15:22Z",
          "bytes_quota": 0,
          "bytes_used": 0,
          "created_at": "2019-08-24T14:15:22Z",
          "last_refreshed_at": "2019-08-24T14:15:22Z",
          "modified_at": "2019-08-24T14:15:22Z",
          "used_percentage": "string"
        },
        "volume_mounts": [
          {
            "mount_path": "string",
            "storage_volume_id": "string",
            "volume_sub_path": "string",
            "workload_id": "string",
            "workload_name": "string"
          }
        ]
      }
    ],
    "network": {
      "created_at": "2019-08-24T14:15:22Z",
      "display_name": "string",
      "hydra_network_name": "string",
      "id": "string",
      "team_id": "string"
    },
    "new_launch_version_available": true,
    "nickname": "string",
    "quickstart": {
      "description": "string",
      "id": "string",
      "name": "string",
      "recipe": "string",
      "tag": "string"
    },
    "recipe_deleted": true,
    "recipe_id": "string",
    "recipe_version": {
      "build": {
        "build_step_checks": [
          {
            "command": "string",
            "completed_at": "string",
            "error": "string",
            "is_cached": true,
            "is_user_step": true,
            "last_updated": "string",
            "logsrv_id": "string",
            "name": "string",
            "start_time": "string",
            "status": "pending",
            "step_id": "string"
          }
        ],
        "created_at": "2019-08-24T14:15:22Z",
        "id": "string",
        "modified_at": "2019-08-24T14:15:22Z",
        "recipe_id": "string",
        "recipe_name": "string",
        "recipe_version_id": "string",
        "status": "Not Started",
        "team_id": "string",
        "user_id": "string"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "id": "string",
      "recipe": "string",
      "recipe_defaults": "string",
      "team_id": "string",
      "user": {
        "default_region": "string",
        "default_region_name": "string",
        "dora_connection_ids": [
          "string"
        ],
        "dxi_onboarding_checklist": {
          "analyze_own_code": "SKIPPED",
          "development_process_bottlenecks": "SKIPPED",
          "devzero_cli": "SKIPPED",
          "github_token": "SKIPPED",
          "is_dora_repository_connected": true
        },
        "email": "user@example.com",
        "given_name": "string",
        "id": "string",
        "linked_vcss": [
          {
            "link_metadata": "string",
            "vsc_uri": "string"
          }
        ],
        "onboarding_checklist": {
          "has_completed_onboarding": true,
          "has_completed_onboarding_checklist": true,
          "has_completed_recipe_quick_starters": true,
          "has_created_recipe": true,
          "has_dismissed_quickstart": true,
          "has_dismissed_recipe_callout": true,
          "has_forked_quickstart": true,
          "has_launched_workspace": true,
          "has_seen_onboarding_recipe_modal": true,
          "onboarding_path": "undefined"
        },
        "sub": "string",
        "teams": [
          {
            "is_owner": true,
            "name": "string",
            "permissions": "string",
            "team_id": "string",
            "user_id": "string"
          }
        ],
        "timezone": "string",
        "user_scoped_recipe": "string"
      }
    },
    "region": "string",
    "region_name": "string",
    "status": "Building",
    "status_hint": "string",
    "team_id": "string",
    "user": {
      "default_region": "string",
      "default_region_name": "string",
      "dora_connection_ids": [
        "string"
      ],
      "dxi_onboarding_checklist": {
        "analyze_own_code": "SKIPPED",
        "development_process_bottlenecks": "SKIPPED",
        "devzero_cli": "SKIPPED",
        "github_token": "SKIPPED",
        "is_dora_repository_connected": true
      },
      "email": "user@example.com",
      "given_name": "string",
      "id": "string",
      "linked_vcss": [
        {
          "link_metadata": "string",
          "vsc_uri": "string"
        }
      ],
      "onboarding_checklist": {
        "has_completed_onboarding": true,
        "has_completed_onboarding_checklist": true,
        "has_completed_recipe_quick_starters": true,
        "has_created_recipe": true,
        "has_dismissed_quickstart": true,
        "has_dismissed_recipe_callout": true,
        "has_forked_quickstart": true,
        "has_launched_workspace": true,
        "has_seen_onboarding_recipe_modal": true,
        "onboarding_path": "undefined"
      },
      "sub": "string",
      "teams": [
        {
          "is_owner": true,
          "name": "string",
          "permissions": "string",
          "team_id": "string",
          "user_id": "string"
        }
      ],
      "timezone": "string",
      "user_scoped_recipe": "string"
    },
    "workspace_recipe_summary": {
      "cpu": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "memory": "string",
      "name": "string",
      "repos": [
        "string"
      ],
      "storage": "string"
    }
  }
]