README.md

Liveness

(liveness)

Overview

Available Operations

• liveness - Liveness check

liveness

This endpoint checks if the service is alive.

Example Usage

import { Unkey } from "@unkey/api";

const unkey = new Unkey({
  rootKey: "UNKEY_ROOT_KEY",
});

async function run() {
  const result = await unkey.liveness.liveness();

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { UnkeyCore } from "@unkey/api/core.js";
import { livenessLiveness } from "@unkey/api/funcs/livenessLiveness.js";

// Use `UnkeyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const unkey = new UnkeyCore({
  rootKey: "UNKEY_ROOT_KEY",
});

async function run() {
  const res = await livenessLiveness(unkey);

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.V2LivenessResponseBody>

Errors

Error Type	Status Code	Content Type
errors.PreconditionFailedErrorResponse	412	application/json
errors.InternalServerErrorResponse	500	application/json
errors.APIError	4XX, 5XX	*/*