API Calls

API calls can be grouped into the following categories:

Category

API Calls

Description

Authentication

Auth Token

Provides the access bearer token.

Computation

Compute Flow

Computes the flow identified with the ID {rflid}.

CRUD

Create Database

Creates a new database inside the environment identified by the ID {envId}.

Create Environment

Creates a new environment inside the environment identified by the ID {envId}.

Create Filesystem

Creates a new filesystem inside the environment identified by the ID {envId}.

Create Flow

Creates a new flow in the environment identified by the ID {envId}.

Create Macro

Creates a new macro inside the environment identified by the ID {envId}.

Create Source

Creates a new source in the environment identified with the ID {envId}.

Create Var Env

Creates a new environment variable inside the environment identified with the ID {envId}.

Delete Database

Deletes the database identified with the ID {sourceId}.

Delete Environment

Deletes the environment identified with the ID {environmentId}.

Delete Filesystem

Deletes the filesystem identified with the ID {sourceId}.

Delete Flow

Deletes the flow identified with the ID {flowId}.

Delete Macro

Deletes the macro identified with the ID {sourceId}.

Delete Repository

Deletes the repository, or multiple repositories, identified with the ID(s) <sourceId>.

Delete Var Env

Deletes one or more environment variables in the environment identified with the ID {envId}.

Delete Vault

Deletes the vault identified with the ID {sourceId}.

Rename Database

Renames the database identified with the ID {sourceId}.

Rename Environment

Renames the environment identified with the ID {envId}.

Rename Filesystem

Renames the filesystem identified with the ID {sourceId}.

Rename Flow

Renames the flow identified with the ID {rflId}.

Rename Macro

Renames the flow identified with the ID {rflId}.

Rename Var Env

Renames the environment variable identified with the ID {envId}.

Rename Vault

Renames the vault identified with the ID {sourceId}.

Set Stop Computation

Ends the computation of the flow identified with the ID {rflId}.

Set Var Env

Updates an existing environment variable in the environment identified with the ID {envId}.

Export

Export Flow

Exports one or more flows to a generic filesystem, identified by their {rflIds}.

Get

Get File

Downloads a file after an export operation performed on a local filesystem. The path parameter {fileId} can be a single ID or the concatenation of multiple IDs, separated by a '/'.

Get Resource ID

Returns the ID of the resource identified with the path {resourcePath} and the type {resourceType}.

Get Result

Gets the result of the request identified with the ID {reqId}.

Import

Import Flow

Imports one or more flows from a specified origin, placing them in the environment identified with the ID {envId}.

List

List Database

Lists the databases in the parent environment identified with the ID {envId}.

List Environment

Lists the environments contained in the parent environment identified with the ID {envId}.

List Filesystem

Lists the filesystem(s) contained in the parent environment, which is identified with the ID {envId}.

List Flow

Lists the flows in the parent environment identified with the ID {envId}.

List Macro

Lists the macros in the parent environment identified with the ID {envId}.

List Var Env

Lists the environment variables in the parent environment identified with the ID {envId}.

List Vault

Lists the vaults in the parent environment identified with the ID {envId}.