Security Client
- class opensearchpy.client.security.SecurityClient(client)[source]
Bases:
NamespacedClient
- Parameters:
client (Any) –
- authinfo(*, params=None, headers=None)[source]
Returns or updates authentication information for the currently authenticated user.
- Parameters:
auth_type – The type of the current authentication request.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
verbose – Whether to return a verbose response.
params (Any) –
headers (Any) –
- Return type:
- authtoken(*, params=None, headers=None)[source]
Returns the authorization token for the current user.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- cache(*, params=None, headers=None)[source]
Not supported for the Cache API.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- change_password(*, body, params=None, headers=None)[source]
Changes the password for the current user.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- config_upgrade_check(*, params=None, headers=None)[source]
Checks whether or not an upgrade can be performed and which security resources can be updated.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- config_upgrade_perform(*, body=None, params=None, headers=None)[source]
Assists the cluster operator with upgrading missing default values and stale default definitions.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- create_action_group(*, action_group, body, params=None, headers=None)[source]
Creates or replaces the specified action group.
- Parameters:
action_group (Any) – The name of the action group to create or replace.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
action_group –
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- create_allowlist(*, body, params=None, headers=None)[source]
Creates or replaces APIs permitted for users on the allow list. Requires a super admin certificate or REST API permissions.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- create_role(*, role, body, params=None, headers=None)[source]
Creates or replaces the specified role.
- Parameters:
role (Any) – The name of the role to create.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
role –
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- create_role_mapping(*, role, body, params=None, headers=None)[source]
Creates or replaces the specified role mapping.
- Parameters:
role (Any) – The name of the role for which to create a role mapping.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
role –
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- create_tenant(*, tenant, body, params=None, headers=None)[source]
Creates or replaces the specified tenant.
- Parameters:
tenant (Any) – The name of the tenant to create.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
tenant –
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- create_update_tenancy_config(*, body, params=None, headers=None)[source]
Creates or replaces the multi-tenancy configuration. Requires super admin or REST API permissions.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- create_user(*, username, body, params=None, headers=None)[source]
Creates or replaces the specified user.
- Parameters:
username (Any) – The name of the user to create.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
username –
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- create_user_legacy(*, username, body, params=None, headers=None)[source]
Creates or replaces the specified user. Legacy API.
- Parameters:
username (Any) – The name of the user to create.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
username –
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- delete_action_group(*, action_group, params=None, headers=None)[source]
Deletes the specified action group.
- Parameters:
action_group (Any) – The name of the action group to delete.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
action_group –
params (Any) –
headers (Any) –
- Return type:
- delete_distinguished_name(*, cluster_name, params=None, headers=None)[source]
Deletes all distinguished names in the specified cluster or node allowlist. Requires super admin or REST API permissions.
- Parameters:
cluster_name (Any) – The cluster name to delete from list of distinguished names.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
cluster_name –
params (Any) –
headers (Any) –
- Return type:
- delete_role(*, role, params=None, headers=None)[source]
Deletes the specified role.
- Parameters:
role (Any) – The name of the role to delete.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
role –
params (Any) –
headers (Any) –
- Return type:
- delete_role_mapping(*, role, params=None, headers=None)[source]
Deletes the specified role mapping.
- Parameters:
role (Any) – The name of the role for which to delete the role’s mappings.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
role –
params (Any) –
headers (Any) –
- Return type:
- delete_tenant(*, tenant, params=None, headers=None)[source]
Deletes the specified tenant.
- Parameters:
tenant (Any) – The name of the tenant to delete.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
tenant –
params (Any) –
headers (Any) –
- Return type:
- delete_user(*, username, params=None, headers=None)[source]
Deletes the specified internal user.
- Parameters:
username (Any) – The name of the user to delete.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
username –
params (Any) –
headers (Any) –
- Return type:
- delete_user_legacy(*, username, params=None, headers=None)[source]
Delete the specified user. Legacy API.
- Parameters:
username (Any) – The name of the user to delete.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
username –
params (Any) –
headers (Any) –
- Return type:
- flush_cache(*, params=None, headers=None)[source]
Flushes the Security plugin’s user, authentication, and authorization cache.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- generate_obo_token(*, body, params=None, headers=None)[source]
Generates a On-Behalf-Of token for the current user.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- generate_user_token(*, username, params=None, headers=None)[source]
Generates an authorization token for the specified user.
- Parameters:
username (Any) – The name of the user for whom to issue an authorization token.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
username –
params (Any) –
headers (Any) –
- Return type:
- generate_user_token_legacy(*, username, params=None, headers=None)[source]
Generates authorization token for the given user. Legacy API. Not Implemented.
- Parameters:
username (Any) – The name of the user for whom to issue an authorization token.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
username –
params (Any) –
headers (Any) –
- Return type:
- get_account_details(*, params=None, headers=None)[source]
Returns account information for the current user.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- get_action_group(*, action_group, params=None, headers=None)[source]
Retrieves one action group.
- Parameters:
action_group (Any) – The name of the action group to retrieve.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
action_group –
params (Any) –
headers (Any) –
- Return type:
- get_action_groups(*, params=None, headers=None)[source]
Retrieves all action groups.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- get_all_certificates(*, params=None, headers=None)[source]
Retrieves the cluster security certificates.
- Parameters:
cert_type – The type of certificates (HTTP, TRANSPORT, or ALL) to retrieve from all nodes.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
timeout – The maximum duration, in seconds, to spend retrieving certificates from all nodes before a timeout.
params (Any) –
headers (Any) –
- Return type:
- get_allowlist(*, params=None, headers=None)[source]
Retrieves the current list of allowed APIs accessible to a normal user.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- get_audit_configuration(*, params=None, headers=None)[source]
Retrieves the audit configuration.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- get_certificates(*, params=None, headers=None)[source]
Retrieves the cluster security certificates.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- get_configuration(*, params=None, headers=None)[source]
Returns the current Security plugin configuration in a JSON format.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- get_dashboards_info(*, params=None, headers=None)[source]
Retrieves the current values for dynamic security settings for OpenSearch Dashboards.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- get_distinguished_name(*, cluster_name, params=None, headers=None)[source]
Retrieves all node distinguished names. Requires super admin or REST API permissions.
- Parameters:
cluster_name (Any) – The name of the cluster to retrieve that cluster’s nodes DN settings.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
show_all – Whether to include or exclude any static node’s DN settings from the final result.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
cluster_name –
params (Any) –
headers (Any) –
- Return type:
- get_distinguished_names(*, params=None, headers=None)[source]
Retrieves all node distinguished names. Requires super admin or REST API permissions.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
show_all – Whether to include or exclude any static node’s DN settings from the final result.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- get_node_certificates(*, node_id, params=None, headers=None)[source]
Retrieves the specified node’s security certificates.
- Parameters:
node_id (Any) – The node ID to retrieve certificates for.
cert_type – The type of certificates (HTTP, TRANSPORT, or ALL) to retrieve from a node.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
timeout – The maximum duration, in seconds, to spend retrieving certificates from all nodes before a timeout.
node_id –
params (Any) –
headers (Any) –
- Return type:
- get_permissions_info(*, params=None, headers=None)[source]
Retrieves the evaluated REST API permissions for the currently logged in user.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- get_role(*, role, params=None, headers=None)[source]
Retrieves one role.
- Parameters:
role (Any) – The name of the role to retrieve.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
role –
params (Any) –
headers (Any) –
- Return type:
- get_role_mapping(*, role, params=None, headers=None)[source]
Retrieves the specified role mapping.
- Parameters:
role (Any) – The name of the role mapping to retrieve.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
role –
params (Any) –
headers (Any) –
- Return type:
- get_role_mappings(*, params=None, headers=None)[source]
Retrieves all role mappings.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- get_roles(*, params=None, headers=None)[source]
Retrieves all roles.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- get_sslinfo(*, params=None, headers=None)[source]
Retrieves information about the SSL configuration.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
show_dn – Whether to include all domain names in the response.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- get_tenancy_config(*, params=None, headers=None)[source]
Retrieves the multi-tenancy configuration. Requires super admin or REST API permissions.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- get_tenant(*, tenant, params=None, headers=None)[source]
Retrieves the specified tenant.
- Parameters:
tenant (Any) – The name of the tenant to retrieve.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
tenant –
params (Any) –
headers (Any) –
- Return type:
- get_tenants(*, params=None, headers=None)[source]
Retrieves all tenants.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- get_user(*, username, params=None, headers=None)[source]
Retrieve information about the specified internal user.
- Parameters:
username (Any) – The name of the user to retrieve.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
username –
params (Any) –
headers (Any) –
- Return type:
- get_user_legacy(*, username, params=None, headers=None)[source]
Retrieve one user. Legacy API.
- Parameters:
username (Any) – The name of the user to retrieve.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
username –
params (Any) –
headers (Any) –
- Return type:
- get_users(*, params=None, headers=None)[source]
Retrieve all internal users.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- get_users_legacy(*, params=None, headers=None)[source]
Retrieve all internal users. Legacy API.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- health(*, params=None, headers=None)[source]
Checks to see if the Security plugin is running.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
mode – A flag that determines whether to consider the security status before returning a response for a health query response. For example, strict mode indicates service should check the Security plugin status.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- migrate(*, params=None, headers=None)[source]
Migrates the security configuration from v6 to v7.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- patch_action_group(*, action_group, body, params=None, headers=None)[source]
Updates the individual attributes of an action group.
- Parameters:
action_group (Any) – The name of the action group to update.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
action_group –
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- patch_action_groups(*, body, params=None, headers=None)[source]
Creates, updates, or deletes multiple action groups in a single request.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- patch_allowlist(*, body, params=None, headers=None)[source]
Updates the current list of APIs accessible for users on the allow list.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- patch_audit_configuration(*, body, params=None, headers=None)[source]
Updates the specified fields in the audit configuration.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- patch_configuration(*, body, params=None, headers=None)[source]
Updates the existing security configuration using the REST API. Requires super admin or REST API permissions.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- patch_distinguished_name(*, cluster_name, body=None, params=None, headers=None)[source]
Updates the distinguished cluster name for the specified cluster. Requires super admin or REST API permissions.
- Parameters:
cluster_name (Any) – The cluster name to update the nodesDn value.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
cluster_name –
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- patch_distinguished_names(*, body, params=None, headers=None)[source]
Bulk updates specified node distinguished names. Requires super admin or REST API permissions.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- patch_role(*, role, body, params=None, headers=None)[source]
Updates the individual attributes of a role.
- Parameters:
role (Any) – The name of the role to update.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
role –
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- patch_role_mapping(*, role, body, params=None, headers=None)[source]
Updates the individual attributes of a role mapping.
- Parameters:
role (Any) – The name of the role to update a role mapping for
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
role –
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- patch_role_mappings(*, body, params=None, headers=None)[source]
Creates or updates multiple role mappings in a single request.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- patch_roles(*, body, params=None, headers=None)[source]
Creates, updates, or deletes multiple roles in a single call.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- patch_tenant(*, tenant, body, params=None, headers=None)[source]
Adds, deletes, or modifies a single tenant.
- Parameters:
tenant (Any) – The name of the tenant to update.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
tenant –
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- patch_tenants(*, body, params=None, headers=None)[source]
Adds, deletes, or modifies multiple tenants in a single request.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- patch_user(*, username, body, params=None, headers=None)[source]
Updates individual attributes for an internal user.
- Parameters:
username (Any) – The name of the user to update.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
username –
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- patch_users(*, body, params=None, headers=None)[source]
Creates, updates, or deletes multiple internal users in a single request.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- post_dashboards_info(*, params=None, headers=None)[source]
Retrieves the current values for dynamic security settings for OpenSearch Dashboards.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- reload_http_certificates(*, params=None, headers=None)[source]
Reloads the HTTP communication certificates.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- reload_transport_certificates(*, params=None, headers=None)[source]
Reloads the transport communication certificates.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- tenant_info(*, params=None, headers=None)[source]
Retrieves the names of current tenants. Requires super admin or kibanaserver permissions.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- update_audit_configuration(*, body, params=None, headers=None)[source]
Updates the audit configuration.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- update_configuration(*, body, params=None, headers=None)[source]
Updates the settings for an existing security configuration. Requires super admin or REST API permissions.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- update_distinguished_name(*, cluster_name, body=None, params=None, headers=None)[source]
Adds or updates the specified distinguished names in the cluster or node allowlist. Requires super admin or REST API permissions.
- Parameters:
cluster_name (Any) – The name of the cluster containing the nodesDn value to create or update.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
cluster_name –
body (Any) –
params (Any) –
headers (Any) –
- Return type:
- validate(*, params=None, headers=None)[source]
Checks whether the v6 security configuration is valid and ready to be migrated to v7.
- Parameters:
accept_invalid – Whether an invalid v6 configuration should be allowed.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- who_am_i(*, params=None, headers=None)[source]
Gets the identity information for the user currently logged in.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type:
- who_am_i_protected(*, params=None, headers=None)[source]
Gets the identity information for the user currently logged in. To use this operation, you must have access to this endpoint when authorization at REST layer is enabled.
- Parameters:
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –
- Return type: