--- title: "List add-on workspaces" component: "savanna" version: "main" module: "rest-api" html_url: "/savanna/main/rest-api/endpoints/list-add-on-workspaces" --- [View as HTML](/savanna/main/rest-api/endpoints/list-add-on-workspaces) # List add-on workspaces Lists the workspaces that have a given add-on enabled. GET `/controller/v4/v2/addons/{addonsID}/workspaces` ## 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-addons-id) `addonsID` string path required Addons ID ## Response 200 200 400 500 application/json [#](#response-200-error) `Error` boolean Indicates whether the request returned an error. [#](#response-200-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-200-message) `Message` string Human-readable summary of the request result. [#](#response-200-request-id) `RequestID` string Unique identifier for tracing the request. [#](#response-200-result) `Result` object\[\] Payload returned by the request. 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. [#](#response-400-error) `Error` boolean Indicates whether the request returned an error. [#](#response-400-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-400-message) `Message` string Human-readable summary of the request result. [#](#response-400-request-id) `RequestID` string Unique identifier for tracing the request. [#](#response-400-result) `Result` object Payload returned by the request. [#](#response-500-error) `Error` boolean Indicates whether the request returned an error. [#](#response-500-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-500-message) `Message` string Human-readable summary of the request result. [#](#response-500-request-id) `RequestID` string Unique identifier for tracing the request. [#](#response-500-result) `Result` object Payload returned by the request. List add-on workspaces cURL cURL Python JavaScript PHP Go Java Ruby ```bash curl --request GET \ --url 'https://api.tgcloud.io/controller/v4/v2/addons/{addonsID}/workspaces' \ --header 'x-api-key: ' ``` ```python import requests url = "https://api.tgcloud.io/controller/v4/v2/addons/{addonsID}/workspaces" headers = {"x-api-key": ""} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const response = await fetch( "https://api.tgcloud.io/controller/v4/v2/addons/{addonsID}/workspaces", { method: "GET", headers: { "x-api-key": "" }, } ) console.log(await response.json()) ``` ```php " ]); curl_exec($request); ``` ```go request, _ := http.NewRequest( "GET", "https://api.tgcloud.io/controller/v4/v2/addons/{addonsID}/workspaces", nil, ) request.Header.Add("x-api-key", "") response, _ := http.DefaultClient.Do(request) ``` ```java HttpRequest request = HttpRequest.newBuilder() .uri(URI.create( "https://api.tgcloud.io/controller/v4/v2/addons/{addonsID}/workspaces" )) .header("x-api-key", "") .GET() .build(); ``` ```ruby uri = URI( "https://api.tgcloud.io/controller/v4/v2/addons/{addonsID}/workspaces" ) request = Net::HTTP::Get.new(uri) request["x-api-key"] = "" response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(request) } ``` 200 400 500 ```json { "Error": false, "ErrorDetails": [], "Message": "", "RequestID": "", "Result": [ { "addons": [ { "addons_id": "", "enable": false, "enable_configuration": "", "is_free": false, "unique_name": "", "workspace_id": "" } ], "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": "" } } ] } ``` ```json { "Error": true, "ErrorDetails": [ { "FieldName": "", "Reason": "", "Type": "Internal-Error" } ], "Message": "", "RequestID": "" } ``` ```json { "Error": true, "ErrorDetails": [ { "FieldName": "", "Reason": "", "Type": "Internal-Error" } ], "Message": "", "RequestID": "" } ```