Skip to content

FunctionInvokeOptions

Options for invoking a function.

Folder context is required: pass one of folderId, folderKey, or folderPath, or initialize the SDK with a folder context.

Extends

Properties

Property Type Description
expand? string -
folderId? number Numeric folder ID.
folderKey? string Folder key (GUID-formatted string).
folderPath? string Slash-delimited folder path, e.g. 'Shared/Finance'.
jobKey? string Key (GUID) of the job this invocation belongs to, so the run is attributed to it.
refreshLicense? boolean Acquires a fresh license instead of reusing the one already held for this user. Defaults to false. A license is reused for as long as it says it is valid, read from the license rather than assumed, so a burst of invocations costs one acquisition. A license that states no validity window — as the free tier's does not — is reused for five minutes and then re-acquired. Set this when the user's licensing may have changed and the invocation must reflect it before that lapses.
select? string -