openapi: 3.0.0 info: title: RetroShare OpenApi wrapper version: 0.0.1 description: RetroShare OpenApi wrapper generated using Doxygen documentation license: name: AGPLv3 servers: - url: http://127.0.0.1:9092/ paths: /rsGxsForums/createForum: post: operationId: RsGxsForumsCreateForum summary: Create forum. Blocking API. deprecated: false requestBody: description: > forum: ( RsGxsForumGroup)Forum data (name, description...) content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsForumsCreateForum' examples: ReqRsGxsForumsCreateForum: value: forum: ( RsGxsForumGroup)Forum data (name, description...) security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsForums/createMessage: post: operationId: RsGxsForumsCreateMessage summary: Create forum message. Blocking API. deprecated: false requestBody: description: > message: ( RsGxsForumMsg)None content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsForumsCreateMessage' examples: ReqRsGxsForumsCreateMessage: value: message: ( RsGxsForumMsg)None security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsForums/editForum: post: operationId: RsGxsForumsEditForum summary: Edit forum details. deprecated: false requestBody: description: > forum: ( RsGxsForumGroup)Forum data (name, description...) with modifications content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsForumsEditForum' examples: ReqRsGxsForumsEditForum: value: forum: ( RsGxsForumGroup)Forum data (name, description...) with modifications security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsForums/getForumContent: post: operationId: RsGxsForumsGetForumContent summary: Get specific list of messages from a single forums. Blocking API deprecated: false requestBody: description: > forumId: ( RsGxsGroupId)id of the forum of which the content is requested msgsIds: ( set)list of message ids to request content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsForumsGetForumContent' examples: ReqRsGxsForumsGetForumContent: value: forumId: ( RsGxsGroupId)id of the forum of which the content is requested msgsIds: ( set)list of message ids to request security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise msgs(vector)storage for the forum messages content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsForums/getForumMsgMetaData: post: operationId: RsGxsForumsGetForumMsgMetaData summary: Get message metadatas for a specific forum. Blocking API deprecated: false requestBody: description: > forumId: ( RsGxsGroupId)id of the forum of which the content is requested content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsForumsGetForumMsgMetaData' examples: ReqRsGxsForumsGetForumMsgMetaData: value: forumId: ( RsGxsGroupId)id of the forum of which the content is requested security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise msgMetas(vector)storage for the forum messages meta data content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsForums/getForumsInfo: post: operationId: RsGxsForumsGetForumsInfo summary: Get forums information (description, thumbnail...). Blocking API. deprecated: false requestBody: description: > forumIds: ( list)ids of the forums of which to get the informations content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsForumsGetForumsInfo' examples: ReqRsGxsForumsGetForumsInfo: value: forumIds: ( list)ids of the forums of which to get the informations security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise forumsInfo(vector)storage for the forums informations content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsForums/getForumsSummaries: post: operationId: RsGxsForumsGetForumsSummaries summary: Get forums summaries list. Blocking API. deprecated: false security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise forums(list)list where to store the forums summaries content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsForums/markRead: post: operationId: RsGxsForumsMarkRead summary: Toggle message read status. Blocking API. deprecated: false requestBody: description: > messageId: ( RsGxsGrpMsgIdPair)post identifier read: ( boolean)true to mark as read, false to mark as unread content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsForumsMarkRead' examples: ReqRsGxsForumsMarkRead: value: messageId: ( RsGxsGrpMsgIdPair)post identifier read: ( boolean)true to mark as read, false to mark as unread security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsForums/requestStatus: post: operationId: RsGxsForumsRequestStatus summary: deprecated: false requestBody: description: > token: ( integer)None content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsForumsRequestStatus' examples: ReqRsGxsForumsRequestStatus: value: token: ( integer)None security: - BasicAuth: [] responses: '200': description: > return: content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsForums/subscribeToForum: post: operationId: RsGxsForumsSubscribeToForum summary: Subscrbe to a forum. Blocking API deprecated: false requestBody: description: > forumId: ( RsGxsGroupId)Forum id subscribe: ( boolean)true to subscribe, false to unsubscribe content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsForumsSubscribeToForum' examples: ReqRsGxsForumsSubscribeToForum: value: forumId: ( RsGxsGroupId)Forum id subscribe: ( boolean)true to subscribe, false to unsubscribe security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsControl/isReady: post: operationId: RsControlIsReady summary: Check if core is fully ready, true only after deprecated: false security: - BasicAuth: [] responses: '200': description: > return: content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsControl/rsGlobalShutDown: post: operationId: RsControlRsGlobalShutDown summary: Turn off RetroShare deprecated: false security: - BasicAuth: [] responses: '200': description: > return: content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsReputations/autoPositiveOpinionForContacts: post: operationId: RsReputationsAutoPositiveOpinionForContacts summary: check if giving automatic positive opinion when flagging as contact is enbaled deprecated: false security: - BasicAuth: [] responses: '200': description: > return: true if enabled, false otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsReputations/banNode: post: operationId: RsReputationsBanNode summary: Enable automatic banning of all identities signed by the given node deprecated: false requestBody: description: > id: ( RsPgpId)PGP id of the node b: ( boolean)true to enable, false to disable content: application/json: schema: $ref: '#/components/schemas/ReqRsReputationsBanNode' examples: ReqRsReputationsBanNode: value: id: ( RsPgpId)PGP id of the node b: ( boolean)true to enable, false to disable security: - BasicAuth: [] responses: '200': description: > return: content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsReputations/getOwnOpinion: post: operationId: RsReputationsGetOwnOpinion summary: Get own opition about the given identity deprecated: false requestBody: description: > id: ( RsGxsId)Id of the identity content: application/json: schema: $ref: '#/components/schemas/ReqRsReputationsGetOwnOpinion' examples: ReqRsReputationsGetOwnOpinion: value: id: ( RsGxsId)Id of the identity security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise op(RsOpinion)Own opinion content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsReputations/getReputationInfo: post: operationId: RsReputationsGetReputationInfo summary: Get reputation data of given identity deprecated: false requestBody: description: > id: ( RsGxsId)Id of the identity ownerNode: ( RsPgpId)Optiona PGP id of the signed identity, accept a null (all zero/noninitialized) PGP id stamp: ( boolean)if true, timestamo the information content: application/json: schema: $ref: '#/components/schemas/ReqRsReputationsGetReputationInfo' examples: ReqRsReputationsGetReputationInfo: value: id: ( RsGxsId)Id of the identity ownerNode: ( RsPgpId)Optiona PGP id of the signed identity, accept a null (all zero/noninitialized) PGP id stamp: ( boolean)if true, timestamo the information security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise info(RsReputationInfo)storage for the information content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsReputations/isIdentityBanned: post: operationId: RsReputationsIsIdentityBanned summary: This method allow fast checking if a GXS identity is banned. deprecated: false requestBody: description: > id: ( RsGxsId)Id of the identity to check content: application/json: schema: $ref: '#/components/schemas/ReqRsReputationsIsIdentityBanned' examples: ReqRsReputationsIsIdentityBanned: value: id: ( RsGxsId)Id of the identity to check security: - BasicAuth: [] responses: '200': description: > return: true if identity is banned, false otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsReputations/isNodeBanned: post: operationId: RsReputationsIsNodeBanned summary: Check if automatic banning of all identities signed by the given node is enabled deprecated: false requestBody: description: > id: ( RsPgpId)PGP id of the node content: application/json: schema: $ref: '#/components/schemas/ReqRsReputationsIsNodeBanned' examples: ReqRsReputationsIsNodeBanned: value: id: ( RsPgpId)PGP id of the node security: - BasicAuth: [] responses: '200': description: > return: true if enabled, false otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsReputations/overallReputationLevel: post: operationId: RsReputationsOverallReputationLevel summary: Get overall reputation level of given identity deprecated: false requestBody: description: > id: ( RsGxsId)Id of the identity content: application/json: schema: $ref: '#/components/schemas/ReqRsReputationsOverallReputationLevel' examples: ReqRsReputationsOverallReputationLevel: value: id: ( RsGxsId)Id of the identity security: - BasicAuth: [] responses: '200': description: > return: the calculated reputation level based on available information content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsReputations/rememberBannedIdThreshold: post: operationId: RsReputationsRememberBannedIdThreshold summary: Get number of days to wait before deleting a banned identity from local storage deprecated: false security: - BasicAuth: [] responses: '200': description: > return: number of days to wait, 0 means never delete content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsReputations/setAutoPositiveOpinionForContacts: post: operationId: RsReputationsSetAutoPositiveOpinionForContacts summary: Enable giving automatic positive opinion when flagging as contact deprecated: false requestBody: description: > b: ( boolean)true to enable, false to disable content: application/json: schema: $ref: '#/components/schemas/ReqRsReputationsSetAutoPositiveOpinionForContacts' examples: ReqRsReputationsSetAutoPositiveOpinionForContacts: value: b: ( boolean)true to enable, false to disable security: - BasicAuth: [] responses: '200': description: > return: content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsReputations/setOwnOpinion: post: operationId: RsReputationsSetOwnOpinion summary: Set own opinion about the given identity deprecated: false requestBody: description: > id: ( RsGxsId)Id of the identity op: ( RsOpinion)Own opinion content: application/json: schema: $ref: '#/components/schemas/ReqRsReputationsSetOwnOpinion' examples: ReqRsReputationsSetOwnOpinion: value: id: ( RsGxsId)Id of the identity op: ( RsOpinion)Own opinion security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsReputations/setRememberBannedIdThreshold: post: operationId: RsReputationsSetRememberBannedIdThreshold summary: Set number of days to wait before deleting a banned identity from local storage deprecated: false requestBody: description: > days: ( integer)number of days to wait, 0 means never delete content: application/json: schema: $ref: '#/components/schemas/ReqRsReputationsSetRememberBannedIdThreshold' examples: ReqRsReputationsSetRememberBannedIdThreshold: value: days: ( integer)number of days to wait, 0 means never delete security: - BasicAuth: [] responses: '200': description: > return: content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsReputations/setThresholdForRemotelyNegativeReputation: post: operationId: RsReputationsSetThresholdForRemotelyNegativeReputation summary: Set threshold on remote reputation to consider it remotely negative deprecated: false requestBody: description: > thresh: ( integer)Threshold value content: application/json: schema: $ref: '#/components/schemas/ReqRsReputationsSetThresholdForRemotelyNegativeReputation' examples: ReqRsReputationsSetThresholdForRemotelyNegativeReputation: value: thresh: ( integer)Threshold value security: - BasicAuth: [] responses: '200': description: > return: content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsReputations/setThresholdForRemotelyPositiveReputation: post: operationId: RsReputationsSetThresholdForRemotelyPositiveReputation summary: Set threshold on remote reputation to consider it remotely positive deprecated: false requestBody: description: > thresh: ( integer)Threshold value content: application/json: schema: $ref: '#/components/schemas/ReqRsReputationsSetThresholdForRemotelyPositiveReputation' examples: ReqRsReputationsSetThresholdForRemotelyPositiveReputation: value: thresh: ( integer)Threshold value security: - BasicAuth: [] responses: '200': description: > return: content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsReputations/thresholdForRemotelyNegativeReputation: post: operationId: RsReputationsThresholdForRemotelyNegativeReputation summary: Get threshold on remote reputation to consider it remotely negative deprecated: false security: - BasicAuth: [] responses: '200': description: > return: Threshold value content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsReputations/thresholdForRemotelyPositiveReputation: post: operationId: RsReputationsThresholdForRemotelyPositiveReputation summary: Get threshold on remote reputation to consider it remotely negative deprecated: false security: - BasicAuth: [] responses: '200': description: > return: Threshold value content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsServiceControl/getOwnServices: post: operationId: RsServiceControlGetOwnServices summary: get a map off all services. deprecated: false security: - BasicAuth: [] responses: '200': description: > return: always true info(RsPeerServiceInfo)storage for service information content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsServiceControl/getPeersConnected: post: operationId: RsServiceControlGetPeersConnected summary: getPeersConnected return peers using a service. deprecated: false requestBody: description: > serviceId: ( integer)service to look up. content: application/json: schema: $ref: '#/components/schemas/ReqRsServiceControlGetPeersConnected' examples: ReqRsServiceControlGetPeersConnected: value: serviceId: ( integer)service to look up. security: - BasicAuth: [] responses: '200': description: > return: peerSet(set)set of peers using this service. content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsServiceControl/getServiceItemNames: post: operationId: RsServiceControlGetServiceItemNames summary: getServiceItemNames return a map of service item names. deprecated: false requestBody: description: > serviceId: ( integer)service to look up content: application/json: schema: $ref: '#/components/schemas/ReqRsServiceControlGetServiceItemNames' examples: ReqRsServiceControlGetServiceItemNames: value: serviceId: ( integer)service to look up security: - BasicAuth: [] responses: '200': description: > return: true on success false otherwise names(map)names of items content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsServiceControl/getServiceName: post: operationId: RsServiceControlGetServiceName summary: getServiceName lookup the name of a service. deprecated: false requestBody: description: > serviceId: ( integer)service to look up content: application/json: schema: $ref: '#/components/schemas/ReqRsServiceControlGetServiceName' examples: ReqRsServiceControlGetServiceName: value: serviceId: ( integer)service to look up security: - BasicAuth: [] responses: '200': description: > return: name of service content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsServiceControl/getServicePermissions: post: operationId: RsServiceControlGetServicePermissions summary: getServicePermissions return permissions of one service. deprecated: false requestBody: description: > serviceId: ( integer)service id to look up content: application/json: schema: $ref: '#/components/schemas/ReqRsServiceControlGetServicePermissions' examples: ReqRsServiceControlGetServicePermissions: value: serviceId: ( integer)service id to look up security: - BasicAuth: [] responses: '200': description: > return: true on success false otherwise. permissions(RsServicePermissions)None content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsServiceControl/getServicesAllowed: post: operationId: RsServiceControlGetServicesAllowed summary: getServicesAllowed return a mpa with allowed service information. deprecated: false requestBody: description: > peerId: ( RsPeerId)peer to look up content: application/json: schema: $ref: '#/components/schemas/ReqRsServiceControlGetServicesAllowed' examples: ReqRsServiceControlGetServicesAllowed: value: peerId: ( RsPeerId)peer to look up security: - BasicAuth: [] responses: '200': description: > return: always true info(RsPeerServiceInfo)map with infomration content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsServiceControl/getServicesProvided: post: operationId: RsServiceControlGetServicesProvided summary: getServicesProvided return services provided by a peer. deprecated: false requestBody: description: > peerId: ( RsPeerId)peer to look up content: application/json: schema: $ref: '#/components/schemas/ReqRsServiceControlGetServicesProvided' examples: ReqRsServiceControlGetServicesProvided: value: peerId: ( RsPeerId)peer to look up security: - BasicAuth: [] responses: '200': description: > return: true on success false otherwise. info(RsPeerServiceInfo)None content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsServiceControl/updateServicePermissions: post: operationId: RsServiceControlUpdateServicePermissions summary: updateServicePermissions update service permissions of one service. deprecated: false requestBody: description: > serviceId: ( integer)service to update permissions: ( RsServicePermissions)new permissions content: application/json: schema: $ref: '#/components/schemas/ReqRsServiceControlUpdateServicePermissions' examples: ReqRsServiceControlUpdateServicePermissions: value: serviceId: ( integer)service to update permissions: ( RsServicePermissions)new permissions security: - BasicAuth: [] responses: '200': description: > return: true on success false otherwise. content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /jsonApiServer/authorizeToken: post: operationId: JsonApiServerAuthorizeToken summary: Add new auth token to the authorized set deprecated: false requestBody: description: > token: ( string)toke to autorize decoded content: application/json: schema: $ref: '#/components/schemas/ReqJsonApiServerAuthorizeToken' examples: ReqJsonApiServerAuthorizeToken: value: token: ( string)toke to autorize decoded security: - BasicAuth: [] responses: '200': description: > return: true if the token has been added to authorized, false if error occurred or if the token was already authorized content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /jsonApiServer/decodeToken: post: operationId: JsonApiServerDecodeToken summary: Get decoded version of the given encoded token deprecated: false requestBody: description: > token: ( string)encoded content: application/json: schema: $ref: '#/components/schemas/ReqJsonApiServerDecodeToken' examples: ReqJsonApiServerDecodeToken: value: token: ( string)encoded responses: '200': description: > return: token decoded content: application/json: schema: type: string /jsonApiServer/encondeToken: post: operationId: JsonApiServerEncondeToken summary: Get encoded version of the given decoded token deprecated: false requestBody: description: > token: ( string)decoded content: application/json: schema: $ref: '#/components/schemas/ReqJsonApiServerEncondeToken' examples: ReqJsonApiServerEncondeToken: value: token: ( string)decoded responses: '200': description: > return: token encoded content: application/json: schema: type: string /jsonApiServer/getAuthorizedTokens: post: operationId: JsonApiServerGetAuthorizedTokens summary: Get uthorized tokens deprecated: false security: - BasicAuth: [] responses: '200': description: > return: the set of authorized encoded tokens content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /jsonApiServer/isAuthTokenValid: post: operationId: JsonApiServerIsAuthTokenValid summary: Check if given JSON API auth token is authorized deprecated: false requestBody: description: > token: ( string)decoded content: application/json: schema: $ref: '#/components/schemas/ReqJsonApiServerIsAuthTokenValid' examples: ReqJsonApiServerIsAuthTokenValid: value: token: ( string)decoded security: - BasicAuth: [] responses: '200': description: > return: tru if authorized, false otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /jsonApiServer/requestNewTokenAutorization: post: operationId: JsonApiServerRequestNewTokenAutorization summary: This function should be used by JSON API clients that aren't authenticated yet, to ask their token to be authorized, the success or failure will depend on mNewAccessRequestCallback return value, and it will likely need human user interaction in the process. deprecated: false requestBody: description: > token: ( string)token to autorize content: application/json: schema: $ref: '#/components/schemas/ReqJsonApiServerRequestNewTokenAutorization' examples: ReqJsonApiServerRequestNewTokenAutorization: value: token: ( string)token to autorize responses: '200': description: > return: true if authorization succeded, false otherwise. content: application/json: schema: type: string /jsonApiServer/revokeAuthToken: post: operationId: JsonApiServerRevokeAuthToken summary: Revoke given auth token deprecated: false requestBody: description: > token: ( string)decoded content: application/json: schema: $ref: '#/components/schemas/ReqJsonApiServerRevokeAuthToken' examples: ReqJsonApiServerRevokeAuthToken: value: token: ( string)decoded security: - BasicAuth: [] responses: '200': description: > return: true if the token has been revoked, false otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /jsonApiServer/version: post: operationId: JsonApiServerVersion summary: Write version information to given paramethers deprecated: false responses: '200': description: > return: major(integer)storage minor(integer)storage mini(integer)storage extra(string)storage human(string)storage content: application/json: schema: type: string /rsIdentity/autoAddFriendIdsAsContact: post: operationId: RsIdentityAutoAddFriendIdsAsContact summary: Check if automatic signed by friend identity contact flagging is enabled deprecated: false security: - BasicAuth: [] responses: '200': description: > return: true if enabled, false otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsIdentity/createIdentity: post: operationId: RsIdentityCreateIdentity summary: Create a new identity deprecated: false requestBody: description: > name: ( string)Name of the identity avatar: ( RsGxsImage)Image associated to the identity pseudonimous: ( boolean)true for unsigned identity, false otherwise pgpPassword: ( string)password to unlock PGP to sign identity, not implemented yet content: application/json: schema: $ref: '#/components/schemas/ReqRsIdentityCreateIdentity' examples: ReqRsIdentityCreateIdentity: value: name: ( string)Name of the identity avatar: ( RsGxsImage)Image associated to the identity pseudonimous: ( boolean)true for unsigned identity, false otherwise pgpPassword: ( string)password to unlock PGP to sign identity, not implemented yet security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise id(RsGxsId)storage for the created identity Id content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsIdentity/deleteBannedNodesThreshold: post: operationId: RsIdentityDeleteBannedNodesThreshold summary: Get number of days after which delete a banned identities deprecated: false security: - BasicAuth: [] responses: '200': description: > return: number of days content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsIdentity/deleteIdentity: post: operationId: RsIdentityDeleteIdentity summary: Locally delete given identity deprecated: false requestBody: description: > id: ( RsGxsId)Id of the identity content: application/json: schema: $ref: '#/components/schemas/ReqRsIdentityDeleteIdentity' examples: ReqRsIdentityDeleteIdentity: value: id: ( RsGxsId)Id of the identity security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsIdentity/getIdentitiesInfo: post: operationId: RsIdentityGetIdentitiesInfo summary: Get identities information (name, avatar...). Blocking API. deprecated: false requestBody: description: > ids: ( set)ids of the channels of which to get the informations content: application/json: schema: $ref: '#/components/schemas/ReqRsIdentityGetIdentitiesInfo' examples: ReqRsIdentityGetIdentitiesInfo: value: ids: ( set)ids of the channels of which to get the informations security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise idsInfo(vector)storage for the identities informations content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsIdentity/getIdentitiesSummaries: post: operationId: RsIdentityGetIdentitiesSummaries summary: Get identities summaries list. deprecated: false security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise ids(list)list where to store the identities content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsIdentity/getLastUsageTS: post: operationId: RsIdentityGetLastUsageTS summary: Get last seen usage time of given identity deprecated: false requestBody: description: > id: ( RsGxsId)Id of the identity content: application/json: schema: $ref: '#/components/schemas/ReqRsIdentityGetLastUsageTS' examples: ReqRsIdentityGetLastUsageTS: value: id: ( RsGxsId)Id of the identity security: - BasicAuth: [] responses: '200': description: > return: timestamp of last seen usage content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsIdentity/getOwnPseudonimousIds: post: operationId: RsIdentityGetOwnPseudonimousIds summary: Get own pseudonimous (unsigned) ids deprecated: false security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise ids(vector)storage for the ids content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsIdentity/getOwnSignedIds: post: operationId: RsIdentityGetOwnSignedIds summary: Get own signed ids deprecated: false security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise ids(vector)storage for the ids content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsIdentity/identityFromBase64: post: operationId: RsIdentityIdentityFromBase64 summary: Import identity from base64 representation deprecated: false requestBody: description: > base64String: ( string)base64 representation of the identity to import content: application/json: schema: $ref: '#/components/schemas/ReqRsIdentityIdentityFromBase64' examples: ReqRsIdentityIdentityFromBase64: value: base64String: ( string)base64 representation of the identity to import security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise id(RsGxsId)storage for the identity id content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsIdentity/identityToBase64: post: operationId: RsIdentityIdentityToBase64 summary: Get base64 representation of an identity deprecated: false requestBody: description: > id: ( RsGxsId)Id of the identity content: application/json: schema: $ref: '#/components/schemas/ReqRsIdentityIdentityToBase64' examples: ReqRsIdentityIdentityToBase64: value: id: ( RsGxsId)Id of the identity security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise base64String(string)storage for the identity base64 content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsIdentity/isARegularContact: post: operationId: RsIdentityIsARegularContact summary: Check if an identity is contact deprecated: false requestBody: description: > id: ( RsGxsId)Id of the identity content: application/json: schema: $ref: '#/components/schemas/ReqRsIdentityIsARegularContact' examples: ReqRsIdentityIsARegularContact: value: id: ( RsGxsId)Id of the identity security: - BasicAuth: [] responses: '200': description: > return: true if it is a conctact, false otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsIdentity/isOwnId: post: operationId: RsIdentityIsOwnId summary: Check if an id is own deprecated: false requestBody: description: > id: ( RsGxsId)Id to check content: application/json: schema: $ref: '#/components/schemas/ReqRsIdentityIsOwnId' examples: ReqRsIdentityIsOwnId: value: id: ( RsGxsId)Id to check security: - BasicAuth: [] responses: '200': description: > return: true if the id is own, false otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsIdentity/requestStatus: post: operationId: RsIdentityRequestStatus summary: deprecated: false requestBody: description: > token: ( integer)None content: application/json: schema: $ref: '#/components/schemas/ReqRsIdentityRequestStatus' examples: ReqRsIdentityRequestStatus: value: token: ( integer)None security: - BasicAuth: [] responses: '200': description: > return: content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsIdentity/setAutoAddFriendIdsAsContact: post: operationId: RsIdentitySetAutoAddFriendIdsAsContact summary: Toggle automatic flagging signed by friends identity as contact deprecated: false requestBody: description: > enabled: ( boolean)true to enable, false to disable content: application/json: schema: $ref: '#/components/schemas/ReqRsIdentitySetAutoAddFriendIdsAsContact' examples: ReqRsIdentitySetAutoAddFriendIdsAsContact: value: enabled: ( boolean)true to enable, false to disable security: - BasicAuth: [] responses: '200': description: > return: content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsIdentity/setDeleteBannedNodesThreshold: post: operationId: RsIdentitySetDeleteBannedNodesThreshold summary: Set number of days after which delete a banned identities deprecated: false requestBody: description: > days: ( integer)number of days content: application/json: schema: $ref: '#/components/schemas/ReqRsIdentitySetDeleteBannedNodesThreshold' examples: ReqRsIdentitySetDeleteBannedNodesThreshold: value: days: ( integer)number of days security: - BasicAuth: [] responses: '200': description: > return: content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsIdentity/updateIdentity: post: operationId: RsIdentityUpdateIdentity summary: Update identity data (name, avatar...) deprecated: false requestBody: description: > identityData: ( RsGxsIdGroup)updated identiy data content: application/json: schema: $ref: '#/components/schemas/ReqRsIdentityUpdateIdentity' examples: ReqRsIdentityUpdateIdentity: value: identityData: ( RsGxsIdGroup)updated identiy data security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGossipDiscovery/getDiscFriends: post: operationId: RsGossipDiscoveryGetDiscFriends summary: getDiscFriends get a list of all friends of a given friend deprecated: false requestBody: description: > id: ( RsPeerId)peer to get the friends of content: application/json: schema: $ref: '#/components/schemas/ReqRsGossipDiscoveryGetDiscFriends' examples: ReqRsGossipDiscoveryGetDiscFriends: value: id: ( RsPeerId)peer to get the friends of security: - BasicAuth: [] responses: '200': description: > return: true on success false otherwise friends(list)list of friends (ssl id) content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGossipDiscovery/getDiscPgpFriends: post: operationId: RsGossipDiscoveryGetDiscPgpFriends summary: getDiscPgpFriends get a list of all friends of a given friend deprecated: false requestBody: description: > pgpid: ( RsPgpId)peer to get the friends of content: application/json: schema: $ref: '#/components/schemas/ReqRsGossipDiscoveryGetDiscPgpFriends' examples: ReqRsGossipDiscoveryGetDiscPgpFriends: value: pgpid: ( RsPgpId)peer to get the friends of security: - BasicAuth: [] responses: '200': description: > return: true on success false otherwise gpg_friends(list)list of friends (gpg id) content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGossipDiscovery/getPeerVersion: post: operationId: RsGossipDiscoveryGetPeerVersion summary: getPeerVersion get the version string of a peer. deprecated: false requestBody: description: > id: ( RsPeerId)peer to get the version string of content: application/json: schema: $ref: '#/components/schemas/ReqRsGossipDiscoveryGetPeerVersion' examples: ReqRsGossipDiscoveryGetPeerVersion: value: id: ( RsPeerId)peer to get the version string of security: - BasicAuth: [] responses: '200': description: > return: true on success false otherwise version(string)version string sent by the peer content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGossipDiscovery/getWaitingDiscCount: post: operationId: RsGossipDiscoveryGetWaitingDiscCount summary: getWaitingDiscCount get the number of queued discovery packets. deprecated: false security: - BasicAuth: [] responses: '200': description: > return: true on success false otherwise sendCount(size_t)number of queued outgoing packets recvCount(size_t)number of queued incoming packets content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGossipDiscovery/requestInvite: post: operationId: RsGossipDiscoveryRequestInvite summary: Request RetroShare certificate to given peer deprecated: false requestBody: description: > inviteId: ( RsPeerId)id of the peer of which request the invite toSslId: ( RsPeerId)id of the destination of the request content: application/json: schema: $ref: '#/components/schemas/ReqRsGossipDiscoveryRequestInvite' examples: ReqRsGossipDiscoveryRequestInvite: value: inviteId: ( RsPeerId)id of the peer of which request the invite toSslId: ( RsPeerId)id of the destination of the request security: - BasicAuth: [] responses: '200': description: > return: true on success false otherwise errorMessage(string)Optional storage for the error message, meaningful only on failure. content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGossipDiscovery/sendInvite: post: operationId: RsGossipDiscoverySendInvite summary: Send RetroShare invite to given peer deprecated: false requestBody: description: > inviteId: ( RsPeerId)id of peer of which send the invite toSslId: ( RsPeerId)ssl id of the destination peer content: application/json: schema: $ref: '#/components/schemas/ReqRsGossipDiscoverySendInvite' examples: ReqRsGossipDiscoverySendInvite: value: inviteId: ( RsPeerId)id of peer of which send the invite toSslId: ( RsPeerId)ssl id of the destination peer security: - BasicAuth: [] responses: '200': description: > return: true on success false otherwise errorMessage(string)Optional storage for the error message, meaningful only on failure. content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsEvents/registerEventsHandler: post: operationId: RsEventsRegisterEventsHandler summary: This method is asynchronous. Register events handler Every time an event is dispatced the registered events handlers will get their method handleEvent called with the event passed as paramether. deprecated: false requestBody: description: > hId: ( RsEventsHandlerId_t)Optional storage for handler id, useful to eventually unregister the handler later. The value may be provided to the function call but must habe been generated with content: application/json: schema: $ref: '#/components/schemas/ReqRsEventsRegisterEventsHandler' examples: ReqRsEventsRegisterEventsHandler: value: hId: ( RsEventsHandlerId_t)Optional storage for handler id, useful to eventually unregister the handler later. The value may be provided to the function call but must habe been generated with security: - BasicAuth: [] responses: '200': description: > return: False on error, true otherwise. content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/acceptLobbyInvite: post: operationId: RsMsgsAcceptLobbyInvite summary: acceptLobbyInvite accept a chat invite deprecated: false requestBody: description: > id: ( ChatLobbyId)chat lobby id you were invited into and you want to join identity: ( RsGxsId)chat identity to use content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsAcceptLobbyInvite' examples: ReqRsMsgsAcceptLobbyInvite: value: id: ( ChatLobbyId)chat lobby id you were invited into and you want to join identity: ( RsGxsId)chat identity to use security: - BasicAuth: [] responses: '200': description: > return: true on success content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/clearChatLobby: post: operationId: RsMsgsClearChatLobby summary: clearChatLobby clear a chat lobby deprecated: false requestBody: description: > id: ( ChatId)chat lobby id to clear content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsClearChatLobby' examples: ReqRsMsgsClearChatLobby: value: id: ( ChatId)chat lobby id to clear security: - BasicAuth: [] responses: '200': description: > return: content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/createChatLobby: post: operationId: RsMsgsCreateChatLobby summary: createChatLobby create a new chat lobby deprecated: false requestBody: description: > lobby_name: ( string)lobby name lobby_identity: ( RsGxsId)chat id to use for new lobby lobby_topic: ( string)lobby toppic invited_friends: ( set)list of friends to invite lobby_privacy_type: ( ChatLobbyFlags)flag for new chat lobby content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsCreateChatLobby' examples: ReqRsMsgsCreateChatLobby: value: lobby_name: ( string)lobby name lobby_identity: ( RsGxsId)chat id to use for new lobby lobby_topic: ( string)lobby toppic invited_friends: ( set)list of friends to invite lobby_privacy_type: ( ChatLobbyFlags)flag for new chat lobby security: - BasicAuth: [] responses: '200': description: > return: chat id of new lobby content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/denyLobbyInvite: post: operationId: RsMsgsDenyLobbyInvite summary: denyLobbyInvite deny a chat lobby invite deprecated: false requestBody: description: > id: ( ChatLobbyId)chat lobby id you were invited into content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsDenyLobbyInvite' examples: ReqRsMsgsDenyLobbyInvite: value: id: ( ChatLobbyId)chat lobby id you were invited into security: - BasicAuth: [] responses: '200': description: > return: content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/getChatLobbyInfo: post: operationId: RsMsgsGetChatLobbyInfo summary: getChatLobbyInfo get lobby info of a subscribed chat lobby. Returns true if lobby id is valid. deprecated: false requestBody: description: > id: ( ChatLobbyId)id to get infos from content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsGetChatLobbyInfo' examples: ReqRsMsgsGetChatLobbyInfo: value: id: ( ChatLobbyId)id to get infos from security: - BasicAuth: [] responses: '200': description: > return: true on success info(ChatLobbyInfo)lobby infos content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/getChatLobbyList: post: operationId: RsMsgsGetChatLobbyList summary: getChatLobbyList get ids of subscribed lobbies deprecated: false security: - BasicAuth: [] responses: '200': description: > return: cl_list(list)lobby list content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/getCustomStateString: post: operationId: RsMsgsGetCustomStateString summary: getCustomStateString get the custom status message from a peer deprecated: false requestBody: description: > peer_id: ( RsPeerId)peer id to the peer you want to get the status message from content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsGetCustomStateString' examples: ReqRsMsgsGetCustomStateString: value: peer_id: ( RsPeerId)peer id to the peer you want to get the status message from security: - BasicAuth: [] responses: '200': description: > return: status message content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/getDefaultIdentityForChatLobby: post: operationId: RsMsgsGetDefaultIdentityForChatLobby summary: getDefaultIdentityForChatLobby get the default identity used for chat lobbies deprecated: false security: - BasicAuth: [] responses: '200': description: > return: id(RsGxsId)chat identitiy to use content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/getIdentityForChatLobby: post: operationId: RsMsgsGetIdentityForChatLobby summary: getIdentityForChatLobby deprecated: false requestBody: description: > lobby_id: ( ChatLobbyId)lobby to get the chat id from content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsGetIdentityForChatLobby' examples: ReqRsMsgsGetIdentityForChatLobby: value: lobby_id: ( ChatLobbyId)lobby to get the chat id from security: - BasicAuth: [] responses: '200': description: > return: true on success nick(RsGxsId)chat identity content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/getListOfNearbyChatLobbies: post: operationId: RsMsgsGetListOfNearbyChatLobbies summary: getListOfNearbyChatLobbies get info about all lobbies, subscribed and unsubscribed deprecated: false security: - BasicAuth: [] responses: '200': description: > return: public_lobbies(vector)list of all visible lobbies content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/getLobbyAutoSubscribe: post: operationId: RsMsgsGetLobbyAutoSubscribe summary: getLobbyAutoSubscribe get current value of auto subscribe deprecated: false requestBody: description: > lobby_id: ( ChatLobbyId)lobby to get value from content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsGetLobbyAutoSubscribe' examples: ReqRsMsgsGetLobbyAutoSubscribe: value: lobby_id: ( ChatLobbyId)lobby to get value from security: - BasicAuth: [] responses: '200': description: > return: wether lobby has auto subscribe enabled or disabled content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/getMaxMessageSecuritySize: post: operationId: RsMsgsGetMaxMessageSecuritySize summary: getMaxMessageSecuritySize get the maximum size of a chta message deprecated: false requestBody: description: > type: ( integer)chat type content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsGetMaxMessageSecuritySize' examples: ReqRsMsgsGetMaxMessageSecuritySize: value: type: ( integer)chat type security: - BasicAuth: [] responses: '200': description: > return: maximum size or zero for infinite content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/getMessage: post: operationId: RsMsgsGetMessage summary: getMessage deprecated: false requestBody: description: > msgId: ( string)message ID to lookup content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsGetMessage' examples: ReqRsMsgsGetMessage: value: msgId: ( string)message ID to lookup security: - BasicAuth: [] responses: '200': description: > return: true on success msg(Rs_Msgs_MessageInfo)None content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/getMessageCount: post: operationId: RsMsgsGetMessageCount summary: getMessageCount deprecated: false security: - BasicAuth: [] responses: '200': description: > return: nInbox(integer)None nInboxNew(integer)None nOutbox(integer)None nDraftbox(integer)None nSentbox(integer)None nTrashbox(integer)None content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/getMessageSummaries: post: operationId: RsMsgsGetMessageSummaries summary: getMessageSummaries deprecated: false security: - BasicAuth: [] responses: '200': description: > return: always true msgList(list)None content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/getMessageTag: post: operationId: RsMsgsGetMessageTag summary: getMessageTag deprecated: false requestBody: description: > msgId: ( string)None content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsGetMessageTag' examples: ReqRsMsgsGetMessageTag: value: msgId: ( string)None security: - BasicAuth: [] responses: '200': description: > return: true on success info(Rs_Msgs_MsgTagInfo)None content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/getMessageTagTypes: post: operationId: RsMsgsGetMessageTagTypes summary: getMessageTagTypes deprecated: false security: - BasicAuth: [] responses: '200': description: > return: always true tags(Rs_Msgs_MsgTagType)None content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/getMsgParentId: post: operationId: RsMsgsGetMsgParentId summary: getMsgParentId deprecated: false requestBody: description: > msgId: ( string)None content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsGetMsgParentId' examples: ReqRsMsgsGetMsgParentId: value: msgId: ( string)None security: - BasicAuth: [] responses: '200': description: > return: true on success msgParentId(string)None content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/getPendingChatLobbyInvites: post: operationId: RsMsgsGetPendingChatLobbyInvites summary: getPendingChatLobbyInvites get a list of all pending chat lobby invites deprecated: false security: - BasicAuth: [] responses: '200': description: > return: invites(list)list of all pending chat lobby invites content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/invitePeerToLobby: post: operationId: RsMsgsInvitePeerToLobby summary: invitePeerToLobby invite a peer to join a lobby deprecated: false requestBody: description: > lobby_id: ( ChatLobbyId)lobby it to invite into peer_id: ( RsPeerId)peer to invite content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsInvitePeerToLobby' examples: ReqRsMsgsInvitePeerToLobby: value: lobby_id: ( ChatLobbyId)lobby it to invite into peer_id: ( RsPeerId)peer to invite security: - BasicAuth: [] responses: '200': description: > return: content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/joinVisibleChatLobby: post: operationId: RsMsgsJoinVisibleChatLobby summary: joinVisibleChatLobby join a lobby that is visible deprecated: false requestBody: description: > lobby_id: ( ChatLobbyId)lobby to join to own_id: ( RsGxsId)chat id to use content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsJoinVisibleChatLobby' examples: ReqRsMsgsJoinVisibleChatLobby: value: lobby_id: ( ChatLobbyId)lobby to join to own_id: ( RsGxsId)chat id to use security: - BasicAuth: [] responses: '200': description: > return: true on success content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/MessageDelete: post: operationId: RsMsgsMessageDelete summary: MessageDelete deprecated: false requestBody: description: > msgId: ( string)None content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsMessageDelete' examples: ReqRsMsgsMessageDelete: value: msgId: ( string)None security: - BasicAuth: [] responses: '200': description: > return: true on success content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/MessageForwarded: post: operationId: RsMsgsMessageForwarded summary: MessageForwarded deprecated: false requestBody: description: > msgId: ( string)None forwarded: ( boolean)None content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsMessageForwarded' examples: ReqRsMsgsMessageForwarded: value: msgId: ( string)None forwarded: ( boolean)None security: - BasicAuth: [] responses: '200': description: > return: true on success content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/MessageLoadEmbeddedImages: post: operationId: RsMsgsMessageLoadEmbeddedImages summary: MessageLoadEmbeddedImages deprecated: false requestBody: description: > msgId: ( string)None load: ( boolean)None content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsMessageLoadEmbeddedImages' examples: ReqRsMsgsMessageLoadEmbeddedImages: value: msgId: ( string)None load: ( boolean)None security: - BasicAuth: [] responses: '200': description: > return: true on success content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/MessageRead: post: operationId: RsMsgsMessageRead summary: MessageRead deprecated: false requestBody: description: > msgId: ( string)None unreadByUser: ( boolean)None content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsMessageRead' examples: ReqRsMsgsMessageRead: value: msgId: ( string)None unreadByUser: ( boolean)None security: - BasicAuth: [] responses: '200': description: > return: true on success content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/MessageReplied: post: operationId: RsMsgsMessageReplied summary: MessageReplied deprecated: false requestBody: description: > msgId: ( string)None replied: ( boolean)None content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsMessageReplied' examples: ReqRsMsgsMessageReplied: value: msgId: ( string)None replied: ( boolean)None security: - BasicAuth: [] responses: '200': description: > return: true on success content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/MessageSend: post: operationId: RsMsgsMessageSend summary: MessageSend deprecated: false requestBody: description: > info: ( Rs_Msgs_MessageInfo)None content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsMessageSend' examples: ReqRsMsgsMessageSend: value: info: ( Rs_Msgs_MessageInfo)None security: - BasicAuth: [] responses: '200': description: > return: always true content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/MessageStar: post: operationId: RsMsgsMessageStar summary: MessageStar deprecated: false requestBody: description: > msgId: ( string)None mark: ( boolean)None content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsMessageStar' examples: ReqRsMsgsMessageStar: value: msgId: ( string)None mark: ( boolean)None security: - BasicAuth: [] responses: '200': description: > return: true on success content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/MessageToDraft: post: operationId: RsMsgsMessageToDraft summary: MessageToDraft deprecated: false requestBody: description: > info: ( Rs_Msgs_MessageInfo)None msgParentId: ( string)None content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsMessageToDraft' examples: ReqRsMsgsMessageToDraft: value: info: ( Rs_Msgs_MessageInfo)None msgParentId: ( string)None security: - BasicAuth: [] responses: '200': description: > return: true on success content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/MessageToTrash: post: operationId: RsMsgsMessageToTrash summary: MessageToTrash deprecated: false requestBody: description: > msgId: ( string)Id of the message to mode to trash box bTrash: ( boolean)Move to trash if true, otherwise remove from trash content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsMessageToTrash' examples: ReqRsMsgsMessageToTrash: value: msgId: ( string)Id of the message to mode to trash box bTrash: ( boolean)Move to trash if true, otherwise remove from trash security: - BasicAuth: [] responses: '200': description: > return: true on success content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/removeMessageTagType: post: operationId: RsMsgsRemoveMessageTagType summary: removeMessageTagType deprecated: false requestBody: description: > tagId: ( integer)None content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsRemoveMessageTagType' examples: ReqRsMsgsRemoveMessageTagType: value: tagId: ( integer)None security: - BasicAuth: [] responses: '200': description: > return: true on success content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/resetMessageStandardTagTypes: post: operationId: RsMsgsResetMessageStandardTagTypes summary: resetMessageStandardTagTypes deprecated: false security: - BasicAuth: [] responses: '200': description: > return: always true tags(Rs_Msgs_MsgTagType)None content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/sendChat: post: operationId: RsMsgsSendChat summary: sendChat send a chat message to a given id deprecated: false requestBody: description: > id: ( ChatId)id to send the message msg: ( string)message to send content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsSendChat' examples: ReqRsMsgsSendChat: value: id: ( ChatId)id to send the message msg: ( string)message to send security: - BasicAuth: [] responses: '200': description: > return: true on success content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/sendLobbyStatusPeerLeaving: post: operationId: RsMsgsSendLobbyStatusPeerLeaving summary: sendLobbyStatusPeerLeaving notify friend nodes that we're leaving a subscribed lobby deprecated: false requestBody: description: > lobby_id: ( ChatLobbyId)lobby to leave content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsSendLobbyStatusPeerLeaving' examples: ReqRsMsgsSendLobbyStatusPeerLeaving: value: lobby_id: ( ChatLobbyId)lobby to leave security: - BasicAuth: [] responses: '200': description: > return: content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/sendStatusString: post: operationId: RsMsgsSendStatusString summary: sendStatusString send a status string deprecated: false requestBody: description: > id: ( ChatId)chat id to send the status string to status_string: ( string)status string content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsSendStatusString' examples: ReqRsMsgsSendStatusString: value: id: ( ChatId)chat id to send the status string to status_string: ( string)status string security: - BasicAuth: [] responses: '200': description: > return: content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/setCustomStateString: post: operationId: RsMsgsSetCustomStateString summary: setCustomStateString set your custom status message deprecated: false requestBody: description: > status_string: ( string)status message content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsSetCustomStateString' examples: ReqRsMsgsSetCustomStateString: value: status_string: ( string)status message security: - BasicAuth: [] responses: '200': description: > return: content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/setDefaultIdentityForChatLobby: post: operationId: RsMsgsSetDefaultIdentityForChatLobby summary: setDefaultIdentityForChatLobby set the default identity used for chat lobbies deprecated: false requestBody: description: > nick: ( RsGxsId)chat identitiy to use content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsSetDefaultIdentityForChatLobby' examples: ReqRsMsgsSetDefaultIdentityForChatLobby: value: nick: ( RsGxsId)chat identitiy to use security: - BasicAuth: [] responses: '200': description: > return: true on success content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/setIdentityForChatLobby: post: operationId: RsMsgsSetIdentityForChatLobby summary: setIdentityForChatLobby set the chat identit deprecated: false requestBody: description: > lobby_id: ( ChatLobbyId)lobby to change the chat idnetity for nick: ( RsGxsId)new chat identity content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsSetIdentityForChatLobby' examples: ReqRsMsgsSetIdentityForChatLobby: value: lobby_id: ( ChatLobbyId)lobby to change the chat idnetity for nick: ( RsGxsId)new chat identity security: - BasicAuth: [] responses: '200': description: > return: true on success content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/setLobbyAutoSubscribe: post: operationId: RsMsgsSetLobbyAutoSubscribe summary: setLobbyAutoSubscribe enable or disable auto subscribe for a chat lobby deprecated: false requestBody: description: > lobby_id: ( ChatLobbyId)lobby to auto (un)subscribe autoSubscribe: ( boolean)set value for auto subscribe content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsSetLobbyAutoSubscribe' examples: ReqRsMsgsSetLobbyAutoSubscribe: value: lobby_id: ( ChatLobbyId)lobby to auto (un)subscribe autoSubscribe: ( boolean)set value for auto subscribe security: - BasicAuth: [] responses: '200': description: > return: content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/setMessageTag: post: operationId: RsMsgsSetMessageTag summary: setMessageTag set == false && tagId == 0 deprecated: false requestBody: description: > msgId: ( string)None tagId: ( integer)None set: ( boolean)None content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsSetMessageTag' examples: ReqRsMsgsSetMessageTag: value: msgId: ( string)None tagId: ( integer)None set: ( boolean)None security: - BasicAuth: [] responses: '200': description: > return: true on success content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/setMessageTagType: post: operationId: RsMsgsSetMessageTagType summary: setMessageTagType deprecated: false requestBody: description: > tagId: ( integer)None text: ( string)None rgb_color: ( integer)None content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsSetMessageTagType' examples: ReqRsMsgsSetMessageTagType: value: tagId: ( integer)None text: ( string)None rgb_color: ( integer)None security: - BasicAuth: [] responses: '200': description: > return: true on success content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/SystemMessage: post: operationId: RsMsgsSystemMessage summary: SystemMessage deprecated: false requestBody: description: > title: ( string)None message: ( string)None systemFlag: ( integer)None content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsSystemMessage' examples: ReqRsMsgsSystemMessage: value: title: ( string)None message: ( string)None systemFlag: ( integer)None security: - BasicAuth: [] responses: '200': description: > return: true on success content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsMsgs/unsubscribeChatLobby: post: operationId: RsMsgsUnsubscribeChatLobby summary: unsubscribeChatLobby leave a chat lobby deprecated: false requestBody: description: > lobby_id: ( ChatLobbyId)lobby to leave content: application/json: schema: $ref: '#/components/schemas/ReqRsMsgsUnsubscribeChatLobby' examples: ReqRsMsgsUnsubscribeChatLobby: value: lobby_id: ( ChatLobbyId)lobby to leave security: - BasicAuth: [] responses: '200': description: > return: content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsBanList/enableIPFiltering: post: operationId: RsBanListEnableIPFiltering summary: Enable or disable IP filtering service deprecated: false requestBody: description: > enable: ( boolean)pass true to enable, false to disable content: application/json: schema: $ref: '#/components/schemas/ReqRsBanListEnableIPFiltering' examples: ReqRsBanListEnableIPFiltering: value: enable: ( boolean)pass true to enable, false to disable security: - BasicAuth: [] responses: '200': description: > return: content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsBanList/ipFilteringEnabled: post: operationId: RsBanListIpFilteringEnabled summary: Get ip filtering service status deprecated: false security: - BasicAuth: [] responses: '200': description: > return: true if enabled, false if disabled content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsCircles/cancelCircleMembership: post: operationId: RsGxsCirclesCancelCircleMembership summary: Leave given circle deprecated: false requestBody: description: > ownGxsId: ( RsGxsId)Own id to remove from the circle circleId: ( RsGxsCircleId)Id of the circle to leave content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsCirclesCancelCircleMembership' examples: ReqRsGxsCirclesCancelCircleMembership: value: ownGxsId: ( RsGxsId)Own id to remove from the circle circleId: ( RsGxsCircleId)Id of the circle to leave security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsCircles/createCircle: post: operationId: RsGxsCirclesCreateCircle summary: Create new circle deprecated: false requestBody: description: > cData: ( RsGxsCircleGroup)input name and flags of the circle, storage for generated circle data id etc. content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsCirclesCreateCircle' examples: ReqRsGxsCirclesCreateCircle: value: cData: ( RsGxsCircleGroup)input name and flags of the circle, storage for generated circle data id etc. security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsCircles/editCircle: post: operationId: RsGxsCirclesEditCircle summary: Edit own existing circle deprecated: false requestBody: description: > cData: ( RsGxsCircleGroup)Circle data with modifications, storage for data updatedad during the operation. content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsCirclesEditCircle' examples: ReqRsGxsCirclesEditCircle: value: cData: ( RsGxsCircleGroup)Circle data with modifications, storage for data updatedad during the operation. security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsCircles/getCircleDetails: post: operationId: RsGxsCirclesGetCircleDetails summary: Get circle details. Memory cached deprecated: false requestBody: description: > id: ( RsGxsCircleId)Id of the circle content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsCirclesGetCircleDetails' examples: ReqRsGxsCirclesGetCircleDetails: value: id: ( RsGxsCircleId)Id of the circle security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise details(RsGxsCircleDetails)Storage for the circle details content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsCircles/getCircleExternalIdList: post: operationId: RsGxsCirclesGetCircleExternalIdList summary: Get list of known external circles ids. Memory cached deprecated: false requestBody: description: > circleIds: ( list)Storage for circles id list content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsCirclesGetCircleExternalIdList' examples: ReqRsGxsCirclesGetCircleExternalIdList: value: circleIds: ( list)Storage for circles id list security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsCircles/getCircleRequests: post: operationId: RsGxsCirclesGetCircleRequests summary: Get circle requests deprecated: false requestBody: description: > circleId: ( RsGxsGroupId)id of the circle of which the requests are requested content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsCirclesGetCircleRequests' examples: ReqRsGxsCirclesGetCircleRequests: value: circleId: ( RsGxsGroupId)id of the circle of which the requests are requested security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise requests(vector)storage for the circle requests content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsCircles/getCirclesInfo: post: operationId: RsGxsCirclesGetCirclesInfo summary: Get circles information deprecated: false requestBody: description: > circlesIds: ( list)ids of the circles of which to get the informations content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsCirclesGetCirclesInfo' examples: ReqRsGxsCirclesGetCirclesInfo: value: circlesIds: ( list)ids of the circles of which to get the informations security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise circlesInfo(vector)storage for the circles informations content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsCircles/getCirclesSummaries: post: operationId: RsGxsCirclesGetCirclesSummaries summary: Get circles summaries list. deprecated: false security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise circles(list)list where to store the circles summaries content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsCircles/inviteIdsToCircle: post: operationId: RsGxsCirclesInviteIdsToCircle summary: Invite identities to circle deprecated: false requestBody: description: > identities: ( set)ids of the identities to invite circleId: ( RsGxsCircleId)Id of the circle you own and want to invite ids in content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsCirclesInviteIdsToCircle' examples: ReqRsGxsCirclesInviteIdsToCircle: value: identities: ( set)ids of the identities to invite circleId: ( RsGxsCircleId)Id of the circle you own and want to invite ids in security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsCircles/requestCircleMembership: post: operationId: RsGxsCirclesRequestCircleMembership summary: Request circle membership, or accept circle invitation deprecated: false requestBody: description: > ownGxsId: ( RsGxsId)Id of own identity to introduce to the circle circleId: ( RsGxsCircleId)Id of the circle to which ask for inclusion content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsCirclesRequestCircleMembership' examples: ReqRsGxsCirclesRequestCircleMembership: value: ownGxsId: ( RsGxsId)Id of own identity to introduce to the circle circleId: ( RsGxsCircleId)Id of the circle to which ask for inclusion security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsCircles/requestStatus: post: operationId: RsGxsCirclesRequestStatus summary: deprecated: false requestBody: description: > token: ( integer)None content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsCirclesRequestStatus' examples: ReqRsGxsCirclesRequestStatus: value: token: ( integer)None security: - BasicAuth: [] responses: '200': description: > return: content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsChannels/createChannel: post: operationId: RsGxsChannelsCreateChannel summary: Deprecated{ substituted by createChannelV2 } deprecated: false requestBody: description: > channel: ( RsGxsChannelGroup)Channel data (name, description...) content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsChannelsCreateChannel' examples: ReqRsGxsChannelsCreateChannel: value: channel: ( RsGxsChannelGroup)Channel data (name, description...) security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsChannels/createChannelV2: post: operationId: RsGxsChannelsCreateChannelV2 summary: Create channel. Blocking API. deprecated: false requestBody: description: > name: ( string)Name of the channel description: ( string)Description of the channel thumbnail: ( RsGxsImage)Optional image to show as channel thumbnail. authorId: ( RsGxsId)Optional id of the author. Leave empty for an anonymous channel. circleType: ( RsGxsCircleType)Optional visibility rule, default public. circleId: ( RsGxsCircleId)If the channel is not public specify the id of the circle who can see the channel. Depending on the value you pass for circleType this should be be an external circle if EXTERNAL is passed, a local friend group id if NODES_GROUP is passed, empty otherwise. content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsChannelsCreateChannelV2' examples: ReqRsGxsChannelsCreateChannelV2: value: name: ( string)Name of the channel description: ( string)Description of the channel thumbnail: ( RsGxsImage)Optional image to show as channel thumbnail. authorId: ( RsGxsId)Optional id of the author. Leave empty for an anonymous channel. circleType: ( RsGxsCircleType)Optional visibility rule, default public. circleId: ( RsGxsCircleId)If the channel is not public specify the id of the circle who can see the channel. Depending on the value you pass for circleType this should be be an external circle if EXTERNAL is passed, a local friend group id if NODES_GROUP is passed, empty otherwise. security: - BasicAuth: [] responses: '200': description: > return: False on error, true otherwise. channelId(RsGxsGroupId)Optional storage for the id of the created channel, meaningful only if creations succeeds. errorMessage(string)Optional storage for error messsage, meaningful only if creation fail. content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsChannels/createComment: post: operationId: RsGxsChannelsCreateComment summary: Deprecated deprecated: true requestBody: description: > comment: ( RsGxsComment)None content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsChannelsCreateComment' examples: ReqRsGxsChannelsCreateComment: value: comment: ( RsGxsComment)None security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsChannels/createCommentV2: post: operationId: RsGxsChannelsCreateCommentV2 summary: Add a comment on a post or on another comment. Blocking API. deprecated: false requestBody: description: > channelId: ( RsGxsGroupId)Id of the channel in which the comment is to be posted threadId: ( RsGxsMessageId)Id of the post (that is a thread) in the channel where the comment is placed parentId: ( RsGxsMessageId)Id of the parent of the comment that is either a channel post Id or the Id of another comment. authorId: ( RsGxsId)Id of the author of the comment comment: ( string)UTF-8 string containing the comment itself content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsChannelsCreateCommentV2' examples: ReqRsGxsChannelsCreateCommentV2: value: channelId: ( RsGxsGroupId)Id of the channel in which the comment is to be posted threadId: ( RsGxsMessageId)Id of the post (that is a thread) in the channel where the comment is placed parentId: ( RsGxsMessageId)Id of the parent of the comment that is either a channel post Id or the Id of another comment. authorId: ( RsGxsId)Id of the author of the comment comment: ( string)UTF-8 string containing the comment itself security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise commentMessageId(RsGxsMessageId)Optional storage for the id of the comment that was created, meaningful only on success. errorMessage(string)Optional storage for error message, meaningful only on failure. content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsChannels/createPost: post: operationId: RsGxsChannelsCreatePost summary: Deprecated deprecated: true requestBody: description: > post: ( RsGxsChannelPost)None content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsChannelsCreatePost' examples: ReqRsGxsChannelsCreatePost: value: post: ( RsGxsChannelPost)None security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsChannels/createPostV2: post: operationId: RsGxsChannelsCreatePostV2 summary: Create channel post. Blocking API. deprecated: false requestBody: description: > channelId: ( RsGxsGroupId)Id of the channel where to put the post. Beware you need publish rights on that channel to post. title: ( string)Title of the post mBody: ( string)Text content of the post files: ( list)Optional list of attached files. These are supposed to be already shared, thumbnail: ( RsGxsImage)Optional thumbnail image for the post. origPostId: ( RsGxsMessageId)If this is supposed to replace an already existent post, the id of the old post. If left blank a new post will be created. content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsChannelsCreatePostV2' examples: ReqRsGxsChannelsCreatePostV2: value: channelId: ( RsGxsGroupId)Id of the channel where to put the post. Beware you need publish rights on that channel to post. title: ( string)Title of the post mBody: ( string)Text content of the post files: ( list)Optional list of attached files. These are supposed to be already shared, thumbnail: ( RsGxsImage)Optional thumbnail image for the post. origPostId: ( RsGxsMessageId)If this is supposed to replace an already existent post, the id of the old post. If left blank a new post will be created. security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise postId(RsGxsMessageId)Optional storage for the id of the created post, meaningful only on success. errorMessage(string)Optional storage for the error message, meaningful only on failure. content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsChannels/createVote: post: operationId: RsGxsChannelsCreateVote summary: Deprecated deprecated: true requestBody: description: > vote: ( RsGxsVote)None content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsChannelsCreateVote' examples: ReqRsGxsChannelsCreateVote: value: vote: ( RsGxsVote)None security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsChannels/createVoteV2: post: operationId: RsGxsChannelsCreateVoteV2 summary: Create a vote deprecated: false requestBody: description: > channelId: ( RsGxsGroupId)Id of the channel where to vote postId: ( RsGxsMessageId)Id of the channel post of which a comment is voted. commentId: ( RsGxsMessageId)Id of the comment that is voted authorId: ( RsGxsId)Id of the author. Needs to be of an owned identity. vote: ( RsGxsVoteType)Vote value, either content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsChannelsCreateVoteV2' examples: ReqRsGxsChannelsCreateVoteV2: value: channelId: ( RsGxsGroupId)Id of the channel where to vote postId: ( RsGxsMessageId)Id of the channel post of which a comment is voted. commentId: ( RsGxsMessageId)Id of the comment that is voted authorId: ( RsGxsId)Id of the author. Needs to be of an owned identity. vote: ( RsGxsVoteType)Vote value, either security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise voteId(RsGxsMessageId)Optional storage for the id of the created vote, meaningful only on success. errorMessage(string)Optional storage for error message, meaningful only on failure. content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsChannels/editChannel: post: operationId: RsGxsChannelsEditChannel summary: Edit channel details. deprecated: false requestBody: description: > channel: ( RsGxsChannelGroup)Channel data (name, description...) with modifications content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsChannelsEditChannel' examples: ReqRsGxsChannelsEditChannel: value: channel: ( RsGxsChannelGroup)Channel data (name, description...) with modifications security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsChannels/ExtraFileHash: post: operationId: RsGxsChannelsExtraFileHash summary: Share extra file Can be used to share extra file attached to a channel post deprecated: false requestBody: description: > path: ( string)file path content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsChannelsExtraFileHash' examples: ReqRsGxsChannelsExtraFileHash: value: path: ( string)file path security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsChannels/ExtraFileRemove: post: operationId: RsGxsChannelsExtraFileRemove summary: Remove extra file from shared files deprecated: false requestBody: description: > hash: ( RsFileHash)hash of the file to remove content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsChannelsExtraFileRemove' examples: ReqRsGxsChannelsExtraFileRemove: value: hash: ( RsFileHash)hash of the file to remove security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsChannels/getChannelAutoDownload: post: operationId: RsGxsChannelsGetChannelAutoDownload summary: Get auto-download option value for given channel deprecated: false requestBody: description: > channelId: ( RsGxsGroupId)channel id content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsChannelsGetChannelAutoDownload' examples: ReqRsGxsChannelsGetChannelAutoDownload: value: channelId: ( RsGxsGroupId)channel id security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise enabled(boolean)storage for the auto-download option value content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsChannels/getChannelContent: post: operationId: RsGxsChannelsGetChannelContent summary: Get channel contents deprecated: false requestBody: description: > channelId: ( RsGxsGroupId)id of the channel of which the content is requested contentsIds: ( set)ids of requested contents content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsChannelsGetChannelContent' examples: ReqRsGxsChannelsGetChannelContent: value: channelId: ( RsGxsGroupId)id of the channel of which the content is requested contentsIds: ( set)ids of requested contents security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise posts(vector)storage for posts comments(vector)storage for the comments content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsChannels/getChannelDownloadDirectory: post: operationId: RsGxsChannelsGetChannelDownloadDirectory summary: Get download directory for the given channel deprecated: false requestBody: description: > channelId: ( RsGxsGroupId)id of the channel content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsChannelsGetChannelDownloadDirectory' examples: ReqRsGxsChannelsGetChannelDownloadDirectory: value: channelId: ( RsGxsGroupId)id of the channel security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise directory(string)reference to string where to store the path content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsChannels/getChannelsInfo: post: operationId: RsGxsChannelsGetChannelsInfo summary: Get channels information (description, thumbnail...). Blocking API. deprecated: false requestBody: description: > chanIds: ( list)ids of the channels of which to get the informations content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsChannelsGetChannelsInfo' examples: ReqRsGxsChannelsGetChannelsInfo: value: chanIds: ( list)ids of the channels of which to get the informations security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise channelsInfo(vector)storage for the channels informations content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsChannels/getChannelsSummaries: post: operationId: RsGxsChannelsGetChannelsSummaries summary: Get channels summaries list. Blocking API. deprecated: false security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise channels(list)list where to store the channels content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsChannels/getContentSummaries: post: operationId: RsGxsChannelsGetContentSummaries summary: Get channel content summaries deprecated: false requestBody: description: > channelId: ( RsGxsGroupId)id of the channel of which the content is requested content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsChannelsGetContentSummaries' examples: ReqRsGxsChannelsGetContentSummaries: value: channelId: ( RsGxsGroupId)id of the channel of which the content is requested security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise summaries(vector)storage for summaries content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsChannels/localSearchRequest: post: operationId: RsGxsChannelsLocalSearchRequest summary: This method is asynchronous. Search local channels deprecated: false requestBody: description: > matchString: ( string)string to look for in the search maxWait: ( rstime_t)maximum wait time in seconds for search results content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsChannelsLocalSearchRequest' examples: ReqRsGxsChannelsLocalSearchRequest: value: matchString: ( string)string to look for in the search maxWait: ( rstime_t)maximum wait time in seconds for search results security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsChannels/markRead: post: operationId: RsGxsChannelsMarkRead summary: Toggle post read status. Blocking API. deprecated: false requestBody: description: > postId: ( RsGxsGrpMsgIdPair)post identifier read: ( boolean)true to mark as read, false to mark as unread content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsChannelsMarkRead' examples: ReqRsGxsChannelsMarkRead: value: postId: ( RsGxsGrpMsgIdPair)post identifier read: ( boolean)true to mark as read, false to mark as unread security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsChannels/requestStatus: post: operationId: RsGxsChannelsRequestStatus summary: deprecated: false requestBody: description: > token: ( integer)None content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsChannelsRequestStatus' examples: ReqRsGxsChannelsRequestStatus: value: token: ( integer)None security: - BasicAuth: [] responses: '200': description: > return: content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsChannels/setChannelAutoDownload: post: operationId: RsGxsChannelsSetChannelAutoDownload summary: Enable or disable auto-download for given channel. Blocking API deprecated: false requestBody: description: > channelId: ( RsGxsGroupId)channel id enable: ( boolean)true to enable, false to disable content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsChannelsSetChannelAutoDownload' examples: ReqRsGxsChannelsSetChannelAutoDownload: value: channelId: ( RsGxsGroupId)channel id enable: ( boolean)true to enable, false to disable security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsChannels/setChannelDownloadDirectory: post: operationId: RsGxsChannelsSetChannelDownloadDirectory summary: Set download directory for the given channel. Blocking API. deprecated: false requestBody: description: > channelId: ( RsGxsGroupId)id of the channel directory: ( string)path content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsChannelsSetChannelDownloadDirectory' examples: ReqRsGxsChannelsSetChannelDownloadDirectory: value: channelId: ( RsGxsGroupId)id of the channel directory: ( string)path security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsChannels/shareChannelKeys: post: operationId: RsGxsChannelsShareChannelKeys summary: Share channel publishing key This can be used to authorize other peers to post on the channel deprecated: false requestBody: description: > channelId: ( RsGxsGroupId)id of the channel peers: ( set)peers to share the key with content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsChannelsShareChannelKeys' examples: ReqRsGxsChannelsShareChannelKeys: value: channelId: ( RsGxsGroupId)id of the channel peers: ( set)peers to share the key with security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsChannels/subscribeToChannel: post: operationId: RsGxsChannelsSubscribeToChannel summary: Subscrbe to a channel. Blocking API deprecated: false requestBody: description: > channelId: ( RsGxsGroupId)Channel id subscribe: ( boolean)true to subscribe, false to unsubscribe content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsChannelsSubscribeToChannel' examples: ReqRsGxsChannelsSubscribeToChannel: value: channelId: ( RsGxsGroupId)Channel id subscribe: ( boolean)true to subscribe, false to unsubscribe security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsChannels/turtleChannelRequest: post: operationId: RsGxsChannelsTurtleChannelRequest summary: This method is asynchronous. Request remote channel deprecated: false requestBody: description: > channelId: ( RsGxsGroupId)id of the channel to request to distants peers maxWait: ( rstime_t)maximum wait time in seconds for search results content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsChannelsTurtleChannelRequest' examples: ReqRsGxsChannelsTurtleChannelRequest: value: channelId: ( RsGxsGroupId)id of the channel to request to distants peers maxWait: ( rstime_t)maximum wait time in seconds for search results security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsGxsChannels/turtleSearchRequest: post: operationId: RsGxsChannelsTurtleSearchRequest summary: This method is asynchronous. Request remote channels search deprecated: false requestBody: description: > matchString: ( string)string to look for in the search maxWait: ( rstime_t)maximum wait time in seconds for search results content: application/json: schema: $ref: '#/components/schemas/ReqRsGxsChannelsTurtleSearchRequest' examples: ReqRsGxsChannelsTurtleSearchRequest: value: matchString: ( string)string to look for in the search maxWait: ( rstime_t)maximum wait time in seconds for search results security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/addSharedDirectory: post: operationId: RsFilesAddSharedDirectory summary: Add shared directory deprecated: false requestBody: description: > dir: ( SharedDirInfo)directory to share with sharing options content: application/json: schema: $ref: '#/components/schemas/ReqRsFilesAddSharedDirectory' examples: ReqRsFilesAddSharedDirectory: value: dir: ( SharedDirInfo)directory to share with sharing options security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/alreadyHaveFile: post: operationId: RsFilesAlreadyHaveFile summary: Check if we already have a file deprecated: false requestBody: description: > hash: ( RsFileHash)file identifier content: application/json: schema: $ref: '#/components/schemas/ReqRsFilesAlreadyHaveFile' examples: ReqRsFilesAlreadyHaveFile: value: hash: ( RsFileHash)file identifier security: - BasicAuth: [] responses: '200': description: > return: true if the file is already present, false otherwise info(FileInfo)storage for the possibly found file information content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/banFile: post: operationId: RsFilesBanFile summary: Ban unwanted file from being, searched and forwarded by this node deprecated: false requestBody: description: > realFileHash: ( RsFileHash)this is what will really enforce banning filename: ( string)expected name of the file, for the user to read fileSize: ( integer)expected file size, for the user to read content: application/json: schema: $ref: '#/components/schemas/ReqRsFilesBanFile' examples: ReqRsFilesBanFile: value: realFileHash: ( RsFileHash)this is what will really enforce banning filename: ( string)expected name of the file, for the user to read fileSize: ( integer)expected file size, for the user to read security: - BasicAuth: [] responses: '200': description: > return: meaningless value content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/defaultChunkStrategy: post: operationId: RsFilesDefaultChunkStrategy summary: Get default chunk strategy deprecated: false security: - BasicAuth: [] responses: '200': description: > return: current default chunck strategy content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/FileCancel: post: operationId: RsFilesFileCancel summary: Cancel file downloading deprecated: false requestBody: description: > hash: ( RsFileHash)None content: application/json: schema: $ref: '#/components/schemas/ReqRsFilesFileCancel' examples: ReqRsFilesFileCancel: value: hash: ( RsFileHash)None security: - BasicAuth: [] responses: '200': description: > return: false if the file is not in the download queue, true otherwhise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/FileClearCompleted: post: operationId: RsFilesFileClearCompleted summary: Clear completed downloaded files list deprecated: false security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/FileControl: post: operationId: RsFilesFileControl summary: Controls file transfer deprecated: false requestBody: description: > hash: ( RsFileHash)file identifier flags: ( integer)action to perform. Pict into { RS_FILE_CTRL_PAUSE, RS_FILE_CTRL_START, RS_FILE_CTRL_FORCE_CHECK } } content: application/json: schema: $ref: '#/components/schemas/ReqRsFilesFileControl' examples: ReqRsFilesFileControl: value: hash: ( RsFileHash)file identifier flags: ( integer)action to perform. Pict into { RS_FILE_CTRL_PAUSE, RS_FILE_CTRL_START, RS_FILE_CTRL_FORCE_CHECK } } security: - BasicAuth: [] responses: '200': description: > return: false if error occured such as unknown hash. content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/FileDetails: post: operationId: RsFilesFileDetails summary: Get file details deprecated: false requestBody: description: > hash: ( RsFileHash)file identifier hintflags: ( FileSearchFlags)filtering hint (RS_FILE_HINTS_EXTRA|...|RS_FILE_HINTS_LOCAL) content: application/json: schema: $ref: '#/components/schemas/ReqRsFilesFileDetails' examples: ReqRsFilesFileDetails: value: hash: ( RsFileHash)file identifier hintflags: ( FileSearchFlags)filtering hint (RS_FILE_HINTS_EXTRA|...|RS_FILE_HINTS_LOCAL) security: - BasicAuth: [] responses: '200': description: > return: true if file found, false otherwise info(FileInfo)storage for file information content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/FileDownloadChunksDetails: post: operationId: RsFilesFileDownloadChunksDetails summary: Get chunk details about the downloaded file with given hash. deprecated: false requestBody: description: > hash: ( RsFileHash)file identifier content: application/json: schema: $ref: '#/components/schemas/ReqRsFilesFileDownloadChunksDetails' examples: ReqRsFilesFileDownloadChunksDetails: value: hash: ( RsFileHash)file identifier security: - BasicAuth: [] responses: '200': description: > return: true if file found, false otherwise info(FileChunksInfo)storage for file information content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/FileDownloads: post: operationId: RsFilesFileDownloads summary: Get incoming files list deprecated: false security: - BasicAuth: [] responses: '200': description: > return: hashs(list)storage for files identifiers list content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/FileRequest: post: operationId: RsFilesFileRequest summary: Initiate downloading of a file deprecated: false requestBody: description: > fileName: ( string)None hash: ( RsFileHash)None size: ( integer)None destPath: ( string)in not empty specify a destination path flags: ( TransferRequestFlags)you usually want RS_FILE_REQ_ANONYMOUS_ROUTING srcIds: ( list)eventually specify known sources content: application/json: schema: $ref: '#/components/schemas/ReqRsFilesFileRequest' examples: ReqRsFilesFileRequest: value: fileName: ( string)None hash: ( RsFileHash)None size: ( integer)None destPath: ( string)in not empty specify a destination path flags: ( TransferRequestFlags)you usually want RS_FILE_REQ_ANONYMOUS_ROUTING srcIds: ( list)eventually specify known sources security: - BasicAuth: [] responses: '200': description: > return: false if we already have the file, true otherwhise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/FileUploadChunksDetails: post: operationId: RsFilesFileUploadChunksDetails summary: Get details about the upload with given hash deprecated: false requestBody: description: > hash: ( RsFileHash)file identifier peer_id: ( RsPeerId)peer identifier content: application/json: schema: $ref: '#/components/schemas/ReqRsFilesFileUploadChunksDetails' examples: ReqRsFilesFileUploadChunksDetails: value: hash: ( RsFileHash)file identifier peer_id: ( RsPeerId)peer identifier security: - BasicAuth: [] responses: '200': description: > return: true if file found, false otherwise map(CompressedChunkMap)storage for chunk info content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/FileUploads: post: operationId: RsFilesFileUploads summary: Get outgoing files list deprecated: false security: - BasicAuth: [] responses: '200': description: > return: false if some error occurred, true otherwise hashs(list)storage for files identifiers list content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/ForceDirectoryCheck: post: operationId: RsFilesForceDirectoryCheck summary: Force shared directories check deprecated: false security: - BasicAuth: [] responses: '200': description: > return: content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/freeDiskSpaceLimit: post: operationId: RsFilesFreeDiskSpaceLimit summary: Get free disk space limit deprecated: false security: - BasicAuth: [] responses: '200': description: > return: current minimum free space on disk in MB content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/getDownloadDirectory: post: operationId: RsFilesGetDownloadDirectory summary: Get default complete downloads directory deprecated: false security: - BasicAuth: [] responses: '200': description: > return: default completed downloads directory path content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/getFileData: post: operationId: RsFilesGetFileData summary: Provides file data for the gui, media streaming or rpc clients. It may return unverified chunks. This allows streaming without having to wait for hashes or completion of the file. This function returns an unspecified amount of bytes. Either as much data as available or a sensible maximum. Expect a block size of around 1MiB. To get more data, call this function repeatedly with different offsets. deprecated: false requestBody: description: > hash: ( RsFileHash)hash of the file. The file has to be available on this node or it has to be in downloading state. offset: ( integer)where the desired block starts requested_size: ( integer)size of pre-allocated data. Will be updated by the function. content: application/json: schema: $ref: '#/components/schemas/ReqRsFilesGetFileData' examples: ReqRsFilesGetFileData: value: hash: ( RsFileHash)hash of the file. The file has to be available on this node or it has to be in downloading state. offset: ( integer)where the desired block starts requested_size: ( integer)size of pre-allocated data. Will be updated by the function. security: - BasicAuth: [] responses: '200': description: > return: Returns false in case data(uint8_t*)pre-allocated memory chunk of size 'requested_size' by the client content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/getPartialsDirectory: post: operationId: RsFilesGetPartialsDirectory summary: Get partial downloads directory deprecated: false security: - BasicAuth: [] responses: '200': description: > return: partials downloads directory path content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/getPrimaryBannedFilesList: post: operationId: RsFilesGetPrimaryBannedFilesList summary: Get list of banned files deprecated: false security: - BasicAuth: [] responses: '200': description: > return: meaningless value bannedFiles(map)storage for banned files information content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/getSharedDirectories: post: operationId: RsFilesGetSharedDirectories summary: Get list of current shared directories deprecated: false security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise dirs(list)storage for the list of share directories content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/isHashBanned: post: operationId: RsFilesIsHashBanned summary: Check if a file is on banned list deprecated: false requestBody: description: > hash: ( RsFileHash)hash of the file content: application/json: schema: $ref: '#/components/schemas/ReqRsFilesIsHashBanned' examples: ReqRsFilesIsHashBanned: value: hash: ( RsFileHash)hash of the file security: - BasicAuth: [] responses: '200': description: > return: true if the hash is on the list, false otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/removeSharedDirectory: post: operationId: RsFilesRemoveSharedDirectory summary: Remove directory from shared list deprecated: false requestBody: description: > dir: ( string)Path of the directory to remove from shared list content: application/json: schema: $ref: '#/components/schemas/ReqRsFilesRemoveSharedDirectory' examples: ReqRsFilesRemoveSharedDirectory: value: dir: ( string)Path of the directory to remove from shared list security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/requestDirDetails: post: operationId: RsFilesRequestDirDetails summary: Request directory details, subsequent multiple call may be used to explore a whole directory tree. deprecated: false requestBody: description: > handle: ( integer)element handle 0 for root, pass the content of DirDetails::child[x].ref after first call to explore deeper, be aware that is not a real pointer but an index used internally by RetroShare. flags: ( FileSearchFlags)file search flags RS_FILE_HINTS_* content: application/json: schema: $ref: '#/components/schemas/ReqRsFilesRequestDirDetails' examples: ReqRsFilesRequestDirDetails: value: handle: ( integer)element handle 0 for root, pass the content of DirDetails::child[x].ref after first call to explore deeper, be aware that is not a real pointer but an index used internally by RetroShare. flags: ( FileSearchFlags)file search flags RS_FILE_HINTS_* security: - BasicAuth: [] responses: '200': description: > return: false if error occurred, true otherwise details(DirDetails)Storage for directory details content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/setChunkStrategy: post: operationId: RsFilesSetChunkStrategy summary: Set chunk strategy for file, useful to set streaming mode to be able of see video or other media preview while it is still downloading deprecated: false requestBody: description: > hash: ( RsFileHash)file identifier newStrategy: ( FileChunksInfo_ChunkStrategy)None content: application/json: schema: $ref: '#/components/schemas/ReqRsFilesSetChunkStrategy' examples: ReqRsFilesSetChunkStrategy: value: hash: ( RsFileHash)file identifier newStrategy: ( FileChunksInfo_ChunkStrategy)None security: - BasicAuth: [] responses: '200': description: > return: false if some error occurred, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/setDefaultChunkStrategy: post: operationId: RsFilesSetDefaultChunkStrategy summary: Set default chunk strategy deprecated: false requestBody: description: > strategy: ( FileChunksInfo_ChunkStrategy)None content: application/json: schema: $ref: '#/components/schemas/ReqRsFilesSetDefaultChunkStrategy' examples: ReqRsFilesSetDefaultChunkStrategy: value: strategy: ( FileChunksInfo_ChunkStrategy)None security: - BasicAuth: [] responses: '200': description: > return: content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/setDestinationDirectory: post: operationId: RsFilesSetDestinationDirectory summary: Set destination directory for given file deprecated: false requestBody: description: > hash: ( RsFileHash)file identifier newPath: ( string)None content: application/json: schema: $ref: '#/components/schemas/ReqRsFilesSetDestinationDirectory' examples: ReqRsFilesSetDestinationDirectory: value: hash: ( RsFileHash)file identifier newPath: ( string)None security: - BasicAuth: [] responses: '200': description: > return: false if some error occurred, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/setDestinationName: post: operationId: RsFilesSetDestinationName summary: Set name for dowloaded file deprecated: false requestBody: description: > hash: ( RsFileHash)file identifier newName: ( string)None content: application/json: schema: $ref: '#/components/schemas/ReqRsFilesSetDestinationName' examples: ReqRsFilesSetDestinationName: value: hash: ( RsFileHash)file identifier newName: ( string)None security: - BasicAuth: [] responses: '200': description: > return: false if some error occurred, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/setDownloadDirectory: post: operationId: RsFilesSetDownloadDirectory summary: Set default complete downloads directory deprecated: false requestBody: description: > path: ( string)directory path content: application/json: schema: $ref: '#/components/schemas/ReqRsFilesSetDownloadDirectory' examples: ReqRsFilesSetDownloadDirectory: value: path: ( string)directory path security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/setFreeDiskSpaceLimit: post: operationId: RsFilesSetFreeDiskSpaceLimit summary: Set minimum free disk space limit deprecated: false requestBody: description: > minimumFreeMB: ( integer)minimum free space in MB content: application/json: schema: $ref: '#/components/schemas/ReqRsFilesSetFreeDiskSpaceLimit' examples: ReqRsFilesSetFreeDiskSpaceLimit: value: minimumFreeMB: ( integer)minimum free space in MB security: - BasicAuth: [] responses: '200': description: > return: content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/setPartialsDirectory: post: operationId: RsFilesSetPartialsDirectory summary: Set partial downloads directory deprecated: false requestBody: description: > path: ( string)directory path content: application/json: schema: $ref: '#/components/schemas/ReqRsFilesSetPartialsDirectory' examples: ReqRsFilesSetPartialsDirectory: value: path: ( string)directory path security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/setSharedDirectories: post: operationId: RsFilesSetSharedDirectories summary: Set shared directories deprecated: false requestBody: description: > dirs: ( list)list of shared directories with share options content: application/json: schema: $ref: '#/components/schemas/ReqRsFilesSetSharedDirectories' examples: ReqRsFilesSetSharedDirectories: value: dirs: ( list)list of shared directories with share options security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/turtleSearchRequest: post: operationId: RsFilesTurtleSearchRequest summary: This method is asynchronous. Request remote files search deprecated: false requestBody: description: > matchString: ( string)string to look for in the search maxWait: ( rstime_t)maximum wait time in seconds for search results content: application/json: schema: $ref: '#/components/schemas/ReqRsFilesTurtleSearchRequest' examples: ReqRsFilesTurtleSearchRequest: value: matchString: ( string)string to look for in the search maxWait: ( rstime_t)maximum wait time in seconds for search results security: - BasicAuth: [] responses: '200': description: > return: false on error, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/unbanFile: post: operationId: RsFilesUnbanFile summary: Remove file from unwanted list deprecated: false requestBody: description: > realFileHash: ( RsFileHash)hash of the file content: application/json: schema: $ref: '#/components/schemas/ReqRsFilesUnbanFile' examples: ReqRsFilesUnbanFile: value: realFileHash: ( RsFileHash)hash of the file security: - BasicAuth: [] responses: '200': description: > return: meaningless value content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsFiles/updateShareFlags: post: operationId: RsFilesUpdateShareFlags summary: Updates shared directory sharing flags. The directory should be already shared! deprecated: false requestBody: description: > dir: ( SharedDirInfo)Shared directory with updated sharing options content: application/json: schema: $ref: '#/components/schemas/ReqRsFilesUpdateShareFlags' examples: ReqRsFilesUpdateShareFlags: value: dir: ( SharedDirInfo)Shared directory with updated sharing options security: - BasicAuth: [] responses: '200': description: > return: false if something failed, true otherwhise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsBroadcastDiscovery/getDiscoveredPeers: post: operationId: RsBroadcastDiscoveryGetDiscoveredPeers summary: Get potential peers that have been discovered up until now deprecated: false security: - BasicAuth: [] responses: '200': description: > return: vector containing discovered peers, may be empty. content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsConfig/getAllBandwidthRates: post: operationId: RsConfigGetAllBandwidthRates summary: getAllBandwidthRates get the bandwidth rates for all peers deprecated: false security: - BasicAuth: [] responses: '200': description: > return: returns 1 on succes and 0 otherwise ratemap(map)map with peers->rates content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsConfig/getConfigNetStatus: post: operationId: RsConfigGetConfigNetStatus summary: getConfigNetStatus return the net status deprecated: false security: - BasicAuth: [] responses: '200': description: > return: returns 1 on succes and 0 otherwise status(RsConfigNetStatus)network status content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsConfig/GetCurrentDataRates: post: operationId: RsConfigGetCurrentDataRates summary: GetCurrentDataRates get current upload and download rates deprecated: false security: - BasicAuth: [] responses: '200': description: > return: returns 1 on succes and 0 otherwise inKb(number)download rate in kB outKb(number)upload rate in kB content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsConfig/GetMaxDataRates: post: operationId: RsConfigGetMaxDataRates summary: GetMaxDataRates get maximum upload and download rates deprecated: false security: - BasicAuth: [] responses: '200': description: > return: returns 1 on succes and 0 otherwise inKb(integer)download rate in kB outKb(integer)upload rate in kB content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsConfig/getOperatingMode: post: operationId: RsConfigGetOperatingMode summary: getOperatingMode get current operating mode deprecated: false security: - BasicAuth: [] responses: '200': description: > return: return the current operating mode content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsConfig/getTotalBandwidthRates: post: operationId: RsConfigGetTotalBandwidthRates summary: getTotalBandwidthRates returns the current bandwidths rates deprecated: false security: - BasicAuth: [] responses: '200': description: > return: returns 1 on succes and 0 otherwise rates(RsConfigDataRates)None content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsConfig/getTrafficInfo: post: operationId: RsConfigGetTrafficInfo summary: getTrafficInfo returns a list of all tracked traffic clues deprecated: false security: - BasicAuth: [] responses: '200': description: > return: returns 1 on succes and 0 otherwise out_lst(list)outgoing traffic clues in_lst(list)incomming traffic clues content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsConfig/SetMaxDataRates: post: operationId: RsConfigSetMaxDataRates summary: SetMaxDataRates set maximum upload and download rates deprecated: false requestBody: description: > downKb: ( integer)download rate in kB upKb: ( integer)upload rate in kB content: application/json: schema: $ref: '#/components/schemas/ReqRsConfigSetMaxDataRates' examples: ReqRsConfigSetMaxDataRates: value: downKb: ( integer)download rate in kB upKb: ( integer)upload rate in kB security: - BasicAuth: [] responses: '200': description: > return: returns 1 on succes and 0 otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsConfig/setOperatingMode: post: operationId: RsConfigSetOperatingMode summary: setOperatingMode set the current oprating mode deprecated: false requestBody: description: > opMode: ( integer)new opearting mode content: application/json: schema: $ref: '#/components/schemas/ReqRsConfigSetOperatingMode' examples: ReqRsConfigSetOperatingMode: value: opMode: ( integer)new opearting mode security: - BasicAuth: [] responses: '200': description: > return: None content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/acceptInvite: post: operationId: RsPeersAcceptInvite summary: Add trusted node from invite deprecated: false requestBody: description: > invite: ( string)invite string being it in cert or URL format flags: ( ServicePermissionFlags)service permissions flag content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersAcceptInvite' examples: ReqRsPeersAcceptInvite: value: invite: ( string)invite string being it in cert or URL format flags: ( ServicePermissionFlags)service permissions flag security: - BasicAuth: [] responses: '200': description: > return: false if error occurred, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/addFriend: post: operationId: RsPeersAddFriend summary: Add trusted node deprecated: false requestBody: description: > sslId: ( RsPeerId)SSL id of the node to add gpgId: ( RsPgpId)PGP id of the node to add flags: ( ServicePermissionFlags)service permissions flag content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersAddFriend' examples: ReqRsPeersAddFriend: value: sslId: ( RsPeerId)SSL id of the node to add gpgId: ( RsPgpId)PGP id of the node to add flags: ( ServicePermissionFlags)service permissions flag security: - BasicAuth: [] responses: '200': description: > return: false if error occurred, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/addGroup: post: operationId: RsPeersAddGroup summary: addGroup create a new group deprecated: false requestBody: description: > groupInfo: ( RsGroupInfo)None content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersAddGroup' examples: ReqRsPeersAddGroup: value: groupInfo: ( RsGroupInfo)None security: - BasicAuth: [] responses: '200': description: > return: None content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/addPeerLocator: post: operationId: RsPeersAddPeerLocator summary: Add URL locator for given peer deprecated: false requestBody: description: > sslId: ( RsPeerId)SSL id of the peer, own id is accepted too locator: ( RsUrl)peer url locator content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersAddPeerLocator' examples: ReqRsPeersAddPeerLocator: value: sslId: ( RsPeerId)SSL id of the peer, own id is accepted too locator: ( RsUrl)peer url locator security: - BasicAuth: [] responses: '200': description: > return: false if error occurred, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/assignPeersToGroup: post: operationId: RsPeersAssignPeersToGroup summary: assignPeersToGroup add a list of peers to a group deprecated: false requestBody: description: > groupId: ( RsNodeGroupId)None peerIds: ( list)None assign: ( boolean)true to assign a peer, false to remove a peer content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersAssignPeersToGroup' examples: ReqRsPeersAssignPeersToGroup: value: groupId: ( RsNodeGroupId)None peerIds: ( list)None assign: ( boolean)true to assign a peer, false to remove a peer security: - BasicAuth: [] responses: '200': description: > return: None content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/assignPeerToGroup: post: operationId: RsPeersAssignPeerToGroup summary: assignPeerToGroup add a peer to a group deprecated: false requestBody: description: > groupId: ( RsNodeGroupId)None peerId: ( RsPgpId)None assign: ( boolean)true to assign a peer, false to remove a peer content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersAssignPeerToGroup' examples: ReqRsPeersAssignPeerToGroup: value: groupId: ( RsNodeGroupId)None peerId: ( RsPgpId)None assign: ( boolean)true to assign a peer, false to remove a peer security: - BasicAuth: [] responses: '200': description: > return: None content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/connectAttempt: post: operationId: RsPeersConnectAttempt summary: Trigger connection attempt to given node deprecated: false requestBody: description: > sslId: ( RsPeerId)SSL id of the node to connect content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersConnectAttempt' examples: ReqRsPeersConnectAttempt: value: sslId: ( RsPeerId)SSL id of the node to connect security: - BasicAuth: [] responses: '200': description: > return: false if error occurred, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/editGroup: post: operationId: RsPeersEditGroup summary: editGroup edit an existing group deprecated: false requestBody: description: > groupId: ( RsNodeGroupId)None groupInfo: ( RsGroupInfo)None content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersEditGroup' examples: ReqRsPeersEditGroup: value: groupId: ( RsNodeGroupId)None groupInfo: ( RsGroupInfo)None security: - BasicAuth: [] responses: '200': description: > return: None content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/getFriendList: post: operationId: RsPeersGetFriendList summary: Get trusted peers list deprecated: false security: - BasicAuth: [] responses: '200': description: > return: false if error occurred, true otherwise sslIds(list)storage for the trusted peers content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/getGPGId: post: operationId: RsPeersGetGPGId summary: Get PGP id for the given peer deprecated: false requestBody: description: > sslId: ( RsPeerId)SSL id of the peer content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersGetGPGId' examples: ReqRsPeersGetGPGId: value: sslId: ( RsPeerId)SSL id of the peer security: - BasicAuth: [] responses: '200': description: > return: PGP id of the peer content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/getGroupInfo: post: operationId: RsPeersGetGroupInfo summary: getGroupInfo get group information to one group deprecated: false requestBody: description: > groupId: ( RsNodeGroupId)None content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersGetGroupInfo' examples: ReqRsPeersGetGroupInfo: value: groupId: ( RsNodeGroupId)None security: - BasicAuth: [] responses: '200': description: > return: None groupInfo(RsGroupInfo)None content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/getGroupInfoByName: post: operationId: RsPeersGetGroupInfoByName summary: getGroupInfoByName get group information by group name deprecated: false requestBody: description: > groupName: ( string)None content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersGetGroupInfoByName' examples: ReqRsPeersGetGroupInfoByName: value: groupName: ( string)None security: - BasicAuth: [] responses: '200': description: > return: None groupInfo(RsGroupInfo)None content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/getGroupInfoList: post: operationId: RsPeersGetGroupInfoList summary: getGroupInfoList get list of all groups deprecated: false security: - BasicAuth: [] responses: '200': description: > return: None groupInfoList(list)None content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/getOnlineList: post: operationId: RsPeersGetOnlineList summary: Get connected peers list deprecated: false security: - BasicAuth: [] responses: '200': description: > return: false if error occurred, true otherwise sslIds(list)storage for the peers content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/getPeerDetails: post: operationId: RsPeersGetPeerDetails summary: Get details details of the given peer deprecated: false requestBody: description: > sslId: ( RsPeerId)id of the peer content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersGetPeerDetails' examples: ReqRsPeersGetPeerDetails: value: sslId: ( RsPeerId)id of the peer security: - BasicAuth: [] responses: '200': description: > return: false if error occurred, true otherwise det(RsPeerDetails)storage for the details of the peer content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/getPeersCount: post: operationId: RsPeersGetPeersCount summary: Get peers count deprecated: false requestBody: description: > countLocations: ( boolean)true to count multiple locations of same owner content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersGetPeersCount' examples: ReqRsPeersGetPeersCount: value: countLocations: ( boolean)true to count multiple locations of same owner security: - BasicAuth: [] responses: '200': description: > return: false if error occurred, true otherwise peersCount(integer)storage for trusted peers count onlinePeersCount(integer)storage for online peers count content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/GetRetroshareInvite: post: operationId: RsPeersGetRetroshareInvite summary: Get RetroShare invite of the given peer deprecated: false requestBody: description: > sslId: ( RsPeerId)Id of the peer of which we want to generate an invite, a null id (all 0) is passed, an invite for own node is returned. includeSignatures: ( boolean)true to add key signatures to the invite includeExtraLocators: ( boolean)false to avoid to add extra locators content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersGetRetroshareInvite' examples: ReqRsPeersGetRetroshareInvite: value: sslId: ( RsPeerId)Id of the peer of which we want to generate an invite, a null id (all 0) is passed, an invite for own node is returned. includeSignatures: ( boolean)true to add key signatures to the invite includeExtraLocators: ( boolean)false to avoid to add extra locators security: - BasicAuth: [] responses: '200': description: > return: invite string content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/isFriend: post: operationId: RsPeersIsFriend summary: Check if given peer is a trusted node deprecated: false requestBody: description: > sslId: ( RsPeerId)id of the peer to check content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersIsFriend' examples: ReqRsPeersIsFriend: value: sslId: ( RsPeerId)id of the peer to check security: - BasicAuth: [] responses: '200': description: > return: true if the node is trusted, false otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/isOnline: post: operationId: RsPeersIsOnline summary: Check if there is an established connection to the given peer deprecated: false requestBody: description: > sslId: ( RsPeerId)id of the peer to check content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersIsOnline' examples: ReqRsPeersIsOnline: value: sslId: ( RsPeerId)id of the peer to check security: - BasicAuth: [] responses: '200': description: > return: true if the connection is establisced, false otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/isPgpFriend: post: operationId: RsPeersIsPgpFriend summary: Check if given PGP id is trusted deprecated: false requestBody: description: > pgpId: ( RsPgpId)PGP id to check content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersIsPgpFriend' examples: ReqRsPeersIsPgpFriend: value: pgpId: ( RsPgpId)PGP id to check security: - BasicAuth: [] responses: '200': description: > return: true if the PGP id is trusted, false otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/loadCertificateFromString: post: operationId: RsPeersLoadCertificateFromString summary: Import certificate into the keyring deprecated: false requestBody: description: > cert: ( string)string representation of the certificate content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersLoadCertificateFromString' examples: ReqRsPeersLoadCertificateFromString: value: cert: ( string)string representation of the certificate security: - BasicAuth: [] responses: '200': description: > return: false if error occurred, true otherwise sslId(RsPeerId)storage for the SSL id of the certificate pgpId(RsPgpId)storage for the PGP id of the certificate errorString(string)storage for the possible error string content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/loadDetailsFromStringCert: post: operationId: RsPeersLoadDetailsFromStringCert summary: Examine certificate and get details without importing into the keyring deprecated: false requestBody: description: > cert: ( string)string representation of the certificate content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersLoadDetailsFromStringCert' examples: ReqRsPeersLoadDetailsFromStringCert: value: cert: ( string)string representation of the certificate security: - BasicAuth: [] responses: '200': description: > return: false if error occurred, true otherwise certDetails(RsPeerDetails)storage for the certificate details errorCode(integer)storage for possible error number content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/removeFriend: post: operationId: RsPeersRemoveFriend summary: Revoke connection trust from to node deprecated: false requestBody: description: > pgpId: ( RsPgpId)PGP id of the node content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersRemoveFriend' examples: ReqRsPeersRemoveFriend: value: pgpId: ( RsPgpId)PGP id of the node security: - BasicAuth: [] responses: '200': description: > return: false if error occurred, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/removeFriendLocation: post: operationId: RsPeersRemoveFriendLocation summary: Remove location of a trusted node, useful to prune old unused locations of a trusted peer without revoking trust deprecated: false requestBody: description: > sslId: ( RsPeerId)SSL id of the location to remove content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersRemoveFriendLocation' examples: ReqRsPeersRemoveFriendLocation: value: sslId: ( RsPeerId)SSL id of the location to remove security: - BasicAuth: [] responses: '200': description: > return: false if error occurred, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/removeGroup: post: operationId: RsPeersRemoveGroup summary: removeGroup remove a group deprecated: false requestBody: description: > groupId: ( RsNodeGroupId)None content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersRemoveGroup' examples: ReqRsPeersRemoveGroup: value: groupId: ( RsNodeGroupId)None security: - BasicAuth: [] responses: '200': description: > return: None content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/setDynDNS: post: operationId: RsPeersSetDynDNS summary: Set (dynamical) domain name associated to the given peer deprecated: false requestBody: description: > sslId: ( RsPeerId)SSL id of the peer, own id is accepted too addr: ( string)domain name string representation content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersSetDynDNS' examples: ReqRsPeersSetDynDNS: value: sslId: ( RsPeerId)SSL id of the peer, own id is accepted too addr: ( string)domain name string representation security: - BasicAuth: [] responses: '200': description: > return: false if error occurred, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/setExtAddress: post: operationId: RsPeersSetExtAddress summary: Set external IPv4 address for given peer deprecated: false requestBody: description: > sslId: ( RsPeerId)SSL id of the peer, own id is accepted too addr: ( string)string representation of the external IPv4 address port: ( integer)external listening port content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersSetExtAddress' examples: ReqRsPeersSetExtAddress: value: sslId: ( RsPeerId)SSL id of the peer, own id is accepted too addr: ( string)string representation of the external IPv4 address port: ( integer)external listening port security: - BasicAuth: [] responses: '200': description: > return: false if error occurred, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/setLocalAddress: post: operationId: RsPeersSetLocalAddress summary: Set local IPv4 address for the given peer deprecated: false requestBody: description: > sslId: ( RsPeerId)SSL id of the peer, own id is accepted too addr: ( string)string representation of the local IPv4 address port: ( integer)local listening port content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersSetLocalAddress' examples: ReqRsPeersSetLocalAddress: value: sslId: ( RsPeerId)SSL id of the peer, own id is accepted too addr: ( string)string representation of the local IPv4 address port: ( integer)local listening port security: - BasicAuth: [] responses: '200': description: > return: false if error occurred, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/setNetworkMode: post: operationId: RsPeersSetNetworkMode summary: Set network mode of the given peer deprecated: false requestBody: description: > sslId: ( RsPeerId)SSL id of the peer, own id is accepted too netMode: ( integer)one of RS_NETMODE_* content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersSetNetworkMode' examples: ReqRsPeersSetNetworkMode: value: sslId: ( RsPeerId)SSL id of the peer, own id is accepted too netMode: ( integer)one of RS_NETMODE_* security: - BasicAuth: [] responses: '200': description: > return: false if error occurred, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsPeers/setVisState: post: operationId: RsPeersSetVisState summary: set DHT and discovery modes deprecated: false requestBody: description: > sslId: ( RsPeerId)SSL id of the peer, own id is accepted too vsDisc: ( integer)one of RS_VS_DISC_* vsDht: ( integer)one of RS_VS_DHT_* content: application/json: schema: $ref: '#/components/schemas/ReqRsPeersSetVisState' examples: ReqRsPeersSetVisState: value: sslId: ( RsPeerId)SSL id of the peer, own id is accepted too vsDisc: ( integer)one of RS_VS_DISC_* vsDht: ( integer)one of RS_VS_DHT_* security: - BasicAuth: [] responses: '200': description: > return: false if error occurred, true otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsLoginHelper/attemptLogin: post: operationId: RsLoginHelperAttemptLogin summary: Normal way to attempt login deprecated: false requestBody: description: > account: ( RsPeerId)Id of the account to which attempt login password: ( string)Password for the given account content: application/json: schema: $ref: '#/components/schemas/ReqRsLoginHelperAttemptLogin' examples: ReqRsLoginHelperAttemptLogin: value: account: ( RsPeerId)Id of the account to which attempt login password: ( string)Password for the given account security: - BasicAuth: [] responses: '200': description: > return: None content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsLoginHelper/collectEntropy: post: operationId: RsLoginHelperCollectEntropy summary: Feed extra entropy to the crypto libraries deprecated: false requestBody: description: > bytes: ( integer)number to feed to the entropy pool content: application/json: schema: $ref: '#/components/schemas/ReqRsLoginHelperCollectEntropy' examples: ReqRsLoginHelperCollectEntropy: value: bytes: ( integer)number to feed to the entropy pool responses: '200': description: > return: false if error occurred, true otherwise content: application/json: schema: type: string /rsLoginHelper/createLocation: post: operationId: RsLoginHelperCreateLocation summary: Creates a new RetroShare location, and log in once is created deprecated: false requestBody: description: > location: ( RsLoginHelper_Location)provide input information to generate the location and storage to output the data of the generated location password: ( string)to protect and unlock the associated PGP key makeHidden: ( boolean)pass true to create an hidden location. UNTESTED! makeAutoTor: ( boolean)pass true to create an automatically configured Tor hidden location. UNTESTED! content: application/json: schema: $ref: '#/components/schemas/ReqRsLoginHelperCreateLocation' examples: ReqRsLoginHelperCreateLocation: value: location: ( RsLoginHelper_Location)provide input information to generate the location and storage to output the data of the generated location password: ( string)to protect and unlock the associated PGP key makeHidden: ( boolean)pass true to create an hidden location. UNTESTED! makeAutoTor: ( boolean)pass true to create an automatically configured Tor hidden location. UNTESTED! security: - BasicAuth: [] responses: '200': description: > return: true if success, false otherwise errorMessage(string)if some error occurred human readable error message content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsLoginHelper/getLocations: post: operationId: RsLoginHelperGetLocations summary: Get locations and associated information deprecated: false responses: '200': description: > return: locations(vector)storage for the retrived locations content: application/json: schema: type: string /rsLoginHelper/isLoggedIn: post: operationId: RsLoginHelperIsLoggedIn summary: Check if RetroShare is already logged in, this usually return true after a successfull deprecated: false responses: '200': description: > return: true if already logged in, false otherwise content: application/json: schema: type: string /rsAccounts/ExportIdentity: post: operationId: RsAccountsExportIdentity summary: Export full encrypted PGP identity to file deprecated: false requestBody: description: > filePath: ( string)path of certificate file pgpId: ( RsPgpId)PGP id to export content: application/json: schema: $ref: '#/components/schemas/ReqRsAccountsExportIdentity' examples: ReqRsAccountsExportIdentity: value: filePath: ( string)path of certificate file pgpId: ( RsPgpId)PGP id to export security: - BasicAuth: [] responses: '200': description: > return: true on success, false otherwise content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsAccounts/exportIdentityToString: post: operationId: RsAccountsExportIdentityToString summary: Export full encrypted PGP identity to string deprecated: false requestBody: description: > pgpId: ( RsPgpId)PGP id to export includeSignatures: ( boolean)true to include signatures content: application/json: schema: $ref: '#/components/schemas/ReqRsAccountsExportIdentityToString' examples: ReqRsAccountsExportIdentityToString: value: pgpId: ( RsPgpId)PGP id to export includeSignatures: ( boolean)true to include signatures security: - BasicAuth: [] responses: '200': description: > return: true on success, false otherwise data(string)storage for certificate string errorMsg(string)storage for eventual human readable error message content: application/json: schema: type: string '401': $ref: '#/components/responses/UnauthorizedError' /rsAccounts/getCurrentAccountId: post: operationId: RsAccountsGetCurrentAccountId summary: Get current account id. Beware that an account may be selected without actually logging in. deprecated: false responses: '200': description: > return: false if account hasn't been selected yet, true otherwise id(RsPeerId)storage for current account id content: application/json: schema: type: string /rsAccounts/GetPGPLogins: post: operationId: RsAccountsGetPGPLogins summary: Get available PGP identities id list deprecated: false responses: '200': description: > return: true on success, false otherwise pgpIds(list)storage for PGP id list content: application/json: schema: type: string /rsAccounts/ImportIdentity: post: operationId: RsAccountsImportIdentity summary: Import full encrypted PGP identity from file deprecated: false requestBody: description: > filePath: ( string)path of certificate file content: application/json: schema: $ref: '#/components/schemas/ReqRsAccountsImportIdentity' examples: ReqRsAccountsImportIdentity: value: filePath: ( string)path of certificate file responses: '200': description: > return: true on success, false otherwise pgpId(RsPgpId)storage for the PGP fingerprint of the imported key errorMsg(string)storage for eventual human readable error message content: application/json: schema: type: string /rsAccounts/importIdentityFromString: post: operationId: RsAccountsImportIdentityFromString summary: Import full encrypted PGP identity from string deprecated: false requestBody: description: > data: ( string)certificate string content: application/json: schema: $ref: '#/components/schemas/ReqRsAccountsImportIdentityFromString' examples: ReqRsAccountsImportIdentityFromString: value: data: ( string)certificate string responses: '200': description: > return: true on success, false otherwise pgpId(RsPgpId)storage for the PGP fingerprint of the imported key errorMsg(string)storage for eventual human readable error message content: application/json: schema: type: string components: responses: UnauthorizedError: description: Authentication information is missing or invalid headers: WWW_Authenticate: schema: type: string securitySchemes: BasicAuth: # <-- arbitrary name for the security scheme type: http scheme: basic schemas: ReqRsGxsForumsCreateForum: type: object properties: forum: $ref: '#/components/schemas/RsGxsForumGroup' ReqRsGxsForumsCreateMessage: type: object properties: message: $ref: '#/components/schemas/RsGxsForumMsg' ReqRsGxsForumsEditForum: type: object properties: forum: $ref: '#/components/schemas/RsGxsForumGroup' ReqRsGxsForumsGetForumContent: type: object properties: forumId: $ref: '#/components/schemas/RsGxsGroupId' msgsIds: type: array items: $ref: '#/components/schemas/RsGxsMessageId' ReqRsGxsForumsGetForumMsgMetaData: type: object properties: forumId: $ref: '#/components/schemas/RsGxsGroupId' ReqRsGxsForumsGetForumsInfo: type: object properties: forumIds: type: array items: $ref: '#/components/schemas/RsGxsGroupId' ReqRsGxsForumsMarkRead: type: object properties: messageId: $ref: '#/components/schemas/RsGxsGrpMsgIdPair' read: type: boolean ReqRsGxsForumsRequestStatus: type: object properties: token: type: integer ReqRsGxsForumsSubscribeToForum: type: object properties: forumId: $ref: '#/components/schemas/RsGxsGroupId' subscribe: type: boolean ReqRsReputationsBanNode: type: object properties: id: $ref: '#/components/schemas/RsPgpId' b: type: boolean ReqRsReputationsGetOwnOpinion: type: object properties: id: $ref: '#/components/schemas/RsGxsId' ReqRsReputationsGetReputationInfo: type: object properties: id: $ref: '#/components/schemas/RsGxsId' ownerNode: $ref: '#/components/schemas/RsPgpId' stamp: type: boolean ReqRsReputationsIsIdentityBanned: type: object properties: id: $ref: '#/components/schemas/RsGxsId' ReqRsReputationsIsNodeBanned: type: object properties: id: $ref: '#/components/schemas/RsPgpId' ReqRsReputationsOverallReputationLevel: type: object properties: id: $ref: '#/components/schemas/RsGxsId' ReqRsReputationsSetAutoPositiveOpinionForContacts: type: object properties: b: type: boolean ReqRsReputationsSetOwnOpinion: type: object properties: id: $ref: '#/components/schemas/RsGxsId' op: $ref: '#/components/schemas/RsOpinion' ReqRsReputationsSetRememberBannedIdThreshold: type: object properties: days: type: integer ReqRsReputationsSetThresholdForRemotelyNegativeReputation: type: object properties: thresh: type: integer ReqRsReputationsSetThresholdForRemotelyPositiveReputation: type: object properties: thresh: type: integer ReqRsServiceControlGetPeersConnected: type: object properties: serviceId: type: integer ReqRsServiceControlGetServiceItemNames: type: object properties: serviceId: type: integer ReqRsServiceControlGetServiceName: type: object properties: serviceId: type: integer ReqRsServiceControlGetServicePermissions: type: object properties: serviceId: type: integer ReqRsServiceControlGetServicesAllowed: type: object properties: peerId: $ref: '#/components/schemas/RsPeerId' ReqRsServiceControlGetServicesProvided: type: object properties: peerId: $ref: '#/components/schemas/RsPeerId' ReqRsServiceControlUpdateServicePermissions: type: object properties: serviceId: type: integer permissions: $ref: '#/components/schemas/RsServicePermissions' ReqJsonApiServerAuthorizeToken: type: object properties: token: type: string ReqJsonApiServerDecodeToken: type: object properties: token: type: string ReqJsonApiServerEncondeToken: type: object properties: token: type: string ReqJsonApiServerIsAuthTokenValid: type: object properties: token: type: string ReqJsonApiServerRequestNewTokenAutorization: type: object properties: token: type: string ReqJsonApiServerRevokeAuthToken: type: object properties: token: type: string ReqRsIdentityCreateIdentity: type: object properties: name: type: string avatar: $ref: '#/components/schemas/RsGxsImage' pseudonimous: type: boolean pgpPassword: type: string ReqRsIdentityDeleteIdentity: type: object properties: id: $ref: '#/components/schemas/RsGxsId' ReqRsIdentityGetIdentitiesInfo: type: object properties: ids: type: array items: $ref: '#/components/schemas/RsGxsId' ReqRsIdentityGetLastUsageTS: type: object properties: id: $ref: '#/components/schemas/RsGxsId' ReqRsIdentityIdentityFromBase64: type: object properties: base64String: type: string ReqRsIdentityIdentityToBase64: type: object properties: id: $ref: '#/components/schemas/RsGxsId' ReqRsIdentityIsARegularContact: type: object properties: id: $ref: '#/components/schemas/RsGxsId' ReqRsIdentityIsOwnId: type: object properties: id: $ref: '#/components/schemas/RsGxsId' ReqRsIdentityRequestStatus: type: object properties: token: type: integer ReqRsIdentitySetAutoAddFriendIdsAsContact: type: object properties: enabled: type: boolean ReqRsIdentitySetDeleteBannedNodesThreshold: type: object properties: days: type: integer ReqRsIdentityUpdateIdentity: type: object properties: identityData: $ref: '#/components/schemas/RsGxsIdGroup' ReqRsGossipDiscoveryGetDiscFriends: type: object properties: id: $ref: '#/components/schemas/RsPeerId' ReqRsGossipDiscoveryGetDiscPgpFriends: type: object properties: pgpid: $ref: '#/components/schemas/RsPgpId' ReqRsGossipDiscoveryGetPeerVersion: type: object properties: id: $ref: '#/components/schemas/RsPeerId' ReqRsGossipDiscoveryRequestInvite: type: object properties: inviteId: $ref: '#/components/schemas/RsPeerId' toSslId: $ref: '#/components/schemas/RsPeerId' ReqRsGossipDiscoverySendInvite: type: object properties: inviteId: $ref: '#/components/schemas/RsPeerId' toSslId: $ref: '#/components/schemas/RsPeerId' ReqRsEventsRegisterEventsHandler: type: object properties: hId: $ref: '#/components/schemas/RsEventsHandlerId_t' ReqRsMsgsAcceptLobbyInvite: type: object properties: id: $ref: '#/components/schemas/ChatLobbyId' identity: $ref: '#/components/schemas/RsGxsId' ReqRsMsgsClearChatLobby: type: object properties: id: $ref: '#/components/schemas/ChatId' ReqRsMsgsCreateChatLobby: type: object properties: lobby_name: type: string lobby_identity: $ref: '#/components/schemas/RsGxsId' lobby_topic: type: string invited_friends: type: array items: $ref: '#/components/schemas/RsPeerId' lobby_privacy_type: $ref: '#/components/schemas/ChatLobbyFlags' ReqRsMsgsDenyLobbyInvite: type: object properties: id: $ref: '#/components/schemas/ChatLobbyId' ReqRsMsgsGetChatLobbyInfo: type: object properties: id: $ref: '#/components/schemas/ChatLobbyId' ReqRsMsgsGetCustomStateString: type: object properties: peer_id: $ref: '#/components/schemas/RsPeerId' ReqRsMsgsGetIdentityForChatLobby: type: object properties: lobby_id: $ref: '#/components/schemas/ChatLobbyId' ReqRsMsgsGetLobbyAutoSubscribe: type: object properties: lobby_id: $ref: '#/components/schemas/ChatLobbyId' ReqRsMsgsGetMaxMessageSecuritySize: type: object properties: type: type: integer ReqRsMsgsGetMessage: type: object properties: msgId: type: string ReqRsMsgsGetMessageTag: type: object properties: msgId: type: string ReqRsMsgsGetMsgParentId: type: object properties: msgId: type: string ReqRsMsgsInvitePeerToLobby: type: object properties: lobby_id: $ref: '#/components/schemas/ChatLobbyId' peer_id: $ref: '#/components/schemas/RsPeerId' ReqRsMsgsJoinVisibleChatLobby: type: object properties: lobby_id: $ref: '#/components/schemas/ChatLobbyId' own_id: $ref: '#/components/schemas/RsGxsId' ReqRsMsgsMessageDelete: type: object properties: msgId: type: string ReqRsMsgsMessageForwarded: type: object properties: msgId: type: string forwarded: type: boolean ReqRsMsgsMessageLoadEmbeddedImages: type: object properties: msgId: type: string load: type: boolean ReqRsMsgsMessageRead: type: object properties: msgId: type: string unreadByUser: type: boolean ReqRsMsgsMessageReplied: type: object properties: msgId: type: string replied: type: boolean ReqRsMsgsMessageSend: type: object properties: info: $ref: '#/components/schemas/Rs_Msgs_MessageInfo' ReqRsMsgsMessageStar: type: object properties: msgId: type: string mark: type: boolean ReqRsMsgsMessageToDraft: type: object properties: info: $ref: '#/components/schemas/Rs_Msgs_MessageInfo' msgParentId: type: string ReqRsMsgsMessageToTrash: type: object properties: msgId: type: string bTrash: type: boolean ReqRsMsgsRemoveMessageTagType: type: object properties: tagId: type: integer ReqRsMsgsSendChat: type: object properties: id: $ref: '#/components/schemas/ChatId' msg: type: string ReqRsMsgsSendLobbyStatusPeerLeaving: type: object properties: lobby_id: $ref: '#/components/schemas/ChatLobbyId' ReqRsMsgsSendStatusString: type: object properties: id: $ref: '#/components/schemas/ChatId' status_string: type: string ReqRsMsgsSetCustomStateString: type: object properties: status_string: type: string ReqRsMsgsSetDefaultIdentityForChatLobby: type: object properties: nick: $ref: '#/components/schemas/RsGxsId' ReqRsMsgsSetIdentityForChatLobby: type: object properties: lobby_id: $ref: '#/components/schemas/ChatLobbyId' nick: $ref: '#/components/schemas/RsGxsId' ReqRsMsgsSetLobbyAutoSubscribe: type: object properties: lobby_id: $ref: '#/components/schemas/ChatLobbyId' autoSubscribe: type: boolean ReqRsMsgsSetMessageTag: type: object properties: msgId: type: string tagId: type: integer set: type: boolean ReqRsMsgsSetMessageTagType: type: object properties: tagId: type: integer text: type: string rgb_color: type: integer ReqRsMsgsSystemMessage: type: object properties: title: type: string message: type: string systemFlag: type: integer ReqRsMsgsUnsubscribeChatLobby: type: object properties: lobby_id: $ref: '#/components/schemas/ChatLobbyId' ReqRsBanListEnableIPFiltering: type: object properties: enable: type: boolean ReqRsGxsCirclesCancelCircleMembership: type: object properties: ownGxsId: $ref: '#/components/schemas/RsGxsId' circleId: $ref: '#/components/schemas/RsGxsCircleId' ReqRsGxsCirclesCreateCircle: type: object properties: cData: $ref: '#/components/schemas/RsGxsCircleGroup' ReqRsGxsCirclesEditCircle: type: object properties: cData: $ref: '#/components/schemas/RsGxsCircleGroup' ReqRsGxsCirclesGetCircleDetails: type: object properties: id: $ref: '#/components/schemas/RsGxsCircleId' ReqRsGxsCirclesGetCircleExternalIdList: type: object properties: circleIds: type: array items: $ref: '#/components/schemas/RsGxsCircleId' ReqRsGxsCirclesGetCircleRequests: type: object properties: circleId: $ref: '#/components/schemas/RsGxsGroupId' ReqRsGxsCirclesGetCirclesInfo: type: object properties: circlesIds: type: array items: $ref: '#/components/schemas/RsGxsGroupId' ReqRsGxsCirclesInviteIdsToCircle: type: object properties: identities: type: array items: $ref: '#/components/schemas/RsGxsId' circleId: $ref: '#/components/schemas/RsGxsCircleId' ReqRsGxsCirclesRequestCircleMembership: type: object properties: ownGxsId: $ref: '#/components/schemas/RsGxsId' circleId: $ref: '#/components/schemas/RsGxsCircleId' ReqRsGxsCirclesRequestStatus: type: object properties: token: type: integer ReqRsGxsChannelsCreateChannel: type: object properties: channel: $ref: '#/components/schemas/RsGxsChannelGroup' ReqRsGxsChannelsCreateChannelV2: type: object properties: name: type: string description: type: string thumbnail: $ref: '#/components/schemas/RsGxsImage' authorId: $ref: '#/components/schemas/RsGxsId' circleType: $ref: '#/components/schemas/RsGxsCircleType' circleId: $ref: '#/components/schemas/RsGxsCircleId' ReqRsGxsChannelsCreateComment: type: object properties: comment: $ref: '#/components/schemas/RsGxsComment' ReqRsGxsChannelsCreateCommentV2: type: object properties: channelId: $ref: '#/components/schemas/RsGxsGroupId' threadId: $ref: '#/components/schemas/RsGxsMessageId' parentId: $ref: '#/components/schemas/RsGxsMessageId' authorId: $ref: '#/components/schemas/RsGxsId' comment: type: string ReqRsGxsChannelsCreatePost: type: object properties: post: $ref: '#/components/schemas/RsGxsChannelPost' ReqRsGxsChannelsCreatePostV2: type: object properties: channelId: $ref: '#/components/schemas/RsGxsGroupId' title: type: string mBody: type: string files: type: array items: $ref: '#/components/schemas/RsGxsFile' thumbnail: $ref: '#/components/schemas/RsGxsImage' origPostId: $ref: '#/components/schemas/RsGxsMessageId' ReqRsGxsChannelsCreateVote: type: object properties: vote: $ref: '#/components/schemas/RsGxsVote' ReqRsGxsChannelsCreateVoteV2: type: object properties: channelId: $ref: '#/components/schemas/RsGxsGroupId' postId: $ref: '#/components/schemas/RsGxsMessageId' commentId: $ref: '#/components/schemas/RsGxsMessageId' authorId: $ref: '#/components/schemas/RsGxsId' vote: $ref: '#/components/schemas/RsGxsVoteType' ReqRsGxsChannelsEditChannel: type: object properties: channel: $ref: '#/components/schemas/RsGxsChannelGroup' ReqRsGxsChannelsExtraFileHash: type: object properties: path: type: string ReqRsGxsChannelsExtraFileRemove: type: object properties: hash: $ref: '#/components/schemas/RsFileHash' ReqRsGxsChannelsGetChannelAutoDownload: type: object properties: channelId: $ref: '#/components/schemas/RsGxsGroupId' ReqRsGxsChannelsGetChannelContent: type: object properties: channelId: $ref: '#/components/schemas/RsGxsGroupId' contentsIds: type: array items: $ref: '#/components/schemas/RsGxsMessageId' ReqRsGxsChannelsGetChannelDownloadDirectory: type: object properties: channelId: $ref: '#/components/schemas/RsGxsGroupId' ReqRsGxsChannelsGetChannelsInfo: type: object properties: chanIds: type: array items: $ref: '#/components/schemas/RsGxsGroupId' ReqRsGxsChannelsGetContentSummaries: type: object properties: channelId: $ref: '#/components/schemas/RsGxsGroupId' ReqRsGxsChannelsLocalSearchRequest: type: object properties: matchString: type: string maxWait: $ref: '#/components/schemas/rstime_t' ReqRsGxsChannelsMarkRead: type: object properties: postId: $ref: '#/components/schemas/RsGxsGrpMsgIdPair' read: type: boolean ReqRsGxsChannelsRequestStatus: type: object properties: token: type: integer ReqRsGxsChannelsSetChannelAutoDownload: type: object properties: channelId: $ref: '#/components/schemas/RsGxsGroupId' enable: type: boolean ReqRsGxsChannelsSetChannelDownloadDirectory: type: object properties: channelId: $ref: '#/components/schemas/RsGxsGroupId' directory: type: string ReqRsGxsChannelsShareChannelKeys: type: object properties: channelId: $ref: '#/components/schemas/RsGxsGroupId' peers: type: array items: $ref: '#/components/schemas/RsPeerId' ReqRsGxsChannelsSubscribeToChannel: type: object properties: channelId: $ref: '#/components/schemas/RsGxsGroupId' subscribe: type: boolean ReqRsGxsChannelsTurtleChannelRequest: type: object properties: channelId: $ref: '#/components/schemas/RsGxsGroupId' maxWait: $ref: '#/components/schemas/rstime_t' ReqRsGxsChannelsTurtleSearchRequest: type: object properties: matchString: type: string maxWait: $ref: '#/components/schemas/rstime_t' ReqRsFilesAddSharedDirectory: type: object properties: dir: $ref: '#/components/schemas/SharedDirInfo' ReqRsFilesAlreadyHaveFile: type: object properties: hash: $ref: '#/components/schemas/RsFileHash' ReqRsFilesBanFile: type: object properties: realFileHash: $ref: '#/components/schemas/RsFileHash' filename: type: string fileSize: type: integer ReqRsFilesFileCancel: type: object properties: hash: $ref: '#/components/schemas/RsFileHash' ReqRsFilesFileControl: type: object properties: hash: $ref: '#/components/schemas/RsFileHash' flags: type: integer ReqRsFilesFileDetails: type: object properties: hash: $ref: '#/components/schemas/RsFileHash' hintflags: $ref: '#/components/schemas/FileSearchFlags' ReqRsFilesFileDownloadChunksDetails: type: object properties: hash: $ref: '#/components/schemas/RsFileHash' ReqRsFilesFileRequest: type: object properties: fileName: type: string hash: $ref: '#/components/schemas/RsFileHash' size: type: integer destPath: type: string flags: $ref: '#/components/schemas/TransferRequestFlags' srcIds: type: array items: $ref: '#/components/schemas/RsPeerId' ReqRsFilesFileUploadChunksDetails: type: object properties: hash: $ref: '#/components/schemas/RsFileHash' peer_id: $ref: '#/components/schemas/RsPeerId' ReqRsFilesGetFileData: type: object properties: hash: $ref: '#/components/schemas/RsFileHash' offset: type: integer requested_size: type: integer ReqRsFilesIsHashBanned: type: object properties: hash: $ref: '#/components/schemas/RsFileHash' ReqRsFilesRemoveSharedDirectory: type: object properties: dir: type: string ReqRsFilesRequestDirDetails: type: object properties: handle: type: integer flags: $ref: '#/components/schemas/FileSearchFlags' ReqRsFilesSetChunkStrategy: type: object properties: hash: $ref: '#/components/schemas/RsFileHash' newStrategy: $ref: '#/components/schemas/FileChunksInfo_ChunkStrategy' ReqRsFilesSetDefaultChunkStrategy: type: object properties: strategy: $ref: '#/components/schemas/FileChunksInfo_ChunkStrategy' ReqRsFilesSetDestinationDirectory: type: object properties: hash: $ref: '#/components/schemas/RsFileHash' newPath: type: string ReqRsFilesSetDestinationName: type: object properties: hash: $ref: '#/components/schemas/RsFileHash' newName: type: string ReqRsFilesSetDownloadDirectory: type: object properties: path: type: string ReqRsFilesSetFreeDiskSpaceLimit: type: object properties: minimumFreeMB: type: integer ReqRsFilesSetPartialsDirectory: type: object properties: path: type: string ReqRsFilesSetSharedDirectories: type: object properties: dirs: type: array items: $ref: '#/components/schemas/SharedDirInfo' ReqRsFilesTurtleSearchRequest: type: object properties: matchString: type: string maxWait: $ref: '#/components/schemas/rstime_t' ReqRsFilesUnbanFile: type: object properties: realFileHash: $ref: '#/components/schemas/RsFileHash' ReqRsFilesUpdateShareFlags: type: object properties: dir: $ref: '#/components/schemas/SharedDirInfo' ReqRsConfigSetMaxDataRates: type: object properties: downKb: type: integer upKb: type: integer ReqRsConfigSetOperatingMode: type: object properties: opMode: type: integer ReqRsPeersAcceptInvite: type: object properties: invite: type: string flags: $ref: '#/components/schemas/ServicePermissionFlags' ReqRsPeersAddFriend: type: object properties: sslId: $ref: '#/components/schemas/RsPeerId' gpgId: $ref: '#/components/schemas/RsPgpId' flags: $ref: '#/components/schemas/ServicePermissionFlags' ReqRsPeersAddGroup: type: object properties: groupInfo: $ref: '#/components/schemas/RsGroupInfo' ReqRsPeersAddPeerLocator: type: object properties: sslId: $ref: '#/components/schemas/RsPeerId' locator: $ref: '#/components/schemas/RsUrl' ReqRsPeersAssignPeersToGroup: type: object properties: groupId: $ref: '#/components/schemas/RsNodeGroupId' peerIds: type: array items: $ref: '#/components/schemas/RsPgpId' assign: type: boolean ReqRsPeersAssignPeerToGroup: type: object properties: groupId: $ref: '#/components/schemas/RsNodeGroupId' peerId: $ref: '#/components/schemas/RsPgpId' assign: type: boolean ReqRsPeersConnectAttempt: type: object properties: sslId: $ref: '#/components/schemas/RsPeerId' ReqRsPeersEditGroup: type: object properties: groupId: $ref: '#/components/schemas/RsNodeGroupId' groupInfo: $ref: '#/components/schemas/RsGroupInfo' ReqRsPeersGetGPGId: type: object properties: sslId: $ref: '#/components/schemas/RsPeerId' ReqRsPeersGetGroupInfo: type: object properties: groupId: $ref: '#/components/schemas/RsNodeGroupId' ReqRsPeersGetGroupInfoByName: type: object properties: groupName: type: string ReqRsPeersGetPeerDetails: type: object properties: sslId: $ref: '#/components/schemas/RsPeerId' ReqRsPeersGetPeersCount: type: object properties: countLocations: type: boolean ReqRsPeersGetRetroshareInvite: type: object properties: sslId: $ref: '#/components/schemas/RsPeerId' includeSignatures: type: boolean includeExtraLocators: type: boolean ReqRsPeersIsFriend: type: object properties: sslId: $ref: '#/components/schemas/RsPeerId' ReqRsPeersIsOnline: type: object properties: sslId: $ref: '#/components/schemas/RsPeerId' ReqRsPeersIsPgpFriend: type: object properties: pgpId: $ref: '#/components/schemas/RsPgpId' ReqRsPeersLoadCertificateFromString: type: object properties: cert: type: string ReqRsPeersLoadDetailsFromStringCert: type: object properties: cert: type: string ReqRsPeersRemoveFriend: type: object properties: pgpId: $ref: '#/components/schemas/RsPgpId' ReqRsPeersRemoveFriendLocation: type: object properties: sslId: $ref: '#/components/schemas/RsPeerId' ReqRsPeersRemoveGroup: type: object properties: groupId: $ref: '#/components/schemas/RsNodeGroupId' ReqRsPeersSetDynDNS: type: object properties: sslId: $ref: '#/components/schemas/RsPeerId' addr: type: string ReqRsPeersSetExtAddress: type: object properties: sslId: $ref: '#/components/schemas/RsPeerId' addr: type: string port: type: integer ReqRsPeersSetLocalAddress: type: object properties: sslId: $ref: '#/components/schemas/RsPeerId' addr: type: string port: type: integer ReqRsPeersSetNetworkMode: type: object properties: sslId: $ref: '#/components/schemas/RsPeerId' netMode: type: integer ReqRsPeersSetVisState: type: object properties: sslId: $ref: '#/components/schemas/RsPeerId' vsDisc: type: integer vsDht: type: integer ReqRsLoginHelperAttemptLogin: type: object properties: account: $ref: '#/components/schemas/RsPeerId' password: type: string ReqRsLoginHelperCollectEntropy: type: object properties: bytes: type: integer ReqRsLoginHelperCreateLocation: type: object properties: location: $ref: '#/components/schemas/RsLoginHelper_Location' password: type: string makeHidden: type: boolean makeAutoTor: type: boolean ReqRsAccountsExportIdentity: type: object properties: filePath: type: string pgpId: $ref: '#/components/schemas/RsPgpId' ReqRsAccountsExportIdentityToString: type: object properties: pgpId: $ref: '#/components/schemas/RsPgpId' includeSignatures: type: boolean ReqRsAccountsImportIdentity: type: object properties: filePath: type: string ReqRsAccountsImportIdentityFromString: type: object properties: data: type: string RsGxsForumGroup: type: object properties: mMeta: $ref: '#/components/schemas/RsGroupMetaData' mDescription: type: string mAdminList: $ref: '#/components/schemas/RsTlvGxsIdSet' mPinnedPosts: $ref: '#/components/schemas/RsTlvGxsMsgIdSet' RsGxsForumMsg: type: object properties: mMeta: $ref: '#/components/schemas/RsMsgMetaData' mMsg: type: string RsGxsGroupId: type: string RsGxsMessageId: type: string RsMsgMetaData: type: object properties: mGroupId: $ref: '#/components/schemas/RsGxsGroupId' mMsgId: $ref: '#/components/schemas/RsGxsMessageId' mThreadId: $ref: '#/components/schemas/RsGxsMessageId' mParentId: $ref: '#/components/schemas/RsGxsMessageId' mOrigMsgId: $ref: '#/components/schemas/RsGxsMessageId' mAuthorId: $ref: '#/components/schemas/RsGxsId' mMsgName: type: string mPublishTs: $ref: '#/components/schemas/rstime_t' mMsgFlags: type: integer mMsgStatus: type: integer mChildTs: $ref: '#/components/schemas/rstime_t' mServiceString: type: string RsGroupMetaData: type: object properties: mGroupId: $ref: '#/components/schemas/RsGxsGroupId' mGroupName: type: string mGroupFlags: type: integer mSignFlags: type: integer mPublishTs: $ref: '#/components/schemas/rstime_t' mAuthorId: $ref: '#/components/schemas/RsGxsId' mCircleId: $ref: '#/components/schemas/RsGxsCircleId' mCircleType: type: integer mAuthenFlags: type: integer mParentGrpId: $ref: '#/components/schemas/RsGxsGroupId' mSubscribeFlags: type: integer mPop: type: integer mVisibleMsgCount: type: integer mLastPost: $ref: '#/components/schemas/rstime_t' mGroupStatus: type: integer mServiceString: type: string mOriginator: $ref: '#/components/schemas/RsPeerId' mInternalCircle: $ref: '#/components/schemas/RsGxsCircleId' RsGxsGrpMsgIdPair: type: array items: anyOf: - $ref: '#/components/schemas/RsGxsGroupId' - $ref: '#/components/schemas/RsGxsMessageId' minItems: 2 maxItems: 2 RsPgpId: type: string RsGxsId: type: string RsOpinion: type: object properties: type: type: integer enum: - 0 - 1 - 2 x-enum-varnames: - NEGATIVE - NEUTRAL - POSITIVE RsReputationInfo: type: object properties: mOwnOpinion: $ref: '#/components/schemas/RsOpinion' mFriendsPositiveVotes: type: integer mFriendsNegativeVotes: type: integer mFriendAverageScore: type: number mOverallReputationLevel: $ref: '#/components/schemas/RsReputationLevel' RsPeerServiceInfo: type: object properties: mPeerId: $ref: '#/components/schemas/RsPeerId' mServiceList: type: array items: anyOf: - type: integer - $ref: '#/components/schemas/RsServiceInfo' minItems: 2 maxItems: 2 RsPeerId: type: string RsServicePermissions: type: object properties: mServiceId: type: integer mServiceName: type: string mDefaultAllowed: type: boolean mPeersAllowed: type: array items: $ref: '#/components/schemas/RsPeerId' mPeersDenied: type: array items: $ref: '#/components/schemas/RsPeerId' RsGxsImage: type: object properties: mSize: type: integer mData: type: integer RsGxsIdGroup: type: object properties: mMeta: $ref: '#/components/schemas/RsGroupMetaData' mPgpIdHash: $ref: '#/components/schemas/Sha1CheckSum' mPgpIdSign: type: string mRecognTags: type: array items: type: string mImage: $ref: '#/components/schemas/RsGxsImage' mLastUsageTS: $ref: '#/components/schemas/rstime_t' mPgpKnown: type: boolean mIsAContact: type: boolean mPgpId: $ref: '#/components/schemas/RsPgpId' mReputation: $ref: '#/components/schemas/GxsReputation' RsEvent: type: object properties: mType: $ref: '#/components/schemas/RsEventType' mTimePoint: type: integer RsEventsHandlerId_t: type: integer ChatLobbyId: type: integer ChatId: type: object properties: broadcast_status_peer_id: $ref: '#/components/schemas/RsPeerId' ChatLobbyFlags: type: integer ChatLobbyInfo: type: object properties: lobby_id: $ref: '#/components/schemas/ChatLobbyId' lobby_name: type: string lobby_topic: type: string participating_friends: type: array items: $ref: '#/components/schemas/RsPeerId' gxs_id: $ref: '#/components/schemas/RsGxsId' lobby_flags: $ref: '#/components/schemas/ChatLobbyFlags' gxs_ids: type: array items: anyOf: - $ref: '#/components/schemas/RsGxsId' - $ref: '#/components/schemas/rstime_t' minItems: 2 maxItems: 2 last_activity: $ref: '#/components/schemas/rstime_t' VisibleChatLobbyRecord: type: object properties: lobby_id: $ref: '#/components/schemas/ChatLobbyId' lobby_name: type: string lobby_topic: type: string participating_friends: type: array items: $ref: '#/components/schemas/RsPeerId' total_number_of_peers: type: integer last_report_time: $ref: '#/components/schemas/rstime_t' lobby_flags: $ref: '#/components/schemas/ChatLobbyFlags' Rs_Msgs_MessageInfo: type: object properties: msgId: type: string rspeerid_srcId: $ref: '#/components/schemas/RsPeerId' rsgxsid_srcId: $ref: '#/components/schemas/RsGxsId' msgflags: type: integer rspeerid_msgto: type: array items: $ref: '#/components/schemas/RsPeerId' rspeerid_msgcc: type: array items: $ref: '#/components/schemas/RsPeerId' rspeerid_msgbcc: type: array items: $ref: '#/components/schemas/RsPeerId' rsgxsid_msgto: type: array items: $ref: '#/components/schemas/RsGxsId' rsgxsid_msgcc: type: array items: $ref: '#/components/schemas/RsGxsId' rsgxsid_msgbcc: type: array items: $ref: '#/components/schemas/RsGxsId' title: type: string msg: type: string attach_title: type: string attach_comment: type: string files: type: array items: $ref: '#/components/schemas/FileInfo' size: type: integer count: type: integer ts: type: integer Rs_Msgs_MsgInfoSummary: type: object properties: msgId: $ref: '#/components/schemas/RsMailMessageId' srcId: $ref: '#/components/schemas/RsPeerId' msgflags: type: integer msgtags: type: array items: type: integer title: type: string count: type: integer ts: $ref: '#/components/schemas/rstime_t' Rs_Msgs_MsgTagInfo: type: object properties: msgId: type: string tagIds: type: array items: type: integer Rs_Msgs_MsgTagType: type: object properties: types: type: array items: anyOf: - type: integer - type: array items: anyOf: - type: string - type: integer minItems: 2 maxItems: 2 minItems: 2 maxItems: 2 ChatLobbyInvite: type: object properties: lobby_id: $ref: '#/components/schemas/ChatLobbyId' peer_id: $ref: '#/components/schemas/RsPeerId' lobby_name: type: string lobby_topic: type: string lobby_flags: $ref: '#/components/schemas/ChatLobbyFlags' RsGxsCircleId: type: string RsGxsCircleGroup: type: object properties: mMeta: $ref: '#/components/schemas/RsGroupMetaData' mLocalFriends: type: array items: $ref: '#/components/schemas/RsPgpId' mInvitedMembers: type: array items: $ref: '#/components/schemas/RsGxsId' mSubCircles: type: array items: $ref: '#/components/schemas/RsGxsCircleId' RsGxsCircleDetails: type: object properties: mCircleId: $ref: '#/components/schemas/RsGxsCircleId' mCircleName: type: string mCircleType: type: integer mRestrictedCircleId: $ref: '#/components/schemas/RsGxsCircleId' mAmIAllowed: type: boolean mAllowedGxsIds: type: array items: $ref: '#/components/schemas/RsGxsId' mAllowedNodes: type: array items: $ref: '#/components/schemas/RsPgpId' mSubscriptionFlags: type: array items: anyOf: - $ref: '#/components/schemas/RsGxsId' - type: integer minItems: 2 maxItems: 2 RsGxsCircleMsg: type: object properties: mMeta: $ref: '#/components/schemas/RsMsgMetaData' stuff: type: string RsGxsChannelGroup: type: object properties: mMeta: $ref: '#/components/schemas/RsGroupMetaData' mDescription: type: string mImage: $ref: '#/components/schemas/RsGxsImage' mAutoDownload: type: boolean RsGxsCircleType: type: object properties: type: type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 x-enum-varnames: - UNKNOWN - PUBLIC - EXTERNAL - NODES_GROUP - LOCAL - EXT_SELF - YOUR_EYES_ONLY RsGxsComment: type: object properties: mMeta: $ref: '#/components/schemas/RsMsgMetaData' mComment: type: string mUpVotes: type: integer mDownVotes: type: integer mScore: type: number mOwnVote: type: integer mVotes: type: array items: $ref: '#/components/schemas/RsGxsVote' RsGxsChannelPost: type: object properties: mMeta: $ref: '#/components/schemas/RsMsgMetaData' mOlderVersions: type: array items: $ref: '#/components/schemas/RsGxsMessageId' mMsg: type: string mFiles: type: array items: $ref: '#/components/schemas/RsGxsFile' mCount: type: integer mSize: type: integer mThumbnail: $ref: '#/components/schemas/RsGxsImage' RsGxsFile: type: object properties: mName: type: string mHash: $ref: '#/components/schemas/RsFileHash' mSize: type: integer RsGxsVote: type: object properties: mMeta: $ref: '#/components/schemas/RsMsgMetaData' mVoteType: type: integer RsGxsVoteType: type: object properties: type: type: integer enum: - 0 - 1 - 2 x-enum-varnames: - NONE - DOWN - UP RsFileHash: type: string RsGxsGroupSummary: type: object properties: mGroupId: $ref: '#/components/schemas/RsGxsGroupId' mGroupName: type: string mAuthorId: $ref: '#/components/schemas/RsGxsId' mPublishTs: $ref: '#/components/schemas/rstime_t' mNumberOfMessages: type: integer mLastMessageTs: $ref: '#/components/schemas/rstime_t' mSignFlags: type: integer mPopularity: type: integer mSearchContext: type: string rstime_t: type: integer SharedDirInfo: type: object properties: filename: type: string virtualname: type: string shareflags: $ref: '#/components/schemas/FileStorageFlags' parent_groups: type: array items: $ref: '#/components/schemas/RsNodeGroupId' FileInfo: type: object properties: storage_permission_flags: $ref: '#/components/schemas/FileStorageFlags' transfer_info_flags: $ref: '#/components/schemas/TransferRequestFlags' mId: type: integer searchId: type: integer path: type: string fname: type: string hash: $ref: '#/components/schemas/RsFileHash' ext: type: string size: type: integer avail: type: integer rank: type: number age: type: integer queue_position: type: integer transfered: type: integer tfRate: type: number downloadStatus: type: integer peers: type: array items: $ref: '#/components/schemas/TransferInfo' priority: $ref: '#/components/schemas/DwlSpeed' lastTS: $ref: '#/components/schemas/rstime_t' parent_groups: type: array items: $ref: '#/components/schemas/RsNodeGroupId' FileSearchFlags: type: integer FileChunksInfo: type: object properties: file_size: type: integer chunk_size: type: integer strategy: $ref: '#/components/schemas/FileChunksInfo_ChunkStrategy' chunks: type: array items: $ref: '#/components/schemas/ChunkState' compressed_peer_availability_maps: type: array items: anyOf: - $ref: '#/components/schemas/RsPeerId' - $ref: '#/components/schemas/CompressedChunkMap' minItems: 2 maxItems: 2 active_chunks: type: array items: type: array items: anyOf: - type: integer - type: integer minItems: 2 maxItems: 2 pending_slices: type: array items: anyOf: - type: integer - type: array items: $ref: '#/components/schemas/SliceInfo' minItems: 2 maxItems: 2 TransferRequestFlags: type: integer CompressedChunkMap: type: object properties: _map: type: array items: type: integer DirDetails: type: object properties: parent: type: integer prow: type: integer ref: type: integer type: type: integer id: $ref: '#/components/schemas/RsPeerId' name: type: string hash: $ref: '#/components/schemas/RsFileHash' path: type: string count: type: integer mtime: type: integer flags: $ref: '#/components/schemas/FileStorageFlags' max_mtime: type: integer children: type: array items: $ref: '#/components/schemas/DirStub' parent_groups: type: array items: $ref: '#/components/schemas/RsNodeGroupId' FileChunksInfo_ChunkStrategy: type: object properties: type: type: integer enum: - 0 - 1 - 2 x-enum-varnames: - CHUNK_STRATEGY_STREAMING - CHUNK_STRATEGY_RANDOM - CHUNK_STRATEGY_PROGRESSIVE TurtleFileInfo: type: object properties: size: type: integer hash: $ref: '#/components/schemas/RsFileHash' name: type: string RsConfigNetStatus: type: object properties: ownId: $ref: '#/components/schemas/RsPeerId' ownName: type: string localAddr: type: string localPort: type: integer extAddr: type: string extPort: type: integer extDynDns: type: string firewalled: type: boolean forwardPort: type: boolean DHTActive: type: boolean uPnPActive: type: boolean uPnPState: type: integer netLocalOk: type: boolean netUpnpOk: type: boolean netDhtOk: type: boolean netStunOk: type: boolean netExtAddressOk: type: boolean netDhtNetSize: type: integer netDhtRsNetSize: type: integer RsConfigDataRates: type: object properties: mRateIn: type: number mRateMaxIn: type: number mAllocIn: type: number mAllocTs: $ref: '#/components/schemas/rstime_t' mRateOut: type: number mRateMaxOut: type: number mAllowedOut: type: number mAllowedTs: $ref: '#/components/schemas/rstime_t' mQueueIn: type: integer mQueueOut: type: integer RSTrafficClue: type: object properties: TS: $ref: '#/components/schemas/rstime_t' size: type: integer priority: type: integer service_id: type: integer service_sub_id: type: integer peer_id: $ref: '#/components/schemas/RsPeerId' count: type: integer ServicePermissionFlags: type: integer RsGroupInfo: type: object properties: id: $ref: '#/components/schemas/RsNodeGroupId' name: type: string flag: type: integer peerIds: type: array items: $ref: '#/components/schemas/RsPgpId' RsUrl: type: object properties: schemeSeparator: type: string ipv6WrapOpen: type: string ipv6Separator: type: string ipv6WrapClose: type: string portSeparator: type: string pathSeparator: type: string querySeparator: type: string queryAssign: type: string queryFieldSep: type: string fragmentSeparator: type: string RsNodeGroupId: type: string RsPeerDetails: type: object properties: isOnlyGPGdetail: type: boolean id: $ref: '#/components/schemas/RsPeerId' gpg_id: $ref: '#/components/schemas/RsPgpId' name: type: string email: type: string location: type: string org: type: string issuer: $ref: '#/components/schemas/RsPgpId' fpr: $ref: '#/components/schemas/RsPgpFingerprint' authcode: type: string gpgSigners: type: array items: $ref: '#/components/schemas/RsPgpId' trustLvl: type: integer validLvl: type: integer ownsign: type: boolean hasSignedMe: type: boolean accept_connection: type: boolean service_perm_flags: $ref: '#/components/schemas/ServicePermissionFlags' state: type: integer actAsServer: type: boolean connectAddr: type: string connectPort: type: integer isHiddenNode: type: boolean hiddenNodeAddress: type: string hiddenNodePort: type: integer hiddenType: type: integer localAddr: type: string localPort: type: integer extAddr: type: string extPort: type: integer dyndns: type: string ipAddressList: type: array items: type: string netMode: type: integer vs_disc: type: integer vs_dht: type: integer lastConnect: type: integer lastUsed: type: integer connectState: type: integer connectStateString: type: string connectPeriod: type: integer foundDHT: type: boolean wasDeniedConnection: type: boolean deniedTS: $ref: '#/components/schemas/rstime_t' linkType: type: integer RsLoginHelper_Location: type: object properties: mLocationId: $ref: '#/components/schemas/RsPeerId' mPgpId: $ref: '#/components/schemas/RsPgpId' mLocationName: type: string mPpgName: type: string RsTlvGxsIdSet: type: string RsTlvGxsMsgIdSet: type: string RsReputationLevel: type: object properties: type: type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 x-enum-varnames: - LOCALLY_NEGATIVE - REMOTELY_NEGATIVE - NEUTRAL - REMOTELY_POSITIVE - LOCALLY_POSITIVE - UNKNOWN RsServiceInfo: type: object properties: mServiceName: type: string mServiceType: type: integer mVersionMajor: type: integer mVersionMinor: type: integer mMinVersionMajor: type: integer mMinVersionMinor: type: integer Sha1CheckSum: type: string GxsReputation: type: object properties: mOverallScore: type: integer mIdScore: type: integer mOwnOpinion: type: integer mPeerOpinion: type: integer RsEventType: type: object properties: type: type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 - 0 x-enum-varnames: - NONE - BROADCAST_DISCOVERY_PEER_FOUND - GOSSIP_DISCOVERY_INVITE_RECEIVED - AUTHSSL_CONNECTION_AUTENTICATION - REMOTE_PEER_REFUSED_CONNECTION - GXS_CHANGES - MAX FileStorageFlags: type: integer TransferInfo: type: object properties: peerId: $ref: '#/components/schemas/RsPeerId' name: type: string tfRate: type: number status: type: integer transfered: type: integer DwlSpeed: type: object properties: type: type: integer enum: - 0 - 1 - 2 x-enum-varnames: - SPEED_LOW - SPEED_NORMAL - SPEED_HIGH RsMailMessageId: type: string ChunkState: type: object properties: type: type: integer enum: - 0 - 1 - 2 - 3 x-enum-varnames: - CHUNK_OUTSTANDING - CHUNK_ACTIVE - CHUNK_DONE - CHUNK_CHECKING FileChunksInfo_SliceInfo: type: object properties: start: type: integer size: type: integer peer_id: $ref: '#/components/schemas/RsPeerId' DirStub: type: object properties: type: type: integer name: type: string ref: type: integer RsPgpFingerprint: type: string