health.get

GET

/v1/health

import { Client, Orvano } from '@orvano/js'

const orvano = new Orvano(new Client({ endpoint: 'https://orvano.example.com' }))

const health = await orvano.health.get()
console.log(health)

// app/page.tsx, a server component. Route handlers and server actions use createServerClient too.
import { cookies } from 'next/headers'
import { createServerClient } from '@orvano/nextjs'

export default async function Page() {
  const orvano = createServerClient({
    endpoint: process.env.ORVANO_ENDPOINT!,
    cookies: await cookies(),
  })
  const health = await orvano.health.get()
  return <pre>{JSON.stringify(health, null, 2)}</pre>
}

import 'package:orvano_flutter/orvano_flutter.dart';

Future<void> main() async {
  final orvano = Orvano(Client(endpoint: 'https://orvano.example.com'));
  final health = await orvano.health.get();
  print(health.toJson());
}

import 'dart:io';

import 'package:orvano_dart/orvano_dart.dart';

Future<void> main() async {
  final orvano = Orvano(
    Client(
      endpoint: 'https://orvano.example.com',
      apiKey: Platform.environment['ORVANO_API_KEY'],
    ),
  );
  final health = await orvano.health.get();
  print(health.toJson());
}

using Orvano;

using var orvano = new OrvanoClient(new OrvanoClientOptions(new Uri("https://orvano.example.com"))
{
    ApiKey = Environment.GetEnvironmentVariable("ORVANO_API_KEY"),
});
var health = await orvano.Health.GetAsync();
Console.WriteLine(health);

Checks that the server is up and returns its version.

Client and server SDKs: a signed in user’s access token, or a server SDK on behalf of one. A failure answers with a problem details body; its code has a page under Errors.

Responses

200

The request has succeeded.

application/json

Whether the server is up, and which Orvano version it runs.

object

status

required

Always ok when the server answers.

string

version

required

The Orvano server version, major.minor.patch.

string

Example

{
  "status": "ok",
  "version": "0.4.2"
}

default

An unexpected error response.

application/problem+json

An RFC 9457 problem details body. Every operation declares it as its default response, sent as application/problem+json.

object

type

required

Identifies the error: https://orvano.dev/errors/<code>.

string

title

required

The standard HTTP reason phrase for the status.

string

status

required

The HTTP status code.

integer format: int32

detail

A short, safe sentence about this occurrence, when the server has one.

string

code

required

Orvano’s stable error code, from the ErrorCode catalog. SDKs treat it as a plain string.

string

requestId

required

The request ID to quote when reporting a problem; also sent as X-Request-Id.

string

Example

{
  "type": "https://orvano.dev/errors/not_found",
  "title": "Not Found",
  "status": 404,
  "code": "not_found",
  "requestId": "4bf92f3577b34da6a3ce929d0e0e4736"
}