package soulfire.v1

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc GetClientData (ClientDataRequest, ClientDataResponse)

  client.proto:71

  message ClientDataRequest

  client.proto:10

  (message has no fields)

  message ClientDataResponse

  client.proto:27

  • string id = 6

  • string username = 1

  • UserRole role = 7

  • string email = 8

  • repeated GlobalPermissionState server_permissions = 2

  • optional ServerInfo server_info = 11

• rpc GenerateWebDAVToken (GenerateWebDAVTokenRequest, GenerateWebDAVTokenResponse)

  client.proto:72

  message GenerateWebDAVTokenRequest

  client.proto:36

  (message has no fields)

  message GenerateWebDAVTokenResponse

  client.proto:39

  • string token = 1

• rpc GenerateAPIToken (GenerateAPITokenRequest, GenerateAPITokenResponse)

  client.proto:73

  message GenerateAPITokenRequest

  client.proto:43

  (message has no fields)

  message GenerateAPITokenResponse

  client.proto:46

  • string token = 1

• rpc UpdateSelfUsername (UpdateSelfUsernameRequest, UpdateSelfUsernameResponse)

  client.proto:74

  message UpdateSelfUsernameRequest

  client.proto:50

  • string username = 1

  message UpdateSelfUsernameResponse

  client.proto:54

  (message has no fields)

• rpc UpdateSelfEmail (UpdateSelfEmailRequest, UpdateSelfEmailResponse)

  client.proto:75

  message UpdateSelfEmailRequest

  client.proto:57

  • string email = 1

  message UpdateSelfEmailResponse

  client.proto:61

  (message has no fields)

• rpc InvalidateSelfSessions (InvalidateSelfSessionsRequest, InvalidateSelfSessionsResponse)

  client.proto:76

  message InvalidateSelfSessionsRequest

  client.proto:64

  (message has no fields)

  message InvalidateSelfSessionsResponse

  client.proto:67

  (message has no fields)

• rpc ExecuteCommand (CommandRequest, CommandResponse)

  command.proto:47

  message CommandRequest

  command.proto:22

  • optional CommandScope scope = 4

  • string command = 3

  message CommandResponse

  command.proto:27

  • int32 code = 1

• rpc TabCompleteCommand (CommandCompletionRequest, CommandCompletionResponse)

  command.proto:48

  message CommandCompletionRequest

  command.proto:31

  • optional CommandScope scope = 5

  • string command = 3

  • int32 cursor = 4

  message CommandCompletionResponse

  command.proto:42

  • repeated CommandCompletion suggestions = 1

• rpc Download (DownloadRequest, DownloadResponse)

  download.proto:29

  message DownloadRequest

  download.proto:15

  • string instance_id = 1

  • string uri = 2

  • repeated HeaderPair headers = 3

  • optional ProxyProto proxy = 4

  message DownloadResponse

  download.proto:22

  • bytes data = 1

  • repeated HeaderPair headers = 2

  • int32 status_code = 3

• rpc CreateInstance (InstanceCreateRequest, InstanceCreateResponse)

  instance.proto:131

  message InstanceCreateRequest

  instance.proto:23

  • string friendlyName = 1

  message InstanceCreateResponse

  instance.proto:27

  • string id = 1

• rpc DeleteInstance (InstanceDeleteRequest, InstanceDeleteResponse)

  instance.proto:132

  message InstanceDeleteRequest

  instance.proto:31

  • string id = 1

  message InstanceDeleteResponse

  instance.proto:35

  (message has no fields)

• rpc ListInstances (InstanceListRequest, InstanceListResponse)

  instance.proto:133

  message InstanceListRequest

  instance.proto:46

  (message has no fields)

  message InstanceListResponse

  instance.proto:49

  • repeated InstanceListResponse.Instance instances = 1

• rpc GetInstanceInfo (InstanceInfoRequest, InstanceInfoResponse)

  instance.proto:134

  message InstanceInfoRequest

  instance.proto:66

  • string id = 1

  message InstanceInfoResponse

  instance.proto:70

  • string friendly_name = 1

  • string icon = 5

  • optional InstanceConfig config = 2

  • InstanceState state = 3

  • repeated InstancePermissionState instance_permissions = 4

  • repeated SettingsPage instance_settings = 6

• rpc UpdateInstanceMeta (InstanceUpdateMetaRequest, InstanceUpdateMetaResponse)

  instance.proto:135

  message InstanceUpdateMetaRequest

  instance.proto:79

  • string id = 1

  • oneof meta

    • string friendly_name = 2

    • string icon = 3

  message InstanceUpdateMetaResponse

  instance.proto:87

  (message has no fields)

• rpc UpdateInstanceConfig (InstanceUpdateConfigRequest, InstanceUpdateConfigResponse)

  instance.proto:136

  message InstanceUpdateConfigRequest

  instance.proto:90

  • string id = 1

  • optional InstanceConfig config = 2

  message InstanceUpdateConfigResponse

  instance.proto:95

  (message has no fields)

• rpc ChangeInstanceState (InstanceStateChangeRequest, InstanceStateChangeResponse)

  instance.proto:137

  message InstanceStateChangeRequest

  instance.proto:98

  • string id = 1

  • InstanceState state = 2

  message InstanceStateChangeResponse

  instance.proto:103

  (message has no fields)

• rpc GetAuditLog (InstanceAuditLogRequest, InstanceAuditLogResponse)

  instance.proto:138

  message InstanceAuditLogRequest

  instance.proto:106

  • string id = 1

  message InstanceAuditLogResponse

  instance.proto:110

  • repeated InstanceAuditLogResponse.AuditLogEntry entry = 1

• rpc Login (LoginRequest, NextAuthFlowResponse)

  login.proto:42

  message LoginRequest

  login.proto:8

  • string email = 1

• rpc EmailCode (EmailCodeRequest, NextAuthFlowResponse)

  login.proto:43

  message EmailCodeRequest

  login.proto:36

  • string auth_flow_token = 1

  • string code = 2

• rpc GetPrevious (PreviousLogRequest, PreviousLogResponse)

  logs.proto:65

  message PreviousLogRequest

  logs.proto:47

  • optional LogScope scope = 4

  • int32 count = 3

  message PreviousLogResponse

  logs.proto:52

  • repeated LogString messages = 1

• rpc Subscribe (LogRequest, stream LogResponse)

  logs.proto:66

  message LogRequest

  logs.proto:56

  • optional LogScope scope = 3

  message LogResponse

  logs.proto:60

  • optional LogString message = 1

• rpc LoginCredentials (CredentialsAuthRequest, stream CredentialsAuthResponse)

  mc-auth.proto:66

  message CredentialsAuthRequest

  mc-auth.proto:10

  • string instance_id = 1

  • AccountTypeCredentials service = 2

  • repeated string payload = 3

  message CredentialsAuthResponse

  mc-auth.proto:29

  • oneof data

    • CredentialsAuthFullList full_list = 1

    • CredentialsAuthOneSuccess one_success = 2

    • CredentialsAuthOneFailure one_failure = 3

• rpc LoginDeviceCode (DeviceCodeAuthRequest, stream DeviceCodeAuthResponse)

  mc-auth.proto:67

  message DeviceCodeAuthRequest

  mc-auth.proto:37

  • string instance_id = 1

  • AccountTypeDeviceCode service = 2

  message DeviceCodeAuthResponse

  mc-auth.proto:49

  • oneof data

    • MinecraftAccountProto account = 1

    • DeviceCode device_code = 2

• rpc Refresh (RefreshRequest, RefreshResponse)

  mc-auth.proto:68

  message RefreshRequest

  mc-auth.proto:56

  • string instance_id = 1

  • optional MinecraftAccountProto account = 2

  message RefreshResponse

  mc-auth.proto:61

  • optional MinecraftAccountProto account = 1

• rpc Check (ProxyCheckRequest, stream ProxyCheckResponse)

  proxy-check.proto:44

  message ProxyCheckRequest

  proxy-check.proto:10

  • string instance_id = 1

  • repeated ProxyProto proxy = 2

  message ProxyCheckResponse

  proxy-check.proto:35

  • oneof data

    • ProxyCheckFullList full_list = 1

    • ProxyCheckOneSuccess one_success = 2

    • ProxyCheckOneFailure one_failure = 3

• rpc CreateScript (CreateScriptRequest, CreateScriptResponse)

  script.proto:83

  message CreateScriptRequest

  script.proto:25

  • optional ScriptScope scope = 1

  • string script_name = 2

  • bool elevated_permissions = 3

  message CreateScriptResponse

  script.proto:31

  • string id = 1

• rpc DeleteScript (DeleteScriptRequest, DeleteScriptResponse)

  script.proto:84

  message DeleteScriptRequest

  script.proto:35

  • string id = 1

  message DeleteScriptResponse

  script.proto:39

  (message has no fields)

• rpc RestartScript (RestartScriptRequest, RestartScriptResponse)

  script.proto:85

  message RestartScriptRequest

  script.proto:42

  • string id = 1

  message RestartScriptResponse

  script.proto:46

  (message has no fields)

• rpc UpdateScript (UpdateScriptRequest, UpdateScriptResponse)

  script.proto:86

  message UpdateScriptRequest

  script.proto:49

  • string id = 1

  • string script_name = 2

  • bool elevated_permissions = 3

  message UpdateScriptResponse

  script.proto:55

  (message has no fields)

• rpc ListScripts (ScriptListRequest, ScriptListResponse)

  script.proto:87

  message ScriptListRequest

  script.proto:58

  • optional ScriptScope scope = 1

  message ScriptListResponse

  script.proto:68

  • repeated ScriptListResponse.Script scripts = 1

• rpc GetServerInfo (ServerInfoRequest, ServerInfoResponse)

  server.proto:30

  message ServerInfoRequest

  server.proto:14

  (message has no fields)

  message ServerInfoResponse

  server.proto:17

  • optional ServerConfig config = 1

  • repeated SettingsPage server_settings = 2

• rpc UpdateServerConfig (ServerUpdateConfigRequest, ServerUpdateConfigResponse)

  server.proto:31

  message ServerUpdateConfigRequest

  server.proto:22

  • optional ServerConfig config = 1

  message ServerUpdateConfigResponse

  server.proto:26

  (message has no fields)

• rpc CreateUser (UserCreateRequest, UserCreateResponse)

  user.proto:87

  message UserCreateRequest

  user.proto:11

  • string username = 1

  • UserRole role = 2

  • string email = 3

  message UserCreateResponse

  user.proto:17

  • string id = 1

• rpc DeleteUser (UserDeleteRequest, UserDeleteResponse)

  user.proto:88

  message UserDeleteRequest

  user.proto:21

  • string id = 1

  message UserDeleteResponse

  user.proto:25

  (message has no fields)

• rpc ListUsers (UserListRequest, UserListResponse)

  user.proto:89

  message UserListRequest

  user.proto:28

  (message has no fields)

  message UserListResponse

  user.proto:31

  • repeated UserListResponse.User users = 1

• rpc GetUserInfo (UserInfoRequest, UserInfoResponse)

  user.proto:90

  message UserInfoRequest

  user.proto:46

  • string id = 1

  message UserInfoResponse

  user.proto:50

  • string username = 1

  • UserRole role = 2

  • string email = 3

  • optional google.protobuf.Timestamp created_at = 4

  • optional google.protobuf.Timestamp updated_at = 5

  • optional google.protobuf.Timestamp last_login_at = 6

  • optional google.protobuf.Timestamp min_issued_at = 7

• rpc InvalidateSessions (InvalidateSessionsRequest, InvalidateSessionsResponse)

  user.proto:91

  message InvalidateSessionsRequest

  user.proto:61

  Invalidate all sessions for a user, effectively logging them out of all devices.

  • string id = 1

  message InvalidateSessionsResponse

  user.proto:65

  (message has no fields)

• rpc UpdateUser (UpdateUserRequest, UpdateUserResponse)

  user.proto:92

  message UpdateUserRequest

  user.proto:68

  • string id = 1

  • string username = 2

  • UserRole role = 3

  • string email = 4

  message UpdateUserResponse

  user.proto:75

  (message has no fields)

• rpc GenerateUserAPIToken (GenerateUserAPITokenRequest, GenerateUserAPITokenResponse)

  user.proto:93

  message GenerateUserAPITokenRequest

  user.proto:78

  • string id = 1

  message GenerateUserAPITokenResponse

  user.proto:82

  • string token = 1

Used in: CredentialsAuthRequest

• MICROSOFT_JAVA_CREDENTIALS = 0

• MICROSOFT_BEDROCK_CREDENTIALS = 1

• OFFLINE = 4

• MICROSOFT_JAVA_REFRESH_TOKEN = 5

Used in: DeviceCodeAuthRequest

• MICROSOFT_JAVA_DEVICE_CODE = 0

• MICROSOFT_BEDROCK_DEVICE_CODE = 1

Used in: SettingEntry

• string ui_name = 1

• string description = 2

• bool def = 3

• bool disabled = 4

Used in: LogScope

• string instance_id = 1

• string bot_id = 2

Used in: SettingEntry

• string ui_name = 1

• string description = 2

• repeated ComboSetting.Option options = 3

  List of options

• string def = 4

• bool disabled = 5

Used in: ComboSetting

• string id = 1

  Sent to server

• string display_name = 2

  Displayed to user

• optional string icon_id = 3

  May be used for an icon for an option

• repeated string keywords = 4

  keywords to also use for filtering

Used in: CommandCompletionResponse

• string suggestion = 1

• optional string tooltip = 2

Used in: CommandCompletionRequest, CommandRequest

• oneof scope

  • GlobalCommandScope global = 1

  • InstanceCommandScope instance = 2

Full response of all accounts that were authenticated

Used in: CredentialsAuthResponse

• repeated MinecraftAccountProto account = 1

Used when an account is not successfully authenticated

Used in: CredentialsAuthResponse

(message has no fields)

Used when an account is successfully authenticated

Used in: CredentialsAuthResponse

(message has no fields)

Used in: DeviceCodeAuthResponse

• string device_code = 1

• string user_code = 2

• string verification_uri = 3

• string direct_verification_uri = 4

Used in: SettingEntry

• string ui_name = 1

• string description = 2

• double def = 3

• double min = 4

• double max = 5

• double step = 6

• string placeholder = 7

• bool thousand_separator = 8

• int32 decimal_scale = 9

• bool fixed_decimal_scale = 10

• bool disabled = 11

Used in: CommandScope

(message has no fields)

Used in: LogScope

(message has no fields)

Used in: GlobalPermissionState

• CREATE_INSTANCE = 0

• GLOBAL_SUBSCRIBE_LOGS = 1

• READ_CLIENT_DATA = 2

• READ_SERVER_CONFIG = 3

• UPDATE_SERVER_CONFIG = 4

• CREATE_USER = 5

• READ_USER = 6

• UPDATE_USER = 7

• DELETE_USER = 8

• GLOBAL_COMMAND_EXECUTION = 9

• INVALIDATE_SESSIONS = 11

• GENERATE_SELF_WEBDAV_TOKEN = 12

• GENERATE_SELF_API_TOKEN = 15

• UPDATE_SELF_USERNAME = 13

• UPDATE_SELF_EMAIL = 14

• GENERATE_API_TOKEN = 16

• INVALIDATE_SELF_SESSIONS = 17

• CREATE_GLOBAL_SCRIPT = 18

• READ_GLOBAL_SCRIPT = 19

• UPDATE_GLOBAL_SCRIPT = 20

• DELETE_GLOBAL_SCRIPT = 21

• ELEVATE_SCRIPT_PERMISSIONS = 22

Used in: ClientDataResponse

• GlobalPermission global_permission = 1

• bool granted = 2

Used in: LogScope

• string script_id = 1

Used in: ScriptScope

(message has no fields)

Used in: DownloadRequest, DownloadResponse

• string key = 1

• string value = 2

Used in: InstanceAuditLogResponse

• string id = 1

• optional InstanceUser user = 2

• AuditLogEntryType type = 3

• optional google.protobuf.Timestamp timestamp = 4

• string data = 5

Used in: AuditLogEntry

• EXECUTE_COMMAND = 0

• START_ATTACK = 1

• PAUSE_ATTACK = 2

• RESUME_ATTACK = 3

• STOP_ATTACK = 4

Used in: CommandScope

• string instance_id = 1

Used in: InstanceInfoResponse, InstanceUpdateConfigRequest

• repeated SettingsNamespace settings = 1

• repeated MinecraftAccountProto accounts = 2

• repeated ProxyProto proxies = 3

Used in: InstanceListResponse

• string id = 1

• string friendly_name = 2

• string icon = 5

• InstanceState state = 3

• repeated InstancePermissionState instance_permissions = 4

Used in: LogScope

• string instance_id = 1

Used in: InstancePermissionState

• INSTANCE_COMMAND_EXECUTION = 0

• READ_INSTANCE = 2

• UPDATE_INSTANCE_META = 3

• UPDATE_INSTANCE_CONFIG = 14

• DELETE_INSTANCE = 4

• CHANGE_INSTANCE_STATE = 5

• AUTHENTICATE_MC_ACCOUNT = 6

• CHECK_PROXY = 7

• DOWNLOAD_URL = 8

• ACCESS_OBJECT_STORAGE = 9

• ACCESS_SCRIPT_CODE_OBJECT_STORAGE = 20

• INSTANCE_SUBSCRIBE_LOGS = 13

• READ_INSTANCE_AUDIT_LOGS = 15

• CREATE_SCRIPT = 16

• READ_SCRIPT = 17

• UPDATE_SCRIPT = 18

• DELETE_SCRIPT = 19

Used in: InstanceInfoResponse, InstanceListResponse.Instance

• InstancePermission instance_permission = 1

• bool granted = 2

Used in: LogScope

• string instance_id = 1

• string script_id = 2

Used in: ScriptScope

• string id = 1

Used in: InstanceInfoResponse, InstanceListResponse.Instance, InstanceStateChangeRequest

• STARTING = 0

• RUNNING = 1

• PAUSED = 2

• STOPPING = 3

• STOPPED = 4

Used in: InstanceAuditLogResponse.AuditLogEntry

• string id = 1

• string username = 2

• string email = 3

Used in: SettingEntry

• string ui_name = 1

• string description = 2

• int32 def = 3

• int32 min = 4

• int32 max = 5

• int32 step = 6

• string placeholder = 7

• bool thousand_separator = 8

• bool disabled = 9

Used in: LogRequest, PreviousLogRequest

• oneof scope

  • GlobalLogScope global = 1

  • InstanceLogScope instance = 2

  • BotLogScope bot = 3

  • GlobalScriptLogScope global_script = 4

  • InstanceScriptLogScope instance_script = 5

Used in: LogResponse, PreviousLogResponse

• string id = 1

• string message = 2

• optional string instance_id = 3

• optional string bot_id = 4

• optional string script_id = 5

Used in: SettingEntry

• int32 min = 1

• int32 max = 2

• int32 step = 3

• bool thousand_separator = 4

• optional MinMaxSetting.Entry minEntry = 5

• optional MinMaxSetting.Entry maxEntry = 6

• bool disabled = 7

Used in: MinMaxSetting

• string ui_name = 1

• string description = 2

• int32 def = 3

• string placeholder = 4

Used in: CredentialsAuthFullList, DeviceCodeAuthResponse, InstanceConfig, RefreshRequest, RefreshResponse

• MinecraftAccountProto.AccountTypeProto type = 1

• string profile_id = 2

• string last_known_name = 3

• oneof account_data

  • MinecraftAccountProto.OnlineChainJavaData online_chain_java_data = 5

  • MinecraftAccountProto.OfflineJavaData offline_java_data = 6

  • MinecraftAccountProto.BedrockData bedrock_data = 7

Used in: MinecraftAccountProto

• MICROSOFT_JAVA_CREDENTIALS = 0

• MICROSOFT_BEDROCK_CREDENTIALS = 1

• OFFLINE = 4

• MICROSOFT_JAVA_DEVICE_CODE = 5

• MICROSOFT_BEDROCK_DEVICE_CODE = 6

• MICROSOFT_JAVA_REFRESH_TOKEN = 7

Used in: MinecraftAccountProto

• string mojang_jwt = 1

• string identity_jwt = 2

• string public_key = 3

• string private_key = 4

• string device_id = 5

• string play_fab_id = 6

• optional google.protobuf.Struct auth_chain = 7

Used in: MinecraftAccountProto

(message has no fields)

Used in: MinecraftAccountProto

• string auth_token = 1

• int64 token_expire_at = 2

• optional google.protobuf.Struct auth_chain = 3

Used as response type in: LoginService.EmailCode, LoginService.Login

• string auth_flow_token = 1

• oneof next

  • NextAuthFlowResponse.EmailCode email_code = 2

  • NextAuthFlowResponse.Success success = 3

  • NextAuthFlowResponse.Failure failure = 4

Used in: NextAuthFlowResponse

(message has no fields)

Used in: NextAuthFlowResponse

• Failure.Reason reason = 1

Used in: Failure

• INVALID_CODE = 0

Used in: NextAuthFlowResponse

• string token = 1

Full response of all proxies that were checked

Used in: ProxyCheckResponse

• repeated ProxyCheckResponseSingle response = 1

Used when a proxy is not successfully checked

Used in: ProxyCheckResponse

(message has no fields)

Used when a proxy is successfully checked

Used in: ProxyCheckResponse

(message has no fields)

Used in: ProxyCheckFullList

• optional ProxyProto proxy = 1

• bool valid = 2

• int32 latency = 3

• string real_ip = 4

Used in: DownloadRequest, InstanceConfig, ProxyCheckRequest, ProxyCheckResponseSingle

• ProxyProto.Type type = 1

• string address = 2

• optional string username = 3

• optional string password = 4

Used in: ProxyProto

• HTTP = 0

• SOCKS4 = 1

• SOCKS5 = 2

Used in: ScriptListResponse.Script

• JAVASCRIPT = 0

• PYTHON = 1

• TYPESCRIPT = 2

Used in: ScriptListResponse

• string id = 1

• string script_name = 2

• bool elevated_permissions = 3

• ScriptLanguage language = 4

• optional google.protobuf.Timestamp created_at = 5

• optional google.protobuf.Timestamp updated_at = 6

• optional ScriptScope script_scope = 7

Used in: CreateScriptRequest, ScriptListRequest, ScriptListResponse.Script

• oneof scope

  • GlobalScriptScope global_script = 1

  • InstanceScriptScope instance_script = 2

Used in: ServerInfoResponse, ServerUpdateConfigRequest

• repeated SettingsNamespace settings = 1

Used in: ClientDataResponse

• string version = 1

• string commit_hash = 2

• string branch_name = 3

• string public_api_address = 4

• string public_webdav_address = 5

• string public_docs_address = 6

Used in: SettingsPage

• string id = 1

• string version = 2

• string description = 3

• string author = 4

• string license = 5

• string website = 6

A entry in the settings page

Used in: SettingsPage

• string key = 1

  Basically we only send a kv map to the server with every setting entry

• oneof value

  • StringSetting string = 2

  • IntSetting int = 3

  • DoubleSetting double = 4

  • BoolSetting bool = 5

  • ComboSetting combo = 6

  • StringListSetting string_list = 7

  • MinMaxSetting min_max = 8

Used in: SettingsNamespace

• string key = 1

• optional google.protobuf.Value value = 2

Used in: InstanceConfig, ServerConfig

• string namespace = 1

• repeated SettingsEntry entries = 2

Used in: InstanceInfoResponse, ServerInfoResponse

• optional ServerPlugin owning_plugin = 2

• string page_name = 3

  The name of the page for these settings

• string namespace = 4

  What namespace the settings of this page represent

• repeated SettingEntry entries = 5

• string icon_id = 6

  https://lucide.dev icon id for this page (Usually rendered left of the page name)

• optional string enabled_key = 7

  Key which makes this plugin "enabled" or "disabled"

Used in: SettingEntry

• string ui_name = 1

• string description = 2

• repeated string def = 3

• bool disabled = 4

Used in: SettingEntry

• string ui_name = 1

• string description = 2

• string def = 3

• StringSetting.InputType input_type = 10

• string placeholder = 6

• int32 min_length = 7

• int32 max_length = 8

• string pattern = 9

• bool disabled = 11

Used in: StringSetting

• TEXT = 0

• PASSWORD = 1

• EMAIL = 2

• SEARCH = 3

• TEL = 4

• URL = 5

• TEXTAREA = 6

Used in: UserListResponse

• string id = 1

• string username = 2

• UserRole role = 3

• string email = 4

• optional google.protobuf.Timestamp created_at = 5

• optional google.protobuf.Timestamp updated_at = 6

• optional google.protobuf.Timestamp last_login_at = 7

• optional google.protobuf.Timestamp min_issued_at = 8

Used in: ClientDataResponse, UpdateUserRequest, UserCreateRequest, UserInfoResponse, UserListResponse.User

• ADMIN = 0

• USER = 1