instana_client.SLISettingsApi

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

Method	HTTP request	Description
create_sli_config	POST /api/settings/sli	Create SLI Config
create_sli_config_v2	POST /api/settings/v2/sli	Create SLI Config
delete_sli_config	DELETE /api/settings/sli/{id}	Delete SLI Config
delete_sli_config_v2	DELETE /api/settings/v2/sli/{id}	Delete SLI Config
get_all_sli_configs	GET /api/settings/sli	Get All SLI Configs
get_all_sli_configs_v2	GET /api/settings/v2/sli	Get All SLI Configs
get_sli_config	GET /api/settings/sli/{id}	Get SLI Config
get_sli_config_v2	GET /api/settings/v2/sli/{id}	Get SLI Config
get_sli_configs_for_entity_type_and_id_v2	GET /api/settings/v2/sli/{entityType}/{entityId}	Get all SLI configs for entity type and entity id
update_sli_config	PUT /api/settings/sli/{id}	Update SLI Config

create_sli_config

SliConfigurationWithLastUpdated create_sli_config(sli_configuration)

Create SLI Config

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.models.sli_configuration import SliConfiguration
from instana_client.models.sli_configuration_with_last_updated import SliConfigurationWithLastUpdated
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.SLISettingsApi(api_client)
    sli_configuration = {"sliName":"test-application-sli","metricConfiguration":{"metricName":"latency","metricAggregation":"P90","threshold":555},"sliEntity":{"sliType":"application","applicationId":"btg-B709IU6o9QNXUS4TVw","serviceId":null,"endpointId":null,"boundaryScope":"INBOUND"}} # SliConfiguration | 

    try:
        # Create SLI Config
        api_response = api_instance.create_sli_config(sli_configuration)
        print("The response of SLISettingsApi->create_sli_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SLISettingsApi->create_sli_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
sli_configuration	SliConfiguration

Return type

SliConfigurationWithLastUpdated

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

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

create_sli_config_v2

SliConfigurationWithLastUpdated create_sli_config_v2(sli_configuration)

Create SLI Config

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.models.sli_configuration import SliConfiguration
from instana_client.models.sli_configuration_with_last_updated import SliConfigurationWithLastUpdated
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.SLISettingsApi(api_client)
    sli_configuration = {"sliName":"test-application-sli","metricConfiguration":{"metricName":"latency","metricAggregation":"P90","threshold":555},"sliEntity":{"sliType":"application","applicationId":"btg-B709IU6o9QNXUS4TVw","serviceId":null,"endpointId":null,"boundaryScope":"INBOUND"}} # SliConfiguration | 

    try:
        # Create SLI Config
        api_response = api_instance.create_sli_config_v2(sli_configuration)
        print("The response of SLISettingsApi->create_sli_config_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SLISettingsApi->create_sli_config_v2: %s\n" % e)

Parameters

Name	Type	Description	Notes
sli_configuration	SliConfiguration

Return type

SliConfigurationWithLastUpdated

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	New SLI Configuration Created Successfully	-
400	Bad Request	-
422	Unprocessable Entity	-

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

delete_sli_config

delete_sli_config(id)

Delete SLI Config

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.SLISettingsApi(api_client)
    id = '7iydEfqJQP6AKzd3yR3byw' # str | 

    try:
        # Delete SLI Config
        api_instance.delete_sli_config(id)
    except Exception as e:
        print("Exception when calling SLISettingsApi->delete_sli_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
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]

delete_sli_config_v2

delete_sli_config_v2(id)

Delete SLI Config

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.SLISettingsApi(api_client)
    id = 'HXcNRWhDSWiZs3HiUAKr7g' # str | ID of the Service Level Indicator (SLI)

    try:
        # Delete SLI Config
        api_instance.delete_sli_config_v2(id)
    except Exception as e:
        print("Exception when calling SLISettingsApi->delete_sli_config_v2: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	ID of the Service Level Indicator (SLI)

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	SLI Configuration Deleted Successfully	-

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

get_all_sli_configs

List[SliConfigurationWithLastUpdated] get_all_sli_configs()

Get All SLI Configs

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.models.sli_configuration_with_last_updated import SliConfigurationWithLastUpdated
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.SLISettingsApi(api_client)

    try:
        # Get All SLI Configs
        api_response = api_instance.get_all_sli_configs()
        print("The response of SLISettingsApi->get_all_sli_configs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SLISettingsApi->get_all_sli_configs: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[SliConfigurationWithLastUpdated]

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

get_all_sli_configs_v2

List[SliConfigurationWithLastUpdated] get_all_sli_configs_v2()

Get All SLI Configs

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.models.sli_configuration_with_last_updated import SliConfigurationWithLastUpdated
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.SLISettingsApi(api_client)

    try:
        # Get All SLI Configs
        api_response = api_instance.get_all_sli_configs_v2()
        print("The response of SLISettingsApi->get_all_sli_configs_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SLISettingsApi->get_all_sli_configs_v2: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[SliConfigurationWithLastUpdated]

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

get_sli_config

SliConfigurationWithLastUpdated get_sli_config(id)

Get SLI Config

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.models.sli_configuration_with_last_updated import SliConfigurationWithLastUpdated
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.SLISettingsApi(api_client)
    id = '3J0RDgfyQz-P_hVzbNNb4A' # str | 

    try:
        # Get SLI Config
        api_response = api_instance.get_sli_config(id)
        print("The response of SLISettingsApi->get_sli_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SLISettingsApi->get_sli_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

SliConfigurationWithLastUpdated

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

get_sli_config_v2

SliConfigurationWithLastUpdated get_sli_config_v2(id)

Get SLI Config

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.models.sli_configuration_with_last_updated import SliConfigurationWithLastUpdated
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.SLISettingsApi(api_client)
    id = 'HXcNRWhDSWiZs3HiUAKr7g' # str | ID of the Service Level Indicator (SLI)

    try:
        # Get SLI Config
        api_response = api_instance.get_sli_config_v2(id)
        print("The response of SLISettingsApi->get_sli_config_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SLISettingsApi->get_sli_config_v2: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	ID of the Service Level Indicator (SLI)

Return type

SliConfigurationWithLastUpdated

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
404	SLI Configuration Not Found	-

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

get_sli_configs_for_entity_type_and_id_v2

List[SliConfigurationWithLastUpdated] get_sli_configs_for_entity_type_and_id_v2(entity_type, entity_id)

Get all SLI configs for entity type and entity id

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.models.sli_configuration_with_last_updated import SliConfigurationWithLastUpdated
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.SLISettingsApi(api_client)
    entity_type = 'entity_type_example' # str | Type of the Entity, whether it is an application or website
    entity_id = 'DkPX-x9VQuKBKopuilrkYw' # str | Unique ID of the Entity

    try:
        # Get all SLI configs for entity type and entity id
        api_response = api_instance.get_sli_configs_for_entity_type_and_id_v2(entity_type, entity_id)
        print("The response of SLISettingsApi->get_sli_configs_for_entity_type_and_id_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SLISettingsApi->get_sli_configs_for_entity_type_and_id_v2: %s\n" % e)

Parameters

Name	Type	Description	Notes
entity_type	str	Type of the Entity, whether it is an application or website
entity_id	str	Unique ID of the Entity

Return type

List[SliConfigurationWithLastUpdated]

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

update_sli_config

SliConfigurationWithLastUpdated update_sli_config(id, sli_configuration)

Update SLI Config

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.models.sli_configuration import SliConfiguration
from instana_client.models.sli_configuration_with_last_updated import SliConfigurationWithLastUpdated
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.SLISettingsApi(api_client)
    id = '3J0RDgfyQz-P_hVzbNNb4A' # str | 
    sli_configuration = {"id":"3J0RDgfyQz-P_hVzbNNb4A","sliName":"test-application-sli","initialEvaluationTimestamp":1732017600000,"metricConfiguration":{"metricName":"latency","metricAggregation":"P90","threshold":555},"sliEntity":{"sliType":"application","applicationId":"btg-B709IU6o9QNXUS4TVw","serviceId":null,"endpointId":null,"boundaryScope":"INBOUND"},"lastUpdated":1732017541059} # SliConfiguration | 

    try:
        # Update SLI Config
        api_response = api_instance.update_sli_config(id, sli_configuration)
        print("The response of SLISettingsApi->update_sli_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SLISettingsApi->update_sli_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
sli_configuration	SliConfiguration

Return type

SliConfigurationWithLastUpdated

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

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

Uh oh!

FilesExpand file tree

SLISettingsApi.md

Latest commit

History

SLISettingsApi.md

File metadata and controls

instana_client.SLISettingsApi

create_sli_config

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_sli_config_v2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_sli_config

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_sli_config_v2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_all_sli_configs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_all_sli_configs_v2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_sli_config

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_sli_config_v2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_sli_configs_for_entity_type_and_id_v2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_sli_config

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details