envless.versions.rollback()

def rollback(
    id: str,
    *,
    timeout: float | None = None,
) -> RolledBackVersionResource

async def rollback(
    id: str,
    *,
    timeout: float | None = None,
) -> RolledBackVersionResource

Restores an environment to a snapshot in one transaction, behind the same per environment advisory lock that envless.variables.apply takes. The environment is derived from the version, which is why there is no project or environment argument here.

It rewrites the live environment, it does not create a new version. Variables in the snapshot but missing live are re-created, variables in both are overwritten whenever value, type, visibility, required or defaultValue differs, and live variables absent from the snapshot are soft-deleted. Ids are not preserved, so a re-created variable comes back with a new id and any cache of variable ids has to be rebuilt afterwards.

Rollback does not snapshot the current state first, so call envless.versions.create before it if you might want to come back. The restored ciphertext is copied verbatim too: if the workspace passphrase was rotated without re-encrypting version entries, this call succeeds and writes values that no longer decrypt, with no warning.

Example#

from envless import envless

backup = envless.versions.create(
    'api', 'production', {'note': 'pre rollback'}
)

result = envless.versions.rollback(
    '0191f0c4-6d2a-7c31-9a4b-8f2e1d5c7a90'
)

print(
    backup['label'],
    result['versionLabel'],
    result['added'],
    result['updated'],
    result['removed'],
)

import asyncio

from envless import AsyncEnvless


async def main() -> None:
    async with AsyncEnvless() as envless:
        backup = await envless.versions.create(
            'api', 'production', {'note': 'pre rollback'}
        )

        result = await envless.versions.rollback(
            '0191f0c4-6d2a-7c31-9a4b-8f2e1d5c7a90'
        )

        print(
            backup['label'],
            result['versionLabel'],
            result['added'],
            result['updated'],
            result['removed'],
        )


asyncio.run(main())

Parameters#

Returns#

RolledBackVersionResource with the restored versionLabel plus added, updated and removed counts.

Worth knowing#

Required scopes#

versions:write and variables:write

Underlying endpoint#

In TypeScript#