These docs are for Rancher 1.6, if you are looking for Rancher 2.x docs, see here.
Environment
An “environment” in the API is referred to as a stack in the UI and the Rancher documentation. In the API documentation, we’ll use the UI terminology. A Rancher stack mirrors the same concept as a docker-compose project. It represents a group of services that make up a typical application or workload.
Resource Fields
Writeable Fields
Field
Type
Create
Update
Default
Notes
description
string
Optional
Yes
-
dockerCompose
string
Optional
-
-
environment
map[string]
Optional
-
-
externalId
string
Optional
Yes
-
name
string
Yes
Yes
-
outputs
map[string]
Optional
Yes
-
previousEnvironment
map[string]
Optional
Yes
-
previousExternalId
string
Optional
Yes
-
rancherCompose
string
Optional
-
-
startOnCreate
boolean
Optional
-
-
Read Only Fields
Field
Type
Notes
healthState
string
id
int
The unique identifier for the environment
Please read more about the common resource fields. These fields are read only and applicable to almost every resource. We have segregated them from the list above.