wavefront_api_client.ProxyApi

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

Method	HTTP request	Description
delete_proxy	DELETE /api/v2/proxy/{id}	Delete a specific proxy
get_all_proxy	GET /api/v2/proxy	Get all proxies for a customer
get_proxy	GET /api/v2/proxy/{id}	Get a specific proxy
get_proxy_config	GET /api/v2/proxy/{id}/config	Get a specific proxy config
get_proxy_preprocessor_rules	GET /api/v2/proxy/{id}/preprocessorRules	Get a specific proxy preprocessor rules
undelete_proxy	POST /api/v2/proxy/{id}/undelete	Undelete a specific proxy
update_proxy	PUT /api/v2/proxy/{id}	Update the name of a specific proxy

delete_proxy

ResponseContainerProxy delete_proxy(id, skip_trash=skip_trash)

Delete a specific proxy

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.ProxyApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 
skip_trash = false # bool |  (optional) (default to false)

try:
    # Delete a specific proxy
    api_response = api_instance.delete_proxy(id, skip_trash=skip_trash)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProxyApi->delete_proxy: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
skip_trash	bool		[optional] [default to false]

Return type

ResponseContainerProxy

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_proxy

ResponseContainerPagedProxy get_all_proxy(offset=offset, limit=limit)

Get all proxies for a customer

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

try:
    # Get all proxies for a customer
    api_response = api_instance.get_all_proxy(offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProxyApi->get_all_proxy: %s\n" % e)

Parameters

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

Return type

ResponseContainerPagedProxy

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_proxy

ResponseContainerProxy get_proxy(id)

Get a specific proxy

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

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

Parameters

Name	Type	Description	Notes
id	str

Return type

ResponseContainerProxy

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_proxy_config

ResponseContainerMap get_proxy_config(id)

Get a specific proxy config

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

try:
    # Get a specific proxy config
    api_response = api_instance.get_proxy_config(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProxyApi->get_proxy_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

ResponseContainerMap

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_proxy_preprocessor_rules

ResponseContainerMap get_proxy_preprocessor_rules(id)

Get a specific proxy preprocessor rules

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

try:
    # Get a specific proxy preprocessor rules
    api_response = api_instance.get_proxy_preprocessor_rules(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProxyApi->get_proxy_preprocessor_rules: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

ResponseContainerMap

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]

undelete_proxy

ResponseContainerProxy undelete_proxy(id)

Undelete a specific proxy

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

try:
    # Undelete a specific proxy
    api_response = api_instance.undelete_proxy(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProxyApi->undelete_proxy: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

ResponseContainerProxy

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_proxy

ResponseContainerProxy update_proxy(id, body=body)

Update the name of a specific proxy

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.ProxyApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 
body = wavefront_api_client.Proxy() # Proxy | Example Body:  <pre>{   \"name\": \"New Name for proxy\" }</pre> (optional)

try:
    # Update the name of a specific proxy
    api_response = api_instance.update_proxy(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProxyApi->update_proxy: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
body	Proxy	Example Body: <pre>{ "name": "New Name for proxy" }</pre>	[optional]

Return type

ResponseContainerProxy

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

ProxyApi.md

Latest commit

History

ProxyApi.md

File metadata and controls

wavefront_api_client.ProxyApi

delete_proxy

Example

Parameters

Return type

Authorization

HTTP request headers

get_all_proxy

Example

Parameters

Return type

Authorization

HTTP request headers

get_proxy

Example

Parameters

Return type

Authorization

HTTP request headers

get_proxy_config

Example

Parameters

Return type

Authorization

HTTP request headers

get_proxy_preprocessor_rules

Example

Parameters

Return type

Authorization

HTTP request headers

undelete_proxy

Example

Parameters

Return type

Authorization

HTTP request headers

update_proxy

Example

Parameters

Return type

Authorization

HTTP request headers