Skip to main content

Function Management

Manage your serverless functions using the Invoke CLI.

Creating Functions​

The quickest way to create and deploy a new function:

# 1. Scaffold a new function directory
invoke init my-api --name my-api --description "REST API handler" --project "my-project"

# 2. Enter the directory
cd my-api

# 3. Deploy (creates on first run, updates on subsequent runs)
invoke function:deploy --name my-api --project "my-project"

Deploy a Function (Smart Upsert)​

function:deploy is the primary deployment command. It creates the function if it doesn't exist, then uploads and activates a new version in one step:

invoke function:deploy [path] --name <name> --project <project>

Arguments:

  • [path] - Path to function directory or zip file (default: .)

Required options:

  • --name (required): Function name
  • --project (required): Project ID or name

Options:

  • --description: Function description (used on first creation only)
  • --requires-api-key: Require API key for invocation (creation only)
  • --output: Output format (table/json)

Examples:

# Deploy current directory
invoke function:deploy --name my-api --project "my-project"

# Deploy a specific path
invoke function:deploy ./my-api --name my-api --project "my-project"

# Deploy with API key requirement
invoke function:deploy --name secure-api --project "my-project" --requires-api-key

The CLI will:

  1. Check if the function exists; create it if not
  2. Upload the code (auto-zips directories)
  3. Automatically activate the new version

Create a Function (Low-level)​

For more control, use function:create to create the function record and upload code separately:

invoke function:create \
  --name my-api \
  --description "REST API handler" \
  --project abc123 \
  ./my-function

Options:

  • --name (required): Function name
  • --description: Function description
  • --project: Project ID (defaults to default project)
  • --requires-api-key: Require API key for execution
  • --output: Output format (table/json)

Listing Functions​

List All Functions​

invoke function:list

Example output:

⚡ Functions:

┌──────────────────────────┬───────────┬────────┬──────────┐
│ Name                     │ Project   │ Active │ Version  │
├──────────────────────────┼───────────┼────────┼──────────┤
│ my-api                   │ Default   │ Yes    │ 2        │
│ webhook-handler          │ Default   │ Yes    │ 1        │
│ data-processor           │ Analytics │ No     │ 3        │
└──────────────────────────┴───────────┴────────┴──────────┘

With JSON output:

invoke function:list --output json

Getting Function Details​

Get Function Info​

Use either the function ID or name:

# By name
invoke function:get my-api

# By UUID
invoke function:get cd23cc1f-936f-445e-b2ba-dd8306b8dc01

Example output:

⚡ Function Details:

ID: cd23cc1f-936f-445e-b2ba-dd8306b8dc01
Name: my-api
Description: REST API handler
Project: Default Project
Active: Yes
Requires API Key: No
Active Version: 2
Created: 23/2/2026, 1:44:11 pm
Updated: 23/2/2026, 2:15:30 pm
Last Executed: 23/2/2026, 2:10:57 pm
Total Executions: 142

Updating Functions​

Update Function Metadata​

invoke function:update my-api \
  --name my-rest-api \
  --description "Updated REST API" \
  --active true

Options:

  • --name: New function name
  • --description: New description
  • --active: Set active status (true/false)
  • --requires-api-key: Require API key (true/false)

Activating and Deactivating​

Activate a Function​

invoke function:activate my-api

Deactivate a Function​

invoke function:deactivate my-api

Deactivated functions cannot be executed until reactivated.

Deleting Functions​

Delete a Function​

invoke function:delete my-api

You'll be prompted for confirmation:

? Are you sure you want to delete function my-api? This cannot be undone. (y/N)

Skip confirmation:

invoke function:delete my-api --force
danger

Deleting a function removes all versions, logs, and environment variables permanently!

Function API Keys​

Show API Key​

Display the function's API key (if enabled):

invoke function:key:show my-api

Example output:

🔑 Function API Key:

func_abc123def456...

Regenerate API Key​

Generate a new API key for the function:

invoke function:key:regenerate my-api

You'll be prompted for confirmation:

? Are you sure? This will invalidate the existing API key. (y/N)

Skip confirmation:

invoke function:key:regenerate my-api --force

Example output:

✅ API key regenerated successfully

🔑 New API Key:

func_xyz789abc123...

Tips​

Using Function Names​

All commands support function names in addition to UUIDs:

# These are equivalent
invoke function:get cd23cc1f-936f-445e-b2ba-dd8306b8dc01
invoke function:get my-api

JSON Output​

Get machine-readable output with --output json:

invoke function:get my-api --output json

This is useful for scripting and automation.

Quick Status Check​

invoke function:list | grep "my-api"