CoCoCoCoCoCo / docs
← API reference
Mutation / files

testStorageBackend

Probe a storage backend's connectivity with its stored credentials (a bucket/root head — nothing is written). Never throws: a failure comes back as ok: false with a reason. Requires storageBackend:read permission.

Arguments

idStorageBackendID!

TypeID (sbk_ prefix) of the backend to probe.

Returns StorageBackendProbeResult!

Scalar fields at a glance

okBoolean!
errorString
↗ View the complete StorageBackendProbeResult type

Explore in a view

Print PrepressProduction Floor
View exact SDL
"""
Probe a storage backend's connectivity with its stored credentials (a bucket/root head — nothing is written). Never throws: a failure comes back as ok: false with a reason. Requires storageBackend:read permission.
"""
testStorageBackend(
  """TypeID (`sbk_` prefix) of the backend to probe."""
  id: StorageBackendID!
): StorageBackendProbeResult! @topic(names: ["files"])

Schema reference describes the API contract. Actual access is checked by the platform for every operation.