PUT /environments/{environment_id}

Replace an environment's definition, by id or by name.

MethodPath
PUT/v1/environments/{environment_id}

The whole definition is replaced, live at once — future sessions resolve the new body; running sessions keep the one frozen at their start. Only for environments managed through this API: one defined by a repository file is a 409.

Path parameters

environment_idstringrequired
curl -X PUT "https://api.ellipsis.dev/v1/environments/{environment_id}" \
  -H "Authorization: Bearer $ELLIPSIS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"environment":"..."}'

Request

Example request body
{
}

Body parameters

environmentEnvironmentDocumentrequired

The environment's new definition. Replaces the previous one wholesale — this is not a partial update.

Response

Example response · 200
{
}

On this page

No Headings
Schedule a demo