Alumio API (01KV85PMY51VEBF4KS85VPQ0HP)

Download OpenAPI specification:Download

Access Alumio through OpenAPI v3.1.

AI

Generate JavaScript code

Generates JavaScript code for the JavaScript Code Transformer based on the supplied prompt. Returns the generated code, or an error message describing why it could not be generated.

Request Body schema: application/json
prompt
required
string <= 3000 characters

Responses

Request samples

Content type
application/json
{
  • "prompt": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "errorMessage": "string"
}

Generate transformer tester data

Generates example JSON input data for the transformer tester based on the supplied prompt. Returns the generated JSON, or an error message describing why it could not be generated.

Request Body schema: application/json
prompt
required
string <= 500 characters

Responses

Request samples

Content type
application/json
{
  • "prompt": "string"
}

Response samples

Content type
application/json
{
  • "json_result": "string",
  • "errorMessage": "string"
}

Generate a CRON expression

Generates a CRON expression from a natural-language prompt. Returns the generated expression along with a flag indicating whether it is valid and an error message explaining why generation failed when it is not.

Request Body schema: application/json
prompt
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "prompt": "string"
}

Response samples

Content type
application/json
{
  • "expression": "string",
  • "isValidExpression": true,
  • "errorMessage": "string"
}

Application

Get application capabilities

Retrieves the application's capability flags as an object mapping each capability name to a boolean indicating whether it is enabled.

Responses

Response samples

Content type
application/json
{
  • "capabilities": {
    }
}

AuditTrail

Get current space audit trail item

Retrieves a single audit trail item from the current space, identified by the entry identifier supplied in the path. Returns the matching audit trail item, or an error response if it cannot be found.

path Parameters
identifier
required
string

Entry identifier

Responses

Response samples

Content type
application/json
{
  • "identifier": "string",
  • "user": "user@example.com",
  • "spaceIdentifier": "string",
  • "action": "string",
  • "category": "string",
  • "ipAddress": "string",
  • "message": "string",
  • "request": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

Get current space audit trail list

Retrieves the list of audit trail entries recorded for the current space, returning the matching items together with pagination metadata. Accepts an optional filter query parameter to narrow the results by search criteria.

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

Export current space audit trail

Exports the audit trail entries for the current space. Accepts an optional filter in the form-encoded request body to narrow down which entries are included in the export.

Request Body schema: application/x-www-form-urlencoded
filter
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "context": { },
  • "type": "string",
  • "title": "string",
  • "detail": "string",
  • "violations": [
    ]
}

Spaces

Export audit trail

Exports the audit trail entries as a downloadable file, optionally narrowing the result set with the form-encoded filter parameter.

Request Body schema: application/x-www-form-urlencoded
filter
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "context": { },
  • "type": "string",
  • "title": "string",
  • "detail": "string",
  • "violations": [
    ]
}

Get audit trail item

Retrieves a single audit trail item identified by the path identifier. Returns the audit trail item details, or an error response if the identifier cannot be resolved.

path Parameters
identifier
required
string

Entry identifier

Responses

Response samples

Content type
application/json
{
  • "identifier": "string",
  • "user": "user@example.com",
  • "spaceIdentifier": "string",
  • "action": "string",
  • "category": "string",
  • "ipAddress": "string",
  • "message": "string",
  • "request": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

Get audit trail list

Retrieves the list of audit trail entries, returning the matching items along with result metadata. Accepts an optional filter query parameter to narrow the results by search criteria.

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

Retry syncing space to external system

Retries syncing the space identified by the path identifier, which must be in the initialized state, to the external system. Returns a message response confirming the retry.

path Parameters
identifier
required
string

Space identifier

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Create a space

Creates a space from the supplied identifier, name, purpose, and terms agreement, along with its initial users and data engine allocations. Returns the created space.

Request Body schema: application/json
required
object
required
Array of objects (User)
required
Array of objects (SpaceWorkerAllocation)

Responses

Request samples

Content type
application/json
{
  • "object": {
    },
  • "users": [
    ],
  • "dataEngines": [
    ]
}

Response samples

Content type
application/json
{
  • "object": {
    }
}

Update a space

Creates or updates a space from the supplied name, identifier, purpose, and optional description, and returns the resulting space object.

Request Body schema: application/json
identifier
required
string (Identifier) <= 255 characters ^[a-z0-9-]+$

Identifier

name
required
string (Name) <= 255 characters

Name of the space

description
string (Description) <= 64000 characters
Default: ""

Description of the space.

purpose
required
string (SpacePurpose)
Enum: "prod" "uat" "test" "dev"

Responses

Request samples

Content type
application/json
{
  • "identifier": "string",
  • "name": "string",
  • "description": "",
  • "purpose": "prod"
}

Response samples

Content type
application/json
{
  • "object": {
    }
}

Get a single space

Retrieves a single space identified by the path identifier, returning its full details.

path Parameters
identifier
required
string

Space identifier

Responses

Response samples

Content type
application/json
{
  • "object": {
    }
}

Cancel a space

Cancels the space identified by the path identifier so that it will be deleted on its expiration date, and returns a confirmation message.

path Parameters
identifier
required
string

Space identifier

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Reactivate a space

Reactivates a previously canceled space identified by the path identifier and returns a confirmation message.

path Parameters
identifier
required
string

Space identifier

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Get all statistics for a specific period

Retrieves task log totals per space, broken down by status (new, processing, finished, failed, and skipped). Accepts optional dateFrom and dateTo query parameters to restrict the statistics to a specific period.

query Parameters
dateFrom
string <date>

Date from

dateTo
string <date>

Date to

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get usage info

Retrieves notifier usage information across spaces.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get assigned space workers

Retrieves the current worker allocation per space, including the total number of available workers and the number of workers available per space.

Responses

Response samples

Content type
application/json
{
  • "workers": 0,
  • "workersPerSpace": 0,
  • "spaceWorkers": [
    ]
}

Allocate workers to a space

Allocates a number of workers to each space from the list in the request body and returns the updated worker allocation.

Request Body schema: application/json
Array of objects (SpaceWorkerAllocation)

Responses

Request samples

Content type
application/json
{
  • "spaceWorkers": [
    ]
}

Response samples

Content type
application/json
{
  • "workers": 0,
  • "workersPerSpace": 0,
  • "spaceWorkers": [
    ]
}

Get assigned space workers

Retrieves the list of workers assigned to each space, identified by their worker identifiers, along with the total number of available workers and the number of workers available per space.

Responses

Response samples

Content type
application/json
{
  • "workers": 0,
  • "workersPerSpace": 0,
  • "spaceWorkers": [
    ]
}

Assign workers to spaces

Assigns specific workers to spaces based on the worker identifiers supplied per space in the request body, and returns the updated worker assignments.

Request Body schema: application/json
Array of objects (SpaceWorker)

Responses

Request samples

Content type
application/json
{
  • "spaceWorkers": [
    ]
}

Response samples

Content type
application/json
{
  • "workers": 0,
  • "workersPerSpace": 0,
  • "spaceWorkers": [
    ]
}

Assign users to a space in bulk

Assigns a list of users to the space identified by the space path parameter in a single bulk operation, using the users array provided in the request body. Returns the resulting set of spaces on success.

path Parameters
space
required
string

Space identifier

Request Body schema: application/json
required
Array of objects (User)

Responses

Request samples

Content type
application/json
{
  • "users": [
    ]
}

Response samples

Content type
application/json
{ }

Get space users

Retrieves the list of users that have access to the given space, returned together with action metadata. Supports an optional filter query parameter to apply search criteria.

path Parameters
space
required
string

Space identifier.

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

Create a space user

Adds a user to the given space, assigning the email address and one or more roles supplied in the request body. Returns the created space user on success.

path Parameters
space
required
string

Space identifier.

Request Body schema: application/json
email
required
string <email> (Email address)
roles
required
Array of strings (Roles) non-empty unique
Items Enum: "ROLE_EDITOR" "ROLE_USER" "ROLE_ADMINISTRATOR"

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "object": {
    }
}

Get a single space user

Retrieves a single user of the given space, identified by their email address. Returns the user's email, space, and assigned roles.

path Parameters
space
required
string

Space identifier

email
required
string

User identifier

Responses

Response samples

Content type
application/json
{
  • "object": {
    }
}

Update a space user

Updates the user identified by the email address within the given space, replacing their email and roles with the values from the request body. Returns the updated space user.

path Parameters
space
required
string

Space identifier

email
required
string

User identifier

Request Body schema: application/json
email
required
string <email> (Email address)
roles
required
Array of strings (Roles) non-empty unique
Items Enum: "ROLE_EDITOR" "ROLE_USER" "ROLE_ADMINISTRATOR"

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "object": {
    }
}

Delete a space user

Removes the user identified by the email address from the given space, revoking their access. Returns a confirmation message.

path Parameters
space
required
string

Space identifier

email
required
string

User identifier

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Users

Get current logged-in user

Retrieves the profile of the currently authenticated user based on the request's credentials. Returns the user details as a UserResponse.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "object": {
    }
}

Get users of the current space

Retrieves the list of users belonging to the current space, each with their email address and assigned roles. Accepts an optional filter query parameter to apply search criteria.

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

Create a user in the current space

Creates a new user in the current space from the supplied email address and one or more roles. Returns the created user.

Request Body schema: application/json
email
required
string <email> (Email address)
roles
required
Array of strings (Roles) non-empty unique
Items Enum: "ROLE_EDITOR" "ROLE_USER" "ROLE_ADMINISTRATOR"

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "object": {
    }
}

Get a single user from the current space

Retrieves a single user from the current space identified by the email path parameter. Returns the user's email address and assigned roles.

path Parameters
email
required
string

User identifier

Responses

Response samples

Content type
application/json
{
  • "object": {
    }
}

Update a user in the current space

Updates the user in the current space identified by the email path parameter, replacing their assigned roles with those in the request body. Returns the updated user.

path Parameters
email
required
string

User identifier

Request Body schema: application/json
email
required
string <email> (Email address)
roles
required
Array of strings (Roles) non-empty unique
Items Enum: "ROLE_EDITOR" "ROLE_USER" "ROLE_ADMINISTRATOR"

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "object": {
    }
}

Delete a user from the current space

Removes the user identified by the email path parameter from the current space. Returns a confirmation message.

path Parameters
email
required
string

User identifier

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Update user preferences in the current space

Updates the preferences of the current user in the current space using the preference values supplied in the request body. Returns the updated user.

Request Body schema: application/json
object (CurrentSpaceUserPreferences)

Responses

Request samples

Content type
application/json
{
  • "updatedPreferences": { }
}

Response samples

Content type
application/json
{
  • "object": {
    }
}

Get the table filters

Retrieves the list of saved table filters for the current user. Accepts an optional filter query parameter to narrow the results by search criteria.

query Parameters
filter
string

Apply search criteria

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

Create a new table filter for the user

Creates a new table filter for the current user from the supplied table key, name, and filter criteria. Returns the stored filter, including its generated identifier.

Request Body schema: application/json
tableKey
required
string <= 255 characters
name
required
string <= 255 characters
required
object

Responses

Request samples

Content type
application/json
{
  • "tableKey": "string",
  • "name": "string",
  • "filter": { }
}

Response samples

Content type
application/json
{
  • "object": {
    }
}

Update a table filter by identifier

Updates the table filter matching the given identifier with the supplied table key, name, and filter criteria. Returns the updated filter.

path Parameters
identifier
required
string

Table filter identifier

Request Body schema: application/json
tableKey
required
string <= 255 characters
name
required
string <= 255 characters
required
object

Responses

Request samples

Content type
application/json
{
  • "tableKey": "string",
  • "name": "string",
  • "filter": { }
}

Response samples

Content type
application/json
{
  • "object": {
    }
}

Delete a table filter by identifier

Deletes the table filter matching the given identifier. Returns a confirmation message once the filter has been removed.

path Parameters
identifier
required
string

Table filter identifier

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Save updated user preferences

Updates the authenticated user's preferences by merging the supplied updatedPreferences object into the stored settings. Returns the updated user, including the new preferences.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "updatedPreferences": { }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "object": {
    }
}

Accept user agreement

Records the authenticated user's acceptance of the terms and conditions. Returns a confirmation message together with the updated user object.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "object": {
    }
}

Di

List configuration usages

Retrieves the usages of the dependency injection configuration identified by the given type and identifier path parameters. Returns a list of usages, each describing the property path, type, and specification where the configuration is referenced.

path Parameters
type
required
string

Di type name

identifier
required
string

Di configuration identifier

Responses

Response samples

Content type
application/json
{
  • "usages": [
    ]
}

List configuration relations for multiple configurations

Resolves dependency relations for multiple configurations supplied as a list of type and identifier pairs in the request body, returning each resolved node with its relationships. Use the optional "direction" query parameter to control how relations are traversed (down, up, both, or recursive).

query Parameters
direction
string
Default: "both"
Enum: "down" "up" "both" "recursive"

Direction to resolve relations

Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "objects": [
    ]
}

Response samples

Content type
application/json
{
  • "nodes": [
    ]
}

List configuration relations

Resolves the dependency relations for a single configuration identified by its type and identifier path parameters, returning the resolved nodes with their relationships. Use the optional "direction" query parameter to control how relations are traversed (down, up, both, or recursive).

path Parameters
type
required
string

Di type name

identifier
required
string

Di configuration identifier

query Parameters
direction
string
Default: "both"
Enum: "down" "up" "both" "recursive"

Direction to resolve relations

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ]
}

List dependants

Retrieves the configuration dependants, returning each dependant with its type, identifier, and the usages that reference it. Accepts an optional filter query parameter to narrow the results by search criteria.

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

Content type
application/json
{
  • "dependants": [
    ]
}

Test prototypes

Runs tests against dependency injection prototypes matching the given type and identifier patterns, limited to a configurable number of tests per prototype. Returns the succeeded and failed tests with totals, responding with status 500 when any test fails.

query Parameters
type
string
Default: "*"

Type pattern

identifier
string
Default: "*"

Identifier pattern

show-succeeded
boolean
Default: false

Show succeeded tests

max-tests
number
Default: 3

How many tests to run per prototype. Use -1 to run all tests.

Responses

Response samples

Content type
application/json
{
  • "succeeded": [
    ],
  • "failed": [
    ],
  • "totalSucceeded": 0,
  • "totalFailed": 0
}

Toggle favorite status

Toggles the favourite status of a configuration identified by its type and identifier, marking it as a favourite if it is not already one and removing the favourite otherwise. Returns the resulting favourite item reflecting the new status.

Request Body schema: application/json
type
string (Type)

Type

identifier
string (Identifier) <= 255 characters ^[a-z0-9-]+$

Identifier

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "identifier": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "identifier": "string",
  • "type": "string",
  • "space": "string",
  • "user": "user@example.com",
  • "tag": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Restore a configuration to a previous state

Restores the configuration identified by the given type and identifier to a previous historical state, selected by the ulid supplied in the request body. Returns the restored configuration object.

path Parameters
type
required
string

Type identifier

identifier
required
string

Configuration identifier

Request Body schema: application/json
ulid
required
string <ulid>

Responses

Request samples

Content type
application/json
{
  • "ulid": "string"
}

Response samples

Content type
application/json
{
  • "object": {
    }
}

Get the history of an object

Retrieves the list of historical states recorded for the configuration identified by the given type and identifier. Accepts an optional filter query parameter to narrow the returned history entries by search criteria.

path Parameters
type
required
string

Type identifier

identifier
required
string

Configuration identifier

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

Bulk export object configurations

Exports a selected set of object configurations identified by their type and identifier in the request body, optionally scoped with a client time. Returns the exported configurations for the requested objects.

Request Body schema: application/json
Array of objects
clientTime
string^\d+$

Responses

Request samples

Content type
application/json
{
  • "objects": [
    ],
  • "clientTime": "string"
}

Export object configurations by type

Exports the configurations of the object type given in the path, optionally filtered to the identifiers supplied in the request body. Returns the exported configurations for the matching objects.

path Parameters
type
required
string

Object Type

Request Body schema: x-www-form-urlencoded
identifiers
Array of strings
clientTime
string^\d+$

Responses

Import object configurations

Imports object configurations supplied as JSON, NDJSON, or uploaded files, and returns a result detailing per-object decisions, actions, relationships, and any validation violations. Set the dry-run query parameter to only validate and check for existing configurations without persisting, or validate-variables to additionally validate variables.

query Parameters
validate-variables
boolean
Default: false

Enable validation of variables.

dry-run
boolean
Default: false

Only validate and check whether configurations already exist.

Request Body schema:
Array
required
Class name (string) or Identifier (string) (type)
identifier
required
string (identifier) >= 2 characters ^[a-z0-9]+[a-z0-9\-]*[a-z0-9]+$
name
required
string
description
string
required
object or object (inline.configuration)

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "valid": true,
  • "title": "string",
  • "detail": "string",
  • "results": [
    ]
}

Get a list of labels

Retrieves all labels defined in the system. Returns a list of labels along with action metadata.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

Set labels of a configuration

Replaces the labels assigned to the configuration identified by the given type and identifier with the labels provided in the request body. Returns the updated list of labels along with action metadata.

path Parameters
type
required
string

Type identifier

identifier
required
string

Configuration identifier

Request Body schema: application/json
labels
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "labels": [
    ]
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

Get object relations

Retrieves the list of object relations for the given type and owner. Accepts an optional filter query parameter to apply search criteria, and returns the matching relations along with metadata.

path Parameters
type
required
string

Type identifier

owner
required
string

Owner identifier

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

Create an object relation

Creates a new object relation for the given type and owner from the relation supplied in the request body. Returns the created relation.

path Parameters
type
required
string

Type identifier

owner
required
string

Owner identifier

Request Body schema: application/json
type
string (Type)
identifier
string (Identifier) <= 255 characters ^[a-z0-9-]+$
name
string (Name) <= 255 characters
description
string (Description) <= 64000 characters
object
object (Prototype)
removable
boolean
Default: false

Whether the relation can be removed through the API

resettable
boolean
Default: false

Whether the relation can be reset through the API

disabled
boolean (Disabled)
Default: false

Whether the configuration is disabled

editor
string (Last edited by)

The email of the person who last edited this

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "identifier": "string",
  • "name": "string",
  • "description": "string",
  • "object": { },
  • "removable": false,
  • "resettable": false,
  • "disabled": false,
  • "editor": "string"
}

Response samples

Content type
application/json
{
  • "object": {
    }
}

Get an object relation

Retrieves a single object relation identified by its type, owner, and identifier. Returns the matching relation.

path Parameters
type
required
string

Type identifier

owner
required
string

Owner identifier

identifier
required
string

Relation identifier

Responses

Response samples

Content type
application/json
{
  • "object": {
    }
}

Update an object relation

Updates the object relation identified by its type, owner, and identifier with the data supplied in the request body. Returns the updated relation.

path Parameters
type
required
string

Type identifier

owner
required
string

Owner identifier

identifier
required
string

Relation identifier

Request Body schema: application/json
type
string (Type)
identifier
string (Identifier) <= 255 characters ^[a-z0-9-]+$
name
string (Name) <= 255 characters
description
string (Description) <= 64000 characters
object
object (Prototype)
removable
boolean
Default: false

Whether the relation can be removed through the API

resettable
boolean
Default: false

Whether the relation can be reset through the API

disabled
boolean (Disabled)
Default: false

Whether the configuration is disabled

editor
string (Last edited by)

The email of the person who last edited this

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "identifier": "string",
  • "name": "string",
  • "description": "string",
  • "object": { },
  • "removable": false,
  • "resettable": false,
  • "disabled": false,
  • "editor": "string"
}

Response samples

Content type
application/json
{
  • "object": {
    }
}

Delete an object relation

Deletes the object relation identified by its type, owner, and identifier. Returns a confirmation message on success.

path Parameters
type
required
string

Type identifier

owner
required
string

Owner identifier

identifier
required
string

Relation identifier

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Validate configured object configurations

Validates the configured object configurations and returns a DiValidationResult listing any validation violations found. Use the optional type query parameter to restrict validation to a single type identifier.

query Parameters
type
string

Type identifier

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Validate registered object configurations

Validates the registered object configurations and returns a DiValidationResult; responds with status 400 when invalid configurations are found. Use the optional type query parameter to restrict validation to a single type identifier.

query Parameters
type
string

Type identifier

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get stored object configurations

Retrieves the list of object configurations that are persisted in storage, optionally narrowed down with the filter query parameter. Returns the matching configurations together with pagination metadata.

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

Get object configurations

Retrieves the list of available object configurations, optionally narrowed down with the filter query parameter. Returns the matching configurations together with pagination metadata.

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

Create an object configuration

Creates a new object configuration from the type, name, and object payload in the request body. Returns the created configuration on success.

Request Body schema: application/json
type
required
string (Type)

Type

identifier
string (Identifier) <= 255 characters ^[a-z0-9-]+$

Identifier

name
required
string (Name) <= 255 characters

Name

description
string (Description) <= 64000 characters
Default: ""

Description

object
required
object
context
object
owner
string (Owner)

The identifier of the owner of the configuration.

removable
boolean
Default: false

Whether the configuration can be removed through the API

resettable
boolean
Default: false

Whether the configuration can be reset through the API

disabled
boolean (Status)
Default: false

Whether the configuration is disabled

createdAt
string <date-time> (Created at)

Creation date

updatedAt
string <date-time> (Updated at)

Update date

editor
string (Last edited by)

The email of the last person who edited the configuration

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "identifier": "string",
  • "name": "string",
  • "description": "",
  • "object": { },
  • "context": { },
  • "owner": "string",
  • "removable": false,
  • "resettable": false,
  • "disabled": false,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "editor": "string"
}

Response samples

Content type
application/json
{
  • "object": {
    }
}

Update an object configuration

Replaces an existing object configuration, identified by the type and identifier in the request body, with the supplied values. Returns the updated configuration.

Request Body schema: application/json
type
required
string (Type)

Type

identifier
required
string (Identifier) <= 255 characters ^[a-z0-9-]+$

Identifier

name
required
string (Name) <= 255 characters

Name

description
string (Description) <= 64000 characters
Default: ""

Description

object
required
object
context
object
owner
string (Owner)

The identifier of the owner of the configuration.

removable
boolean
Default: false

Whether the configuration can be removed through the API

resettable
boolean
Default: false

Whether the configuration can be reset through the API

disabled
boolean (Status)
Default: false

Whether the configuration is disabled

createdAt
string <date-time> (Created at)

Creation date

updatedAt
string <date-time> (Updated at)

Update date

editor
string (Last edited by)

The email of the last person who edited the configuration

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "identifier": "string",
  • "name": "string",
  • "description": "",
  • "object": { },
  • "context": { },
  • "owner": "string",
  • "removable": false,
  • "resettable": false,
  • "disabled": false,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "editor": "string"
}

Response samples

Content type
application/json
{
  • "object": {
    }
}

Patch an object configuration

Partially updates an existing object configuration, identified by the type and identifier in the request body, applying only the supplied fields. Returns the updated configuration.

Request Body schema: application/json
type
required
string (Type)

Type

identifier
required
string (Identifier) <= 255 characters ^[a-z0-9-]+$

Identifier

name
string (Name) <= 255 characters

Name

description
string (Description) <= 64000 characters
Default: ""

Description

object
object
context
object
owner
string (Owner)

The identifier of the owner of the configuration.

removable
boolean
Default: false

Whether the configuration can be removed through the API

resettable
boolean
Default: false

Whether the configuration can be reset through the API

disabled
boolean (Status)
Default: false

Whether the configuration is disabled

createdAt
string <date-time> (Created at)

Creation date

updatedAt
string <date-time> (Updated at)

Update date

editor
string (Last edited by)

The email of the last person who edited the configuration

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "identifier": "string",
  • "name": "string",
  • "description": "",
  • "object": { },
  • "context": { },
  • "owner": "string",
  • "removable": false,
  • "resettable": false,
  • "disabled": false,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "editor": "string"
}

Response samples

Content type
application/json
{
  • "object": {
    }
}

Get an object configuration

Retrieves a single object configuration identified by the type and identifier path parameters. Returns the matching configuration.

path Parameters
type
required
string

Type identifier

identifier
required
string

Configuration identifier

Responses

Response samples

Content type
application/json
{
  • "object": {
    }
}

Delete an object configuration

Deletes the object configuration identified by the type and identifier path parameters. Returns a message confirming the deletion.

path Parameters
type
required
string

Type identifier

identifier
required
string

Configuration identifier

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Update an object configuration status

Updates the enabled or disabled status of the object configuration identified by the type and identifier path parameters, using the disabled flag in the request body. Returns the updated configuration.

path Parameters
type
required
string

Type identifier

identifier
required
string

Configuration identifier

Request Body schema: application/json
disabled
required
boolean (Status)

Whether the configuration is disabled

Responses

Request samples

Content type
application/json
{
  • "disabled": true
}

Response samples

Content type
application/json
{
  • "object": {
    }
}

Bulk delete object configurations

Deletes all object configurations of the given type that match the filter in the request body. Returns the number of configurations that were deleted.

path Parameters
type
required
string

Type identifier

Request Body schema: application/json
filter
string

Responses

Request samples

Content type
application/json
{
  • "filter": "string"
}

Response samples

Content type
application/json
{
  • "deleted": 0
}

Test a non-stored object configuration

Tests an object configuration of the given type without persisting it, using the specification and test data supplied in the request body. Returns the test result for the evaluated object.

path Parameters
type
required
string

Type identifier

Request Body schema: application/json
any

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "type": "string",
  • "specification": "string",
  • "object": "string",
  • "tester": "string",
  • "response": { }
}

Test an object configuration

Tests the stored object configuration identified by the type and identifier path parameters and returns the test result for the evaluated object.

path Parameters
type
required
string

Type identifier

identifier
required
string

Configuration identifier

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "specification": "string",
  • "object": "string",
  • "tester": "string",
  • "response": { }
}

List object configurations and prototypes

Retrieves both the configured objects and the available prototypes for the given dependency injection type. Accepts an optional filter query parameter to narrow the results by search criteria.

path Parameters
type
required
string

Di type name

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "configurations": [
    ],
  • "prototypes": [
    ],
  • "defaultPrototype": {
    }
}

List object configurations

Retrieves the configured objects for the given dependency injection type. Accepts an optional filter query parameter to narrow the results by search criteria.

path Parameters
type
required
string

Di type name

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "configurations": [
    ],
  • "prototypes": [
    ],
  • "defaultPrototype": {
    }
}

List object prototypes

Retrieves the available object prototypes for the given dependency injection type. Accepts an optional filter query parameter to narrow the results by search criteria.

path Parameters
type
required
string

Di type name

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "configurations": [
    ],
  • "prototypes": [
    ],
  • "defaultPrototype": {
    }
}

List platforms

Retrieves a list of available data integration platforms, each including its identifier, name, categories, vendor, logo, editions, extensions, and APIs. Accepts an optional filter query parameter to narrow results by search criteria.

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

DiExport

Bulk export all object configurations

Exports every object configuration in the environment as a single bulk export. Returns the exported configurations for all object types without requiring a selection.

Responses

Documentation

Get prototype documentation

Retrieves the documentation for the prototype identified by the given type and identifier path parameters. Returns a ProtoTypeDocumentationResult describing the prototype's configuration options.

path Parameters
type
required
string

Type identifier

identifier
required
string

Prototype identifier

Responses

Response samples

Content type
application/json
{
  • "documentation": "string"
}

Get default prototype documentation

Retrieves the documentation for the default prototype of the given type path parameter. Returns a ProtoTypeDocumentationResult describing that prototype's configuration options.

path Parameters
type
required
string

Type identifier

Responses

Response samples

Content type
application/json
{
  • "documentation": "string"
}

Log

Search logs

Searches log entries in Elasticsearch using the supplied query and returns the matching documents. The target index is selected with the optional index query parameter, which defaults to filebeat-*.

query Parameters
index
string
Default: "filebeat-*"

Index to use

Request Body schema: application/json
prototype
string
parameters
object

Responses

Request samples

Content type
application/json
{
  • "prototype": "string",
  • "parameters": { }
}

Response samples

Content type
application/json
{ }

Count logs

Counts the log entries in Elasticsearch that match the supplied query and returns the total number of hits. The target index is selected with the optional index query parameter, which defaults to filebeat-*.

query Parameters
index
string
Default: "filebeat-*"

Index to use

Request Body schema: application/json
prototype
string
parameters
object

Responses

Request samples

Content type
application/json
{
  • "prototype": "string",
  • "parameters": { }
}

Response samples

Content type
application/json
{ }

Export Elasticsearch by ID (deprecated)

Exports the Elasticsearch log entry identified by the given message id from the specified index, defaulting to the filebeat-* index pattern. Deprecated in favour of the endpoint that resolves the index automatically.

path Parameters
index
required
string
Default: "filebeat-*"

Index to use

id
required
string

Message Id

Responses

Export Elasticsearch by ID

Exports the Elasticsearch log entry identified by the given message id. Returns the matching log data for that message.

path Parameters
id
required
string

Message Id

Responses

Elasticsearch

Update Elasticsearch index template

Applies the configured Elasticsearch index template, returning the affected templates along with the action taken and the raw Elasticsearch response. Set the dry-run query parameter to only report the differences without making any changes.

query Parameters
dry-run
boolean
Default: false

Only check for differences

Responses

Response samples

Content type
application/json
{
  • "templates": [
    ]
}

Environment

List environment variables

Retrieves the collection of environment variables. Accepts an optional filter query parameter to apply search criteria.

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

Create environment variable

Creates a new environment variable from the supplied name and value, optionally marked as encrypted, and returns the created variable.

Request Body schema: application/json
name
required
string (EnvironmentVariableName) ^[a-zA-Z0-9_-]+$
description
string (Description) <= 150 characters
value
required
string
encrypted
boolean (Encrypted)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "value": "string",
  • "encrypted": true
}

Response samples

Content type
application/json
{
  • "object": {
    }
}

Get environment variable

Retrieves a single environment variable identified by its name in the path.

path Parameters
name
required
string

Environment variable name

Responses

Response samples

Content type
application/json
{
  • "object": {
    }
}

Update environment variable

Updates the environment variable identified by its name, modifying its description, value, or encrypted flag, and returns the updated variable. For encrypted variables the value may be left blank to retain the current value.

path Parameters
name
required
string

Environment variable name

Request Body schema: application/json
description
string (Description) <= 150 characters
encrypted
boolean (Encrypted)
value
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "encrypted": true,
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "object": {
    }
}

Delete environment variable

Deletes the environment variable identified by its name in the path and returns a confirmation message.

path Parameters
name
required
string

Environment variable name

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

List candidate environment variables

Retrieves candidate environment variables detected across the system, each returned with the locations where it is referenced as a list of matches describing the match type, metadata, and payload. Use this to discover values that could be promoted to environment variables.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

Get variable usage

Retrieves the configurations that reference the specified environment variable. Returns a list of usage entries, each identifying the configuration by its type, identifier, and name.

path Parameters
variable
required
string

Environment variable

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

Search

General search

Searches across configurations, tasks, and variables using the optional query string with predefined properties and search operators, and the optional filter expression. Returns each type as a separate group containing its matching results and metadata.

query Parameters
filter
string
Default: "{}"

Apply filter to the results, result will be empty on non existing order or where column.

query
string
Default: ""

Search in multiple types with predefined properties and search operators.

Responses

Response samples

Content type
application/json
{
  • "configurations": {
    },
  • "tasks": {
    },
  • "variables": {
    }
}

Info

Retrieve application information

Retrieves general server information about the application, including the server IP address, the OAuth2 redirect URL, and the API base URL.

Responses

Response samples

Content type
application/json
{
  • "ipAddress": "string",
  • "oauth2RedirectUrl": "string",
  • "apiUrl": "string"
}

Retrieve support information

Retrieves support-related information, including the support portal URL and the login help URL.

Responses

Response samples

Content type
application/json
{
  • "supportUrl": "string",
  • "loginHelpUrl": "string"
}

Get subscription details

Retrieves details about the current Alumio subscription, including the environment and subscription identifiers, edition, version, queue status, related URLs, support contact details, and the list of associated environments.

Responses

Response samples

Content type
application/json
{
  • "environmentId": "string",
  • "subscriptionId": "string",
  • "queueEnabled": true,
  • "edition": "string",
  • "version": "string",
  • "lastUpdate": "string",
  • "ipAddress": "string",
  • "oauth2RedirectUrl": "string",
  • "oauth1CallbackUrl": "string",
  • "openApiSchema": "string",
  • "webHookUrl": "string",
  • "httpProxyUrl": "string",
  • "swaggerDocsUrl": "string",
  • "supportEmail": "string",
  • "supportPortal": "string",
  • "slaUrl": "string",
  • "environments": [
    ]
}

Get environment information

Retrieves information about the current environment, including data engine settings such as the memory limit and number of workers, along with usage metrics for filesystem and database size.

Responses

Response samples

Content type
application/json
{
  • "dataEngines": {
    },
  • "usage": {
    }
}

JWT

List tokens

Retrieves the list of JWT token identifiers along with their metadata. Accepts an optional filter query parameter to apply search criteria.

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

Generate a new token

Generates a new JWT token from the supplied name and optional description. Returns the generated access token together with its identifier.

Request Body schema: application/json
name
required
string (Token name) <= 45 characters
description
string (Description) <= 64000 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "identifier": "string"
}

Get a token

Retrieves a single JWT token identified by the identifier path parameter. Returns the token's metadata such as name, description, creation details, and last used timestamp.

path Parameters
identifier
required
string

Token identifier

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "object": {
    }
}

Delete a token

Deletes the JWT token identified by the identifier path parameter. Returns a confirmation message.

path Parameters
identifier
required
string

Token identifier

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Update a token

Updates the name and description of the JWT token identified by the identifier path parameter. Returns the updated token.

path Parameters
identifier
required
string

Token identifier

Request Body schema: application/json
name
string (Token name) <= 45 characters
description
string (Description) <= 64000 characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "object": {
    }
}

Settings

Set the preferred update cycle

Sets the preferred Alumio update cycle, accepting either "latest" or "lts" in the request body. Returns the updated update cycle setting.

Request Body schema: application/json
Latest"latest" (string) or LTS"lts" (string)

Responses

Request samples

Content type
application/json
{
  • "updateCycle": "latest"
}

Response samples

Content type
application/json
{
  • "updateCycle": "latest"
}

MaintenanceWindow

Get maintenance window logs

Retrieves the list of maintenance window log records, each describing a maintenance window's identifier, start and end dates, and timezone. Accepts an optional filter query parameter to narrow the results by search criteria.

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

Notifier

Get notification usage info

Retrieves notification usage statistics broken down per channel, returning the number of notifications sent and the credits consumed for each channel.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Oauth

Initialize OAuth1 token request

Starts the OAuth1 authorization flow for the given provider, using the supplied provider specification, key, and callbackId to track the request. Typically responds with a redirect to the provider's authorization URL.

query Parameters
object

Provider specification

key
string

The current key

callbackId
string

Id to return when receiving data

Responses

Get OAuth token key

Initiates the OAuth flow for the specified provider and redirects to the provider's authorization endpoint to obtain a token key. Accepts the current key and a callback id used to correlate the returned authorization data.

query Parameters
provider
object (OAuthTokenRequest)

Provider specification

key
string

The current key

callbackId
string

Id to return when receiving data

Responses

Handle OAuth1 callback

Handles the OAuth1 callback by validating the oauth_token and oauth_verifier query parameters returned by the provider to complete the authorization flow. Typically responds with a redirect once the callback is processed.

query Parameters
oauth_token
string

OAuth token

oauth_verifier
string

OAuth verifier

Responses

Subscribers

Consume data for a subscriber (deprecated) Deprecated

Consumes and processes data for the subscriber identified by the path parameter and returns the consume result. Deprecated: use queuePublish instead.

path Parameters
subscriber
required
string

Incoming configuration identifier.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Consume data for a subscriber (deprecated) Deprecated

Consumes the next available data for the subscriber identified by the path parameter and returns the consumed result. Deprecated: use the queuePublish endpoint instead.

path Parameters
subscriber
required
string

Incoming configuration identifier.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Publishers

Export data for a route (deprecated) Deprecated

Exports data for the route identified by the path parameter and returns an export result, optionally limiting the run with the tasks query parameter. Deprecated in favor of queuePublish.

path Parameters
route
required
string

Route identifier.

query Parameters
tasks
integer <int32>

Number of tasks to export

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Export data for a route (deprecated) Deprecated

Exports data for the route identified by the route path parameter, optionally limited to the number of tasks given by the tasks query parameter, and returns the export result. Deprecated: use queuePublish instead.

path Parameters
route
required
string

Route identifier.

query Parameters
tasks
integer <int32>

Number of tasks to export

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Queue

Publish a job in the queue

Publishes a job onto the queue from the request body, specifying its target queue, priority, and the commands to run. Returns a confirmation message and the process identifier of the scheduled job.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "job": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "processId": "string"
}

Get a list of queued processes

Retrieves the list of queue processes along with action metadata. Accepts an optional filter query parameter to narrow the results by search criteria.

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

Get a single process

Retrieves the details of a single queue process identified by the process path parameter. Returns the process log including its status, priority, command type, and timing information.

path Parameters
process
required
string

Process identifier

Responses

Response samples

Content type
application/json
{
  • "object": {
    }
}

Get a single job

Retrieves the details of a single queue job identified by the job path parameter. Returns the job's queue process information.

path Parameters
job
required
string

Job identifier

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

Skip jobs in bulk

Skips multiple queued jobs matching the filter provided in the request body. Returns a message and the number of jobs that were skipped.

Request Body schema: application/json
filter
string

Responses

Request samples

Content type
application/json
{
  • "filter": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "skipped": 0
}

Kill jobs in bulk

Kills multiple jobs matching the filter provided in the request body, terminating them immediately. Returns a message and the number of jobs that were scheduled for killing.

Request Body schema: application/json
filter
string

Responses

Request samples

Content type
application/json
{
  • "filter": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "scheduled": 0,
  • "processId": "string"
}

Stop jobs in bulk

Stops multiple jobs matching the filter provided in the request body, signalling them to halt gracefully. Returns a message and the number of jobs that were scheduled for stopping.

Request Body schema: application/json
filter
string

Responses

Request samples

Content type
application/json
{
  • "filter": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "scheduled": 0,
  • "processId": "string"
}

Background

Kill a queued or running process

Kills the queued or running background process matching the identifier path parameter, terminating it immediately. Returns a message describing the outcome.

path Parameters
identifier
required
string

Type identifier

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Stop a running process

Stops the running background process matching the identifier path parameter, signalling it to halt gracefully. Returns a message describing the outcome.

path Parameters
identifier
required
string

Type identifier

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Routing

Get all available routes

Retrieves all available routes, returning a list of route entries with their identifier, name, and type along with action metadata.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

Reporting

Get the statistics of routes

Retrieves task and log statistics for the specified routes within a given time window, accepting a request body with the required from and to timestamps and one or more route identifiers. Returns per-route statistics including counts of new, finished, and failed tasks along with log error counts and memory usage.

Request Body schema: application/json
from
required
string <date-time>

Start timestamp.

to
required
string <date-time>

End timestamp.

routeIdentifiers
required
Array of strings non-empty

List of one or route identifiers.

Responses

Request samples

Content type
application/json
{
  • "from": "2019-08-24T14:15:22Z",
  • "to": "2019-08-24T14:15:22Z",
  • "routeIdentifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

Get stats about routes and tasks

Retrieves task processing statistics aggregated per route, returning counts of new, processing, skipped, finished, and failed tasks for each route. Supports optional filtering by a date range using the from and to query parameters and by a specific route identifier.

query Parameters
from
string

Start date

to
string

End date

route
string

Route identifier

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

Get routes across all spaces

Retrieves all routes from every space, returning each route's type, identifier, space, name, disabled status, and timestamps. Accepts an optional filter query parameter to narrow the results by search criteria.

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

Storage

Copy storage items from source to target

Copies all stored items from the source storage into the target storage, both identified by path parameters. Returns information about the copied objects.

path Parameters
source
required
string

The storage that needs to be copied.

target
required
string

The target storage where data will be stored.

Responses

Response samples

Content type
application/json
{ }

Prune storages

Prunes storages to remove expired or obsolete entries, optionally limited to a single storage via the identifier query parameter. Returns a message describing the result of the prune operation.

query Parameters
identifier
string

Storage identifier.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Get a list of storage entities

Retrieves the list of entities in the storage identified by the path identifier, optionally narrowed by the filter query parameter. Returns the matching entities along with metadata and a pagination cursor.

path Parameters
identifier
required
string

Storage identifier.

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ],
  • "next": [
    ]
}

Delete multiple entities from a storage

Deletes multiple entities from the storage identified by the path identifier, selecting which entities to remove via the filter in the request body. Returns a message describing the result.

path Parameters
identifier
required
string

Storage identifier

Request Body schema: application/json
filter
string

Responses

Request samples

Content type
application/json
{
  • "filter": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Get the content of a stored entity Deprecated

Retrieves the stored content of a single entity, identified by the storage and entity path parameters. Returns the entity value together with its last-updated timestamp; this endpoint is deprecated.

path Parameters
identifier
required
string

Storage identifier.

entity
required
string

Entity identifier.

Responses

Response samples

Content type
application/json
{
  • "value": null,
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Modify the content of a stored entity Deprecated

Updates the stored content of a single entity, identified by the storage and entity path parameters. Returns the updated entity value with its last-updated timestamp; this endpoint is deprecated.

path Parameters
identifier
required
string

Storage identifier.

entity
required
string

Entity identifier.

Responses

Response samples

Content type
application/json
{
  • "value": null,
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete the content of a stored entity Deprecated

Deletes a single stored entity, identified by the storage and entity path parameters. Returns a message describing the result; this endpoint is deprecated.

path Parameters
identifier
required
string

Storage identifier.

entity
required
string

Entity identifier.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Get the content of a stored entity

Retrieves the stored content of a single entity, selected by the storage path identifier and the required entity query parameter. Returns the entity value together with its last-updated timestamp.

path Parameters
identifier
required
string

Storage identifier.

query Parameters
entity
required
string

Entity identifier.

Responses

Response samples

Content type
application/json
{
  • "value": null,
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Modify the content of a stored entity

Updates the stored content of a single entity, selected by the storage path identifier and the required entity query parameter. Returns the updated entity value with its last-updated timestamp.

path Parameters
identifier
required
string

Storage identifier.

query Parameters
entity
required
string

Entity identifier.

Responses

Response samples

Content type
application/json
{
  • "value": null,
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Create a new entity in a storage

Creates a new entity in the storage identified by the path identifier, using the required entity query parameter as its key. Returns the created entity value with its last-updated timestamp.

path Parameters
identifier
required
string

Storage identifier.

query Parameters
entity
required
string

Entity identifier.

Responses

Response samples

Content type
application/json
{
  • "value": null,
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete the content of a stored entity

Deletes a single stored entity, selected by the storage path identifier and the required entity query parameter. Returns a message describing the result.

path Parameters
identifier
required
string

Storage identifier.

query Parameters
entity
required
string

Entity identifier.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Export storage entities matching the filter

Exports entities from the storage identified by the path identifier that match the filter in the request body, with an optional clientTime hint. Streams the matching entities as a newline-delimited JSON (application/x-ndjson) response.

path Parameters
identifier
required
string

Storage identifier.

Request Body schema: application/json
filter
string
clientTime
string^\d+$

Responses

Request samples

Content type
application/json
{
  • "filter": "string",
  • "clientTime": "string"
}

Response samples

Content type
application/x-ndjson
"string"

Empty the stored entities

Removes all entities from the storage identified by the path identifier, emptying it completely. Returns a message describing the result.

path Parameters
identifier
required
string

Storage identifier.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Get a list of storage metadata

Retrieves a list of storage metadata entries, each reporting a storage identifier and its size in bytes used on disk. Accepts an optional filter query parameter to narrow the results by search criteria.

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

TaskLogger

Get the current task limits

Retrieves the task usage limits for the current environment, returning the maximum number of tasks allowed alongside the number of tasks currently used.

Responses

Response samples

Content type
application/json
{
  • "results": {
    }
}

Get aggregated task statistics

Retrieves aggregated task log statistics grouped by date, returning per-status counts of new, processing, finished, failed, and skipped log items. Accepts an optional filter query parameter to narrow the results by search criteria.

query Parameters
filter
string

Apply search criteria

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

Get environment task statistics time series

Retrieves a time series of task statistics for the environment, returning per-period counts of new, processing, finished, failed, and skipped task log items. Requires a filter to scope the results and accepts an optional aggregation level (daily, weekly, monthly, or yearly, defaulting to monthly).

query Parameters
filter
required
string

Apply search criteria

aggregation
string
Default: "monthly"
Enum: "daily" "weekly" "monthly" "yearly"

Aggregation level for the task statistics

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get all statistics for a specific period

Retrieves aggregated task log statistics, returning the total counts of log items grouped by status (new, processing, finished, failed, and skipped). Accepts an optional filter for search criteria and dateFrom and dateTo parameters to restrict the totals to a specific period.

query Parameters
filter
string

Apply search criteria

dateFrom
string <date>

Date from

dateTo
string <date>

Date to

Responses

Response samples

Content type
application/json
{
  • "results": {
    }
}

SystemAdministrator

Get system administrators

Retrieves the list of system administrators, returning their email addresses and assigned roles. Accepts an optional filter query parameter to narrow the results by search criteria.

query Parameters
filter
string

Apply search criteria

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

Create a system administrator

Creates a new system administrator from the supplied email address and roles, and returns the created administrator.

Request Body schema: application/json
email
required
string <email> (Email address)
required
Array of System Administrator"ROLE_SYSTEM_ADMINISTRATOR" (string) (Roles) non-empty unique

System administrator roles

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "object": {
    }
}

Get the requested system administrator

Retrieves a single system administrator identified by the email path parameter, returning their email address and assigned roles.

path Parameters
email
required
string

Email address

Responses

Response samples

Content type
application/json
{
  • "object": {
    }
}

Update a system administrator

Updates the system administrator identified by the email path parameter with the supplied email address and roles, and returns the updated administrator.

path Parameters
email
required
string

User email

Request Body schema: application/json
email
required
string <email> (Email address)
required
Array of System Administrator"ROLE_SYSTEM_ADMINISTRATOR" (string) (Roles) non-empty unique

System administrator roles

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "object": {
    }
}

Delete the supplied system administrator

Deletes the system administrator identified by the email path parameter, and returns a confirmation message.

path Parameters
email
required
string

User email

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Tasks

Export task entity data

Exports the entity data of the task identified by the path parameter. Returns the data as a downloadable JSON attachment.

path Parameters
identifier
required
string

Task identifier

Responses

Response samples

Content type
application/json
{ }

Get task entity data

Retrieves the entity data of the task identified by the given path identifier. Returns a JSON object containing the task's entity data under the data property.

path Parameters
identifier
required
string

Task identifier

Responses

Response samples

Content type
application/json
{
  • "data": { }
}

List tasks

Retrieves a paginated list of tasks, optionally narrowed by search criteria passed in the filter query parameter. Returns the matching tasks along with action metadata.

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

Get a task

Retrieves a single task by its identifier, including detailed information such as entity data, context, status, route, and processing metadata.

path Parameters
identifier
required
string

Entry identifier

Responses

Response samples

Content type
application/json
{
  • "object": {
    }
}

Retry tasks matching filter

Sets the status to retry for all tasks matching the filter in the request body. Returns the new status and the number of tasks affected.

Request Body schema: application/json
filter
string

Responses

Request samples

Content type
application/json
{
  • "filter": "string"
}

Response samples

Content type
application/json
{
  • "newStatus": "string",
  • "numberOfTasks": 0
}

Skip tasks matching filter

Sets the status to skipped for all tasks matching the filter in the request body. Returns the new status and the number of tasks affected.

Request Body schema: application/json
filter
string

Responses

Request samples

Content type
application/json
{
  • "filter": "string"
}

Response samples

Content type
application/json
{
  • "newStatus": "string",
  • "numberOfTasks": 0
}

Resolve tasks matching filter

Sets the status to resolved for all tasks matching the filter in the request body. Returns the new status and the number of tasks affected.

Request Body schema: application/json
filter
string

Responses

Request samples

Content type
application/json
{
  • "filter": "string"
}

Response samples

Content type
application/json
{
  • "newStatus": "string",
  • "numberOfTasks": 0
}

Export tasks matching filter

Exports all tasks matching the filter supplied in the form-encoded request body, using the optional clientTime value to align timestamps with the caller's timezone.

Request Body schema: application/x-www-form-urlencoded
filter
string
clientTime
string^\d+$

Responses

Set task status to finished

Set the status of tasks from waiting to finished.

Request Body schema: application/json
filter
string

Responses

Request samples

Content type
application/json
{
  • "filter": "string"
}

Response samples

Content type
application/json
{
  • "newStatus": "string",
  • "numberOfTasks": 0
}

Set task status to failed

Set the status of tasks from waiting to failed.

Request Body schema: application/json
filter
string

Responses

Request samples

Content type
application/json
{
  • "filter": "string"
}

Response samples

Content type
application/json
{
  • "newStatus": "string",
  • "numberOfTasks": 0
}

Prune tasks

Deletes tasks older than the required maxAge or beyond the required maxCount most recent tasks, optionally restricted by the filter query parameter. Returns the number of tasks removed for being expired and for exceeding the count.

query Parameters
maxAge
required
string

Max age of the tasks.

maxCount
required
integer

Max number of remaining tasks.

filter
string

Apply search criteria.

Responses

Response samples

Content type
application/json
{
  • "expired": 0,
  • "excess": 0
}

Repair stuck tasks

Resets tasks that have been stuck for at least the given age (default 1 hour) to the newStatus (default new), optionally limited by the filter query parameter. Returns the number of tasks repaired and the status they were set to.

query Parameters
age
string
Default: "1 hour"

Minimum age of the tasks.

newStatus
string
Default: "new"

The status to be set for repaired tasks

filter
string

Apply search criteria.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "newStatus": "string"
}

Update waiting tasks in bulk

Transitions waiting tasks to a finished or failed status in bulk, attaching the provided log messages to each identifier. Returns the number of tasks updated together with their details.

Request Body schema: application/json
Array of objects non-empty

Responses

Request samples

Content type
application/json
{
  • "tasks": [
    ]
}

Response samples

Content type
application/json
{
  • "numberOfTasks": 0,
  • "updatedTasks": { }
}

Transformer

Execute a transformer

Runs the transformer of the given "type" (defaulting to "list-transformer") against the supplied request body and returns the resulting entities. Supports debugging via the "breakpoints" and "stop-exec-at" query parameters to pause or halt execution at specific points.

query Parameters
type
string
Default: "list-transformer"
breakpoints
boolean
Default: false
stop-exec-at
string
Request Body schema: application/json
object (TransformerExecuteEntity)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

UI

Get UI schema by type

Retrieves the UI schema items for the type given in the path, returning them as a map of items under an object wrapper.

path Parameters
type
required
string

UI schema type

Responses

Response samples

Content type
application/json
{
  • "object": {
    }
}

Lolina

Get a list of user environments

Retrieves the environments accessible to the authenticated user, returning each environment's identifier, name, code, type, and prototype alongside action metadata.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}