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 |
Create workgroup request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
Response 200
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
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
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
< Workgroup > 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 |
Workgroup ID |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
Response 200
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
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 |
Workgroup ID |
string |
Body |
request |
Update workgroup request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
Response 200
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
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 |
Workgroup ID |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
Response 200
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
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 |
Workgroup ID |
string |
Body |
request |
Allowed IP request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
500 |
Internal Server Error |
Response 200
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
Response 400
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
string |
Response 500
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
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 |
Workgroup ID |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
500 |
Internal Server Error |
Response 200
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
< AllowedIP > array |
Response 500
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
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 |
Workgroup ID |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
500 |
Internal Server Error |
Response 200
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
Result
Name | Schema |
---|---|
|
boolean |
CurrentIP |
string |
Response 500
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
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 |
Workgroup ID |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
500 |
Internal Server Error |
Response 200
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
string |
Response 500
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
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 |
Workgroup ID |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
500 |
Internal Server Error |
Response 200
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
string |
Response 500
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
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 |
Allowed IP ID |
string |
Path |
workgroupID |
Workgroup ID |
string |
Body |
request |
Allowed IP request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
500 |
Internal Server Error |
Response 200
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
Response 400
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
string |
Response 500
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
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 |
Allowed IP ID |
string |
Path |
workgroupID |
Workgroup ID |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
500 |
Internal Server Error |
Response 200
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
string |
Response 500
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
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 |
Database ID |
string |
Path |
workgroupID |
Workgroup ID |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
Response 200
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
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 |
Database ID |
string |
Path |
workgroupID |
Workgroup ID |
string |
Body |
request |
Update database request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
Response 200
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
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 |
Database ID |
string |
Path |
workgroupID |
Workgroup ID |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
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 |
Workgroup ID |
string |
Body |
request |
Create workspace request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
Response 200
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
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 |
Workgroup ID |
string |
Path |
workspaceID |
Workspace ID |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
Response 200
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
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 |
Workgroup ID |
string |
Path |
workspaceID |
Workspace ID |
string |
Body |
request |
Update workspace request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
Response 200
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
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 |
Workgroup ID |
string |
Path |
workspaceID |
Workspace ID |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
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 |
Workgroup ID |
string |
Path |
workspaceID |
Workspace ID |
string |
Body |
request |
Delete Backup Request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfully deleted the backup. |
|
400 |
Bad request |
|
500 |
Internal server error |
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 |
Workgroup ID |
string |
Path |
workspaceID |
Workspace ID |
string |
Body |
request |
Restore Backup Request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfully restored the backup. |
|
400 |
Bad request |
|
500 |
Internal server error |
Response 200
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
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 |
Workgroup ID |
string |
Path |
workspaceID |
Workspace ID |
string |
Body |
request |
Backup Schedule |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfully set the backup schedule. |
|
400 |
Bad request |
|
500 |
Internal server error |
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 |
Workgroup ID |
string |
Path |
workspaceID |
Workspace ID |
string |
Body |
request |
In-database user request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfully created the in-database GSQL user. |
|
400 |
Bad request |
|
500 |
Internal server error |
Response 200
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
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 |
Workgroup ID |
string |
Path |
workspaceID |
Workspace ID |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfully listed the in-database GSQL users. |
|
500 |
Internal server error |
Response 200
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
< tgIAM.IAMUser > 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 |
Workgroup ID |
string |
Path |
workspaceID |
Workspace ID |
string |
Body |
request |
In-database user request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfully updated the in-database GSQL password. |
|
400 |
Bad request |
|
500 |
Internal server error |
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 |
Workgroup ID |
string |
Path |
workspaceID |
Workspace ID |
string |
Body |
request |
In-database user request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfully deleted the in-database GSQL user. |
|
400 |
Bad request |
|
500 |
Internal server error |
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 |
Workgroup ID |
string |
Path |
workspaceID |
Workspace ID |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
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 |
Workgroup ID |
string |
Path |
workspaceID |
Workspace ID |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
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 |
Workgroup ID |
string |
Path |
workspaceID |
Workspace ID |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
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
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
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 |
Workspace ID |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfully listed the backups. |
|
500 |
Internal server error |
Response 200
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
< Backup > 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 |
Job ID |
string |
Path |
workspaceID |
Workspace ID |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfully got the backup restore status. |
|
500 |
Internal server error |
Response 200
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
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 |
Workgroup ID |
string |
Path |
workspaceID |
Workspace ID |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Successfully got the backup schedule. |
|
500 |
Internal server error |
Response 200
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
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 |
Workgroup ID |
string |
Path |
workspaceID |
Workspace ID |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
500 |
Internal Server Error |
Response 200
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
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 |
Workgroup ID |
string |
Path |
workspaceID |
Workspace ID |
string |
Body |
body |
Workspace Schedule |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
500 |
Internal Server Error |
Response 200
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
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 |
Workgroup ID |
string |
Path |
workspaceID |
Workspace ID |
string |
Body |
body |
Workspace Schedule |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
500 |
Internal Server Error |
Response 200
Name | Schema |
---|---|
Error |
boolean |
ErrorDetails |
< middleware.Error > array |
Message |
string |
RequestID |
string |
Result |
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 |
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 |
Id of the user |
string |
Body |
body |
Roles of the user |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
Org