instana_client.DefaultApi

All URIs are relative to https://unit-tenant.instana.io

Method	HTTP request	Description
delete	DELETE /api/filters/{id}
delete_trace_sampling_config	DELETE /api/settings/trace-sampling	Delete trace sampling configuration
encrypt	POST /api/encrypt
get	GET /api/filters
get1	GET /api/license
get2	GET /api/tos-privacy-agreement/checkUserAcceptance
get3	GET /api/user-settings
get_internal_custom_dashboards	GET /api/internal/custom-dashboard
get_internal_dashboard	GET /api/internal/custom-dashboard/{dashboardId}
get_latest_tos_privacy_agreement	GET /api/tos-privacy-agreement/latest
get_merged_user_permissions	GET /api/settings/users/{userId}/mergedPermissions
get_trace_sampling_config	GET /api/settings/trace-sampling	Get trace sampling configuration
get_two_factor_credentials	GET /api/settings/authentication/2fa/credentials
get_ui_settings	GET /api/ui/settings
get_user_permissions	GET /api/permissions
get_user_permissions_by_id	GET /api/permissions/{userId}
post	POST /api/filters
post_change_password	POST /api/settings/authentication/changePassword
put	PUT /api/filters/{id}
put1	PUT /api/user-settings
put_ui_setting	PUT /api/ui/settings/{setting}
put_ui_settings	PUT /api/ui/settings
toggle2_fa	POST /api/settings/authentication/2fa/toggle
toggle2_fa1	POST /api/settings/authentication/2fa/verify/{token}
tos_privacy_agreement	POST /api/tos-privacy-agreement
update_trace_sampling_config	PUT /api/settings/trace-sampling	Update trace sampling configuration

delete

delete(id)

Example

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)


# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.DefaultApi(api_client)
    id = 'id_example' # str | 

    try:
        api_instance.delete(id)
    except Exception as e:
        print("Exception when calling DefaultApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
0	default response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_trace_sampling_config

delete_trace_sampling_config()

Delete trace sampling configuration

Deletes the trace sampling configuration for the current tenant

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.DefaultApi(api_client)

    try:
        # Delete trace sampling configuration
        api_instance.delete_trace_sampling_config()
    except Exception as e:
        print("Exception when calling DefaultApi->delete_trace_sampling_config: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Trace sampling configuration deleted successfully	-
401	Unauthorized access - requires user authentication.	-
403	Insufficient permissions or limited in access.	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

encrypt

str encrypt(customer_email=customer_email)

Example

import instana_client
from instana_client.models.customer_email import CustomerEmail
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)


# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.DefaultApi(api_client)
    customer_email = instana_client.CustomerEmail() # CustomerEmail |  (optional)

    try:
        api_response = api_instance.encrypt(customer_email=customer_email)
        print("The response of DefaultApi->encrypt:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->encrypt: %s\n" % e)

Parameters

Name	Type	Description	Notes
customer_email	CustomerEmail		[optional]

Return type

str

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: /

HTTP response details

Status code	Description	Response headers
0	default response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get

get()

Example

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)


# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.DefaultApi(api_client)

    try:
        api_instance.get()
    except Exception as e:
        print("Exception when calling DefaultApi->get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
0	default response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get1

get1()

Example

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)


# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.DefaultApi(api_client)

    try:
        api_instance.get1()
    except Exception as e:
        print("Exception when calling DefaultApi->get1: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
0	default response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get2

bool get2()

Example

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)


# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.DefaultApi(api_client)

    try:
        api_response = api_instance.get2()
        print("The response of DefaultApi->get2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get2: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

bool

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
0	default response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get3

get3()

Example

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)


# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.DefaultApi(api_client)

    try:
        api_instance.get3()
    except Exception as e:
        print("Exception when calling DefaultApi->get3: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
0	default response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_internal_custom_dashboards

get_internal_custom_dashboards(query=query, page_size=page_size, page=page, with_total_hits=with_total_hits)

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.DefaultApi(api_client)
    query = 'BeeInstana' # str | query (optional)
    page_size = 2 # int | pageSize (optional)
    page = 1 # int | page (optional)
    with_total_hits = false # bool | withTotalHits (optional)

    try:
        api_instance.get_internal_custom_dashboards(query=query, page_size=page_size, page=page, with_total_hits=with_total_hits)
    except Exception as e:
        print("Exception when calling DefaultApi->get_internal_custom_dashboards: %s\n" % e)

Parameters

Name	Type	Description	Notes
query	str	query	[optional]
page_size	int	pageSize	[optional]
page	int	page	[optional]
with_total_hits	bool	withTotalHits	[optional]

Return type

void (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
0	default response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_internal_dashboard

get_internal_dashboard(dashboard_id)

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.DefaultApi(api_client)
    dashboard_id = 'dashboard_id_example' # str | 

    try:
        api_instance.get_internal_dashboard(dashboard_id)
    except Exception as e:
        print("Exception when calling DefaultApi->get_internal_dashboard: %s\n" % e)

Parameters

Name	Type	Description	Notes
dashboard_id	str

Return type

void (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
0	default response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_latest_tos_privacy_agreement

get_latest_tos_privacy_agreement()

Example

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)


# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.DefaultApi(api_client)

    try:
        api_instance.get_latest_tos_privacy_agreement()
    except Exception as e:
        print("Exception when calling DefaultApi->get_latest_tos_privacy_agreement: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
0	default response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_merged_user_permissions

get_merged_user_permissions(user_id)

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.DefaultApi(api_client)
    user_id = 'user_id_example' # str | 

    try:
        api_instance.get_merged_user_permissions(user_id)
    except Exception as e:
        print("Exception when calling DefaultApi->get_merged_user_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str

Return type

void (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
0	default response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_trace_sampling_config

TraceSamplingConfig get_trace_sampling_config()

Get trace sampling configuration

Retrieves the trace sampling configuration for the current tenant

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.models.trace_sampling_config import TraceSamplingConfig
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.DefaultApi(api_client)

    try:
        # Get trace sampling configuration
        api_response = api_instance.get_trace_sampling_config()
        print("The response of DefaultApi->get_trace_sampling_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_trace_sampling_config: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

TraceSamplingConfig

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Trace sampling configuration retrieved successfully	-
401	Unauthorized access - requires user authentication.	-
403	Insufficient permissions or limited in access.	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_two_factor_credentials

get_two_factor_credentials()

Example

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)


# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.DefaultApi(api_client)

    try:
        api_instance.get_two_factor_credentials()
    except Exception as e:
        print("Exception when calling DefaultApi->get_two_factor_credentials: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
0	default response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_ui_settings

get_ui_settings()

Example

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)


# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.DefaultApi(api_client)

    try:
        api_instance.get_ui_settings()
    except Exception as e:
        print("Exception when calling DefaultApi->get_ui_settings: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
0	default response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_user_permissions

get_user_permissions()

Example

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)


# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.DefaultApi(api_client)

    try:
        api_instance.get_user_permissions()
    except Exception as e:
        print("Exception when calling DefaultApi->get_user_permissions: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
0	default response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_user_permissions_by_id

get_user_permissions_by_id(user_id)

Example

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)


# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.DefaultApi(api_client)
    user_id = 'user_id_example' # str | 

    try:
        api_instance.get_user_permissions_by_id(user_id)
    except Exception as e:
        print("Exception when calling DefaultApi->get_user_permissions_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
0	default response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post

post()

Example

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)


# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.DefaultApi(api_client)

    try:
        api_instance.post()
    except Exception as e:
        print("Exception when calling DefaultApi->post: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
0	default response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_change_password

post_change_password()

Example

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)


# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.DefaultApi(api_client)

    try:
        api_instance.post_change_password()
    except Exception as e:
        print("Exception when calling DefaultApi->post_change_password: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
0	default response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

put

put(id)

Example

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)


# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.DefaultApi(api_client)
    id = 'id_example' # str | 

    try:
        api_instance.put(id)
    except Exception as e:
        print("Exception when calling DefaultApi->put: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
0	default response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

put1

put1()

Example

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)


# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.DefaultApi(api_client)

    try:
        api_instance.put1()
    except Exception as e:
        print("Exception when calling DefaultApi->put1: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
0	default response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

put_ui_setting

put_ui_setting(setting)

Example

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)


# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.DefaultApi(api_client)
    setting = 'setting_example' # str | 

    try:
        api_instance.put_ui_setting(setting)
    except Exception as e:
        print("Exception when calling DefaultApi->put_ui_setting: %s\n" % e)

Parameters

Name	Type	Description	Notes
setting	str

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
0	default response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

put_ui_settings

put_ui_settings()

Example

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)


# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.DefaultApi(api_client)

    try:
        api_instance.put_ui_settings()
    except Exception as e:
        print("Exception when calling DefaultApi->put_ui_settings: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
0	default response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

toggle2_fa

toggle2_fa()

Example

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)


# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.DefaultApi(api_client)

    try:
        api_instance.toggle2_fa()
    except Exception as e:
        print("Exception when calling DefaultApi->toggle2_fa: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
0	default response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

toggle2_fa1

toggle2_fa1(token)

Example

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)


# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.DefaultApi(api_client)
    token = 56 # int | 

    try:
        api_instance.toggle2_fa1(token)
    except Exception as e:
        print("Exception when calling DefaultApi->toggle2_fa1: %s\n" % e)

Parameters

Name	Type	Description	Notes
token	int

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
0	default response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tos_privacy_agreement

tos_privacy_agreement()

Example

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)


# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.DefaultApi(api_client)

    try:
        api_instance.tos_privacy_agreement()
    except Exception as e:
        print("Exception when calling DefaultApi->tos_privacy_agreement: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
0	default response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_trace_sampling_config

TraceSamplingConfig update_trace_sampling_config(trace_sampling_config)

Update trace sampling configuration

Creates or updates the trace sampling configuration for the current tenant

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.models.trace_sampling_config import TraceSamplingConfig
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.DefaultApi(api_client)
    trace_sampling_config = instana_client.TraceSamplingConfig() # TraceSamplingConfig | Trace sampling configuration

    try:
        # Update trace sampling configuration
        api_response = api_instance.update_trace_sampling_config(trace_sampling_config)
        print("The response of DefaultApi->update_trace_sampling_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_trace_sampling_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
trace_sampling_config	TraceSamplingConfig	Trace sampling configuration

Return type

TraceSamplingConfig

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Trace sampling configuration updated successfully	-
401	Unauthorized access - requires user authentication.	-
403	Insufficient permissions or limited in access.	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Uh oh!

FilesExpand file tree

DefaultApi.md

Latest commit

History

DefaultApi.md

File metadata and controls

instana_client.DefaultApi

delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_trace_sampling_config

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

encrypt

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get3

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_internal_custom_dashboards

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_internal_dashboard

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_latest_tos_privacy_agreement

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_merged_user_permissions

Example