envless.versions.create()

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

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

Snapshots every live variable in the environment as it stands right now into a new immutable version, and emails the active members of the workspace apart from the publisher. This is the programmatic equivalent of publishing a version in the dashboard.

The ciphertext is copied verbatim. The server cannot decrypt or re-encrypt it, so the workspace key in force at this moment is the key needed to read the snapshot back later. That is exactly why rotating a passphrase has to rewrite version entries as well as live variables.

Take a version before any risky bulk change, and take one before a rollback, because envless.versions.rollback does not snapshot the current state for you. The body is optional and a missing or unparseable body is read as no note rather than an error.

Example#

from envless import envless

version = envless.versions.create(
    'api', 'production', {'note': 'before billing migration'}
)

print(
    version['id'], version['label'], version['variableCount']
)

import asyncio

from envless import AsyncEnvless


async def main() -> None:
    async with AsyncEnvless() as envless:
        version = await envless.versions.create(
            'api', 'production', {'note': 'before billing migration'}
        )

        print(
            version['id'], version['label'], version['variableCount']
        )


asyncio.run(main())

Parameters#

Returns#

VersionResource for the new snapshot, carrying the server assigned label and the variableCount captured.

Worth knowing#

Required scopes#

versions:write

Underlying endpoint#

In TypeScript#