Managing an endpoint definition from the Orchestration CLI

Syntax

$endpoint
[folder/]endpoint_name
  [description "text"]
  [monitor_frequency_seconds value]
  task_plugin_id
  CONNECTION
    {
      "connection_parameter_key" : "connection_parameter_value",
      ...
    }
  [WORKSTATION workstation_name]
END

Arguments

• [folder/]endpoint_name: Using this keyword, you can define the name of the endpoint. The name must start with a letter and can contain alphanumeric characters, dashes, and underscores. Optionally, you can specify the folder name where the endpoint is defined.
• description "text": Using this keyword, you can specify a description for the endpoint. The content must be enclosed within double quotation marks.
• monitor_frequency_seconds value: Using this keyword, you can specify the frequency in seconds at which the endpoint availability is checked. The value range is from 60 seconds (1 minute) to 86400 seconds (24 hours). If not specified, the endpoint is not monitored.
• task_plugin_id: Using this keyword, you can specify the task type plugin ID associated with the external system (for example, RESTful or Database).
• CONNECTION: Using this keyword, you define the block containing the specific connection parameters required by the plugin type (such as URLs, users, or API keys) in JSON format.
• WORKSTATION workstation_name: Using this keyword, you can optionally specify the workstation used to run test connections. If not specified, the default CLOUD workstation is used.

Examples

Example 1: Defining a RESTful endpoint

The following example defines a RESTful endpoint named MY_REST_ENDPOINT located in the /Production folder. It is monitored every 300 seconds (5 minutes).

$endpoint
                /Production/MY_REST_ENDPOINT
                DESCRIPTION "Connection to external payment gateway"
                MONITOR_FREQUENCY_SECONDS 300
                RESTful
                CONNECTION
                {
                "serviceUrl" : "https://api.payment-gateway.com/v1",
                "authType" : "Basic",
                "username" : "service_user",
                "password" : "${password:service_user_pwd}"
                }
                END

Example 2: Defining a Database endpoint

The following example defines a Database endpoint named SALES_DB that is not monitored.

$endpoint
                SALES_DB
                DESCRIPTION "Sales reporting database"
                Database
                CONNECTION
                {
                "dbVendor" : "postgresql",
                "connectionUrl" : "jdbc:postgresql://db.sales.com:5432/reporting",
                "username" : "db_admin",
                "password" : "${secret:db_password}"
                }
                WORKSTATION AGENT_NYC
                END