DefaultApi.md

instana_client.DefaultApi

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

Method	HTTP request	Description
get_internal_custom_dashboards	GET /api/internal/custom-dashboard
get_internal_dashboard	GET /api/internal/custom-dashboard/{dashboardId}

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]