Skip to content

Registry & System API

DRAFT — Internal Developer Use Only

This API reference is for internal development teams.

Overview

What it is: The registry API provides system-level operations for node management, secret generation, and client join operations.

Endpoints

MethodPathDescriptionAuth required
GET/internal/v1/registry/random/secretGenerate a random secretJWT + API token
GET/internal/v1/registry/advertiseGet advertised gateway addressesJWT + API token
GET/internal/v1/node/name/:nidGet node name by IDJWT + API token
GET/internal/v1/join/code/:codeGet join code detailsJWT + API token

Platform Users (used by Control)

MethodPathDescriptionAuth required
GET/internal/v1/registry/config/grid.userList platform usersJWT + API token
GET/internal/v1/datastore/entity/:type/:userIDGet user entity detailsJWT + API token

GET /internal/v1/registry/random/secret

Generate a cryptographically random secret string. Use this for creating API tokens and client secrets.

Request:

http
GET /internal/v1/registry/random/secret
Authorization: Bearer <token>

Response (200):

json
{
  "secret": "a1b2c3d4e5f6..."
}

Get the advertised gateway addresses for client registration.

Request:

http
GET /internal/v1/registry/advertise
Authorization: Bearer <token>

Response (200):

json
{
  "addresses": [
    "https://gateway-01.hydden.com",
    "https://gateway-02.hydden.com"
  ]
}

GET /internal/v1/join/code/:code

Retrieve details for a client join code. Join codes are used during client registration.

Request:

http
GET /internal/v1/join/code/ABC123
Authorization: Bearer <token>

Response (200):

json
{
  "code": "ABC123",
  "tenantId": "tenant-uuid",
  "expiresAt": "2026-02-13T10:00:00Z",
  "used": false
}

Control Integration — Platform Users

Control uses these registry endpoints to retrieve Discovery platform user data:

Diagram description: A sequence diagram showing how Control retrieves platform user data from Discovery. Control sends a GET request to the registry config endpoint to receive the platform user list, then sends a GET request to the datastore entity endpoint to retrieve user details. Control maps the results to its own platform user model.

Hydden Documentation and Training Hub