wavefront_api_client.SavedAppMapSearchGroupApi

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

Method	HTTP request	Description
add_saved_app_map_search_to_group	POST /api/v2/savedappmapsearchgroup/{id}/addSearch/{searchId}	Add a search to a search group
create_saved_app_map_search_group	POST /api/v2/savedappmapsearchgroup	Create a search group
delete_saved_app_map_search_group	DELETE /api/v2/savedappmapsearchgroup/{id}	Delete a search group
get_all_saved_app_map_search_group	GET /api/v2/savedappmapsearchgroup	Get all search groups for a user
get_saved_app_map_search_group	GET /api/v2/savedappmapsearchgroup/{id}	Get a specific search group
get_saved_app_map_searches_for_group	GET /api/v2/savedappmapsearchgroup/{id}/searches	Get all searches for a search group
remove_saved_app_map_search_from_group	POST /api/v2/savedappmapsearchgroup/{id}/removeSearch/{searchId}	Remove a search from a search group
update_saved_app_map_search_group	PUT /api/v2/savedappmapsearchgroup/{id}	Update a search group

add_saved_app_map_search_to_group

ResponseContainer add_saved_app_map_search_to_group(id, search_id)

Add a search to a search group

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.SavedAppMapSearchGroupApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 
search_id = 'search_id_example' # str | 

try:
    # Add a search to a search group
    api_response = api_instance.add_saved_app_map_search_to_group(id, search_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SavedAppMapSearchGroupApi->add_saved_app_map_search_to_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
search_id	str

Return type

ResponseContainer

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]

create_saved_app_map_search_group

ResponseContainerSavedAppMapSearchGroup create_saved_app_map_search_group(body=body)

Create a search group

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.SavedAppMapSearchGroupApi(wavefront_api_client.ApiClient(configuration))
body = wavefront_api_client.SavedAppMapSearchGroup() # SavedAppMapSearchGroup | Example Body:  <pre>{   \"name\": \"Search Group 1\" }</pre> (optional)

try:
    # Create a search group
    api_response = api_instance.create_saved_app_map_search_group(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SavedAppMapSearchGroupApi->create_saved_app_map_search_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	SavedAppMapSearchGroup	Example Body: <pre>{ "name": "Search Group 1" }</pre>	[optional]

Return type

ResponseContainerSavedAppMapSearchGroup

Authorization

api_key

HTTP request headers

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

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

delete_saved_app_map_search_group

ResponseContainerSavedAppMapSearchGroup delete_saved_app_map_search_group(id)

Delete a search group

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.SavedAppMapSearchGroupApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 

try:
    # Delete a search group
    api_response = api_instance.delete_saved_app_map_search_group(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SavedAppMapSearchGroupApi->delete_saved_app_map_search_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

ResponseContainerSavedAppMapSearchGroup

Authorization

api_key

HTTP request headers

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

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

get_all_saved_app_map_search_group

ResponseContainerPagedSavedAppMapSearchGroup get_all_saved_app_map_search_group(offset=offset, limit=limit)

Get all search groups for a user

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.SavedAppMapSearchGroupApi(wavefront_api_client.ApiClient(configuration))
offset = 0 # int |  (optional) (default to 0)
limit = 100 # int |  (optional) (default to 100)

try:
    # Get all search groups for a user
    api_response = api_instance.get_all_saved_app_map_search_group(offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SavedAppMapSearchGroupApi->get_all_saved_app_map_search_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
offset	int		[optional] [default to 0]
limit	int		[optional] [default to 100]

Return type

ResponseContainerPagedSavedAppMapSearchGroup

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_saved_app_map_search_group

ResponseContainerSavedAppMapSearchGroup get_saved_app_map_search_group(id)

Get a specific search group

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.SavedAppMapSearchGroupApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 

try:
    # Get a specific search group
    api_response = api_instance.get_saved_app_map_search_group(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SavedAppMapSearchGroupApi->get_saved_app_map_search_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

ResponseContainerSavedAppMapSearchGroup

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_saved_app_map_searches_for_group

ResponseContainerPagedSavedAppMapSearch get_saved_app_map_searches_for_group(id, offset=offset, limit=limit)

Get all searches for a search group

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.SavedAppMapSearchGroupApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 
offset = 0 # int |  (optional) (default to 0)
limit = 100 # int |  (optional) (default to 100)

try:
    # Get all searches for a search group
    api_response = api_instance.get_saved_app_map_searches_for_group(id, offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SavedAppMapSearchGroupApi->get_saved_app_map_searches_for_group: %s\n" % e)

Parameters

Name	Type	Notes
id	str
offset	int	[optional] [default to 0]
limit	int	[optional] [default to 100]

Return type

ResponseContainerPagedSavedAppMapSearch

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]

remove_saved_app_map_search_from_group

ResponseContainer remove_saved_app_map_search_from_group(id, search_id)

Remove a search from a search group

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.SavedAppMapSearchGroupApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 
search_id = 'search_id_example' # str | 

try:
    # Remove a search from a search group
    api_response = api_instance.remove_saved_app_map_search_from_group(id, search_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SavedAppMapSearchGroupApi->remove_saved_app_map_search_from_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
search_id	str

Return type

ResponseContainer

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]

update_saved_app_map_search_group

ResponseContainerSavedAppMapSearchGroup update_saved_app_map_search_group(id, body=body)

Update a search group

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.SavedAppMapSearchGroupApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 
body = wavefront_api_client.SavedAppMapSearchGroup() # SavedAppMapSearchGroup | Example Body:  <pre>{   \"name\": \"Search Group 1\" }</pre> (optional)

try:
    # Update a search group
    api_response = api_instance.update_saved_app_map_search_group(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SavedAppMapSearchGroupApi->update_saved_app_map_search_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
body	SavedAppMapSearchGroup	Example Body: <pre>{ "name": "Search Group 1" }</pre>	[optional]

Return type

ResponseContainerSavedAppMapSearchGroup

Authorization

api_key

HTTP request headers

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

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

Files

SavedAppMapSearchGroupApi.md

Latest commit

History

SavedAppMapSearchGroupApi.md

File metadata and controls

wavefront_api_client.SavedAppMapSearchGroupApi

add_saved_app_map_search_to_group

Example

Parameters

Return type

Authorization

HTTP request headers

create_saved_app_map_search_group

Example

Parameters

Return type

Authorization

HTTP request headers

delete_saved_app_map_search_group

Example

Parameters

Return type

Authorization

HTTP request headers

get_all_saved_app_map_search_group

Example

Parameters

Return type

Authorization

HTTP request headers

get_saved_app_map_search_group

Example

Parameters

Return type

Authorization

HTTP request headers

get_saved_app_map_searches_for_group

Example

Parameters

Return type

Authorization

HTTP request headers

remove_saved_app_map_search_from_group

Example

Parameters

Return type

Authorization

HTTP request headers

update_saved_app_map_search_group

Example

Parameters

Return type

Authorization

HTTP request headers