def create(
project,
environment,
body = nil,
product: nil,
timeout: nil,
**fields
)def create: (
String project,
String environment,
?(version_create | Hash[Symbol | String, untyped])? body,
?product: (String | Symbol)?,
?timeout: seconds?,
**untyped
) -> version_resourceSnapshots 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
require "envless/sdk"
version = Envless.versions.create(
"api",
"production",
note: "before billing migration"
)
puts "#{version[:id]} #{version[:label]}"
puts version[:variableCount]Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
project | String | Yes | Project slug or project uniqueId. |
environment | String | Yes | Environment slug to snapshot. |
body | version_create | No | The fields below as one Hash, with Symbol or String keys, in place of the keywords. |
note: | String | No | Free text label for why the snapshot was taken, up to 200 characters. |
product: | String | Symbol | No | Product slug used to disambiguate a project slug shared across products. |
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
version_resource for the new snapshot, carrying the server assigned label and the variableCount captured.
Worth knowing
labelis assigned server side. Passing one has no effect.- A
noteover 200 characters and an environment already holding 1000 versions both fail with status 400 and the genericrequest.invalidcode, so readmessageto tell them apart. - Publishing is on every plan, Free included. What Free lacks is the history: only the latest version can be read back or restored there, so a snapshot taken as a safety net before a bulk change is only usable as one from Dev upward.
- A version is immutable and the SDK exposes no update or delete for one. The only way forward is another snapshot.
Required scopes
versions:write
Underlying endpoint
POST /projects/{slug}/environments/{environmentSlug}/versions
Request and response schema, every error code, and a live playground.
In TypeScript
envless.versions.create()
The same method in @goenvless/sdk, with the same request, retries and errors.