SEseqeralabs
compute-envs

Validate a compute environment

Changed on

Re-runs the pre-flight checks (associated-credential validation and work-directory accessibility) for the compute environment identified by the given computeEnvId and persists the outcome to the compute environment and its credential. Intended to recover a compute environment marked INVALID after the underlying problem has been fixed. Available only while the pre-flight feature is enabled.

post/compute-envs/{computeEnvId}/validate

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Path parameters

computeEnvIdstring required

Compute environment string identifier

Query parameters

workspaceIdinteger

Workspace numeric identifier

forceboolean

When true, skip the credential and work-dir checks and force the compute environment (INVALID only, with an AVAILABLE credential) to AVAILABLE. Rejected with 409 otherwise.

Request body

EmptyBodyRequest required

Response

Validation outcome - inspect status and the transientError flag on the response body

messagestring nullable

Human-readable explanation of the outcome: the failure reason when the compute environment is INVALID, the provider-unreachable reason on a transient outcome, or null when the compute environment is AVAILABLE.

status'CREATING' | 'AVAILABLE' | 'DISABLED' | 'DELETING' | 'ERRORED' | 'INVALID' | 'DELETED'
transientErrorboolean

True when a provider could not be reached (timeout / throttle / 5xx). The persisted status is left unchanged; retry later.

Changes