Skip to content

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

MethodPathSummaryScopes
GET/api/v1/environmentsEnvironment Listtenant:environments.read
POST/api/v1/environmentsEnvironment Createtenant:environments.write
GET/api/v1/environments/{id}Environment Gettenant:environments.read
PATCH/api/v1/environments/{id}Environment Renametenant:environments.write
POST/api/v1/environments/{id}/reactivateEnvironment Reactivatetenant:environments.write
POST/api/v1/environments/{id}/suspendEnvironment Suspendtenant:environments.write

Operation details

GET /api/v1/environments

Environment List

  • Operation ID: environmentList
  • Required scopes: tenant:environments.read

Responses:

StatusDescriptionBody
200OKEnvironmentListResponse
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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/jsonCreateEnvironmentRequest

Responses:

StatusDescriptionBody
201CreatedEnvironmentResponse
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

NameInRequiredTypeDescription
idpathyesstring

Responses:

StatusDescriptionBody
200OKEnvironmentResponse
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

NameInRequiredTypeDescription
idpathyesstring

Request body (required): application/jsonUpdateEnvironmentRequest

Responses:

StatusDescriptionBody
200OKEnvironmentResponse
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

NameInRequiredTypeDescription
idpathyesstring

Responses:

StatusDescriptionBody
200OKEnvironmentResponse
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

NameInRequiredTypeDescription
idpathyesstring

Responses:

StatusDescriptionBody
200OKEnvironmentResponse
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)