Versions

$envless->versions->listEntries()

Read one page of raw version ciphertext

php
/** @return Page<VersionEntryResource> */
public function listEntries(
    string $project,
    string $environment,
    ?int $limit = null,
    ?int $offset = null,
    ?string $product = null,
    int|float|null $timeout = null,
): Page

Returns one page of the raw ciphertext of every version entry in the environment, across all versions, so it can be re-encrypted client side. Together with reencryptEntries this is the passphrase rotation pair.

The payload is deliberately thin: id, value and defaultValue, with no variable name and no version id, because rotation is blind and you decrypt and re-encrypt keyed on id alone. Pagination is applied in memory after the server loads the whole history, so a page is stable within a run but not cheap on a large environment.

Rotating the live variables without also rewriting these entries silently breaks every later rollback. If the rotation itself is all you want, Envless::rotateWorkspacePassphrase() walks both live variables and history for you.

Example

php
use Envless\Envless;

$envless = new Envless();

$page = $envless->versions->listEntries('api', 'production', limit: 100);

echo count($page->items), ' ', $page->pagination['totalCount'], PHP_EOL;
echo $page->hasMore() ? 'more pages to read' : 'last page', PHP_EOL;

Parameters

ParameterTypeRequiredDescription
$projectstringYesProject slug or project uniqueId.
$environmentstringYesEnvironment slug, since an environment uniqueId will not resolve here.
$productstringNoProduct slug used to disambiguate a project slug shared across products.
$limitintNoRows per page, a whole number from 1 to 100.
$offsetintNoRows to skip before the page starts.
$timeoutint|floatNoSeconds each attempt of this call may take, the response body included, before it throws Envless\Exception\NetworkException with isTimeout() true. Overrides the client's timeout for this call, and 0 turns the limit off.

Returns

Page<VersionEntryResource> whose items are arrays holding id, value and defaultValue, plus the pagination envelope.

Reads the entries collection. list returns one page as an Envless\Result\Page with items and pagination, listAll collects every page into an array, and iterate returns a Generator that yields one item at a time, fetching the next page only when the loop gets there.

Worth knowing

  • Requires both versions:read and variables:read.
  • Keep limit: at 100 or below. reencryptEntries takes at most 200 entries per call, so a page of 100 is the practical round trip.
  • Entries are flat across the environment, so two rows can hold the same plaintext from different versions. That is expected.

Required scopes

versions:read and variables:read

Underlying endpoint

GET /projects/{slug}/environments/{environmentSlug}/versions/entries

Request and response schema, every error code, and a live playground.

In TypeScript

envless.versions.listEntries()

The same method in @goenvless/sdk, with the same request, retries and errors.