babylon

babylon

CLI used for cloud interactions between CosmoTech and multiple cloud environment

Usage:

babylon [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--verbosity, -v	text	Either CRITICAL, ERROR, WARNING, INFO or DEBUG	INFO
-n, --dry-run	boolean	Will run commands in dry-run mode.	False
--version	boolean	Print version number and return.	False
--log-path	directory	Path to the directory where log files will be stored. If not set, defaults to current working directory.	/home/runner/work/Babylon/Babylon
--help	boolean	Show this message and exit.	False

Subcommands

• api: Cosmotech API
• apply: Macro Apply
• destroy: Macro Destroy
• init:
• namespace: Babylon namespace

api

Cosmotech API

Usage:

babylon api [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• about:
• datasets: Datasets - Cosmotech API
• organizations: Organizations - Cosmotech API
• runners: Runners - Cosmotech API
• runs: Runs - Cosmotech API
• solutions: Solutions - Cosmotech API
• workspaces: Workspaces - Cosmotech API

about

Get the version of the API service

Usage:

babylon api about [OPTIONS]

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

datasets

Datasets - Cosmotech API

Usage:

babylon api datasets [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• create:
• create-part:
• delete: Delete a dataset
• delete-part:
• download-part: Download a dataset part
• get: Get a dataset
• get-all:
• get-all-parts:
• get-part: Get a dataset part
• search: Get dataset with the given tag from the organization
• search-parts:
• security: Group allowing dataset security management

create

Create a dataset

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace PAYLOAD_FILE : Path to the manifest file used to create the dataset

Usage:

babylon api datasets create [OPTIONS] ORGANIZATION_ID WORKSPACE_ID
                            PAYLOAD_FILE

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

create-part

Create a dataset part

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace DATASET_ID: The unique identifier of the datatset PAYLOAD_FILE : Path to the manifest file used to create the dataset

Usage:

babylon api datasets create-part [OPTIONS] ORGANIZATION_ID WORKSPACE_ID
                                 DATASET_ID PAYLOAD_FILE

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

delete

Delete a dataset

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace DATASET_ID: The unique identifier of the datatset

Usage:

babylon api datasets delete [OPTIONS] ORGANIZATION_ID WORKSPACE_ID DATASET_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-D	boolean	Force Delete	False
--help	boolean	Show this message and exit.	False

delete-part

Delete a dataset part

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace DATASET_ID: The unique identifier of the datatset DATASET_PART_ID : The unique identifier of the dataset_part_id

Usage:

babylon api datasets delete-part [OPTIONS] ORGANIZATION_ID WORKSPACE_ID
                                 DATASET_ID DATASET_PART_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-D	boolean	Force Delete	False
--help	boolean	Show this message and exit.	False

download-part

Download a dataset part

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace DATASET_ID: The unique identifier of the datatset DATASET_PART_ID : The unique identifier of the dataset_part_id

Usage:

babylon api datasets download-part [OPTIONS] ORGANIZATION_ID WORKSPACE_ID
                                   DATASET_ID DATASET_PART_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

get

Get a dataset

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace DATASET_ID: The unique identifier of the datatset

Usage:

babylon api datasets get [OPTIONS] ORGANIZATION_ID WORKSPACE_ID DATASET_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

get-all

Get all datasets from the organization

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace

Usage:

babylon api datasets get-all [OPTIONS] ORGANIZATION_ID WORKSPACE_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--filter	text	Filter response with a jmespath query	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

get-all-parts

Get all dataset parts

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace DATASET_ID: The unique identifier of the datatset

Usage:

babylon api datasets get-all-parts [OPTIONS] ORGANIZATION_ID WORKSPACE_ID
                                   DATASET_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

get-part

Get a dataset part

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace DATASET_ID: The unique identifier of the datatset DATASET_PART_ID : The unique identifier of the dataset_part_id

Usage:

babylon api datasets get-part [OPTIONS] ORGANIZATION_ID WORKSPACE_ID
                              DATASET_ID DATASET_PART_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

search

Get dataset with the given tag from the organization

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace TAG : A specific tag used to retrieve the dataset

Usage:

babylon api datasets search [OPTIONS] ORGANIZATION_ID WORKSPACE_ID [TAG]...

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

search-parts

Get dataset part with the given tag

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace DATASET_ID: The unique identifier of the datatset TAG : A specific tag used to retrieve the dataset

Usage:

babylon api datasets search-parts [OPTIONS] ORGANIZATION_ID WORKSPACE_ID
                                  DATASET_ID [TAG]...

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

security

Group allowing dataset security management

Usage:

babylon api datasets security [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• add:
• delete:
• get:
• get-all:
• set-default:
• update:

add

Add dataset users RBAC access

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace DATASET_ID: The unique identifier of the datatset

Usage:

babylon api datasets security add [OPTIONS] ORGANIZATION_ID WORKSPACE_ID
                                  DATASET_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--role	text	Role RBAC	Sentinel.UNSET
--email	text	Email valid	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

delete

Delete dataset users RBAC access

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace DATASET_ID: The unique identifier of the datatset

Usage:

babylon api datasets security delete [OPTIONS] ORGANIZATION_ID WORKSPACE_ID
                                     DATASET_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--email	text	Email valid	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

get

Get dataset user RBAC access

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace DATASET_ID: The unique identifier of the datatset

Usage:

babylon api datasets security get [OPTIONS] ORGANIZATION_ID WORKSPACE_ID
                                  DATASET_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--email	text	Email valid	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

get-all

Get dataset users access

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace

Usage:

babylon api datasets security get-all [OPTIONS] ORGANIZATION_ID WORKSPACE_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

set-default

Set the dataset default security

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace DATASET_ID: The unique identifier of the datatset

Usage:

babylon api datasets security set-default [OPTIONS] ORGANIZATION_ID
                                          WORKSPACE_ID DATASET_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--role	text	Role RBAC	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

update

Update dataset users RBAC access

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace DATASET_ID: The unique identifier of the datatset

Usage:

babylon api datasets security update [OPTIONS] ORGANIZATION_ID WORKSPACE_ID
                                     DATASET_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--email	text	Email valid	Sentinel.UNSET
--role	text	Role RBAC	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

organizations

Organizations - Cosmotech API

Usage:

babylon api organizations [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• create:
• delete:
• get:
• get-all:
• security: Group allowing organization security management
• update:

create

Register new organization

Args:

PAYLOAD_FILE : Path to the manifest file used to create the organization

Usage:

babylon api organizations create [OPTIONS] PAYLOAD_FILE

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

delete

Delete a specific organization

Args:

ORGANIZATION_ID: The unique identifier of the organization

Usage:

babylon api organizations delete [OPTIONS] ORGANIZATION_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-D	boolean	Force Delete	False
--help	boolean	Show this message and exit.	False

get

Get the details of a specific organization.

Args:

ORGANIZATION_ID: The unique identifier of the organization

Usage:

babylon api organizations get [OPTIONS] ORGANIZATION_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

get-all

Get all organizations details

Usage:

babylon api organizations get-all [OPTIONS]

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--filter	text	Filter response with a jmespath query	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

security

Group allowing organization security management

Usage:

babylon api organizations security [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• add:
• delete:
• get:
• get-all:
• set-default:
• update:

add

Add organization users RBAC access

Args:

ORGANIZATION_ID : The unique identifier of the organization

Usage:

babylon api organizations security add [OPTIONS] ORGANIZATION_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--role	text	Role RBAC	Sentinel.UNSET
--email	text	Email valid	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

delete

Delete organization users RBAC access

Args:

ORGANIZATION_ID : The unique identifier of the organization

Usage:

babylon api organizations security delete [OPTIONS] ORGANIZATION_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--email	text	Email valid	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

get

Get organization user RBAC access

Args:

ORGANIZATION_ID : The unique identifier of the organization

Usage:

babylon api organizations security get [OPTIONS] ORGANIZATION_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--email	text	Email valid	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

get-all

Get all RBAC access to the organization

Args:

ORGANIZATION_ID : The unique identifier of the organization

Usage:

babylon api organizations security get-all [OPTIONS] ORGANIZATION_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

set-default

Set default RBAC access to the organization

Args:

ORGANIZATION_ID : The unique identifier of the organization

Usage:

babylon api organizations security set-default [OPTIONS] ORGANIZATION_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--role	text	Role RBAC	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

update

Update organization users RBAC access

Args:

ORGANIZATION_ID : The unique identifier of the organization

Usage:

babylon api organizations security update [OPTIONS] ORGANIZATION_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--role	text	Role RBAC	Sentinel.UNSET
--email	text	Email valid	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

update

Update a specific organization.

Args:

ORGANIZATION_ID : The unique identifier of the organization PAYLOAD_FILE : Path to the manifest file used to update the organization

Usage:

babylon api organizations update [OPTIONS] ORGANIZATION_ID PAYLOAD_FILE

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

runners

Runners - Cosmotech API

Usage:

babylon api runners [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• create:
• delete:
• get:
• get-all:
• security: Group allowing runner security management
• start:
• stop:
• update:

create

Create new runner

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace PAYLOAD_FILE : Path to the manifest file used to update the workspace

Usage:

babylon api runners create [OPTIONS] ORGANIZATION_ID WORKSPACE_ID PAYLOAD_FILE

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

delete

Delete a runner

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace RUNNER_ID : The unique identifier of the runner

Usage:

babylon api runners delete [OPTIONS] ORGANIZATION_ID WORKSPACE_ID RUNNER_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-D	boolean	Force Delete	False
--help	boolean	Show this message and exit.	False

get

Get runner details

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace RUNNER_ID : The unique identifier of the runner

Usage:

babylon api runners get [OPTIONS] ORGANIZATION_ID WORKSPACE_ID RUNNER_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

get-all

Get all runners in the workspace

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace

Usage:

babylon api runners get-all [OPTIONS] ORGANIZATION_ID WORKSPACE_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--filter	text	Filter response with a jmespath query	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

security

Group allowing runner security management

Usage:

babylon api runners security [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• add:
• delete:
• get:
• get-all:
• set-default:
• update:

add

Add runner users RBAC access

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace RUNNER_ID : The unique identifier of the runner

Usage:

babylon api runners security add [OPTIONS] ORGANIZATION_ID WORKSPACE_ID
                                 RUNNER_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--role	text	Role RBAC	Sentinel.UNSET
--email	text	Valid email	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

delete

Delete runner RBAC access

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace RUNNER_ID : The unique identifier of the runner

Usage:

babylon api runners security delete [OPTIONS] ORGANIZATION_ID WORKSPACE_ID
                                    RUNNER_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--email	text	Email valid	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

get

Get runner RBAC access for user

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace RUNNER_ID : The unique identifier of the runner

Usage:

babylon api runners security get [OPTIONS] ORGANIZATION_ID WORKSPACE_ID
                                 RUNNER_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--email	text	Email valid	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

get-all

Get all runner RBAC access

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace RUNNER_ID : The unique identifier of the runner

Usage:

babylon api runners security get-all [OPTIONS] ORGANIZATION_ID WORKSPACE_ID
                                     RUNNER_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

set-default

Set the runner default security

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace RUNNER_ID : The unique identifier of the runner

Usage:

babylon api runners security set-default [OPTIONS] ORGANIZATION_ID
                                         WORKSPACE_ID RUNNER_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--role	text	Role RBAC	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

update

Update runner RBAC access for user

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace RUNNER_ID : The unique identifier of the runner

Usage:

babylon api runners security update [OPTIONS] ORGANIZATION_ID WORKSPACE_ID
                                    RUNNER_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--email	text	Email valid	Sentinel.UNSET
--role	text	Role RBAC	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

start

Start a runner run

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace RUNNER_ID : The unique identifier of the runner

Usage:

babylon api runners start [OPTIONS] ORGANIZATION_ID WORKSPACE_ID RUNNER_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

stop

Stop a runner run

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace RUNNER_ID : The unique identifier of the runner

Usage:

babylon api runners stop [OPTIONS] ORGANIZATION_ID WORKSPACE_ID RUNNER_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

update

Update a runner

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace RUNNER_ID : The unique identifier of the runner PAYLOAD_FILE : Path to the manifest file used to update the runner

Usage:

babylon api runners update [OPTIONS] ORGANIZATION_ID WORKSPACE_ID RUNNER_ID
                           PAYLOAD_FILE

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

runs

Runs - Cosmotech API

Usage:

babylon api runs [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• delete:
• get:
• get-all:
• logs:
• status:

delete

Delete the run

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace RUNNER_ID : The unique identifier of the runner RUN_ID: The unique identifier of the run

Usage:

babylon api runs delete [OPTIONS] ORGANIZATION_ID WORKSPACE_ID RUNNER_ID
                        RUN_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
-D	boolean	Force Delete	False
--help	boolean	Show this message and exit.	False

get

Get run details

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace RUNNER_ID : The unique identifier of the runner RUN_ID: The unique identifier of the run

Usage:

babylon api runs get [OPTIONS] ORGANIZATION_ID WORKSPACE_ID RUNNER_ID RUN_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

get-all

Get run details

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace RUNNER_ID : The unique identifier of the runner RUN_ID: The unique identifier of the run

Usage:

babylon api runs get-all [OPTIONS] ORGANIZATION_ID WORKSPACE_ID RUNNER_ID
                         RUN_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

logs

Get the logs for the Run

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace RUNNER_ID : The unique identifier of the runner RUN_ID: The unique identifier of the run

Usage:

babylon api runs logs [OPTIONS] ORGANIZATION_ID WORKSPACE_ID RUNNER_ID RUN_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

status

Get the status of the Run

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace RUNNER_ID : The unique identifier of the runner RUN_ID: The unique identifier of the run

Usage:

babylon api runs status [OPTIONS] ORGANIZATION_ID WORKSPACE_ID RUNNER_ID
                        RUN_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

solutions

Solutions - Cosmotech API

Usage:

babylon api solutions [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• create:
• delete:
• get:
• get-all:
• runtemplates: Group allowing solutions run Templates management
• security: Group allowing solutions security management
• update:

create

Register a new solution

Args:

ORGANIZATION_ID : The unique identifier of the organization PAYLOAD_FILE : Path to the manifest file used to update the solution

Usage:

babylon api solutions create [OPTIONS] ORGANIZATION_ID PAYLOAD_FILE

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

delete

Delete a specific solution

Args:

ORGANIZATION_ID : The unique identifier of the organization SOLUTION_ID : The unique identifier of the solution

Usage:

babylon api solutions delete [OPTIONS] ORGANIZATION_ID SOLUTION_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-D	boolean	Force Delete	False
--help	boolean	Show this message and exit.	False

get

Get a specific solution details

Args:

ORGANIZATION_ID : The unique identifier of the organization SOLUTION_ID : The unique identifier of the solution

Usage:

babylon api solutions get [OPTIONS] ORGANIZATION_ID SOLUTION_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

get-all

Get all solutions details

Args:

ORGANIZATION_ID : The unique identifier of the organization

Usage:

babylon api solutions get-all [OPTIONS] ORGANIZATION_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--filter	text	Filter response with a jmespath query	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

runtemplates

Group allowing solutions run Templates management

Usage:

babylon api solutions runtemplates [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• add:
• delete:
• get:
• get-all:
• update:

add

Add runTemplates to solution

Args:

ORGANIZATION_ID : The unique identifier of the organization SOLUTION_ID : The unique identifier of the solution PAYLOAD_FILE : Path to the manifest file used to add the runTemplates

Usage:

babylon api solutions runtemplates add [OPTIONS] ORGANIZATION_ID SOLUTION_ID
                                       PAYLOAD_FILE

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

delete

Delete solution runtemplate by id

Args:

ORGANIZATION_ID : The unique identifier of the organization SOLUTION_ID : The unique identifier of the solution RUNTEMPLATE_ID: The unique identifier of the runTemplate

Usage:

babylon api solutions runtemplates delete [OPTIONS] ORGANIZATION_ID
                                          SOLUTION_ID RUNTEMPLATE_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

get

Get RunTemplate in the solution by ID

Args:

ORGANIZATION_ID : The unique identifier of the organization SOLUTION_ID : The unique identifier of the solution PAYLOAD_FILE : Path to the manifest file used to add the runTemplates

Usage:

babylon api solutions runtemplates get [OPTIONS] ORGANIZATION_ID SOLUTION_ID
                                       RUNTEMPLATE_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

get-all

Get all RunTemplates in solution

Args:

ORGANIZATION_ID : The unique identifier of the organization SOLUTION_ID : The unique identifier of the solution

Usage:

babylon api solutions runtemplates get-all [OPTIONS] ORGANIZATION_ID
                                           SOLUTION_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

update

Update Run Template in the Solution by id

Args:

ORGANIZATION_ID : The unique identifier of the organization SOLUTION_ID : The unique identifier of the solution RUNTEMPLATE_ID: The unique identifier of the runTemplate PAYLOAD_FILE : Path to the manifest file used to add the runTemplates

Usage:

babylon api solutions runtemplates update [OPTIONS] ORGANIZATION_ID
                                          SOLUTION_ID RUNTEMPLATE_ID
                                          PAYLOAD_FILE

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

security

Group allowing solutions security management

Usage:

babylon api solutions security [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• add:
• delete:
• get:
• get-all:
• get-users:
• set-default:
• update:

add

Add solution users RBAC access

Args:

ORGANIZATION_ID : The unique identifier of the organization SOLUTION_ID : The unique identifier of the solution

Usage:

babylon api solutions security add [OPTIONS] ORGANIZATION_ID SOLUTION_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--role	text	Role RBAC	viewer
--email	text	Email valid	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

delete

Remove the specified access from the Solution

Args:

ORGANIZATION_ID : The unique identifier of the organization SOLUTION_ID : The unique identifier of the solution

Usage:

babylon api solutions security delete [OPTIONS] ORGANIZATION_ID SOLUTION_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--email	text	Email valid	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

get

Get solution users RBAC access

Args:

ORGANIZATION_ID : The unique identifier of the organization SOLUTION_ID : The unique identifier of the solution

Usage:

babylon api solutions security get [OPTIONS] ORGANIZATION_ID SOLUTION_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--email	text	Email valid	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

get-all

Get all RBAC access to the Solution

Args:

ORGANIZATION_ID : The unique identifier of the organization SOLUTION_ID : The unique identifier of the solution

Usage:

babylon api solutions security get-all [OPTIONS] ORGANIZATION_ID SOLUTION_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

get-users

Get the Solution security users list

Args:

ORGANIZATION_ID : The unique identifier of the organization SOLUTION_ID : The unique identifier of the solution

Usage:

babylon api solutions security get-users [OPTIONS] ORGANIZATION_ID SOLUTION_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

set-default

Set the Solution default security

Args:

ORGANIZATION_ID : The unique identifier of the organization SOLUTION_ID : The unique identifier of the solution

Usage:

babylon api solutions security set-default [OPTIONS] ORGANIZATION_ID
                                           SOLUTION_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--role	text	Role RBAC	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

update

Update solution users RBAC access

Args:

ORGANIZATION_ID : The unique identifier of the organization PAYLOAD_FILE : Path to the manifest file used to update the organization

Usage:

babylon api solutions security update [OPTIONS] ORGANIZATION_ID SOLUTION_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
--email	text	Email valid	Sentinel.UNSET
--role	text	Role RBAC	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

update

Update a specific solution

Args:

ORGANIZATION_ID : The unique identifier of the organization SOLUTION_ID : The unique identifier of the solution PAYLOAD_FILE : Path to the manifest file used to update the solution

Usage:

babylon api solutions update [OPTIONS] ORGANIZATION_ID SOLUTION_ID
                             PAYLOAD_FILE

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

workspaces

Workspaces - Cosmotech API

Usage:

babylon api workspaces [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• create:
• delete:
• get:
• get-all:
• security: Group allowing workspace security management
• update:

create

Register a specific workspace

Args:

ORGANIZATION_ID : The unique identifier of the organization PAYLOAD_FILE : Path to the manifest file used to update the workspace

Usage:

babylon api workspaces create [OPTIONS] ORGANIZATION_ID PAYLOAD_FILE

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

delete

Delete a specific workspace

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace

Usage:

babylon api workspaces delete [OPTIONS] ORGANIZATION_ID WORKSPACE_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-D	boolean	Force Delete	False
--help	boolean	Show this message and exit.	False

get

Get a workspace details

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace

Usage:

babylon api workspaces get [OPTIONS] ORGANIZATION_ID WORKSPACE_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

get-all

Get all workspaces details

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace

Usage:

babylon api workspaces get-all [OPTIONS] ORGANIZATION_ID WORKSPACE_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--filter	text	Filter response with a jmespath query	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

security

Group allowing workspace security management

Usage:

babylon api workspaces security [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• add:
• delete:
• get:
• get-all:
• set-default:
• update:

add

Add workspace users RBAC access

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace

Usage:

babylon api workspaces security add [OPTIONS] ORGANIZATION_ID WORKSPACE_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--role	text	Role RBAC	viewer
--email	text	Email valid	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

delete

Delete workspace users RBAC access

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace

Usage:

babylon api workspaces security delete [OPTIONS] ORGANIZATION_ID WORKSPACE_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--email	text	Email valid	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

get

Get workspace users RBAC access

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace

Usage:

babylon api workspaces security get [OPTIONS] ORGANIZATION_ID WORKSPACE_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--email	text	Email valid	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

get-all

Get all RBAC access for the workspace

Usage:

babylon api workspaces security get-all [OPTIONS] ORGANIZATION_ID WORKSPACE_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

set-default

Set default RBAC access to workspace

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace

Usage:

babylon api workspaces security set-default [OPTIONS] ORGANIZATION_ID
                                            WORKSPACE_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--role	text	Role RBAC	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

update

Update workspace users RBAC access

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace

Usage:

babylon api workspaces security update [OPTIONS] ORGANIZATION_ID WORKSPACE_ID

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--role	text	Role RBAC	Sentinel.UNSET
--email	text	Email valid	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

update

Update a specific workspace

Args:

ORGANIZATION_ID : The unique identifier of the organization WORKSPACE_ID : The unique identifier of the workspace PAYLOAD_FILE : Path to the manifest file used to update the workspace

Usage:

babylon api workspaces update [OPTIONS] ORGANIZATION_ID WORKSPACE_ID
                              PAYLOAD_FILE

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
-o, --output	text	File to which content should be outputted	Sentinel.UNSET
--help	boolean	Show this message and exit.	False

apply

Macro Apply

Usage:

babylon apply [OPTIONS] DEPLOY_DIR

Options:

Name	Type	Description	Default
-c, --context	text	Context Name without any special character	Sentinel.UNSET
-t, --tenant	text	Tenant Id without any special character	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
--var-file	path	Specify the path of your variable file. By default, it takes the variables.yaml file.	['./variables.yaml']
--organization	boolean	Deploy or update an organization.	False
--solution	boolean	Deploy or update a solution.	False
--workspace	boolean	Deploy or update a workspace.	False
--dataset	boolean	Deploy or update a dataset.	False
--runner	boolean	Deploy or update a runner.	False
--payload-only	boolean	Specify if you want to specify payload only	False
--help	boolean	Show this message and exit.	False

destroy

Macro Destroy

Usage:

babylon destroy [OPTIONS]

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

init

Create a Babylon project structure using YAML templates.

Usage:

babylon init [OPTIONS]

Options:

Name	Type	Description	Default
--project-folder	text	Name of the project folder to create (default: 'project').	project
--variables-file	text	Name of the variables file (default: 'variables.yaml').	variables.yaml
--help	boolean	Show this message and exit.	False

namespace

Babylon namespace

Usage:

babylon namespace [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• get-contexts: Display the currently active namespace
• get-states: Display all states in your local machine
• use: Switch to a specific Babylon namespace or create a new one

get-contexts

Display the currently active namespace

Usage:

babylon namespace get-contexts [OPTIONS]

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

get-states

Display all states in your local machine

Usage:

babylon namespace get-states [OPTIONS]

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

use

Switch to a specific Babylon namespace or create a new one

Usage:

babylon namespace use [OPTIONS]

Options:

Name	Type	Description	Default
-c, --context	text	Context Name	Sentinel.UNSET
-t, --tenant	text	Tenant Name	Sentinel.UNSET
-s, --state-id	text	State Id	Sentinel.UNSET
--help	boolean	Show this message and exit.	False