Skip to content

Latest commit

 

History

History
611 lines (423 loc) · 20.9 KB

IntegrationApi.md

File metadata and controls

611 lines (423 loc) · 20.9 KB
Raw

wavefront_api_client.IntegrationApi

All URIs are relative to https://YOUR_INSTANCE.wavefront.com

Method HTTP request Description
get_all_integration GET /api/v2/integration Gets a flat list of all Tanzu Observability integrations available, along with their status
get_all_integration_in_manifests GET /api/v2/integration/manifests Gets all Tanzu Observability integrations as structured in their integration manifests, along with their status and content
get_all_integration_in_manifests_min GET /api/v2/integration/manifests/min Gets all Tanzu Observability integrations as structured in their integration manifests.
get_all_integration_statuses GET /api/v2/integration/status Gets the status of all Tanzu Observability integrations
get_installed_integration GET /api/v2/integration/installed Gets a flat list of all Integrations that are installed, along with their status
get_integration GET /api/v2/integration/{id} Gets a single Tanzu Observability integration by its id, along with its status
get_integration_status GET /api/v2/integration/{id}/status Gets the status of a single Tanzu Observability integration
install_all_integration_alerts POST /api/v2/integration/{id}/install-all-alerts Enable all alerts associated with this integration
install_integration POST /api/v2/integration/{id}/install Installs a Tanzu Observability integration
uninstall_all_integration_alerts POST /api/v2/integration/{id}/uninstall-all-alerts Disable all alerts associated with this integration
uninstall_integration POST /api/v2/integration/{id}/uninstall Uninstalls a Tanzu Observability integration

get_all_integration

ResponseContainerPagedIntegration get_all_integration(offset=offset, limit=limit, exclude_dashboard=exclude_dashboard)

Gets a flat list of all Tanzu Observability integrations available, along with their status

Example

from __future__ import print_function
import time
import wavefront_api_client
from wavefront_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = wavefront_api_client.Configuration()
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'

# create an instance of the API class
api_instance = wavefront_api_client.IntegrationApi(wavefront_api_client.ApiClient(configuration))
offset = 0 # int |  (optional) (default to 0)
limit = 100 # int | Limit the number of queried integrations to reduce the response size (optional) (default to 100)
exclude_dashboard = false # bool | Whether to exclude information on dashboards, default is set to false (optional) (default to false)

try:
    # Gets a flat list of all Tanzu Observability integrations available, along with their status
    api_response = api_instance.get_all_integration(offset=offset, limit=limit, exclude_dashboard=exclude_dashboard)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationApi->get_all_integration: %s\n" % e)

Parameters

Name Type Description Notes
offset int [optional] [default to 0]
limit int Limit the number of queried integrations to reduce the response size [optional] [default to 100]
exclude_dashboard bool Whether to exclude information on dashboards, default is set to false [optional] [default to false]

Return type

ResponseContainerPagedIntegration

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

get_all_integration_in_manifests

ResponseContainerListIntegrationManifestGroup get_all_integration_in_manifests()

Gets all Tanzu Observability integrations as structured in their integration manifests, along with their status and content

Example

from __future__ import print_function
import time
import wavefront_api_client
from wavefront_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = wavefront_api_client.Configuration()
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'

# create an instance of the API class
api_instance = wavefront_api_client.IntegrationApi(wavefront_api_client.ApiClient(configuration))

try:
    # Gets all Tanzu Observability integrations as structured in their integration manifests, along with their status and content
    api_response = api_instance.get_all_integration_in_manifests()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationApi->get_all_integration_in_manifests: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ResponseContainerListIntegrationManifestGroup

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

get_all_integration_in_manifests_min

ResponseContainerListIntegrationManifestGroup get_all_integration_in_manifests_min()

Gets all Tanzu Observability integrations as structured in their integration manifests.

Example

from __future__ import print_function
import time
import wavefront_api_client
from wavefront_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = wavefront_api_client.Configuration()
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'

# create an instance of the API class
api_instance = wavefront_api_client.IntegrationApi(wavefront_api_client.ApiClient(configuration))

try:
    # Gets all Tanzu Observability integrations as structured in their integration manifests.
    api_response = api_instance.get_all_integration_in_manifests_min()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationApi->get_all_integration_in_manifests_min: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ResponseContainerListIntegrationManifestGroup

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

get_all_integration_statuses

ResponseContainerMapStringIntegrationStatus get_all_integration_statuses()

Gets the status of all Tanzu Observability integrations

Example

from __future__ import print_function
import time
import wavefront_api_client
from wavefront_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = wavefront_api_client.Configuration()
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'

# create an instance of the API class
api_instance = wavefront_api_client.IntegrationApi(wavefront_api_client.ApiClient(configuration))

try:
    # Gets the status of all Tanzu Observability integrations
    api_response = api_instance.get_all_integration_statuses()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationApi->get_all_integration_statuses: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ResponseContainerMapStringIntegrationStatus

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

get_installed_integration

ResponseContainerListIntegration get_installed_integration(has_content=has_content, return_content=return_content)

Gets a flat list of all Integrations that are installed, along with their status

Example

from __future__ import print_function
import time
import wavefront_api_client
from wavefront_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = wavefront_api_client.Configuration()
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'

# create an instance of the API class
api_instance = wavefront_api_client.IntegrationApi(wavefront_api_client.ApiClient(configuration))
has_content = false # bool |  (optional) (default to false)
return_content = true # bool |  (optional) (default to true)

try:
    # Gets a flat list of all Integrations that are installed, along with their status
    api_response = api_instance.get_installed_integration(has_content=has_content, return_content=return_content)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationApi->get_installed_integration: %s\n" % e)

Parameters

Name Type Description Notes
has_content bool [optional] [default to false]
return_content bool [optional] [default to true]

Return type

ResponseContainerListIntegration

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

get_integration

ResponseContainerIntegration get_integration(id, refresh=refresh)

Gets a single Tanzu Observability integration by its id, along with its status

Example

from __future__ import print_function
import time
import wavefront_api_client
from wavefront_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = wavefront_api_client.Configuration()
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'

# create an instance of the API class
api_instance = wavefront_api_client.IntegrationApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 
refresh = true # bool |  (optional)

try:
    # Gets a single Tanzu Observability integration by its id, along with its status
    api_response = api_instance.get_integration(id, refresh=refresh)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationApi->get_integration: %s\n" % e)

Parameters

Name Type Description Notes
id str
refresh bool [optional]

Return type

ResponseContainerIntegration

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

get_integration_status

ResponseContainerIntegrationStatus get_integration_status(id)

Gets the status of a single Tanzu Observability integration

Example

from __future__ import print_function
import time
import wavefront_api_client
from wavefront_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = wavefront_api_client.Configuration()
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'

# create an instance of the API class
api_instance = wavefront_api_client.IntegrationApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 

try:
    # Gets the status of a single Tanzu Observability integration
    api_response = api_instance.get_integration_status(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationApi->get_integration_status: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

ResponseContainerIntegrationStatus

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

install_all_integration_alerts

ResponseContainerIntegrationStatus install_all_integration_alerts(id, body=body)

Enable all alerts associated with this integration

Example

from __future__ import print_function
import time
import wavefront_api_client
from wavefront_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = wavefront_api_client.Configuration()
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'

# create an instance of the API class
api_instance = wavefront_api_client.IntegrationApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 
body = wavefront_api_client.InstallAlerts() # InstallAlerts |  (optional)

try:
    # Enable all alerts associated with this integration
    api_response = api_instance.install_all_integration_alerts(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationApi->install_all_integration_alerts: %s\n" % e)

Parameters

Name Type Description Notes
id str
body InstallAlerts [optional]

Return type

ResponseContainerIntegrationStatus

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

install_integration

ResponseContainerIntegrationStatus install_integration(id)

Installs a Tanzu Observability integration

Example

from __future__ import print_function
import time
import wavefront_api_client
from wavefront_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = wavefront_api_client.Configuration()
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'

# create an instance of the API class
api_instance = wavefront_api_client.IntegrationApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 

try:
    # Installs a Tanzu Observability integration
    api_response = api_instance.install_integration(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationApi->install_integration: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

ResponseContainerIntegrationStatus

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

uninstall_all_integration_alerts

ResponseContainerIntegrationStatus uninstall_all_integration_alerts(id)

Disable all alerts associated with this integration

Example

from __future__ import print_function
import time
import wavefront_api_client
from wavefront_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = wavefront_api_client.Configuration()
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'

# create an instance of the API class
api_instance = wavefront_api_client.IntegrationApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 

try:
    # Disable all alerts associated with this integration
    api_response = api_instance.uninstall_all_integration_alerts(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationApi->uninstall_all_integration_alerts: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

ResponseContainerIntegrationStatus

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

uninstall_integration

ResponseContainerIntegrationStatus uninstall_integration(id)

Uninstalls a Tanzu Observability integration

Example

from __future__ import print_function
import time
import wavefront_api_client
from wavefront_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
configuration = wavefront_api_client.Configuration()
configuration.api_key['X-AUTH-TOKEN'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-AUTH-TOKEN'] = 'Bearer'

# create an instance of the API class
api_instance = wavefront_api_client.IntegrationApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 

try:
    # Uninstalls a Tanzu Observability integration
    api_response = api_instance.uninstall_integration(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationApi->uninstall_integration: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

ResponseContainerIntegrationStatus

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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