--- title: "Reads the whole of a lambda at a glance" method: GET path: "/lambdas/{privateKey}/summary" tags: ["Monitoring"] --- # Reads the whole of a lambda at a glance `GET /lambdas/{privateKey}/summary` ## Request - Base URL: `https://genhttp.dev/api/v1` - URL: `https://genhttp.dev/api/v1/lambdas/{privateKey}/summary` - Auth: none declared Whether it is online and with which version, its traffic over the last hour and day, its last few problems, what its version and its data take, its limits, and what its documentation says. The figures about code and storage are about the version online, or the newest where none is. ## Path parameters - `privateKey` string, required ## Response `200` The lambda at a glance - LambdaSummaryResponse: Everything worth knowing about a lambda at a glance. - `Lambda` LambdaResponse: A lambda, as whoever holds its editor key sees it. - `PublicKey` string: Names its address below the hosting domain. Not a secret; its owner may change it. - `PrivateKey` string: The editor key, which authorizes every call about the lambda. Treat it like a password. - `Tier` string: `Free`, `Premium` or `Demo`, assigned by the operator. Decides its limits, whether it is kept online while nobody uses it, and whether it may answer at a domain of its own. - `Created` string, date-time: When it was created - `Modified` string, date-time: When something about it last changed: a save, a deployment, a setting - `ActiveVersion` integer, nullable: The version that is online; absent while nothing is - `LatestVersion` integer, nullable: The newest version saved, which may be ahead of the one online - `PublicUrl` string: Its address below the hosting domain, named after its public key: `https://quiz.genhttp.run/`. While it answers at a domain of its own, this address sends its visitors on to the domain. - `EditorPath` string: Where its editor is on this site: `/editor/{privateKey}`. Holds the editor key. - `DeployedAt` string, date-time, nullable: When the version online went online; absent while nothing is - `DeployedUntil` string, date-time, nullable: When it is taken offline unless it is visited or edited before then - each visit and each edit moves this on. Absent while it is offline, and for a tier that keeps it online. - `KeptUntil` string, date-time, nullable: When it is deleted unless it is visited or edited before then. Absent for a tier that keeps it. - `Domain` string, nullable: The domain of its own it is configured to answer at, whether or not its tier lets it - `DomainServed` boolean: Whether it answers at that domain: it has one, and its tier includes it - `Address` string: Where to link to it: its domain while that is served, `publicUrl` otherwise - `View` string: How its editor opens for somebody who has not chosen a view of their own: `Full` or `Simple` - `GitPath` string: Where it is cloned with git and pushed to, on this site. The versions are the commits of `main`, the features the other branches. Holds the editor key, like the editor's path. - `Live` VersionResponse: A version, without its files. - `Version` integer: Its number, counting from 1 - `Created` string, date-time: When it was saved - `Specification` string, nullable: What the user wanted and why, where whoever saved it said - `Change` string, nullable: What it changed, where whoever saved it said - `Origin` string, nullable: How it was saved: `template` (what the lambda started as), `api`, `agent`, `git`, `admin` or `system` - `Latest` VersionResponse: A version, without its files. - `Version` integer: Its number, counting from 1 - `Created` string, date-time: When it was saved - `Specification` string, nullable: What the user wanted and why, where whoever saved it said - `Change` string, nullable: What it changed, where whoever saved it said - `Origin` string, nullable: How it was saved: `template` (what the lambda started as), `api`, `agent`, `git`, `admin` or `system` - `Versions` integer: How many versions are kept - `Activation` ActivationResponse: One stretch of time a version was online. - `Version` integer: The version that was online - `Started` string, date-time: When it went online - `Origin` string, nullable: Who put it online: `api`, `agent`, `git`, `admin` (the operator) or `system` - `Ended` string, date-time, nullable: When it went offline; absent while it is still online - `EndedBy` string, nullable: Why it went offline: `replaced` by another deployment, `stopped` by its owner, `expired` because nobody used it, or taken down by the operator (`admin`) - `Seconds` integer: How long it was online, or has been so far, in seconds - `Traffic` TrafficSummary: How much a lambda is used, and how well it answers. - `HourRequests` integer: Requests in the last hour - `HourFailed` integer: Of those, answered with a server error - `DayRequests` integer: Requests in the last day - `DayFailed` integer: Of those, answered with a server error - `DayRejected` integer: Of those, answered with a client error, not found included - `AverageMillis` number, double: The mean time to answer over the last day, in milliseconds - `Upgrades` integer: Connections upgraded to a websocket in the last day - `Hourly` integer[]: Requests per hour over the last day, oldest first - `LastSeen` string, date-time, nullable: When the last request arrived - `Since` string, date-time: When the counting started: when the server came up - `RecentProblems` OwnerLogEntry[]: The last few errors and warnings of its own log, newest first - not the requests that were merely refused - `Seq` integer: Its sequence: counts up and never repeats, so a reader asks for what came after the last one it saw - `At` string, date-time: When it was said - `Level` string: `trace`, `debug`, `info`, `warn`, `error` or `critical` - `Source` string: Who said it: `Requests` for a request line, `stdout` or `stderr` for what the code printed, or the part of the server that spoke - `Text` string: What was said - `Detail` string, nullable: The stack trace, where there is one - `Country` string, nullable: The two letter code of the country the caller's address is registered in, where it is known - `Agent` string, nullable: What the caller said it was - its user agent - `Repeats` integer: How many identical lines in a row this one stands for; one is itself alone - `Domain` string, nullable: The host the request was addressed to: the lambda's subdomain of the hosting domain, or its own domain - `Storage` StorageSummary: What a lambda keeps, and how much of each allowance it takes. - `Version` integer, nullable: The version the figures about code are about: the one online, else the newest - `CodeFiles` integer: Files of its code: the C# it is compiled from and whatever else it is kept with, never served - `CodeBytes` integer: What those weigh, towards what a version may come to - `ResourceFiles` integer: Its resources, which it reads and serves while it runs - `ResourceBytes` integer: What those weigh, decoded, towards what a version may come to - `WorkspaceFiles` integer: Files in the workspace, which it writes while it runs and every version shares - `WorkspaceBytes` integer: The room those take, towards the data allowance - `ServesResources` boolean: Whether the code of that version serves its resources - `ServesWorkspace` boolean: Whether it serves the workspace, which makes those files public - `WorkspaceEnabled` boolean: Whether the workspace is switched on - `UsesWorkspace` boolean: Whether the code of that version uses the workspace at all, and so fails where it does once it is switched off - `SecretsEnabled` boolean: Whether secrets are switched on - `Secrets` integer: How many secrets it keeps - `MissingSecrets` string[], nullable: The secrets its code reads that have no value yet - what its owner still has to enter, because until then the code that reads them fails - `DatabaseEnabled` boolean: Whether the database is switched on - `DatabaseTables` integer: How many tables the database holds - `DatabaseBytes` integer: The room the database takes, towards the data allowance - `UsesDatabase` boolean: Whether the code of that version connects to the database, and so fails where it does once it is switched off - `Limits` SummaryLimits: What a lambda of its tier may have on this installation, as the operator set it. - `BuildBytes` integer: What a version may come to, its code and its resources together, in bytes - `DataBytes` integer: The room its data may take, its database and its workspace together, in bytes - `Versions` integer: How many versions are kept; the oldest beyond that go with every save, but never the one online or one a feature is based on - `DeploymentLifetimeHours` integer: How long a free lambda may go without a visit or an edit before it is taken offline, in hours - `RetentionDays` integer: How long a free lambda may go without a visit or an edit before it is deleted, in days - `Features` integer: How many features it may have open at once - `Documentation` DocumentationSummary: What a version says about itself, in `docs/` and `tests/`. - `About` string, nullable: The first paragraph of `docs/product.md`, as plain text - what the app is, in a sentence or two - `Product` boolean: Whether it has `docs/product.md`: what the app is, for whom, and why - `Decisions` boolean: Whether it has `docs/decisions.md`: which technical decisions were made, and why - `Tests` boolean: Whether it has `tests/README.md`: how it is tested - `Files` integer: How many files its documentation and tests come to - `Bytes` integer: What those weigh, which counts towards what a version may come to like the rest of its code ## Other responses - `204`: A response containing no body - `404`: No lambda has this editor key. A key that never existed and the key of a deleted lambda are answered alike. --- [API](https://skmtc.dev/genhttp/apis/genhttp-lambda-api.md) · [All operations](https://skmtc.dev/genhttp/apis/genhttp-lambda-api/llms.txt) · [OpenAPI document](https://skmtc.dev/genhttp/apis/genhttp-lambda-api/revisions/8b36699e03df?raw)