doctl serverless functions invoke

Go to Navigation


doctl serverless functions invoke <functionName> [flags]


Invokes a function in your functions namespace. You can provide inputs and inspect outputs.


The following example invokes a function named “example/helloWorld” with the parameters title:John,place:NY:

doctl serverless functions invoke example/helloWorld --param title:John,place:NY


Option Description
--full , -f Waits for the function to complete and then outputs the function’s response along with its complete activation record. The record contains log information, duration time, and other information about the function’s execution.
Default: false
--help , -h Help for this command
--no-wait , -n Asynchronously invokes the function and does not wait for the result to be returned. An activation ID is returned in the response, instead.
Default: false
--param , -p Key-value pairs of input parameters. For example, if your function takes two parameters called name and place, you would provide them as title:John,place:NY.
--param-file , -P A path to a file containing parameter values in JSON format, such as path/to/file.json.
--web Invokes the function as a web function and displays the result in your browser
Default: false
Command Description
doctl serverless functions Work with the functions in your namespace

Global Flags

Option Description
--access-token, -t API V2 access token
--api-url, -u Override default API endpoint
--config, -c Specify a custom config file
  • macOS: ${HOME}/Library/Application Support/doctl/config.yaml
  • Linux: ${XDG_CONFIG_HOME}/doctl/config.yaml
  • Windows: %APPDATA%\doctl\config.yaml
--context Specify a custom authentication context name
--http-retry-max Set maximum number of retries for requests that fail with a 429 or 500-level error
Default: 5
--http-retry-wait-max Set the minimum number of seconds to wait before retrying a failed request
Default: 30
--http-retry-wait-min Set the maximum number of seconds to wait before retrying a failed request
Default: 1
--interactive Enable interactive behavior. Defaults to true if the terminal supports it (default false)
Default: false
--output, -o Desired output format [text|json]
Default: text
--trace Show a log of network activity while performing a command
Default: false
--verbose, -v Enable verbose output
Default: false