On this Page

Invoking the Task through URI Patterns

You can invoke an Ultra Pipeline as a Task by calling either the task name or the alias that was provided when you created the Ultra Task.

To obtain the URL:

In Manager, navigate to the target Project, and click the Tasks tab.
Click on the inverted arrow by the target Task, and click Details.
Copy the URL from HTTP Endpoint.
(Optional) You can view the CA certificate generated by SnapLogic by clicking Download the CA Certificate for your SnapLogic organization.

In cases where IP Address and port number are used as part of the URL, you must replace them with the name of the Host before you can invoke the Task.

Using Task Name to Invoke the Task

feed_master_uri/api/1/rest/feed-master/queue/org/project_space/project/task_name

Using Alias to Invoke the Task

feed_master_uri/api/1/rest/feed-master/queue/org/project_space/project/alias

Sending an HTTP Request to the Pipeline

To send HTTP requests to the pipeline, use the HTTP Authorization header and endpoint from the Task Details page.

The Authorization header must be included in requests sent to the endpoint if a Bearer token is configured. Otherwise, an HTTP 401 Unauthorized error is returned.
The HTTP endpoint belongs to the FeedMaster that is part of the Snaplex on which the Task is configured to run.
As an example, the following cURL command line sends a GET request to the FeedMaster with the Authorization header.
- Using the Task Name:
  $ curl -k -H 'Authorization: Bearer jH6ofxtn3qe8jGoiSWbW3adW0N6KXziV'https://groundplex.local:8084/api/1/rest/feed-master/queue/Snaplogic/projects/llfeed-demo/hello-world-task
- Using the Alias:
  $ curl -k -H 'Authorization: Bearer jH6ofxtn3qe8jGoiSWbW3adW0N6KXziV' https://groundplex.local:8084/api/1/rest/feed-master/queue/Snaplogic/projects/llfeed-demo/hello-world-task-alias

Sending an HTTP Request through a Browser

Alternatively, from an HTTP request through a browser, use the URLs to call an Ultra Pipeline with the bearer token.

Using the Task Name:
https://groundplex.local:8084/api/1/rest/feed-master/queue/Snaplogic/projects/llfeed-demo/hello-world-task?bearer_token=jH6ofxtn3qe8jGoiSWbW3adW0N6KXziV
Using the Alias:
https://groundplex.local:8084/api/1/rest/feed-master/queue/Snaplogic/projects/llfeed-demo/hello-world-task-alias?bearer_token=jH6ofxtn3qe8jGoiSWbW3adW0N6KXziV

The runs can be monitored in the SnapLogic Dashboard and can be stopped by disabling or deleting the Task. You should also check the logs in the Task Details page since prepare fails are logged and do not show up in the Dashboard. The FeedMaster writes a feed_master_access.log that follows the web server common log format with the addition of an integer that specifies how many milliseconds the request took to process.

Alias Feature - The field Alias is available only in the JCC, please ensure that your Snaplex is updated to the latest version in order to use this feature.

Using the bearer token as a query parameter

If your API calling system does not support authorization through a header, you can instead pass the bearer token as a query parameter. For example:

Curl Command

$ curl 'https://<pod_/api/1/rest/slsched/feed/example/jobs/test-hello?Name=John&bearer_token=Xrcuwn2zVLqR7KXXXXXXXXX'

HTTP Request via a browser

https://groundplex.local:8084/api/1/rest/feed-master/queue/Snaplogic/projects/llfeed-demo/hello-world-task?bearer_token=jH6ofxtn3qe8jGoiSWbW3adW0N6KXziV

Enabling/Disabling the Task in Manager

To start or stop an Task:

In Manager, click Tasks to display a list of all Tasks.
Select the target Ultra Task, then in the upper right sided corner of the window, adjacent to the icons, click Enable to start the Task or Disable to stop it.

High Availability Using Alias to Deploy Ultra Tasks in Multiple Snaplexes

You can deploy an Ultra Pipeline across multiple Snaplexes by using the Task Alias you have assigned to the Task in the Alias field instead of using the Task Name. This capability enables High Availability configurations to ensure that if one Snaplex goes down, the Task is triggered in the other Snaplex. This feature is available on the JCC node.

See Also

Community Posts: Creating APIs with SnapLogic Pipelines and Ultra Tasks

Browser not supported