Skip to content

Latest commit

 

History

History
572 lines (400 loc) · 19 KB

EventApi.md

File metadata and controls

572 lines (400 loc) · 19 KB

wavefront_api_client.EventApi

All URIs are relative to https://localhost

Method HTTP request Description
add_event_tag PUT /api/v2/event/{id}/tag/{tagValue} Add a tag to a specific event
close_event POST /api/v2/event/{id}/close Close a specific event
create_event POST /api/v2/event Create a specific event
delete_event DELETE /api/v2/event/{id} Delete a specific event
get_all_events_with_time_range GET /api/v2/event List all the events for a customer within a time range
get_event GET /api/v2/event/{id} Get a specific event
get_event_tags GET /api/v2/event/{id}/tag Get all tags associated with a specific event
remove_event_tag DELETE /api/v2/event/{id}/tag/{tagValue} Remove a tag from a specific event
set_event_tags POST /api/v2/event/{id}/tag Set all tags associated with a specific event
update_event PUT /api/v2/event/{id} Update a specific event

add_event_tag

ResponseContainer add_event_tag(id, tag_value)

Add a tag to a specific event

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

try:
    # Add a tag to a specific event
    api_response = api_instance.add_event_tag(id, tag_value)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventApi->add_event_tag: %s\n" % e)

Parameters

Name Type Description Notes
id str
tag_value str

Return type

ResponseContainer

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]

close_event

ResponseContainerEvent close_event(id)

Close a specific event

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

try:
    # Close a specific event
    api_response = api_instance.close_event(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventApi->close_event: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

ResponseContainerEvent

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_event

ResponseContainerEvent create_event(body=body)

Create a specific event

The following fields are readonly and will be ignored when passed in the request: id, isEphemeral, isUserEvent, runningState, canDelete, canClose, creatorType, createdAt, updatedAt, createdEpochMillis, updatedEpochMillis, updaterId, creatorId, and summarizedEvents

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.EventApi(wavefront_api_client.ApiClient(configuration))
body = wavefront_api_client.Event() # Event | Example Body:  <pre>{   \"name\": \"Event API Example\",   \"annotations\": {     \"severity\": \"info\",     \"type\": \"event type\",     \"details\": \"description\"   },   \"startTime\": 1490000000000,   \"endTime\": 1490000000001 }</pre> (optional)

try:
    # Create a specific event
    api_response = api_instance.create_event(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventApi->create_event: %s\n" % e)

Parameters

Name Type Description Notes
body Event Example Body: <pre>{ &quot;name&quot;: &quot;Event API Example&quot;, &quot;annotations&quot;: { &quot;severity&quot;: &quot;info&quot;, &quot;type&quot;: &quot;event type&quot;, &quot;details&quot;: &quot;description&quot; }, &quot;startTime&quot;: 1490000000000, &quot;endTime&quot;: 1490000000001 }</pre> [optional]

Return type

ResponseContainerEvent

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_event

ResponseContainerEvent delete_event(id)

Delete a specific event

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

try:
    # Delete a specific event
    api_response = api_instance.delete_event(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventApi->delete_event: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

ResponseContainerEvent

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_events_with_time_range

ResponseContainerPagedEvent get_all_events_with_time_range(earliest_start_time_epoch_millis=earliest_start_time_epoch_millis, latest_start_time_epoch_millis=latest_start_time_epoch_millis, cursor=cursor, limit=limit)

List all the events for a customer within a time range

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.EventApi(wavefront_api_client.ApiClient(configuration))
earliest_start_time_epoch_millis = 789 # int |  (optional)
latest_start_time_epoch_millis = 789 # int |  (optional)
cursor = 'cursor_example' # str |  (optional)
limit = 100 # int |  (optional) (default to 100)

try:
    # List all the events for a customer within a time range
    api_response = api_instance.get_all_events_with_time_range(earliest_start_time_epoch_millis=earliest_start_time_epoch_millis, latest_start_time_epoch_millis=latest_start_time_epoch_millis, cursor=cursor, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventApi->get_all_events_with_time_range: %s\n" % e)

Parameters

Name Type Description Notes
earliest_start_time_epoch_millis int [optional]
latest_start_time_epoch_millis int [optional]
cursor str [optional]
limit int [optional] [default to 100]

Return type

ResponseContainerPagedEvent

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_event

ResponseContainerEvent get_event(id)

Get a specific event

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

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

Parameters

Name Type Description Notes
id str

Return type

ResponseContainerEvent

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_event_tags

ResponseContainerTagsResponse get_event_tags(id)

Get all tags associated with a specific event

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

try:
    # Get all tags associated with a specific event
    api_response = api_instance.get_event_tags(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventApi->get_event_tags: %s\n" % e)

Parameters

Name Type Description Notes
id str

Return type

ResponseContainerTagsResponse

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_event_tag

ResponseContainer remove_event_tag(id, tag_value)

Remove a tag from a specific event

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

try:
    # Remove a tag from a specific event
    api_response = api_instance.remove_event_tag(id, tag_value)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventApi->remove_event_tag: %s\n" % e)

Parameters

Name Type Description Notes
id str
tag_value str

Return type

ResponseContainer

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]

set_event_tags

ResponseContainer set_event_tags(id, body=body)

Set all tags associated with a specific event

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.EventApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 
body = [wavefront_api_client.list[str]()] # list[str] |  (optional)

try:
    # Set all tags associated with a specific event
    api_response = api_instance.set_event_tags(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventApi->set_event_tags: %s\n" % e)

Parameters

Name Type Description Notes
id str
body list[str] [optional]

Return type

ResponseContainer

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]

update_event

ResponseContainerEvent update_event(id, body=body)

Update a specific event

The following fields are readonly and will be ignored when passed in the request: id, isEphemeral, isUserEvent, runningState, canDelete, canClose, creatorType, createdAt, updatedAt, createdEpochMillis, updatedEpochMillis, updaterId, creatorId, and summarizedEvents

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.EventApi(wavefront_api_client.ApiClient(configuration))
id = 'id_example' # str | 
body = wavefront_api_client.Event() # Event | Example Body:  <pre>{   \"name\": \"Event API Example\",   \"annotations\": {     \"severity\": \"info\",     \"type\": \"event type\",     \"details\": \"description\"   },   \"startTime\": 1490000000000,   \"endTime\": 1490000000001 }</pre> (optional)

try:
    # Update a specific event
    api_response = api_instance.update_event(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventApi->update_event: %s\n" % e)

Parameters

Name Type Description Notes
id str
body Event Example Body: <pre>{ &quot;name&quot;: &quot;Event API Example&quot;, &quot;annotations&quot;: { &quot;severity&quot;: &quot;info&quot;, &quot;type&quot;: &quot;event type&quot;, &quot;details&quot;: &quot;description&quot; }, &quot;startTime&quot;: 1490000000000, &quot;endTime&quot;: 1490000000001 }</pre> [optional]

Return type

ResponseContainerEvent

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]