MetadataApi.md

ESP::MetadataApi

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

Method	HTTP request	Description
for_alert	GET /api/v2/alerts/{alert_id}/metadata.json_api	Show the metadata for an alert
show	GET /api/v2/metadata/{id}.json_api	Show a single Metadata

for_alert

Metadata for_alert(alert_id)

Show the metadata for an alert

Example

# load the gem
require 'esp_sdk'

api_instance = ESP::MetadataApi.new

alert_id = 56 # Integer | Alert Id


begin
  #Show the metadata for an alert
  result = api_instance.for_alert(alert_id)
  p result
rescue ESP::ApiError => e
  puts "Exception when calling MetadataApi->for_alert: #{e}"
end

Parameters

Name	Type	Description	Notes
alert_id	Integer	Alert Id

Return type

Metadata

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

Metadata show(id)

Show a single Metadata

Example

# load the gem
require 'esp_sdk'

api_instance = ESP::MetadataApi.new

id = 56 # Integer | Metadata ID


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

Parameters

Name	Type	Description	Notes
id	Integer	Metadata ID

Return type

Metadata

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