← API reference
CANONICAL TYPE REFERENCE

FolderProbeResult

Outcome of the testFolder reachability probe against a folder's bound transport.

Distinguishes verified reachability, failure and an unverified prerequisite

okBoolean!

True when the folder's backend answered a cheap stat probe. A probe for an absent key still counts as success — reachability is what is tested, not the presence of any file.

errorString

Short, user-facing reason the probe failed (unreachable backend, unknown folder, a binding that cannot stat), or the reason readiness is unknown; the full error only reaches the server log. Null when ok is true.

View exact SDL
"""
Outcome of the testFolder reachability probe against a folder's bound transport.
"""
type FolderProbeResult {
  """
  Distinguishes verified reachability, failure and an unverified prerequisite
  """
  status: FolderProbeStatus!
  """
  True when the folder's backend answered a cheap stat probe. A probe for an absent key still counts as success — reachability is what is tested, not the presence of any file.
  """
  ok: Boolean!
  """
  Short, user-facing reason the probe failed (unreachable backend, unknown folder, a binding that cannot stat), or the reason readiness is unknown; the full error only reaches the server log. Null when ok is true.
  """
  error: String
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.