Skip to content
DashboardGet API key

Get function

View .md
GET

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Path parameters

  • functionIdstringrequired

    Zavu Function ID.

Responses

200Function details.
  • functionobjectrequired

    A Zavu Function — user-supplied TypeScript that runs in Zavu Cloud and reacts to messaging events or HTTP requests.

    14 properties
    • idstringrequired
    • slugstringrequired

      URL-safe identifier, unique per project.

    • namestringrequired
    • descriptionstringnullable
    • runtimestringrequired

      Runtime the function is deployed on.

      One ofnodejs24
    • statusstringrequired

      Lifecycle status of a Zavu Function.

      One ofdraftbundlingdeployingactivefaileddisabled
    • timeoutSecintegerrequired

      Per-invocation timeout in seconds.

    • memoryMbintegerrequired

      Memory allocation in MB.

    • httpEnabledbooleanrequired

      Whether the function can be invoked over HTTPS via its public URL.

    • publicUrlstring<uri>nullable

      HTTPS endpoint, present only while httpEnabled is true. Null otherwise, including for a function that was previously exposed — the stored URL stops serving the moment HTTP is turned off, so it is never returned.

    • dependenciesobjectrequired

      npm dependencies installed in the function bundle. Keys are package names, values are semver ranges.

      1 properties
      • {key}string
    • activeDeploymentIdstringnullable

      ID of the deployment currently serving traffic.

    • createdAtstring<date-time>required
    • updatedAtstring<date-time>required
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject
404Function not found.
  • codestringrequired
  • messagestringrequired
  • detailsobject