Overview

Login

Authenticate user via basic auth and create a server-side session with a HttpOnly cookie

Update Settings

Update settings. Note that this only updates file. For changes to take effect u have to restart instance.

List Generator Dirs

List all generator directory names inside `path.generators_dir` with generator configs.

Get Generator Config

Get generator configuration in the directory with specified name.

Create Generator Config

Create generator configuration in the directory with specified name.

Delete Generator Config

Delete whole generator configuration directory with specified name.

Update Generator Config

Update generator configuration in the directory with specified name.

Rename Generator Config

Rename generator configuration directory. Instances that use the configuration are repointed at the new directory and must be stopped beforehand.

Export Generator Config

Export generator directory with specified name as a ZIP archive. Entries named in `exclude` are left out with everything under them.

Import Generator Config

Import generator directory with specified name from a ZIP archive. The archive must hold a generator configuration, and the directory holding it becomes the root of the imported generator.

Get Generator Config Path

Get generator configuration path in the directory with specified name.

Get Generator File Tree

Get file tree of the generator directory with specified name.

Get Generator File

Read file from specified path inside generator directory with specified name. Set `download` to receive the file as an attachment instead of inline content.

Upload Generator File

Upload file to specified path inside generator directory with specified name.

Delete Generator File

Delete file in specified path inside generator directory with specified name.

Put Generator File

Put file to specified path inside generator directory with specified name.

Create Generator Directory

Create directory inside generator directory in specified path.

Move Generator File

Move file from source to destination location inside generator directory with specified name.

Copy Generator File

Copy file from source to destination location inside generator directory with specified name.

Release Event Plugin

Release event plugin with freeing acquired resource

Produce Events

Produce events using initialized event plugin

Get Template Event Plugin Local State

Get local state of template event plugin for the specified template by its alias

Update Template Event Plugin Local State

Patch local state of template event plugin for the specified template by its alias

Clear Template Event Plugin Local State

Clear local state of template event plugin for the specified template by its alias

Delete Template Event Plugin Local State Key

Delete a key from local state of template event plugin for the specified template by its alias

Get Template Event Plugin Shared State

Get shared state of template event plugin

Update Template Event Plugin Shared State

Patch shared state of template event plugin

Clear Template Event Plugin Shared State

Clear shared state of template event plugin

Delete Template Event Plugin Shared State Key

Delete a key from shared state of template event plugin

Get Event Plugin Global State

Get global state shared across all event plugins

Update Event Plugin Global State

Patch global state shared across all event plugins

Clear Event Plugin Global State

Clear global state shared across all event plugins

Delete Event Plugin Global State Key

Delete a key from global state shared across all event plugins

Normalize Versatile Datetime

Normalize versatile date time expression

Add Generator

Add generator. Note that `id` path parameter takes precedence over `id` field in the body.

Delete Generator

Remove generator by its id. Stop it in case it is running.

Update Generator

Update generator with provided parameters. Note that `id` path parameter takes precedence over `id` field in the body.

Rename Generator

Rename generator. The definition in the startup file is renamed along with the generator, and scenario membership is kept.

Get Generators In Startup

Get list of generator definitions in the startup file

Get Generator From Startup

Get generator definition from list in the startup file

Add Generator To Startup

Add generator definition to list in the startup file

Delete Generator From Startup

Delete generator definition from list in the startup file

Update Generator In Startup

Update generator definition in list in the startup file

Bulk Delete Generators From Startup

Bulk delete several generator definitions from list in the startup file

Delete Scenario

Delete scenario (remove tag from all generators)

Rename Scenario

Rename scenario (rewrite tag in all generators that carry it)

Remove Generator From Scenario

Remove generator from scenario

Get globals usage for a generator in a scenario

Detect globals usage in Jinja2 templates and Python scripts via AST analysis.

Delete Scenario Global State Key

Delete a key from global state

Get Scenario Global State

Get global state shared across all event plugins

Update Scenario Global State

Update global state shared across all event plugins

Clear Scenario Global State

Clear global state shared across all event plugins

Get Secret Value

Get secret with specified name from keyring

Delete Secret Value

Delete secret with specified name to keyring

Set Secret Value

Put secret with specified name to keyring. The name is what a configuration references as `${secrets.<name>}`, so it must be words of lowercase letters, digits and `_`, separated by `.`.

List Secret References

List what refers to the secret - the projects whose configuration reads it as `${secrets.<name>}`, and the connected repositories authenticating with it

Rename secret in keyring. The new name must be words of lowercase letters, digits and `_`, separated by `.`, since a configuration references it as `${secrets.<name>}`. Everything referring to the secret follows: the token is rewritten in the configuration of every project reading it, and every connected repository authenticating with it is repointed at the new name.

Login

Get Current User

Logout

Get Info

Get Settings