Product documentation
Environment
Workspace environments (SSO-2410) — several long-lived sandboxes plus the one platform-managed production plane per workspace: list, create sandbox, rename, suspend/reactivate.
Environment
Workspace environments (SSO-2410) — several long-lived sandboxes plus the one platform-managed production plane per workspace: list, create sandbox, rename, suspend/reactivate.
Base URL: https://api.stg.thoryn.org
Operations
| Method | Path | Summary | Scopes |
|---|---|---|---|
GET | /api/v1/environments | Environment List | tenant:environments.read |
POST | /api/v1/environments | Environment Create | tenant:environments.write |
GET | /api/v1/environments/{id} | Environment Get | tenant:environments.read |
PATCH | /api/v1/environments/{id} | Environment Rename | tenant:environments.write |
POST | /api/v1/environments/{id}/reactivate | Environment Reactivate | tenant:environments.write |
POST | /api/v1/environments/{id}/suspend | Environment Suspend | tenant:environments.write |
Operation details
GET /api/v1/environments
Environment List
- Operation ID:
environmentList - Required scopes:
tenant:environments.read
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | EnvironmentListResponse |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
POST /api/v1/environments
Environment Create
- Operation ID:
environmentCreate - Required scopes:
tenant:environments.write
Request body (required): application/json → CreateEnvironmentRequest
Responses:
| Status | Description | Body |
|---|---|---|
201 | Created | EnvironmentResponse |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
GET /api/v1/environments/{id}
Environment Get
- Operation ID:
environmentGet - Required scopes:
tenant:environments.read
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | EnvironmentResponse |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
PATCH /api/v1/environments/{id}
Environment Rename
- Operation ID:
environmentRename - Required scopes:
tenant:environments.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string |
Request body (required): application/json → UpdateEnvironmentRequest
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | EnvironmentResponse |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
POST /api/v1/environments/{id}/reactivate
Environment Reactivate
- Operation ID:
environmentReactivate - Required scopes:
tenant:environments.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | EnvironmentResponse |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
POST /api/v1/environments/{id}/suspend
Environment Suspend
- Operation ID:
environmentSuspend - Required scopes:
tenant:environments.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | EnvironmentResponse |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |