Edit data for a cluster

POST

/teams/{team_id}/clusters/{cluster_id}/metadata

Request Body

application/jsonRequired

edit cluster body

`description`string

description of cluster

`nickname`string

nickname of cluster

`request_hibernate`boolean

Request the cluster to hibernate, does nothing if cluster is already hibernated or hibernating

`request_wake_up`boolean

Request the cluster to wake up, does nothing if cluster is already awake or waking up

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 POST "https://api.devzero.io/backend/v0/teams/string/clusters/string/metadata" \
  -H "Authorization: string" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "string",
    "nickname": "string",
    "request_hibernate": true,
    "request_wake_up": true
  }'

cluster information

{
  "created_at": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24",
  "description": "string",
  "id": "string",
  "nickname": "string",
  "num_workspaces": 0,
  "region": "string",
  "region_name": "string",
  "status": "Unknown",
  "team_id": "string",
  "updated_at": "2019-08-24",
  "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"
  },
  "user_id": "string"
}

Edit data for a cluster

Path

Headers

Body

Request Body

descriptionstring

nicknamestring

request_hibernateboolean

request_wake_upboolean

Path Parameters

cluster_idRequiredstring

team_idRequiredstring