Skip to content
/
Reload all plugins

WebRobot ETL API (1.0.0)

API for managing projects, jobs, datasets, and ETL pipelines on WebRobot.

Authentication

The API uses API Keys for authentication. Include the X-API-Key header in all requests.

Base URL

  • Production: https://api.webrobot.eu/api
  • Development: http://localhost:8020/api

Rate Limiting

Requests are limited to 1000 requests per minute per API key.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
WebRobot Support
support@webrobot.eu
License
Proprietary
Languages
Servers
Mock server
http://docs.webrobot.eu/_mock/openapi/
Production
https://api.webrobot.eu/api/
Local development
http://localhost:8020/api/

Cloud

Operations

Scheduler

Operations

Spark

Operations

Health

Operations

Training

Operations

EAN Plugin

Operations

Jobs

Operations

Bootstrap

Operations

Images

Operations

Info

Operations

Query

Operations

Upload

Operations

AI Providers

Operations

Models

Operations

Datasets

Operations

Agents

Operations

Categories

Operations

Test

Operations

Cloud Credentials

Operations

Tasks

Operations

Admin

Operations

Register a new plugin

Request

Registers a new plugin in the system as an installation.

The plugin can be associated with one or more organizations.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

Plugin installation data

idinteger(int64)

Id

pluginIdstring

Pluginid

pluginTypestring

Plugintype

buildTypestring

Buildtype

buildNumberinteger(int32)

Buildnumber

versionstring

Version

jarPathstring

Jarpath

manifestPathstring

Manifestpath

enabledboolean

Enabled

organizationIdstring

Organizationid

organizationIdsJsonstring

Organizationidsjson

mainClassstring

Mainclass

descriptionstring

Description

installedAtstring(date-time)

Installedat

updatedAtstring(date-time)

Updatedat

enabledAtstring(date-time)

Enabledat

enabledBystring

Enabledby

installedBystring

Installedby

curl -i -X POST \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/admin/plugin-installations \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "id": 0,
    "pluginId": "string",
    "pluginType": "string",
    "buildType": "string",
    "buildNumber": 0,
    "version": "string",
    "jarPath": "string",
    "manifestPath": "string",
    "enabled": true,
    "organizationId": "string",
    "organizationIdsJson": "string",
    "mainClass": "string",
    "description": "string",
    "installedAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "enabledAt": "2019-08-24T14:15:22Z",
    "enabledBy": "string",
    "installedBy": "string"
  }'

Responses

Plugin registered successfully

Bodyapplication/json
idinteger(int64)

Id

pluginIdstring

Pluginid

pluginTypestring

Plugintype

buildTypestring

Buildtype

buildNumberinteger(int32)

Buildnumber

versionstring

Version

jarPathstring

Jarpath

manifestPathstring

Manifestpath

enabledboolean

Enabled

organizationIdstring

Organizationid

organizationIdsJsonstring

Organizationidsjson

mainClassstring

Mainclass

descriptionstring

Description

installedAtstring(date-time)

Installedat

updatedAtstring(date-time)

Updatedat

enabledAtstring(date-time)

Enabledat

enabledBystring

Enabledby

installedBystring

Installedby

Response
application/json
{
  "id": 0,
  "pluginId": "string",
  "pluginType": "string",
  "buildType": "string",
  "buildNumber": 0,
  "version": "string",
  "jarPath": "string",
  "manifestPath": "string",
  "enabled": true,
  "organizationId": "string",
  "organizationIdsJson": "string",
  "mainClass": "string",
  "description": "string",
  "installedAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "enabledAt": "2019-08-24T14:15:22Z",
  "enabledBy": "string",
  "installedBy": "string"
}

Reload all plugins

Request

Reloads all plugins in the system, updating configurations and installations.

Useful after uploading or modifying plugins to apply changes without restarting the system.

Security
ApiKeyAuth
curl -i -X POST \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/admin/plugin-installations/reload \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Plugins reloaded successfully

Bodyapplication/json
messagestring
Example: "Plugins reloaded successfully"
Response
application/json
{
  "message": "Plugins reloaded successfully"
}

Mark zombie tasks as FAILED

Request

Detects and marks as FAILED tasks that are RUNNING for longer than the specified timeout ("zombie" tasks).

A task is considered a "zombie" if:

  • It has status RUNNING
  • It has been running longer than the specified timeout (default: 24 hours)
  • The startedAt timestamp (or scheduledTime as a fallback) exceeds the timeout

When a task is marked as a zombie:

  • Status is updated to FAILED
  • executionLog is updated with FAILED status, completedAt, and an error message
  • Total execution duration is computed

Note: This endpoint requires admin privileges (scope admin).

Security
ApiKeyAuth
Query
timeoutHoursinteger(int64)

Timeout in hours to consider a task a "zombie" (default: 24). RUNNING tasks exceeding this value will be marked as FAILED.

Default 24
Example: timeoutHours=24
curl -i -X POST \
  'http://docs.webrobot.eu/_mock/openapi/webrobot/api/projects/admin/tasks/mark-zombies?timeoutHours=24' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Zombie tasks marked successfully

Bodyapplication/json
markedCountinteger(int64)

Number of tasks marked as FAILED

markedTaskIdsArray of integers(int64)

List of task IDs marked as FAILED

timeoutHoursinteger(int64)

Timeout used (in hours)

messagestring

Confirmation message

Example: "Marked 5 zombie task(s) as FAILED"
Response
application/json
{
  "markedCount": 0,
  "markedTaskIds": [
    0
  ],
  "timeoutHours": 0,
  "message": "Marked 5 zombie task(s) as FAILED"
}

ETL Library

Operations

Package

Operations

Plugins

Operations

Projects

Operations

ETL Execution

Operations

Execution

Operations

Webhooks

Operations

Metrics

Operations

getHtml

Request

Security
ApiKeyAuth
Path
protocolstringrequired

HTTP protocol (http or https)

urlstringrequired

URL to fetch HTML content from

curl -i -X GET \
  'http://docs.webrobot.eu/_mock/openapi/webrobot/api/html/{url}/{protocol}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

default response

Bodytext/html

getById

Request

Security
ApiKeyAuth
Path
tablestringrequired

Table name in Strapi

idstringrequired

Record ID

curl -i -X GET \
  'http://docs.webrobot.eu/_mock/openapi/api/strapi-tables/{table}/{id}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

default response

Bodyapplication/json
Response
application/json
null

update

Request

Security
ApiKeyAuth
Path
tablestringrequired

Table name in Strapi

idstringrequired

Record ID

Bodyapplication/json
property name*objectadditional property
curl -i -X PUT \
  'http://docs.webrobot.eu/_mock/openapi/api/strapi-tables/{table}/{id}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "property1": {},
    "property2": {}
  }'

Responses

default response

Bodyapplication/json
Response
application/json
null

delete

Request

Security
ApiKeyAuth
Path
tablestringrequired

Table name in Strapi

idstringrequired

Record ID

curl -i -X DELETE \
  'http://docs.webrobot.eu/_mock/openapi/api/strapi-tables/{table}/{id}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

default response

Bodyapplication/json
Response
application/json
null

findAll

Request

Security
ApiKeyAuth
Path
tablestringrequired
Query
pageinteger(int32)
Default 0
pageSizeinteger(int32)

Number of records per page

Default 50
curl -i -X GET \
  'http://docs.webrobot.eu/_mock/openapi/api/strapi-tables/{table}?page=0&pageSize=50' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

default response

Bodyapplication/json
Response
application/json
null

insert

Request

Security
ApiKeyAuth
Path
tablestringrequired

Table name in Strapi

Bodyapplication/json
property name*objectadditional property
curl -i -X POST \
  'http://docs.webrobot.eu/_mock/openapi/api/strapi-tables/{table}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "property1": {},
    "property2": {}
  }'

Responses

default response

Bodyapplication/json
Response
application/json
null

getHealth

Request

Security
ApiKeyAuth
curl -i -X GET \
  http://docs.webrobot.eu/_mock/openapi/health \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

default response

Bodyapplication/json
Response
application/json
null

Python Extensions

Operations