Functions API

The Functions API enables deployment and execution of serverless functions written in JavaScript/TypeScript, running in a secure Deno runtime environment.

Base URL

Admin endpoints: /api/functions
Execution endpoint: /functions

Function Management

List All Functions

curl https://your-app.region.insforge.app/api/functions \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Retrieve all functions with metadata (admin only). Response

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "slug": "hello-world",
    "name": "Hello World Function",
    "description": "Returns a greeting message",
    "status": "active",
    "created_at": "2024-01-21T10:30:00Z",
    "updated_at": "2024-01-21T10:35:00Z",
    "deployed_at": "2024-01-21T10:35:00Z"
  },
  {
    "id": "223e4567-e89b-12d3-a456-426614174001",
    "slug": "process-webhook",
    "name": "Webhook Processor",
    "description": "Processes incoming webhooks",
    "status": "draft",
    "created_at": "2024-01-22T14:20:00Z",
    "updated_at": "2024-01-22T14:20:00Z",
    "deployed_at": null
  }
]

Create Function

curl -X POST https://your-app.region.insforge.app/api/functions \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Hello World Function",
    "slug": "hello-world",
    "description": "Returns a personalized greeting",
    "status": "active",
    "code": "export default async function(request) {\n  const { name = '"'"'World'"'"' } = await request.json();\n  return new Response(\n    JSON.stringify({ message: `Hello, ${name}!` }),\n    { headers: { '"'"'Content-Type'"'"': '"'"'application/json'"'"' } }\n  );\n}"
  }'

Create a new serverless function (admin only). Body Parameters

name

string

required

Display name for the function

slug

string

URL-friendly identifier (auto-generated from name if not provided)

code

string

required

JavaScript/TypeScript code exporting async function

description

string

Description of what the function does

status

string

default:"active"

Initial status: draft or active

Response

{
  "success": true,
  "function": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "slug": "hello-world",
    "name": "Hello World Function",
    "description": "Returns a personalized greeting",
    "status": "active",
    "created_at": "2024-01-21T10:30:00Z",
    "updated_at": "2024-01-21T10:30:00Z",
    "deployed_at": "2024-01-21T10:30:00Z"
  }
}

Example Function Code

Simple Hello World

export default async function(request) {
  const { name = 'World' } = await request.json();
  return new Response(
    JSON.stringify({ message: `Hello, ${name}!` }),
    { headers: { 'Content-Type': 'application/json' } }
  );
}

Database Query

export default async function(request) {
  const supabaseUrl = Deno.env.get('SUPABASE_URL');
  const supabaseKey = Deno.env.get('SUPABASE_KEY');
  
  const response = await fetch(`${supabaseUrl}/rest/v1/posts?select=*`, {
    headers: {
      'apikey': supabaseKey,
      'Authorization': `Bearer ${supabaseKey}`
    }
  });
  
  const posts = await response.json();
  return new Response(JSON.stringify(posts), {
    headers: { 'Content-Type': 'application/json' }
  });
}

Get Function Details

curl https://your-app.region.insforge.app/api/functions/hello-world \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Retrieve function details including code (admin only). Path Parameters

slug

string

required

Function slug identifier

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "slug": "hello-world",
  "name": "Hello World Function",
  "description": "Returns a greeting message",
  "code": "export default async function(request) {\n  const { name = 'World' } = await request.json();\n  return new Response(\n    JSON.stringify({ message: `Hello, ${name}!` }),\n    { headers: { 'Content-Type': 'application/json' } }\n  );\n}",
  "status": "active",
  "created_at": "2024-01-21T10:30:00Z",
  "updated_at": "2024-01-21T10:35:00Z",
  "deployed_at": "2024-01-21T10:35:00Z"
}

Update Function

curl -X PUT https://your-app.region.insforge.app/api/functions/hello-world \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Hello World Function v2",
    "description": "Updated greeting function",
    "code": "export default async function(request) {\n  return new Response('"'"'Hello!'"'"');\n}"
  }'

Update function code or metadata (admin only). Path Parameters

slug

string

required

Function slug identifier

Body Parameters

name

string

New display name

code

string

Updated function code

description

string

Updated description

status

string

Function status: draft, active, or error

Response

{
  "success": true,
  "function": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "slug": "hello-world",
    "name": "Hello World Function v2",
    "description": "Updated greeting function",
    "status": "active",
    "updated_at": "2024-01-21T11:00:00Z",
    "deployed_at": "2024-01-21T11:00:00Z"
  }
}

Delete Function

curl -X DELETE https://your-app.region.insforge.app/api/functions/hello-world \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Permanently delete a function (admin only). Path Parameters

slug

string

required

Function slug identifier

Response

{
  "success": true,
  "message": "Function hello-world deleted successfully"
}

Function Execution

Execute Function (GET)

curl https://your-app.region.insforge.app/functions/hello-world

Execute function using GET method. Path Parameters

slug

string

required

Function slug identifier

Response The response depends on what your function returns. The function controls the status code, headers, and body.

{
  "message": "Hello, World!"
}

Execute Function (POST)

curl -X POST https://your-app.region.insforge.app/functions/hello-world \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John",
    "age": 30
  }'

Execute function with JSON body using POST method. Path Parameters

slug

string

required

Function slug identifier

Body Any JSON data your function expects. Response

{
  "message": "Hello, John!"
}

Execute Function (PUT)

curl -X PUT https://your-app.region.insforge.app/functions/update-record \
  -H "Content-Type: application/json" \
  -d '{
    "id": "123",
    "status": "completed"
  }'

Execute function using PUT method.

Execute Function (PATCH)

curl -X PATCH https://your-app.region.insforge.app/functions/partial-update \
  -H "Content-Type: application/json" \
  -d '{
    "status": "active"
  }'

Execute function using PATCH method.

Execute Function (DELETE)

curl -X DELETE https://your-app.region.insforge.app/functions/delete-resource?id=123

Execute function using DELETE method.

Function Environment

Available APIs

Functions run in a Deno runtime with access to:

Web APIs: fetch, Request, Response, URL, etc.
Deno APIs: Deno.env.get(), file system (restricted)
Standard library: Built-in JavaScript/TypeScript features

Environment Variables

Access environment variables using Deno.env.get():

const apiKey = Deno.env.get('API_KEY');
const dbUrl = Deno.env.get('DATABASE_URL');

Request Object

The request parameter provides:

export default async function(request) {
  // HTTP method
  const method = request.method; // GET, POST, etc.
  
  // Headers
  const contentType = request.headers.get('Content-Type');
  const auth = request.headers.get('Authorization');
  
  // URL and query params
  const url = new URL(request.url);
  const id = url.searchParams.get('id');
  
  // Body (for POST/PUT/PATCH)
  const body = await request.json();
  // OR
  const text = await request.text();
  
  // Return response
  return new Response(
    JSON.stringify({ success: true }),
    { 
      status: 200,
      headers: { 'Content-Type': 'application/json' }
    }
  );
}

Error Handling

export default async function(request) {
  try {
    const data = await request.json();
    
    if (!data.name) {
      return new Response(
        JSON.stringify({ error: 'Name is required' }),
        { status: 400, headers: { 'Content-Type': 'application/json' } }
      );
    }
    
    // Process data...
    return new Response(
      JSON.stringify({ success: true }),
      { status: 200, headers: { 'Content-Type': 'application/json' } }
    );
    
  } catch (error) {
    return new Response(
      JSON.stringify({ error: error.message }),
      { status: 500, headers: { 'Content-Type': 'application/json' } }
    );
  }
}

Security Restrictions

Functions cannot use:

Deno.run() - Process execution blocked
Unrestricted file system access
Network access to internal services

Status Codes

200 - Function executed successfully
404 - Function not found or not active
502 - Failed to proxy to Deno runtime
500 - Function threw an error

Core APIs

Management APIs

Base URL

Function Management

List All Functions

Create Function

Get Function Details

Update Function

Delete Function

Function Execution

Execute Function (GET)

Execute Function (POST)

Execute Function (PUT)

Execute Function (PATCH)

Execute Function (DELETE)

Function Environment

Available APIs

Environment Variables

Request Object

Error Handling

Security Restrictions

Status Codes

Build docs developers (and LLMs) love

Core APIs

Management APIs

​Base URL

​Function Management

​List All Functions

​Create Function

​Get Function Details

​Update Function

​Delete Function

​Function Execution

​Execute Function (GET)

​Execute Function (POST)

​Execute Function (PUT)

​Execute Function (PATCH)

​Execute Function (DELETE)

​Function Environment

​Available APIs

​Environment Variables

​Request Object

​Error Handling

​Security Restrictions

​Status Codes

Build docs developers (and LLMs) love

Base URL

Function Management

List All Functions

Create Function

Get Function Details

Update Function

Delete Function

Function Execution

Execute Function (GET)

Execute Function (POST)

Execute Function (PUT)

Execute Function (PATCH)

Execute Function (DELETE)

Function Environment

Available APIs

Environment Variables

Request Object

Error Handling

Security Restrictions

Status Codes