Skip to content

TagsApi.md

Latest commit

 

History

History
108 lines (72 loc) · 3.04 KB

TagsApi.md

File metadata and controls

108 lines (72 loc) · 3.04 KB

esp_sdk.TagsApi

All URIs are relative to https://api.evident.io

Method HTTP request Description
list_for_alert GET /api/v2/alerts/{alert_id}/tags.json_api Get a list of Tags
show GET /api/v2/tags/{id}.json_api Show a single Tag

list_for_alert

PaginatedCollection list_for_alert(alert_id, page=page)

Get a list of Tags

Example

from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = esp_sdk.TagsApi()
alert_id = 56 # int | The ID of the alert to list tags for
page = '{:number=>1,+:size=>20}' # str | Page Number and Page Size.  Number is the page number of the collection to return, size is the number of items to return per page. (optional) (default to {:number=>1,+:size=>20})

try: 
    # Get a list of Tags
    api_response = api_instance.list_for_alert(alert_id, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagsApi->list_for_alert: %s\n" % e)

Parameters

Name Type Description Notes
alert_id int The ID of the alert to list tags for
page str Page Number and Page Size. Number is the page number of the collection to return, size is the number of items to return per page. [optional] [default to {:number=>1,+:size=>20}]

Return type

PaginatedCollection

Authorization

See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

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

show

Tag show(id)

Show a single Tag

Example

from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = esp_sdk.TagsApi()
id = 56 # int | Tag ID

try: 
    # Show a single Tag
    api_response = api_instance.show(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TagsApi->show: %s\n" % e)

Parameters

Name Type Description Notes
id int Tag ID

Return type

Tag

Authorization

See https://github.com/EvidentSecurity/esp-sdk-python#set-your-hmac-security-keys

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

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