instana_client.SyntheticAlertConfigurationApi

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

Method	HTTP request	Description
bulk_delete_synthetic_alert_configs	PUT /api/events/settings/global-alert-configs/synthetics/bulk/delete	Bulk Delete Synthetic Smart Alert Configs
bulk_disable_synthetic_alert_configs	PUT /api/events/settings/global-alert-configs/synthetics/bulk/disable	Bulk Disable Synthetic Smart Alert Configs
bulk_enable_synthetic_alert_configs	PUT /api/events/settings/global-alert-configs/synthetics/bulk/enable	Bulk Enable Synthetic Smart Alert Configs
create_synthetic_alert_config	POST /api/events/settings/global-alert-configs/synthetics	Create Synthetic Smart Alert Config
delete_synthetic_alert_config	DELETE /api/events/settings/global-alert-configs/synthetics/{id}	Delete Synthetic Smart Alert Config
disable_synthetic_alert_config	PUT /api/events/settings/global-alert-configs/synthetics/{id}/disable	Disable Synthetic Smart Alert Config
enable_synthetic_alert_config	PUT /api/events/settings/global-alert-configs/synthetics/{id}/enable	Enable Synthetic Smart Alert Config
find_active_synthetic_alert_configs	GET /api/events/settings/global-alert-configs/synthetics	Get all Synthetic Smart Alert Configs
find_synthetic_alert_config	GET /api/events/settings/global-alert-configs/synthetics/{id}	Get Synthetic Smart Alert Config
find_synthetic_alert_config_versions	GET /api/events/settings/global-alert-configs/synthetics/{id}/versions	Get Synthetic Smart Alert Config Versions
restore_synthetic_alert_config	PUT /api/events/settings/global-alert-configs/synthetics/{id}/restore/{created}	Restore Synthetic Smart Alert Config
update_synthetic_alert_config	POST /api/events/settings/global-alert-configs/synthetics/{id}	Update Synthetic Smart Alert Config

bulk_delete_synthetic_alert_configs

bulk_delete_synthetic_alert_configs(request_body)

Bulk Delete Synthetic Smart Alert Configs

Deletes multiple Synthetic Smart Alert Configurations. For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration.

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.SyntheticAlertConfigurationApi(api_client)
    request_body = ['request_body_example'] # List[str] | 

    try:
        # Bulk Delete Synthetic Smart Alert Configs
        api_instance.bulk_delete_synthetic_alert_configs(request_body)
    except Exception as e:
        print("Exception when calling SyntheticAlertConfigurationApi->bulk_delete_synthetic_alert_configs: %s\n" % e)

Parameters

Name	Type	Description	Notes
request_body	List[str]

Return type

void (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Successful - no content to return.	-
400	Bad request.	-
403	Insufficient permissions or limited in access.	-

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

bulk_disable_synthetic_alert_configs

bulk_disable_synthetic_alert_configs(request_body)

Bulk Disable Synthetic Smart Alert Configs

Disables multiple Synthetic Smart Alert Configurations. For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration.

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.SyntheticAlertConfigurationApi(api_client)
    request_body = ['request_body_example'] # List[str] | 

    try:
        # Bulk Disable Synthetic Smart Alert Configs
        api_instance.bulk_disable_synthetic_alert_configs(request_body)
    except Exception as e:
        print("Exception when calling SyntheticAlertConfigurationApi->bulk_disable_synthetic_alert_configs: %s\n" % e)

Parameters

Name	Type	Description	Notes
request_body	List[str]

Return type

void (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Successful - no content to return.	-
400	Bad request.	-
403	Insufficient permissions or limited in access.	-

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

bulk_enable_synthetic_alert_configs

bulk_enable_synthetic_alert_configs(request_body)

Bulk Enable Synthetic Smart Alert Configs

Enables multiple Synthetic Smart Alert Configurations. For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration.

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.SyntheticAlertConfigurationApi(api_client)
    request_body = ['request_body_example'] # List[str] | 

    try:
        # Bulk Enable Synthetic Smart Alert Configs
        api_instance.bulk_enable_synthetic_alert_configs(request_body)
    except Exception as e:
        print("Exception when calling SyntheticAlertConfigurationApi->bulk_enable_synthetic_alert_configs: %s\n" % e)

Parameters

Name	Type	Description	Notes
request_body	List[str]

Return type

void (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Successful - no content to return.	-
400	Bad request.	-
403	Insufficient permissions or limited in access.	-

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

create_synthetic_alert_config

SyntheticAlertConfigWithMetadata create_synthetic_alert_config(synthetic_alert_config)

Create Synthetic Smart Alert Config

Creates a new Synthetic Smart Alert Configuration. For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration.

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.models.synthetic_alert_config import SyntheticAlertConfig
from instana_client.models.synthetic_alert_config_with_metadata import SyntheticAlertConfigWithMetadata
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.SyntheticAlertConfigurationApi(api_client)
    synthetic_alert_config = {"name":"2 consecutive failures of ${synthetic.testName} at locations${synthetic.locationLabel}","description":"Alert created without test but with AppId - Synthetic test failed for 2 consecutive times","syntheticTestIds":["ic25Vt1T5dgKzi0K7812","2gBxQz3oKtXgFXzRoQ6O"],"severity":5,"tagFilterExpression":{"type":"TAG_FILTER","name":"synthetic.applicationId","stringValue":"2BPCBLz_RBG8J6mjyuxm6w","numberValue":null,"booleanValue":null,"key":null,"value":"2BPCBLz_RBG8J6mjyuxm6w","operator":"EQUALS","entity":"NOT_APPLICABLE"},"rule":{"alertType":"failure","metricName":"status","aggregation":"SUM"},"alertChannelIds":["0o1ISHPfR8-N4iUK"],"timeThreshold":{"type":"violationsInSequence","violationsCount":2},"customPayloadFields":[]} # SyntheticAlertConfig | 

    try:
        # Create Synthetic Smart Alert Config
        api_response = api_instance.create_synthetic_alert_config(synthetic_alert_config)
        print("The response of SyntheticAlertConfigurationApi->create_synthetic_alert_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SyntheticAlertConfigurationApi->create_synthetic_alert_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
synthetic_alert_config	SyntheticAlertConfig

Return type

SyntheticAlertConfigWithMetadata

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad request.	-
403	Insufficient permissions or limited in access.	-
422	Unprocessable request - missing/invalid data.	-

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

delete_synthetic_alert_config

delete_synthetic_alert_config(id)

Delete Synthetic Smart Alert Config

Deletes a Synthetic Smart Alert Configuration. For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration.

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.SyntheticAlertConfigurationApi(api_client)
    id = '2K1YQIeaSQKIcIkHPH7D3g' # str | ID of a specific Synthetic Smart Alert Configuration to delete.

    try:
        # Delete Synthetic Smart Alert Config
        api_instance.delete_synthetic_alert_config(id)
    except Exception as e:
        print("Exception when calling SyntheticAlertConfigurationApi->delete_synthetic_alert_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	ID of a specific Synthetic Smart Alert Configuration to delete.

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	Successful - no content to return.	-
403	Insufficient permissions or limited in access.	-
404	Resource not found.	-

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

disable_synthetic_alert_config

disable_synthetic_alert_config(id, body=body)

Disable Synthetic Smart Alert Config

Disables a Synthetic Smart Alert Configuration. For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration.

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.SyntheticAlertConfigurationApi(api_client)
    id = '2K1YQIeaSQKIcIkHPH7D3g' # str | ID of a specific Synthetic Smart Alert Configuration to disable.
    body = 'body_example' # str |  (optional)

    try:
        # Disable Synthetic Smart Alert Config
        api_instance.disable_synthetic_alert_config(id, body=body)
    except Exception as e:
        print("Exception when calling SyntheticAlertConfigurationApi->disable_synthetic_alert_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	ID of a specific Synthetic Smart Alert Configuration to disable.
body	str		[optional]

Return type

void (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Successful - no content to return.	-
403	Insufficient permissions or limited in access.	-
404	Resource not found.	-

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

enable_synthetic_alert_config

enable_synthetic_alert_config(id, body=body)

Enable Synthetic Smart Alert Config

Enables a Synthetic Smart Alert Configuration. For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration.

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.SyntheticAlertConfigurationApi(api_client)
    id = '2K1YQIeaSQKIcIkHPH7D3g' # str | ID of a specific Synthetic Smart Alert Configuration to enable.
    body = 'body_example' # str |  (optional)

    try:
        # Enable Synthetic Smart Alert Config
        api_instance.enable_synthetic_alert_config(id, body=body)
    except Exception as e:
        print("Exception when calling SyntheticAlertConfigurationApi->enable_synthetic_alert_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	ID of a specific Synthetic Smart Alert Configuration to enable.
body	str		[optional]

Return type

void (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Successful - no content to return.	-
403	Insufficient permissions or limited in access.	-
404	Resource not found.	-

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

find_active_synthetic_alert_configs

List[SyntheticAlertConfigWithMetadata] find_active_synthetic_alert_configs(synthetic_test_id=synthetic_test_id, alert_ids=alert_ids)

Get all Synthetic Smart Alert Configs

Gets all the Synthetic Smart Alert Configuration pertaining to a specific synthetic test. Configurations are sorted by creation date in descending order. For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration.

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.models.synthetic_alert_config_with_metadata import SyntheticAlertConfigWithMetadata
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.SyntheticAlertConfigurationApi(api_client)
    synthetic_test_id = 'ic25Vt1T5dgKzi0K7812' # str | The ID of a specific Synthetic Test.  (optional)
    alert_ids = ['smRTFp08juKWtn8I'] # List[str] | A list of Smart Alert Configuration IDs. This allows fetching of a specific set of Configurations. This query can be repeated to use multiple IDs. (optional)

    try:
        # Get all Synthetic Smart Alert Configs
        api_response = api_instance.find_active_synthetic_alert_configs(synthetic_test_id=synthetic_test_id, alert_ids=alert_ids)
        print("The response of SyntheticAlertConfigurationApi->find_active_synthetic_alert_configs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SyntheticAlertConfigurationApi->find_active_synthetic_alert_configs: %s\n" % e)

Parameters

Name	Type	Description	Notes
synthetic_test_id	str	The ID of a specific Synthetic Test.	[optional]
alert_ids	List[str]	A list of Smart Alert Configuration IDs. This allows fetching of a specific set of Configurations. This query can be repeated to use multiple IDs.	[optional]

Return type

List[SyntheticAlertConfigWithMetadata]

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success. Returns empty result if syntheticTestId is invalid.	-

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

find_synthetic_alert_config

SyntheticAlertConfigWithRBACTag find_synthetic_alert_config(id, valid_on=valid_on)

Get Synthetic Smart Alert Config

Gets a specific Synthetic Smart Alert Configuration. This may return a deleted Configuration. For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration.

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.models.synthetic_alert_config_with_rbac_tag import SyntheticAlertConfigWithRBACTag
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.SyntheticAlertConfigurationApi(api_client)
    id = 'qgEwvI0vRfe3Al_D7T7LSA' # str | ID of a specific Synthetic Smart Alert Configuration to retrieve.
    valid_on = 1707149760053 # int | A Unix timestamp representing a specific time the Configuration was active. If no timestamp is provided, the latest active version will be retrieved.  (optional)

    try:
        # Get Synthetic Smart Alert Config
        api_response = api_instance.find_synthetic_alert_config(id, valid_on=valid_on)
        print("The response of SyntheticAlertConfigurationApi->find_synthetic_alert_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SyntheticAlertConfigurationApi->find_synthetic_alert_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	ID of a specific Synthetic Smart Alert Configuration to retrieve.
valid_on	int	A Unix timestamp representing a specific time the Configuration was active. If no timestamp is provided, the latest active version will be retrieved.	[optional]

Return type

SyntheticAlertConfigWithRBACTag

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
403	Insufficient permissions or limited in access.	-
404	Resource not found.	-

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

find_synthetic_alert_config_versions

List[ConfigVersion] find_synthetic_alert_config_versions(id)

Get Synthetic Smart Alert Config Versions

Gets all versions of a Synthetic Smart Alert Configuration. This may return deleted Configurations. Configurations are sorted by creation date in descending order. For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration.

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.models.config_version import ConfigVersion
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.SyntheticAlertConfigurationApi(api_client)
    id = 'qgEwvI0vRfe3Al_D7T7LSA' # str | ID of a specific Synthetic Smart Alert Configuration to retrieve.

    try:
        # Get Synthetic Smart Alert Config Versions
        api_response = api_instance.find_synthetic_alert_config_versions(id)
        print("The response of SyntheticAlertConfigurationApi->find_synthetic_alert_config_versions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SyntheticAlertConfigurationApi->find_synthetic_alert_config_versions: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	ID of a specific Synthetic Smart Alert Configuration to retrieve.

Return type

List[ConfigVersion]

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
403	Insufficient permissions or limited in access.	-
404	Resource not found.	-

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

restore_synthetic_alert_config

restore_synthetic_alert_config(id, created, body=body)

Restore Synthetic Smart Alert Config

Restores a deleted Synthetic Smart Alert Configuration. For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration.

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.SyntheticAlertConfigurationApi(api_client)
    id = '2K1YQIeaSQKIcIkHPH7D3g' # str | ID of a specific Synthetic Smart Alert Configuration to restore.
    created = 1707726529124 # int | Unix timestamp representing the creation time of a specific Synthetic Smart Alert Configuration.
    body = 'body_example' # str |  (optional)

    try:
        # Restore Synthetic Smart Alert Config
        api_instance.restore_synthetic_alert_config(id, created, body=body)
    except Exception as e:
        print("Exception when calling SyntheticAlertConfigurationApi->restore_synthetic_alert_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	ID of a specific Synthetic Smart Alert Configuration to restore.
created	int	Unix timestamp representing the creation time of a specific Synthetic Smart Alert Configuration.
body	str		[optional]

Return type

void (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Successful - no content to return.	-
403	Insufficient permissions or limited in access.	-
404	Resource not found.	-

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

update_synthetic_alert_config

SyntheticAlertConfigWithMetadata update_synthetic_alert_config(id, synthetic_alert_config)

Update Synthetic Smart Alert Config

Updates an existing Synthetic Smart Alert Configuration. For more information on Synthetic Alert Configuration please access the https://developer.ibm.com/apis/catalog/instana--instana-rest-api/Synthetic+Monitoring#synthetic-alert-configuration.

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.models.synthetic_alert_config import SyntheticAlertConfig
from instana_client.models.synthetic_alert_config_with_metadata import SyntheticAlertConfigWithMetadata
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.SyntheticAlertConfigurationApi(api_client)
    id = 'qgEwvI0vRfe3Al_D7T7LSA' # str | ID of a specific Synthetic Smart Alert Configuration to update.
    synthetic_alert_config = {"name":"2 consecutive failures of ${synthetic.testName} at locations${synthetic.locationLabel}","description":"Alert created without test but with AppId - Synthetic test failed for 2 consecutive times","syntheticTestIds":["ic25Vt1T5dgKzi0K7812","2gBxQz3oKtXgFXzRoQ6O"],"severity":5,"tagFilterExpression":{"type":"TAG_FILTER","name":"synthetic.applicationId","stringValue":"2BPCBLz_RBG8J6mjyuxm6w","numberValue":null,"booleanValue":null,"key":null,"value":"2BPCBLz_RBG8J6mjyuxm6w","operator":"EQUALS","entity":"NOT_APPLICABLE"},"rule":{"alertType":"failure","metricName":"status","aggregation":"SUM"},"alertChannelIds":["0o1ISHPfR8-N4iUK"],"timeThreshold":{"type":"violationsInSequence","violationsCount":2},"customPayloadFields":[]} # SyntheticAlertConfig | 

    try:
        # Update Synthetic Smart Alert Config
        api_response = api_instance.update_synthetic_alert_config(id, synthetic_alert_config)
        print("The response of SyntheticAlertConfigurationApi->update_synthetic_alert_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SyntheticAlertConfigurationApi->update_synthetic_alert_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	ID of a specific Synthetic Smart Alert Configuration to update.
synthetic_alert_config	SyntheticAlertConfig

Return type

SyntheticAlertConfigWithMetadata

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Synthetic Smart Alert Configuration updated	-
204	Synthetic Smart Alert Configuration did not change	-
403	Insufficient permissions or limited in access.	-
404	Resource not found.	-
422	Unprocessable request - missing/invalid data.	-
500	Internal server error.	-

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

FilesExpand file tree

SyntheticAlertConfigurationApi.md

Latest commit

History

SyntheticAlertConfigurationApi.md

File metadata and controls

instana_client.SyntheticAlertConfigurationApi

bulk_delete_synthetic_alert_configs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

bulk_disable_synthetic_alert_configs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

bulk_enable_synthetic_alert_configs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_synthetic_alert_config

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_synthetic_alert_config

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

disable_synthetic_alert_config

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

enable_synthetic_alert_config

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

find_active_synthetic_alert_configs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

find_synthetic_alert_config

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

find_synthetic_alert_config_versions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

restore_synthetic_alert_config

Example

Parameters