API Reference

The Environment API endpoints provide an interface for getting information about Chain environments.

Environment

Properties

NameTypeDescriptionRestrictions
chains_countinteger(int64)
colorstring
created_atstring
descriptionstring
idIDThe unique identifier of a resource (can be a GUID).
namestring
positioninteger(int64)
settingsobject
settings.colorstring
updated_atstring
variables[Variable]

Example

{
  "chains_count": 0,
  "color": "string",
  "created_at": "string",
  "description": "string",
  "id": "74",
  "name": "string",
  "position": 0,
  "settings": {
    "color": "string"
  },
  "updated_at": "string",
  "variables": [
    {
      "defaultValue": "string",
      "encrypted": true,
      "key": "string",
      "label": "string",
      "value": "string"
    }
  ]
}

Variable

Properties

NameTypeDescriptionRestrictions
defaultValuestring
encryptedboolean
keystring
labelstring
valuestring

Example

{
  "defaultValue": "string",
  "encrypted": true,
  "key": "string",
  "label": "string",
  "value": "string"
}