Environments

$envless->environments->get()

Read one environment by slug

php
/** @return EnvironmentSummaryResource */
public function get(
    string $project,
    string $environment,
    ?string $product = null,
    int|float|null $timeout = null,
): array

Fetches a single environment inside a project. The two path arguments are not symmetrical: project accepts a slug or a uniqueId, while environment is a slug only. An environment uniqueId 404s on every route in this namespace.

The payload is the summary shape, identical to a list row, and it carries the stored exposed flag and updatedAt directly.

Example

php
use Envless\Envless;

$envless = new Envless();

$environment = $envless->environments->get('api', 'production');

echo $environment['id'], PHP_EOL;

Parameters

ParameterTypeRequiredDescription
$projectstringYesProject slug or uniqueId that owns the environment.
$environmentstringYesEnvironment slug, unique within the project.
$productstringNoProduct slug that disambiguates an ambiguous project slug.
$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

EnvironmentSummaryResource with id, name, slug, projectId, exposed, createdAt and updatedAt.

Worth knowing

  • A 402 on this route means the project is locked for exceeding the plan project allowance, not that the environment is missing.
  • Use the id from here as the environmentId you match against variables and versions.

Required scopes

environments:read

Underlying endpoint

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

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

In TypeScript

envless.environments.get()

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