EPepilot
environments

getEnvironmentVariable

Changed on

Get an environment variable by key. Returns value for non-secret types, omitted for SecretString.

get/v1/environments/{key}

Request

  • Base URL
    https://environments.sls.epilot.io
  • URL
    https://environments.sls.epilot.io/v1/environments/{key}
  • Auth
    HTTP bearer

Response

Environment variable

keystring required
type'String' | 'SecretString' | 'Text' | 'Number' | 'Boolean' | 'Map' | 'JSON' | 'Link' | 'List' required

The structure a variable's value holds. SecretString is encrypted at rest and its value is never returned. Text, Number, Boolean, Map, JSON and Link may be served to browser-facing consumers; String and SecretString may not. A List inherits this from its element type: a List is served only when its itemType is itself client-safe, so a List<String> or List<SecretString> is not.

item_type'String' | 'SecretString' | 'Text' | 'Number' | 'Boolean' | 'JSON' | 'Link'

The element type a List holds — every value type except the containers. Map is already a keyed collection and a list of lists has no consumer. A list is exactly as client-safe and exactly as secret as its element type: a list of SecretString is encrypted per item and its value is never returned.

descriptionstring
groupstring

Optional group name for organising variables in the UI

protectedboolean

Whether the variable is protected from editing

created_atstring date-time required
updated_atstring date-time required

Changes

  • 2d3bb87bb819Revision changes
    • warning

      added the new List enum value to the response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added to the //// response property anyOf list for the response status

  • 318bb4b16fc3Revision changes
    • warning

      added the new Link enum value to the response property for the response status

    • info

      added to the //// response property anyOf list for the response status