environment#
The Environment API endpoints provide an interface for getting information about Chain environments.
Environment#
An object containing information about a particular workspace environment.
Properties#
Name |
Type |
Description |
Restrictions |
|---|---|---|---|
chains_count |
integer(int64) |
||
color |
string |
||
created_at |
string |
||
description |
string |
||
id |
ID |
The unique identifier of a resource (can be a GUID). |
|
name |
string |
||
position |
integer(int64) |
||
settings |
object |
||
settings.color |
string |
||
updated_at |
string |
||
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#
Name |
Type |
Description |
Restrictions |
|---|---|---|---|
defaultValue |
string |
||
encrypted |
boolean |
||
key |
string |
||
label |
string |
||
value |
string |
Example#
{
"defaultValue": "string",
"encrypted": true,
"key": "string",
"label": "string",
"value": "string"
}