All REST Endpoints

connections
Retrieve, update, and delete connections.
Delete a Connection
Method: delete
Path: /v1/connections/{code}
Retrieve a Connection
Method: get
Path: /v1/connections/{code}
Retrieve Connections
Method: get
Path: /v1/connections
Update a Connection
Method: put
Path: /v1/connections/{code}
integrations
Retrieve, delete, export, import, activate, deactivate, and run integrations.
Activate an Integration
Method: post
Path: /v1/integrations/{code}/{version}/activate
Deactivate an Integration
Method: post
Path: /v1/integrations/{code}/{version}/deactivate
Delete an Integration
Method: delete
Path: /v1/integrations/{code}/{version}
Export an Integration
Method: get
Path: /v1/integrations/{code}/{version}/export
Fetch ESS Job Status
Method: get
Path: /v1/integrations/{code}/{version}/schedule/state/{id}
Import (Add) an Integration
Method: post
Path: /v1/integrations/import
Import (Replace) an Integration
Method: put
Path: /v1/integrations/import
Retrieve an Integration
Method: get
Path: /v1/integrations/{code}/{version}
Retrieve Integrations
Method: get
Path: /v1/integrations
Run an Integration Flow
Method: post
Path: /v1/integrations/{code}/{version}/schedulenow
lookups
Retrieve a list of lookups.
Retrieve Lookups
Method: get
Path: /v1/lookups
monitoring
Retrieve integration metrics and view or export the monitoring log.
Export the Monitoring Log
Method: get
Path: /v1/monitoring/logs/export
Retrieve Integration Monitoring Metrics
Method: get
Path: /v1/monitoring/integrations
Retrieve Single Integration Monitoring Metrics
Method: get
Path: /v1/monitoring/integrations/{code}/{version}
Retrieve the Monitoring Log
Method: get
Path: /v1/monitoring/logs
packages
Retrieve, delete, export, and import packages.
Delete a Package
Method: delete
Path: /v1/packages/{packagename}
Export a Package
Method: get
Path: /v1/packages/{packagename}/export
Import (Add) a Package
Method: post
Path: /v1/packages/import
Retrieve a Package
Method: get
Path: /v1/packages/{packagename}
Retrieve Packages
Method: get
Path: /v1/packages
All Endpoints
Activate an Integration
Method: post
Path: /v1/integrations/{code}/{version}/activate
Deactivate an Integration
Method: post
Path: /v1/integrations/{code}/{version}/deactivate
Delete a Connection
Method: delete
Path: /v1/connections/{code}
Delete a Package
Method: delete
Path: /v1/packages/{packagename}
Delete an Integration
Method: delete
Path: /v1/integrations/{code}/{version}
Export a Package
Method: get
Path: /v1/packages/{packagename}/export
Export an Integration
Method: get
Path: /v1/integrations/{code}/{version}/export
Export the Monitoring Log
Method: get
Path: /v1/monitoring/logs/export
Fetch ESS Job Status
Method: get
Path: /v1/integrations/{code}/{version}/schedule/state/{id}
Import (Add) a Package
Method: post
Path: /v1/packages/import
Import (Add) an Integration
Method: post
Path: /v1/integrations/import
Import (Replace) an Integration
Method: put
Path: /v1/integrations/import
Retrieve a Connection
Method: get
Path: /v1/connections/{code}
Retrieve a Package
Method: get
Path: /v1/packages/{packagename}
Retrieve an Integration
Method: get
Path: /v1/integrations/{code}/{version}
Retrieve Connections
Method: get
Path: /v1/connections
Retrieve Integration Monitoring Metrics
Method: get
Path: /v1/monitoring/integrations
Retrieve Integrations
Method: get
Path: /v1/integrations
Retrieve Lookups
Method: get
Path: /v1/lookups
Retrieve Packages
Method: get
Path: /v1/packages
Retrieve Single Integration Monitoring Metrics
Method: get
Path: /v1/monitoring/integrations/{code}/{version}
Retrieve the Monitoring Log
Method: get
Path: /v1/monitoring/logs
Run an Integration Flow
Method: post
Path: /v1/integrations/{code}/{version}/schedulenow
Update a Connection
Method: put
Path: /v1/connections/{code}
connections
Retrieve, update, and delete connections.
Retrieve Connections
Method: get
Path: /v1/connections
Delete a Connection
Method: delete
Path: /v1/connections/{code}
Retrieve a Connection
Method: get
Path: /v1/connections/{code}
Update a Connection
Method: put
Path: /v1/connections/{code}
integrations
Retrieve, delete, export, import, activate, deactivate, and run integrations.
Retrieve Integrations
Method: get
Path: /v1/integrations
Import (Add) an Integration
Method: post
Path: /v1/integrations/import
Import (Replace) an Integration
Method: put
Path: /v1/integrations/import
Delete an Integration
Method: delete
Path: /v1/integrations/{code}/{version}
Retrieve an Integration
Method: get
Path: /v1/integrations/{code}/{version}
Activate an Integration
Method: post
Path: /v1/integrations/{code}/{version}/activate
Deactivate an Integration
Method: post
Path: /v1/integrations/{code}/{version}/deactivate
Export an Integration
Method: get
Path: /v1/integrations/{code}/{version}/export
Fetch ESS Job Status
Method: get
Path: /v1/integrations/{code}/{version}/schedule/state/{id}
Run an Integration Flow
Method: post
Path: /v1/integrations/{code}/{version}/schedulenow
lookups
Retrieve a list of lookups.
Retrieve Lookups
Method: get
Path: /v1/lookups
monitoring
Retrieve integration metrics and view or export the monitoring log.
Retrieve Integration Monitoring Metrics
Method: get
Path: /v1/monitoring/integrations
Retrieve Single Integration Monitoring Metrics
Method: get
Path: /v1/monitoring/integrations/{code}/{version}
Retrieve the Monitoring Log
Method: get
Path: /v1/monitoring/logs
Export the Monitoring Log
Method: get
Path: /v1/monitoring/logs/export
packages
Retrieve, delete, export, and import packages.
Retrieve Packages
Method: get
Path: /v1/packages
Import (Add) a Package
Method: post
Path: /v1/packages/import
Delete a Package
Method: delete
Path: /v1/packages/{packagename}
Retrieve a Package
Method: get
Path: /v1/packages/{packagename}
Export a Package
Method: get
Path: /v1/packages/{packagename}/export
All Endpoints
Retrieve Connections
Method: get
Path: /v1/connections
Delete a Connection
Method: delete
Path: /v1/connections/{code}
Retrieve a Connection
Method: get
Path: /v1/connections/{code}
Update a Connection
Method: put
Path: /v1/connections/{code}
Retrieve Integrations
Method: get
Path: /v1/integrations
Import (Add) an Integration
Method: post
Path: /v1/integrations/import
Import (Replace) an Integration
Method: put
Path: /v1/integrations/import
Delete an Integration
Method: delete
Path: /v1/integrations/{code}/{version}
Retrieve an Integration
Method: get
Path: /v1/integrations/{code}/{version}
Activate an Integration
Method: post
Path: /v1/integrations/{code}/{version}/activate
Deactivate an Integration
Method: post
Path: /v1/integrations/{code}/{version}/deactivate
Export an Integration
Method: get
Path: /v1/integrations/{code}/{version}/export
Fetch ESS Job Status
Method: get
Path: /v1/integrations/{code}/{version}/schedule/state/{id}
Run an Integration Flow
Method: post
Path: /v1/integrations/{code}/{version}/schedulenow
Retrieve Lookups
Method: get
Path: /v1/lookups
Retrieve Integration Monitoring Metrics
Method: get
Path: /v1/monitoring/integrations
Retrieve Single Integration Monitoring Metrics
Method: get
Path: /v1/monitoring/integrations/{code}/{version}
Retrieve the Monitoring Log
Method: get
Path: /v1/monitoring/logs
Export the Monitoring Log
Method: get
Path: /v1/monitoring/logs/export
Retrieve Packages
Method: get
Path: /v1/packages
Import (Add) a Package
Method: post
Path: /v1/packages/import
Delete a Package
Method: delete
Path: /v1/packages/{packagename}
Retrieve a Package
Method: get
Path: /v1/packages/{packagename}
Export a Package
Method: get
Path: /v1/packages/{packagename}/export
connections
Retrieve, update, and delete connections.
Delete a Connection
Method: delete
Path: /v1/connections/{code}
Retrieve Connections
Method: get
Path: /v1/connections
Retrieve a Connection
Method: get
Path: /v1/connections/{code}
Update a Connection
Method: put
Path: /v1/connections/{code}
integrations
Retrieve, delete, export, import, activate, deactivate, and run integrations.
Delete an Integration
Method: delete
Path: /v1/integrations/{code}/{version}
Retrieve Integrations
Method: get
Path: /v1/integrations
Retrieve an Integration
Method: get
Path: /v1/integrations/{code}/{version}
Export an Integration
Method: get
Path: /v1/integrations/{code}/{version}/export
Fetch ESS Job Status
Method: get
Path: /v1/integrations/{code}/{version}/schedule/state/{id}
Import (Add) an Integration
Method: post
Path: /v1/integrations/import
Activate an Integration
Method: post
Path: /v1/integrations/{code}/{version}/activate
Deactivate an Integration
Method: post
Path: /v1/integrations/{code}/{version}/deactivate
Run an Integration Flow
Method: post
Path: /v1/integrations/{code}/{version}/schedulenow
Import (Replace) an Integration
Method: put
Path: /v1/integrations/import
lookups
Retrieve a list of lookups.
Retrieve Lookups
Method: get
Path: /v1/lookups
monitoring
Retrieve integration metrics and view or export the monitoring log.
Retrieve Integration Monitoring Metrics
Method: get
Path: /v1/monitoring/integrations
Retrieve Single Integration Monitoring Metrics
Method: get
Path: /v1/monitoring/integrations/{code}/{version}
Retrieve the Monitoring Log
Method: get
Path: /v1/monitoring/logs
Export the Monitoring Log
Method: get
Path: /v1/monitoring/logs/export
packages
Retrieve, delete, export, and import packages.
Delete a Package
Method: delete
Path: /v1/packages/{packagename}
Retrieve Packages
Method: get
Path: /v1/packages
Retrieve a Package
Method: get
Path: /v1/packages/{packagename}
Export a Package
Method: get
Path: /v1/packages/{packagename}/export
Import (Add) a Package
Method: post
Path: /v1/packages/import
All Endpoints
Delete a Connection
Method: delete
Path: /v1/connections/{code}
Delete an Integration
Method: delete
Path: /v1/integrations/{code}/{version}
Delete a Package
Method: delete
Path: /v1/packages/{packagename}
Retrieve Connections
Method: get
Path: /v1/connections
Retrieve a Connection
Method: get
Path: /v1/connections/{code}
Retrieve Integrations
Method: get
Path: /v1/integrations
Retrieve an Integration
Method: get
Path: /v1/integrations/{code}/{version}
Export an Integration
Method: get
Path: /v1/integrations/{code}/{version}/export
Fetch ESS Job Status
Method: get
Path: /v1/integrations/{code}/{version}/schedule/state/{id}
Retrieve Lookups
Method: get
Path: /v1/lookups
Retrieve Integration Monitoring Metrics
Method: get
Path: /v1/monitoring/integrations
Retrieve Single Integration Monitoring Metrics
Method: get
Path: /v1/monitoring/integrations/{code}/{version}
Retrieve the Monitoring Log
Method: get
Path: /v1/monitoring/logs
Export the Monitoring Log
Method: get
Path: /v1/monitoring/logs/export
Retrieve Packages
Method: get
Path: /v1/packages
Retrieve a Package
Method: get
Path: /v1/packages/{packagename}
Export a Package
Method: get
Path: /v1/packages/{packagename}/export
Import (Add) an Integration
Method: post
Path: /v1/integrations/import
Activate an Integration
Method: post
Path: /v1/integrations/{code}/{version}/activate
Deactivate an Integration
Method: post
Path: /v1/integrations/{code}/{version}/deactivate
Run an Integration Flow
Method: post
Path: /v1/integrations/{code}/{version}/schedulenow
Import (Add) a Package
Method: post
Path: /v1/packages/import
Update a Connection
Method: put
Path: /v1/connections/{code}
Import (Replace) an Integration
Method: put
Path: /v1/integrations/import