Skip to content

Commit 8973c47

Browse files
Environment state docs updates
1 parent aee3fac commit 8973c47

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

src/pages/docs/infrastructure/environments/environment-state.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,33 @@ The response is an array of name and URL pairs:
124124
]
125125
```
126126

127+
## Limits on environment state
128+
129+
Up to 10 environment state entries can be created for each combination of project, environment and optional tenant.
130+
131+
- Maximum key length is 100 characters
132+
- Maximum value length is 1000 characters
133+
134+
If any of these limits are exceeded during a deployment or runbook run step, the step will fail.
135+
136+
Use [Octopus variable logging](/docs/support/how-to-turn-on-variable-logging-and-export-the-task-log) to check if you are nearing your maximum number of environment state entries.
137+
138+
## Deleting environment state
139+
140+
If a project, environment, and tenant combination has hit the limit above, delete entries you no longer need to make room for new ones. Deleting is API-only.
141+
142+
For environment state scoped to a project and environment:
143+
```text
144+
DELETE /api/spaces/{spaceId}/projects/{projectId}/environments/{environmentId}/untenanted/states/{key}
145+
```
146+
147+
For environment state scoped to a project, environment and tenant:
148+
```text
149+
DELETE /api/spaces/{spaceId}/projects/{projectId}/environments/{environmentId}/tenants/{tenantId}/states/{key}
150+
```
151+
152+
Use [Octopus variable logging](/docs/support/how-to-turn-on-variable-logging-and-export-the-task-log) to get a list of environment state keys for a project, environment, and optional tenant scope.
153+
127154
## Availability
128155

129156
Environment state is rolling out to Octopus Cloud, and will be available to self-hosted customers from version `2026.3`.

0 commit comments

Comments
 (0)