Syncthing

API: Internal/Beta

Table of Contents

1. Remote Procedure Calls
Name Description
retrieveConfiguration No description
resetConfiguration No description
restart No description
updateConfiguration No description
2. Data Models
Name Description
SyncthingConfig No description
SyncthingConfig.Device No description
SyncthingConfig.Folder No description
SyncthingConfig.OrchestratorInfo No description
IAppsResetConfigRequest No description
IAppsRestartRequest No description
IAppsRetrieveConfigRequest No description
IAppsUpdateConfigRequest No description
IAppsResetConfigResponse No description
IAppsRestartResponse No description
IAppsRetrieveConfigResponse No description
IAppsUpdateConfigResponse No description

Remote Procedure Calls

retrieveConfiguration

API: Internal/Beta Auth: Users

Request Response Error
IAppsRetrieveConfigRequest<SyncthingConfig> IAppsRetrieveConfigResponse<SyncthingConfig> CommonErrorMessage

resetConfiguration

API: Internal/Beta Auth: Users

Request Response Error
IAppsResetConfigRequest<SyncthingConfig> IAppsResetConfigResponse<SyncthingConfig> CommonErrorMessage

restart

API: Internal/Beta Auth: Users

Request Response Error
IAppsRestartRequest<SyncthingConfig> IAppsRestartResponse<SyncthingConfig> CommonErrorMessage

updateConfiguration

API: Internal/Beta Auth: Users

Request Response Error
IAppsUpdateConfigRequest<SyncthingConfig> IAppsUpdateConfigResponse<SyncthingConfig> CommonErrorMessage

Data Models

SyncthingConfig

API: Internal/Beta

data class SyncthingConfig(
    val folders: List<SyncthingConfig.Folder>,
    val devices: List<SyncthingConfig.Device>,
    val orchestratorInfo: SyncthingConfig.OrchestratorInfo?,
)
Properties
folders: List<SyncthingConfig.Folder>
devices: List<SyncthingConfig.Device>
orchestratorInfo: SyncthingConfig.OrchestratorInfo?

SyncthingConfig.Device

API: Internal/Beta

data class Device(
    val deviceId: String,
    val label: String,
)
Properties
deviceId: String
label: String

SyncthingConfig.Folder

API: Internal/Beta

data class Folder(
    val ucloudPath: String,
    val path: String?,
    val id: String?,
)
Properties
ucloudPath: String
path: String?
id: String?

SyncthingConfig.OrchestratorInfo

API: Internal/Beta

data class OrchestratorInfo(
    val folderPathToPermission: JsonObject,
)
Properties
folderPathToPermission: JsonObject

IAppsResetConfigRequest

API: Internal/Beta

data class IAppsResetConfigRequest<ConfigType>(
    val provider: String,
    val productId: String,
    val expectedETag: String?,
)
Properties
provider: String
productId: String
expectedETag: String?

IAppsRestartRequest

API: Internal/Beta

data class IAppsRestartRequest<ConfigType>(
    val provider: String,
    val productId: String,
)
Properties
provider: String
productId: String

IAppsRetrieveConfigRequest

API: Internal/Beta

data class IAppsRetrieveConfigRequest<ConfigType>(
    val provider: String,
    val productId: String,
)
Properties
provider: String
productId: String

IAppsUpdateConfigRequest

API: Internal/Beta

data class IAppsUpdateConfigRequest<ConfigType>(
    val provider: String,
    val productId: String,
    val config: ConfigType,
    val expectedETag: String?,
)
Properties
provider: String
productId: String
config: ConfigType
expectedETag: String?

IAppsResetConfigResponse

API: Internal/Beta

data class IAppsResetConfigResponse<ConfigType>(
)
Properties

IAppsRestartResponse

API: Internal/Beta

data class IAppsRestartResponse<ConfigType>(
)
Properties

IAppsRetrieveConfigResponse

API: Internal/Beta

data class IAppsRetrieveConfigResponse<ConfigType>(
    val etag: String,
    val config: ConfigType,
)
Properties
etag: String
config: ConfigType

IAppsUpdateConfigResponse

API: Internal/Beta

data class IAppsUpdateConfigResponse<ConfigType>(
)
Properties