Services

Find a service

GET/api/v1/registry/:feature

Who can use this: Any signed-in accountAs Markdown

When a service is registered at more than one address, this is the one heard from most recently, which is the one homelab-api forwards your calls to.

Parameters

Name	Where	What it is
feature required	path	The service's name, as the list shows it.e.g. homelab-drive

Good to know

A name no service has registered answers 404.

curl -s 'https://api.mailmasker.org/api/v1/registry/homelab-drive' \
  -H "Authorization: Bearer $TOKEN"

use Mojo::Base -strict;
use Mojo::UserAgent;

my $ua  = Mojo::UserAgent->new;
my $res = $ua->get('https://api.mailmasker.org/api/v1/registry/homelab-drive',
    { Authorization => "Bearer $ENV{TOKEN}" })->result;
die $res->code, ' ', ($res->json('/error') // $res->message), "\n" unless $res->is_success;
print $res->body, "\n";

homelab-cli registry lookup homelab-drive

Response 200 OK

{
  "feature_name": "homelab-drive",
  "host": "192.0.2.11",
  "port": 2501,
  "health_check_url": "/health",
  "description": "File storage web app + JSON API, serves /api/v1/drive/*"
}