--- title: "Savanna REST Endpoints" description: "Reference guide for Savanna's REST endpoints" component: "savanna" version: "main" module: "rest-api" html_url: "/savanna/main/rest-api/endpoints.html" --- [View as HTML](/savanna/main/rest-api/endpoints.html) ยท [Documentation index](/llms.txt) # Savanna REST Endpoints ## Endpoints ### Create workgroups in your org POST https://api.tgcloud.io/controller/v4/v2/workgroups #### Description Create workgroups in your org #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Body** | **request** _required_ | Create workgroup request | [CreateWorkgroupRequest](definitions.md#%5Fcreateworkgrouprequest) | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fpost%5Fresponse%5F200) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | [Workgroup](definitions.md#%5Fworkgroup) | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * Workgroup ### Get workgroups for your org GET https://api.tgcloud.io/controller/v4/v2/workgroups #### Description Get workgroups for your org #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fget%5Fresponse%5F200) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | < [Workgroup](definitions.md#%5Fworkgroup) \> array | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * Workgroup ### Get workgroup detail in your org GET https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID} #### Description Get workgroup detail in your org #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workgroupID** _required_ | Workgroup ID | string | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fget%5Fresponse%5F200) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | [Workgroup](definitions.md#%5Fworkgroup) | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * Workgroup ### Update workgroups in your org PUT https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID} #### Description Update workgroups in your org #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workgroupID** _required_ | Workgroup ID | string | | **Body** | **request** _required_ | Update workgroup request | [UpdateWorkgroupRequest](definitions.md#%5Fupdateworkgrouprequest) | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fput%5Fresponse%5F200) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | [Workgroup](definitions.md#%5Fworkgroup) | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * Workgroup ### Delete workgroup detail in your org DELETE https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID} #### Description Delete workgroup detail in your org #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workgroupID** _required_ | Workgroup ID | string | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fdelete%5Fresponse%5F200) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | string | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * Workgroup ### Add Allowed IP POST https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/allow_list #### Description Add a new allowed IP to the workgroup #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workgroupID** _required_ | Workgroup ID | string | | **Body** | **request** _required_ | Allowed IP request | [AllowedIP](definitions.md#%5Fallowedip) | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fallow%5Flist%5Fpost%5Fresponse%5F200) | | **400** | Bad Request | [Response 400](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fallow%5Flist%5Fpost%5Fresponse%5F400) | | **500** | Internal Server Error | [Response 500](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fallow%5Flist%5Fpost%5Fresponse%5F500) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | [AllowedIP](definitions.md#%5Fallowedip) | **Response 400** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | string | **Response 500** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | string | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * AllowedIP ### List Allowed IPs GET https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/allow_list #### Description List all allowed IPs in the workgroup #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workgroupID** _required_ | Workgroup ID | string | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fallow%5Flist%5Fget%5Fresponse%5F200) | | **500** | Internal Server Error | [Response 500](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fallow%5Flist%5Fget%5Fresponse%5F500) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | < [AllowedIP](definitions.md#%5Fallowedip) \> array | **Response 500** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | string | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * AllowedIP ### Get Current IP GET https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/allow_list/current #### Description Get the current IP and check if it is allowed in the workgroup #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workgroupID** _required_ | Workgroup ID | string | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fallow%5Flist%5Fcurrent%5Fget%5Fresponse%5F200) | | **500** | Internal Server Error | [Response 500](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fallow%5Flist%5Fcurrent%5Fget%5Fresponse%5F500) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | [Result](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fallow%5Flist%5Fcurrent%5Fget%5Fresult) | **Result** | Name | Schema | | --- | --- | | * IsAllowed\*\* _optional_ | boolean | | **CurrentIP** _optional_ | string | **Response 500** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | string | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * AllowedIP ### Disable Allow List PUT https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/allow_list/disable #### Description Disable the allow list for the workgroup #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workgroupID** _required_ | Workgroup ID | string | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fallow%5Flist%5Fdisable%5Fput%5Fresponse%5F200) | | **500** | Internal Server Error | [Response 500](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fallow%5Flist%5Fdisable%5Fput%5Fresponse%5F500) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | string | **Response 500** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | string | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * AllowedIP ### Enable Allow List PUT https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/allow_list/enable #### Description Enable the allow list for the workgroup #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workgroupID** _required_ | Workgroup ID | string | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fallow%5Flist%5Fenable%5Fput%5Fresponse%5F200) | | **500** | Internal Server Error | [Response 500](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fallow%5Flist%5Fenable%5Fput%5Fresponse%5F500) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | string | **Response 500** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | string | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * AllowedIP ### Update Allowed IP PUT https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/allow_list/{id} #### Description Update an existing allowed IP in the workgroup #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **id** _required_ | Allowed IP ID | string | | **Path** | **workgroupID** _required_ | Workgroup ID | string | | **Body** | **request** _required_ | Allowed IP request | [AllowedIP](definitions.md#%5Fallowedip) | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fallow%5Flist%5Fid%5Fput%5Fresponse%5F200) | | **400** | Bad Request | [Response 400](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fallow%5Flist%5Fid%5Fput%5Fresponse%5F400) | | **500** | Internal Server Error | [Response 500](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fallow%5Flist%5Fid%5Fput%5Fresponse%5F500) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | [AllowedIP](definitions.md#%5Fallowedip) | **Response 400** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | string | **Response 500** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | string | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * AllowedIP ### Delete Allowed IP DELETE https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/allow_list/{id} #### Description Delete an existing allowed IP from the workgroup #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **id** _required_ | Allowed IP ID | string | | **Path** | **workgroupID** _required_ | Workgroup ID | string | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fallow%5Flist%5Fid%5Fdelete%5Fresponse%5F200) | | **500** | Internal Server Error | [Response 500](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fallow%5Flist%5Fid%5Fdelete%5Fresponse%5F500) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | string | **Response 500** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | string | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * AllowedIP ### Get database in workgroup GET https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/databases/{databaseID} #### Description Get database in workgroup #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **databaseID** _required_ | Database ID | string | | **Path** | **workgroupID** _required_ | Workgroup ID | string | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fdatabases%5Fdatabaseid%5Fget%5Fresponse%5F200) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | [TGDatabase](definitions.md#%5Ftgdatabase) | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * Database ### Update database in workgroup PUT https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/databases/{databaseID} #### Description Update database in workgroup #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **databaseID** _required_ | Database ID | string | | **Path** | **workgroupID** _required_ | Workgroup ID | string | | **Body** | **request** _required_ | Update database request | [UpdateTGDatabaseRequest](definitions.md#%5Fupdatetgdatabaserequest) | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fdatabases%5Fdatabaseid%5Fput%5Fresponse%5F200) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | [TGDatabase](definitions.md#%5Ftgdatabase) | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * Database ### Delete database in workgroup DELETE https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/databases/{databaseID} #### Description Delete database in workgroup #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **databaseID** _required_ | Database ID | string | | **Path** | **workgroupID** _required_ | Workgroup ID | string | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * Database ### Create workspace in workgroup POST https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces #### Description Create workspace in workgroup #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workgroupID** _required_ | Workgroup ID | string | | **Body** | **request** _required_ | Create workspace request | [CreateWorkspaceRequest](definitions.md#%5Fcreateworkspacerequest) | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fworkspaces%5Fpost%5Fresponse%5F200) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | [Workspace](definitions.md#%5Fworkspace) | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * Workspace ### Get workspace in workgroup GET https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID} #### Description Get workspace in workgroup #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workgroupID** _required_ | Workgroup ID | string | | **Path** | **workspaceID** _required_ | Workspace ID | string | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fworkspaces%5Fworkspaceid%5Fget%5Fresponse%5F200) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | [Workspace](definitions.md#%5Fworkspace) | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * Workspace ### Update workspace in workgroup PUT https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID} #### Description Update workspace in workgroup #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workgroupID** _required_ | Workgroup ID | string | | **Path** | **workspaceID** _required_ | Workspace ID | string | | **Body** | **request** _required_ | Update workspace request | [UpdateWorkspaceRequest](definitions.md#%5Fupdateworkspacerequest) | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fworkspaces%5Fworkspaceid%5Fput%5Fresponse%5F200) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | [Workspace](definitions.md#%5Fworkspace) | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * Workspace ### Delete workspace in workgroup DELETE https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID} #### Description Delete workspace in workgroup #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workgroupID** _required_ | Workgroup ID | string | | **Path** | **workspaceID** _required_ | Workspace ID | string | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * Workspace ### Delete a backup DELETE https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/backups #### Description Delete a backup for a workspace #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workgroupID** _required_ | Workgroup ID | string | | **Path** | **workspaceID** _required_ | Workspace ID | string | | **Body** | **request** _required_ | Delete Backup Request | [DeleteBackupRequest](definitions.md#%5Fdeletebackuprequest) | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | Successfully deleted the backup. | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | | **400** | Bad request | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | | **500** | Internal server error | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * Backup ### Restore a backup POST https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/backups/restore #### Description Restore a backup for a workspace #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workgroupID** _required_ | Workgroup ID | string | | **Path** | **workspaceID** _required_ | Workspace ID | string | | **Body** | **request** _required_ | Restore Backup Request | [RestoreBackupRequest](definitions.md#%5Frestorebackuprequest) | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | Successfully restored the backup. | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fworkspaces%5Fworkspaceid%5Fbackups%5Frestore%5Fpost%5Fresponse%5F200) | | **400** | Bad request | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | | **500** | Internal server error | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | string | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * Backup ### Set backup schedule POST https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/backups/schedule #### Description Set a backup schedule for a workspace #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workgroupID** _required_ | Workgroup ID | string | | **Path** | **workspaceID** _required_ | Workspace ID | string | | **Body** | **request** _required_ | Backup Schedule | [BackupSchedule](definitions.md#%5Fbackupschedule) | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | Successfully set the backup schedule. | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | | **400** | Bad request | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | | **500** | Internal server error | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * Backup ### Create in-database GSQL user POST https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/dbuser #### Description Create a new in-database GSQL user in the specified workspace and workgroup. #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workgroupID** _required_ | Workgroup ID | string | | **Path** | **workspaceID** _required_ | Workspace ID | string | | **Body** | **request** _required_ | In-database user request | [InDatabaseUserRequest](definitions.md#%5Findatabaseuserrequest) | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | Successfully created the in-database GSQL user. | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fworkspaces%5Fworkspaceid%5Fdbuser%5Fpost%5Fresponse%5F200) | | **400** | Bad request | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | | **500** | Internal server error | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | [tgIAM.IAMUser](definitions.md#%5Ftgiam%5Fiamuser) | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * DatabaseUser ### List in-database GSQL users GET https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/dbuser #### Description List all in-database GSQL users in the specified workspace and workgroup. #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workgroupID** _required_ | Workgroup ID | string | | **Path** | **workspaceID** _required_ | Workspace ID | string | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | Successfully listed the in-database GSQL users. | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkgroups%5Fworkgroupid%5Fworkspaces%5Fworkspaceid%5Fdbuser%5Fget%5Fresponse%5F200) | | **500** | Internal server error | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | < [tgIAM.IAMUser](definitions.md#%5Ftgiam%5Fiamuser) \> array | #### Produces * `application/json` #### Tags * DatabaseUser ### Update in-database GSQL user password PUT https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/dbuser #### Description Update the password of an in-database GSQL user in the specified workspace and workgroup. #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workgroupID** _required_ | Workgroup ID | string | | **Path** | **workspaceID** _required_ | Workspace ID | string | | **Body** | **request** _required_ | In-database user request | [InDatabaseUserRequest](definitions.md#%5Findatabaseuserrequest) | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | Successfully updated the in-database GSQL password. | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | | **400** | Bad request | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | | **500** | Internal server error | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * DatabaseUser ### Delete in-database GSQL user DELETE https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/dbuser #### Description Delete an in-database GSQL user in the specified workspace and workgroup. #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workgroupID** _required_ | Workgroup ID | string | | **Path** | **workspaceID** _required_ | Workspace ID | string | | **Body** | **request** _required_ | In-database user request | [InDatabaseUserRequest](definitions.md#%5Findatabaseuserrequest) | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | Successfully deleted the in-database GSQL user. | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | | **400** | Bad request | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | | **500** | Internal server error | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * DatabaseUser ### Pause workspace in workgroup POST https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/pause #### Description Pause workspace in workgroup #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workgroupID** _required_ | Workgroup ID | string | | **Path** | **workspaceID** _required_ | Workspace ID | string | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * Workspace ### Refresh workspace in workgroup POST https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/refresh #### Description Refresh workspace in workgroup #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workgroupID** _required_ | Workgroup ID | string | | **Path** | **workspaceID** _required_ | Workspace ID | string | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * Workspace ### Resume workspace in workgroup POST https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/resume #### Description Resume workspace in workgroup #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workgroupID** _required_ | Workgroup ID | string | | **Path** | **workspaceID** _required_ | Workspace ID | string | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * Workspace ### Get an metadata for your org GET https://api.tgcloud.io/controller/v4/v2/workspaces/meta #### Description Get regions/tgVersions/workspaceTypes supported for your org #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkspaces%5Fmeta%5Fget%5Fresponse%5F200) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | [resource\_manager\_handler.GetMetadata.metadata](definitions.md#%5Fresource%5Fmanager%5Fhandler%5Fgetmetadata%5Fmetadata) | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * Org ### List backups GET https://api.tgcloud.io/controller/v4/v2/workspaces/{workspaceID}/backups #### Description List all backups for a workspace #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workspaceID** _required_ | Workspace ID | string | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | Successfully listed the backups. | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkspaces%5Fworkspaceid%5Fbackups%5Fget%5Fresponse%5F200) | | **500** | Internal server error | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | < [Backup](definitions.md#%5Fbackup) \> array | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * Backup ### Get backup restore status GET https://api.tgcloud.io/controller/v4/v2/workspaces/{workspaceID}/backups/{job}/status #### Description Get the status of a backup restore job #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **job** _required_ | Job ID | string | | **Path** | **workspaceID** _required_ | Workspace ID | string | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | Successfully got the backup restore status. | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkspaces%5Fworkspaceid%5Fbackups%5Frestore%5Fjob%5Fstatus%5Fget%5Fresponse%5F200) | | **500** | Internal server error | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | [BackupRestoreStatus](definitions.md#%5Fbackuprestorestatus) | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * Backup ### Get backup schedule GET https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/backups/schedule #### Description Get the backup schedule for a workspace #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workgroupID** _required_ | Workgroup ID | string | | **Path** | **workspaceID** _required_ | Workspace ID | string | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | Successfully got the backup schedule. | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkspaces%5Fworkspaceid%5Fbackups%5Fschedule%5Fget%5Fresponse%5F200) | | **500** | Internal server error | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | [BackupSchedule](definitions.md#%5Fbackupschedule) | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * Backup ### Retrieve workspace schedule GET https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/schedules #### Description Retrieve the schedule for a given workspace #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workgroupID** _required_ | Workgroup ID | string | | **Path** | **workspaceID** _required_ | Workspace ID | string | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkspaces%5Fworkspaceid%5Fschedules%5Fget%5Fresponse%5F200) | | **500** | Internal Server Error | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | string | #### Produces * `application/json` #### Tags * WorkspaceSchedule ### Update an existing workspace schedule POST https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/backups/schedule #### Description Update an existing workspace schedule for a given workspace #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workgroupID** _required_ | Workgroup ID | string | | **Path** | **workspaceID** _required_ | Workspace ID | string | | **Body** | **body** _required_ | Workspace Schedule | [WorkspaceSchedule](definitions.md#%5Fworkspaceschedule) | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkspaces%5Fworkspaceid%5Fschedules%5Fschedule%5Fid%5Fput%5Fresponse%5F200) | | **400** | Bad Request | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | | **500** | Internal Server Error | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | string | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * WorkspaceSchedule ### Delete an existing workspace schedule POST https://api.tgcloud.io/controller/v4/v2/workgroups/{workgroupID}/workspaces/{workspaceID}/backups/schedule #### Description Delete an existing workspace schedule for a given workspace #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **workgroupID** _required_ | Workgroup ID | string | | **Path** | **workspaceID** _required_ | Workspace ID | string | | **Body** | **body** _required_ | Workspace Schedule | [WorkspaceSchedule](definitions.md#%5Fworkspaceschedule) | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [Response 200](#%5Fhttps%5Fapi%5Ftgcloud%5Fio%5Fcontroller%5Fv4%5Fv2%5Fworkspaces%5Fworkspaceid%5Fschedules%5Fschedule%5Fid%5Fdelete%5Fresponse%5F200) | | **500** | Internal Server Error | [middleware.Response](definitions.md#%5Fmiddleware%5Fresponse) | **Response 200** | Name | Schema | | --- | --- | | **Error** _optional_ | boolean | | **ErrorDetails** _optional_ | < [middleware.Error](definitions.md#%5Fmiddleware%5Ferror) \> array | | **Message** _optional_ | string | | **RequestID** _optional_ | string | | **Result** _optional_ | string | #### Produces * `application/json` #### Tags * WorkspaceSchedule ### List of users in the org GET https://api.tgcloud.io/users #### Description List of users in the org. Note: this endpoint is not APIKEY compatible #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **200** | OK | [org\_handler.OrgListUserResponse](definitions.md#%5Forg%5Fhandler%5Forglistuserresponse) | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * Org ### Update the role of an org user PUT https://api.tgcloud.io/users/{userId}/roles #### Description Updates the role of an org user. Note: this endpoint is not APIKEY compatible #### Parameters | Type | Name | Description | Schema | | --- | --- | --- | --- | | **Path** | **userId** _required_ | Id of the user | string | | **Body** | **body** _required_ | Roles of the user | [org\_handler.PutOrgUsersRoles](definitions.md#%5Forg%5Fhandler%5Fputorgusersroles) | #### Responses | HTTP Code | Description | Schema | | --- | --- | --- | | **204** | No Content | No Content | #### Consumes * `application/json` #### Produces * `application/json` #### Tags * Org