Get supported workspace options :: TigerGraph Savanna

Lists the regions, TigerGraph versions, and workspace types available to your organization.

GET /controller/v4/v2/workspaces/meta

Authorizations

x-api-key string header required

Authorization for TigerGraph Savanna. Send the key in the x-api-key request header.

Query parameters

# upgrade boolean query

When true, tgVersions only include versions with allow_upgrade; when false or omitted (default), all create-allowed versions for the org are returned

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

regionsobject[]

Cloud regions available to your org.

Show child attributes Hide child attributes

descriptionstring

Description of the region.

namestring

Name of the region.

tgVersionsobject[]

TigerGraph versions available to your org.

Show child attributes Hide child attributes

allow_createboolean

Whether new workspaces can be created on this version.

allow_upgradeboolean

Whether existing workspaces can be upgraded to this version.

channelstring

Release channel the version belongs to.

end_of_lifestring

Date the version stops being supported.

imagestring

Container image that provides the version.

incompatible_upgrades_fromstring[]

Versions that cannot be upgraded to this version.

namestring

Version number.

orgsstring[]

For customized versions

workspaceTypesobject[]

Workspace sizes available to your org.

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.

Get supported workspace options

curl --request GET \
  --url 'https://api.tgcloud.io/controller/v4/v2/workspaces/meta' \
  --header 'x-api-key: <your-api-key>'

import requests

url = "https://api.tgcloud.io/controller/v4/v2/workspaces/meta"
headers = {"x-api-key": "<your-api-key>"}
response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://api.tgcloud.io/controller/v4/v2/workspaces/meta",
  {
    method: "GET",
    headers: { "x-api-key": "<your-api-key>" },
  }
)
console.log(await response.json())

<?php
$request = curl_init(
  "https://api.tgcloud.io/controller/v4/v2/workspaces/meta"
);
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($request, CURLOPT_HTTPHEADER, [
  "x-api-key: <your-api-key>"
]);
curl_exec($request);

request, _ := http.NewRequest(
  "GET",
  "https://api.tgcloud.io/controller/v4/v2/workspaces/meta",
  nil,
)
request.Header.Add("x-api-key", "<your-api-key>")
response, _ := http.DefaultClient.Do(request)

HttpRequest request = HttpRequest.newBuilder()
  .uri(URI.create(
    "https://api.tgcloud.io/controller/v4/v2/workspaces/meta"
  ))
  .header("x-api-key", "<your-api-key>")
  .GET()
  .build();

uri = URI(
  "https://api.tgcloud.io/controller/v4/v2/workspaces/meta"
)
request = Net::HTTP::Get.new(uri)
request["x-api-key"] = "<your-api-key>"
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) {
  |http| http.request(request)
}

{
  "Error": false,
  "ErrorDetails": [],
  "Message": "<string>",
  "RequestID": "<string>",
  "Result": {
    "regions": [
      {
        "description": "<string>",
        "name": "<string>"
      }
    ],
    "tgVersions": [
      {
        "allow_create": false,
        "allow_upgrade": false,
        "channel": "<string>",
        "end_of_life": "<string>",
        "image": "<string>",
        "incompatible_upgrades_from": [
          "<string>"
        ],
        "name": "<string>",
        "orgs": [
          "<string>"
        ]
      }
    ],
    "workspaceTypes": [
      {
        "cpu": "<string>",
        "ha": 0,
        "memory": "<string>",
        "partition": 0,
        "typeName": "<string>"
      }
    ]
  }
}