TagsApi.md

ESP::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, opts)

Get a list of Tags

Example

# load the gem
require 'esp_sdk'

api_instance = ESP::TagsApi.new

alert_id = 56 # Integer | The ID of the alert to list tags for

opts = { 
  page: "{:number=>1,+:size=>20}" # String | 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.
}

begin
  #Get a list of Tags
  result = api_instance.list_for_alert(alert_id, opts)
  p result
rescue ESP::ApiError => e
  puts "Exception when calling TagsApi->list_for_alert: #{e}"
end

Parameters

Name	Type	Description	Notes
alert_id	Integer	The ID of the alert to list tags for
page	String	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-ruby#set-your-hmac-security-keys

HTTP request headers

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

show

Tag show(id)

Show a single Tag

Example

# load the gem
require 'esp_sdk'

api_instance = ESP::TagsApi.new

id = 56 # Integer | Tag ID


begin
  #Show a single Tag
  result = api_instance.show(id)
  p result
rescue ESP::ApiError => e
  puts "Exception when calling TagsApi->show: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer	Tag ID

Return type

Tag

Authorization

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

HTTP request headers

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