Sign in

v49

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01151216390.1 KB
Scenario

Archive a Scenario.

Archive a previously created Scenario. The scenario will no longer appear in list endpoints but can still be retrieved by ID.

post/v1/scenarios/{id}/archive

Path parameters

idstring required

The ID of the Scenario to archive.

Response

OK

idstring required

The ID of the Scenario.

namestring required

The name of the Scenario.

metadataobject required

User defined metadata to attach to the scenario for organization.

reference_outputstring nullable

A string representation of the reference output to solve the scenario. Commonly can be the result of a git diff or a sequence of command actions to apply to the environment.

required_environment_variablesstring[]

Environment variables required to run the scenario. If any required environment variables are missing, the scenario will fail to start.

required_secret_namesstring[]

Environment variables required to run the scenario. If any required secrets are missing, the scenario will fail to start.

is_publicboolean

Whether this scenario is public.

validation_type'UNSPECIFIED' | 'FORWARD' | 'REVERSE' | 'EVALUATION'
scorer_timeout_secinteger nullable

Timeout for scoring in seconds. Default 30 minutes (1800s).

status'active' | 'archived' required