All REST Endpoints

connections
Retrieve, update, manage attachments for, and delete connections.
Delete a Connection
Method: delete
Path: /v1/connections/{code}
Retrieve a Connection
Method: get
Path: /v1/connections/{code}
Retrieve an Attachment
Method: get
Path: /v1/connections/{id}/attachments/{connPropName}
Retrieve Connections
Method: get
Path: /v1/connections
Update a Connection
Method: put
Path: /v1/connections/{code}
Upload an Attachment
Method: post
Path: /v1/connections/{id}/attachments/{connPropName}
environment
Retrieve ICS environment information and manage compression.
Retrieve Compression Status
Method: get
Path: /v1/environment/compresswsdls
Retrieve ICS Environment Information
Method: get
Path: /v1/environment
Start Compression
Method: post
Path: /v1/environment/compresswsdls
integrations
Retrieve, delete, export, import, activate, deactivate, and run integrations.
Activate an Integration
Method: post
Path: /v1/integrations/{code}/{version}/activate
Clone an Integration
Method: post
Path: /v1/integrations/{code}/{version}/clone
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
Pause a Schedule
Method: post
Path: /v1/integrations/{code}/{version}/schedule/pause
Resume a Schedule
Method: post
Path: /v1/integrations/{code}/{version}/schedule/resume
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
Start a Schedule
Method: post
Path: /v1/integrations/{code}/{version}/schedule/start
Stop a Schedule
Method: post
Path: /v1/integrations/{code}/{version}/schedule/stop
lookups
Retrieve a list of lookups.
Retrieve Lookups
Method: get
Path: /v1/lookups
monitoring
Retrieve, discard, or resubmit a list of error instances. Also retrieve integration monitoring metrics and monitoring logs.
Discard an instance
Method: post
Path: /v1/monitoring/errors/{instanceid}/discard
Discard instances by connection
Method: post
Path: /v1/monitoring/errors/discardbyconnection/{connection}
Discard instances by integration
Method: post
Path: /v1/monitoring/errors/discardbyintegration/{code}/{version}
Export the Monitoring Log
Method: get
Path: /v1/monitoring/logs/export
Resubmit an instance
Method: post
Path: /v1/monitoring/errors/{instanceid}/resubmit
Resubmit instances by connection
Method: post
Path: /v1/monitoring/errors/resubmitbyconnection/{connection}
Resubmit instances by integration
Method: post
Path: /v1/monitoring/errors/resubmitbyintegration/{code}/{version}
Retrieve an Error Instance
Method: get
Path: /v1/monitoring/errors/{id}
Retrieve an Instance
Method: get
Path: /v1/monitoring/instances/{id}
Retrieve Error Instances
Method: get
Path: /v1/monitoring/errors
Retrieve Instances
Method: get
Path: /v1/monitoring/instances
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
status
Retrieve ICS status information.
Retrieve ICS Status Information
Method: get
Path: /v1/status
usage
Retrieve ICS usage information.
Retrieve ICS Usage Information
Method: get
Path: /v1/usage
All Endpoints
Activate an Integration
Method: post
Path: /v1/integrations/{code}/{version}/activate
Clone an Integration
Method: post
Path: /v1/integrations/{code}/{version}/clone
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}
Discard an instance
Method: post
Path: /v1/monitoring/errors/{instanceid}/discard
Discard instances by connection
Method: post
Path: /v1/monitoring/errors/discardbyconnection/{connection}
Discard instances by integration
Method: post
Path: /v1/monitoring/errors/discardbyintegration/{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
Pause a Schedule
Method: post
Path: /v1/integrations/{code}/{version}/schedule/pause
Resubmit an instance
Method: post
Path: /v1/monitoring/errors/{instanceid}/resubmit
Resubmit instances by connection
Method: post
Path: /v1/monitoring/errors/resubmitbyconnection/{connection}
Resubmit instances by integration
Method: post
Path: /v1/monitoring/errors/resubmitbyintegration/{code}/{version}
Resume a Schedule
Method: post
Path: /v1/integrations/{code}/{version}/schedule/resume
Retrieve a Connection
Method: get
Path: /v1/connections/{code}
Retrieve a Package
Method: get
Path: /v1/packages/{packagename}
Retrieve an Attachment
Method: get
Path: /v1/connections/{id}/attachments/{connPropName}
Retrieve an Error Instance
Method: get
Path: /v1/monitoring/errors/{id}
Retrieve an Instance
Method: get
Path: /v1/monitoring/instances/{id}
Retrieve an Integration
Method: get
Path: /v1/integrations/{code}/{version}
Retrieve Compression Status
Method: get
Path: /v1/environment/compresswsdls
Retrieve Connections
Method: get
Path: /v1/connections
Retrieve Error Instances
Method: get
Path: /v1/monitoring/errors
Retrieve ICS Environment Information
Method: get
Path: /v1/environment
Retrieve ICS Status Information
Method: get
Path: /v1/status
Retrieve ICS Usage Information
Method: get
Path: /v1/usage
Retrieve Instances
Method: get
Path: /v1/monitoring/instances
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
Start a Schedule
Method: post
Path: /v1/integrations/{code}/{version}/schedule/start
Start Compression
Method: post
Path: /v1/environment/compresswsdls
Stop a Schedule
Method: post
Path: /v1/integrations/{code}/{version}/schedule/stop
Update a Connection
Method: put
Path: /v1/connections/{code}
Upload an Attachment
Method: post
Path: /v1/connections/{id}/attachments/{connPropName}
connections
Retrieve, update, manage attachments for, 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}
Retrieve an Attachment
Method: get
Path: /v1/connections/{id}/attachments/{connPropName}
Upload an Attachment
Method: post
Path: /v1/connections/{id}/attachments/{connPropName}
environment
Retrieve ICS environment information and manage compression.
Retrieve ICS Environment Information
Method: get
Path: /v1/environment
Retrieve Compression Status
Method: get
Path: /v1/environment/compresswsdls
Start Compression
Method: post
Path: /v1/environment/compresswsdls
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
Clone an Integration
Method: post
Path: /v1/integrations/{code}/{version}/clone
Deactivate an Integration
Method: post
Path: /v1/integrations/{code}/{version}/deactivate
Export an Integration
Method: get
Path: /v1/integrations/{code}/{version}/export
Pause a Schedule
Method: post
Path: /v1/integrations/{code}/{version}/schedule/pause
Resume a Schedule
Method: post
Path: /v1/integrations/{code}/{version}/schedule/resume
Start a Schedule
Method: post
Path: /v1/integrations/{code}/{version}/schedule/start
Fetch ESS Job Status
Method: get
Path: /v1/integrations/{code}/{version}/schedule/state/{id}
Stop a Schedule
Method: post
Path: /v1/integrations/{code}/{version}/schedule/stop
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, discard, or resubmit a list of error instances. Also retrieve integration monitoring metrics and monitoring logs.
Retrieve Error Instances
Method: get
Path: /v1/monitoring/errors
Discard instances by connection
Method: post
Path: /v1/monitoring/errors/discardbyconnection/{connection}
Discard instances by integration
Method: post
Path: /v1/monitoring/errors/discardbyintegration/{code}/{version}
Resubmit instances by connection
Method: post
Path: /v1/monitoring/errors/resubmitbyconnection/{connection}
Resubmit instances by integration
Method: post
Path: /v1/monitoring/errors/resubmitbyintegration/{code}/{version}
Retrieve an Error Instance
Method: get
Path: /v1/monitoring/errors/{id}
Discard an instance
Method: post
Path: /v1/monitoring/errors/{instanceid}/discard
Resubmit an instance
Method: post
Path: /v1/monitoring/errors/{instanceid}/resubmit
Retrieve Instances
Method: get
Path: /v1/monitoring/instances
Retrieve an Instance
Method: get
Path: /v1/monitoring/instances/{id}
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
status
Retrieve ICS status information.
Retrieve ICS Status Information
Method: get
Path: /v1/status
usage
Retrieve ICS usage information.
Retrieve ICS Usage Information
Method: get
Path: /v1/usage
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 an Attachment
Method: get
Path: /v1/connections/{id}/attachments/{connPropName}
Upload an Attachment
Method: post
Path: /v1/connections/{id}/attachments/{connPropName}
Retrieve ICS Environment Information
Method: get
Path: /v1/environment
Retrieve Compression Status
Method: get
Path: /v1/environment/compresswsdls
Start Compression
Method: post
Path: /v1/environment/compresswsdls
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
Clone an Integration
Method: post
Path: /v1/integrations/{code}/{version}/clone
Deactivate an Integration
Method: post
Path: /v1/integrations/{code}/{version}/deactivate
Export an Integration
Method: get
Path: /v1/integrations/{code}/{version}/export
Pause a Schedule
Method: post
Path: /v1/integrations/{code}/{version}/schedule/pause
Resume a Schedule
Method: post
Path: /v1/integrations/{code}/{version}/schedule/resume
Start a Schedule
Method: post
Path: /v1/integrations/{code}/{version}/schedule/start
Fetch ESS Job Status
Method: get
Path: /v1/integrations/{code}/{version}/schedule/state/{id}
Stop a Schedule
Method: post
Path: /v1/integrations/{code}/{version}/schedule/stop
Run an Integration Flow
Method: post
Path: /v1/integrations/{code}/{version}/schedulenow
Retrieve Lookups
Method: get
Path: /v1/lookups
Retrieve Error Instances
Method: get
Path: /v1/monitoring/errors
Discard instances by connection
Method: post
Path: /v1/monitoring/errors/discardbyconnection/{connection}
Discard instances by integration
Method: post
Path: /v1/monitoring/errors/discardbyintegration/{code}/{version}
Resubmit instances by connection
Method: post
Path: /v1/monitoring/errors/resubmitbyconnection/{connection}
Resubmit instances by integration
Method: post
Path: /v1/monitoring/errors/resubmitbyintegration/{code}/{version}
Retrieve an Error Instance
Method: get
Path: /v1/monitoring/errors/{id}
Discard an instance
Method: post
Path: /v1/monitoring/errors/{instanceid}/discard
Resubmit an instance
Method: post
Path: /v1/monitoring/errors/{instanceid}/resubmit
Retrieve Instances
Method: get
Path: /v1/monitoring/instances
Retrieve an Instance
Method: get
Path: /v1/monitoring/instances/{id}
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
Retrieve ICS Status Information
Method: get
Path: /v1/status
Retrieve ICS Usage Information
Method: get
Path: /v1/usage
connections
Retrieve, update, manage attachments for, 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}
Retrieve an Attachment
Method: get
Path: /v1/connections/{id}/attachments/{connPropName}
Upload an Attachment
Method: post
Path: /v1/connections/{id}/attachments/{connPropName}
Update a Connection
Method: put
Path: /v1/connections/{code}
environment
Retrieve ICS environment information and manage compression.
Retrieve ICS Environment Information
Method: get
Path: /v1/environment
Retrieve Compression Status
Method: get
Path: /v1/environment/compresswsdls
Start Compression
Method: post
Path: /v1/environment/compresswsdls
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
Clone an Integration
Method: post
Path: /v1/integrations/{code}/{version}/clone
Deactivate an Integration
Method: post
Path: /v1/integrations/{code}/{version}/deactivate
Pause a Schedule
Method: post
Path: /v1/integrations/{code}/{version}/schedule/pause
Resume a Schedule
Method: post
Path: /v1/integrations/{code}/{version}/schedule/resume
Start a Schedule
Method: post
Path: /v1/integrations/{code}/{version}/schedule/start
Stop a Schedule
Method: post
Path: /v1/integrations/{code}/{version}/schedule/stop
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, discard, or resubmit a list of error instances. Also retrieve integration monitoring metrics and monitoring logs.
Retrieve Error Instances
Method: get
Path: /v1/monitoring/errors
Retrieve an Error Instance
Method: get
Path: /v1/monitoring/errors/{id}
Retrieve Instances
Method: get
Path: /v1/monitoring/instances
Retrieve an Instance
Method: get
Path: /v1/monitoring/instances/{id}
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
Discard instances by connection
Method: post
Path: /v1/monitoring/errors/discardbyconnection/{connection}
Discard instances by integration
Method: post
Path: /v1/monitoring/errors/discardbyintegration/{code}/{version}
Resubmit instances by connection
Method: post
Path: /v1/monitoring/errors/resubmitbyconnection/{connection}
Resubmit instances by integration
Method: post
Path: /v1/monitoring/errors/resubmitbyintegration/{code}/{version}
Discard an instance
Method: post
Path: /v1/monitoring/errors/{instanceid}/discard
Resubmit an instance
Method: post
Path: /v1/monitoring/errors/{instanceid}/resubmit
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
status
Retrieve ICS status information.
Retrieve ICS Status Information
Method: get
Path: /v1/status
usage
Retrieve ICS usage information.
Retrieve ICS Usage Information
Method: get
Path: /v1/usage
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 an Attachment
Method: get
Path: /v1/connections/{id}/attachments/{connPropName}
Retrieve ICS Environment Information
Method: get
Path: /v1/environment
Retrieve Compression Status
Method: get
Path: /v1/environment/compresswsdls
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 Error Instances
Method: get
Path: /v1/monitoring/errors
Retrieve an Error Instance
Method: get
Path: /v1/monitoring/errors/{id}
Retrieve Instances
Method: get
Path: /v1/monitoring/instances
Retrieve an Instance
Method: get
Path: /v1/monitoring/instances/{id}
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
Retrieve ICS Status Information
Method: get
Path: /v1/status
Retrieve ICS Usage Information
Method: get
Path: /v1/usage
Upload an Attachment
Method: post
Path: /v1/connections/{id}/attachments/{connPropName}
Start Compression
Method: post
Path: /v1/environment/compresswsdls
Import (Add) an Integration
Method: post
Path: /v1/integrations/import
Activate an Integration
Method: post
Path: /v1/integrations/{code}/{version}/activate
Clone an Integration
Method: post
Path: /v1/integrations/{code}/{version}/clone
Deactivate an Integration
Method: post
Path: /v1/integrations/{code}/{version}/deactivate
Pause a Schedule
Method: post
Path: /v1/integrations/{code}/{version}/schedule/pause
Resume a Schedule
Method: post
Path: /v1/integrations/{code}/{version}/schedule/resume
Start a Schedule
Method: post
Path: /v1/integrations/{code}/{version}/schedule/start
Stop a Schedule
Method: post
Path: /v1/integrations/{code}/{version}/schedule/stop
Run an Integration Flow
Method: post
Path: /v1/integrations/{code}/{version}/schedulenow
Discard instances by connection
Method: post
Path: /v1/monitoring/errors/discardbyconnection/{connection}
Discard instances by integration
Method: post
Path: /v1/monitoring/errors/discardbyintegration/{code}/{version}
Resubmit instances by connection
Method: post
Path: /v1/monitoring/errors/resubmitbyconnection/{connection}
Resubmit instances by integration
Method: post
Path: /v1/monitoring/errors/resubmitbyintegration/{code}/{version}
Discard an instance
Method: post
Path: /v1/monitoring/errors/{instanceid}/discard
Resubmit an instance
Method: post
Path: /v1/monitoring/errors/{instanceid}/resubmit
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