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

region
optional

string

CreateWorkspaceRequest

Create Workspace Request

Name Description Schema

addons
optional

< WorkspaceAddonsRequest > 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

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 > 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 > 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

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 > 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 > array

agent_config
optional

AgentConfig

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

region
optional

string

tg_databases
optional

< TGDatabase > array

workgroup_id
optional

string

workspaces
optional

< Workspace > array

Workspace

Name Schema

addons
optional

< WorkspaceAddonsRequest > array

agent_config
optional

AgentConfig

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

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

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

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 > 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

path
optional

string

roles
optional

< org_handler.OrgRole > 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 > 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 > 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 > array

data_storage_pricing
optional

< pb.DataStoragePricing > array

workspace_pricing
optional

< pb.WorkspacePricing > 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 > array

tgVersions
optional

< TGVersion > array

workspaceTypes
optional

< WorkspaceType > 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