Skip to content

Get an environment

View .md
GET

Its name and each variable's name and last four characters.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Path parameters

  • environmentIdstringrequired

    Sandbox environment ID.

Responses

200The environment.
  • environmentobjectrequired

    A named set of environment variables to start sandboxes with. Values are encrypted at rest and never returned.

    5 properties
    • idstringrequired
    • namestringrequired
    • variablesobject[]required

      Each variable's name and the last four characters of its value.

      2 properties
      • keystringrequired
      • last4stringrequired
    • createdAtstring<date-time>required
    • updatedAtstring<date-time>required
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject
404Environment not found, or it belongs to another project.
  • codestringrequired
  • messagestringrequired
  • detailsobject