---
title: "Data Definitions"
description: "Descriptions of the data schemas used by the parameters, request bodies, and responses of Savanna endpoints"
component: "savanna"
version: "main"
module: "rest-api"
html_url: "/savanna/main/rest-api/definitions.html"
---

[View as HTML](/savanna/main/rest-api/definitions.html) · [Documentation index](/llms.txt)

# Data Definitions

Savanna uses several standardized data structures to pass information to and from its REST endpoints. This data describes the data schemas for those data objects.

## Data Objects

### AgentConfig

| Name | Schema |
| --- | --- |
| **catalog\_activity\_update\_interval\_seconds**   _optional_ | integer |
| **enable\_topology\_force\_update**   _optional_ | boolean |
| **heartbeat\_interval\_seconds**   _optional_ | integer |
| **query\_activity\_update\_interval\_seconds**   _optional_ | integer |
| **topology\_update\_interval\_seconds**   _optional_ | integer |

### AllowedIP

| Name | Schema |
| --- | --- |
| **cidr**   _required_ | string |
| **id**   _optional_ | string |
| **note**   _optional_ | string |

### Backup

| Name | Schema |
| --- | --- |
| **id**   _optional_ | string |
| **is\_automatic**   _optional_ | boolean |
| **size\_bytes**   _optional_ | string |
| **status**   _optional_ | string |
| **tag**   _optional_ | string |
| **time**   _optional_ | string |
| **type**   _optional_ | string |
| **version**   _optional_ | string |

### BackupRestoreStatus

| Name | Schema |
| --- | --- |
| **created\_at**   _optional_ | string |
| **name**   _optional_ | string |
| **output**   _optional_ | string |
| **status**   _optional_ | string |

### BackupSchedule

| Name | Schema |
| --- | --- |
| **max\_backup\_files**   _optional_ | integer |
| **max\_reserved\_days**   _optional_ | integer |
| **max\_retry**   _optional_ | integer |
| **pause**   _optional_ | boolean |
| **schedule**   _required_ | string |

### CreateWorkgroupRequest

| Name | Schema |
| --- | --- |
| **cloud\_provider\_id**   _required_ | string |
| **name**   _optional_ | string |
| **platform**   _optional_ | [constants.Platform](#%5Fconstants%5Fplatform) |
| **region**   _optional_ | string |

### CreateWorkspaceRequest

Create Workspace Request

| Name | Description | Schema |
| --- | --- | --- |
| **addons**   _optional_ |  | < [WorkspaceAddonsRequest](#%5Fworkspaceaddonsrequest) \> array |
| **auto\_stop\_minutes**   _optional_ |  | integer |
| **enable\_auto\_start**   _optional_ |  | boolean |
| **enable\_ha**   _optional_ |  | boolean |
| **is\_rw**   _optional_ |  | boolean |
| **name**   _optional_ |  | string |
| **solution\_install\_request**   _optional_ |  | [SolutionInstallRequest](#%5Fsolutioninstallrequest) |
| **tg\_database\_id**   _optional_ |  | string |
| **tg\_version**   _optional_ |  | string |
| **workspace\_type\_name**   _optional_ | Workspace Type Name TG-0/TG-2 | string |

### DeleteBackupRequest

| Name | Schema |
| --- | --- |
| **backup\_id**   _required_ | string |

### FolderStatistics

| Name | Schema |
| --- | --- |
| **backup\_size**   _optional_ | integer |
| **billed\_size**   _optional_ | integer |
| **log\_size**   _optional_ | integer |
| **milvus\_size**   _optional_ | integer |
| **total\_size**   _optional_ | integer |
| **workspaces**   _optional_ | < [WorkspaceSize](#%5Fworkspacesize) \> array |

### InDatabaseUserRequest

| Name | Schema |
| --- | --- |
| **password**   _optional_ | string |
| **username**   _optional_ | string |

### Region

| Name | Schema |
| --- | --- |
| **description**   _optional_ | string |
| **name**   _optional_ | string |

### RestoreBackupRequest

| Name | Schema |
| --- | --- |
| **backup\_id**   _required_ | string |

### SolutionInstallRequest

| Name | Schema |
| --- | --- |
| **addons**   _optional_ | < [WorkspaceAddonsRequest](#%5Fworkspaceaddonsrequest) \> array |
| **data\_source\_origin**   _optional_ | string |
| **name**   _optional_ | string |
| **solution\_catalog\_id**   _optional_ | string |

### TGDatabase

| Name | Schema |
| --- | --- |
| **create\_time**   _optional_ | string |
| **database\_id**   _optional_ | string |
| **folder\_statistics**   _optional_ | [FolderStatistics](#%5Ffolderstatistics) |
| **name**   _optional_ | string |
| **org\_id**   _optional_ | string |
| **org\_name**   _optional_ | string |
| **region**   _optional_ | string |
| **tg\_version**   _optional_ | string |
| **workgroup\_id**   _optional_ | string |
| **workspaces**   _optional_ | < [Workspace](#%5Fworkspace) \> array |

### TGVersion

| Name | Schema |
| --- | --- |
| **image**   _optional_ | string |
| **name**   _optional_ | string |

### UpdateTGDatabaseRequest

| Name | Schema |
| --- | --- |
| **tg\_database\_name**   _required_ | string |

### UpdateWorkgroupRequest

| Name | Schema |
| --- | --- |
| **workgroup\_name**   _optional_ | string |

### UpdateWorkspaceRequest

| Name | Description | Schema |
| --- | --- | --- |
| **addons**   _optional_ |  | < [WorkspaceAddonsRequest](#%5Fworkspaceaddonsrequest) \> array |
| **agent\_config**   _optional_ |  | [AgentConfig](#%5Fagentconfig) |
| **auto\_stop\_minutes**   _optional_ | **Minimum value** : `0` | integer |
| **enable\_auto\_start**   _optional_ |  | boolean |
| **enable\_ha**   _optional_ |  | boolean |
| **pause**   _optional_ |  | boolean |
| **workspace\_name**   _optional_ |  | string |
| **workspace\_type\_name**   _optional_ |  | string |

### Workgroup

| Name | Schema |
| --- | --- |
| **cloud\_provider\_id**   _optional_ | string |
| **creator**   _optional_ | string |
| **enable\_allow\_list**   _optional_ | boolean |
| **name**   _optional_ | string |
| **org\_id**   _optional_ | string |
| **org\_name**   _optional_ | string |
| **platform**   _optional_ | [constants.Platform](#%5Fconstants%5Fplatform) |
| **region**   _optional_ | string |
| **tg\_databases**   _optional_ | < [TGDatabase](#%5Ftgdatabase) \> array |
| **workgroup\_id**   _optional_ | string |
| **workspaces**   _optional_ | < [Workspace](#%5Fworkspace) \> array |

### Workspace

| Name | Schema |
| --- | --- |
| **addons**   _optional_ | < [WorkspaceAddonsRequest](#%5Fworkspaceaddonsrequest) \> array |
| **agent\_config**   _optional_ | [AgentConfig](#%5Fagentconfig) |
| **auto\_stop\_minutes**   _optional_ | integer |
| **cloud\_provider\_id**   _optional_ | string |
| **condition\_type**   _optional_ | string |
| **created\_at**   _optional_ | string |
| **creator**   _optional_ | string |
| **database\_id**   _optional_ | string |
| **edge\_count**   _optional_ | integer |
| **enable\_auto\_start**   _optional_ | boolean |
| **enable\_ha**   _optional_ | boolean |
| **folder\_statistics**   _optional_ | [FolderStatistics](#%5Ffolderstatistics) |
| **graph\_topology\_size\_bytes**   _optional_ | integer |
| **is\_rw**   _optional_ | boolean |
| **last\_modified\_time**   _optional_ | string |
| **name**   _optional_ | string |
| **nginx\_host**   _optional_ | string |
| **org\_id**   _optional_ | string |
| **org\_name**   _optional_ | string |
| **refresh\_message**   _optional_ | string |
| **refresh\_status**   _optional_ | string |
| **region**   _optional_ | string |
| **size**   _optional_ | integer |
| **snapshot\_time**   _optional_ | string |
| **solution\_catalog\_id**   _optional_ | string |
| **status**   _optional_ | string |
| **tg\_version**   _optional_ | string |
| **version\_number**   _optional_ | integer |
| **vertex\_count**   _optional_ | integer |
| **workgroup\_id**   _optional_ | string |
| **workgroup\_name**   _optional_ | string |
| **workspace\_id**   _optional_ | string |
| **workspace\_type**   _optional_ | [WorkspaceType](#%5Fworkspacetype) |

### WorkspaceSchedule

| Name | Schema |
| --- | --- |
| **date**   _optional_ | string |
| **id**   _optional_ | string |
| **repeat**   _required_ | string |
| **repeat\_on**   _optional_ | string |
| **time**   _required_ | string |
| **timezone**   _required_ | string |
| **workspace\_id**   _required_ | string |
| **workspace\_type\_name**   _optional_ | string |

### WorkspaceSize

| Name | Schema |
| --- | --- |
| **size**   _optional_ | integer |
| **workspace\_id**   _optional_ | string |

### WorkspaceType

| Name | Schema |
| --- | --- |
| **cpu**   _optional_ | string |
| **ha**   _optional_ | integer |
| **memory**   _optional_ | string |
| **partition**   _optional_ | integer |
| **typeName**   _optional_ | string |

### middleware.Error

| Name | Schema |
| --- | --- |
| **FieldName**   _optional_ | string |
| **Reason**   _optional_ | string |
| **Type**   _optional_ | [middleware.ErrorType](#%5Fmiddleware%5Ferrortype) |

### middleware.ErrorType

_Type_ : enum (Internal-Error, Bad-Request, Not-Found, Forbidden, Unauthorized, API-Disabled, Quota-Exceed, Unknown)

### middleware.Response

| Name | Schema |
| --- | --- |
| **Error**   _optional_ | boolean |
| **ErrorDetails**   _optional_ | < [middleware.Error](#%5Fmiddleware%5Ferror) \> array |
| **Message**   _optional_ | string |
| **RequestID**   _optional_ | string |
| **Result**   _optional_ | object |

### org\_handler.OrgListUserResponse

| Name | Schema |
| --- | --- |
| **auth0UserID**   _optional_ | string |
| **authID**   _optional_ | string |
| **created**   _optional_ | string |
| **email**   _optional_ | string |
| **enabled**   _optional_ | boolean |
| **firstName**   _optional_ | string |
| **id**   _optional_ | string |
| **lastName**   _optional_ | string |
| **metadata**   _optional_ | [org\_handler.OrgMetadata](#%5Forg%5Fhandler%5Forgmetadata) |
| **path**   _optional_ | string |
| **roles**   _optional_ | < [org\_handler.OrgRole](#%5Forg%5Fhandler%5Forgrole) \> array |
| **tenantID**   _optional_ | string |
| **trn**   _optional_ | string |
| **updated**   _optional_ | string |
| **username**   _optional_ | string |

### org\_handler.OrgMetadata

| Name | Schema |
| --- | --- |
| **attachedTo**   _optional_ | < string > array |
| **lastLogin**   _optional_ | string |

### org\_handler.OrgRole

| Name | Schema |
| --- | --- |
| **displayName**   _optional_ | string |
| **id**   _optional_ | string |
| **name**   _optional_ | string |
| **path**   _optional_ | string |
| **tenantID**   _optional_ | string |
| **trn**   _optional_ | string |

### org\_handler.PutOrgUsersRoles

| Name | Schema |
| --- | --- |
| **roles**   _optional_ | < string > array |

### pb.APIKey

| Name | Schema |
| --- | --- |
| **created\_at**   _optional_ | string |
| **creator**   _optional_ | string |
| **description**   _optional_ | string |
| **expires\_at**   _optional_ | string |
| **key\_name**   _optional_ | string |
| **org\_id**   _optional_ | string |
| **plaintext\_key**   _optional_ | string |
| **redacted\_key**   _optional_ | string |
| **user\_id**   _optional_ | string |

### pb.CreateAPIKeyRequest

| Name | Schema |
| --- | --- |
| **description**   _optional_ | string |
| **life\_time\_in\_seconds**   _optional_ | integer |

### pb.CustomerCreditCard

| Name | Schema |
| --- | --- |
| **brand**   _optional_ | string |
| **card\_id**   _optional_ | string |
| **expire\_month**   _optional_ | integer |
| **expire\_year**   _optional_ | integer |
| **last\_4\_digits**   _optional_ | string |
| **name\_on\_card**   _optional_ | string |
| **org\_id**   _optional_ | string |

### pb.DataStoragePricing

| Name | Schema |
| --- | --- |
| **platform**   _optional_ | string |
| **price\_per\_month**   _optional_ | number |
| **region**   _optional_ | string |

### pb.DeleteAPIKeyRequest

| Name | Schema |
| --- | --- |
| **key\_name**   _optional_ | string |

### pb.FeatureFlag

| Name | Schema |
| --- | --- |
| **enabled**   _optional_ | boolean |
| **feature\_name**   _optional_ | string |

### pb.GetCustomerCreditCardsResponse

| Name | Schema |
| --- | --- |
| **credit\_cards**   _optional_ | < [pb.CustomerCreditCard](#%5Fpb%5Fcustomercreditcard) \> array |
| **default\_card**   _optional_ | string |

### pb.OrgQuota

| Name | Schema |
| --- | --- |
| **max\_workspace\_memory**   _optional_ | string |
| **max\_workspace\_type**   _optional_ | string |
| **memory\_limit**   _optional_ | string |
| **memory\_usage\_in\_bytes**   _optional_ | integer |
| **org\_id**   _optional_ | string |
| **ro\_workspace\_count\_limit**   _optional_ | integer |
| **ro\_workspace\_count\_usage**   _optional_ | integer |
| **rw\_workspace\_count\_limit**   _optional_ | integer |
| **rw\_workspace\_count\_usage**   _optional_ | integer |
| **tier**   _optional_ | string |
| **workspace\_auto\_backup\_count\_limit**   _optional_ | integer |
| **workspace\_auto\_backup\_retention\_in\_days**   _optional_ | integer |
| **workspace\_manual\_backup\_count\_limit**   _optional_ | integer |

### pb.Organization

| Name | Schema |
| --- | --- |
| **create\_time**   _optional_ | string |
| **creator**   _optional_ | string |
| **feature\_flag**   _optional_ | < [pb.FeatureFlag](#%5Fpb%5Ffeatureflag) \> array |
| **logo\_url**   _optional_ | string |
| **org\_display\_name**   _optional_ | string |
| **org\_id**   _optional_ | string |
| **org\_name**   _optional_ | string |

### pb.ResourcePricing

| Name | Schema |
| --- | --- |
| **addon\_pricing**   _optional_ | < [pb.AddOnPricing](#%5Fpb%5Faddonpricing) \> array |
| **data\_storage\_pricing**   _optional_ | < [pb.DataStoragePricing](#%5Fpb%5Fdatastoragepricing) \> array |
| **workspace\_pricing**   _optional_ | < [pb.WorkspacePricing](#%5Fpb%5Fworkspacepricing) \> array |

### pb.WorkspacePricing

| Name | Schema |
| --- | --- |
| **cloud\_provider**   _optional_ | string |
| **ha**   _optional_ | string |
| **platform**   _optional_ | string |
| **price\_per\_hour**   _optional_ | number |
| **region**   _optional_ | string |
| **workspace\_type**   _optional_ | string |

### resource\_manager\_handler.GetMetadata.metadata

| Name | Schema |
| --- | --- |
| **regions**   _optional_ | < [Region](#%5Fregion) \> array |
| **tgVersions**   _optional_ | < [TGVersion](#%5Ftgversion) \> array |
| **workspaceTypes**   _optional_ | < [WorkspaceType](#%5Fworkspacetype) \> array |

### tgIAM.IAMUser

| Name | Schema |
| --- | --- |
| **auth0UserID**   _optional_ | string |
| **created**   _optional_ | string |
| **email**   _optional_ | string |
| **enabled**   _optional_ | boolean |
| **firstName**   _optional_ | string |
| **id**   _optional_ | string |
| **lastName**   _optional_ | string |
| **path**   _optional_ | string |
| **tenantID**   _optional_ | string |
| **trn**   _optional_ | string |
| **updated**   _optional_ | string |
| **username**   _optional_ | string |

### tgIAM.OrgRequest

| Name | Schema |
| --- | --- |
| **logoUrl**   _optional_ | string |
| **orgDisplayName**   _optional_ | string |
| **orgID**   _optional_ | string |
| **orgName**   _optional_ | string |