Sign in
Functions

Resolve function name for invocation

Changed on

Resolves a DNS-safe function name to its function ID and invocation URL within the caller's project.

SDKs use this endpoint internally to invoke by function name while routing by function ID. Invoke the returned invoke_url as-is. It does not share a domain with the API, so a host built from the API URL will not reach the function. When the deployment serves no public invocation domain, as in local development, invoke_url is omitted and callers invoke through POST /functions/{functionId}/invoke.

With Service Key:

  • Allowed

With Auth User Token:

  • Allowed for authenticated and public functions
  • A private function answers 404, exactly as a missing one

With Anon Key:

  • Requires anon key permission: functions.invoke
  • Function must have visibility: public; any other answers 404
get/functions/resolve

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/functions/resolve
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Query parameters

namestring required

DNS-safe function name (lowercase letters, numbers, hyphens; cannot start or end with hyphen)

Response

Function resolved successfully

namestring required

DNS-safe function name

function_idstring uuid required

Canonical function ID used for invocation routing

invoke_urlstring

Canonical HTTPS endpoint for invoking this function. Use it as-is: it does not share a domain with the API, so a host derived from the API URL will not reach the function. Omitted when the deployment serves no public invocation domain, as in local development; invoke through POST /functions/{functionId}/invoke instead.

cache_ttl_secondsinteger required

Suggested SDK cache TTL for this name-to-ID mapping

Changes

  • 3a6f365f3f35Revision changes
    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

  • bb44e98aba2eRevision changes
    • ▲

      the response's body type changed from object to no type for status

    • ▲

      the response's body type changed from object to no type for status

    • ▲

      the response's body type changed from object to no type for status

    • ▲

      the response's body type changed from object to no type for status

    • ▲

      the response's body type changed from object to no type for status

    • ▲

      removed the required property from the response with the status

    • ▲

      removed the required property from the response with the status

    • ▲

      removed the required property from the response with the status

    • ▲

      removed the required property from the response with the status

    • ▲

      removed the required property from the response with the status

    • ▲

      removed the required property from the response with the status

    • ▲

      removed the required property from the response with the status

    • ●

      removed the optional property from the response with the status

    • ●

      removed the optional property from the response with the status

    • ●

      removed the optional property from the response with the status

    • ●

      removed the optional property from the response with the status