Update a workgroup :: TigerGraph Savanna

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

Path parameters

# workgroupID string path required

Workgroup ID

Body

# enable_application_log boolean

Whether application logging is enabled.

# encryption_method string

Encryption method to apply to the workgroup.

Available options: TMK

# workgroup_name string

New name for the workgroup.

Response

200 application/json

# Error boolean

Indicates whether the request returned an error.

# ErrorDetails object[]

Details about each error returned by the request.

Show child attributes Hide child attributes

FieldNamestring

Field associated with the error.

Reasonstring

Explanation of why the error occurred.

Typestring

Category of the error.

Available options: Internal-Error, Bad-Request, Not-Found, Forbidden, Unauthorized, API-Disabled, Quota-Exceed, Unknown

# Message string

Human-readable summary of the request result.

# RequestID string

Unique identifier for tracing the request.

# Result object

Payload returned by the request.

Show child attributes Hide child attributes

cloud_provider_idstring

Unique identifier of the cloud provider configuration.

cloud_provider_namestring

Display name of the cloud provider.

cloud_provider_statusstring

Current status of the cloud provider configuration.

cloud_provider_typestring

Type of cloud provider configuration.

creatorstring

User who created the workgroup.

enable_allow_listboolean

Whether the IP allow list is enabled.

enable_application_logboolean

Whether application logging is enabled.

encryption_methodstring

Encryption method used by the workgroup.

Available options: TMK

is_current_ip_allowedboolean

Whether the current client IP is allowed.

namestring

Name of the workgroup.

org_idstring

Unique identifier of the organization.

org_namestring

Name of the organization.

platformstring

Cloud platform that hosts the workgroup.

Available options: aws, azure, gcp

regionstring

Cloud region that hosts the workgroup.

shared_storageboolean

Whether shared storage is enabled.

tg_databasesobject[]

Databases associated with the workgroup.

Show child attributes Hide child attributes

create_timestring

Time the database was created.

database_idstring

Unique identifier of the database.

folder_statisticsobject

Storage statistics for the database.

Show child attributes Hide child attributes

backup_sizeinteger

Size of backup data, in bytes.

billed_sizeinteger

Storage size counted for billing, in bytes.

log_sizeinteger

Size of log data, in bytes.

milvus_sizeinteger

Size of vector index data, in bytes.

total_sizeinteger

Total storage size, in bytes.

workspacesobject[]

Storage used by each workspace.

Show child attributes Hide child attributes

sizeinteger

Storage used by the workspace, in bytes.

workspace_idstring

Unique identifier of the workspace.

namestring

Name of the database.

org_idstring

Unique identifier of the organization.

org_namestring

Name of the organization.

regionstring

Cloud region that hosts the database.

tg_versionstring

TigerGraph version of the database.

workgroup_idstring

Unique identifier of the parent workgroup.

workspacesobject[]

Workspaces attached to the database.

Show child attributes Hide child attributes

addonsobject[]

Add-ons enabled for the workspace.

Show child attributes Hide child attributes

addons_idstringrequired

Unique identifier of the add-on.

enablebooleanrequired

Whether the add-on is enabled.

enable_configurationobject

Configuration applied when the add-on is enabled.

is_freeboolean

Whether the add-on is available at no cost.

unique_namestring

Unique name of the add-on.

workspace_idstring

Unique identifier of the workspace.

agent_configobject

Agent heartbeat and polling configuration.

Show child attributes Hide child attributes

catalog_activity_update_interval_secondsinteger

Seconds between catalog activity updates.

enable_topology_force_updateboolean

Whether topology updates are forced.

heartbeat_interval_secondsinteger

Seconds between agent heartbeats.

query_activity_update_interval_secondsinteger

Seconds between query activity updates.

topology_update_interval_secondsinteger

Seconds between topology updates.

auto_stop_minutesinteger

Idle minutes before the workspace stops automatically.

auto_upgrade_statestring

State of the automatic version upgrade.

cloud_provider_idstring

Unique identifier of the cloud provider configuration.

cloud_provider_namestring

Display name of the cloud provider.

cloud_provider_short_idstring

Short identifier of the cloud provider configuration.

condition_typestring

Current condition reported for the workspace.

created_atstring

Time the workspace was created.

creatorstring

User who created the workspace.

database_idstring

Unique identifier of the attached database.

database_namestring

Name of the attached database.

deleted_atstring

Time the workspace was deleted.

desired_tg_versionstring

TigerGraph version the workspace is moving to.

display_statusstring

Status shown in the TigerGraph Savanna console.

edge_countinteger

Number of edges stored in the workspace.

enable_auto_startboolean

Whether the workspace starts automatically on access.

enable_copilotboolean

Whether TigerGraph CoPilot is enabled.

enable_haboolean

Whether high availability is enabled.

err_messagestring

Error message reported for the workspace.

folder_statisticsobject

Storage statistics for the workspace.

Show child attributes Hide child attributes

backup_sizeinteger

Size of backup data, in bytes.

billed_sizeinteger

Storage size counted for billing, in bytes.

log_sizeinteger

Size of log data, in bytes.

milvus_sizeinteger

Size of vector index data, in bytes.

total_sizeinteger

Total storage size, in bytes.

workspacesobject[]

Storage used by each workspace.

Show child attributes Hide child attributes

sizeinteger

Storage used by the workspace, in bytes.

workspace_idstring

Unique identifier of the workspace.

graph_topology_size_bytesinteger

Size of the graph topology, in bytes.

is_rwboolean

Whether the workspace accepts writes.

last_maintenancestring

Time of the last maintenance run.

last_modified_timestring

Time the workspace was last modified.

maintenance_window_day_of_weekinteger

Day of the week the maintenance window starts.

maintenance_window_hour_of_dayinteger

Hour of the day the maintenance window starts.

maintenance_window_interval_weeksinteger

Number of weeks between maintenance windows.

maintenance_window_time_zonestring

Time zone used for the maintenance window.

namestring

Name of the workspace.

nginx_hoststring

Host name that serves the workspace endpoint.

org_idstring

Unique identifier of the organization.

org_namestring

Name of the organization.

refresh_messagestring

Message describing the most recent refresh.

refresh_statusstring

Status of the most recent refresh.

regionstring

Cloud region that hosts the workspace.

replicasinteger

Number of replicas provisioned for the workspace.

snapshot_timestring

Time of the snapshot the workspace was created from.

solution_catalog_idstring

Unique identifier of the solution catalog entry.

statusstring

Current status of the workspace.

tg_versionstring

TigerGraph version running in the workspace.

update_strategystring

Strategy used to apply workspace updates.

version_numberinteger

Internal version number of the workspace record.

vertex_countinteger

Number of vertices stored in the workspace.

workgroup_idstring

Unique identifier of the parent workgroup.

workgroup_namestring

Name of the parent workgroup.

workspace_idstring

Unique identifier of the workspace.

workspace_typeobject

Compute size and shape of the workspace.

Show child attributes Hide child attributes

cpustring

Number of vCPUs allocated to the workspace.

hainteger

Number of high-availability replicas.

memorystring

Memory allocated to the workspace.

partitioninteger

Number of partitions in the workspace.

typeNamestring

Name of the workspace size type.

workgroup_idstring

Unique identifier of the workgroup.

workspacesobject[]

Workspaces associated with the workgroup.

Show child attributes Hide child attributes

addonsobject[]

Add-ons enabled for the workspace.

Show child attributes Hide child attributes

addons_idstringrequired

Unique identifier of the add-on.

enablebooleanrequired

Whether the add-on is enabled.

enable_configurationobject

Configuration applied when the add-on is enabled.

is_freeboolean

Whether the add-on is available at no cost.

unique_namestring

Unique name of the add-on.

workspace_idstring

Unique identifier of the workspace.

agent_configobject

Agent heartbeat and polling configuration.

Show child attributes Hide child attributes

catalog_activity_update_interval_secondsinteger

Seconds between catalog activity updates.

enable_topology_force_updateboolean

Whether topology updates are forced.

heartbeat_interval_secondsinteger

Seconds between agent heartbeats.

query_activity_update_interval_secondsinteger

Seconds between query activity updates.

topology_update_interval_secondsinteger

Seconds between topology updates.

auto_stop_minutesinteger

Idle minutes before the workspace stops automatically.

auto_upgrade_statestring

State of the automatic version upgrade.

cloud_provider_idstring

Unique identifier of the cloud provider configuration.

cloud_provider_namestring

Display name of the cloud provider.

cloud_provider_short_idstring

Short identifier of the cloud provider configuration.

condition_typestring

Current condition reported for the workspace.

created_atstring

Time the workspace was created.

creatorstring

User who created the workspace.

database_idstring

Unique identifier of the attached database.

database_namestring

Name of the attached database.

deleted_atstring

Time the workspace was deleted.

desired_tg_versionstring

TigerGraph version the workspace is moving to.

display_statusstring

Status shown in the TigerGraph Savanna console.

edge_countinteger

Number of edges stored in the workspace.

enable_auto_startboolean

Whether the workspace starts automatically on access.

enable_copilotboolean

Whether TigerGraph CoPilot is enabled.

enable_haboolean

Whether high availability is enabled.

err_messagestring

Error message reported for the workspace.

folder_statisticsobject

Storage statistics for the workspace.

Show child attributes Hide child attributes

backup_sizeinteger

Size of backup data, in bytes.

billed_sizeinteger

Storage size counted for billing, in bytes.

log_sizeinteger

Size of log data, in bytes.

milvus_sizeinteger

Size of vector index data, in bytes.

total_sizeinteger

Total storage size, in bytes.

workspacesobject[]

Storage used by each workspace.

Show child attributes Hide child attributes

sizeinteger

Storage used by the workspace, in bytes.

workspace_idstring

Unique identifier of the workspace.

graph_topology_size_bytesinteger

Size of the graph topology, in bytes.

is_rwboolean

Whether the workspace accepts writes.

last_maintenancestring

Time of the last maintenance run.

last_modified_timestring

Time the workspace was last modified.

maintenance_window_day_of_weekinteger

Day of the week the maintenance window starts.

maintenance_window_hour_of_dayinteger

Hour of the day the maintenance window starts.

maintenance_window_interval_weeksinteger

Number of weeks between maintenance windows.

maintenance_window_time_zonestring

Time zone used for the maintenance window.

namestring

Name of the workspace.

nginx_hoststring

Host name that serves the workspace endpoint.

org_idstring

Unique identifier of the organization.

org_namestring

Name of the organization.

refresh_messagestring

Message describing the most recent refresh.

refresh_statusstring

Status of the most recent refresh.

regionstring

Cloud region that hosts the workspace.

replicasinteger

Number of replicas provisioned for the workspace.

snapshot_timestring

Time of the snapshot the workspace was created from.

solution_catalog_idstring

Unique identifier of the solution catalog entry.

statusstring

Current status of the workspace.

tg_versionstring

TigerGraph version running in the workspace.

update_strategystring

Strategy used to apply workspace updates.

version_numberinteger

Internal version number of the workspace record.

vertex_countinteger

Number of vertices stored in the workspace.

workgroup_idstring

Unique identifier of the parent workgroup.

workgroup_namestring

Name of the parent workgroup.

workspace_idstring

Unique identifier of the workspace.

workspace_typeobject

Compute size and shape of the workspace.

Show child attributes Hide child attributes

cpustring

Number of vCPUs allocated to the workspace.

hainteger

Number of high-availability replicas.

memorystring

Memory allocated to the workspace.

partitioninteger

Number of partitions in the workspace.

typeNamestring

Name of the workspace size type.

Update a workgroup

curl --request PUT \
  --url 'https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}' \
  --header 'x-api-key: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "enable_application_log": false,
    "encryption_method": "TMK",
    "workgroup_name": "<string>"
  }'

import requests

url = "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}"
headers = {"x-api-key": "<your-api-key>"}
payload = {
  "enable_application_log": False,
  "encryption_method": "TMK",
  "workgroup_name": "<string>"
}

response = requests.put(url, headers=headers, json=payload)
print(response.json())

const response = await fetch(
  "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}",
  {
    method: "PUT",
    headers: { "x-api-key": "<your-api-key>", "Content-Type": "application/json" },
    body: JSON.stringify({
      "enable_application_log": false,
      "encryption_method": "TMK",
      "workgroup_name": "<string>"
    }),
  }
)
console.log(await response.json())

<?php
$request = curl_init(
  "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}"
);
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($request, CURLOPT_HTTPHEADER, [
  "x-api-key: <your-api-key>",
  "Content-Type: application/json"
]);
curl_setopt($request, CURLOPT_POSTFIELDS, '{
    "enable_application_log": false,
    "encryption_method": "TMK",
    "workgroup_name": "<string>"
  }');
curl_exec($request);

payload := strings.NewReader(`{
    "enable_application_log": false,
    "encryption_method": "TMK",
    "workgroup_name": "<string>"
  }`)

request, _ := http.NewRequest(
  "PUT",
  "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}",
  payload,
)
request.Header.Add("x-api-key", "<your-api-key>")
request.Header.Add("Content-Type", "application/json")
response, _ := http.DefaultClient.Do(request)

HttpRequest request = HttpRequest.newBuilder()
  .uri(URI.create(
    "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}"
  ))
  .header("x-api-key", "<your-api-key>")
  .header("Content-Type", "application/json")
  .method("PUT", HttpRequest.BodyPublishers.ofString("""
{
      "enable_application_log": false,
      "encryption_method": "TMK",
      "workgroup_name": "<string>"
    }
  """))
  .build();

uri = URI(
  "https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}"
)
request = Net::HTTP::Put.new(uri)
request["x-api-key"] = "<your-api-key>"
request["Content-Type"] = "application/json"
request.body = <<~JSON
{
    "enable_application_log": false,
    "encryption_method": "TMK",
    "workgroup_name": "<string>"
  }
JSON
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) {
  |http| http.request(request)
}

{
  "Error": false,
  "ErrorDetails": [],
  "Message": "<string>",
  "RequestID": "<string>",
  "Result": {
    "cloud_provider_id": "<string>",
    "cloud_provider_name": "<string>",
    "cloud_provider_status": "<string>",
    "cloud_provider_type": "<string>",
    "creator": "<string>",
    "enable_allow_list": false,
    "enable_application_log": false,
    "encryption_method": "TMK",
    "is_current_ip_allowed": false,
    "name": "<string>",
    "org_id": "<string>",
    "org_name": "<string>",
    "platform": "aws",
    "region": "<string>",
    "shared_storage": false,
    "tg_databases": [
      {
        "create_time": "<string>",
        "database_id": "<string>",
        "folder_statistics": {
          "backup_size": 0,
          "billed_size": 0,
          "log_size": 0,
          "milvus_size": 0,
          "total_size": 0,
          "workspaces": []
        },
        "name": "<string>",
        "org_id": "<string>",
        "org_name": "<string>",
        "region": "<string>",
        "tg_version": "<string>",
        "workgroup_id": "<string>",
        "workspaces": []
      }
    ],
    "workgroup_id": "<string>",
    "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": "<string>",
        "cloud_provider_id": "<string>",
        "cloud_provider_name": "<string>",
        "cloud_provider_short_id": "<string>",
        "condition_type": "<string>",
        "created_at": "<string>",
        "creator": "<string>",
        "database_id": "<string>",
        "database_name": "<string>",
        "deleted_at": "<string>",
        "desired_tg_version": "<string>",
        "display_status": "<string>",
        "edge_count": 0,
        "enable_auto_start": false,
        "enable_copilot": false,
        "enable_ha": false,
        "err_message": "<string>",
        "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": "<string>",
        "last_modified_time": "<string>",
        "maintenance_window_day_of_week": 0,
        "maintenance_window_hour_of_day": 0,
        "maintenance_window_interval_weeks": 0,
        "maintenance_window_time_zone": "<string>",
        "name": "<string>",
        "nginx_host": "<string>",
        "org_id": "<string>",
        "org_name": "<string>",
        "refresh_message": "<string>",
        "refresh_status": "<string>",
        "region": "<string>",
        "replicas": 0,
        "snapshot_time": "<string>",
        "solution_catalog_id": "<string>",
        "status": "<string>",
        "tg_version": "<string>",
        "update_strategy": "<string>",
        "version_number": 0,
        "vertex_count": 0,
        "workgroup_id": "<string>",
        "workgroup_name": "<string>",
        "workspace_id": "<string>",
        "workspace_type": {
          "cpu": "<string>",
          "ha": 0,
          "memory": "<string>",
          "partition": 0,
          "typeName": "<string>"
        }
      }
    ]
  }
}