Skip to content

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

Get all ETL library versions

Request

Returns the list of all ETL library versions available in the system, with support for filtering by build type and active status.

Security
ApiKeyAuth
Query
buildTypestring

Filter by build type (e.g. "development", "production")

Example: buildType=development
activeOnlyboolean

Return only active versions

Default false
curl -i -X GET \
  'http://docs.webrobot.eu/_mock/openapi/webrobot/api/admin/etl-library-versions?buildType=development&activeOnly=false' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

List of ETL versions

Bodyapplication/jsonArray [
idinteger(int64)

Id

buildTypestring

Buildtype

buildNumberinteger(int32)

Buildnumber

versionstring

Version

jarPathstring

Jarpath

jarPathObfuscatedstring

Jarpathobfuscated

jarSizeBytesinteger(int64)

Jarsizebytes

uploadedAtstring(date-time)

Uploadedat

activeboolean

Active

descriptionstring

Description

]
Response
application/json
[
  {
    "id": 0,
    "buildType": "string",
    "buildNumber": 0,
    "version": "string",
    "jarPath": "string",
    "jarPathObfuscated": "string",
    "jarSizeBytes": 0,
    "uploadedAt": "2019-08-24T14:15:22Z",
    "active": true,
    "description": "string"
  }
]

Create or update an ETL library version

Request

Creates a new ETL library version or updates an existing one.

ETL versions are used to execute Spark jobs with specific library versions.

Security
ApiKeyAuth
Bodyapplication/jsonrequired

ETL version data

idinteger(int64)

Id

buildTypestring

Buildtype

buildNumberinteger(int32)

Buildnumber

versionstring

Version

jarPathstring

Jarpath

jarPathObfuscatedstring

Jarpathobfuscated

jarSizeBytesinteger(int64)

Jarsizebytes

uploadedAtstring(date-time)

Uploadedat

activeboolean

Active

descriptionstring

Description

curl -i -X POST \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/admin/etl-library-versions \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "id": 0,
    "buildType": "string",
    "buildNumber": 0,
    "version": "string",
    "jarPath": "string",
    "jarPathObfuscated": "string",
    "jarSizeBytes": 0,
    "uploadedAt": "2019-08-24T14:15:22Z",
    "active": true,
    "description": "string"
  }'

Responses

Version created or updated successfully

Bodyapplication/json
idinteger(int64)

Id

buildTypestring

Buildtype

buildNumberinteger(int32)

Buildnumber

versionstring

Version

jarPathstring

Jarpath

jarPathObfuscatedstring

Jarpathobfuscated

jarSizeBytesinteger(int64)

Jarsizebytes

uploadedAtstring(date-time)

Uploadedat

activeboolean

Active

descriptionstring

Description

Response
application/json
{
  "id": 0,
  "buildType": "string",
  "buildNumber": 0,
  "version": "string",
  "jarPath": "string",
  "jarPathObfuscated": "string",
  "jarSizeBytes": 0,
  "uploadedAt": "2019-08-24T14:15:22Z",
  "active": true,
  "description": "string"
}

Get a specific ETL version

Request

Returns the details of a version of the library ETL identified by the ID.

Security
ApiKeyAuth
Path
idinteger(int64)required

Unique ID of the version

Example: 1
curl -i -X GET \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/admin/etl-library-versions/id/1 \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

ETL version details

Bodyapplication/json
idinteger(int64)

Id

buildTypestring

Buildtype

buildNumberinteger(int32)

Buildnumber

versionstring

Version

jarPathstring

Jarpath

jarPathObfuscatedstring

Jarpathobfuscated

jarSizeBytesinteger(int64)

Jarsizebytes

uploadedAtstring(date-time)

Uploadedat

activeboolean

Active

descriptionstring

Description

Response
application/json
{
  "id": 0,
  "buildType": "string",
  "buildNumber": 0,
  "version": "string",
  "jarPath": "string",
  "jarPathObfuscated": "string",
  "jarSizeBytes": 0,
  "uploadedAt": "2019-08-24T14:15:22Z",
  "active": true,
  "description": "string"
}

Update an ETL version

Request

Updates the data of an existing ETL library version.

Security
ApiKeyAuth
Path
idinteger(int64)required

Unique ID of the version to update

Example: 1
Bodyapplication/jsonrequired

Updated version data

idinteger(int64)

Id

buildTypestring

Buildtype

buildNumberinteger(int32)

Buildnumber

versionstring

Version

jarPathstring

Jarpath

jarPathObfuscatedstring

Jarpathobfuscated

jarSizeBytesinteger(int64)

Jarsizebytes

uploadedAtstring(date-time)

Uploadedat

activeboolean

Active

descriptionstring

Description

curl -i -X PUT \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/admin/etl-library-versions/id/1 \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "id": 0,
    "buildType": "string",
    "buildNumber": 0,
    "version": "string",
    "jarPath": "string",
    "jarPathObfuscated": "string",
    "jarSizeBytes": 0,
    "uploadedAt": "2019-08-24T14:15:22Z",
    "active": true,
    "description": "string"
  }'

Responses

Version updated successfully

Bodyapplication/json
idinteger(int64)

Id

buildTypestring

Buildtype

buildNumberinteger(int32)

Buildnumber

versionstring

Version

jarPathstring

Jarpath

jarPathObfuscatedstring

Jarpathobfuscated

jarSizeBytesinteger(int64)

Jarsizebytes

uploadedAtstring(date-time)

Uploadedat

activeboolean

Active

descriptionstring

Description

Response
application/json
{
  "id": 0,
  "buildType": "string",
  "buildNumber": 0,
  "version": "string",
  "jarPath": "string",
  "jarPathObfuscated": "string",
  "jarSizeBytes": 0,
  "uploadedAt": "2019-08-24T14:15:22Z",
  "active": true,
  "description": "string"
}

Delete an ETL version

Request

Deletes an ETL library version from the system.

Warning: This operation is irreversible. Jobs using this version may not work correctly.

Security
ApiKeyAuth
Path
idinteger(int64)required

Unique ID of the version to delete

Example: 1
curl -i -X DELETE \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/admin/etl-library-versions/id/1 \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Version deleted successfully

Bodyapplication/json
object
Response
application/json
{}

Get an ETL version by build type and build number

Request

Returns the details of a version of the library ETL identified by build type and build number.

Security
ApiKeyAuth
Path
buildTypestringrequired

Build type (e.g. "development", "production")

Example: development
buildNumberinteger(int32)required

Build number

Example: 123
curl -i -X GET \
  http://docs.webrobot.eu/_mock/openapi/webrobot/api/admin/etl-library-versions/build-type/development/build-number/123 \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

ETL version details

Bodyapplication/json
idinteger(int64)

Id

buildTypestring

Buildtype

buildNumberinteger(int32)

Buildnumber

versionstring

Version

jarPathstring

Jarpath

jarPathObfuscatedstring

Jarpathobfuscated

jarSizeBytesinteger(int64)

Jarsizebytes

uploadedAtstring(date-time)

Uploadedat

activeboolean

Active

descriptionstring

Description

Response
application/json
{
  "id": 0,
  "buildType": "string",
  "buildNumber": 0,
  "version": "string",
  "jarPath": "string",
  "jarPathObfuscated": "string",
  "jarSizeBytes": 0,
  "uploadedAt": "2019-08-24T14:15:22Z",
  "active": true,
  "description": "string"
}

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