← All resources

Resource

storage_backend

A configured storage destination for a tenant (archives, transfers, folder bindings). Credentials are never returned; each backend kind's block exposes a hasCredentials flag instead.

GraphQL reference →

Configuration

nameString!Required

Storage backend name (required)

descriptionStringOptional

Optional description

configStorageBackendConfig!Required

Connection settings for exactly one kind of backend.

View CreateStorageBackendConfigInput fields →

Input types

Fields for the structured values used in this resource’s configuration.

CreateStorageBackendConfigInput

A backend's connection settings on create. Exactly one kind, and which one decides the backend's kind — there is no separate discriminator to disagree with it. Google Drive and Dropbox are absent on purpose: they are connected through the OAuth consent flow, so they cannot be declared here at all.

Set exactly one field to a non-null value.

s3CreateS3BackendInputOptional

S3-compatible object storage.

View CreateS3BackendInput fields →

hostPathHostPathBackendInputOptional

A directory on the machine running the server.

View HostPathBackendInput fields →

ftpCreateFTPBackendInputOptional

An FTP server.

View CreateFTPBackendInput fields →

CreateS3BackendInput

S3-compatible connection settings on create. Everything the server will not invent is non-null here, so a half-filled configuration is refused while the document is being written rather than at apply time.

endpointString!Required

S3 endpoint URL.

regionString!Required

Bucket region.

bucketString!Required

Bucket name.

pathStyleBooleanOptional

Use path-style addressing rather than virtual-hosted. Needed by most S3-compatible servers.

accessKeyIdString!Required

Write-only; never returned. Set together with secretAccessKey.

secretAccessKeyString!Required

Write-only; never returned. Set together with accessKeyId.

HostPathBackendInput

Host-path connection settings. Refused unless the deployment enables host-path storage.

pathString!Required

Directory beneath the deployment's STORAGE_HOSTPATH_ROOT.

CreateFTPBackendInput

FTP connection settings on create. Plaintext and password-only — no FTPS, and no key-based auth.

hostString!Required

FTP host.

portIntOptional

FTP port. Defaults to 21.

usernameString!Required

FTP username.

passwordString!Required

Write-only; never returned.

rootPathStringOptional

Path on the server that this backend is rooted at.

passiveModeBooleanOptional

Use passive mode. Defaults to true.

Read-only values

Show values
idStorageBackendID!Read only

TypeID of this storage backend (sbk_ prefix, e.g. "sbk_01K…").

computed by the platform

tenantIdTenantID!Read only

TypeID of the tenant that owns this backend (ten_ prefix). Backends are tenant-scoped; every read and mutation is filtered by the caller's tenant.

computed by the platform

statusStorageBackendConnectionStatus!Read only

Whether the backend's stored credentials are usable right now. Only OAuth backends ever leave CONNECTED — either while a draft awaits its first consent, or after a refresh token is revoked/expires.

Allowed values

CONNECTED — The backend's stored credentials are usable, so it can serve transfers. Non-OAuth backends (S3, host-path, FTP) never report anything else.

NEEDS_REAUTHORIZATION — An OAuth consent flow has to be run before the backend can be used. Covers both a draft backend still awaiting its first authorization and a live one whose refresh token was revoked or expired; reauthorizationReason says which, when a reason was recorded.

computed by the platform

reauthorizationReasonStringRead only

Why the backend needs reauthorizing (e.g. "authorization pending"). Non-null only when status is NEEDS_REAUTHORIZATION, and even then may be null if no reason was recorded.

computed by the platform

createdAtString!Read only

ISO-8601 timestamp of when the backend row was first created.

computed by the platform

updatedAtString!Read only

ISO-8601 timestamp of the last change to the backend — including a config or credential change, not just a rename.

computed by the platform

Lifecycle

The CLI can create this resource. The platform assigns its id.

When replacement is needed, the existing resource is removed before its replacement is created.