functions

Activate function

Activate a deactivated function. Active functions can be triggered.

POST/api/functions/projects/{projectId}/functions/{functionId}/activate

Authentication

Requires JWT Requires API Key JWT or API Key

Note

This endpoint accepts either JWT Bearer token or API Key. Use Authorization: Bearer YOUR_TOKEN for user context, or X-API-Key: YOUR_KEY for server-to-server. View authentication guide →Include your JWT in the Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →Include your API key in the X-API-Key: YOUR_KEY header (server-to-server, SDKs). View authentication guide →

Path Parameters

Name	Type	Required	Description
`projectId`	string	Yes	Project ID (MongoDB ObjectId) that owns the function.
`functionId`	string	Yes	Function ID (MongoDB ObjectId) to activate.

SDK setup

Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.

import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");
import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");

Example request

Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.

const result = await client.functions.activate({
  projectId: "proj_YTPlcg1XX2TQ",
  functionId: "Mo47M99gXxw4Fvu5"
});
const result = await client.functions.activate({
  projectId: "proj_YTPlcg1XX2TQ",
  functionId: "Mo47M99gXxw4Fvu5"
});

Try It Live

Test this endpoint with your own credentials. Your requests will be sent to the live API.

API Key (optional)Get your API key from the console

JWT Bearer Token (optional)Use the auth endpoints to obtain a JWT.

Path Parameters

projectId

functionId

No Request Yet

Send a request to see the full inspector

Responses

200Function activated

json

{
  "success": true,
  "data": {
    "_id": "U4CATqYMhJauZX5r",
    "name": "Delilah Wehner",
    "description": "Introducing the Cuba-inspired Chair, blending grown style with local craftsmanship",
    "projectId": "proj_bDpJg8MziRQU",
    "trigger": {
      "type": "file",
      "event": "interface transmit",
      "schedule": "protocol transmit",
      "path": "card parse",
      "method": "GET",
      "collectionId": "0Cc9p4iUNtFNLaB4",
      "bucketId": "u8XSjcsxoiFgs8QF"
    },
    "stats": {
      "totalExecutions": 82,
      "successfulExecutions": 43143,
      "failedExecutions": 88320,
      "avgExecutionTime": 794.1,
      "lastExecution": "2026-03-19T05:31:46.204Z"
    },
    "isActive": true,
    "createdBy": "transmitter back up",
    "createdAt": "2026-02-06T20:12:01.509Z",
    "updatedAt": "2026-02-02T00:33:22.413Z"
  }
}
{
  "success": true,
  "data": {
    "_id": "U4CATqYMhJauZX5r",
    "name": "Delilah Wehner",
    "description": "Introducing the Cuba-inspired Chair, blending grown style with local craftsmanship",
    "projectId": "proj_bDpJg8MziRQU",
    "trigger": {
      "type": "file",
      "event": "interface transmit",
      "schedule": "protocol transmit",
      "path": "card parse",
      "method": "GET",
      "collectionId": "0Cc9p4iUNtFNLaB4",
      "bucketId": "u8XSjcsxoiFgs8QF"
    },
    "stats": {
      "totalExecutions": 82,
      "successfulExecutions": 43143,
      "failedExecutions": 88320,
      "avgExecutionTime": 794.1,
      "lastExecution": "2026-03-19T05:31:46.204Z"
    },
    "isActive": true,
    "createdBy": "transmitter back up",
    "createdAt": "2026-02-06T20:12:01.509Z",
    "updatedAt": "2026-02-02T00:33:22.413Z"
  }
}

400Bad request or validation error.

401Authentication required or invalid token.

403Access denied or insufficient permissions.

Errors

Code	Meaning
`400`	Bad request or validation error.
`401`	Authentication required or invalid token.
`403`	Access denied or insufficient permissions.

Run in Postman Download OpenAPI

Next steps

Edit this page on GitHub