← API reference
Query / files

getFTPBackend

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

Arguments

TypeID (sbk_ prefix) of the backend to fetch.

Returns FTPBackend

Scalar fields at a glance

hostString!
portInt!
usernameString!
rootPathString!
passiveModeBoolean!
hasCredentialsBoolean!
↗ View the complete FTPBackend type

Explore in a view

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

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