CoCoCoCoCoCo / docs
← API reference
Query / files

getHostPathBackend

Fetch one storage backend as a host-path backend. Null when no backend with that id exists in the caller's tenant, or when it exists but is not host-path — a backend has exactly one kind, so asking for the wrong face is a miss rather than an error. Requires storageBackend:read permission.

Arguments

idStorageBackendID!

TypeID (sbk_ prefix) of the backend to fetch.

Returns HostPathBackend

Scalar fields at a glance

pathString!
↗ View the complete HostPathBackend type

Explore in a view

Print PrepressProduction Floor
View exact SDL
"""
Fetch one storage backend as a host-path backend. Null when no backend with that id exists in the caller's tenant, or when it exists but is not host-path — a backend has exactly one kind, so asking for the wrong face is a miss rather than an error. Requires storageBackend:read permission.
"""
getHostPathBackend(
  """TypeID (`sbk_` prefix) of the backend to fetch."""
  id: StorageBackendID!
): HostPathBackend @topic(names: ["files"])

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