Skip to content
deploybase

Admin functions overview

GET
/api/v1/admin/functions
 
curl --request GET \
  --url https://api.deploybase.eu/api/v1/api/v1/admin/functions \
  --header 'Authorization: <Authorization>'

Functions adoption (beta grants, pending applications, active functions), the background invocation queue over 24h, HTTP function metrics from Cockpit, the top failing functions and every active function with its owner. Beta telemetry (DEP-594): limits_hit (7-day limit hits per function and kind; the Cockpit kinds body_413 and http_timeout are absent, never zero, when cockpit_available is false), cold_starts (pod starts and wakes, boot-time percentiles over wakes only, and an approximate wake share of HTTP requests that is null without Cockpit), retention (the last 8 ISO weeks, oldest first, every week present) and cost (7-day pod-seconds, GiB-seconds, background runtime and node pool usage). Only a database error fails the request.

Authorizations

Section titled “ Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

OK

Media type application/json
object
data
meta
object
request_id
string
timestamp
string
trace_id
string
data
object
adoption
object
functions_active_background
integer
functions_active_http
integer
teams_granted
integer
teams_pending
integer
teams_with_functions
integer
background_24h
object
cancelled
integer
completed
integer
failed
integer
failure_rate
number
oldest_pending_seconds
number
p50_ms
number
p95_ms
number
pending
integer
running
integer
stuck_running
integer
timed_out
integer
total
integer
cold_starts
object
functions
Array<object>
object
boot_ms_p50_7d
integer
boot_ms_p99_7d
integer
function_id
string
function_name
string
owner_email
string
pod_starts_7d
integer
pod_starts_24h
integer
project_name
string
team_id
string
wake_share_24h
number
wakes_7d
integer
wakes_24h
integer
platform
object
boot_ms_p50_7d
integer
boot_ms_p99_7d
integer
pod_starts_7d
integer
pod_starts_24h
integer
wake_share_24h
number
wakes_7d
integer
wakes_24h
integer
cost
object
platform
object
background_runtime_seconds_7d
integer
http_gib_seconds_7d
number
http_pod_seconds_7d
integer
pool
object
latest
object
allocatable_memory_mib
integer
node_count
integer
requested_memory_mib
integer
sampled_at
string
node_hours_7d
integer
teams
Array<object>
object
background_runtime_seconds_7d
integer
http_gib_seconds_7d
number
http_pod_seconds_7d
integer
memory_request_mib
integer
owner_email
string
peak_memory_mib
integer
team_id
string
functions
Array<object>
object
function_id
string
hostname

Hostname is the public origin of an HTTP function; null for background functions, and for an HTTP function that cannot have one (no project subdomain, or name+subdomain over the DNS label limit — the deployer refuses those too).

string
http_stats

HTTPStats is the function’s own interceptor traffic; null for a background function (it has no InterceptorRoute), same rule as Hostname.

object
available
boolean
error_rate_5xx
number
p50_ms
number
p99_ms
number
reason
string
requests_24h
integer
window_hours
integer
invocations_24h
integer
kind
string
name
string
owner_email
string
project_id
string
project_name
string
runtime
string
team_id
string
updated_at
string
generated_at
string
http_metrics
object
available
boolean
concurrency_now
number
error_rate_5xx
number
p50_ms
number
p99_ms
number
reason
string
requests_24h
integer
window_hours
integer
limits_hit

Functions beta telemetry (DEP-594).

object
cockpit_available
boolean
cockpit_reason
string
rows
Array<object>
object
count_7d
integer
count_24h
integer
function_id
string
function_name
string
kind
string
last_hit_at
string
owner_email
string
project_name
string
team_id
string
retention
object
weeks
Array<object>
object
active_teams
integer
background_invocations
integer
http_requests
integer
new_teams
integer
retained_teams
integer
week_start
string
top_failing
Array<object>
object
failures_24h
integer
function_id
string
function_name
string
kind
string
last_error
string
last_failed_at
string
owner_email
string
project_id
string
project_name
string
team_id
string

Example generated

{
  "data": {
    "adoption": {
      "functions_active_background": 1,
      "functions_active_http": 1,
      "teams_granted": 1,
      "teams_pending": 1,
      "teams_with_functions": 1
    },
    "background_24h": {
      "cancelled": 1,
      "completed": 1,
      "failed": 1,
      "failure_rate": 1,
      "oldest_pending_seconds": 1,
      "p50_ms": 1,
      "p95_ms": 1,
      "pending": 1,
      "running": 1,
      "stuck_running": 1,
      "timed_out": 1,
      "total": 1
    },
    "cold_starts": {
      "functions": [
        {
          "boot_ms_p50_7d": 1,
          "boot_ms_p99_7d": 1,
          "function_id": "example",
          "function_name": "example",
          "owner_email": "example",
          "pod_starts_7d": 1,
          "pod_starts_24h": 1,
          "project_name": "example",
          "team_id": "example",
          "wake_share_24h": 1,
          "wakes_7d": 1,
          "wakes_24h": 1
        }
      ],
      "platform": {
        "boot_ms_p50_7d": 1,
        "boot_ms_p99_7d": 1,
        "pod_starts_7d": 1,
        "pod_starts_24h": 1,
        "wake_share_24h": 1,
        "wakes_7d": 1,
        "wakes_24h": 1
      }
    },
    "cost": {
      "platform": {
        "background_runtime_seconds_7d": 1,
        "http_gib_seconds_7d": 1,
        "http_pod_seconds_7d": 1,
        "pool": {
          "latest": {
            "allocatable_memory_mib": 1,
            "node_count": 1,
            "requested_memory_mib": 1,
            "sampled_at": "example"
          },
          "node_hours_7d": 1
        }
      },
      "teams": [
        {
          "background_runtime_seconds_7d": 1,
          "http_gib_seconds_7d": 1,
          "http_pod_seconds_7d": 1,
          "memory_request_mib": 1,
          "owner_email": "example",
          "peak_memory_mib": 1,
          "team_id": "example"
        }
      ]
    },
    "functions": [
      {
        "function_id": "example",
        "hostname": "example",
        "http_stats": {
          "available": true,
          "error_rate_5xx": 1,
          "p50_ms": 1,
          "p99_ms": 1,
          "reason": "example",
          "requests_24h": 1,
          "window_hours": 1
        },
        "invocations_24h": 1,
        "kind": "example",
        "name": "example",
        "owner_email": "example",
        "project_id": "example",
        "project_name": "example",
        "runtime": "example",
        "team_id": "example",
        "updated_at": "example"
      }
    ],
    "generated_at": "example",
    "http_metrics": {
      "available": true,
      "concurrency_now": 1,
      "error_rate_5xx": 1,
      "p50_ms": 1,
      "p99_ms": 1,
      "reason": "example",
      "requests_24h": 1,
      "window_hours": 1
    },
    "limits_hit": {
      "cockpit_available": true,
      "cockpit_reason": "example",
      "rows": [
        {
          "count_7d": 1,
          "count_24h": 1,
          "function_id": "example",
          "function_name": "example",
          "kind": "example",
          "last_hit_at": "example",
          "owner_email": "example",
          "project_name": "example",
          "team_id": "example"
        }
      ]
    },
    "retention": {
      "weeks": [
        {
          "active_teams": 1,
          "background_invocations": 1,
          "http_requests": 1,
          "new_teams": 1,
          "retained_teams": 1,
          "week_start": "example"
        }
      ]
    },
    "top_failing": [
      {
        "failures_24h": 1,
        "function_id": "example",
        "function_name": "example",
        "kind": "example",
        "last_error": "example",
        "last_failed_at": "example",
        "owner_email": "example",
        "project_id": "example",
        "project_name": "example",
        "team_id": "example"
      }
    ]
  },
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

401

Section titled “ 401 ”

Unauthorized

Media type application/json
object
code
string
details
error
string
meta
object
request_id
string
timestamp
string
trace_id
string

Example generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

403

Section titled “ 403 ”

Forbidden

Media type application/json
object
code
string
details
error
string
meta
object
request_id
string
timestamp
string
trace_id
string

Example generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

500

Section titled “ 500 ”

Internal Server Error

Media type application/json
object
code
string
details
error
string
meta
object
request_id
string
timestamp
string
trace_id
string

Example generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

503

Section titled “ 503 ”

Service Unavailable

Media type application/json
object
code
string
details
error
string
meta
object
request_id
string
timestamp
string
trace_id
string

Example generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

Live 174db30c built