Skip to content

MetadataApi.md

Latest commit

 

History

History
106 lines (70 loc) · 2.58 KB

MetadataApi.md

File metadata and controls

106 lines (70 loc) · 2.58 KB

esp_sdk.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

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.MetadataApi()
alert_id = 56 # int | Alert Id

try: 
    # Show the metadata for an alert
    api_response = api_instance.for_alert(alert_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetadataApi->for_alert: %s\n" % e)

Parameters

Name Type Description Notes
alert_id int Alert Id

Return type

Metadata

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

Metadata show(id)

Show a single Metadata

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.MetadataApi()
id = 56 # int | Metadata ID

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

Parameters

Name Type Description Notes
id int Metadata ID

Return type

Metadata

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]