Alpine· Docs
Contents

Reference · Management sandboxes

Retire a Test sandbox

Close a Test sandbox after its child Application keys have been reconciled and revoked.

POST/management/v1/sandboxes/{sandboxRef}/retire

Authorization: Bearer mk_test_… · Management key

Idempotency-Key: <uuid> · required

semantic: management_sandbox_retire_command

Key capabilities

  • SandboxRetire

Parameters

sandboxRefpath · required

Response fields

  • sandbox
  • changed
  • replay

Contract notes

targetEnvironmentKinddemo_sandbox
liveAccessnot_supported_by_management_api
idempotencyMaterialsandboxRef
firstSubmissionStatus200_ok
replayStatus200_ok
retirementAuthoritymanagement_sandbox_anchor

Sharp edges

  • Retire child authority before the parent sandbox; idempotency does not make an incorrect target safe.

generated from openapi.json · gateway 0.1.0 · sandbox