DefaultApi.md 597 KB
Newer Older
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1 2 3 4 5 6
# openapi_client.DefaultApi

All URIs are relative to *http://127.0.0.1:9092*

Method | HTTP request | Description
------------- | ------------- | -------------
Joan Pascual Sana's avatar
Joan Pascual Sana committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
[**json_api_server_authorize_token**](DefaultApi.md#json_api_server_authorize_token) | **POST** /jsonApiServer/authorizeToken | Add new auth token to the authorized set
[**json_api_server_decode_token**](DefaultApi.md#json_api_server_decode_token) | **POST** /jsonApiServer/decodeToken | Get decoded version of the given encoded token
[**json_api_server_enconde_token**](DefaultApi.md#json_api_server_enconde_token) | **POST** /jsonApiServer/encondeToken | Get encoded version of the given decoded token
[**json_api_server_get_authorized_tokens**](DefaultApi.md#json_api_server_get_authorized_tokens) | **POST** /jsonApiServer/getAuthorizedTokens | Get uthorized tokens
[**json_api_server_is_auth_token_valid**](DefaultApi.md#json_api_server_is_auth_token_valid) | **POST** /jsonApiServer/isAuthTokenValid | Check if given JSON API auth token is authorized
[**json_api_server_request_new_token_autorization**](DefaultApi.md#json_api_server_request_new_token_autorization) | **POST** /jsonApiServer/requestNewTokenAutorization | 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.
[**json_api_server_revoke_auth_token**](DefaultApi.md#json_api_server_revoke_auth_token) | **POST** /jsonApiServer/revokeAuthToken | Revoke given auth token
[**json_api_server_version**](DefaultApi.md#json_api_server_version) | **POST** /jsonApiServer/version | Write version information to given paramethers
[**rs_accounts_export_identity**](DefaultApi.md#rs_accounts_export_identity) | **POST** /rsAccounts/ExportIdentity | Export full encrypted PGP identity to file
[**rs_accounts_export_identity_to_string**](DefaultApi.md#rs_accounts_export_identity_to_string) | **POST** /rsAccounts/exportIdentityToString | Export full encrypted PGP identity to string
[**rs_accounts_get_current_account_id**](DefaultApi.md#rs_accounts_get_current_account_id) | **POST** /rsAccounts/getCurrentAccountId | Get current account id. Beware that an account may be selected without actually logging in.
[**rs_accounts_get_pgp_logins**](DefaultApi.md#rs_accounts_get_pgp_logins) | **POST** /rsAccounts/GetPGPLogins | Get available PGP identities id list
[**rs_accounts_import_identity**](DefaultApi.md#rs_accounts_import_identity) | **POST** /rsAccounts/ImportIdentity | Import full encrypted PGP identity from file
[**rs_accounts_import_identity_from_string**](DefaultApi.md#rs_accounts_import_identity_from_string) | **POST** /rsAccounts/importIdentityFromString | Import full encrypted PGP identity from string
[**rs_ban_list_enable_ip_filtering**](DefaultApi.md#rs_ban_list_enable_ip_filtering) | **POST** /rsBanList/enableIPFiltering | Enable or disable IP filtering service
[**rs_ban_list_ip_filtering_enabled**](DefaultApi.md#rs_ban_list_ip_filtering_enabled) | **POST** /rsBanList/ipFilteringEnabled | Get ip filtering service status
[**rs_broadcast_discovery_get_discovered_peers**](DefaultApi.md#rs_broadcast_discovery_get_discovered_peers) | **POST** /rsBroadcastDiscovery/getDiscoveredPeers | Get potential peers that have been discovered up until now
[**rs_config_get_all_bandwidth_rates**](DefaultApi.md#rs_config_get_all_bandwidth_rates) | **POST** /rsConfig/getAllBandwidthRates | getAllBandwidthRates get the bandwidth rates for all peers
[**rs_config_get_config_net_status**](DefaultApi.md#rs_config_get_config_net_status) | **POST** /rsConfig/getConfigNetStatus | getConfigNetStatus return the net status
[**rs_config_get_current_data_rates**](DefaultApi.md#rs_config_get_current_data_rates) | **POST** /rsConfig/GetCurrentDataRates | GetCurrentDataRates get current upload and download rates
[**rs_config_get_max_data_rates**](DefaultApi.md#rs_config_get_max_data_rates) | **POST** /rsConfig/GetMaxDataRates | GetMaxDataRates get maximum upload and download rates
[**rs_config_get_operating_mode**](DefaultApi.md#rs_config_get_operating_mode) | **POST** /rsConfig/getOperatingMode | getOperatingMode get current operating mode
[**rs_config_get_total_bandwidth_rates**](DefaultApi.md#rs_config_get_total_bandwidth_rates) | **POST** /rsConfig/getTotalBandwidthRates | getTotalBandwidthRates returns the current bandwidths rates
[**rs_config_get_traffic_info**](DefaultApi.md#rs_config_get_traffic_info) | **POST** /rsConfig/getTrafficInfo | getTrafficInfo returns a list of all tracked traffic clues
[**rs_config_set_max_data_rates**](DefaultApi.md#rs_config_set_max_data_rates) | **POST** /rsConfig/SetMaxDataRates | SetMaxDataRates set maximum upload and download rates
[**rs_config_set_operating_mode**](DefaultApi.md#rs_config_set_operating_mode) | **POST** /rsConfig/setOperatingMode | setOperatingMode set the current oprating mode
[**rs_control_is_ready**](DefaultApi.md#rs_control_is_ready) | **POST** /rsControl/isReady | Check if core is fully ready, true only after
[**rs_control_rs_global_shut_down**](DefaultApi.md#rs_control_rs_global_shut_down) | **POST** /rsControl/rsGlobalShutDown | Turn off RetroShare
[**rs_events_register_events_handler**](DefaultApi.md#rs_events_register_events_handler) | **POST** /rsEvents/registerEventsHandler | 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.
[**rs_files_add_shared_directory**](DefaultApi.md#rs_files_add_shared_directory) | **POST** /rsFiles/addSharedDirectory | Add shared directory
[**rs_files_already_have_file**](DefaultApi.md#rs_files_already_have_file) | **POST** /rsFiles/alreadyHaveFile | Check if we already have a file
[**rs_files_ban_file**](DefaultApi.md#rs_files_ban_file) | **POST** /rsFiles/banFile | Ban unwanted file from being, searched and forwarded by this node
[**rs_files_default_chunk_strategy**](DefaultApi.md#rs_files_default_chunk_strategy) | **POST** /rsFiles/defaultChunkStrategy | Get default chunk strategy
Joan Pascual Sana's avatar
Joan Pascual Sana committed
40 41 42
[**rs_files_extra_file_hash**](DefaultApi.md#rs_files_extra_file_hash) | **POST** /rsFiles/ExtraFileHash | Add file to extra shared file list
[**rs_files_extra_file_remove**](DefaultApi.md#rs_files_extra_file_remove) | **POST** /rsFiles/ExtraFileRemove | Remove file from extra fila shared list
[**rs_files_extra_file_status**](DefaultApi.md#rs_files_extra_file_status) | **POST** /rsFiles/ExtraFileStatus | Get extra file information
Joan Pascual Sana's avatar
Joan Pascual Sana committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
[**rs_files_file_cancel**](DefaultApi.md#rs_files_file_cancel) | **POST** /rsFiles/FileCancel | Cancel file downloading
[**rs_files_file_clear_completed**](DefaultApi.md#rs_files_file_clear_completed) | **POST** /rsFiles/FileClearCompleted | Clear completed downloaded files list
[**rs_files_file_control**](DefaultApi.md#rs_files_file_control) | **POST** /rsFiles/FileControl | Controls file transfer
[**rs_files_file_details**](DefaultApi.md#rs_files_file_details) | **POST** /rsFiles/FileDetails | Get file details
[**rs_files_file_download_chunks_details**](DefaultApi.md#rs_files_file_download_chunks_details) | **POST** /rsFiles/FileDownloadChunksDetails | Get chunk details about the downloaded file with given hash.
[**rs_files_file_downloads**](DefaultApi.md#rs_files_file_downloads) | **POST** /rsFiles/FileDownloads | Get incoming files list
[**rs_files_file_request**](DefaultApi.md#rs_files_file_request) | **POST** /rsFiles/FileRequest | Initiate downloading of a file
[**rs_files_file_upload_chunks_details**](DefaultApi.md#rs_files_file_upload_chunks_details) | **POST** /rsFiles/FileUploadChunksDetails | Get details about the upload with given hash
[**rs_files_file_uploads**](DefaultApi.md#rs_files_file_uploads) | **POST** /rsFiles/FileUploads | Get outgoing files list
[**rs_files_force_directory_check**](DefaultApi.md#rs_files_force_directory_check) | **POST** /rsFiles/ForceDirectoryCheck | Force shared directories check
[**rs_files_free_disk_space_limit**](DefaultApi.md#rs_files_free_disk_space_limit) | **POST** /rsFiles/freeDiskSpaceLimit | Get free disk space limit
[**rs_files_get_download_directory**](DefaultApi.md#rs_files_get_download_directory) | **POST** /rsFiles/getDownloadDirectory | Get default complete downloads directory
[**rs_files_get_file_data**](DefaultApi.md#rs_files_get_file_data) | **POST** /rsFiles/getFileData | 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.
[**rs_files_get_partials_directory**](DefaultApi.md#rs_files_get_partials_directory) | **POST** /rsFiles/getPartialsDirectory | Get partial downloads directory
[**rs_files_get_primary_banned_files_list**](DefaultApi.md#rs_files_get_primary_banned_files_list) | **POST** /rsFiles/getPrimaryBannedFilesList | Get list of banned files
[**rs_files_get_shared_directories**](DefaultApi.md#rs_files_get_shared_directories) | **POST** /rsFiles/getSharedDirectories | Get list of current shared directories
[**rs_files_is_hash_banned**](DefaultApi.md#rs_files_is_hash_banned) | **POST** /rsFiles/isHashBanned | Check if a file is on banned list
[**rs_files_remove_shared_directory**](DefaultApi.md#rs_files_remove_shared_directory) | **POST** /rsFiles/removeSharedDirectory | Remove directory from shared list
[**rs_files_request_dir_details**](DefaultApi.md#rs_files_request_dir_details) | **POST** /rsFiles/requestDirDetails | Request directory details, subsequent multiple call may be used to explore a whole directory tree.
[**rs_files_set_chunk_strategy**](DefaultApi.md#rs_files_set_chunk_strategy) | **POST** /rsFiles/setChunkStrategy | 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
[**rs_files_set_default_chunk_strategy**](DefaultApi.md#rs_files_set_default_chunk_strategy) | **POST** /rsFiles/setDefaultChunkStrategy | Set default chunk strategy
[**rs_files_set_destination_directory**](DefaultApi.md#rs_files_set_destination_directory) | **POST** /rsFiles/setDestinationDirectory | Set destination directory for given file
[**rs_files_set_destination_name**](DefaultApi.md#rs_files_set_destination_name) | **POST** /rsFiles/setDestinationName | Set name for dowloaded file
[**rs_files_set_download_directory**](DefaultApi.md#rs_files_set_download_directory) | **POST** /rsFiles/setDownloadDirectory | Set default complete downloads directory
[**rs_files_set_free_disk_space_limit**](DefaultApi.md#rs_files_set_free_disk_space_limit) | **POST** /rsFiles/setFreeDiskSpaceLimit | Set minimum free disk space limit
[**rs_files_set_partials_directory**](DefaultApi.md#rs_files_set_partials_directory) | **POST** /rsFiles/setPartialsDirectory | Set partial downloads directory
[**rs_files_set_shared_directories**](DefaultApi.md#rs_files_set_shared_directories) | **POST** /rsFiles/setSharedDirectories | Set shared directories
[**rs_files_turtle_search_request**](DefaultApi.md#rs_files_turtle_search_request) | **POST** /rsFiles/turtleSearchRequest | This method is asynchronous. Request remote files search
[**rs_files_unban_file**](DefaultApi.md#rs_files_unban_file) | **POST** /rsFiles/unbanFile | Remove file from unwanted list
[**rs_files_update_share_flags**](DefaultApi.md#rs_files_update_share_flags) | **POST** /rsFiles/updateShareFlags | Updates shared directory sharing flags. The directory should be already shared!
[**rs_gossip_discovery_get_disc_friends**](DefaultApi.md#rs_gossip_discovery_get_disc_friends) | **POST** /rsGossipDiscovery/getDiscFriends | getDiscFriends get a list of all friends of a given friend
[**rs_gossip_discovery_get_disc_pgp_friends**](DefaultApi.md#rs_gossip_discovery_get_disc_pgp_friends) | **POST** /rsGossipDiscovery/getDiscPgpFriends | getDiscPgpFriends get a list of all friends of a given friend
[**rs_gossip_discovery_get_peer_version**](DefaultApi.md#rs_gossip_discovery_get_peer_version) | **POST** /rsGossipDiscovery/getPeerVersion | getPeerVersion get the version string of a peer.
[**rs_gossip_discovery_get_waiting_disc_count**](DefaultApi.md#rs_gossip_discovery_get_waiting_disc_count) | **POST** /rsGossipDiscovery/getWaitingDiscCount | getWaitingDiscCount get the number of queued discovery packets.
[**rs_gossip_discovery_request_invite**](DefaultApi.md#rs_gossip_discovery_request_invite) | **POST** /rsGossipDiscovery/requestInvite | Request RetroShare certificate to given peer
[**rs_gossip_discovery_send_invite**](DefaultApi.md#rs_gossip_discovery_send_invite) | **POST** /rsGossipDiscovery/sendInvite | Send RetroShare invite to given peer
[**rs_gxs_channels_create_channel**](DefaultApi.md#rs_gxs_channels_create_channel) | **POST** /rsGxsChannels/createChannel | Deprecated{ substituted by createChannelV2 }
[**rs_gxs_channels_create_channel_v2**](DefaultApi.md#rs_gxs_channels_create_channel_v2) | **POST** /rsGxsChannels/createChannelV2 | Create channel. Blocking API.
[**rs_gxs_channels_create_comment**](DefaultApi.md#rs_gxs_channels_create_comment) | **POST** /rsGxsChannels/createComment | Deprecated
[**rs_gxs_channels_create_comment_v2**](DefaultApi.md#rs_gxs_channels_create_comment_v2) | **POST** /rsGxsChannels/createCommentV2 | Add a comment on a post or on another comment. Blocking API.
[**rs_gxs_channels_create_post**](DefaultApi.md#rs_gxs_channels_create_post) | **POST** /rsGxsChannels/createPost | Deprecated
[**rs_gxs_channels_create_post_v2**](DefaultApi.md#rs_gxs_channels_create_post_v2) | **POST** /rsGxsChannels/createPostV2 | Create channel post. Blocking API.
[**rs_gxs_channels_create_vote**](DefaultApi.md#rs_gxs_channels_create_vote) | **POST** /rsGxsChannels/createVote | Deprecated
[**rs_gxs_channels_create_vote_v2**](DefaultApi.md#rs_gxs_channels_create_vote_v2) | **POST** /rsGxsChannels/createVoteV2 | Create a vote
[**rs_gxs_channels_edit_channel**](DefaultApi.md#rs_gxs_channels_edit_channel) | **POST** /rsGxsChannels/editChannel | Edit channel details.
[**rs_gxs_channels_extra_file_hash**](DefaultApi.md#rs_gxs_channels_extra_file_hash) | **POST** /rsGxsChannels/ExtraFileHash | Share extra file Can be used to share extra file attached to a channel post
[**rs_gxs_channels_extra_file_remove**](DefaultApi.md#rs_gxs_channels_extra_file_remove) | **POST** /rsGxsChannels/ExtraFileRemove | Remove extra file from shared files
[**rs_gxs_channels_get_channel_auto_download**](DefaultApi.md#rs_gxs_channels_get_channel_auto_download) | **POST** /rsGxsChannels/getChannelAutoDownload | Get auto-download option value for given channel
[**rs_gxs_channels_get_channel_content**](DefaultApi.md#rs_gxs_channels_get_channel_content) | **POST** /rsGxsChannels/getChannelContent | Get channel contents
[**rs_gxs_channels_get_channel_download_directory**](DefaultApi.md#rs_gxs_channels_get_channel_download_directory) | **POST** /rsGxsChannels/getChannelDownloadDirectory | Get download directory for the given channel
[**rs_gxs_channels_get_channels_info**](DefaultApi.md#rs_gxs_channels_get_channels_info) | **POST** /rsGxsChannels/getChannelsInfo | Get channels information (description, thumbnail...). Blocking API.
[**rs_gxs_channels_get_channels_summaries**](DefaultApi.md#rs_gxs_channels_get_channels_summaries) | **POST** /rsGxsChannels/getChannelsSummaries | Get channels summaries list. Blocking API.
[**rs_gxs_channels_get_content_summaries**](DefaultApi.md#rs_gxs_channels_get_content_summaries) | **POST** /rsGxsChannels/getContentSummaries | Get channel content summaries
[**rs_gxs_channels_local_search_request**](DefaultApi.md#rs_gxs_channels_local_search_request) | **POST** /rsGxsChannels/localSearchRequest | This method is asynchronous. Search local channels
[**rs_gxs_channels_mark_read**](DefaultApi.md#rs_gxs_channels_mark_read) | **POST** /rsGxsChannels/markRead | Toggle post read status. Blocking API.
[**rs_gxs_channels_request_status**](DefaultApi.md#rs_gxs_channels_request_status) | **POST** /rsGxsChannels/requestStatus | null
[**rs_gxs_channels_set_channel_auto_download**](DefaultApi.md#rs_gxs_channels_set_channel_auto_download) | **POST** /rsGxsChannels/setChannelAutoDownload | Enable or disable auto-download for given channel. Blocking API
[**rs_gxs_channels_set_channel_download_directory**](DefaultApi.md#rs_gxs_channels_set_channel_download_directory) | **POST** /rsGxsChannels/setChannelDownloadDirectory | Set download directory for the given channel. Blocking API.
[**rs_gxs_channels_share_channel_keys**](DefaultApi.md#rs_gxs_channels_share_channel_keys) | **POST** /rsGxsChannels/shareChannelKeys | Share channel publishing key This can be used to authorize other peers to post on the channel
[**rs_gxs_channels_subscribe_to_channel**](DefaultApi.md#rs_gxs_channels_subscribe_to_channel) | **POST** /rsGxsChannels/subscribeToChannel | Subscrbe to a channel. Blocking API
[**rs_gxs_channels_turtle_channel_request**](DefaultApi.md#rs_gxs_channels_turtle_channel_request) | **POST** /rsGxsChannels/turtleChannelRequest | This method is asynchronous. Request remote channel
[**rs_gxs_channels_turtle_search_request**](DefaultApi.md#rs_gxs_channels_turtle_search_request) | **POST** /rsGxsChannels/turtleSearchRequest | This method is asynchronous. Request remote channels search
[**rs_gxs_circles_cancel_circle_membership**](DefaultApi.md#rs_gxs_circles_cancel_circle_membership) | **POST** /rsGxsCircles/cancelCircleMembership | Leave given circle
[**rs_gxs_circles_create_circle**](DefaultApi.md#rs_gxs_circles_create_circle) | **POST** /rsGxsCircles/createCircle | Create new circle
[**rs_gxs_circles_edit_circle**](DefaultApi.md#rs_gxs_circles_edit_circle) | **POST** /rsGxsCircles/editCircle | Edit own existing circle
[**rs_gxs_circles_get_circle_details**](DefaultApi.md#rs_gxs_circles_get_circle_details) | **POST** /rsGxsCircles/getCircleDetails | Get circle details. Memory cached
[**rs_gxs_circles_get_circle_external_id_list**](DefaultApi.md#rs_gxs_circles_get_circle_external_id_list) | **POST** /rsGxsCircles/getCircleExternalIdList | Get list of known external circles ids. Memory cached
[**rs_gxs_circles_get_circle_requests**](DefaultApi.md#rs_gxs_circles_get_circle_requests) | **POST** /rsGxsCircles/getCircleRequests | Get circle requests
[**rs_gxs_circles_get_circles_info**](DefaultApi.md#rs_gxs_circles_get_circles_info) | **POST** /rsGxsCircles/getCirclesInfo | Get circles information
[**rs_gxs_circles_get_circles_summaries**](DefaultApi.md#rs_gxs_circles_get_circles_summaries) | **POST** /rsGxsCircles/getCirclesSummaries | Get circles summaries list.
[**rs_gxs_circles_invite_ids_to_circle**](DefaultApi.md#rs_gxs_circles_invite_ids_to_circle) | **POST** /rsGxsCircles/inviteIdsToCircle | Invite identities to circle
[**rs_gxs_circles_request_circle_membership**](DefaultApi.md#rs_gxs_circles_request_circle_membership) | **POST** /rsGxsCircles/requestCircleMembership | Request circle membership, or accept circle invitation
[**rs_gxs_circles_request_status**](DefaultApi.md#rs_gxs_circles_request_status) | **POST** /rsGxsCircles/requestStatus | null
Joan Pascual Sana's avatar
Joan Pascual Sana committed
116 117 118 119
[**rs_gxs_forums_create_forum**](DefaultApi.md#rs_gxs_forums_create_forum) | **POST** /rsGxsForums/createForum | Deprecated
[**rs_gxs_forums_create_forum_v2**](DefaultApi.md#rs_gxs_forums_create_forum_v2) | **POST** /rsGxsForums/createForumV2 | Create forum.
[**rs_gxs_forums_create_message**](DefaultApi.md#rs_gxs_forums_create_message) | **POST** /rsGxsForums/createMessage | Deprecated
[**rs_gxs_forums_create_post**](DefaultApi.md#rs_gxs_forums_create_post) | **POST** /rsGxsForums/createPost | Create a post on the given forum.
Joan Pascual Sana's avatar
Joan Pascual Sana committed
120 121 122 123 124 125 126 127 128 129 130 131
[**rs_gxs_forums_edit_forum**](DefaultApi.md#rs_gxs_forums_edit_forum) | **POST** /rsGxsForums/editForum | Edit forum details.
[**rs_gxs_forums_get_forum_content**](DefaultApi.md#rs_gxs_forums_get_forum_content) | **POST** /rsGxsForums/getForumContent | Get specific list of messages from a single forums. Blocking API
[**rs_gxs_forums_get_forum_msg_meta_data**](DefaultApi.md#rs_gxs_forums_get_forum_msg_meta_data) | **POST** /rsGxsForums/getForumMsgMetaData | Get message metadatas for a specific forum. Blocking API
[**rs_gxs_forums_get_forums_info**](DefaultApi.md#rs_gxs_forums_get_forums_info) | **POST** /rsGxsForums/getForumsInfo | Get forums information (description, thumbnail...). Blocking API.
[**rs_gxs_forums_get_forums_summaries**](DefaultApi.md#rs_gxs_forums_get_forums_summaries) | **POST** /rsGxsForums/getForumsSummaries | Get forums summaries list. Blocking API.
[**rs_gxs_forums_mark_read**](DefaultApi.md#rs_gxs_forums_mark_read) | **POST** /rsGxsForums/markRead | Toggle message read status. Blocking API.
[**rs_gxs_forums_request_status**](DefaultApi.md#rs_gxs_forums_request_status) | **POST** /rsGxsForums/requestStatus | null
[**rs_gxs_forums_subscribe_to_forum**](DefaultApi.md#rs_gxs_forums_subscribe_to_forum) | **POST** /rsGxsForums/subscribeToForum | Subscrbe to a forum. Blocking API
[**rs_identity_auto_add_friend_ids_as_contact**](DefaultApi.md#rs_identity_auto_add_friend_ids_as_contact) | **POST** /rsIdentity/autoAddFriendIdsAsContact | Check if automatic signed by friend identity contact flagging is enabled
[**rs_identity_create_identity**](DefaultApi.md#rs_identity_create_identity) | **POST** /rsIdentity/createIdentity | Create a new identity
[**rs_identity_delete_banned_nodes_threshold**](DefaultApi.md#rs_identity_delete_banned_nodes_threshold) | **POST** /rsIdentity/deleteBannedNodesThreshold | Get number of days after which delete a banned identities
[**rs_identity_delete_identity**](DefaultApi.md#rs_identity_delete_identity) | **POST** /rsIdentity/deleteIdentity | Locally delete given identity
Joan Pascual Sana's avatar
Joan Pascual Sana committed
132
[**rs_identity_get_id_details**](DefaultApi.md#rs_identity_get_id_details) | **POST** /rsIdentity/getIdDetails | Get identity details, from the cache
Joan Pascual Sana's avatar
Joan Pascual Sana committed
133 134 135 136 137 138 139 140 141
[**rs_identity_get_identities_info**](DefaultApi.md#rs_identity_get_identities_info) | **POST** /rsIdentity/getIdentitiesInfo | Get identities information (name, avatar...). Blocking API.
[**rs_identity_get_identities_summaries**](DefaultApi.md#rs_identity_get_identities_summaries) | **POST** /rsIdentity/getIdentitiesSummaries | Get identities summaries list.
[**rs_identity_get_last_usage_ts**](DefaultApi.md#rs_identity_get_last_usage_ts) | **POST** /rsIdentity/getLastUsageTS | Get last seen usage time of given identity
[**rs_identity_get_own_pseudonimous_ids**](DefaultApi.md#rs_identity_get_own_pseudonimous_ids) | **POST** /rsIdentity/getOwnPseudonimousIds | Get own pseudonimous (unsigned) ids
[**rs_identity_get_own_signed_ids**](DefaultApi.md#rs_identity_get_own_signed_ids) | **POST** /rsIdentity/getOwnSignedIds | Get own signed ids
[**rs_identity_identity_from_base64**](DefaultApi.md#rs_identity_identity_from_base64) | **POST** /rsIdentity/identityFromBase64 | Import identity from base64 representation
[**rs_identity_identity_to_base64**](DefaultApi.md#rs_identity_identity_to_base64) | **POST** /rsIdentity/identityToBase64 | Get base64 representation of an identity
[**rs_identity_is_a_regular_contact**](DefaultApi.md#rs_identity_is_a_regular_contact) | **POST** /rsIdentity/isARegularContact | Check if an identity is contact
[**rs_identity_is_own_id**](DefaultApi.md#rs_identity_is_own_id) | **POST** /rsIdentity/isOwnId | Check if an id is own
Joan Pascual Sana's avatar
Joan Pascual Sana committed
142
[**rs_identity_request_identity**](DefaultApi.md#rs_identity_request_identity) | **POST** /rsIdentity/requestIdentity | request details of a not yet known identity to the network
Joan Pascual Sana's avatar
Joan Pascual Sana committed
143
[**rs_identity_request_status**](DefaultApi.md#rs_identity_request_status) | **POST** /rsIdentity/requestStatus | null
Joan Pascual Sana's avatar
Joan Pascual Sana committed
144
[**rs_identity_set_as_regular_contact**](DefaultApi.md#rs_identity_set_as_regular_contact) | **POST** /rsIdentity/setAsRegularContact | Set/unset identity as contact
Joan Pascual Sana's avatar
Joan Pascual Sana committed
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
[**rs_identity_set_auto_add_friend_ids_as_contact**](DefaultApi.md#rs_identity_set_auto_add_friend_ids_as_contact) | **POST** /rsIdentity/setAutoAddFriendIdsAsContact | Toggle automatic flagging signed by friends identity as contact
[**rs_identity_set_delete_banned_nodes_threshold**](DefaultApi.md#rs_identity_set_delete_banned_nodes_threshold) | **POST** /rsIdentity/setDeleteBannedNodesThreshold | Set number of days after which delete a banned identities
[**rs_identity_update_identity**](DefaultApi.md#rs_identity_update_identity) | **POST** /rsIdentity/updateIdentity | Update identity data (name, avatar...)
[**rs_login_helper_attempt_login**](DefaultApi.md#rs_login_helper_attempt_login) | **POST** /rsLoginHelper/attemptLogin | Normal way to attempt login
[**rs_login_helper_collect_entropy**](DefaultApi.md#rs_login_helper_collect_entropy) | **POST** /rsLoginHelper/collectEntropy | Feed extra entropy to the crypto libraries
[**rs_login_helper_create_location**](DefaultApi.md#rs_login_helper_create_location) | **POST** /rsLoginHelper/createLocation | Creates a new RetroShare location, and log in once is created
[**rs_login_helper_get_locations**](DefaultApi.md#rs_login_helper_get_locations) | **POST** /rsLoginHelper/getLocations | Get locations and associated information
[**rs_login_helper_is_logged_in**](DefaultApi.md#rs_login_helper_is_logged_in) | **POST** /rsLoginHelper/isLoggedIn | Check if RetroShare is already logged in, this usually return true after a successfull
[**rs_msgs_accept_lobby_invite**](DefaultApi.md#rs_msgs_accept_lobby_invite) | **POST** /rsMsgs/acceptLobbyInvite | acceptLobbyInvite accept a chat invite
[**rs_msgs_clear_chat_lobby**](DefaultApi.md#rs_msgs_clear_chat_lobby) | **POST** /rsMsgs/clearChatLobby | clearChatLobby clear a chat lobby
[**rs_msgs_create_chat_lobby**](DefaultApi.md#rs_msgs_create_chat_lobby) | **POST** /rsMsgs/createChatLobby | createChatLobby create a new chat lobby
[**rs_msgs_deny_lobby_invite**](DefaultApi.md#rs_msgs_deny_lobby_invite) | **POST** /rsMsgs/denyLobbyInvite | denyLobbyInvite deny a chat lobby invite
[**rs_msgs_get_chat_lobby_info**](DefaultApi.md#rs_msgs_get_chat_lobby_info) | **POST** /rsMsgs/getChatLobbyInfo | getChatLobbyInfo get lobby info of a subscribed chat lobby. Returns true if lobby id is valid.
[**rs_msgs_get_chat_lobby_list**](DefaultApi.md#rs_msgs_get_chat_lobby_list) | **POST** /rsMsgs/getChatLobbyList | getChatLobbyList get ids of subscribed lobbies
[**rs_msgs_get_custom_state_string**](DefaultApi.md#rs_msgs_get_custom_state_string) | **POST** /rsMsgs/getCustomStateString | getCustomStateString get the custom status message from a peer
[**rs_msgs_get_default_identity_for_chat_lobby**](DefaultApi.md#rs_msgs_get_default_identity_for_chat_lobby) | **POST** /rsMsgs/getDefaultIdentityForChatLobby | getDefaultIdentityForChatLobby get the default identity used for chat lobbies
[**rs_msgs_get_identity_for_chat_lobby**](DefaultApi.md#rs_msgs_get_identity_for_chat_lobby) | **POST** /rsMsgs/getIdentityForChatLobby | getIdentityForChatLobby
[**rs_msgs_get_list_of_nearby_chat_lobbies**](DefaultApi.md#rs_msgs_get_list_of_nearby_chat_lobbies) | **POST** /rsMsgs/getListOfNearbyChatLobbies | getListOfNearbyChatLobbies get info about all lobbies, subscribed and unsubscribed
[**rs_msgs_get_lobby_auto_subscribe**](DefaultApi.md#rs_msgs_get_lobby_auto_subscribe) | **POST** /rsMsgs/getLobbyAutoSubscribe | getLobbyAutoSubscribe get current value of auto subscribe
[**rs_msgs_get_max_message_security_size**](DefaultApi.md#rs_msgs_get_max_message_security_size) | **POST** /rsMsgs/getMaxMessageSecuritySize | getMaxMessageSecuritySize get the maximum size of a chta message
[**rs_msgs_get_message**](DefaultApi.md#rs_msgs_get_message) | **POST** /rsMsgs/getMessage | getMessage
[**rs_msgs_get_message_count**](DefaultApi.md#rs_msgs_get_message_count) | **POST** /rsMsgs/getMessageCount | getMessageCount
[**rs_msgs_get_message_summaries**](DefaultApi.md#rs_msgs_get_message_summaries) | **POST** /rsMsgs/getMessageSummaries | getMessageSummaries
[**rs_msgs_get_message_tag**](DefaultApi.md#rs_msgs_get_message_tag) | **POST** /rsMsgs/getMessageTag | getMessageTag
[**rs_msgs_get_message_tag_types**](DefaultApi.md#rs_msgs_get_message_tag_types) | **POST** /rsMsgs/getMessageTagTypes | getMessageTagTypes
[**rs_msgs_get_msg_parent_id**](DefaultApi.md#rs_msgs_get_msg_parent_id) | **POST** /rsMsgs/getMsgParentId | getMsgParentId
[**rs_msgs_get_pending_chat_lobby_invites**](DefaultApi.md#rs_msgs_get_pending_chat_lobby_invites) | **POST** /rsMsgs/getPendingChatLobbyInvites | getPendingChatLobbyInvites get a list of all pending chat lobby invites
[**rs_msgs_invite_peer_to_lobby**](DefaultApi.md#rs_msgs_invite_peer_to_lobby) | **POST** /rsMsgs/invitePeerToLobby | invitePeerToLobby invite a peer to join a lobby
[**rs_msgs_join_visible_chat_lobby**](DefaultApi.md#rs_msgs_join_visible_chat_lobby) | **POST** /rsMsgs/joinVisibleChatLobby | joinVisibleChatLobby join a lobby that is visible
[**rs_msgs_message_delete**](DefaultApi.md#rs_msgs_message_delete) | **POST** /rsMsgs/MessageDelete | MessageDelete
[**rs_msgs_message_forwarded**](DefaultApi.md#rs_msgs_message_forwarded) | **POST** /rsMsgs/MessageForwarded | MessageForwarded
[**rs_msgs_message_load_embedded_images**](DefaultApi.md#rs_msgs_message_load_embedded_images) | **POST** /rsMsgs/MessageLoadEmbeddedImages | MessageLoadEmbeddedImages
[**rs_msgs_message_read**](DefaultApi.md#rs_msgs_message_read) | **POST** /rsMsgs/MessageRead | MessageRead
[**rs_msgs_message_replied**](DefaultApi.md#rs_msgs_message_replied) | **POST** /rsMsgs/MessageReplied | MessageReplied
[**rs_msgs_message_send**](DefaultApi.md#rs_msgs_message_send) | **POST** /rsMsgs/MessageSend | MessageSend
[**rs_msgs_message_star**](DefaultApi.md#rs_msgs_message_star) | **POST** /rsMsgs/MessageStar | MessageStar
[**rs_msgs_message_to_draft**](DefaultApi.md#rs_msgs_message_to_draft) | **POST** /rsMsgs/MessageToDraft | MessageToDraft
[**rs_msgs_message_to_trash**](DefaultApi.md#rs_msgs_message_to_trash) | **POST** /rsMsgs/MessageToTrash | MessageToTrash
[**rs_msgs_remove_message_tag_type**](DefaultApi.md#rs_msgs_remove_message_tag_type) | **POST** /rsMsgs/removeMessageTagType | removeMessageTagType
[**rs_msgs_reset_message_standard_tag_types**](DefaultApi.md#rs_msgs_reset_message_standard_tag_types) | **POST** /rsMsgs/resetMessageStandardTagTypes | resetMessageStandardTagTypes
[**rs_msgs_send_chat**](DefaultApi.md#rs_msgs_send_chat) | **POST** /rsMsgs/sendChat | sendChat send a chat message to a given id
[**rs_msgs_send_lobby_status_peer_leaving**](DefaultApi.md#rs_msgs_send_lobby_status_peer_leaving) | **POST** /rsMsgs/sendLobbyStatusPeerLeaving | sendLobbyStatusPeerLeaving notify friend nodes that we're leaving a subscribed lobby
[**rs_msgs_send_status_string**](DefaultApi.md#rs_msgs_send_status_string) | **POST** /rsMsgs/sendStatusString | sendStatusString send a status string
[**rs_msgs_set_custom_state_string**](DefaultApi.md#rs_msgs_set_custom_state_string) | **POST** /rsMsgs/setCustomStateString | setCustomStateString set your custom status message
[**rs_msgs_set_default_identity_for_chat_lobby**](DefaultApi.md#rs_msgs_set_default_identity_for_chat_lobby) | **POST** /rsMsgs/setDefaultIdentityForChatLobby | setDefaultIdentityForChatLobby set the default identity used for chat lobbies
[**rs_msgs_set_identity_for_chat_lobby**](DefaultApi.md#rs_msgs_set_identity_for_chat_lobby) | **POST** /rsMsgs/setIdentityForChatLobby | setIdentityForChatLobby set the chat identit
[**rs_msgs_set_lobby_auto_subscribe**](DefaultApi.md#rs_msgs_set_lobby_auto_subscribe) | **POST** /rsMsgs/setLobbyAutoSubscribe | setLobbyAutoSubscribe enable or disable auto subscribe for a chat lobby
[**rs_msgs_set_message_tag**](DefaultApi.md#rs_msgs_set_message_tag) | **POST** /rsMsgs/setMessageTag | setMessageTag set == false && tagId == 0
[**rs_msgs_set_message_tag_type**](DefaultApi.md#rs_msgs_set_message_tag_type) | **POST** /rsMsgs/setMessageTagType | setMessageTagType
[**rs_msgs_system_message**](DefaultApi.md#rs_msgs_system_message) | **POST** /rsMsgs/SystemMessage | SystemMessage
[**rs_msgs_unsubscribe_chat_lobby**](DefaultApi.md#rs_msgs_unsubscribe_chat_lobby) | **POST** /rsMsgs/unsubscribeChatLobby | unsubscribeChatLobby leave a chat lobby
[**rs_peers_accept_invite**](DefaultApi.md#rs_peers_accept_invite) | **POST** /rsPeers/acceptInvite | Add trusted node from invite
[**rs_peers_add_friend**](DefaultApi.md#rs_peers_add_friend) | **POST** /rsPeers/addFriend | Add trusted node
[**rs_peers_add_group**](DefaultApi.md#rs_peers_add_group) | **POST** /rsPeers/addGroup | addGroup create a new group
[**rs_peers_add_peer_locator**](DefaultApi.md#rs_peers_add_peer_locator) | **POST** /rsPeers/addPeerLocator | Add URL locator for given peer
[**rs_peers_assign_peer_to_group**](DefaultApi.md#rs_peers_assign_peer_to_group) | **POST** /rsPeers/assignPeerToGroup | assignPeerToGroup add a peer to a group
[**rs_peers_assign_peers_to_group**](DefaultApi.md#rs_peers_assign_peers_to_group) | **POST** /rsPeers/assignPeersToGroup | assignPeersToGroup add a list of peers to a group
[**rs_peers_connect_attempt**](DefaultApi.md#rs_peers_connect_attempt) | **POST** /rsPeers/connectAttempt | Trigger connection attempt to given node
[**rs_peers_edit_group**](DefaultApi.md#rs_peers_edit_group) | **POST** /rsPeers/editGroup | editGroup edit an existing group
[**rs_peers_get_friend_list**](DefaultApi.md#rs_peers_get_friend_list) | **POST** /rsPeers/getFriendList | Get trusted peers list
[**rs_peers_get_gpg_id**](DefaultApi.md#rs_peers_get_gpg_id) | **POST** /rsPeers/getGPGId | Get PGP id for the given peer
[**rs_peers_get_group_info**](DefaultApi.md#rs_peers_get_group_info) | **POST** /rsPeers/getGroupInfo | getGroupInfo get group information to one group
[**rs_peers_get_group_info_by_name**](DefaultApi.md#rs_peers_get_group_info_by_name) | **POST** /rsPeers/getGroupInfoByName | getGroupInfoByName get group information by group name
[**rs_peers_get_group_info_list**](DefaultApi.md#rs_peers_get_group_info_list) | **POST** /rsPeers/getGroupInfoList | getGroupInfoList get list of all groups
[**rs_peers_get_online_list**](DefaultApi.md#rs_peers_get_online_list) | **POST** /rsPeers/getOnlineList | Get connected peers list
[**rs_peers_get_peer_details**](DefaultApi.md#rs_peers_get_peer_details) | **POST** /rsPeers/getPeerDetails | Get details details of the given peer
[**rs_peers_get_peers_count**](DefaultApi.md#rs_peers_get_peers_count) | **POST** /rsPeers/getPeersCount | Get peers count
[**rs_peers_get_retroshare_invite**](DefaultApi.md#rs_peers_get_retroshare_invite) | **POST** /rsPeers/GetRetroshareInvite | Get RetroShare invite of the given peer
[**rs_peers_is_friend**](DefaultApi.md#rs_peers_is_friend) | **POST** /rsPeers/isFriend | Check if given peer is a trusted node
[**rs_peers_is_online**](DefaultApi.md#rs_peers_is_online) | **POST** /rsPeers/isOnline | Check if there is an established connection to the given peer
[**rs_peers_is_pgp_friend**](DefaultApi.md#rs_peers_is_pgp_friend) | **POST** /rsPeers/isPgpFriend | Check if given PGP id is trusted
[**rs_peers_load_certificate_from_string**](DefaultApi.md#rs_peers_load_certificate_from_string) | **POST** /rsPeers/loadCertificateFromString | Import certificate into the keyring
[**rs_peers_load_details_from_string_cert**](DefaultApi.md#rs_peers_load_details_from_string_cert) | **POST** /rsPeers/loadDetailsFromStringCert | Examine certificate and get details without importing into the keyring
[**rs_peers_remove_friend**](DefaultApi.md#rs_peers_remove_friend) | **POST** /rsPeers/removeFriend | Revoke connection trust from to node
[**rs_peers_remove_friend_location**](DefaultApi.md#rs_peers_remove_friend_location) | **POST** /rsPeers/removeFriendLocation | Remove location of a trusted node, useful to prune old unused locations of a trusted peer without revoking trust
[**rs_peers_remove_group**](DefaultApi.md#rs_peers_remove_group) | **POST** /rsPeers/removeGroup | removeGroup remove a group
[**rs_peers_set_dyn_dns**](DefaultApi.md#rs_peers_set_dyn_dns) | **POST** /rsPeers/setDynDNS | Set (dynamical) domain name associated to the given peer
[**rs_peers_set_ext_address**](DefaultApi.md#rs_peers_set_ext_address) | **POST** /rsPeers/setExtAddress | Set external IPv4 address for given peer
[**rs_peers_set_local_address**](DefaultApi.md#rs_peers_set_local_address) | **POST** /rsPeers/setLocalAddress | Set local IPv4 address for the given peer
[**rs_peers_set_network_mode**](DefaultApi.md#rs_peers_set_network_mode) | **POST** /rsPeers/setNetworkMode | Set network mode of the given peer
[**rs_peers_set_vis_state**](DefaultApi.md#rs_peers_set_vis_state) | **POST** /rsPeers/setVisState | set DHT and discovery modes
[**rs_reputations_auto_positive_opinion_for_contacts**](DefaultApi.md#rs_reputations_auto_positive_opinion_for_contacts) | **POST** /rsReputations/autoPositiveOpinionForContacts | check if giving automatic positive opinion when flagging as contact is enbaled
[**rs_reputations_ban_node**](DefaultApi.md#rs_reputations_ban_node) | **POST** /rsReputations/banNode | Enable automatic banning of all identities signed by the given node
[**rs_reputations_get_own_opinion**](DefaultApi.md#rs_reputations_get_own_opinion) | **POST** /rsReputations/getOwnOpinion | Get own opition about the given identity
[**rs_reputations_get_reputation_info**](DefaultApi.md#rs_reputations_get_reputation_info) | **POST** /rsReputations/getReputationInfo | Get reputation data of given identity
[**rs_reputations_is_identity_banned**](DefaultApi.md#rs_reputations_is_identity_banned) | **POST** /rsReputations/isIdentityBanned | This method allow fast checking if a GXS identity is banned.
[**rs_reputations_is_node_banned**](DefaultApi.md#rs_reputations_is_node_banned) | **POST** /rsReputations/isNodeBanned | Check if automatic banning of all identities signed by the given node is enabled
[**rs_reputations_overall_reputation_level**](DefaultApi.md#rs_reputations_overall_reputation_level) | **POST** /rsReputations/overallReputationLevel | Get overall reputation level of given identity
[**rs_reputations_remember_banned_id_threshold**](DefaultApi.md#rs_reputations_remember_banned_id_threshold) | **POST** /rsReputations/rememberBannedIdThreshold | Get number of days to wait before deleting a banned identity from local storage
[**rs_reputations_set_auto_positive_opinion_for_contacts**](DefaultApi.md#rs_reputations_set_auto_positive_opinion_for_contacts) | **POST** /rsReputations/setAutoPositiveOpinionForContacts | Enable giving automatic positive opinion when flagging as contact
[**rs_reputations_set_own_opinion**](DefaultApi.md#rs_reputations_set_own_opinion) | **POST** /rsReputations/setOwnOpinion | Set own opinion about the given identity
[**rs_reputations_set_remember_banned_id_threshold**](DefaultApi.md#rs_reputations_set_remember_banned_id_threshold) | **POST** /rsReputations/setRememberBannedIdThreshold | Set number of days to wait before deleting a banned identity from local storage
[**rs_reputations_set_threshold_for_remotely_negative_reputation**](DefaultApi.md#rs_reputations_set_threshold_for_remotely_negative_reputation) | **POST** /rsReputations/setThresholdForRemotelyNegativeReputation | Set threshold on remote reputation to consider it remotely negative
[**rs_reputations_set_threshold_for_remotely_positive_reputation**](DefaultApi.md#rs_reputations_set_threshold_for_remotely_positive_reputation) | **POST** /rsReputations/setThresholdForRemotelyPositiveReputation | Set threshold on remote reputation to consider it remotely positive
[**rs_reputations_threshold_for_remotely_negative_reputation**](DefaultApi.md#rs_reputations_threshold_for_remotely_negative_reputation) | **POST** /rsReputations/thresholdForRemotelyNegativeReputation | Get threshold on remote reputation to consider it remotely negative
[**rs_reputations_threshold_for_remotely_positive_reputation**](DefaultApi.md#rs_reputations_threshold_for_remotely_positive_reputation) | **POST** /rsReputations/thresholdForRemotelyPositiveReputation | Get threshold on remote reputation to consider it remotely negative
[**rs_service_control_get_own_services**](DefaultApi.md#rs_service_control_get_own_services) | **POST** /rsServiceControl/getOwnServices | get a map off all services.
[**rs_service_control_get_peers_connected**](DefaultApi.md#rs_service_control_get_peers_connected) | **POST** /rsServiceControl/getPeersConnected | getPeersConnected return peers using a service.
[**rs_service_control_get_service_item_names**](DefaultApi.md#rs_service_control_get_service_item_names) | **POST** /rsServiceControl/getServiceItemNames | getServiceItemNames return a map of service item names.
[**rs_service_control_get_service_name**](DefaultApi.md#rs_service_control_get_service_name) | **POST** /rsServiceControl/getServiceName | getServiceName lookup the name of a service.
[**rs_service_control_get_service_permissions**](DefaultApi.md#rs_service_control_get_service_permissions) | **POST** /rsServiceControl/getServicePermissions | getServicePermissions return permissions of one service.
[**rs_service_control_get_services_allowed**](DefaultApi.md#rs_service_control_get_services_allowed) | **POST** /rsServiceControl/getServicesAllowed | getServicesAllowed return a mpa with allowed service information.
[**rs_service_control_get_services_provided**](DefaultApi.md#rs_service_control_get_services_provided) | **POST** /rsServiceControl/getServicesProvided | getServicesProvided return services provided by a peer.
[**rs_service_control_update_service_permissions**](DefaultApi.md#rs_service_control_update_service_permissions) | **POST** /rsServiceControl/updateServicePermissions | updateServicePermissions update service permissions of one service.


# **json_api_server_authorize_token**
Joan Pascual Sana's avatar
Joan Pascual Sana committed
252
> RespJsonApiServerAuthorizeToken json_api_server_authorize_token(req_json_api_server_authorize_token=req_json_api_server_authorize_token)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
253 254 255 256 257

Add new auth token to the authorized set

### Example

Joan Pascual Sana's avatar
Joan Pascual Sana committed
258
* Basic Authentication (BasicAuth):
Joan Pascual Sana's avatar
Joan Pascual Sana committed
259 260 261 262 263 264
```python
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
Joan Pascual Sana's avatar
Joan Pascual Sana committed
265 266 267 268
configuration = openapi_client.Configuration()
# Configure HTTP basic authorization: BasicAuth
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
Joan Pascual Sana's avatar
Joan Pascual Sana committed
269

Joan Pascual Sana's avatar
Joan Pascual Sana committed
270 271
# Defining host is optional and default to http://127.0.0.1:9092
configuration.host = "http://127.0.0.1:9092"
Joan Pascual Sana's avatar
Joan Pascual Sana committed
272
# Create an instance of the API class
Joan Pascual Sana's avatar
Joan Pascual Sana committed
273
api_instance = openapi_client.DefaultApi(openapi_client.ApiClient(configuration))
Joan Pascual Sana's avatar
Joan Pascual Sana committed
274
req_json_api_server_authorize_token = {"token":"( string)toke to autorize decoded "} # ReqJsonApiServerAuthorizeToken | token: \"( string)toke to autorize decoded \"  (optional)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
275 276 277

try:
    # Add new auth token to the authorized set
Joan Pascual Sana's avatar
Joan Pascual Sana committed
278
    api_response = api_instance.json_api_server_authorize_token(req_json_api_server_authorize_token=req_json_api_server_authorize_token)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
279 280
    pprint(api_response)
except ApiException as e:
Joan Pascual Sana's avatar
Joan Pascual Sana committed
281
    print("Exception when calling DefaultApi->json_api_server_authorize_token: %s\n" % e)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
282 283 284 285 286 287
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
Joan Pascual Sana's avatar
Joan Pascual Sana committed
288
 **req_json_api_server_authorize_token** | [**ReqJsonApiServerAuthorizeToken**](ReqJsonApiServerAuthorizeToken.md)| token: \"( string)toke to autorize decoded \"  | [optional] 
Joan Pascual Sana's avatar
Joan Pascual Sana committed
289 290 291

### Return type

Joan Pascual Sana's avatar
Joan Pascual Sana committed
292
[**RespJsonApiServerAuthorizeToken**](RespJsonApiServerAuthorizeToken.md)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
293 294 295

### Authorization

Joan Pascual Sana's avatar
Joan Pascual Sana committed
296
[BasicAuth](../README.md#BasicAuth)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
297 298 299 300 301 302 303 304 305 306

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | return: true if the token has been added to authorized, false if error occurred or if the token was already authorized   |  -  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
307
**401** | Authentication information is missing or invalid |  * WWW_Authenticate -  <br>  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
308 309 310

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Joan Pascual Sana's avatar
Joan Pascual Sana committed
311
# **json_api_server_decode_token**
Joan Pascual Sana's avatar
Joan Pascual Sana committed
312
> RespJsonApiServerDecodeToken json_api_server_decode_token(req_json_api_server_decode_token=req_json_api_server_decode_token)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
313 314 315 316 317 318 319 320 321 322 323 324 325 326

Get decoded version of the given encoded token

### Example

```python
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
Joan Pascual Sana's avatar
Joan Pascual Sana committed
327
req_json_api_server_decode_token = {"token":"( string)encoded "} # ReqJsonApiServerDecodeToken | token: \"( string)encoded \"  (optional)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
328 329 330

try:
    # Get decoded version of the given encoded token
Joan Pascual Sana's avatar
Joan Pascual Sana committed
331
    api_response = api_instance.json_api_server_decode_token(req_json_api_server_decode_token=req_json_api_server_decode_token)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
332 333
    pprint(api_response)
except ApiException as e:
Joan Pascual Sana's avatar
Joan Pascual Sana committed
334
    print("Exception when calling DefaultApi->json_api_server_decode_token: %s\n" % e)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
335 336 337 338 339 340
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
Joan Pascual Sana's avatar
Joan Pascual Sana committed
341
 **req_json_api_server_decode_token** | [**ReqJsonApiServerDecodeToken**](ReqJsonApiServerDecodeToken.md)| token: \&quot;( string)encoded \&quot;  | [optional] 
Joan Pascual Sana's avatar
Joan Pascual Sana committed
342 343 344

### Return type

Joan Pascual Sana's avatar
Joan Pascual Sana committed
345
[**RespJsonApiServerDecodeToken**](RespJsonApiServerDecodeToken.md)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | return: token decoded   |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Joan Pascual Sana's avatar
Joan Pascual Sana committed
363
# **json_api_server_enconde_token**
Joan Pascual Sana's avatar
Joan Pascual Sana committed
364
> RespJsonApiServerEncondeToken json_api_server_enconde_token(req_json_api_server_enconde_token=req_json_api_server_enconde_token)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
365 366 367 368 369 370 371 372 373 374 375 376 377 378

Get encoded version of the given decoded token

### Example

```python
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
Joan Pascual Sana's avatar
Joan Pascual Sana committed
379
req_json_api_server_enconde_token = {"token":"( string)decoded "} # ReqJsonApiServerEncondeToken | token: \"( string)decoded \"  (optional)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
380 381 382

try:
    # Get encoded version of the given decoded token
Joan Pascual Sana's avatar
Joan Pascual Sana committed
383
    api_response = api_instance.json_api_server_enconde_token(req_json_api_server_enconde_token=req_json_api_server_enconde_token)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
384 385
    pprint(api_response)
except ApiException as e:
Joan Pascual Sana's avatar
Joan Pascual Sana committed
386
    print("Exception when calling DefaultApi->json_api_server_enconde_token: %s\n" % e)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
387 388 389 390 391 392
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
Joan Pascual Sana's avatar
Joan Pascual Sana committed
393
 **req_json_api_server_enconde_token** | [**ReqJsonApiServerEncondeToken**](ReqJsonApiServerEncondeToken.md)| token: \&quot;( string)decoded \&quot;  | [optional] 
Joan Pascual Sana's avatar
Joan Pascual Sana committed
394 395 396

### Return type

Joan Pascual Sana's avatar
Joan Pascual Sana committed
397
[**RespJsonApiServerEncondeToken**](RespJsonApiServerEncondeToken.md)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | return: token encoded   |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Joan Pascual Sana's avatar
Joan Pascual Sana committed
415
# **json_api_server_get_authorized_tokens**
Joan Pascual Sana's avatar
Joan Pascual Sana committed
416
> RespJsonApiServerGetAuthorizedTokens json_api_server_get_authorized_tokens()
Joan Pascual Sana's avatar
Joan Pascual Sana committed
417 418 419 420 421

Get uthorized tokens

### Example

Joan Pascual Sana's avatar
Joan Pascual Sana committed
422
* Basic Authentication (BasicAuth):
Joan Pascual Sana's avatar
Joan Pascual Sana committed
423 424 425 426 427 428
```python
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
Joan Pascual Sana's avatar
Joan Pascual Sana committed
429 430 431 432
configuration = openapi_client.Configuration()
# Configure HTTP basic authorization: BasicAuth
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
Joan Pascual Sana's avatar
Joan Pascual Sana committed
433

Joan Pascual Sana's avatar
Joan Pascual Sana committed
434 435
# Defining host is optional and default to http://127.0.0.1:9092
configuration.host = "http://127.0.0.1:9092"
Joan Pascual Sana's avatar
Joan Pascual Sana committed
436
# Create an instance of the API class
Joan Pascual Sana's avatar
Joan Pascual Sana committed
437
api_instance = openapi_client.DefaultApi(openapi_client.ApiClient(configuration))
Joan Pascual Sana's avatar
Joan Pascual Sana committed
438 439 440

try:
    # Get uthorized tokens
Joan Pascual Sana's avatar
Joan Pascual Sana committed
441
    api_response = api_instance.json_api_server_get_authorized_tokens()
Joan Pascual Sana's avatar
Joan Pascual Sana committed
442 443
    pprint(api_response)
except ApiException as e:
Joan Pascual Sana's avatar
Joan Pascual Sana committed
444
    print("Exception when calling DefaultApi->json_api_server_get_authorized_tokens: %s\n" % e)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
445 446 447 448 449 450 451
```

### Parameters
This endpoint does not need any parameter.

### Return type

Joan Pascual Sana's avatar
Joan Pascual Sana committed
452
[**RespJsonApiServerGetAuthorizedTokens**](RespJsonApiServerGetAuthorizedTokens.md)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
453 454 455

### Authorization

Joan Pascual Sana's avatar
Joan Pascual Sana committed
456
[BasicAuth](../README.md#BasicAuth)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
457 458 459 460 461 462 463 464 465 466

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | return: the set of authorized encoded tokens   |  -  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
467
**401** | Authentication information is missing or invalid |  * WWW_Authenticate -  <br>  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
468 469 470

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Joan Pascual Sana's avatar
Joan Pascual Sana committed
471
# **json_api_server_is_auth_token_valid**
Joan Pascual Sana's avatar
Joan Pascual Sana committed
472
> RespJsonApiServerIsAuthTokenValid json_api_server_is_auth_token_valid(req_json_api_server_is_auth_token_valid=req_json_api_server_is_auth_token_valid)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
473 474 475 476 477

Check if given JSON API auth token is authorized

### Example

Joan Pascual Sana's avatar
Joan Pascual Sana committed
478
* Basic Authentication (BasicAuth):
Joan Pascual Sana's avatar
Joan Pascual Sana committed
479 480 481 482 483 484
```python
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
Joan Pascual Sana's avatar
Joan Pascual Sana committed
485 486 487 488
configuration = openapi_client.Configuration()
# Configure HTTP basic authorization: BasicAuth
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
Joan Pascual Sana's avatar
Joan Pascual Sana committed
489

Joan Pascual Sana's avatar
Joan Pascual Sana committed
490 491
# Defining host is optional and default to http://127.0.0.1:9092
configuration.host = "http://127.0.0.1:9092"
Joan Pascual Sana's avatar
Joan Pascual Sana committed
492
# Create an instance of the API class
Joan Pascual Sana's avatar
Joan Pascual Sana committed
493
api_instance = openapi_client.DefaultApi(openapi_client.ApiClient(configuration))
Joan Pascual Sana's avatar
Joan Pascual Sana committed
494
req_json_api_server_is_auth_token_valid = {"token":"( string)decoded "} # ReqJsonApiServerIsAuthTokenValid | token: \"( string)decoded \"  (optional)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
495 496 497

try:
    # Check if given JSON API auth token is authorized
Joan Pascual Sana's avatar
Joan Pascual Sana committed
498
    api_response = api_instance.json_api_server_is_auth_token_valid(req_json_api_server_is_auth_token_valid=req_json_api_server_is_auth_token_valid)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
499 500
    pprint(api_response)
except ApiException as e:
Joan Pascual Sana's avatar
Joan Pascual Sana committed
501
    print("Exception when calling DefaultApi->json_api_server_is_auth_token_valid: %s\n" % e)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
502 503 504 505 506 507
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
Joan Pascual Sana's avatar
Joan Pascual Sana committed
508
 **req_json_api_server_is_auth_token_valid** | [**ReqJsonApiServerIsAuthTokenValid**](ReqJsonApiServerIsAuthTokenValid.md)| token: \&quot;( string)decoded \&quot;  | [optional] 
Joan Pascual Sana's avatar
Joan Pascual Sana committed
509 510 511

### Return type

Joan Pascual Sana's avatar
Joan Pascual Sana committed
512
[**RespJsonApiServerIsAuthTokenValid**](RespJsonApiServerIsAuthTokenValid.md)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
513 514 515

### Authorization

Joan Pascual Sana's avatar
Joan Pascual Sana committed
516
[BasicAuth](../README.md#BasicAuth)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
517 518 519 520 521 522 523 524 525 526

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | return: tru if authorized, false otherwise   |  -  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
527
**401** | Authentication information is missing or invalid |  * WWW_Authenticate -  <br>  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
528 529 530

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Joan Pascual Sana's avatar
Joan Pascual Sana committed
531
# **json_api_server_request_new_token_autorization**
Joan Pascual Sana's avatar
Joan Pascual Sana committed
532
> RespJsonApiServerRequestNewTokenAutorization json_api_server_request_new_token_autorization(req_json_api_server_request_new_token_autorization=req_json_api_server_request_new_token_autorization)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
533 534 535 536 537 538 539 540 541 542 543 544 545 546

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.

### Example

```python
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
Joan Pascual Sana's avatar
Joan Pascual Sana committed
547
req_json_api_server_request_new_token_autorization = {"token":"( string)token to autorize "} # ReqJsonApiServerRequestNewTokenAutorization | token: \"( string)token to autorize \"  (optional)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
548 549 550

try:
    # 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.
Joan Pascual Sana's avatar
Joan Pascual Sana committed
551
    api_response = api_instance.json_api_server_request_new_token_autorization(req_json_api_server_request_new_token_autorization=req_json_api_server_request_new_token_autorization)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
552 553
    pprint(api_response)
except ApiException as e:
Joan Pascual Sana's avatar
Joan Pascual Sana committed
554
    print("Exception when calling DefaultApi->json_api_server_request_new_token_autorization: %s\n" % e)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
555 556 557 558 559 560
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
Joan Pascual Sana's avatar
Joan Pascual Sana committed
561
 **req_json_api_server_request_new_token_autorization** | [**ReqJsonApiServerRequestNewTokenAutorization**](ReqJsonApiServerRequestNewTokenAutorization.md)| token: \&quot;( string)token to autorize \&quot;  | [optional] 
Joan Pascual Sana's avatar
Joan Pascual Sana committed
562 563 564

### Return type

Joan Pascual Sana's avatar
Joan Pascual Sana committed
565
[**RespJsonApiServerRequestNewTokenAutorization**](RespJsonApiServerRequestNewTokenAutorization.md)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | return: true if authorization succeded, false otherwise.   |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Joan Pascual Sana's avatar
Joan Pascual Sana committed
583
# **json_api_server_revoke_auth_token**
Joan Pascual Sana's avatar
Joan Pascual Sana committed
584
> RespJsonApiServerRevokeAuthToken json_api_server_revoke_auth_token(req_json_api_server_revoke_auth_token=req_json_api_server_revoke_auth_token)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
585 586 587 588 589

Revoke given auth token

### Example

Joan Pascual Sana's avatar
Joan Pascual Sana committed
590
* Basic Authentication (BasicAuth):
Joan Pascual Sana's avatar
Joan Pascual Sana committed
591 592 593 594 595 596
```python
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
Joan Pascual Sana's avatar
Joan Pascual Sana committed
597 598 599 600
configuration = openapi_client.Configuration()
# Configure HTTP basic authorization: BasicAuth
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
Joan Pascual Sana's avatar
Joan Pascual Sana committed
601

Joan Pascual Sana's avatar
Joan Pascual Sana committed
602 603
# Defining host is optional and default to http://127.0.0.1:9092
configuration.host = "http://127.0.0.1:9092"
Joan Pascual Sana's avatar
Joan Pascual Sana committed
604
# Create an instance of the API class
Joan Pascual Sana's avatar
Joan Pascual Sana committed
605
api_instance = openapi_client.DefaultApi(openapi_client.ApiClient(configuration))
Joan Pascual Sana's avatar
Joan Pascual Sana committed
606
req_json_api_server_revoke_auth_token = {"token":"( string)decoded "} # ReqJsonApiServerRevokeAuthToken | token: \"( string)decoded \"  (optional)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
607 608 609

try:
    # Revoke given auth token
Joan Pascual Sana's avatar
Joan Pascual Sana committed
610
    api_response = api_instance.json_api_server_revoke_auth_token(req_json_api_server_revoke_auth_token=req_json_api_server_revoke_auth_token)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
611 612
    pprint(api_response)
except ApiException as e:
Joan Pascual Sana's avatar
Joan Pascual Sana committed
613
    print("Exception when calling DefaultApi->json_api_server_revoke_auth_token: %s\n" % e)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
614 615 616 617 618 619
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
Joan Pascual Sana's avatar
Joan Pascual Sana committed
620
 **req_json_api_server_revoke_auth_token** | [**ReqJsonApiServerRevokeAuthToken**](ReqJsonApiServerRevokeAuthToken.md)| token: \&quot;( string)decoded \&quot;  | [optional] 
Joan Pascual Sana's avatar
Joan Pascual Sana committed
621 622 623

### Return type

Joan Pascual Sana's avatar
Joan Pascual Sana committed
624
[**RespJsonApiServerRevokeAuthToken**](RespJsonApiServerRevokeAuthToken.md)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
625 626 627

### Authorization

Joan Pascual Sana's avatar
Joan Pascual Sana committed
628
[BasicAuth](../README.md#BasicAuth)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
629 630 631 632 633 634 635 636 637 638

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | return: true if the token has been revoked, false otherwise   |  -  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
639
**401** | Authentication information is missing or invalid |  * WWW_Authenticate -  <br>  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
640 641 642

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Joan Pascual Sana's avatar
Joan Pascual Sana committed
643
# **json_api_server_version**
Joan Pascual Sana's avatar
Joan Pascual Sana committed
644
> RespJsonApiServerVersion json_api_server_version()
Joan Pascual Sana's avatar
Joan Pascual Sana committed
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661

Write version information to given paramethers

### Example

```python
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()

try:
    # Write version information to given paramethers
Joan Pascual Sana's avatar
Joan Pascual Sana committed
662
    api_response = api_instance.json_api_server_version()
Joan Pascual Sana's avatar
Joan Pascual Sana committed
663 664
    pprint(api_response)
except ApiException as e:
Joan Pascual Sana's avatar
Joan Pascual Sana committed
665
    print("Exception when calling DefaultApi->json_api_server_version: %s\n" % e)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
666 667 668 669 670 671 672
```

### Parameters
This endpoint does not need any parameter.

### Return type

Joan Pascual Sana's avatar
Joan Pascual Sana committed
673
[**RespJsonApiServerVersion**](RespJsonApiServerVersion.md)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
674 675 676 677 678 679 680 681 682 683 684 685 686

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
Joan Pascual Sana's avatar
Joan Pascual Sana committed
687
**200** | return:  [out] major(integer)storage  [out] minor(integer)storage  [out] mini(integer)storage  [out] extra(string)storage  [out] human(string)storage   |  -  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
688 689 690

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Joan Pascual Sana's avatar
Joan Pascual Sana committed
691
# **rs_accounts_export_identity**
Joan Pascual Sana's avatar
Joan Pascual Sana committed
692
> RespRsAccountsExportIdentity rs_accounts_export_identity(req_rs_accounts_export_identity=req_rs_accounts_export_identity)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
693 694 695 696 697

Export full encrypted PGP identity to file

### Example

Joan Pascual Sana's avatar
Joan Pascual Sana committed
698
* Basic Authentication (BasicAuth):
Joan Pascual Sana's avatar
Joan Pascual Sana committed
699 700 701 702 703 704
```python
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
Joan Pascual Sana's avatar
Joan Pascual Sana committed
705 706 707 708
configuration = openapi_client.Configuration()
# Configure HTTP basic authorization: BasicAuth
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
Joan Pascual Sana's avatar
Joan Pascual Sana committed
709

Joan Pascual Sana's avatar
Joan Pascual Sana committed
710 711
# Defining host is optional and default to http://127.0.0.1:9092
configuration.host = "http://127.0.0.1:9092"
Joan Pascual Sana's avatar
Joan Pascual Sana committed
712
# Create an instance of the API class
Joan Pascual Sana's avatar
Joan Pascual Sana committed
713
api_instance = openapi_client.DefaultApi(openapi_client.ApiClient(configuration))
Joan Pascual Sana's avatar
Joan Pascual Sana committed
714
req_rs_accounts_export_identity = {"filePath":"( string)path of certificate file ","pgpId":"( RsPgpId)PGP id to export "} # ReqRsAccountsExportIdentity | filePath: \"( string)path of certificate file \"         pgpId: \"( RsPgpId)PGP id to export \"  (optional)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
715 716 717

try:
    # Export full encrypted PGP identity to file
Joan Pascual Sana's avatar
Joan Pascual Sana committed
718
    api_response = api_instance.rs_accounts_export_identity(req_rs_accounts_export_identity=req_rs_accounts_export_identity)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
719 720
    pprint(api_response)
except ApiException as e:
Joan Pascual Sana's avatar
Joan Pascual Sana committed
721
    print("Exception when calling DefaultApi->rs_accounts_export_identity: %s\n" % e)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
722 723 724 725 726 727
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
Joan Pascual Sana's avatar
Joan Pascual Sana committed
728
 **req_rs_accounts_export_identity** | [**ReqRsAccountsExportIdentity**](ReqRsAccountsExportIdentity.md)| filePath: \&quot;( string)path of certificate file \&quot;         pgpId: \&quot;( RsPgpId)PGP id to export \&quot;  | [optional] 
Joan Pascual Sana's avatar
Joan Pascual Sana committed
729 730 731

### Return type

Joan Pascual Sana's avatar
Joan Pascual Sana committed
732
[**RespRsAccountsExportIdentity**](RespRsAccountsExportIdentity.md)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
733 734 735

### Authorization

Joan Pascual Sana's avatar
Joan Pascual Sana committed
736
[BasicAuth](../README.md#BasicAuth)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
737 738 739 740 741 742 743 744 745 746

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | return: true on success, false otherwise   |  -  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
747
**401** | Authentication information is missing or invalid |  * WWW_Authenticate -  <br>  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
748 749 750

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Joan Pascual Sana's avatar
Joan Pascual Sana committed
751
# **rs_accounts_export_identity_to_string**
Joan Pascual Sana's avatar
Joan Pascual Sana committed
752
> RespRsAccountsExportIdentityToString rs_accounts_export_identity_to_string(req_rs_accounts_export_identity_to_string=req_rs_accounts_export_identity_to_string)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
753 754 755 756 757

Export full encrypted PGP identity to string

### Example

Joan Pascual Sana's avatar
Joan Pascual Sana committed
758
* Basic Authentication (BasicAuth):
Joan Pascual Sana's avatar
Joan Pascual Sana committed
759 760 761 762 763 764
```python
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
Joan Pascual Sana's avatar
Joan Pascual Sana committed
765 766 767 768
configuration = openapi_client.Configuration()
# Configure HTTP basic authorization: BasicAuth
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
Joan Pascual Sana's avatar
Joan Pascual Sana committed
769

Joan Pascual Sana's avatar
Joan Pascual Sana committed
770 771
# Defining host is optional and default to http://127.0.0.1:9092
configuration.host = "http://127.0.0.1:9092"
Joan Pascual Sana's avatar
Joan Pascual Sana committed
772
# Create an instance of the API class
Joan Pascual Sana's avatar
Joan Pascual Sana committed
773
api_instance = openapi_client.DefaultApi(openapi_client.ApiClient(configuration))
Joan Pascual Sana's avatar
Joan Pascual Sana committed
774
req_rs_accounts_export_identity_to_string = {"pgpId":"( RsPgpId)PGP id to export ","includeSignatures":"( boolean)true to include signatures "} # ReqRsAccountsExportIdentityToString | pgpId: \"( RsPgpId)PGP id to export \"         includeSignatures: \"( boolean)true to include signatures \"  (optional)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
775 776 777

try:
    # Export full encrypted PGP identity to string
Joan Pascual Sana's avatar
Joan Pascual Sana committed
778
    api_response = api_instance.rs_accounts_export_identity_to_string(req_rs_accounts_export_identity_to_string=req_rs_accounts_export_identity_to_string)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
779 780
    pprint(api_response)
except ApiException as e:
Joan Pascual Sana's avatar
Joan Pascual Sana committed
781
    print("Exception when calling DefaultApi->rs_accounts_export_identity_to_string: %s\n" % e)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
782 783 784 785 786 787
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
Joan Pascual Sana's avatar
Joan Pascual Sana committed
788
 **req_rs_accounts_export_identity_to_string** | [**ReqRsAccountsExportIdentityToString**](ReqRsAccountsExportIdentityToString.md)| pgpId: \&quot;( RsPgpId)PGP id to export \&quot;         includeSignatures: \&quot;( boolean)true to include signatures \&quot;  | [optional] 
Joan Pascual Sana's avatar
Joan Pascual Sana committed
789 790 791

### Return type

Joan Pascual Sana's avatar
Joan Pascual Sana committed
792
[**RespRsAccountsExportIdentityToString**](RespRsAccountsExportIdentityToString.md)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
793 794 795

### Authorization

Joan Pascual Sana's avatar
Joan Pascual Sana committed
796
[BasicAuth](../README.md#BasicAuth)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
797 798 799 800 801 802 803 804 805

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
Joan Pascual Sana's avatar
Joan Pascual Sana committed
806
**200** | return: true on success, false otherwise  [out] data(string)storage for certificate string  [out] errorMsg(string)storage for eventual human readable error message   |  -  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
807
**401** | Authentication information is missing or invalid |  * WWW_Authenticate -  <br>  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
808 809 810

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Joan Pascual Sana's avatar
Joan Pascual Sana committed
811
# **rs_accounts_get_current_account_id**
Joan Pascual Sana's avatar
Joan Pascual Sana committed
812
> RespRsAccountsGetCurrentAccountId rs_accounts_get_current_account_id()
Joan Pascual Sana's avatar
Joan Pascual Sana committed
813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829

Get current account id. Beware that an account may be selected without actually logging in.

### Example

```python
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()

try:
    # Get current account id. Beware that an account may be selected without actually logging in.
Joan Pascual Sana's avatar
Joan Pascual Sana committed
830
    api_response = api_instance.rs_accounts_get_current_account_id()
Joan Pascual Sana's avatar
Joan Pascual Sana committed
831 832
    pprint(api_response)
except ApiException as e:
Joan Pascual Sana's avatar
Joan Pascual Sana committed
833
    print("Exception when calling DefaultApi->rs_accounts_get_current_account_id: %s\n" % e)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
834 835 836 837 838 839 840
```

### Parameters
This endpoint does not need any parameter.

### Return type

Joan Pascual Sana's avatar
Joan Pascual Sana committed
841
[**RespRsAccountsGetCurrentAccountId**](RespRsAccountsGetCurrentAccountId.md)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
842 843 844 845 846 847 848 849 850 851 852 853 854

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
Joan Pascual Sana's avatar
Joan Pascual Sana committed
855
**200** | return: false if account hasn&#39;t been selected yet, true otherwise  [out] id(RsPeerId)storage for current account id   |  -  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
856 857 858

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Joan Pascual Sana's avatar
Joan Pascual Sana committed
859
# **rs_accounts_get_pgp_logins**
Joan Pascual Sana's avatar
Joan Pascual Sana committed
860
> RespRsAccountsGetPGPLogins rs_accounts_get_pgp_logins()
Joan Pascual Sana's avatar
Joan Pascual Sana committed
861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877

Get available PGP identities id list

### Example

```python
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()

try:
    # Get available PGP identities id list
Joan Pascual Sana's avatar
Joan Pascual Sana committed
878
    api_response = api_instance.rs_accounts_get_pgp_logins()
Joan Pascual Sana's avatar
Joan Pascual Sana committed
879 880
    pprint(api_response)
except ApiException as e:
Joan Pascual Sana's avatar
Joan Pascual Sana committed
881
    print("Exception when calling DefaultApi->rs_accounts_get_pgp_logins: %s\n" % e)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
882 883 884 885 886 887 888
```

### Parameters
This endpoint does not need any parameter.

### Return type

Joan Pascual Sana's avatar
Joan Pascual Sana committed
889
[**RespRsAccountsGetPGPLogins**](RespRsAccountsGetPGPLogins.md)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
890 891 892 893 894 895 896 897 898 899 900 901 902

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
Joan Pascual Sana's avatar
Joan Pascual Sana committed
903
**200** | return: true on success, false otherwise  [out] pgpIds(list&lt;RsPgpId&gt;)storage for PGP id list   |  -  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
904 905 906

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Joan Pascual Sana's avatar
Joan Pascual Sana committed
907
# **rs_accounts_import_identity**
Joan Pascual Sana's avatar
Joan Pascual Sana committed
908
> RespRsAccountsImportIdentity rs_accounts_import_identity(req_rs_accounts_import_identity=req_rs_accounts_import_identity)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
909 910 911 912 913 914 915 916 917 918 919 920 921 922

Import full encrypted PGP identity from file

### Example

```python
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
Joan Pascual Sana's avatar
Joan Pascual Sana committed
923
req_rs_accounts_import_identity = {"filePath":"( string)path of certificate file "} # ReqRsAccountsImportIdentity | filePath: \"( string)path of certificate file \"  (optional)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
924 925 926

try:
    # Import full encrypted PGP identity from file
Joan Pascual Sana's avatar
Joan Pascual Sana committed
927
    api_response = api_instance.rs_accounts_import_identity(req_rs_accounts_import_identity=req_rs_accounts_import_identity)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
928 929
    pprint(api_response)
except ApiException as e:
Joan Pascual Sana's avatar
Joan Pascual Sana committed
930
    print("Exception when calling DefaultApi->rs_accounts_import_identity: %s\n" % e)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
931 932 933 934 935 936
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
Joan Pascual Sana's avatar
Joan Pascual Sana committed
937
 **req_rs_accounts_import_identity** | [**ReqRsAccountsImportIdentity**](ReqRsAccountsImportIdentity.md)| filePath: \&quot;( string)path of certificate file \&quot;  | [optional] 
Joan Pascual Sana's avatar
Joan Pascual Sana committed
938 939 940

### Return type

Joan Pascual Sana's avatar
Joan Pascual Sana committed
941
[**RespRsAccountsImportIdentity**](RespRsAccountsImportIdentity.md)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
942 943 944 945 946 947 948 949 950 951 952 953 954

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
Joan Pascual Sana's avatar
Joan Pascual Sana committed
955
**200** | return: true on success, false otherwise  [out] pgpId(RsPgpId)storage for the PGP fingerprint of the imported key  [out] errorMsg(string)storage for eventual human readable error message   |  -  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
956 957 958

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Joan Pascual Sana's avatar
Joan Pascual Sana committed
959
# **rs_accounts_import_identity_from_string**
Joan Pascual Sana's avatar
Joan Pascual Sana committed
960
> RespRsAccountsImportIdentityFromString rs_accounts_import_identity_from_string(req_rs_accounts_import_identity_from_string=req_rs_accounts_import_identity_from_string)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
961 962 963 964 965 966 967 968 969 970 971 972 973 974

Import full encrypted PGP identity from string

### Example

```python
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
Joan Pascual Sana's avatar
Joan Pascual Sana committed
975
req_rs_accounts_import_identity_from_string = {"data":"( string)certificate string "} # ReqRsAccountsImportIdentityFromString | data: \"( string)certificate string \"  (optional)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
976 977 978

try:
    # Import full encrypted PGP identity from string
Joan Pascual Sana's avatar
Joan Pascual Sana committed
979
    api_response = api_instance.rs_accounts_import_identity_from_string(req_rs_accounts_import_identity_from_string=req_rs_accounts_import_identity_from_string)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
980 981
    pprint(api_response)
except ApiException as e:
Joan Pascual Sana's avatar
Joan Pascual Sana committed
982
    print("Exception when calling DefaultApi->rs_accounts_import_identity_from_string: %s\n" % e)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
983 984 985 986 987 988
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
Joan Pascual Sana's avatar
Joan Pascual Sana committed
989
 **req_rs_accounts_import_identity_from_string** | [**ReqRsAccountsImportIdentityFromString**](ReqRsAccountsImportIdentityFromString.md)| data: \&quot;( string)certificate string \&quot;  | [optional] 
Joan Pascual Sana's avatar
Joan Pascual Sana committed
990 991 992

### Return type

Joan Pascual Sana's avatar
Joan Pascual Sana committed
993
[**RespRsAccountsImportIdentityFromString**](RespRsAccountsImportIdentityFromString.md)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1007
**200** | return: true on success, false otherwise  [out] pgpId(RsPgpId)storage for the PGP fingerprint of the imported key  [out] errorMsg(string)storage for eventual human readable error message   |  -  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1008 1009 1010

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Joan Pascual Sana's avatar
Joan Pascual Sana committed
1011
# **rs_ban_list_enable_ip_filtering**
1012
> object rs_ban_list_enable_ip_filtering(req_rs_ban_list_enable_ip_filtering=req_rs_ban_list_enable_ip_filtering)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1013 1014 1015 1016 1017

Enable or disable IP filtering service

### Example

Joan Pascual Sana's avatar
Joan Pascual Sana committed
1018
* Basic Authentication (BasicAuth):
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1019 1020 1021 1022 1023 1024
```python
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1025 1026 1027 1028
configuration = openapi_client.Configuration()
# Configure HTTP basic authorization: BasicAuth
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1029

Joan Pascual Sana's avatar
Joan Pascual Sana committed
1030 1031
# Defining host is optional and default to http://127.0.0.1:9092
configuration.host = "http://127.0.0.1:9092"
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1032
# Create an instance of the API class
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1033
api_instance = openapi_client.DefaultApi(openapi_client.ApiClient(configuration))
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1034
req_rs_ban_list_enable_ip_filtering = {"enable":"( boolean)pass true to enable, false to disable "} # ReqRsBanListEnableIPFiltering | enable: \"( boolean)pass true to enable, false to disable \"  (optional)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1035 1036 1037

try:
    # Enable or disable IP filtering service
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1038
    api_response = api_instance.rs_ban_list_enable_ip_filtering(req_rs_ban_list_enable_ip_filtering=req_rs_ban_list_enable_ip_filtering)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1039 1040
    pprint(api_response)
except ApiException as e:
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1041
    print("Exception when calling DefaultApi->rs_ban_list_enable_ip_filtering: %s\n" % e)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1042 1043 1044 1045 1046 1047
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1048
 **req_rs_ban_list_enable_ip_filtering** | [**ReqRsBanListEnableIPFiltering**](ReqRsBanListEnableIPFiltering.md)| enable: \&quot;( boolean)pass true to enable, false to disable \&quot;  | [optional] 
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1049 1050 1051

### Return type

1052
**object**
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1053 1054 1055

### Authorization

Joan Pascual Sana's avatar
Joan Pascual Sana committed
1056
[BasicAuth](../README.md#BasicAuth)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | return:   |  -  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1067
**401** | Authentication information is missing or invalid |  * WWW_Authenticate -  <br>  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1068 1069 1070

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Joan Pascual Sana's avatar
Joan Pascual Sana committed
1071
# **rs_ban_list_ip_filtering_enabled**
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1072
> RespRsBanListIpFilteringEnabled rs_ban_list_ip_filtering_enabled()
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1073 1074 1075 1076 1077

Get ip filtering service status

### Example

Joan Pascual Sana's avatar
Joan Pascual Sana committed
1078
* Basic Authentication (BasicAuth):
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1079 1080 1081 1082 1083 1084
```python
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1085 1086 1087 1088
configuration = openapi_client.Configuration()
# Configure HTTP basic authorization: BasicAuth
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1089

Joan Pascual Sana's avatar
Joan Pascual Sana committed
1090 1091
# Defining host is optional and default to http://127.0.0.1:9092
configuration.host = "http://127.0.0.1:9092"
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1092
# Create an instance of the API class
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1093
api_instance = openapi_client.DefaultApi(openapi_client.ApiClient(configuration))
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1094 1095 1096

try:
    # Get ip filtering service status
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1097
    api_response = api_instance.rs_ban_list_ip_filtering_enabled()
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1098 1099
    pprint(api_response)
except ApiException as e:
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1100
    print("Exception when calling DefaultApi->rs_ban_list_ip_filtering_enabled: %s\n" % e)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1101 1102 1103 1104 1105 1106 1107
```

### Parameters
This endpoint does not need any parameter.

### Return type

Joan Pascual Sana's avatar
Joan Pascual Sana committed
1108
[**RespRsBanListIpFilteringEnabled**](RespRsBanListIpFilteringEnabled.md)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1109 1110 1111

### Authorization

Joan Pascual Sana's avatar
Joan Pascual Sana committed
1112
[BasicAuth](../README.md#BasicAuth)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1113 1114 1115 1116 1117 1118 1119 1120 1121 1122

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | return: true if enabled, false if disabled   |  -  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1123
**401** | Authentication information is missing or invalid |  * WWW_Authenticate -  <br>  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1124 1125 1126

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Joan Pascual Sana's avatar
Joan Pascual Sana committed
1127
# **rs_broadcast_discovery_get_discovered_peers**
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1128
> RespRsBroadcastDiscoveryGetDiscoveredPeers rs_broadcast_discovery_get_discovered_peers()
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1129 1130 1131 1132 1133

Get potential peers that have been discovered up until now

### Example

Joan Pascual Sana's avatar
Joan Pascual Sana committed
1134
* Basic Authentication (BasicAuth):
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1135 1136 1137 1138 1139 1140
```python
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1141 1142 1143 1144
configuration = openapi_client.Configuration()
# Configure HTTP basic authorization: BasicAuth
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1145

Joan Pascual Sana's avatar
Joan Pascual Sana committed
1146 1147
# Defining host is optional and default to http://127.0.0.1:9092
configuration.host = "http://127.0.0.1:9092"
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1148
# Create an instance of the API class
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1149
api_instance = openapi_client.DefaultApi(openapi_client.ApiClient(configuration))
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1150 1151 1152

try:
    # Get potential peers that have been discovered up until now
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1153
    api_response = api_instance.rs_broadcast_discovery_get_discovered_peers()
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1154 1155
    pprint(api_response)
except ApiException as e:
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1156
    print("Exception when calling DefaultApi->rs_broadcast_discovery_get_discovered_peers: %s\n" % e)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1157 1158 1159 1160 1161 1162 1163
```

### Parameters
This endpoint does not need any parameter.

### Return type

Joan Pascual Sana's avatar
Joan Pascual Sana committed
1164
[**RespRsBroadcastDiscoveryGetDiscoveredPeers**](RespRsBroadcastDiscoveryGetDiscoveredPeers.md)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1165 1166 1167

### Authorization

Joan Pascual Sana's avatar
Joan Pascual Sana committed
1168
[BasicAuth](../README.md#BasicAuth)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1169 1170 1171 1172 1173 1174 1175 1176 1177 1178

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | return: vector containing discovered peers, may be empty.   |  -  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1179
**401** | Authentication information is missing or invalid |  * WWW_Authenticate -  <br>  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1180 1181 1182

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Joan Pascual Sana's avatar
Joan Pascual Sana committed
1183
# **rs_config_get_all_bandwidth_rates**
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1184
> RespRsConfigGetAllBandwidthRates rs_config_get_all_bandwidth_rates()
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1185 1186 1187 1188 1189

getAllBandwidthRates get the bandwidth rates for all peers

### Example

Joan Pascual Sana's avatar
Joan Pascual Sana committed
1190
* Basic Authentication (BasicAuth):
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1191 1192 1193 1194 1195 1196
```python
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1197 1198 1199 1200
configuration = openapi_client.Configuration()
# Configure HTTP basic authorization: BasicAuth
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1201

Joan Pascual Sana's avatar
Joan Pascual Sana committed
1202 1203
# Defining host is optional and default to http://127.0.0.1:9092
configuration.host = "http://127.0.0.1:9092"
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1204
# Create an instance of the API class
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1205
api_instance = openapi_client.DefaultApi(openapi_client.ApiClient(configuration))
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1206 1207 1208

try:
    # getAllBandwidthRates get the bandwidth rates for all peers
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1209
    api_response = api_instance.rs_config_get_all_bandwidth_rates()
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1210 1211
    pprint(api_response)
except ApiException as e:
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1212
    print("Exception when calling DefaultApi->rs_config_get_all_bandwidth_rates: %s\n" % e)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1213 1214 1215 1216 1217 1218 1219
```

### Parameters
This endpoint does not need any parameter.

### Return type

Joan Pascual Sana's avatar
Joan Pascual Sana committed
1220
[**RespRsConfigGetAllBandwidthRates**](RespRsConfigGetAllBandwidthRates.md)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1221 1222 1223

### Authorization

Joan Pascual Sana's avatar
Joan Pascual Sana committed
1224
[BasicAuth](../README.md#BasicAuth)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1225 1226 1227 1228 1229 1230 1231 1232 1233

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1234
**200** | return: returns 1 on succes and 0 otherwise  [out] ratemap(map&lt;RsPeerId,RsConfigDataRates&gt;)map with peers-&gt;rates   |  -  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1235
**401** | Authentication information is missing or invalid |  * WWW_Authenticate -  <br>  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1236 1237 1238

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Joan Pascual Sana's avatar
Joan Pascual Sana committed
1239
# **rs_config_get_config_net_status**
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1240
> RespRsConfigGetConfigNetStatus rs_config_get_config_net_status()
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1241 1242 1243 1244 1245

getConfigNetStatus return the net status

### Example

Joan Pascual Sana's avatar
Joan Pascual Sana committed
1246
* Basic Authentication (BasicAuth):
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1247 1248 1249 1250 1251 1252
```python
from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1253 1254 1255 1256
configuration = openapi_client.Configuration()
# Configure HTTP basic authorization: BasicAuth
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1257

Joan Pascual Sana's avatar
Joan Pascual Sana committed
1258 1259
# Defining host is optional and default to http://127.0.0.1:9092
configuration.host = "http://127.0.0.1:9092"
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1260
# Create an instance of the API class
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1261
api_instance = openapi_client.DefaultApi(openapi_client.ApiClient(configuration))
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1262 1263 1264

try:
    # getConfigNetStatus return the net status
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1265
    api_response = api_instance.rs_config_get_config_net_status()
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1266 1267
    pprint(api_response)
except ApiException as e:
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1268
    print("Exception when calling DefaultApi->rs_config_get_config_net_status: %s\n" % e)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1269 1270 1271 1272 1273 1274 1275
```

### Parameters
This endpoint does not need any parameter.

### Return type

Joan Pascual Sana's avatar
Joan Pascual Sana committed
1276
[**RespRsConfigGetConfigNetStatus**](RespRsConfigGetConfigNetStatus.md)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1277 1278 1279

### Authorization

Joan Pascual Sana's avatar
Joan Pascual Sana committed
1280
[BasicAuth](../README.md#BasicAuth)
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1281 1282 1283 1284 1285 1286 1287 1288 1289

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1290
**200** | return: returns 1 on succes and 0 otherwise  [out] status(RsConfigNetStatus)network status   |  -  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1291
**401** | Authentication information is missing or invalid |  * WWW_Authenticate -  <br>  |
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1292 1293 1294

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Joan Pascual Sana's avatar
Joan Pascual Sana committed
1295
# **rs_config_get_current_data_rates**
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1296
> RespRsConfigGetCurrentDataRates rs_config_get_current_data_rates()
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1297 1298 1299 1300 1301

GetCurrentDataRates get current upload and download rates

### Example

Joan Pascual Sana's avatar
Joan Pascual Sana committed
1302
* Basic Authentication (BasicAuth):
Joan Pascual Sana's avatar
Joan Pascual Sana committed
1303 1304 1305 1306 1307