API docs by Redocly

Alumio API (01KQ5ZMK4YPE7JBBYRV45MXKGG)

Download OpenAPI specification:Download

Access Alumio through OpenAPI v3.1.

AI

createCronExpression

Generate a CRON expression based on the given prompt.

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"
}

createJavaScriptCodeTransformer

Generate JavaScript for the JavaScript Code Transformer

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"
}

createTransformerTesterData

Generate JSON example data for the transformer tester input.

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"
}

createMappingSuggestion

Generate a mapping suggestion based on the given prompt.

Request Body schema: application/json
from
required
string
to
required
string

Responses

Request samples

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

Response samples

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

Application

getApplicationCapabilities

Get application capability flags.

Responses

Response samples

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

AuditTrail

getAuditTrailCurrentSpaceItem

Get an audit trail item for the current space

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"
}

auditTrailCurrentSpaceExport

Export the audit trail for the current space

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": [
    ]
}

getAuditTrailCurrentSpaceList

Get the audit trail list for the current space

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

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

Spaces

getAuditTrailItem

Get an audit trail item

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"
}

auditTrailExport

Export the audit trail

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": [
    ]
}

getAuditTrailList

Get the audit trail list

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

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

createSpace

Create a space

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

termsAgreed
required
boolean (Terms agreed)

Terms and conditions agreed

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",
  • "termsAgreed": true,
  • "description": "",
  • "purpose": "prod"
}

Response samples

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

updateSpace

Update a space

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": {
    }
}

getSpace

Get a single space

path Parameters
identifier
required
string

Space identifier

Responses

Response samples

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

cancelSpace

Cancel a space

path Parameters
identifier
required
string

Space identifier

Responses

Response samples

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

reactivateSpace

Reactivate a space

path Parameters
identifier
required
string

Space identifier

Responses

Response samples

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

getSpacesTaskLogStatistics

Get all statistics for a specific period

query Parameters
dateFrom
string <date>

Date from

dateTo
string <date>

Date to

Responses

Response samples

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

getSpacesNotificationsInfo

Get usage info

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getSpaceWorkerAllocation

Get assigned space workers

Responses

Response samples

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

postSpaceWorkerAllocation

Allocate workers to a space

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": [
    ]
}

getSpaceWorkers

Get assigned space workers

Responses

Response samples

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

postSpaceWorkers

Assign workers to spaces

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": [
    ]
}

getSpaceUsers

Get space users

path Parameters
space
required
string

Space identifier.

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

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

createSpaceUser

Create a space user

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": {
    }
}

getSpaceUser

Get a single space user

path Parameters
space
required
string

Space identifier

email
required
string

User identifier

Responses

Response samples

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

updateSpaceUser

Update a 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": {
    }
}

deleteSpaceUser

Delete a space user

path Parameters
space
required
string

Space identifier

email
required
string

User identifier

Responses

Response samples

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

assignSpaceUsers

Assign users to a space in bulk.

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
{ }

Users

getCurrentUser

Get current logged in user

Responses

Response samples

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

getCurrentSpaceUsers

Get users of the current space

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

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

createCurrentSpaceUser

Create a user in the current space

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": {
    }
}

getCurrentSpaceUser

Get a single user from the current space

path Parameters
email
required
string

User identifier

Responses

Response samples

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

updateCurrentSpaceUser

Update a user in the current space

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": {
    }
}

deleteCurrentSpaceUser

Delete a user from the current space

path Parameters
email
required
string

User identifier

Responses

Response samples

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

updateCurrentSpaceUserPreferences

Update users preferences in the current space

Request Body schema: application/json
object (CurrentSpaceUserPreferences)

Responses

Request samples

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

Response samples

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

getUserTableFilters

Get the table filters

query Parameters
filter
string

Apply search criteria

Responses

Response samples

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

createUserTableFilter

Creates a new table filter for the user

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": {
    }
}

updateUserTableFilter

Update a table filter by identifier

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": {
    }
}

deleteUserTableFilter

Delete a table filter by identifier

path Parameters
identifier
required
string

Table filter identifier

Responses

Response samples

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

acceptTerms

Accept user agreement

Responses

Response samples

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

updateUserPreferences

Save updated user preferences

Request Body schema: application/json
object

Responses

Request samples

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

Response samples

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

Di

List dependants

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

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

List configuration usages

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

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

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": [
    ]
}

Test prototypes

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
}

toggleDiFavorite

Toggle the favourite status of a configuration

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"
}

restoreConfiguration

Restore a configuration to a previous state

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": {
    }
}

getConfigurationHistory

Get the history of an object

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": [
    ]
}

importObjectConfigurations

Import object configurations

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": [
    ]
}

bulkExportObjectConfigurations

Bulk export object configurations

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

Responses

Request samples

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

exportObjectConfigurations

Export object configurations by type

path Parameters
type
required
string

Object Type

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

Responses

getDiLabelsList

Get a list of labels

Responses

Response samples

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

updateDiLabels

Set labels of a configuration

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": [
    ]
}

validateConfiguredObjectConfigurations

Validate configured object configurations

query Parameters
type
string

Type identifier

Responses

Response samples

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

validateRegisteredObjectConfigurations

Validate registered object configurations

query Parameters
type
string

Type identifier

Responses

Response samples

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

getObjectRelations

Get object relations

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": [
    ]
}

createObjectRelation

Create an object 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": {
    }
}

getObjectRelation

Get an object 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": {
    }
}

updateObjectRelation

Update an object 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": {
    }
}

deleteObjectRelation

Delete an object 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
{
  • "message": "string"
}

List object configurations and prototypes

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

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

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": {
    }
}

getStoredObjectConfigurations

Get stored object configurations

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

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

getObjectConfigurations

Get object configurations

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

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

createObjectConfiguration

Create an object configuration

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": {
    }
}

updateObjectConfiguration

Update an object 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": {
    }
}

patchObjectConfiguration

Patch an object 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": {
    }
}

getObjectConfiguration

Get an object configuration

path Parameters
type
required
string

Type identifier

identifier
required
string

Configuration identifier

Responses

Response samples

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

deleteObjectConfiguration

Delete an object configuration

path Parameters
type
required
string

Type identifier

identifier
required
string

Configuration identifier

Responses

Response samples

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

updateObjectConfigurationStatus

Update an object configuration status

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": {
    }
}

bulkDeleteObjectConfigurations

Bulk delete object configurations

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
}

testObjectSpecification

Test an non-stored object configuration

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": { }
}

testObjectConfiguration

Test an object configuration

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 platforms

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

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

DiExport

bulkExportAllObjectConfigurations

Bulk export all object configurations

Responses

Documentation

getProtoTypeDocumentation

Get the documentation of a prototype.

path Parameters
type
required
string

Type identifier

identifier
required
string

Prototype identifier

Responses

Response samples

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

getDefaultProtoTypeDocumentation

Get the documentation of a default prototype.

path Parameters
type
required
string

Type identifier

Responses

Response samples

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

Log

getLogs

Search logs

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
{ }

getLogCounts

Count logs

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
{ }

exportElasticsearchByIdDeprecated

Deprecated: Export Elasticsearch By Id

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

Index to use

id
required
string

Message Id

Responses

exportElasticsearchById

Export Elasticsearch By Id

path Parameters
id
required
string

Message Id

Responses

Elasticsearch

updateElasticsearchIndexTemplate

Update index template

query Parameters
dry-run
boolean
Default: false

Only check for differences

Responses

Response samples

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

updateElasticsearchIndexMappings

Update index mappings

query Parameters
index
string

Index to update

dry-run
boolean
Default: false

Only check for differences

rollover
boolean
Default: false

Rollover when there are type conflicts

Responses

Response samples

Content type
application/json
{ }

Environment

getEnvironmentVariableUsage

Get variable usage

path Parameters
variable
required
string

Environment variable

Responses

Response samples

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

generateKey

Generate a new cryptography key

Responses

Response samples

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

getEnvironmentVariables

A list of environment variables

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

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

createEnvironmentVariable

Create a new environment 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": {
    }
}

getEnvironmentVariable

Get variable

path Parameters
name
required
string

Environment variable name

Responses

Response samples

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

updateEnvironmentVariable

Update variable

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": {
    }
}

deleteEnvironmentVariable

Delete variable

path Parameters
name
required
string

Environment variable name

Responses

Response samples

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

getCandidateEnvironmentVariables

Get a list of candidate environment variables

Responses

Response samples

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

Search

generalSearch

General search function to look through configurations, tasks, etc.

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

retrieveServerInformation

Application info

Responses

Response samples

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

retrieveSupportInformation

Support info

Responses

Response samples

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

getSubscription

Support info

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": [
    ]
}

getEnvironmentInformation

Get environment information

Responses

Response samples

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

JWT

getTokens

Get tokens

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

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

createToken

Generate a new token.

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"
}

getToken

Get token

path Parameters
identifier
required
string

Token identifier

Responses

Response samples

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

deleteToken

Delete the supplied token

path Parameters
identifier
required
string

Token identifier

Responses

Response samples

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

patchToken

Patch 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

updateUpdateCycle

Set the preferred update cycle of Alumio

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

getMaintenanceWindowLogs

Get maintenance window logs

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

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

Notifier

sendNotifications

Send notifications

Responses

Response samples

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

getNotificationsInfo

Get usage info

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Oauth

oauthGetTokenKey

Get an Oauth token key

query Parameters
provider
object (OAuthTokenRequest)

Provider specification

key
string

The current key

callbackId
string

Id to return when receiving data

Responses

oauth1Callback

Handle OAuth1 callback request

query Parameters
oauth_token
string

OAuth token

oauth_verifier
string

OAuth verifier

Responses

oauth1InitializeToken

Initialize OAuth1 token request

query Parameters
object

Provider specification

key
string

The current key

callbackId
string

Id to return when receiving data

Responses

Publishers

export Deprecated

Deprecated. Use 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 Deprecated

Deprecated. Use 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"
}

Subscribers

consume Deprecated

Deprecated. Use queuePublish

path Parameters
subscriber
required
string

Subscriber identifier.

Responses

Response samples

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

consumeGetDeprecated Deprecated

Deprecated. Use queuePublish

path Parameters
subscriber
required
string

Subscriber identifier.

Responses

Response samples

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

Queue

queuePublish

Publish a job in the queue.

Request Body schema: application/json
object

Responses

Request samples

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

Response samples

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

getQueueProcessList

Get a list of queued processed.

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

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

getQueueProcess

Get a single process

path Parameters
process
required
string

Process identifier

Responses

Response samples

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

getQueueJob

Get a single job

path Parameters
job
required
string

Job identifier

Responses

Response samples

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

queueJobsSkipBulk

Skip jobs in bulk

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
}

queueJobsKillBulk

Kill jobs in bulk

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"
}

queueJobsStopBulk

Stop jobs in bulk

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

killBackgroundProcess

Kill a queued or running process.

path Parameters
identifier
required
string

Type identifier

Responses

Response samples

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

stopBackgroundProcess

Stop a running process.

path Parameters
identifier
required
string

Type identifier

Responses

Response samples

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

Reporting

getAllRoutes

Get routes across all spaces

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

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

postRoutesStatistics

Get the statistics of routes

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

Get status about routes and tasks

query Parameters
from
string

Start date

to
string

End date

route
string

Route identifier

Responses

Response samples

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

Routing

Get all available routes

Get all available routes

Responses

Response samples

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

Storage

storageCopy

Copy all storage items from the source too the target.

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
{ }

pruneStorages

Prune storages

query Parameters
identifier
string

Storage identifier.

Responses

Response samples

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

getStorageEntities

Get a list of storage entities

path Parameters
identifier
required
string

Storage identifier.

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

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

deleteStorageEntities

Delete multiple entities from a storage

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"
}

getStorageEntityContent Deprecated

Get the content of a stored entity.

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"
}

updateStorageEntityContent Deprecated

Modify the content of a stored entity.

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"
}

deleteStorageEntityContent Deprecated

Delete the content of a stored entity.

path Parameters
identifier
required
string

Storage identifier.

entity
required
string

Entity identifier.

Responses

Response samples

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

getStorageEntityContentV2

Get the content of a stored entity.

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"
}

updateStorageEntityContentV2

Modify the content of a stored entity.

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"
}

createStorageEntityContentV2

Create a new entity in a storage.

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"
}

deleteStorageEntityContentV2

Delete the content of a stored entity.

path Parameters
identifier
required
string

Storage identifier.

query Parameters
entity
required
string

Entity identifier.

Responses

Response samples

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

exportStorageEntitiesBulk

Export storage entities matching the filter

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"

emptyStorage

Empty the stored entities.

path Parameters
identifier
required
string

Storage identifier.

Responses

Response samples

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

getStorageMetadata

Get a list of storage metadata.

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

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

TaskLogger

getEnvironmentTaskLimits

Returns the current amount of tasks and limit.

Responses

Response samples

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

getEnvironmentTaskStatisticsTimeSeries

Get totals statistics for the environment aggregated by a timespan

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": [
    ]
}

getTaskLogStatistics

Get all statistics for 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": {
    }
}

getTaskStatistics

Get aggregated task statistics

query Parameters
filter
string

Apply search criteria

Responses

Response samples

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

SystemAdministrator

getSystemAdministrators

Get system administrators

query Parameters
filter
string

Apply search criteria

Responses

Response samples

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

createSystemAdministrator

Create a system 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": {
    }
}

getSystemAdministrator

Get the requested system administrator

path Parameters
email
required
string

Email address

Responses

Response samples

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

updateSystemAdministrator

Update a system 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": {
    }
}

deleteSystemAdministrator

Delete the supplied system administrator

path Parameters
email
required
string

User email

Responses

Response samples

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

Tasks

getTasks

Get tasks

query Parameters
filter
string

Apply search criteria.

Responses

Response samples

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

getTask

Get a task

path Parameters
identifier
required
string

Entry identifier

Responses

Response samples

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

retryTasksBulk

Retry tasks matching the filter

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
}

skipTasksBulk

Skip tasks matching the filter

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
}

resolveTasksBulk

Resolve tasks matching the filter

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
}

exportTasksBulk

Export tasks matching the filter

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

Responses

waitingToFinishedTasksBulk

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
}

waitingToFailedTasksBulk

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
}

pruneTasks

Prune tasks

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
}

repairStuckTasks

Repair stuck tasks

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"
}

updateWaitingTasks

Update tasks with waiting status in bulk

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

executeTransformer

Execute a transformer

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

getUiSchema

Get UI schema items per type

path Parameters
type
required
string

UI schema type

Responses

Response samples

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

Lolina

getUserEnvironments

Get a list of environments of the user

Responses

Response samples

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