### Marketplace - Install JPS manifest

Source: https://context7.com/yoanbernabeu/gojelastic/llms.txt

Install applications and services using Jelastic Packaging Standard (JPS) manifests from marketplace or custom sources.

```APIDOC
## POST /api/marketplace/install

### Description
Install applications and services using Jelastic Packaging Standard (JPS) manifests from marketplace or custom sources.

### Method
POST

### Endpoint
/api/marketplace/install

### Parameters
#### Query Parameters
- **token** (string) - Required - Authentication token.
- **url** (string) - Required - API endpoint URL.
- **jps** (string) - Required - URL of the JPS manifest.
- **envName** (string) - Required - Name for the new environment.
- **envGroups** (string) - Optional - Comma-separated list of environment groups.

### Request Example
```bash
GoJelastic install \
  --token=d7f8a9c2b1e3f4d5a6b7c8d9e0f1a2b3 \
  --url=https://app.jelastic.com/1.0 \
  --jps=https://raw.githubusercontent.com/example/manifests/main/wordpress.yml \
  --envName=my-wordpress-site \
  --envGroups=production
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of installation.

#### Response Example
```json
{
    "result": 0,
    "message": "Installation initiated successfully."
}
```
```

--------------------------------

### Install GoJelastic CLI with wget (Bash)

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/index.md

Installs the GoJelastic CLI on Linux or Darwin using wget to download and execute the installation script. This method is suitable for automated environments.

```bash
wget -qO- https://raw.githubusercontent.com/yoanbernabeu/GoJelastic/main/install.sh | bash
```

--------------------------------

### Install Custom JPS Manifest

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic_install.md

Installs a custom JPS manifest by specifying the JPS URL, environment name, and optionally environment groups, token, and URL.

```APIDOC
## POST /yoanbernabeu/gojelastic/install

### Description
Installs a custom JPS manifest using the GoJelastic CLI. This command requires a JPS manifest URL and an environment name. It also accepts optional environment groups, token, and URL for more specific installations.

### Method
POST

### Endpoint
/yoanbernabeu/gojelastic/install

### Parameters
#### Query Parameters
- **jps** (string) - Required - A JPS manifest URL.
- **envName** (string) - Required - An environment name.
- **envGroups** (string) - Optional - An environment group.
- **token** (string) - Required - A token for authentication.
- **url** (string) - Required - The URL for the Jelastic instance.

### Request Example
```json
{
  "jps": "http://example.com/manifest.jps",
  "envName": "my-environment",
  "envGroups": "production",
  "token": "your_api_token",
  "url": "https://app.jelastic.com"
}
```

### Response
#### Success Response (200)
This endpoint typically returns a success message or status upon successful installation. The exact response structure may vary.

#### Response Example
```json
{
  "status": "success",
  "message": "JPS manifest installed successfully."
}
```
```

--------------------------------

### GoJelastic Start Environment

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic.md

Starts a specified Jelastic environment. This command is used to bring an environment online and make its applications accessible.

```bash
gojelastic startEnv --environment <env_name>
```

--------------------------------

### Install GoJelastic CLI with curl (Bash)

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/index.md

Installs the GoJelastic CLI on Linux or Darwin using curl to download and execute the installation script. This is an alternative to wget for automated installations.

```bash
curl -sL https://raw.githubusercontent.com/yoanbernabeu/GoJelastic/main/install.sh | bash
```

--------------------------------

### Get Account by Session using GoJelastic CLI

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic_getAccount.md

This snippet demonstrates how to use the GoJelastic CLI to retrieve account information by session. It requires a valid token, URL, and appid. The command's synopsis and example usage are provided.

```bash
GoJelastic getAccount [flags]

GoJelastic billing/account getAccount --token=token --url=url --appid=appid
```

--------------------------------

### Install JPS Manifest with GoJelastic CLI

Source: https://context7.com/yoanbernabeu/gojelastic/llms.txt

Installs applications and services using Jelastic Packaging Standard (JPS) manifests. This command automates the deployment of complex application stacks, databases, and multi-tier applications. It requires authentication token, API URL, JPS manifest URL, environment name, and optionally environment groups.

```bash
# Install a JPS manifest from URL
GoJelastic install \
  --token=d7f8a9c2b1e3f4d5a6b7c8d9e0f1a2b3 \
  --url=https://app.jelastic.com/1.0 \
  --jps=https://raw.githubusercontent.com/example/manifests/main/wordpress.yml \
  --envName=my-wordpress-site \
  --envGroups=production

# JPS manifests automate deployment of:
# - Complete application stacks (WordPress, Magento, etc.)
# - Database clusters with replication
# - Load-balanced multi-tier applications
# - Development environments with tooling

# The manifest URL is automatically URL-encoded
# Installation process:
# 1. Downloads and validates JPS manifest
# 2. Provisions required infrastructure
# 3. Configures nodes and networking
# 4. Runs initialization scripts
# 5. Returns environment details upon completion

# Example with custom manifest:
# GoJelastic install \
#   --token=$JELASTIC_TOKEN \
#   --url=$JELASTIC_URL \
#   --jps=https://my-company.com/deploy/microservice.jps \
#   --envName=auth-service-prod \
#   --envGroups=microservices,production
```

--------------------------------

### Get Environment List using GoJelastic CLI

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic_getList.md

The `getList` command retrieves a list of an environment from Jelastic. It requires authentication tokens and the application ID. Ensure you have the GoJelastic CLI installed and configured with valid credentials.

```bash
GoJelastic getList --token=token --url=url --appid=appid
```

--------------------------------

### Install Custom JPS Manifest with GoJelastic

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic_install.md

Installs a custom JPS manifest using the GoJelastic CLI. This command requires a JPS manifest URL and an environment name. Optional parameters include environment groups, an authentication token, and a Jelastic platform URL.

```bash
GoJelastic install --token=token --url=url --jps=jps --envName=envName --envGroups=envGroups
```

--------------------------------

### Get Billing History by Period with GoJelastic CLI

Source: https://context7.com/yoanbernabeu/gojelastic/llms.txt

Retrieves detailed billing history for a specific time period, including resource usage and costs breakdown. This command is essential for monthly cost analysis, budget forecasting, and identifying cost optimization opportunities. It requires authentication token, API URL, application ID, start time, and end time.

```bash
# Get billing history for a date range
GoJelastic getExtendedAccountBillingHistoryByPeriod \
  --token=d7f8a9c2b1e3f4d5a6b7c8d9e0f1a2b3 \
  --url=https://app.jelastic.com/1.0 \
  --appid=my-production-app \
  --startTime=2024-01-01 \
  --endTime=2024-01-31

# Returns itemized billing information:
# - Daily cost breakdown
# - Resource usage by environment
# - Cost by resource type (compute, storage, traffic)
# - Reserved vs. dynamic cloudlet usage

# Useful for:
# - Monthly cost analysis and reporting
# - Budget forecasting
# - Cost optimization identification
# - Chargeback to internal teams
# - Audit and compliance requirements

# Timestamps can be in various formats:
# - YYYY-MM-DD (date)
# - Unix timestamp (seconds)
# - ISO 8601 format
```

--------------------------------

### Build GoJelastic CLI from Source (Bash)

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/index.md

Builds the GoJelastic CLI from its source code. This requires Go to be installed on the system. It clones the repository, navigates to the directory, and then compiles the binary.

```bash
git clone git@github.com:yoanbernabeu/GoJelastic.git
cd GoJelastic
go build -o GoJelastic
```

--------------------------------

### Security - Get firewall rules

Source: https://context7.com/yoanbernabeu/gojelastic/llms.txt

Retrieve all firewall rules configured for an environment, showing allowed ports, protocols, and source restrictions.

```APIDOC
## GET /api/firewall/rules

### Description
Retrieve all firewall rules configured for an environment, showing allowed ports, protocols, and source restrictions.

### Method
GET

### Endpoint
/api/firewall/rules

### Parameters
#### Query Parameters
- **token** (string) - Required - Authentication token.
- **url** (string) - Required - API endpoint URL.
- **appid** (string) - Required - Application ID.

### Request Example
```bash
GoJelastic getRules --token=d7f8a9c2b1e3f4d5a6b7c8d9e0f1a2b3 --url=https://app.jelastic.com/1.0 --appid=my-production-app
```

### Response
#### Success Response (200)
- **rules** (array) - List of firewall rules.
  - **direction** (string) - Rule direction (e.g., INPUT).
  - **protocol** (string) - Protocol (e.g., TCP).
  - **ports** (string) - Allowed ports (e.g., "80,443").
  - **src** (string) - Source IP address range (e.g., "0.0.0.0/0").
  - **priority** (integer) - Rule priority.
  - **action** (string) - Action (e.g., ALLOW).

#### Response Example
```json
{
    "result": 0,
    "rules": [
        {
            "direction": "INPUT",
            "protocol": "TCP",
            "ports": "80,443",
            "src": "0.0.0.0/0",
            "priority": 100,
            "action": "ALLOW"
        },
        {
            "direction": "INPUT",
            "protocol": "TCP",
            "ports": "22",
            "src": "10.0.0.0/8",
            "priority": 200,
            "action": "ALLOW"
        }
    ]
}
```
```

--------------------------------

### GoJelastic Install Custom JPS Manifest

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic.md

Installs a custom Jelastic Packaging Standard (JPS) manifest. This allows for the deployment of custom application stacks or complex configurations.

```bash
gojelastic install --jps-file <path_to_jps_file>
```

--------------------------------

### GoJelastic Generate Documentation

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic.md

Generates documentation for the GoJelastic CLI. This command is useful for creating or updating user guides and API references.

```bash
gojelastic documentation
```

--------------------------------

### GoJelastic Get All Environments

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic.md

Retrieves information about all environments associated with a user's Jelastic account. This provides an overview of all active and inactive environments.

```bash
gojelastic getEnvs
```

--------------------------------

### Get Account Billing Information with GoJelastic CLI

Source: https://context7.com/yoanbernabeu/gojelastic/llms.txt

Retrieves billing account details and current balance information for the authenticated session. This command is useful for monitoring costs and account status. It requires authentication token, API URL, and application ID.

```bash
# Get billing account information
GoJelastic getAccount \
  --token=d7f8a9c2b1e3f4d5a6b7c8d9e0f1a2b3 \
  --url=https://app.jelastic.com/1.0 \
  --appid=my-production-app

# Response includes:
# {
#     "result": 0,
#     "account": {
#         "balance": 125.50,
#         "currency": "USD",
#         "status": "ACTIVE",
#         "paymentMethod": "CREDIT_CARD"
#     }
# }

# Use for monitoring costs and account status
```

--------------------------------

### Get Firewall Rules with GoJelastic CLI

Source: https://context7.com/yoanbernabeu/gojelastic/llms.txt

Retrieves all firewall rules for a specified environment. This command is useful for security auditing, troubleshooting connectivity, and verifying network configurations. It requires authentication token, API URL, and application ID.

```bash
# Get firewall rules for an environment
GoJelastic getRules --token=d7f8a9c2b1e3f4d5a6b7c8d9e0f1a2b3 --url=https://app.jelastic.com/1.0 --appid=my-production-app

# Response includes comprehensive firewall configuration:
# {
#     "result": 0,
#     "rules": [
#         {
#             "direction": "INPUT",
#             "protocol": "TCP",
#             "ports": "80,443",
#             "src": "0.0.0.0/0",
#             "priority": 100,
#             "action": "ALLOW"
#         },
#         {
#             "direction": "INPUT",
#             "protocol": "TCP",
#             "ports": "22",
#             "src": "10.0.0.0/8",
#             "priority": 200,
#             "action": "ALLOW"
#         }
#     ]
# }

# Use for:
# - Security auditing
# - Troubleshooting connectivity issues
# - Compliance documentation
# - Network configuration verification
```

--------------------------------

### Install Zsh Autocompletion for New Sessions (Linux)

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic_completion_zsh.md

Installs the GoJelastic autocompletion script for all new zsh sessions on Linux by saving it to the first directory in the fpath array.

```zsh
GoJelastic completion zsh > "${fpath[1]}/_GoJelastic"
```

--------------------------------

### Get User Info with GoJelastic CLI

Source: https://context7.com/yoanbernabeu/gojelastic/llms.txt

Retrieves detailed information about the authenticated user account, including profile details and permissions. This command is useful for verifying authentication, checking permissions, and monitoring quota usage. It requires an authentication token and API URL.

```bash
# Get current user information
GoJelastic getUserInfo --token=d7f8a9c2b1e3f4d5a6b7c8d9e0f1a2b3 --url=https://app.jelastic.com/1.0

# Response includes:
# {
#     "result": 0,
#     "uid": 12345,
#     "email": "user@example.com",
#     "name": "John Doe",
#     "status": "ACTIVE",
#     "role": "USER",
#     "quota": {
#         "environment": {
#             "max": 10,
#             "current": 5
#         }
#     }
# }

# Useful for:
# - Verifying authentication
# - Checking account permissions
# - Monitoring quota usage
# - Retrieving user metadata for automation
```

--------------------------------

### User Management - Get user account information

Source: https://context7.com/yoanbernabeu/gojelastic/llms.txt

Retrieve detailed information about the authenticated user account, including profile details and permissions.

```APIDOC
## GET /api/user/info

### Description
Retrieve detailed information about the authenticated user account, including profile details and permissions.

### Method
GET

### Endpoint
/api/user/info

### Parameters
#### Query Parameters
- **token** (string) - Required - Authentication token.
- **url** (string) - Required - API endpoint URL.

### Request Example
```bash
GoJelastic getUserInfo --token=d7f8a9c2b1e3f4d5a6b7c8d9e0f1a2b3 --url=https://app.jelastic.com/1.0
```

### Response
#### Success Response (200)
- **uid** (integer) - User ID.
- **email** (string) - User email address.
- **name** (string) - User's full name.
- **status** (string) - User account status.
- **role** (string) - User role.
- **quota** (object) - User's resource quota.
  - **environment** (object) - Environment quota details.
    - **max** (integer) - Maximum allowed environments.
    - **current** (integer) - Current number of environments.

#### Response Example
```json
{
    "result": 0,
    "uid": 12345,
    "email": "user@example.com",
    "name": "John Doe",
    "status": "ACTIVE",
    "role": "USER",
    "quota": {
        "environment": {
            "max": 10,
            "current": 5
        }
    }
}
```
```

--------------------------------

### Install Zsh Autocompletion for New Sessions (macOS)

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic_completion_zsh.md

Installs the GoJelastic autocompletion script for all new zsh sessions on macOS using Homebrew's prefix to determine the correct site-functions directory.

```zsh
GoJelastic completion zsh > $(brew --prefix)/share/zsh/site-functions/_GoJelastic
```

--------------------------------

### Billing - Get account billing information

Source: https://context7.com/yoanbernabeu/gojelastic/llms.txt

Retrieve billing account details and current balance information for the authenticated session.

```APIDOC
## GET /api/billing/account

### Description
Retrieve billing account details and current balance information for the authenticated session.

### Method
GET

### Endpoint
/api/billing/account

### Parameters
#### Query Parameters
- **token** (string) - Required - Authentication token.
- **url** (string) - Required - API endpoint URL.
- **appid** (string) - Required - Application ID.

### Request Example
```bash
GoJelastic getAccount \
  --token=d7f8a9c2b1e3f4d5a6b7c8d9e0f1a2b3 \
  --url=https://app.jelastic.com/1.0 \
  --appid=my-production-app
```

### Response
#### Success Response (200)
- **account** (object) - Billing account details.
  - **balance** (number) - Current account balance.
  - **currency** (string) - Currency of the balance.
  - **status** (string) - Account status (e.g., ACTIVE).
  - **paymentMethod** (string) - Payment method.

#### Response Example
```json
{
    "result": 0,
    "account": {
        "balance": 125.50,
        "currency": "USD",
        "status": "ACTIVE",
        "paymentMethod": "CREDIT_CARD"
    }
}
```
```

--------------------------------

### Get Account by Session

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic_getAccount.md

Retrieves account details associated with the current session using the provided authentication token and application ID.

```APIDOC
## GET /api/account

### Description
Retrieves account details by session. This endpoint fetches information about the account linked to the current user session.

### Method
GET

### Endpoint
/api/account

### Parameters
#### Query Parameters
- **token** (string) - Required - Authentication token for the session.
- **url** (string) - Required - The base URL of the GoJelastic service.
- **appid** (string) - Required - The application ID to use for the request.

### Request Example
```json
{
  "query": {
    "token": "your_auth_token",
    "url": "https://api.gojelastic.com",
    "appid": "your_app_id"
  }
}
```

### Response
#### Success Response (200)
- **accountId** (string) - The unique identifier for the account.
- **accountName** (string) - The name of the account.
- **email** (string) - The primary email address associated with the account.

#### Response Example
```json
{
  "accountId": "acc_12345",
  "accountName": "Example Corp",
  "email": "contact@example.com"
}
```
```

--------------------------------

### getContainerEnvVars - Get Container Environment Variables

Source: https://context7.com/yoanbernabeu/gojelastic/llms.txt

Retrieves all environment variables configured for a specific container node.

```APIDOC
## GET /getContainerEnvVars

### Description
Get all environment variables for a specific container node.

### Method
GET

### Endpoint
/getContainerEnvVars

### Parameters
#### Query Parameters
- **token** (string) - Required - Authentication token.
- **url** (string) - Required - API endpoint URL.
- **appid** (string) - Required - Environment name.
- **nodeid** (string) - Required - Unique identifier of the container node.

### Request Example
```bash
GoJelastic getContainerEnvVars \
  --token=d7f8a9c2b1e3f4d5a6b7c8d9e0f1a2b3 \
  --url=https://app.jelastic.com/1.0 \
  --appid=my-production-app \
  --nodeid=123456
```

### Response
#### Success Response (200)
- **object** (object) - An object containing environment variables as key-value pairs.
```

--------------------------------

### GoJelastic Get Environment Information

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic.md

Retrieves comprehensive information about a specific Jelastic environment. This includes details about nodes, configurations, and services within the environment.

```bash
gojelastic getEnv --environment <env_name>
```

--------------------------------

### GoJelastic Get Environment List

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic.md

Retrieves a list of items or resources associated with a specific environment. The exact nature of the 'list' depends on the context of the environment.

```bash
gojelastic getList --environment <env_name>
```

--------------------------------

### getNodeGroups - Get Node Group Information

Source: https://context7.com/yoanbernabeu/gojelastic/llms.txt

Retrieves detailed information about a specific node group within an environment.

```APIDOC
## GET /getNodeGroups

### Description
Get detailed information about a specific node group within an environment.

### Method
GET

### Endpoint
/getNodeGroups

### Parameters
#### Query Parameters
- **token** (string) - Required - Authentication token.
- **url** (string) - Required - API endpoint URL.
- **appid** (string) - Required - Environment name.
- **nodeid** (string) - Required - The identifier of the node group (e.g., 'cp').

### Request Example
```bash
GoJelastic getNodeGroups \
  --token=d7f8a9c2b1e3f4d5a6b7c8d9e0f1a2b3 \
  --url=https://app.jelastic.com/1.0 \
  --appid=my-production-app \
  --nodeid=cp
```

### Response
#### Success Response (200)
- **nodeGroupDetails** (object) - An object containing details about the node group, including scaling configuration and resource limits.
```

--------------------------------

### GoJelastic Get Container Environment Variables

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic.md

Fetches the environment variables for a specific container. This command helps in diagnosing and understanding container configurations.

```bash
gojelastic getContainerEnvVars --environment <env_name> --node <node_name>
```

--------------------------------

### Enable Zsh Shell Completion

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic_completion_zsh.md

Enables shell completion for zsh by adding the necessary commands to the ~/.zshrc file. This is a one-time setup required before loading autocompletions.

```zsh
echo "autoload -U compinit; compinit" >> ~/.zshrc
```

--------------------------------

### GoJelastic Get Firewall Rules

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic.md

Provides information about the firewall rules configured for a Jelastic environment. This command is crucial for network security and access control.

```bash
gojelastic getRules --environment <env_name>
```

--------------------------------

### Billing - Get extended account billing history by period

Source: https://context7.com/yoanbernabeu/gojelastic/llms.txt

Retrieve detailed billing history for a specific time period, including resource usage and costs breakdown.

```APIDOC
## GET /api/billing/history

### Description
Retrieve detailed billing history for a specific time period, including resource usage and costs breakdown.

### Method
GET

### Endpoint
/api/billing/history

### Parameters
#### Query Parameters
- **token** (string) - Required - Authentication token.
- **url** (string) - Required - API endpoint URL.
- **appid** (string) - Required - Application ID.
- **startTime** (string) - Required - Start of the time period (YYYY-MM-DD or Unix timestamp).
- **endTime** (string) - Required - End of the time period (YYYY-MM-DD or Unix timestamp).

### Request Example
```bash
GoJelastic getExtendedAccountBillingHistoryByPeriod \
  --token=d7f8a9c2b1e3f4d5a6b7c8d9e0f1a2b3 \
  --url=https://app.jelastic.com/1.0 \
  --appid=my-production-app \
  --startTime=2024-01-01 \
  --endTime=2024-01-31
```

### Response
#### Success Response (200)
- **history** (array) - List of billing history items.
  - **date** (string) - Date of the billing entry.
  - **environment** (string) - Environment name.
  - **resourceType** (string) - Type of resource.
  - **cost** (number) - Cost for the entry.

#### Response Example
```json
{
    "result": 0,
    "history": [
        {
            "date": "2024-01-01",
            "environment": "my-app-env",
            "resourceType": "compute",
            "cost": 5.75
        }
        // ... more entries
    ]
}
```
```

--------------------------------

### GoJelastic Get Available Regions

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic.md

Fetches a list of available regions where Jelastic services can be deployed. This is important for selecting optimal deployment locations based on latency or compliance.

```bash
gojelastic getRegions
```

--------------------------------

### GoJelastic Get User Information

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic.md

Retrieves information about the currently logged-in user. This command helps in verifying user identity and accessing user-specific details.

```bash
gojelastic getUserInfo
```

--------------------------------

### GoJelastic Get Account Information

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic.md

Retrieves account details by providing a session identifier. This command is crucial for accessing user-specific information within the Jelastic platform.

```bash
gojelastic getAccount --session <session_id>
```

--------------------------------

### Get Container Environment Variables

Source: https://context7.com/yoanbernabeu/gojelastic/llms.txt

Retrieve all environment variables configured for a specific container node. This command is useful for debugging, verifying credentials, and auditing settings. It requires the authentication token, Jelastic API URL, application ID, and the target node ID.

```bash
# Get environment variables for a specific container
GoJelastic getContainerEnvVars \
  --token=d7f8a9c2b1e3f4d5a6b7c8d9e0f1a2b3 \
  --url=https://app.jelastic.com/1.0 \
  --appid=my-production-app \
  --nodeid=123456

# Useful for:
# - Debugging configuration issues
# - Verifying secrets and credentials are properly set
# - Auditing environment-specific settings

# Response includes all environment variables:
# {
#     "result": 0,
#     "object": {
#         "DATABASE_URL": "postgres://user:pass@db.example.com/mydb",
#         "API_KEY": "sk_live_abc123",
#         "NODE_ENV": "production"
#     }
# }
```

--------------------------------

### GoJelastic Generate Autocompletion Script

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic.md

Generates an autocompletion script for the specified shell, aiding in command-line efficiency. This command requires the GoJelastic CLI to be installed and configured.

```bash
gojelastic completion <shell>
```

--------------------------------

### GoJelastic Get Group List

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic.md

Retrieves a list of groups within the Jelastic platform. This command might be used for managing user permissions or resource segregation.

```bash
gojelastic getGroups
```

--------------------------------

### Get Node Group Information

Source: https://context7.com/yoanbernabeu/gojelastic/llms.txt

Retrieve detailed information about a specific node group within an environment. This includes details on scaling configurations and resource limits, crucial for performance tuning and capacity planning. The command requires authentication, Jelastic API URL, application ID, and the node group ID.

```bash
# Get node group details
GoJelastic getNodeGroups \
  --token=d7f8a9c2b1e3f4d5a6b7c8d9e0f1a2b3 \
  --url=https://app.jelastic.com/1.0 \
  --appid=my-production-app \
  --nodeid=cp

# Common node group identifiers:

```

--------------------------------

### GoJelastic Get Node Groups

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic.md

Retrieves data related to node groups within the Jelastic infrastructure. This command is essential for understanding the organization and capabilities of compute resources.

```bash
gojelastic getNodeGroups
```

--------------------------------

### GoJelastic Get Extended Account Billing History

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic.md

Fetches extended account billing history for a specified period. This command is useful for detailed financial analysis and tracking of Jelastic usage costs.

```bash
gojelastic getExtendedAccountBillingHistoryByPeriod --start-date <YYYY-MM-DD> --end-date <YYYY-MM-DD>
```

--------------------------------

### Get Container Environment Variables (Go CLI)

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic_getContainerEnvVars.md

This Go CLI command retrieves environment variables for a specified container within the Jelastic environment. It requires authentication credentials (token, url) and container identifiers (appid, nodeid). The command is auto-generated by spf13/cobra.

```bash
GoJelastic getContainerEnvVars --token=token --url=url --appid=appid --nodeid=nodeid
```

--------------------------------

### getList - Export Environment Manifest

Source: https://context7.com/yoanbernabeu/gojelastic/llms.txt

Exports the complete environment configuration as a manifest.

```APIDOC
## GET /getList

### Description
Export the complete environment configuration as a manifest.

### Method
GET

### Endpoint
/getList

### Parameters
#### Query Parameters
- **token** (string) - Required - Authentication token.
- **url** (string) - Required - API endpoint URL.
- **appid** (string) - Required - Environment name.

### Request Example
```bash
GoJelastic getList --token=d7f8a9c2b1e3f4d5a6b7c8d9e0f1a2b3 --url=https://app.jelastic.com/1.0 --appid=my-production-app
```

### Response
#### Success Response (200)
- **manifest** (object) - The exported environment manifest containing topology, configurations, and settings.
```

--------------------------------

### Export Environment Configuration Manifest

Source: https://context7.com/yoanbernabeu/gojelastic/llms.txt

Export the complete environment configuration as a manifest file. This is invaluable for backups, creating replicas, or migrating environments. The command requires authentication details and the application ID.

```bash
# Export environment configuration
GoJelastic getList --token=d7f8a9c2b1e3f4d5a6b7c8d9e0f1a2b3 --url=https://app.jelastic.com/1.0 --appid=my-production-app

# Returns exportable environment manifest containing:
# - Complete topology definition
# - Node configurations and relationships
# - Environment variables and settings
# - Network and security configurations

# Use exported manifest to:
# - Clone environments across regions
# - Create templates for new deployments
# - Backup environment configurations
# - Version control infrastructure definitions
```

--------------------------------

### GoJelastic swapExtIps Command Usage

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic_swapExtIps.md

This snippet demonstrates the basic usage of the swapExtIps command, including the required flags for environment name, node IDs, and authentication.

```bash
GoJelastic swapExtIps --token=token --url=url --envName=envName --sourceNodeId=sourceNodeId --targetNodeId=targetNodeId
```

--------------------------------

### GoJelastic swapExtIps Command Options

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic_swapExtIps.md

This snippet details the available command-line options for the swapExtIps command, specifying the required parameters such as environment name, source and target node IDs, and authentication token and URL.

```bash
# Required options
--envName string        An envName is required
--sourceNodeId string   An sourceNodeId is required
--targetNodeId string   An targetNodeId is required

# Inherited options
--token string   A token is required
--url string     A url is required

# Help option
-h, --help      help for swapExtIps
```

--------------------------------

### POST /swapExtIps

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic_swapExtIps.md

Swaps external IP addresses between source and target nodes. If the target node does not have an external IP, it will be assigned to it.

```APIDOC
## POST /swapExtIps

### Description
Swaps external IP addresses between source and target nodes. If the target node does not have an external IP, it will be assigned to it.

### Method
POST

### Endpoint
/swapExtIps

### Parameters
#### Query Parameters
- **token** (string) - Required - A token is required
- **url** (string) - Required - A url is required
- **envName** (string) - Required - An envName is required
- **sourceNodeId** (string) - Required - An sourceNodeId is required
- **targetNodeId** (string) - Required - An targetNodeId is required

### Request Example
```json
{
  "token": "your_token",
  "url": "your_url",
  "envName": "your_env_name",
  "sourceNodeId": "your_source_node_id",
  "targetNodeId": "your_target_node_id"
}
```

### Response
#### Success Response (200)
- **message** (string) - Indicates the IP addresses were swapped successfully.

#### Response Example
```json
{
  "message": "External IPs swapped successfully between sourceNodeId and targetNodeId."
}
```
```

--------------------------------

### GoJelastic CLI Options

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic.md

Displays the available command-line options for the GoJelastic CLI. These options include help flags, toggles, and required parameters like token and URL for authentication and access.

```bash
gojelastic --help
  -h, --help           help for GoJelastic
  -t, --toggle         Help message for toggle
      --token string   A token is required
      --url string     A url is required
```

--------------------------------

### List Available Regions for Environment Deployment

Source: https://context7.com/yoanbernabeu/gojelastic/llms.txt

Retrieve a list of all available datacenter regions accessible to the user's account. This is essential for selecting deployment locations. The command requires authentication credentials and the Jelastic API URL.

```bash
# Get list of available regions for environment deployment
GoJelastic getRegions --token=d7f8a9c2b1e3f4d5a6b7c8d9e0f1a2b3 --url=https://app.jelastic.com/1.0 --appid=my-production-app

# Example response:
# {
#     "result": 0,
#     "array": [
#         {
#             "region": "us-east-1",
#             "displayName": "US East",
#             "domain": "us-east.jelastic.com"
#         },
#         {
#             "region": "eu-west-1",
#             "displayName": "Europe West",
#             "domain": "eu-west.jelastic.com"
#         }
#     ]
# }
```

--------------------------------

### GoJelastic Configure Command Synopsis

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic_configure.md

This snippet shows the basic synopsis for the 'configure' command in the GoJelastic CLI. It indicates the command name and that it accepts flags for configuration.

```bash
GoJelastic configure [flags]
```

--------------------------------

### Configure GoJelastic CLI with Token and URL

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic_configure.md

This snippet demonstrates how to configure the GoJelastic CLI by providing an authentication token and the Jelastic URL. This is essential for authenticating with the Jelastic platform and enabling subsequent CLI operations.

```bash
GoJelastic configure --token=token --url=url
```

--------------------------------

### GoJelastic Configure CLI

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic_configure.md

This section outlines the 'configure' command for the GoJelastic CLI, which allows users to set up their authentication token and Jelastic URL.

```APIDOC
## GoJelastic configure

### Description
Configure your CLI by setting essential parameters like authentication token and Jelastic URL.

### Method
CLI Command

### Endpoint
N/A (CLI command)

### Parameters
#### Command Line Arguments
- **--token** (string) - Required - Your Jelastic token for authentication.
- **--url** (string) - Required - Your Jelastic API endpoint URL.
- **--help** (boolean) - Optional - Display help information for the configure command.

### Request Example
```bash
GoJelastic configure --token=YOUR_JELASTIC_TOKEN --url=YOUR_JELASTIC_URL
```

### Response
#### Success Response
Configuration is updated. No explicit success response body, but the CLI will be configured.

#### Response Example
(No specific response body for successful configuration. Changes are applied to the CLI's configuration.)
```

--------------------------------

### GoJelastic CLI: getEnv Command Options

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic_getEnv.md

This snippet outlines the available options for the GoJelastic getEnv command. It includes required arguments like appid, token, and url, along with a help flag.

```bash
# getEnv command options
      --appid string   An appid is required
  -h, --help           help for getEnv

# Inherited options
      --token string   A token is required
      --url string     A url is required
```

--------------------------------

### GoJelastic Configure CLI

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic.md

Allows users to configure the GoJelastic CLI. This typically involves setting up essential parameters or preferences for the CLI's operation.

```bash
gojelastic configure
```

--------------------------------

### List Environment Groups

Source: https://context7.com/yoanbernabeu/gojelastic/llms.txt

Retrieve a list of all environment groups available for organizing and managing multiple environments. This command aids in structuring cloud resources by project, environment type, or team. It requires authentication and the Jelastic API URL.

```bash
# Get list of environment groups
GoJelastic getGroups --token=d7f8a9c2b1e3f4d5a6b7c8d9e0f1a2b3 --url=https://app.jelastic.com/1.0 --appid=my-production-app

# Environment groups help organize environments by:
# - Project or application
# - Environment type (dev, staging, production)
# - Team or department
# - Cost center or billing category

# Response structure:
# {
#     "result": 0,
#     "groups": [
#         {"name": "Production Apps", "id": 1},
#         {"name": "Development", "id": 2}
#     ]
# }
```

--------------------------------

### GoJelastic Configure Command Options

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic_configure.md

This snippet lists the available options for the 'configure' command in the GoJelastic CLI. It includes the help flag and specific flags for setting the Jelastic token and URL, both of which are required for authentication.

```bash
  -h, --help           help for configure
      --token string   Your Jelastic token
      --url string     Your Jelastic url
```

--------------------------------

### getGroups - List Environment Groups

Source: https://context7.com/yoanbernabeu/gojelastic/llms.txt

Retrieves all environment groups for organizing and managing multiple environments.

```APIDOC
## GET /getGroups

### Description
List all environment groups for organizing and managing environments.

### Method
GET

### Endpoint
/getGroups

### Parameters
#### Query Parameters
- **token** (string) - Required - Authentication token.
- **url** (string) - Required - API endpoint URL.
- **appid** (string) - Required - Environment name.

### Request Example
```bash
GoJelastic getGroups --token=d7f8a9c2b1e3f4d5a6b7c8d9e0f1a2b3 --url=https://app.jelastic.com/1.0 --appid=my-production-app
```

### Response
#### Success Response (200)
- **groups** (array) - A list of environment groups.
  - **name** (string) - The name of the group.
  - **id** (integer) - The ID of the group.
```

--------------------------------

### swapExtIps - Swap External IP Addresses

Source: https://context7.com/yoanbernabeu/gojelastic/llms.txt

Exchanges external IP addresses between two container nodes, useful for blue-green deployments.

```APIDOC
## POST /swapExtIps

### Description
Swap external IP addresses between two container nodes.

### Method
POST

### Endpoint
/swapExtIps

### Parameters
#### Query Parameters
- **token** (string) - Required - Authentication token.
- **url** (string) - Required - API endpoint URL.
- **envName** (string) - Required - The name of the environment.
- **sourceNodeId** (string) - Required - The ID of the source container node.
- **targetNodeId** (string) - Required - The ID of the target container node.

### Request Example
```bash
GoJelastic swapExtIps \
  --token=d7f8a9c2b1e3f4d5a6b7c8d9e0f1a2b3 \
  --url=https://app.jelastic.com/1.0 \
  --envName=my-production-app \
  --sourceNodeId=123456 \
  --targetNodeId=789012
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of the IP address reassignment.
```

--------------------------------

### Initiate Password Recovery with GoJelastic CLI

Source: https://context7.com/yoanbernabeu/gojelastic/llms.txt

The recoverPassword command initiates the password recovery process by sending a reset link to the specified email address. It does not require an authentication token. The command expects the Jelastic platform URL and the target email address as arguments. The response indicates the success or failure of sending the recovery email.

```bash
# Initiate password recovery
GoJelastic recoverPassword --url=https://app.jelastic.com/1.0 --email=user@example.com

# Note: This command does not require authentication token
# Password reset link will be sent to the specified email address

# Response:
# {
#     "result": 0,
#     "message": "Password recovery email sent"
# }

# Use case: Self-service password reset in automation scripts
# or when credentials are lost

```

--------------------------------

### GoJelastic CLI: getEnv Command Usage

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic_getEnv.md

This snippet shows the basic command-line syntax for using the GoJelastic getEnv command. It requires flags for authentication (token, url) and application identification (appid).

```bash
GoJelastic getEnv --token=token --url=url --appid=appid
```

--------------------------------

### Stop Environment using GoJelastic CLI

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic_stopEnv.md

This snippet demonstrates how to use the GoJelastic CLI to stop an environment. It requires the `--token`, `--url`, and `--appid` flags for authentication and identification. Ensure these values are correctly provided to execute the command successfully.

```bash
GoJelastic stopEnv --token=token --url=url --appid=appid
```

--------------------------------

### getEnv Command

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic_getEnv.md

Retrieves comprehensive information about an environment, including node lists and settings.

```APIDOC
## getEnv

### Description
Gets the full information about environment (list of the nodes, settings etc.).

### Method
CLI COMMAND

### Endpoint
N/A (CLI Command)

### Parameters
#### Flags
- **--appid** (string) - Required - An appid is required
- **--token** (string) - Required - A token is required
- **--url** (string) - Required - A url is required
- **-h, --help** (boolean) - Optional - help for getEnv

### Request Example
```
GoJelastic getEnv --token=token --url=url --appid=appid
```

### Response
#### Success Response (200)
- **environmentInfo** (object) - Full information about the environment
  - **nodes** (array) - List of nodes in the environment
  - **settings** (object) - Environment settings

#### Response Example
```json
{
  "environmentInfo": {
    "nodes": [
      {
        "id": "node-1",
        "type": "docker",
        "status": "RUNNING"
      }
    ],
    "settings": {
      "region": "us-east-1"
    }
  }
}
```
```

--------------------------------

### GoJelastic getList

Source: https://github.com/yoanbernabeu/gojelastic/blob/main/docs/documentation/GoJelastic_getList.md

Retrieves a list of an environment within Jelastic. This command requires authentication tokens and environment identifiers.

```APIDOC
## GET /api/environment/list

### Description
Retrieves a list of an environment within Jelastic. This command requires authentication tokens and environment identifiers.

### Method
GET

### Endpoint
/api/environment/list

### Parameters
#### Query Parameters
- **token** (string) - Required - A token is required for authentication.
- **url** (string) - Required - The base URL of the Jelastic API.
- **appid** (string) - Required - The application ID associated with the environment.

### Request Example
```bash
GoJelastic getList --token=your_token --url=your_url --appid=your_appid
```

### Response
#### Success Response (200)
- **environments** (array) - A list of available environments.
  - **id** (string) - The unique identifier of the environment.
  - **name** (string) - The name of the environment.

#### Response Example
```json
{
  "environments": [
    {
      "id": "env123",
      "name": "Production Environment"
    },
    {
      "id": "env456",
      "name": "Staging Environment"
    }
  ]
}
```
```

--------------------------------

### getRegions - List Available Regions

Source: https://context7.com/yoanbernabeu/gojelastic/llms.txt

Retrieves a list of all available datacenter regions for environment deployment.

```APIDOC
## GET /getRegions

### Description
List all available datacenter regions for environment deployment.

### Method
GET

### Endpoint
/getRegions

### Parameters
#### Query Parameters
- **token** (string) - Required - Authentication token.
- **url** (string) - Required - API endpoint URL.
- **appid** (string) - Required - Environment name.

### Request Example
```bash
GoJelastic getRegions --token=d7f8a9c2b1e3f4d5a6b7c8d9e0f1a2b3 --url=https://app.jelastic.com/1.0 --appid=my-production-app
```

### Response
#### Success Response (200)
- **array** (array) - A list of available regions.
  - **region** (string) - The region identifier.
  - **displayName** (string) - The display name of the region.
  - **domain** (string) - The domain associated with the region.
```