Skip to content
SHC Docs

internalrpc response models

Generated file. Do not edit by hand. Regenerate from the repo root with CGO_ENABLED=0 go run scripts/gen-response-models-md.go.

Part of the API response model reference, which explains the Response model and Origin columns. Route inventory: routes.md. Named payload structs: payload-shapes.md.

MethodPathResponse modelOrigin
POST/api/join/{function_name}machine-only: a joining node’s call, never an operator API. {payload, alg, key_id, signature} (core/clustersign Signed): the function’s JSON answer as base64 payload, signed with the cluster CA key under the shc-join-response-v1 context; a refusal is the coded error envelope, unsignedannotation
POST/internal/rpc/{function_name}{result} on success, or the coded error envelope {error, error_code, error_kwargs, error_type}, always HTTP 200; a reply carrying binary values is application/vnd.shc.rpc-frames (the JSON envelope followed by raw frames)annotation
GET/internal/transfer/{id}application/octet-stream raw staged bytes of one transfer handle, served by HTTP Range (206) on the mesh address to the node the handle was issued to; only internal_rpc pulls itannotation