Skip to content

IntegrationsApi.md

Latest commit

 

History

History
259 lines (180 loc) · 8.8 KB

IntegrationsApi.md

File metadata and controls

259 lines (180 loc) · 8.8 KB

esp_sdk.IntegrationsApi

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

Method HTTP request Description
delete DELETE /api/v2/integrations/{id}.json_api Delete a(n) Integration
disable PATCH /api/v2/integrations/{id}/disable.json_api Disable a single Integration
list PUT /api/v2/integrations.json_api Get a list of Integrations
show GET /api/v2/integrations/{id}.json_api Show a single Integration
test_notify POST /api/v2/integrations/{id}/test_notify.json_api Test an Integration

delete

Meta delete(id)

Delete a(n) Integration

Use this endpoint to destory any type of Integration.

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

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

Parameters

Name Type Description Notes
id int Integration ID

Return type

Meta

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]

disable

Meta disable(id)

Disable a single Integration

This will disable any type of Integration

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

try: 
    # Disable a single Integration
    api_response = api_instance.disable(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationsApi->disable: %s\n" % e)

Parameters

Name Type Description Notes
id int Integration ID

Return type

Meta

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]

list

PaginatedCollection list(include=include, filter=filter, page=page)

Get a list of Integrations

This will return a list of every type of Integration.

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.IntegrationsApi()
include = 'include_example' # str | Related objects that can be included in the response:  organization, creator, external_accounts, signatures, custom_signatures See Including Objects for more information. (optional)
filter = {'key': 'filter_example'} # dict(str, str) | Filter Params for Searching.  Equality Searchable Attributes: [id, organization_id, name, service_type] Matching Searchable Attributes: [name, service_type]   Searchable Associations: [teams, signatures, custom_signatures] See Searching Lists for more information. See the filter parameter of the association's list action to see what attributes are searchable on each association. See Conditions on Relationships in Searching Lists for more information. (optional)
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 Integrations
    api_response = api_instance.list(include=include, filter=filter, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationsApi->list: %s\n" % e)

Parameters

Name Type Description Notes
include str Related objects that can be included in the response: organization, creator, external_accounts, signatures, custom_signatures See Including Objects for more information. [optional]
filter dict(str, str) Filter Params for Searching. Equality Searchable Attributes: [id, organization_id, name, service_type] Matching Searchable Attributes: [name, service_type] Searchable Associations: [teams, signatures, custom_signatures] See Searching Lists for more information. See the filter parameter of the association's list action to see what attributes are searchable on each association. See Conditions on Relationships in Searching Lists for more information. [optional]
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

Integration show(id, include=include)

Show a single Integration

This will return any type of Integration.

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.IntegrationsApi()
id = 56 # int | Integration ID
include = 'include_example' # str | Related objects that can be included in the response:  organization, creator, external_accounts, signatures, custom_signatures See Including Objects for more information. (optional)

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

Parameters

Name Type Description Notes
id int Integration ID
include str Related objects that can be included in the response: organization, creator, external_accounts, signatures, custom_signatures See Including Objects for more information. [optional]

Return type

Integration

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]

test_notify

Meta test_notify(id)

Test an Integration

This will test any type of Integration.

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

try: 
    # Test an Integration
    api_response = api_instance.test_notify(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationsApi->test_notify: %s\n" % e)

Parameters

Name Type Description Notes
id int Integration ID

Return type

Meta

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]