Endpoint definition
An endpoint is a reusable item that defines the connection parameters required to communicate with an external system.
By separating connection details—such as URLs, port numbers, and authentication credentials—from the specific logic of a task, endpoints enhance security and simplify maintenance. Instead of defining connection parameters within every individual task, you can define an endpoint once and reference it across multiple tasks and workflows.
Structure
To define an endpoint, you must specify the following information:
- Folder: The logical container where the endpoint definition is stored.
- Name: A unique identifier for the endpoint within the folder.
- Description: An optional text field to describe the purpose of the endpoint.
- Endpoint type: The specific task
plug-in ID associated with the external system (for example,
RESTful,Database,AmazonBedrock). This determines which connection parameters are required. - Connection parameters: The specific details required to establish a connection, such as the target URL, port, protocol, and authentication method (API Key, credentials, or certificates).
- Workstation: An optional workstation reference used to run test connections and picklist retrieval. If not specified, the default CLOUD workstation is used.
Endpoint monitoring
You can optionally configure the Monitored frequency attribute to proactively check the availability of the external system.
- Frequency range: You can set the monitoring frequency between 1 minute and 24 hours. If this value is not set, the endpoint is not monitored.
- Behavior: The Scheduler microservice periodically runs a test connection based on the specified frequency. The result of this test updates the Actual status of the endpoint.
Endpoint status
The availability of an endpoint is managed through two distinct status fields: Status and Actual status.
Status
You can manually toggle the endpoint status to control task submission:
- Online: The endpoint is active. The system may perform monitoring checks if configured.
- Offline: The endpoint is manually taken out of service. No tasks referencing this endpoint can be submitted.
Actual Status
The system automatically updates the Actual status based on the status setting and the results of monitoring tests. Tasks referencing the endpoint only run if the Actual status is Available.
| Actual status | Description | Task behavior |
|---|---|---|
| Available | The endpoint is Online. If monitoring is enabled, the last connectivity check was successful. | Tasks are submitted and run. |
| Error | The endpoint is Online, but the monitoring test failed to connect to the external system. | Tasks remain in READY: waiting for endpoint status. |
| Unknown | The endpoint is Online and monitored, but the first availability test has not yet completed. | Tasks remain in READY: waiting for endpoint status. |
| Set Offline | The status is set to Offline. | Tasks remain in READY: waiting for endpoint status. |