Skip to main content

Service invocation API

In this guide, you’ll simulate and access an application by running and calling the FlowSynx API directly.

Step 1: Open terminal​

You will need to use sudo for this quickstart if:

  • The install path is /usr/local/bin (default install path).

Step 2: Run the FlowSynx​

flowctl run

After executing this command, FlowSynx starts to be running and the logs like below will be displayed.

[time=2/1/2024 6:50:39 PM | level=INFO | machine=TEST-PC] message="Now listening on: http://[::]:5860"
[time=2/1/2024 6:50:39 PM | level=INFO | machine=TEST-PC] message="Application started. Press Ctrl+C to shut down."
[time=2/1/2024 6:50:39 PM | level=INFO | machine=TEST-PC] message="Hosting environment: Production"
[time=2/1/2024 6:50:39 PM | level=INFO | machine=TEST-PC] message="Content root path: _____________"

Step 3: Calling API​

Open a new terminal and enter the below command (in this example List command will be called to getting list from given path):

curl -X POST -H "Content-Type: application/json" -d '{ "entity": "/", "options": { "fields": [], "filter": "", "caseSensitive": false, "recurse": false, "sort": "", "limit": "", "includeMetadata": false }}' http://localhost:5860/list

After executing the command, the result will be returned to you in the form of json data.