Environments

Retrieve environment

Changed on

Returns one server-managed environment definition by id.

get/api/v1/environments/{id}

Request

  • The document declares no server URL.
  • Auth
    • HTTP bearer
    • or API key in cookie __fabro_session

Path parameters

idstring required

Unique environment identifier.

Response

Environment definition

idstring required
revisionstring required

Stable revision used with If-Match for optimistic concurrency.

providerstring required

Sandbox provider kind. local, docker, and daytona are bundled with the server; any other value names a sandbox-driver plugin configured under server.sandbox.providers.<kind>.

cwdstring nullable

Local-provider command working directory for this environment. Docker and Daytona ignore this value.

labelsStringMap required
envobject required

Example response

{
  "id": "docker",
  "revision": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
  "provider": "docker",
  "cwd": "/srv/fabro/workspaces/team-a"
}

Changes

  • efc644ab09d4Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 478e995209e9Revision changes
    • info

      removed the daytona enum value from the response property for the response status

    • info

      removed the docker enum value from the response property for the response status

    • info

      removed the local enum value from the response property for the response status

    • info

      the response's property pattern ^[a-z0-9]([a-z0-9-]{0,62}[a-z0-9])?$ was added for the status