All REST Endpoints

adapters
Retrieve a list of adapters or details about a single adapter.
Retrieve Adapter Metadata Link
Method: options
Path: /icsapis/v2/adapters
Retrieve Adapters
Method: get
Path: /icsapis/v2/adapters
Retrieve an Adapter
Method: get
Path: /icsapis/v2/adapters/{name}
certificates
Retrieve, add, or replace a list of certificates.
Delete a certificate from keystore
Method: delete
Path: /icsapis/v2/certificates/{id}
Import (Add) a certificate
Method: post
Path: /icsapis/v2/certificates
Import (Replace) a certificate
Method: post
Path: /icsapis/v2/certificates/{id}
Retrieve an certificate
Method: get
Path: /icsapis/v2/certificates/{id}
Retrieve certificates
Method: get
Path: /icsapis/v2/certificates
Retrieve certificates metadata link
Method: options
Path: /icsapis/v2/certificates
connections
Retrieve, update, manage attachments for, and delete connections.
Delete a connection
Method: delete
Path: /icsapis/v2/connections/{id}
Retrieve a Connection
Method: get
Path: /icsapis/v2/connections/{id}
Retrieve Connection Metadata Link
Method: options
Path: /icsapis/v2/connections
Retrieve Connection Property Attachment
Method: get
Path: /icsapis/v2/connections/{id}/attachments/{connPropName}
Retrieve Connections
Method: get
Path: /icsapis/v2/connections
Test a Connection
Method: post
Path: /icsapis/v2/connections/{id}/test
Update a Connection
Method: post
Path: /icsapis/v2/connections/{id}
Upload Connection Property Attachment
Method: post
Path: /icsapis/v2/connections/{id}/attachments/{connPropName}
environment
Retrieve Environment Metadata Link
Method: options
Path: /icsapis/v2/environment
Retrieve Environment Parameters
Method: get
Path: /icsapis/v2/environment
Retrieve environment trackingdb metadata link
Method: options
Path: /icsapis/v2/environment/trackingdb
Retrieve tracking db parameters
Method: get
Path: /icsapis/v2/environment/trackingdb
Start tracking db purge process
Method: post
Path: /icsapis/v2/environment/trackingdb/purge
Update tracking db parameters
Method: post
Path: /icsapis/v2/environment/trackingdb
integrations
Retrieve, delete, export, import, activate, deactivate, and run integrations.
Clone an Integration
Method: post
Path: /icsapis/v2/integrations/{id}/clone
Delete an Integration Version
Method: delete
Path: /icsapis/v2/integrations/{id}
Export an Integration
Method: get
Path: /icsapis/v2/integrations/{id}/archive
Fetch ESS Job Status
Method: get
Path: /icsapis/v2/integrations/{id}/schedule/jobs/{job_id}
Import (Add) an Integration
Method: post
Path: /icsapis/v2/integrations/archive
Import (Replace) an Integration
Method: put
Path: /icsapis/v2/integrations/archive
Pause schedule of an Integration Flow
Method: post
Path: /icsapis/v2/integrations/{id}/schedule/pause
Resume schedule of an Integration Flow
Method: post
Path: /icsapis/v2/integrations/{id}/schedule/resume
Retrieve an Integration
Method: get
Path: /icsapis/v2/integrations/{id}
Retrieve Integration Metadata Link
Method: options
Path: /icsapis/v2/integrations
Retrieve Integrations
Method: get
Path: /icsapis/v2/integrations
Run an Integration Flow
Method: post
Path: /icsapis/v2/integrations/{id}/schedule/jobs
Start schedule of an Integration Flow
Method: post
Path: /icsapis/v2/integrations/{id}/schedule/start
Stop schedule of an Integration Flow
Method: post
Path: /icsapis/v2/integrations/{id}/schedule/stop
Update an Integration
Method: post
Path: /icsapis/v2/integrations/{id}
libraries
Delete a Library version
Method: delete
Path: /icsapis/v2/libraries/{id}
Export a Library
Method: get
Path: /icsapis/v2/libraries/{id}/archive
Export Library Metadata
Method: get
Path: /icsapis/v2/libraries/{id}/metadata
Import/Register a Library
Method: post
Path: /icsapis/v2/libraries/archive
Retrieve a Library version
Method: get
Path: /icsapis/v2/libraries/{id}
Retrieve Libraries
Method: get
Path: /icsapis/v2/libraries
Retrieve Library Metadata link
Method: options
Path: /icsapis/v2/libraries
Retrieve Library status
Method: get
Path: /icsapis/v2/libraries/status/{id}
lookups
Retrieve, export, and import lookups.
Delete a lookup
Method: delete
Path: /icsapis/v2/lookups/{name}
Export a Lookup
Method: get
Path: /icsapis/v2/lookups/{name}/archive
Import (Add) a Lookup
Method: post
Path: /icsapis/v2/lookups/archive
Import (Replace) a Lookup
Method: put
Path: /icsapis/v2/lookups/archive
Retrieve a Lookup
Method: get
Path: /icsapis/v2/lookups/{name}
Retrieve Lookup Metadata Link
Method: options
Path: /icsapis/v2/lookups
Retrieve Lookups
Method: get
Path: /icsapis/v2/lookups
monitoring
Resubmit or Discard Error Instances
Method: post
Path: /icsapis/v2/monitoring/errors/jobs
Retrieve a Monitoring Log File
Method: get
Path: /icsapis/v2/monitoring/logs/{id}
Retrieve an Error Instance
Method: get
Path: /icsapis/v2/monitoring/errors/{id}
Retrieve an Instance
Method: get
Path: /icsapis/v2/monitoring/instances/{id}
Retrieve Error Instances
Method: get
Path: /icsapis/v2/monitoring/errors
Retrieve Error Monitoring Metadata Link
Method: options
Path: /icsapis/v2/monitoring/errors
Retrieve Instance Monitoring Metadata Link
Method: options
Path: /icsapis/v2/monitoring/instances
Retrieve Instances
Method: get
Path: /icsapis/v2/monitoring/instances
Retrieve Integrations Monitoring Metadata Link
Method: options
Path: /icsapis/v2/monitoring/integrations
Retrieve Log Monitoring Metadata Link
Method: options
Path: /icsapis/v2/monitoring/logs
Retrieve Monitoring Log Files
Method: get
Path: /icsapis/v2/monitoring/logs
Retrieve Monitoring Metrics for a Single Integration
Method: get
Path: /icsapis/v2/monitoring/integrations/{id}
Retrieve Monitoring Metrics for All Integrations
Method: get
Path: /icsapis/v2/monitoring/integrations
Retrieves monitoring audit records based on query
Method: get
Path: /icsapis/v2/monitoring/auditRecords
packages
Retrieve, delete, export, and import packages.
Delete a Package
Method: delete
Path: /icsapis/v2/packages/{packagename}
Export a Package
Method: get
Path: /icsapis/v2/packages/{packagename}/archive
Import (Add) a Package
Method: post
Path: /icsapis/v2/packages/archive
Retrieve a Package
Method: get
Path: /icsapis/v2/packages/{packagename}
Retrieve Package Metadata Link
Method: options
Path: /icsapis/v2/packages
Retrieve Packages
Method: get
Path: /icsapis/v2/packages
recoveryconfig
Retrieve recovery and update configurations.
Retrieve recovery config metadata link
Method: options
Path: /icsapis/v2/recoveryconfig
Retrieve recovery configuration
Method: get
Path: /icsapis/v2/recoveryconfig
Update recovery configuration
Method: put
Path: /icsapis/v2/recoveryconfig
runrequests
Retrieve, list, and delete ESS runtime requests.
Delete an ESS Runtime Request
Method: delete
Path: /icsapis/v2/runrequests/{id}
Pause all Run Requests
Method: post
Path: /icsapis/v2/runrequests/pause
Resume all Run Requests
Method: post
Path: /icsapis/v2/runrequests/resume
Retrieve an ESS Runtime Request
Method: get
Path: /icsapis/v2/runrequests/{id}
Retrieve ESS Runtime Request Metadata Link
Method: options
Path: /icsapis/v2/runrequests
Retrieve ESS Runtime Requests
Method: get
Path: /icsapis/v2/runrequests
Start all Schedules
Method: post
Path: /icsapis/v2/runrequests/start
Stop all Run Requests
Method: post
Path: /icsapis/v2/runrequests/stop
status
Retrieve information about the runtime health of ICS.
Retrieve ICS Status Information
Method: get
Path: /icsapis/v2/status