Skip to main content

Ephemeral Environments API

All endpoints are scoped to an organization and pipeline.

Base path: /organizations/{orgId}/pipelines/{pipelineId}/ephemeral-environments

List Environments​

GET /

Returns all ephemeral environments with their current lock status.

Get Environment​

GET /{envName}

Returns a single environment's configuration and lock status.

Get History​

GET /{envName}/history?page=1&limit=20

Returns paginated lock history for an environment.

Claim Session​

POST /{envName}/sessions

Body: { "commitId": "abc123", "context": "optional description" }

Claims a lock and optionally triggers an initial deployment. Returns the session ID.

Get Session Status​

GET /{envName}/sessions/{sessionId}

Returns the session's lock status, deployment history, and whether it was overridden.

Deploy Commit​

POST /{envName}/sessions/{sessionId}/deploy

Body: { "commitId": "abc123" }

Deploys a commit within an active session.

Release Session​

DELETE /{envName}/sessions/{sessionId}

Releases the lock on a session.

Force Claim​

POST /{envName}/force-claim

Body: { "commitId": "abc123", "context": "optional" }

Force-claims an environment, releasing any existing lock.