envless.variables.create()

def create(
    project: str,
    environment: str,
    body: VariableInput,
    *,
    product: str | None = None,
    timeout: float | None = None,
) -> VariableResource

async def create(
    project: str,
    environment: str,
    body: VariableInput,
    *,
    product: str | None = None,
    timeout: float | None = None,
) -> VariableResource

Creates a single variable in an environment and returns the stored row.

value must already be ciphertext from encrypt_value. The server holds no key and will not encrypt for you, so a plaintext value is refused with 400 variable.ciphertext_invalid and error.field naming the offender. defaultValue obeys the same rule whenever you send it, and plaintext that reaches it is permanent, since it is copied into every version snapshot taken afterwards and into every rollback made from one.

The ciphertext check runs before the project and environment are resolved, so a malformed value aimed at a project that does not exist returns 400 and not 404. A name already taken by a live variable is 409 variable.name_conflict, and hitting the 1000 variable ceiling is 409 plan.limit_reached rather than a 402.

name must match ^[A-Za-z_][A-Za-z0-9_]*$ and be 1 to 100 characters: letters, digits and underscores only, never starting with a digit. A name that fails either rule is a 400, not a silent fix. Lowercase is legal. Envless stores and returns the name with exactly the casing you send and never upper-cases it for you, but uniqueness inside the environment is judged without regard to case, so creating api_key in an environment that already holds API_KEY is 409 variable.name_conflict rather than a second variable.

Example#

import os

from envless import encrypt_value, envless

passphrase = os.environ['ENVLESS_PASSPHRASE']
workspace_id = envless.me.get()['workspaceId']

variable = envless.variables.create(
    'api',
    'production',
    {
        'name': 'STRIPE_SECRET_KEY',
        'value': encrypt_value(
            'sk_live_51H8xq', passphrase, workspace_id
        ),
        'required': True,
    },
)

print(variable['id'])

import asyncio
import os

from envless import AsyncEnvless, encrypt_value


async def main() -> None:
    async with AsyncEnvless() as envless:
        passphrase = os.environ['ENVLESS_PASSPHRASE']
        workspace_id = (await envless.me.get())['workspaceId']

        variable = await envless.variables.create(
            'api',
            'production',
            {
                'name': 'STRIPE_SECRET_KEY',
                'value': encrypt_value(
                    'sk_live_51H8xq', passphrase, workspace_id
                ),
                'required': True,
            },
        )

        print(variable['id'])


asyncio.run(main())

Parameters#

Returns#

VariableResource for the new variable, including the generated id you need for apply and the id routes.

Worth knowing#

Required scopes#

variables:write

Underlying endpoint#

In TypeScript#