Skip to content
/
Stop a task

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

ETL Library

Operations

Package

Operations

Plugins

Operations

Projects

Operations

Start a task

Request

Starts execution of a specific task.

The task must be of type SPARK, AUTONOMOUS_AGENT, or BACKGROUND_TASK.

Security
ApiKeyAuth
Path
projectIdstringrequired

Project ID

Example: 98
jobIdstringrequired

Job ID

Example: 210
taskIdstringrequired

Unique ID of the task to start

Example: 1
curl -i -X POST \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/projects/id/98/jobs/210/tasks/1/start \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Task started successfully

Bodyapplication/json
object
Response
application/json
{}

Stop a task

Request

Stops execution of a task in progress.

Warning: This operation may interrupt a running task, potentially causing data loss or inconsistency.

Security
ApiKeyAuth
Path
projectIdstringrequired

Project ID

Example: 98
jobIdstringrequired

Job ID

Example: 210
taskIdstringrequired

Task ID to stop

Example: 1
curl -i -X POST \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/projects/id/98/jobs/210/tasks/1/stop \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Task stopped successfully

Bodyapplication/json
object
Response
application/json
{}

Get metrics of a task

Request

Returns detailed metrics for a specific task, including duration, processed records, memory usage, CPU usage, and other performance metrics.

Metrics are extracted from the task executionLog and include:

  • Execution duration
  • Processed and output records
  • Memory usage (driver and executors)
  • CPU usage
  • Error and warning counts
  • Output file size
Security
ApiKeyAuth
Path
projectIdstringrequired

Project ID

Example: 98
jobIdstringrequired

Job ID

Example: 220
taskIdstringrequired

Task ID

Example: 229
curl -i -X GET \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/projects/id/98/jobs/220/tasks/229/metrics \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Task metrics

Bodyapplication/json
taskIdinteger(int64)

Task ID

durationSecondsinteger(int64)

Execution duration in seconds

recordsProcessedinteger(int64)

Number of processed records

recordsOutputinteger(int64)

Number of output records

outputFileSizeBytesinteger(int64)

Output file size in bytes

driverMemoryUsedBytesinteger(int64)

Memory used by the driver in bytes

executorMemoryUsedBytesinteger(int64)

Memory used by executors in bytes

executorCountinteger(int32)

Number of executors used

totalCpuTimeSecondsinteger(int64)

Total CPU time used in seconds

errorCountinteger(int32)

Number of errors during execution

warningCountinteger(int32)

Number of warnings during execution

statusstring

Final task status

startedAtstring(date-time)

Execution start timestamp

completedAtstring(date-time)

Execution completion timestamp

Response
application/json
{
  "taskId": 0,
  "durationSeconds": 0,
  "recordsProcessed": 0,
  "recordsOutput": 0,
  "outputFileSizeBytes": 0,
  "driverMemoryUsedBytes": 0,
  "executorMemoryUsedBytes": 0,
  "executorCount": 0,
  "totalCpuTimeSeconds": 0,
  "errorCount": 0,
  "warningCount": 0,
  "status": "string",
  "startedAt": "2019-08-24T14:15:22Z",
  "completedAt": "2019-08-24T14:15:22Z"
}

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