Download OpenAPI specification:Download
Access Alumio through OpenAPI v3.1.
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.
| prompt required | string <= 3000 characters |
{- "prompt": "string"
}{- "code": "string",
- "errorMessage": "string"
}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.
| prompt required | string <= 500 characters |
{- "prompt": "string"
}{- "json_result": "string",
- "errorMessage": "string"
}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.
| prompt required | string <= 255 characters |
{- "prompt": "string"
}{- "expression": "string",
- "isValidExpression": true,
- "errorMessage": "string"
}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.
| identifier required | string Entry identifier |
{- "identifier": "string",
- "user": "user@example.com",
- "spaceIdentifier": "string",
- "action": "string",
- "category": "string",
- "ipAddress": "string",
- "message": "string",
- "request": { },
- "createdAt": "2019-08-24T14:15:22Z"
}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.
| filter | string Apply search criteria. |
{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "identifier": "string",
- "user": "user@example.com",
- "spaceIdentifier": "string",
- "action": "string",
- "category": "string",
- "ipAddress": "string",
- "message": "string",
- "request": { },
- "createdAt": "2019-08-24T14:15:22Z"
}
]
}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.
| filter | string |
{- "status": "string",
- "context": { },
- "type": "string",
- "title": "string",
- "detail": "string",
- "violations": [
- {
- "title": "string",
- "propertyPath": "string",
- "type": "string"
}
]
}Exports the audit trail entries as a downloadable file, optionally narrowing the result set with the form-encoded filter parameter.
| filter | string |
{- "status": "string",
- "context": { },
- "type": "string",
- "title": "string",
- "detail": "string",
- "violations": [
- {
- "title": "string",
- "propertyPath": "string",
- "type": "string"
}
]
}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.
| identifier required | string Entry identifier |
{- "identifier": "string",
- "user": "user@example.com",
- "spaceIdentifier": "string",
- "action": "string",
- "category": "string",
- "ipAddress": "string",
- "message": "string",
- "request": { },
- "createdAt": "2019-08-24T14:15:22Z"
}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.
| filter | string Apply search criteria. |
{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "identifier": "string",
- "user": "user@example.com",
- "spaceIdentifier": "string",
- "action": "string",
- "category": "string",
- "ipAddress": "string",
- "message": "string",
- "request": { },
- "createdAt": "2019-08-24T14:15:22Z"
}
]
}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.
| identifier required | string Space identifier |
{- "message": "string"
}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.
required | object |
required | Array of objects (User) |
required | Array of objects (SpaceWorkerAllocation) |
{- "object": {
- "identifier": "string",
- "name": "string",
- "termsAgreed": true,
- "description": "",
- "purpose": "prod"
}, - "users": [
- {
- "email": "user@example.com",
- "roles": [
- "ROLE_USER"
]
}
], - "dataEngines": [
- {
- "spaceIdentifier": "string",
- "workers": 0
}
]
}{- "object": {
- "identifier": "string",
- "name": "string",
- "description": "",
- "purpose": "prod",
- "workers": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "isLocked": 0,
- "termsAgreed": 0,
- "createUser": "user@example.com",
- "expireDate": "2019-08-24T14:15:22Z",
- "cancelUser": "user@example.com",
- "cancelDate": "2019-08-24T14:15:22Z",
- "status": "new"
}
}Creates or updates a space from the supplied name, identifier, purpose, and optional description, and returns the resulting space object.
| 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" |
{- "identifier": "string",
- "name": "string",
- "description": "",
- "purpose": "prod"
}{- "object": {
- "identifier": "string",
- "name": "string",
- "description": "",
- "purpose": "prod",
- "workers": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "isLocked": 0,
- "termsAgreed": 0,
- "createUser": "user@example.com",
- "expireDate": "2019-08-24T14:15:22Z",
- "cancelUser": "user@example.com",
- "cancelDate": "2019-08-24T14:15:22Z",
- "status": "new"
}
}Retrieves a single space identified by the path identifier, returning its full details.
| identifier required | string Space identifier |
{- "object": {
- "identifier": "string",
- "name": "string",
- "description": "",
- "purpose": "prod",
- "workers": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "isLocked": 0,
- "termsAgreed": 0,
- "createUser": "user@example.com",
- "expireDate": "2019-08-24T14:15:22Z",
- "cancelUser": "user@example.com",
- "cancelDate": "2019-08-24T14:15:22Z",
- "status": "new"
}
}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.
| dateFrom | string <date> Date from |
| dateTo | string <date> Date to |
{- "results": [
- {
- "spaceIdentifier": "string",
- "spaceName": "string",
- "new": 0,
- "processing": 0,
- "finished": 0,
- "failed": 0,
- "skipped": 0
}
]
}Retrieves the current worker allocation per space, including the total number of available workers and the number of workers available per space.
{- "workers": 0,
- "workersPerSpace": 0,
- "spaceWorkers": [
- {
- "spaceIdentifier": "string",
- "workers": 0
}
]
}Allocates a number of workers to each space from the list in the request body and returns the updated worker allocation.
Array of objects (SpaceWorkerAllocation) |
{- "spaceWorkers": [
- {
- "spaceIdentifier": "string",
- "workers": 0
}
]
}{- "workers": 0,
- "workersPerSpace": 0,
- "spaceWorkers": [
- {
- "spaceIdentifier": "string",
- "workers": 0
}
]
}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.
{- "workers": 0,
- "workersPerSpace": 0,
- "spaceWorkers": [
- {
- "spaceIdentifier": "string",
- "workerIdentifiers": [
- 0
]
}
]
}Assigns specific workers to spaces based on the worker identifiers supplied per space in the request body, and returns the updated worker assignments.
Array of objects (SpaceWorker) |
{- "spaceWorkers": [
- {
- "spaceIdentifier": "string",
- "workerIdentifiers": [
- 0
]
}
]
}{- "workers": 0,
- "workersPerSpace": 0,
- "spaceWorkers": [
- {
- "spaceIdentifier": "string",
- "workerIdentifiers": [
- 0
]
}
]
}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.
| space required | string Space identifier |
required | Array of objects (User) |
{- "users": [
- {
- "email": "user@example.com",
- "roles": [
- "ROLE_USER"
]
}
]
}{ }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.
| space required | string Space identifier. |
| filter | string Apply search criteria. |
{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "email": "user@example.com",
- "space": "string",
- "roles": [
- "ROLE_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.
| space required | string Space identifier. |
| email required | string <email> (Email address) |
| roles required | Array of strings (Roles) non-empty unique Items Enum: "ROLE_EDITOR" "ROLE_USER" "ROLE_ADMINISTRATOR" |
{- "email": "user@example.com",
- "roles": [
- "ROLE_EDITOR"
]
}{- "object": {
- "email": "user@example.com",
- "space": "string",
- "roles": [
- "ROLE_USER"
]
}
}Retrieves a single user of the given space, identified by their email address. Returns the user's email, space, and assigned roles.
| space required | string Space identifier |
| email required | string User identifier |
{- "object": {
- "email": "user@example.com",
- "space": "string",
- "roles": [
- "ROLE_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.
| space required | string Space identifier |
| email required | string User identifier |
| email required | string <email> (Email address) |
| roles required | Array of strings (Roles) non-empty unique Items Enum: "ROLE_EDITOR" "ROLE_USER" "ROLE_ADMINISTRATOR" |
{- "email": "user@example.com",
- "roles": [
- "ROLE_EDITOR"
]
}{- "object": {
- "email": "user@example.com",
- "space": "string",
- "roles": [
- "ROLE_USER"
]
}
}Removes the user identified by the email address from the given space, revoking their access. Returns a confirmation message.
| space required | string Space identifier |
| email required | string User identifier |
{- "message": "string"
}Retrieves the profile of the currently authenticated user based on the request's credentials. Returns the user details as a UserResponse.
{- "message": "string",
- "object": {
- "email": "string",
- "roles": [
- "ROLE_USER"
], - "preferences": { }
}
}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.
| filter | string Apply search criteria. |
{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "email": "user@example.com",
- "roles": [
- "ROLE_USER"
]
}
]
}Creates a new user in the current space from the supplied email address and one or more roles. Returns the created user.
| email required | string <email> (Email address) |
| roles required | Array of strings (Roles) non-empty unique Items Enum: "ROLE_EDITOR" "ROLE_USER" "ROLE_ADMINISTRATOR" |
{- "email": "user@example.com",
- "roles": [
- "ROLE_EDITOR"
]
}{- "object": {
- "email": "user@example.com",
- "roles": [
- "ROLE_USER"
]
}
}Retrieves a single user from the current space identified by the email path parameter. Returns the user's email address and assigned roles.
| email required | string User identifier |
{- "object": {
- "email": "user@example.com",
- "roles": [
- "ROLE_USER"
]
}
}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.
| email required | string User identifier |
| email required | string <email> (Email address) |
| roles required | Array of strings (Roles) non-empty unique Items Enum: "ROLE_EDITOR" "ROLE_USER" "ROLE_ADMINISTRATOR" |
{- "email": "user@example.com",
- "roles": [
- "ROLE_EDITOR"
]
}{- "object": {
- "email": "user@example.com",
- "roles": [
- "ROLE_USER"
]
}
}Updates the preferences of the current user in the current space using the preference values supplied in the request body. Returns the updated user.
object (CurrentSpaceUserPreferences) |
{- "updatedPreferences": { }
}{- "object": {
- "email": "user@example.com",
- "roles": [
- "ROLE_USER"
]
}
}Retrieves the list of saved table filters for the current user. Accepts an optional filter query parameter to narrow the results by search criteria.
| filter | string Apply search criteria |
{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "identifier": "string",
- "user": "string",
- "tableKey": "string",
- "name": "string",
- "filter": { }
}
]
}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.
| tableKey required | string <= 255 characters |
| name required | string <= 255 characters |
required | object |
{- "tableKey": "string",
- "name": "string",
- "filter": { }
}{- "object": {
- "identifier": "string",
- "user": "string",
- "tableKey": "string",
- "name": "string",
- "filter": { }
}
}Updates the table filter matching the given identifier with the supplied table key, name, and filter criteria. Returns the updated filter.
| identifier required | string Table filter identifier |
| tableKey required | string <= 255 characters |
| name required | string <= 255 characters |
required | object |
{- "tableKey": "string",
- "name": "string",
- "filter": { }
}{- "object": {
- "identifier": "string",
- "user": "string",
- "tableKey": "string",
- "name": "string",
- "filter": { }
}
}Deletes the table filter matching the given identifier. Returns a confirmation message once the filter has been removed.
| identifier required | string Table filter identifier |
{- "message": "string"
}Updates the authenticated user's preferences by merging the supplied updatedPreferences object into the stored settings. Returns the updated user, including the new preferences.
object |
{- "updatedPreferences": { }
}{- "message": "string",
- "object": {
- "email": "string",
- "roles": [
- "ROLE_USER"
], - "preferences": { }
}
}Records the authenticated user's acceptance of the terms and conditions. Returns a confirmation message together with the updated user object.
{- "message": "string",
- "object": {
- "email": "user@example.com",
- "roles": [
- "ROLE_USER"
]
}
}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.
| type required | string Di type name |
| identifier required | string Di configuration identifier |
{- "usages": [
- {
- "propertyPath": "string",
- "type": "string",
- "specification": { }
}
]
}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).
| direction | string Default: "both" Enum: "down" "up" "both" "recursive" Direction to resolve relations |
Array of objects |
{- "objects": [
- {
- "type": "string",
- "identifier": "string"
}
]
}{- "nodes": [
- {
- "type": "string",
- "identifier": "string",
- "name": "string",
- "relationships": [
- {
- "relation": "string",
- "node": {
- "identifier": "string",
- "type": "string"
}, - "paths": [
- "string"
]
}
]
}
]
}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).
| type required | string Di type name |
| identifier required | string Di configuration identifier |
| direction | string Default: "both" Enum: "down" "up" "both" "recursive" Direction to resolve relations |
{- "nodes": [
- {
- "type": "string",
- "identifier": "string",
- "name": "string",
- "relationships": [
- {
- "relation": "string",
- "node": {
- "identifier": "string",
- "type": "string"
}, - "paths": [
- "string"
]
}
]
}
]
}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.
| filter | string Apply search criteria. |
{- "dependants": [
- {
- "type": "string",
- "identifier": "string",
- "usages": [
- {
- "propertyPath": "string",
- "type": "string",
- "specification": { }
}
]
}
]
}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.
| 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. |
{- "succeeded": [
- {
- "type": "string",
- "identifier": "string",
- "object": "string",
- "parameters": { }
}
], - "failed": [
- {
- "type": "string",
- "identifier": "string",
- "exception": "string",
- "parameters": { }
}
], - "totalSucceeded": 0,
- "totalFailed": 0
}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.
| type | string (Type) Type |
| identifier | string (Identifier) <= 255 characters ^[a-z0-9-]+$ Identifier |
{- "type": "string",
- "identifier": "string"
}{- "id": "string",
- "identifier": "string",
- "type": "string",
- "space": "string",
- "user": "user@example.com",
- "tag": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}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.
| type required | string Type identifier |
| identifier required | string Configuration identifier |
| ulid required | string <ulid> |
{- "ulid": "string"
}{- "object": {
- "type": "string",
- "identifier": "string",
- "ulid": "string",
- "name": "string",
- "editor": "string",
- "description": "string",
- "object": { },
- "createdAt": "2019-08-24T14:15:22Z",
- "disabled": true,
- "label": [
- "string"
]
}
}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.
| type required | string Type identifier |
| identifier required | string Configuration identifier |
| filter | string Apply search criteria. |
{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "type": "string",
- "identifier": "string",
- "ulid": "string",
- "name": "string",
- "editor": "string",
- "description": "string",
- "object": { },
- "createdAt": "2019-08-24T14:15:22Z",
- "disabled": true,
- "label": [
- "string"
]
}
]
}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.
Array of objects | |
| clientTime | string^\d+$ |
{- "objects": [
- {
- "type": "string",
- "identifier": "string"
}
], - "clientTime": "string"
}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.
| type required | string Object Type |
| identifiers | Array of strings |
| clientTime | string^\d+$ |
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.
| validate-variables | boolean Default: false Enable validation of variables. |
| dry-run | boolean Default: false Only validate and check whether configurations already exist. |
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) |
[- {
- "type": "string",
- "identifier": "string",
- "name": "string",
- "description": "string",
- "object": {
- "prototype": "string",
- "parameters": { }
}
}
]{- "valid": true,
- "title": "string",
- "detail": "string",
- "results": [
- {
- "type": "string",
- "identifier": "string",
- "decision": "string",
- "action": "string",
- "relationships": [
- {
- "relation": "string",
- "node": {
- "identifier": "string",
- "type": "string"
}, - "paths": [
- "string"
]
}
], - "violations": [
- {
- "propertyPath": "string",
- "title": "string",
- "titleTemplate": "string",
- "parameters": { },
- "type": "string",
- "helpText": "string"
}
]
}
]
}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.
| type required | string Type identifier |
| identifier required | string Configuration identifier |
| labels required | Array of strings |
{- "labels": [
- "string"
]
}{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "name": "string"
}
]
}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.
| type required | string Type identifier |
| owner required | string Owner identifier |
| filter | string Apply search criteria. |
{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "type": "string",
- "identifier": "string",
- "name": "string",
- "description": "string",
- "object": { },
- "removable": false,
- "resettable": false,
- "disabled": false,
- "editor": "string"
}
]
}Creates a new object relation for the given type and owner from the relation supplied in the request body. Returns the created relation.
| type required | string Type identifier |
| owner required | string Owner identifier |
| 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 |
{- "type": "string",
- "identifier": "string",
- "name": "string",
- "description": "string",
- "object": { },
- "removable": false,
- "resettable": false,
- "disabled": false,
- "editor": "string"
}{- "object": {
- "type": "string",
- "identifier": "string",
- "name": "string",
- "description": "string",
- "object": { },
- "removable": false,
- "resettable": false,
- "disabled": false,
- "editor": "string"
}
}Retrieves a single object relation identified by its type, owner, and identifier. Returns the matching relation.
| type required | string Type identifier |
| owner required | string Owner identifier |
| identifier required | string Relation identifier |
{- "object": {
- "type": "string",
- "identifier": "string",
- "name": "string",
- "description": "string",
- "object": { },
- "removable": false,
- "resettable": false,
- "disabled": false,
- "editor": "string"
}
}Updates the object relation identified by its type, owner, and identifier with the data supplied in the request body. Returns the updated relation.
| type required | string Type identifier |
| owner required | string Owner identifier |
| identifier required | string Relation identifier |
| 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 |
{- "type": "string",
- "identifier": "string",
- "name": "string",
- "description": "string",
- "object": { },
- "removable": false,
- "resettable": false,
- "disabled": false,
- "editor": "string"
}{- "object": {
- "type": "string",
- "identifier": "string",
- "name": "string",
- "description": "string",
- "object": { },
- "removable": false,
- "resettable": false,
- "disabled": false,
- "editor": "string"
}
}Deletes the object relation identified by its type, owner, and identifier. Returns a confirmation message on success.
| type required | string Type identifier |
| owner required | string Owner identifier |
| identifier required | string Relation identifier |
{- "message": "string"
}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.
| type | string Type identifier |
{- "results": [
- {
- "type": "string",
- "identifier": "string",
- "error": "string",
- "violations": [
- {
- "propertyPath": "string",
- "title": "string",
- "titleTemplate": "string",
- "parameters": { },
- "type": "string"
}
]
}
]
}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.
| type | string Type identifier |
{- "results": [
- {
- "type": "string",
- "identifier": "string",
- "error": "string",
- "violations": [
- {
- "propertyPath": "string",
- "title": "string",
- "titleTemplate": "string",
- "parameters": { },
- "type": "string"
}
]
}
]
}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.
| filter | string Apply search criteria. |
{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "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",
- "label": [
- "string"
], - "tag": [
- "string"
]
}
]
}Retrieves the list of available object configurations, optionally narrowed down with the filter query parameter. Returns the matching configurations together with pagination metadata.
| filter | string Apply search criteria. |
{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "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",
- "label": [
- "string"
], - "tag": [
- "string"
]
}
]
}Creates a new object configuration from the type, name, and object payload in the request body. Returns the created configuration on success.
| 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 |
{- "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"
}{- "object": {
- "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",
- "label": [
- "string"
], - "tag": [
- "string"
]
}
}Replaces an existing object configuration, identified by the type and identifier in the request body, with the supplied values. Returns the updated configuration.
| 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 |
{- "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"
}{- "object": {
- "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",
- "label": [
- "string"
], - "tag": [
- "string"
]
}
}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.
| 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 |
{- "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"
}{- "object": {
- "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",
- "label": [
- "string"
], - "tag": [
- "string"
]
}
}Retrieves a single object configuration identified by the type and identifier path parameters. Returns the matching configuration.
| type required | string Type identifier |
| identifier required | string Configuration identifier |
{- "object": {
- "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",
- "label": [
- "string"
], - "tag": [
- "string"
]
}
}Deletes the object configuration identified by the type and identifier path parameters. Returns a message confirming the deletion.
| type required | string Type identifier |
| identifier required | string Configuration identifier |
{- "message": "string"
}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.
| type required | string Type identifier |
| identifier required | string Configuration identifier |
| disabled required | boolean (Status) Whether the configuration is disabled |
{- "disabled": true
}{- "object": {
- "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",
- "label": [
- "string"
], - "tag": [
- "string"
]
}
}Deletes all object configurations of the given type that match the filter in the request body. Returns the number of configurations that were deleted.
| type required | string Type identifier |
| filter | string |
{- "filter": "string"
}{- "deleted": 0
}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.
| type required | string Type identifier |
null{- "type": "string",
- "specification": "string",
- "object": "string",
- "tester": "string",
- "response": { }
}Tests the stored object configuration identified by the type and identifier path parameters and returns the test result for the evaluated object.
| type required | string Type identifier |
| identifier required | string Configuration identifier |
{- "type": "string",
- "specification": "string",
- "object": "string",
- "tester": "string",
- "response": { }
}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.
| type required | string Di type name |
| filter | string Apply search criteria. |
{- "type": "string",
- "configurations": [
- {
- "identifier": "string",
- "name": "string",
- "description": "string",
- "disabled": false,
- "context": { },
- "$defs": { }
}
], - "prototypes": [
- {
- "identifier": "string",
- "name": "string",
- "description": "string",
- "schema": { },
- "test": { },
- "context": { },
- "$defs": { }
}
], - "defaultPrototype": {
- "type": "string",
- "schema": { },
- "description": "string",
- "context": { },
- "test": { },
- "$defs": { }
}
}Retrieves the configured objects for the given dependency injection type. Accepts an optional filter query parameter to narrow the results by search criteria.
| type required | string Di type name |
| filter | string Apply search criteria. |
{- "type": "string",
- "configurations": [
- {
- "identifier": "string",
- "name": "string",
- "description": "string",
- "disabled": false,
- "context": { },
- "$defs": { }
}
], - "prototypes": [
- {
- "identifier": "string",
- "name": "string",
- "description": "string",
- "schema": { },
- "test": { },
- "context": { },
- "$defs": { }
}
], - "defaultPrototype": {
- "type": "string",
- "schema": { },
- "description": "string",
- "context": { },
- "test": { },
- "$defs": { }
}
}Retrieves the available object prototypes for the given dependency injection type. Accepts an optional filter query parameter to narrow the results by search criteria.
| type required | string Di type name |
| filter | string Apply search criteria. |
{- "type": "string",
- "configurations": [
- {
- "identifier": "string",
- "name": "string",
- "description": "string",
- "disabled": false,
- "context": { },
- "$defs": { }
}
], - "prototypes": [
- {
- "identifier": "string",
- "name": "string",
- "description": "string",
- "schema": { },
- "test": { },
- "context": { },
- "$defs": { }
}
], - "defaultPrototype": {
- "type": "string",
- "schema": { },
- "description": "string",
- "context": { },
- "test": { },
- "$defs": { }
}
}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.
| filter | string Apply search criteria. |
{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "identifier": "string",
- "name": "string",
- "categories": [
- "string"
], - "vendor": "string",
- "editions": { },
- "extensions": { },
- "apis": { }
}
]
}Retrieves the documentation for the prototype identified by the given type and identifier path parameters. Returns a ProtoTypeDocumentationResult describing the prototype's configuration options.
| type required | string Type identifier |
| identifier required | string Prototype identifier |
{- "documentation": "string"
}Retrieves the documentation for the default prototype of the given type path parameter. Returns a ProtoTypeDocumentationResult describing that prototype's configuration options.
| type required | string Type identifier |
{- "documentation": "string"
}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-*.
| index | string Default: "filebeat-*" Index to use |
| prototype | string |
| parameters | object |
{- "prototype": "string",
- "parameters": { }
}{ }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-*.
| index | string Default: "filebeat-*" Index to use |
| prototype | string |
| parameters | object |
{- "prototype": "string",
- "parameters": { }
}{ }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.
| index required | string Default: "filebeat-*" Index to use |
| id required | string Message Id |
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.
| dry-run | boolean Default: false Only check for differences |
{- "templates": [
- {
- "name": "string",
- "action": "string",
- "dryRun": true,
- "response": { }
}
]
}Retrieves the collection of environment variables. Accepts an optional filter query parameter to apply search criteria.
| filter | string Apply search criteria. |
{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "name": "string",
- "description": "string",
- "value": "string",
- "encrypted": true,
- "default": true
}
]
}Creates a new environment variable from the supplied name and value, optionally marked as encrypted, and returns the created variable.
| name required | string (EnvironmentVariableName) ^[a-zA-Z0-9_-]+$ |
| description | string (Description) <= 150 characters |
| value required | string |
| encrypted | boolean (Encrypted) |
{- "name": "string",
- "description": "string",
- "value": "string",
- "encrypted": true
}{- "object": {
- "name": "string",
- "description": "string",
- "value": "string",
- "encrypted": true,
- "default": true
}
}Retrieves a single environment variable identified by its name in the path.
| name required | string Environment variable name |
{- "object": {
- "name": "string",
- "description": "string",
- "value": "string",
- "encrypted": true,
- "default": true
}
}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.
| name required | string Environment variable name |
| description | string (Description) <= 150 characters |
| encrypted | boolean (Encrypted) |
| value | string |
{- "description": "string",
- "encrypted": true,
- "value": "string"
}{- "object": {
- "name": "string",
- "description": "string",
- "value": "string",
- "encrypted": true,
- "default": true
}
}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.
{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "name": "string",
- "matches": [
- {
- "type": "string",
- "metadata": { },
- "payload": { }
}
]
}
]
}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.
| variable required | string Environment variable |
{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "type": "string",
- "identifier": "string",
- "name": "string"
}
]
}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.
| 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. |
{- "configurations": {
- "metadata": { },
- "results": [
- { }
]
}, - "tasks": {
- "metadata": { },
- "results": [
- { }
]
}, - "variables": {
- "metadata": { },
- "results": [
- { }
]
}
}Retrieves general server information about the application, including the server IP address, the OAuth2 redirect URL, and the API base URL.
{- "ipAddress": "string",
- "oauth2RedirectUrl": "string",
- "apiUrl": "string"
}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.
{- "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": [
- { }
]
}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.
{- "dataEngines": {
- "memoryLimitMegaBytes": 0,
- "numberOfWorkers": 0
}, - "usage": {
- "filesystemSizeBytes": 0,
- "databaseSizeBytes": 0
}
}Retrieves the list of JWT token identifiers along with their metadata. Accepts an optional filter query parameter to apply search criteria.
| filter | string Apply search criteria. |
{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "identifier": "string",
- "name": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "description": "string",
- "lastUsed": "2019-08-24T14:15:22Z"
}
]
}Generates a new JWT token from the supplied name and optional description. Returns the generated access token together with its identifier.
| name required | string (Token name) <= 45 characters |
| description | string (Description) <= 64000 characters |
{- "name": "string",
- "description": "string"
}{- "access_token": "string",
- "identifier": "string"
}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.
| identifier required | string Token identifier |
{- "message": "string",
- "object": {
- "identifier": "string",
- "name": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "description": "string",
- "lastUsed": "2019-08-24T14:15:22Z"
}
}Updates the name and description of the JWT token identified by the identifier path parameter. Returns the updated token.
| identifier required | string Token identifier |
| name | string (Token name) <= 45 characters |
| description | string (Description) <= 64000 characters |
{- "name": "string",
- "description": "string"
}{- "message": "string",
- "object": {
- "identifier": "string",
- "name": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "description": "string",
- "lastUsed": "2019-08-24T14:15:22Z"
}
}Sets the preferred Alumio update cycle, accepting either "latest" or "lts" in the request body. Returns the updated update cycle setting.
Latest"latest" (string) or LTS"lts" (string) |
{- "updateCycle": "latest"
}{- "updateCycle": "latest"
}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.
| filter | string Apply search criteria. |
{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "identifier": "string",
- "dateStart": "2019-08-24T14:15:22Z",
- "dateEnd": "2019-08-24T14:15:22Z",
- "timezone": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}
]
}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.
object Provider specification | |
| key | string The current key |
| callbackId | string Id to return when receiving data |
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.
| provider | object (OAuthTokenRequest) Provider specification |
| key | string The current key |
| callbackId | string Id to return when receiving data |
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.
| oauth_token | string OAuth token |
| oauth_verifier | string OAuth verifier |
Consumes and processes data for the subscriber identified by the path parameter and returns the consume result. Deprecated: use queuePublish instead.
| subscriber required | string Incoming configuration identifier. |
{- "message": "string"
}Consumes the next available data for the subscriber identified by the path parameter and returns the consumed result. Deprecated: use the queuePublish endpoint instead.
| subscriber required | string Incoming configuration identifier. |
{- "message": "string"
}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.
| route required | string Route identifier. |
| tasks | integer <int32> Number of tasks to export |
{- "message": "string"
}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.
| route required | string Route identifier. |
| tasks | integer <int32> Number of tasks to export |
{- "message": "string"
}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.
object |
{- "job": {
- "queue": "string",
- "priority": 1,
- "commands": [
- { }
]
}
}{- "message": "string",
- "processId": "string"
}Retrieves the list of queue processes along with action metadata. Accepts an optional filter query parameter to narrow the results by search criteria.
| filter | string Apply search criteria. |
{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "status": "scheduled",
- "identifier": "string",
- "jobId": "string",
- "priority": 1,
- "routingKey": "string",
- "command": "incoming:run",
- "arguments": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "startedAt": "2019-08-24T14:15:22Z",
- "finishedAt": "2019-08-24T14:15:22Z",
- "processTime": 0,
- "runTime": 0,
- "meta": {
- "flags": [
- "string"
]
}
}
]
}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.
| process required | string Process identifier |
{- "object": {
- "status": "scheduled",
- "identifier": "string",
- "jobId": "string",
- "priority": 1,
- "routingKey": "string",
- "command": "incoming:run",
- "arguments": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "startedAt": "2019-08-24T14:15:22Z",
- "finishedAt": "2019-08-24T14:15:22Z",
- "processTime": 0,
- "runTime": 0,
- "meta": {
- "flags": [
- "string"
]
}
}
}Retrieves the details of a single queue job identified by the job path parameter. Returns the job's queue process information.
| job required | string Job identifier |
{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "status": "scheduled",
- "identifier": "string",
- "jobId": "string",
- "priority": 1,
- "routingKey": "string",
- "command": "incoming:run",
- "arguments": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "startedAt": "2019-08-24T14:15:22Z",
- "finishedAt": "2019-08-24T14:15:22Z",
- "processTime": 0,
- "runTime": 0,
- "meta": {
- "flags": [
- "string"
]
}
}
]
}Skips multiple queued jobs matching the filter provided in the request body. Returns a message and the number of jobs that were skipped.
| filter | string |
{- "filter": "string"
}{- "message": "string",
- "skipped": 0
}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.
| filter | string |
{- "filter": "string"
}{- "message": "string",
- "scheduled": 0,
- "processId": "string"
}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.
| filter | string |
{- "filter": "string"
}{- "message": "string",
- "scheduled": 0,
- "processId": "string"
}Kills the queued or running background process matching the identifier path parameter, terminating it immediately. Returns a message describing the outcome.
| identifier required | string Type identifier |
{- "message": "string"
}Stops the running background process matching the identifier path parameter, signalling it to halt gracefully. Returns a message describing the outcome.
| identifier required | string Type identifier |
{- "message": "string"
}Retrieves all available routes, returning a list of route entries with their identifier, name, and type along with action metadata.
{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "identifier": "string",
- "name": "string",
- "type": "string"
}
]
}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.
| 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. |
{- "from": "2019-08-24T14:15:22Z",
- "to": "2019-08-24T14:15:22Z",
- "routeIdentifiers": [
- "string"
]
}{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "identifier": "string",
- "taskStats": {
- "new": 0,
- "finished": 0,
- "failed": 0
}, - "logStats": {
- "errors": 0,
- "memory": "string"
}
}
]
}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.
| from | string Start date |
| to | string End date |
| route | string Route identifier |
{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "identifier": "string",
- "name": "string",
- "stats": {
- "new": 0,
- "processing": 0,
- "skipped": 0,
- "finished": 0,
- "failed": 0
}
}
]
}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.
| filter | string Apply search criteria. |
{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "type": "string",
- "identifier": "string",
- "space": "string",
- "name": "string",
- "disabled": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}Copies all stored items from the source storage into the target storage, both identified by path parameters. Returns information about the copied objects.
| source required | string The storage that needs to be copied. |
| target required | string The target storage where data will be stored. |
{ }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.
| identifier | string Storage identifier. |
{- "message": "string"
}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.
| identifier required | string Storage identifier. |
| filter | string Apply search criteria. |
{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "identifier": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "next": [
- "string"
]
}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.
| identifier required | string Storage identifier |
| filter | string |
{- "filter": "string"
}{- "message": "string"
}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.
| identifier required | string Storage identifier. |
| entity required | string Entity identifier. |
{- "value": null,
- "updatedAt": "2019-08-24T14:15:22Z"
}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.
| identifier required | string Storage identifier. |
| entity required | string Entity identifier. |
{- "value": null,
- "updatedAt": "2019-08-24T14:15:22Z"
}Deletes a single stored entity, identified by the storage and entity path parameters. Returns a message describing the result; this endpoint is deprecated.
| identifier required | string Storage identifier. |
| entity required | string Entity identifier. |
{- "message": "string"
}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.
| identifier required | string Storage identifier. |
| entity required | string Entity identifier. |
{- "value": null,
- "updatedAt": "2019-08-24T14:15:22Z"
}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.
| identifier required | string Storage identifier. |
| entity required | string Entity identifier. |
{- "value": null,
- "updatedAt": "2019-08-24T14:15:22Z"
}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.
| identifier required | string Storage identifier. |
| entity required | string Entity identifier. |
{- "value": null,
- "updatedAt": "2019-08-24T14:15:22Z"
}Deletes a single stored entity, selected by the storage path identifier and the required entity query parameter. Returns a message describing the result.
| identifier required | string Storage identifier. |
| entity required | string Entity identifier. |
{- "message": "string"
}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.
| identifier required | string Storage identifier. |
| filter | string |
| clientTime | string^\d+$ |
{- "filter": "string",
- "clientTime": "string"
}"string"Removes all entities from the storage identified by the path identifier, emptying it completely. Returns a message describing the result.
| identifier required | string Storage identifier. |
{- "message": "string"
}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.
| filter | string Apply search criteria. |
{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "identifier": "string",
- "sizeInBytes": 0
}
]
}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.
| filter | string Apply search criteria |
{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "identifier": "string",
- "spaceIdentifier": "string",
- "date": "2019-08-24",
- "new": 0,
- "processing": 0,
- "finished": 0,
- "failed": 0,
- "skipped": 0
}
]
}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).
| filter required | string Apply search criteria |
| aggregation | string Default: "monthly" Enum: "daily" "weekly" "monthly" "yearly" Aggregation level for the task statistics |
{- "results": [
- {
- "date": "string",
- "new": 0,
- "processing": 0,
- "finished": 0,
- "failed": 0,
- "skipped": 0
}
]
}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.
| filter | string Apply search criteria |
| dateFrom | string <date> Date from |
| dateTo | string <date> Date to |
{- "results": {
- "new": 0,
- "processing": 0,
- "finished": 0,
- "failed": 0,
- "skipped": 0
}
}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.
| filter | string Apply search criteria |
{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "email": "user@example.com",
- "roles": [
- "ROLE_SYSTEM_ADMINISTRATOR"
]
}
]
}Creates a new system administrator from the supplied email address and roles, and returns the created administrator.
| email required | string <email> (Email address) |
required | Array of System Administrator"ROLE_SYSTEM_ADMINISTRATOR" (string) (Roles) non-empty unique System administrator roles |
{- "email": "user@example.com",
- "roles": [
- "ROLE_SYSTEM_ADMINISTRATOR"
]
}{- "object": {
- "email": "user@example.com",
- "roles": [
- "ROLE_SYSTEM_ADMINISTRATOR"
]
}
}Retrieves a single system administrator identified by the email path parameter, returning their email address and assigned roles.
| email required | string Email address |
{- "object": {
- "email": "user@example.com",
- "roles": [
- "ROLE_SYSTEM_ADMINISTRATOR"
]
}
}Updates the system administrator identified by the email path parameter with the supplied email address and roles, and returns the updated administrator.
| email required | string User email |
| email required | string <email> (Email address) |
required | Array of System Administrator"ROLE_SYSTEM_ADMINISTRATOR" (string) (Roles) non-empty unique System administrator roles |
{- "email": "user@example.com",
- "roles": [
- "ROLE_SYSTEM_ADMINISTRATOR"
]
}{- "object": {
- "email": "user@example.com",
- "roles": [
- "ROLE_SYSTEM_ADMINISTRATOR"
]
}
}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.
| identifier required | string Task identifier |
{- "data": { }
}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.
| filter | string Apply search criteria. |
{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "identifier": "string",
- "entityType": "string",
- "entityData": { },
- "entityIdentifier": "string",
- "status": "new",
- "route": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}Retrieves a single task by its identifier, including detailed information such as entity data, context, status, route, and processing metadata.
| identifier required | string Entry identifier |
{- "object": {
- "identifier": "string",
- "entityType": "string",
- "entityIdentifier": "string",
- "entityData": { },
- "context": { },
- "status": "new",
- "route": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "meta": {
- "incoming": {
- "identifier": "string",
- "name": "string"
}, - "outgoing": {
- "identifier": "string",
- "name": "string"
}, - "route": {
- "identifier": "string",
- "name": "string"
}, - "httpProxy": {
- "identifier": "string",
- "name": "string"
}
}
}
}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.
| filter | string |
{- "filter": "string"
}{- "newStatus": "string",
- "numberOfTasks": 0
}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.
| filter | string |
{- "filter": "string"
}{- "newStatus": "string",
- "numberOfTasks": 0
}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.
| filter | string |
{- "filter": "string"
}{- "newStatus": "string",
- "numberOfTasks": 0
}Set the status of tasks from waiting to finished.
| filter | string |
{- "filter": "string"
}{- "newStatus": "string",
- "numberOfTasks": 0
}Set the status of tasks from waiting to failed.
| filter | string |
{- "filter": "string"
}{- "newStatus": "string",
- "numberOfTasks": 0
}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.
| maxAge required | string Max age of the tasks. |
| maxCount required | integer Max number of remaining tasks. |
| filter | string Apply search criteria. |
{- "expired": 0,
- "excess": 0
}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.
| 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. |
{- "count": 0,
- "newStatus": "string"
}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.
Array of objects non-empty |
{- "tasks": [
- {
- "identifiers": [
- "string"
], - "status": "finished",
- "messages": [
- {
- "level": "critical",
- "message": "string"
}
]
}
]
}{- "numberOfTasks": 0,
- "updatedTasks": { }
}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.
| type | string Default: "list-transformer" |
| breakpoints | boolean Default: false |
| stop-exec-at | string |
{ }{ }Retrieves the environments accessible to the authenticated user, returning each environment's identifier, name, code, type, and prototype alongside action metadata.
{- "metadata": {
- "totalCount": 0
}, - "results": [
- {
- "environment": {
- "identifier": "string",
- "name": "string",
- "code": "string",
- "type": "string",
- "prototype": "string"
}
}
]
}