WickrAdminAPI / Client / get_network_settings

get_network_settings¶

WickrAdminAPI.Client.get_network_settings(**kwargs)¶

Retrieves all network-level settings for a Wickr network, including client metrics, data retention, and other configuration options.

See also: AWS API Documentation

Request Syntax

response = client.get_network_settings(
    networkId='string'
)

Parameters:

networkId (string) –

[REQUIRED]

The ID of the Wickr network whose settings will be retrieved.

Return type:

dict

Returns:

Response Syntax

{
    'settings': [
        {
            'optionName': 'string',
            'value': 'string',
            'type': 'string'
        },
    ]
}

Response Structure

(dict) –
- settings (list) –
  
  A list of network settings, where each setting includes a name, value, and type.
  - (dict) –
    
    Represents a single network-level configuration setting with its name, value, and data type. Settings control network-wide behaviors and features.
    - optionName (string) –
      
      The name of the network setting (e.g., ‘enableClientMetrics’, ‘dataRetention’).
    - value (string) –
      
      The current value of the setting as a string. Boolean values are represented as ‘true’ or ‘false’.
    - type (string) –
      
      The data type of the setting value (e.g., ‘boolean’, ‘string’, ‘number’).

Exceptions