def get(project, environment, product: nil, timeout: nil)def get: (
String project,
String environment,
?product: (String | Symbol)?,
?timeout: seconds?
) -> environment_summary_resourceFetches 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
ruby
require "envless/sdk"
environment = Envless.environments.get("api", "production")
puts environment[:id]Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
project | String | Yes | Project slug or uniqueId that owns the environment. |
environment | String | Yes | Environment slug, unique within the project. |
product: | String | Symbol | No | Product slug that disambiguates an ambiguous project slug. |
timeout: | Integer | Float | Rational | No | Seconds each attempt of this call may take, redirects and the response body included, before it raises Envless::NetworkError with timeout? set. Overrides the client's timeout for this call, and 0 turns the limit off. |
Returns
environment_summary_resource 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
idfrom here as theenvironmentIdyou 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.