Essence Developer Sandbox API

All OpenAPI documents

Version v1 · OpenAPI 3.0.1 · 44 operations · Download the JSON document

EPIC 49 — Developer Sandbox provisioning, credentials, and templates.

Generated from the DeveloperSandbox service's code at build time (api-specs/generated/DeveloperSandbox/Essence.Developer.Sandbox.Api.json) and drift-checked in CI. It describes what the code registers, which is not the same as what any one deployment has routed.

CustomScenarioPacks

GET/api/v1/scenario-packs

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
partner	query	string (uuid)	no	—
status	query	CustomScenarioPackStatus	no	—

Request body

No request body.

Responses

200Success — CustomScenarioPackDto[]

403Forbidden — ProblemDetails

POST/api/v1/scenario-packs

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• DraftScenarioPackRequest as application/*+json, application/json, text/json

Responses

201Created — CustomScenarioPackDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

GET/api/v1/scenario-packs/{id}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — CustomScenarioPackDto

404Not Found — ProblemDetails

POST/api/v1/scenario-packs/{id}/approve

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — CustomScenarioPackDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/scenario-packs/{id}/publish

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — CustomScenarioPackDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/scenario-packs/{id}/reject

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• RejectScenarioPackRequest as application/*+json, application/json, text/json

Responses

200Success — CustomScenarioPackDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/scenario-packs/{id}/submit

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — CustomScenarioPackDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

EnvironmentTemplates

GET/api/v1/sandbox-templates

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — EnvironmentTemplateDto[]

GET/api/v1/sandbox-templates/{id}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — EnvironmentTemplateDto

404Not Found — ProblemDetails

SandboxClosure

POST/api/v1/sandboxes/{sandboxId}/clone

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
sandboxId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• CloneSandboxRequest as application/*+json, application/json, text/json

Responses

201Created — CloneSandboxResultDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/sandboxes/{sandboxId}/poc-migration

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
sandboxId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — SandboxDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/sandboxes/{sandboxId}/snapshots

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
sandboxId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — SandboxSnapshotDto[]

POST/api/v1/sandboxes/{sandboxId}/snapshots

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
sandboxId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• CaptureSnapshotRequest as application/*+json, application/json, text/json

Responses

201Created — SandboxSnapshotDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/sandboxes/{sandboxId}/snapshots/{snapshotId}/restore

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
sandboxId	path	string (uuid)	yes	—
snapshotId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — SandboxSnapshotDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

SandboxCredentials

GET/api/v1/sandboxes/{sandboxId}/credentials

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
sandboxId	path	string (uuid)	yes	—
cursor	query	string	no	—
pageSize	query	integer (int32)	no	—

Request body

No request body.

Responses

200Success — SandboxCredentialDtoCursorResult

400Bad Request — ProblemDetails

POST/api/v1/sandboxes/{sandboxId}/credentials

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
sandboxId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• IssueSandboxCredentialRequest as application/*+json, application/json, text/json

Responses

201Created — SandboxCredentialIssuedDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

DELETE/api/v1/sandboxes/{sandboxId}/credentials/{credentialId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
sandboxId	path	string (uuid)	yes	—
credentialId	path	string (uuid)	yes	—
reason	query	string	no	—

Request body

No request body.

Responses

204No Content

404Not Found — ProblemDetails

Sandboxes

GET/api/v1/sandboxes

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
ownerType	query	SandboxOwnerType	no	—

Request body

No request body.

Responses

200Success — SandboxDto[]

POST/api/v1/sandboxes

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• CreateSandboxRequest as application/*+json, application/json, text/json

Responses

201Created — SandboxDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

GET/api/v1/sandboxes/{id}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — SandboxDto

404Not Found — ProblemDetails

DELETE/api/v1/sandboxes/{id}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
reason	query	string	no	—

Request body

No request body.

Responses

204No Content

404Not Found — ProblemDetails

PATCH/api/v1/sandboxes/{id}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• UpdateSandboxConfigRequest as application/*+json, application/json, text/json

Responses

200Success — SandboxDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/sandboxes/{id}/extend

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• ExtendSandboxRequest as application/*+json, application/json, text/json

Responses

200Success — SandboxDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/sandboxes/{id}/reactivate

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — SandboxDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/sandboxes/{id}/reset

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — SandboxDto

404Not Found — ProblemDetails

POST/api/v1/sandboxes/{id}/suspend

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• SuspendSandboxRequest as application/*+json, application/json, text/json

Responses

200Success — SandboxDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

SandboxLicences

GET/api/v1/sandboxes/licences/options

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
audience	query	string	no	—
organizationId	query	string (uuid)	no	—

Request body

No request body.

Responses

200Success — SandboxLicenceOptionsDto

400Bad Request — ProblemDetails

401Unauthorized — ProblemDetails

403Forbidden — ProblemDetails

503Server Error

POST/api/v1/sandboxes/licences/purchases

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
Idempotency-Key	header	string	no	—

Request body

Not marked as required in the document.

• PurchaseSandboxRequest as application/*+json, application/json, text/json

Responses

200Success — SandboxPurchaseDto

201Created — SandboxPurchaseDto

202Accepted — SandboxPurchaseDto

400Bad Request — ProblemDetails

409Conflict — ProblemDetails

503Server Error

GET/api/v1/sandboxes/licences/purchases/{purchaseId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
purchaseId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — SandboxPurchaseDto

404Not Found — ProblemDetails

POST/api/v1/sandboxes/licences/purchases/{purchaseId}/cancel

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
purchaseId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — SandboxPurchaseDto

404Not Found — ProblemDetails

409Conflict — ProblemDetails

503Server Error

POST/api/v1/sandboxes/licences/purchases/{purchaseId}/complete

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
purchaseId	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — SandboxPurchaseDto

404Not Found — ProblemDetails

409Conflict — ProblemDetails

503Server Error

SandboxMembers

GET/api/v1/sandboxes/{sandboxId}/members

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
sandboxId	path	string (uuid)	yes	—
cursor	query	string	no	—
pageSize	query	integer (int32)	no	—

Request body

No request body.

Responses

200Success — SandboxMemberDtoCursorResult

400Bad Request — ProblemDetails

POST/api/v1/sandboxes/{sandboxId}/members

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
sandboxId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• AddSandboxMemberRequest as application/*+json, application/json, text/json

Responses

201Created — SandboxMemberDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

DELETE/api/v1/sandboxes/{sandboxId}/members/{memberId}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
sandboxId	path	string (uuid)	yes	—
memberId	path	string (uuid)	yes	—

Request body

No request body.

Responses

204No Content

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

SandboxScenarioPacks

POST/api/v1/sandboxes/{sandboxId}/scenario-packs

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
sandboxId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• ApplyScenarioPackRequest as application/*+json, application/json, text/json

Responses

200Success — ScenarioPackApplyResultDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

SandboxUsage

GET/api/v1/sandboxes/{sandboxId}/usage

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
sandboxId	path	string (uuid)	yes	—
metric	query	string	no	—
from	query	string (date-time)	no	—
to	query	string (date-time)	no	—
limit	query	integer (int32)	no	—

Request body

No request body.

Responses

200Success — SandboxResourceUsageDto[]

POST/api/v1/sandboxes/{sandboxId}/usage

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
sandboxId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• RecordSandboxUsageRequest as application/*+json, application/json, text/json

Responses

201Created — SandboxResourceUsageDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

TrainingPaths

POST/api/v1/training/labs/{labId}/complete

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
labId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• CompleteLabRequest as application/*+json, application/json, text/json

Responses

200Success — TrainingProgressDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/training/labs/{labId}/start

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
labId	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• StartLabRequest as application/*+json, application/json, text/json

Responses

200Success — TrainingProgressDto

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/training/paths

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

No request body.

Responses

200Success — TrainingPathDto[]

POST/api/v1/training/paths

Authentication: not declared in the document

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• CreateTrainingPathRequest as application/*+json, application/json, text/json

Responses

201Created — TrainingPathDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

GET/api/v1/training/paths/{id}

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — TrainingPathDto

404Not Found — ProblemDetails

POST/api/v1/training/paths/{id}/publish

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — TrainingPathDto

400Bad Request — ProblemDetails

403Forbidden — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/training/progress

Authentication: not declared in the document

Parameters

Name	In	Type	Required	Description
pathId	query	string (uuid)	no	—

Request body

No request body.

Responses

200Success — TrainingProgressDto[]

Schemas

AddSandboxMemberRequest

Property	Type	Required	Description
displayName	string | null	no	—
external	boolean | null	no	—
externalReason	string | null	no	—
role	SandboxMemberRole	no	—
userId	string (uuid)	no	—

ApplyScenarioPackRequest

Property	Type	Required	Description
scenarioPackId	string (uuid)	no	—

CaptureSnapshotRequest

Property	Type	Required	Description
description	string | null	no	—
isLabProgress	boolean	no	—
label	string | null	no	—
manifestJson	string | null	no	—

CloneSandboxRequest

Property	Type	Required	Description
description	string | null	no	—
name	string | null	no	—
sourceSnapshotId	string (uuid) | null	no	—
strategy	string | null	no	—

CloneSandboxResultDto

Property	Type	Required	Description
lineage	SandboxCloneDto	no	—
sandbox	SandboxDto	no	—

CompleteLabRequest

Property	Type	Required	Description
feedback	string | null	no	—
score	integer (int32) | null	no	—

CreateSandboxRequest

Property	Type	Required	Description
description	string | null	no	—
isolationMode	string | null	no	—
name	string | null	no	—
ownerType	SandboxOwnerType	no	—
repro	SandboxReproSeedRequest	no	—
skuCode	string | null	no	—
templateId	string (uuid)	no	—
tier	SandboxTier	no	—
ttlHours	integer (int32)	no	—

CreateTrainingPathRequest

Property	Type	Required	Description
labs	TrainingLabRequestSpec[] | null	no	—
slug	string | null	no	—
summary	string | null	no	—
title	string | null	no	—

CustomScenarioPackDto

Property	Type	Required	Description
approvedAt	string (date-time) | null	no	—
authorUserId	string (uuid)	no	—
id	string (uuid)	no	—
partnerId	string (uuid)	no	—
publishedAt	string (date-time) | null	no	—
publishedTemplateId	string (uuid) | null	no	—
rejectionReason	string | null	no	—
reviewedBy	string (uuid) | null	no	—
seedManifestJson	string | null	no	—
slug	string | null	no	—
status	CustomScenarioPackStatus	no	—
submittedAt	string (date-time) | null	no	—
summary	string | null	no	—
title	string | null	no	—

CustomScenarioPackStatus

0 | 1 | 2 | 3 | 4 | 5 with no declared properties.

DraftScenarioPackRequest

Property	Type	Required	Description
seedManifestJson	string | null	no	—
slug	string | null	no	—
summary	string | null	no	—
title	string | null	no	—

EnvironmentTemplateDto

Property	Type	Required	Description
category	string | null	no	—
dataDefinitionJson	string | null	no	—
description	string | null	no	—
id	string (uuid)	no	—
isPublic	boolean	no	—
isPublished	boolean	no	—
minTier	SandboxTier	no	—
name	string | null	no	—
slug	string | null	no	—
targetModulesJson	string | null	no	—
version	string | null	no	—

ExtendSandboxRequest

Property	Type	Required	Description
hours	integer (int32)	no	—
skuCode	string | null	no	—

IssueSandboxCredentialRequest

Property	Type	Required	Description
credentialType	SandboxCredentialType	no	—
expiresAt	string (date-time)	no	—
name	string | null	no	—
recipientUserId	string (uuid)	no	—
scopes	string[] | null	no	—

LicensedSandboxDto

Property	Type	Required	Description
expiresAt	string (date-time)	no	—
isLive	boolean	no	—
name	string | null	no	—
sandboxId	string (uuid)	no	—
skuCode	string | null	no	—
sponsored	boolean	no	—
sponsoredUntil	string (date-time) | null	no	—
status	SandboxStatus	no	—
subscriptionId	string (uuid)	no	—

ProblemDetails

Property	Type	Required	Description
detail	string | null	no	—
instance	string | null	no	—
status	integer (int32) | null	no	—
title	string | null	no	—
type	string | null	no	—

PurchaseSandboxRequest

Property	Type	Required	Description
description	string | null	no	—
keepSandboxId	string (uuid) | null	no	—
name	string | null	no	—
organizationId	string (uuid) | null	no	—
skuCode	string | null	no	—
templateId	string (uuid)	no	—
ttlHours	integer (int32) | null	no	—

RecordSandboxUsageRequest

Property	Type	Required	Description
metricName	string | null	no	—
recordedAt	string (date-time) | null	no	—
unit	string | null	no	—
value	number (double)	no	—

RejectScenarioPackRequest

Property	Type	Required	Description
reason	string | null	no	—

SandboxCloneDto

Property	Type	Required	Description
cloneSandboxId	string (uuid)	no	—
completedAt	string (date-time)	no	—
id	string (uuid)	no	—
initiatedBy	string (uuid)	no	—
sourceSandboxId	string (uuid)	no	—
sourceSnapshotId	string (uuid) | null	no	—
strategy	string | null	no	—

SandboxCredentialDto

Property	Type	Required	Description
credentialType	SandboxCredentialType	no	—
expiresAt	string (date-time)	no	—
id	string (uuid)	no	—
isRevoked	boolean	no	—
issuedAt	string (date-time)	no	—
keyPrefix	string | null	no	—
name	string | null	no	—
recipientUserId	string (uuid)	no	—
revokedAt	string (date-time) | null	no	—
sandboxId	string (uuid)	no	—
scopesJson	string | null	no	—

SandboxCredentialDtoCursorResult

Property	Type	Required	Description
hasMore	boolean	no	—
items	SandboxCredentialDto[] | null	no	—
nextCursor	string | null	no	—
pageSize	integer (int32)	no	—
previousCursor	string | null	no	—

SandboxCredentialIssuedDto

Property	Type	Required	Description
credential	SandboxCredentialDto	no	—
plaintextSecret	string | null	no	—

SandboxCredentialType

0 | 1 | 2 with no declared properties.

SandboxDto

Property	Type	Required	Description
activeServices	string[] | null	no	—
decommissionedAt	string (date-time) | null	no	—
description	string | null	no	—
endpoints	SandboxEndpointsDto	no	—
expiresAt	string (date-time)	no	—
externalId	string | null	no	—
id	string (uuid)	no	—
isolationMode	string | null	no	—
lastActivityAt	string (date-time)	no	—
name	string | null	no	—
ownerId	string (uuid)	no	—
ownerType	SandboxOwnerType	no	—
provisionedAt	string (date-time)	no	—
repro	SandboxReproDto	no	—
resources	SandboxResourcesDto	no	—
skuCode	string | null	no	—
status	SandboxStatus	no	—
subscriptionId	string (uuid) | null	no	—
suspendedAt	string (date-time) | null	no	—
templateId	string (uuid)	no	—
tier	SandboxTier	no	—

SandboxEndpointsDto

Property	Type	Required	Description
apiBaseUrl	string | null	no	—
graphQlEndpoint	string | null	no	—
webhookUrl	string | null	no	—

SandboxLicenceOfferDto

Property	Type	Required	Description
cadence	string | null	no	—
currency	string | null	no	—
defaultTtlHours	integer (int32) | null	no	—
isFree	boolean	no	—
licenceTier	integer (int32) | null	no	—
maxPerOwner	integer (int32) | null	no	—
name	string | null	no	—
ownerType	SandboxOwnerType	no	—
price	number (double) | null	no	—
purchasable	boolean	no	—
reason	string | null	no	—
refusal	SandboxLicenceRefusalDto	no	—
resources	SandboxResourcesDto	no	—
reuseSubscriptionId	string (uuid) | null	no	—
skuCode	string | null	no	—
subname	string | null	no	—
tier	SandboxTier	no	—

SandboxLicenceOptionsDto

Property	Type	Required	Description
audience	string | null	no	—
billedThroughDisplayName	string | null	no	—
environments	LicensedSandboxDto[] | null	no	—
mode	string | null	no	—
offers	SandboxLicenceOfferDto[] | null	no	—
onBehalfOfPayer	boolean	no	—
ownerOrganizationId	string (uuid)	no	—
pricesHidden	boolean	no	—

SandboxLicenceRefusalDto

Property	Type	Required	Description
code	string | null	no	—
reason	string | null	no	—
rule	string | null	no	—
status	integer (int32)	no	—

SandboxMemberDto

Property	Type	Required	Description
addedAt	string (date-time)	no	—
addedBy	string (uuid)	no	—
displayName	string | null	no	—
external	boolean	no	—
externalReason	string | null	no	—
id	string (uuid)	no	—
role	SandboxMemberRole	no	—
sandboxId	string (uuid)	no	—
userId	string (uuid)	no	—

SandboxMemberDtoCursorResult

Property	Type	Required	Description
hasMore	boolean	no	—
items	SandboxMemberDto[] | null	no	—
nextCursor	string | null	no	—
pageSize	integer (int32)	no	—
previousCursor	string | null	no	—

SandboxMemberRole

0 | 1 | 2 with no declared properties.

SandboxOwnerType

0 | 1 | 2 | 3 with no declared properties.

SandboxPurchaseDto

Property	Type	Required	Description
expiresAt	string (date-time) | null	no	—
failure	SandboxPurchaseFailureDto	no	—
ownerOrganizationId	string (uuid)	no	—
payment	SandboxPurchasePaymentDto	no	—
purchaseId	string (uuid)	no	—
replay	boolean	no	—
sandbox	SandboxDto	no	—
skuCode	string | null	no	—
state	string | null	no	—
subscriptionId	string (uuid) | null	no	—
supportReference	string (uuid) | null	no	—

SandboxPurchaseFailureDto

Property	Type	Required	Description
code	string | null	no	—
reason	string | null	no	—
rule	string | null	no	—

SandboxPurchasePaymentDto

Property	Type	Required	Description
amountDue	number (double) | null	no	—
currency	string | null	no	—
invoiceId	string (uuid) | null	no	—
subscriptionId	string (uuid)	no	—

SandboxReproDto

Property	Type	Required	Description
context	string | null	no	—
findingKey	string | null	no	—
listingId	string | null	no	—

SandboxReproSeedRequest

Property	Type	Required	Description
context	string | null	no	—
findingKey	string | null	no	—
listingId	string | null	no	—

SandboxResourcesDto

Property	Type	Required	Description
cpu	string | null	no	—
memory	string | null	no	—
storage	string | null	no	—

SandboxResourceUsageDto

Property	Type	Required	Description
id	string (uuid)	no	—
metricName	string | null	no	—
recordedAt	string (date-time)	no	—
sandboxId	string (uuid)	no	—
unit	string | null	no	—
value	number (double)	no	—

SandboxSnapshotDto

Property	Type	Required	Description
capturedAt	string (date-time)	no	—
capturedBy	string (uuid)	no	—
description	string | null	no	—
id	string (uuid)	no	—
isLabProgress	boolean	no	—
label	string | null	no	—
lastRestoredAt	string (date-time) | null	no	—
manifestJson	string | null	no	—
restoreCount	integer (int32)	no	—
sandboxId	string (uuid)	no	—

SandboxStatus

0 | 1 | 2 | 3 | 4 | 5 with no declared properties.

SandboxTier

0 | 1 | 2 | 3 | 4 with no declared properties.

ScenarioPackApplyResultDto

Property	Type	Required	Description
entityCount	integer (int32)	no	—
sandboxId	string (uuid)	no	—
scenarioPackId	string (uuid)	no	—
scenarioPackSlug	string | null	no	—

StartLabRequest

Property	Type	Required	Description
sandboxId	string (uuid)	no	—

SuspendSandboxRequest

Property	Type	Required	Description
reason	string | null	no	—

TimeSpan

Property	Type	Required	Description
days	integer (int32)	no	—
hours	integer (int32)	no	—
microseconds	integer (int32)	no	—
milliseconds	integer (int32)	no	—
minutes	integer (int32)	no	—
nanoseconds	integer (int32)	no	—
seconds	integer (int32)	no	—
ticks	integer (int64)	no	—
totalDays	number (double)	no	—
totalHours	number (double)	no	—
totalMicroseconds	number (double)	no	—
totalMilliseconds	number (double)	no	—
totalMinutes	number (double)	no	—
totalNanoseconds	number (double)	no	—
totalSeconds	number (double)	no	—

TrainingLabDto

Property	Type	Required	Description
id	string (uuid)	no	—
instructions	string | null	no	—
kind	TrainingLabKind	no	—
order	integer (int32)	no	—
passThreshold	integer (int32) | null	no	—
pathId	string (uuid)	no	—
scenarioPackSlug	string | null	no	—
slug	string | null	no	—
timeLimit	TimeSpan	no	—
title	string | null	no	—
validationManifestJson	string | null	no	—

TrainingLabKind

0 | 1 | 2 with no declared properties.

TrainingLabRequestSpec

Property	Type	Required	Description
instructions	string | null	no	—
kind	TrainingLabKind	no	—
passThreshold	integer (int32) | null	no	—
scenarioPackSlug	string | null	no	—
slug	string | null	no	—
timeLimitSeconds	integer (int32) | null	no	—
title	string | null	no	—
validationManifestJson	string | null	no	—

TrainingPathDto

Property	Type	Required	Description
authorId	string (uuid)	no	—
id	string (uuid)	no	—
isPublished	boolean	no	—
labs	TrainingLabDto[] | null	no	—
publishedAt	string (date-time) | null	no	—
slug	string | null	no	—
summary	string | null	no	—
title	string | null	no	—

TrainingProgressDto

Property	Type	Required	Description
completedAt	string (date-time) | null	no	—
deadline	string (date-time) | null	no	—
feedback	string | null	no	—
id	string (uuid)	no	—
labId	string (uuid)	no	—
learnerUserId	string (uuid)	no	—
pathId	string (uuid)	no	—
sandboxId	string (uuid) | null	no	—
score	integer (int32) | null	no	—
startedAt	string (date-time)	no	—
state	TrainingProgressState	no	—

TrainingProgressState

0 | 1 | 2 | 3 | 4 with no declared properties.

UpdateSandboxConfigRequest

Property	Type	Required	Description
description	string | null	no	—
name	string | null	no	—