Sign in
Functions

Get function by ID

Changed on
get/projects/{id}/functions/{functionId}

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/projects/{id}/functions/{functionId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring uuid required

Project ID

functionIdstring uuid required

Function ID

Response

Successful response

idstring uuid required
project_idstring uuid required
namestring required
status'provisioning' | 'active' | 'failed' | 'deleting' required
provisioning_started_atstring date-time

Timestamp when the current provisioning phase started

visibility'private' | 'authenticated' | 'public' required

Who can invoke the function. Each level admits everything the one before it does.

  • private: service keys and the project's schedulers only. The default for a new function. To any other credential the function does not exist: it answers 404, like a missing one.
  • authenticated: also any signed-in user of the project, including anonymous sign-ins. The function receives their auth context.
  • public: also anon keys holding functions.invoke, and Frontend Function routes, which forward requests without a credential.
is_publicboolean required

Deprecated. true exactly when visibility is public.

invocation_mode'rpc' | 'http' required

Invocation contract. rpc preserves the existing POST {payload: ...} contract; http forwards HTTP request semantics to the function runtime.

http_auth_mode'volcano' | 'none' required

Authentication applied by the HTTP ingress. none is valid only for HTTP-mode functions with visibility: public and is intended for externally signed webhooks.

openapi_specobject nullable required

Optional OpenAPI 3.0 or 3.1 document describing an HTTP-mode function.

has_openapi_specboolean required

Whether OpenAPI metadata is configured; list responses omit the document itself.

invoke_urlstring

Canonical geo-routed 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, so a client testing for an empty string never matches.

deployed_regionsstring[] required

Regions where this function is currently deployed

runtimestring
handlerstring
current_deployment_idstring uuid

Identifier of the latest function deployment operation

pending_deployment_idstring uuid

Newest queued deployment that will run after the current operation

last_invoked_atstring date-time

Most recent successful invocation timestamp

created_atstring date-time required
updated_atstring date-time required

Changes

  • 23e7875e7c4cRevision changes
    • ●

      removed the optional property from the response with the status

    • ○

      the endpoint scheme security ProjectAccessToken was added to the API

    • ○

      response property is_public deprecated

    • ○

      added the required property to the response with the status

  • 3a6f365f3f35Revision changes
    • ▲

      added the new path request parameter functionId

    • ▲

      added the new path request parameter id

    • ▲

      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 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

    • ○

      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