Skip to main content
POST
db.function.mutation

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
name
string
required

The function to call: "module:function" or "folder/module:function" (module path, colon, export name).

Pattern: ^[A-Za-z0-9_][A-Za-z0-9_-]{0,63}(\/[A-Za-z0-9_][A-Za-z0-9_-]{0,63}){0,9}(:[A-Za-z_][A-Za-z0-9_]{0,63})?$
args
object

The function's arguments as a JSON object, at most 1 MB. Default {}.

Response

The result

value

The function's return value. Absent when it returned nothing.