FlowSynx Plugins API

The FlowSynx Plugins API allows clients to manage plugin lifecycle operations such as listing, installing, retrieving details, updating, and removing plugins. It uses RESTful principles and supports both Basic Authentication and Bearer Token Authentication.

Authentication

1. Basic Auth

curl -u username:password http://localhost:6262/plugins

2.Bearer Token

curl -H "Authorization: Bearer <your_token>" http://localhost:6262/plugins

API Endpoints

List Installed Plugins

• Method: GET
• Endpoint: /plugins
• Body Required: No

curl Example

curl -X GET http://localhost:6262/plugins \
  -H "Authorization: Bearer <your_token>"

Example response

{
  "data": [
    {
      "id": "6c60c794-99b9-47e8-aa34-18a14cdc4583",
      "type": "FlowSynx.Execution.ExternalProcess",
      "version": "1.0.0",
      "description": "Execute external processes, scripts, or commands and capture their output, enabling integration of external tasks within workflows."
    }
  ],
  "messages": [],
  "succeeded": true,
  "generatedAtUtc": "2025-08-02T13:10:05.2517196Z"
}

Install Plugin

• Method: POST
• Endpoint: /plugins
• Body Required: Yes

Request Body

{
  "Type": "FlowSynx.Execution.ExternalProcess",
  "Version": "1.0.0"
}

curl Example

curl -X POST http://localhost:6262/plugins \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d '{
        "Type": "FlowSynx.Execution.ExternalProcess",
        "Version": "1.0.0"
      }'

Example response

{
  "data": {},
  "messages": [
    "The plugin has been installed successfully."
  ],
  "succeeded": true,
  "generatedAtUtc": "2025-08-02T13:09:52.9549804Z"
}

Get Plugin Details

• Method: GET
• Endpoint: /plugins/{pluginId}
• Body Required: No

info

• pluginId: UUID of the plugin to retrieve

curl Example

curl -X GET http://localhost:6262/plugins/6c60c794-99b9-47e8-aa34-18a14cdc4583 \
  -H "Authorization: Bearer <your_token>"

Example response

{
  "data": {
    "id": "6c60c794-99b9-47e8-aa34-18a14cdc4583",
    "type": "FlowSynx.Execution.ExternalProcess",
    "version": "1.0.0",
    "description": "Execute external processes, scripts, or commands and capture their output, enabling integration of external tasks within workflows.",
    "specifications": []
  },
  "messages": [],
  "succeeded": true,
  "generatedAtUtc": "2025-08-02T14:20:56.7520762Z"
}

Update Plugin

• Method: PUT
• Endpoint: /plugins
• Body Required: Yes

Request Body

{
  "Type": "FlowSynx.Execution.ExternalProcess",
  "Version": "1.0.0"
}

curl Example

curl -X PUT http:/localhost:6262/plugins \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d '{
        "Type": "FlowSynx.Execution.ExternalProcess",
        "Version": "1.0.0"
      }'

Example response

{
  "data": {},
  "messages": [
    "The plugin has been uninstalled successfully."
  ],
  "succeeded": true,
  "generatedAtUtc": "2025-08-02T13:09:52.9549804Z"
}

Uninstall Plugin

• Method: DELETE
• Endpoint: /plugins
• Body Required: Yes

Request Body

{
  "Type": "FlowSynx.Execution.ExternalProcess",
  "Version": "1.0.0"
}

curl Example

curl -X DELETE http://localhost:6262/plugins \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d '{
        "Type": "FlowSynx.Execution.ExternalProcess",
        "Version": "1.0.0"
      }'

Example response

{
  "data": {},
  "messages": [
    "The plugin has been uninstalled successfully."
  ],
  "succeeded": true,
  "generatedAtUtc": "2025-08-02T13:09:52.9549804Z"
}

Summary Table

Operation	Method	Endpoint	Body	curl Example
List Plugins	GET	/plugins	No	✔️
Install Plugin	POST	/plugins	Yes	✔️
Plugin Details	GET	/plugins/{pluginId}	No	✔️
Update Plugin	PUT	/plugins	Yes	✔️
Uninstall Plugin	DELETE	/plugins	Yes	✔️

info

• Use Bearer or Basic authentication depending on server configuration.
• Replace <your_token> or username:password with actual credentials.
• All configuration IDs are UUIDs.