Skip to content
DashboardGet API key

Configure a function

View .md
PATCH

Name, description, timeout, memory, architecture, pause and the HTTP endpoint, with the same rules as the dashboard's Settings tab.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Path parameters

  • functionIdstringrequired

Body

application/json

  • namestring
    Limitsmin length 1 · max length 80
  • descriptionstringnullable

    null clears it.

    Limitsmax length 280
  • timeoutSecinteger

    Applied on the next deploy.

    Limitsmin 1 · max 180
  • memoryMbinteger

    Applied on the next deploy.

    One of1282565121024
  • architecturestring
    One ofarm64x86_64
  • enabledboolean

    false pauses the function, true resumes it. Refused with 409 function_not_ready while it is a draft, deploying, or its first deploy failed.

  • httpEnabledboolean

    Switch the public endpoint on or off. Applies to the deployed function without a redeploy.

Responses

200The function after the change.
  • functionobjectrequired

    A Zavu Function: TypeScript that runs in Zavu Cloud, either reacting to events, serving HTTP, or holding the agents its code declares.

    16 properties
    • idstringrequired
    • slugstringrequired
    • namestringrequired
    • descriptionstringnullable
    • runtimestringrequired
    • statusstringrequired
      One ofdraftdeployingactivefaileddisabled
    • enabledbooleanrequired

      True only while a version is live and not paused (status: active). A draft, a failed first deploy, a deploy in progress or a pause are all false.

    • timeoutSecintegerrequired
    • memoryMbintegerrequired
      One of1282565121024
    • architecturestringrequired

      arm64 is the default and the cheaper one; x86_64 bills each invocation at 1.25x units. Applied on the next deploy.

      One ofarm64x86_64
    • httpEnabledbooleanrequired
    • publicUrlstring<uri>nullable

      Null while httpEnabled is false: the URL does not serve then.

    • activeDeploymentIdstringnullable
    • createdAtstring<date-time>required
    • updatedAtstring<date-time>required
    • pausedbooleanrequired

      The customer paused it. A deploy, a git push or a rollback does not resume it. Pausing stops event triggers; the HTTP endpoint has its own switch, httpEnabled, and the tools of the agents it declares keep answering.

400Nothing to change, or invalid values (each in `details.errors`).
  • codestringrequired
  • messagestringrequired
  • detailsobject

    Machine-readable context. Keys that mean the same thing everywhere: - errors: present on every 400 invalid_request for an invalid body or query parameter, [{path, message, ...}], path naming the field (["to"], ["contacts", 2, "recipient"], ["limit"]). - recommendation: one sentence saying what to do next. - dashboardUrl: the dashboard screen that fixes it. - connect: on 409 no_channel, the channels this project can connect to reach the recipient, each {type, request, note, available, dashboardUrl?}; request is the exact call (POST /v2/channels with its body, or POST /v2/numbers), or null for a channel connected from the dashboard (WhatsApp, Instagram, Messenger). available: false says why in note (one-way SMS closed until business verification is approved). - address / from: the address the error is about, under the name the request used for it.

    1 properties
    • errorsobject[]
      3 properties
      • pathobject[]required
      • messagestringrequired
      • codestring
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject

    Machine-readable context. Keys that mean the same thing everywhere: - errors: present on every 400 invalid_request for an invalid body or query parameter, [{path, message, ...}], path naming the field (["to"], ["contacts", 2, "recipient"], ["limit"]). - recommendation: one sentence saying what to do next. - dashboardUrl: the dashboard screen that fixes it. - connect: on 409 no_channel, the channels this project can connect to reach the recipient, each {type, request, note, available, dashboardUrl?}; request is the exact call (POST /v2/channels with its body, or POST /v2/numbers), or null for a channel connected from the dashboard (WhatsApp, Instagram, Messenger). available: false says why in note (one-way SMS closed until business verification is approved). - address / from: the address the error is about, under the name the request used for it.

    1 properties
    • errorsobject[]
      3 properties
      • pathobject[]required
      • messagestringrequired
      • codestring
404Function not found.
  • codestringrequired
  • messagestringrequired
  • detailsobject

    Machine-readable context. Keys that mean the same thing everywhere: - errors: present on every 400 invalid_request for an invalid body or query parameter, [{path, message, ...}], path naming the field (["to"], ["contacts", 2, "recipient"], ["limit"]). - recommendation: one sentence saying what to do next. - dashboardUrl: the dashboard screen that fixes it. - connect: on 409 no_channel, the channels this project can connect to reach the recipient, each {type, request, note, available, dashboardUrl?}; request is the exact call (POST /v2/channels with its body, or POST /v2/numbers), or null for a channel connected from the dashboard (WhatsApp, Instagram, Messenger). available: false says why in note (one-way SMS closed until business verification is approved). - address / from: the address the error is about, under the name the request used for it.

    1 properties
    • errorsobject[]
      3 properties
      • pathobject[]required
      • messagestringrequired
      • codestring
409`function_not_ready`: pausing or resuming a function that is a draft, deploying, or whose last deploy failed.
  • codestringrequired
  • messagestringrequired
  • detailsobject

    Machine-readable context. Keys that mean the same thing everywhere: - errors: present on every 400 invalid_request for an invalid body or query parameter, [{path, message, ...}], path naming the field (["to"], ["contacts", 2, "recipient"], ["limit"]). - recommendation: one sentence saying what to do next. - dashboardUrl: the dashboard screen that fixes it. - connect: on 409 no_channel, the channels this project can connect to reach the recipient, each {type, request, note, available, dashboardUrl?}; request is the exact call (POST /v2/channels with its body, or POST /v2/numbers), or null for a channel connected from the dashboard (WhatsApp, Instagram, Messenger). available: false says why in note (one-way SMS closed until business verification is approved). - address / from: the address the error is about, under the name the request used for it.

    1 properties
    • errorsobject[]
      3 properties
      • pathobject[]required
      • messagestringrequired
      • codestring