--- title: "Update a workgroup" component: "savanna" version: "main" module: "rest-api" html_url: "/savanna/main/rest-api/endpoints/update-a-workgroup" --- [View as HTML](/savanna/main/rest-api/endpoints/update-a-workgroup) # Update a workgroup Updates a workgroup name, application logging, or encryption settings. PUT `/controller/v4/v2/workgroups/{workgroupID}` ## Authorizations `x-api-key` string header required Authorization for TigerGraph Savanna. Send the key in the `x-api-key` request header. [Create an API key](../create-api-key.md) ## Path parameters [#](#parameter-workgroup-id) `workgroupID` string path required Workgroup ID ## Body [#](#body-enable-application-log) `enable_application_log` boolean Whether application logging is enabled. [#](#body-encryption-method) `encryption_method` string Encryption method to apply to the workgroup. Available options: `TMK` [#](#body-workgroup-name) `workgroup_name` string New name for the workgroup. ## Response 200 application/json [#](#response-error) `Error` boolean Indicates whether the request returned an error. [#](#response-error-details) `ErrorDetails` object\[\] Details about each error returned by the request. Show child attributes Hide child attributes `FieldName`string Field associated with the error. `Reason`string Explanation of why the error occurred. `Type`string Category of the error. Available options: `Internal-Error`, `Bad-Request`, `Not-Found`, `Forbidden`, `Unauthorized`, `API-Disabled`, `Quota-Exceed`, `Unknown` [#](#response-message) `Message` string Human-readable summary of the request result. [#](#response-request-id) `RequestID` string Unique identifier for tracing the request. [#](#response-result) `Result` object Payload returned by the request. Show child attributes Hide child attributes `cloud_provider_id`string Unique identifier of the cloud provider configuration. `cloud_provider_name`string Display name of the cloud provider. `cloud_provider_status`string Current status of the cloud provider configuration. `cloud_provider_type`string Type of cloud provider configuration. `creator`string User who created the workgroup. `enable_allow_list`boolean Whether the IP allow list is enabled. `enable_application_log`boolean Whether application logging is enabled. `encryption_method`string Encryption method used by the workgroup. Available options: `TMK` `is_current_ip_allowed`boolean Whether the current client IP is allowed. `name`string Name of the workgroup. `org_id`string Unique identifier of the organization. `org_name`string Name of the organization. `platform`string Cloud platform that hosts the workgroup. Available options: `aws`, `azure`, `gcp` `region`string Cloud region that hosts the workgroup. `shared_storage`boolean Whether shared storage is enabled. `tg_databases`object\[\] Databases associated with the workgroup. Show child attributes Hide child attributes `create_time`string Time the database was created. `database_id`string Unique identifier of the database. `folder_statistics`object Storage statistics for the database. Show child attributes Hide child attributes `backup_size`integer Size of backup data, in bytes. `billed_size`integer Storage size counted for billing, in bytes. `log_size`integer Size of log data, in bytes. `milvus_size`integer Size of vector index data, in bytes. `total_size`integer Total storage size, in bytes. `workspaces`object\[\] Storage used by each workspace. Show child attributes Hide child attributes `size`integer Storage used by the workspace, in bytes. `workspace_id`string Unique identifier of the workspace. `name`string Name of the database. `org_id`string Unique identifier of the organization. `org_name`string Name of the organization. `region`string Cloud region that hosts the database. `tg_version`string TigerGraph version of the database. `workgroup_id`string Unique identifier of the parent workgroup. `workspaces`object\[\] Workspaces attached to the database. Show child attributes Hide child attributes `addons`object\[\] Add-ons enabled for the workspace. Show child attributes Hide child attributes `addons_id`stringrequired Unique identifier of the add-on. `enable`booleanrequired Whether the add-on is enabled. `enable_configuration`object Configuration applied when the add-on is enabled. `is_free`boolean Whether the add-on is available at no cost. `unique_name`string Unique name of the add-on. `workspace_id`string Unique identifier of the workspace. `agent_config`object Agent heartbeat and polling configuration. Show child attributes Hide child attributes `catalog_activity_update_interval_seconds`integer Seconds between catalog activity updates. `enable_topology_force_update`boolean Whether topology updates are forced. `heartbeat_interval_seconds`integer Seconds between agent heartbeats. `query_activity_update_interval_seconds`integer Seconds between query activity updates. `topology_update_interval_seconds`integer Seconds between topology updates. `auto_stop_minutes`integer Idle minutes before the workspace stops automatically. `auto_upgrade_state`string State of the automatic version upgrade. `cloud_provider_id`string Unique identifier of the cloud provider configuration. `cloud_provider_name`string Display name of the cloud provider. `cloud_provider_short_id`string Short identifier of the cloud provider configuration. `condition_type`string Current condition reported for the workspace. `created_at`string Time the workspace was created. `creator`string User who created the workspace. `database_id`string Unique identifier of the attached database. `database_name`string Name of the attached database. `deleted_at`string Time the workspace was deleted. `desired_tg_version`string TigerGraph version the workspace is moving to. `display_status`string Status shown in the TigerGraph Savanna console. `edge_count`integer Number of edges stored in the workspace. `enable_auto_start`boolean Whether the workspace starts automatically on access. `enable_copilot`boolean Whether TigerGraph CoPilot is enabled. `enable_ha`boolean Whether high availability is enabled. `err_message`string Error message reported for the workspace. `folder_statistics`object Storage statistics for the workspace. Show child attributes Hide child attributes `backup_size`integer Size of backup data, in bytes. `billed_size`integer Storage size counted for billing, in bytes. `log_size`integer Size of log data, in bytes. `milvus_size`integer Size of vector index data, in bytes. `total_size`integer Total storage size, in bytes. `workspaces`object\[\] Storage used by each workspace. Show child attributes Hide child attributes `size`integer Storage used by the workspace, in bytes. `workspace_id`string Unique identifier of the workspace. `graph_topology_size_bytes`integer Size of the graph topology, in bytes. `is_rw`boolean Whether the workspace accepts writes. `last_maintenance`string Time of the last maintenance run. `last_modified_time`string Time the workspace was last modified. `maintenance_window_day_of_week`integer Day of the week the maintenance window starts. `maintenance_window_hour_of_day`integer Hour of the day the maintenance window starts. `maintenance_window_interval_weeks`integer Number of weeks between maintenance windows. `maintenance_window_time_zone`string Time zone used for the maintenance window. `name`string Name of the workspace. `nginx_host`string Host name that serves the workspace endpoint. `org_id`string Unique identifier of the organization. `org_name`string Name of the organization. `refresh_message`string Message describing the most recent refresh. `refresh_status`string Status of the most recent refresh. `region`string Cloud region that hosts the workspace. `replicas`integer Number of replicas provisioned for the workspace. `snapshot_time`string Time of the snapshot the workspace was created from. `solution_catalog_id`string Unique identifier of the solution catalog entry. `status`string Current status of the workspace. `tg_version`string TigerGraph version running in the workspace. `update_strategy`string Strategy used to apply workspace updates. `version_number`integer Internal version number of the workspace record. `vertex_count`integer Number of vertices stored in the workspace. `workgroup_id`string Unique identifier of the parent workgroup. `workgroup_name`string Name of the parent workgroup. `workspace_id`string Unique identifier of the workspace. `workspace_type`object Compute size and shape of the workspace. Show child attributes Hide child attributes `cpu`string Number of vCPUs allocated to the workspace. `ha`integer Number of high-availability replicas. `memory`string Memory allocated to the workspace. `partition`integer Number of partitions in the workspace. `typeName`string Name of the workspace size type. `workgroup_id`string Unique identifier of the workgroup. `workspaces`object\[\] Workspaces associated with the workgroup. Show child attributes Hide child attributes `addons`object\[\] Add-ons enabled for the workspace. Show child attributes Hide child attributes `addons_id`stringrequired Unique identifier of the add-on. `enable`booleanrequired Whether the add-on is enabled. `enable_configuration`object Configuration applied when the add-on is enabled. `is_free`boolean Whether the add-on is available at no cost. `unique_name`string Unique name of the add-on. `workspace_id`string Unique identifier of the workspace. `agent_config`object Agent heartbeat and polling configuration. Show child attributes Hide child attributes `catalog_activity_update_interval_seconds`integer Seconds between catalog activity updates. `enable_topology_force_update`boolean Whether topology updates are forced. `heartbeat_interval_seconds`integer Seconds between agent heartbeats. `query_activity_update_interval_seconds`integer Seconds between query activity updates. `topology_update_interval_seconds`integer Seconds between topology updates. `auto_stop_minutes`integer Idle minutes before the workspace stops automatically. `auto_upgrade_state`string State of the automatic version upgrade. `cloud_provider_id`string Unique identifier of the cloud provider configuration. `cloud_provider_name`string Display name of the cloud provider. `cloud_provider_short_id`string Short identifier of the cloud provider configuration. `condition_type`string Current condition reported for the workspace. `created_at`string Time the workspace was created. `creator`string User who created the workspace. `database_id`string Unique identifier of the attached database. `database_name`string Name of the attached database. `deleted_at`string Time the workspace was deleted. `desired_tg_version`string TigerGraph version the workspace is moving to. `display_status`string Status shown in the TigerGraph Savanna console. `edge_count`integer Number of edges stored in the workspace. `enable_auto_start`boolean Whether the workspace starts automatically on access. `enable_copilot`boolean Whether TigerGraph CoPilot is enabled. `enable_ha`boolean Whether high availability is enabled. `err_message`string Error message reported for the workspace. `folder_statistics`object Storage statistics for the workspace. Show child attributes Hide child attributes `backup_size`integer Size of backup data, in bytes. `billed_size`integer Storage size counted for billing, in bytes. `log_size`integer Size of log data, in bytes. `milvus_size`integer Size of vector index data, in bytes. `total_size`integer Total storage size, in bytes. `workspaces`object\[\] Storage used by each workspace. Show child attributes Hide child attributes `size`integer Storage used by the workspace, in bytes. `workspace_id`string Unique identifier of the workspace. `graph_topology_size_bytes`integer Size of the graph topology, in bytes. `is_rw`boolean Whether the workspace accepts writes. `last_maintenance`string Time of the last maintenance run. `last_modified_time`string Time the workspace was last modified. `maintenance_window_day_of_week`integer Day of the week the maintenance window starts. `maintenance_window_hour_of_day`integer Hour of the day the maintenance window starts. `maintenance_window_interval_weeks`integer Number of weeks between maintenance windows. `maintenance_window_time_zone`string Time zone used for the maintenance window. `name`string Name of the workspace. `nginx_host`string Host name that serves the workspace endpoint. `org_id`string Unique identifier of the organization. `org_name`string Name of the organization. `refresh_message`string Message describing the most recent refresh. `refresh_status`string Status of the most recent refresh. `region`string Cloud region that hosts the workspace. `replicas`integer Number of replicas provisioned for the workspace. `snapshot_time`string Time of the snapshot the workspace was created from. `solution_catalog_id`string Unique identifier of the solution catalog entry. `status`string Current status of the workspace. `tg_version`string TigerGraph version running in the workspace. `update_strategy`string Strategy used to apply workspace updates. `version_number`integer Internal version number of the workspace record. `vertex_count`integer Number of vertices stored in the workspace. `workgroup_id`string Unique identifier of the parent workgroup. `workgroup_name`string Name of the parent workgroup. `workspace_id`string Unique identifier of the workspace. `workspace_type`object Compute size and shape of the workspace. Show child attributes Hide child attributes `cpu`string Number of vCPUs allocated to the workspace. `ha`integer Number of high-availability replicas. `memory`string Memory allocated to the workspace. `partition`integer Number of partitions in the workspace. `typeName`string Name of the workspace size type. Update a workgroup cURL cURL Python JavaScript PHP Go Java Ruby ```bash curl --request PUT \ --url 'https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}' \ --header 'x-api-key: ' \ --header 'Content-Type: application/json' \ --data '{ "enable_application_log": false, "encryption_method": "TMK", "workgroup_name": "" }' ``` ```python import requests url = "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}" headers = {"x-api-key": ""} payload = { "enable_application_log": False, "encryption_method": "TMK", "workgroup_name": "" } response = requests.put(url, headers=headers, json=payload) print(response.json()) ``` ```javascript const response = await fetch( "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}", { method: "PUT", headers: { "x-api-key": "", "Content-Type": "application/json" }, body: JSON.stringify({ "enable_application_log": false, "encryption_method": "TMK", "workgroup_name": "" }), } ) console.log(await response.json()) ``` ```php ", "Content-Type: application/json" ]); curl_setopt($request, CURLOPT_POSTFIELDS, '{ "enable_application_log": false, "encryption_method": "TMK", "workgroup_name": "" }'); curl_exec($request); ``` ```go payload := strings.NewReader(`{ "enable_application_log": false, "encryption_method": "TMK", "workgroup_name": "" }`) request, _ := http.NewRequest( "PUT", "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}", payload, ) request.Header.Add("x-api-key", "") request.Header.Add("Content-Type", "application/json") response, _ := http.DefaultClient.Do(request) ``` ```java HttpRequest request = HttpRequest.newBuilder() .uri(URI.create( "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}" )) .header("x-api-key", "") .header("Content-Type", "application/json") .method("PUT", HttpRequest.BodyPublishers.ofString(""" { "enable_application_log": false, "encryption_method": "TMK", "workgroup_name": "" } """)) .build(); ``` ```ruby uri = URI( "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}" ) request = Net::HTTP::Put.new(uri) request["x-api-key"] = "" request["Content-Type"] = "application/json" request.body = <<~JSON { "enable_application_log": false, "encryption_method": "TMK", "workgroup_name": "" } JSON response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(request) } ``` 200 ```json { "Error": false, "ErrorDetails": [], "Message": "", "RequestID": "", "Result": { "cloud_provider_id": "", "cloud_provider_name": "", "cloud_provider_status": "", "cloud_provider_type": "", "creator": "", "enable_allow_list": false, "enable_application_log": false, "encryption_method": "TMK", "is_current_ip_allowed": false, "name": "", "org_id": "", "org_name": "", "platform": "aws", "region": "", "shared_storage": false, "tg_databases": [ { "create_time": "", "database_id": "", "folder_statistics": { "backup_size": 0, "billed_size": 0, "log_size": 0, "milvus_size": 0, "total_size": 0, "workspaces": [] }, "name": "", "org_id": "", "org_name": "", "region": "", "tg_version": "", "workgroup_id": "", "workspaces": [] } ], "workgroup_id": "", "workspaces": [ { "addons": [], "agent_config": { "catalog_activity_update_interval_seconds": 0, "enable_topology_force_update": false, "heartbeat_interval_seconds": 0, "query_activity_update_interval_seconds": 0, "topology_update_interval_seconds": 0 }, "auto_stop_minutes": 0, "auto_upgrade_state": "", "cloud_provider_id": "", "cloud_provider_name": "", "cloud_provider_short_id": "", "condition_type": "", "created_at": "", "creator": "", "database_id": "", "database_name": "", "deleted_at": "", "desired_tg_version": "", "display_status": "", "edge_count": 0, "enable_auto_start": false, "enable_copilot": false, "enable_ha": false, "err_message": "", "folder_statistics": { "backup_size": 0, "billed_size": 0, "log_size": 0, "milvus_size": 0, "total_size": 0, "workspaces": [] }, "graph_topology_size_bytes": 0, "is_rw": false, "last_maintenance": "", "last_modified_time": "", "maintenance_window_day_of_week": 0, "maintenance_window_hour_of_day": 0, "maintenance_window_interval_weeks": 0, "maintenance_window_time_zone": "", "name": "", "nginx_host": "", "org_id": "", "org_name": "", "refresh_message": "", "refresh_status": "", "region": "", "replicas": 0, "snapshot_time": "", "solution_catalog_id": "", "status": "", "tg_version": "", "update_strategy": "", "version_number": 0, "vertex_count": 0, "workgroup_id": "", "workgroup_name": "", "workspace_id": "", "workspace_type": { "cpu": "", "ha": 0, "memory": "", "partition": 0, "typeName": "" } } ] } } ```