environments.show

GET

/environments/{environmentId}

const url = 'https://example.com/api/environments/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/environments/example

Parameters

Path Parameters

environmentId

required

string

>= 1 characters

Responses

200

application/json

object

required

string

projectId

required

string

name

required

string

kind

required

string

Allowed values: local development test staging production preview custom

parentEnvironmentId

string

lifecycleStatus

required

string

Allowed values: active locked archived

lockedAt

string

lockReason

string

archivedAt

string

archiveReason

string

createdAt

required

string

maskedVariables

required

Array<object>

object

key

required

string

value

required

string

scope

required

string

exposure

required

string

Allowed values: build-time runtime

isSecret

required

boolean

kind

required

string

Example

{
  "kind": "local",
  "lifecycleStatus": "active",
  "maskedVariables": [
    {
      "exposure": "build-time"
    }
  ]
}