PAGES

← ToolHive

ToolHive — API

ToolHive APIv1.0 Read the vendor's spec ↗

  • 77 endpoints
  • 2 versions archived since Nov 11, 2026
  • Last checked Nov 14, 2026

This is the ToolHive API server.

Get started

first call
$ curl "$BASE_URL/health"

Set $BASE_URL first, then paste.

Base URL
Not named in the archived spec. $BASE_URL below stands for the origin you deploy against.
Authenticate
No authentication declared in the spec

What it covers

2 more areas

Endpoints

77 of 77

Open an endpoint for a runnable command, its inputs and what it returns.

Workloads 15

  • DELETE /api/v1beta/workloads/{name} Delete a workload

    Loading…

  • GET /api/v1beta/workloads List all workloads

    Loading…

  • GET /api/v1beta/workloads/upgrade-check Check workloads for available upgrades

    Loading…

  • GET /api/v1beta/workloads/{name} Get workload details

    Loading…

  • GET /api/v1beta/workloads/{name}/export Export workload configuration

    Loading…

  • GET /api/v1beta/workloads/{name}/status Get workload status

    Loading…

  • GET /api/v1beta/workloads/{name}/upgrade-check Check a workload for an available upgrade

    Loading…

  • POST /api/v1beta/workloads Create a new workload

    Loading…

  • POST /api/v1beta/workloads/delete Delete workloads in bulk

    Loading…

  • POST /api/v1beta/workloads/restart Restart workloads in bulk

    Loading…

  • POST /api/v1beta/workloads/stop Stop workloads in bulk

    Loading…

  • POST /api/v1beta/workloads/{name}/edit Update workload

    Loading…

  • POST /api/v1beta/workloads/{name}/restart Restart a workload

    Loading…

  • POST /api/v1beta/workloads/{name}/stop Stop a workload

    Loading…

  • POST /api/v1beta/workloads/{name}/upgrade Apply an available upgrade to a workload

    Loading…

Plugins 12

  • DELETE /api/v1beta/plugins/builds/{tag} Delete a locally-built plugin artifact

    Loading…

  • DELETE /api/v1beta/plugins/{name} Uninstall a plugin

    Loading…

  • GET /api/v1beta/plugins List all installed plugins

    Loading…

  • GET /api/v1beta/plugins/builds List locally-built plugin artifacts

    Loading…

  • GET /api/v1beta/plugins/content Get plugin content

    Loading…

  • GET /api/v1beta/plugins/{name} Get plugin details

    Loading…

  • POST /api/v1beta/plugins Install a plugin

    Loading…

  • POST /api/v1beta/plugins/build Build a plugin

    Loading…

  • POST /api/v1beta/plugins/push Push a plugin

    Loading…

  • POST /api/v1beta/plugins/sync Sync project plugins from the lock file

    Loading…

  • POST /api/v1beta/plugins/upgrade Upgrade project plugins

    Loading…

  • POST /api/v1beta/plugins/validate Validate a plugin

    Loading…

Skills 12

  • DELETE /api/v1beta/skills/builds/{tag} Delete a locally-built skill artifact

    Loading…

  • DELETE /api/v1beta/skills/{name} Uninstall a skill

    Loading…

  • GET /api/v1beta/skills List all installed skills

    Loading…

  • GET /api/v1beta/skills/builds List locally-built skill artifacts

    Loading…

  • GET /api/v1beta/skills/content Get skill content

    Loading…

  • GET /api/v1beta/skills/{name} Get skill details

    Loading…

  • POST /api/v1beta/skills Install a skill

    Loading…

  • POST /api/v1beta/skills/build Build a skill

    Loading…

  • POST /api/v1beta/skills/push Push a skill

    Loading…

  • POST /api/v1beta/skills/sync Sync project skills from the lock file

    Loading…

  • POST /api/v1beta/skills/upgrade Upgrade project skills

    Loading…

  • POST /api/v1beta/skills/validate Validate a skill

    Loading…

Registry 10

  • DELETE /api/v1beta/registry/{name} Remove a registry

    Loading…

  • GET /api/v1beta/registry List registries

    Loading…

  • GET /api/v1beta/registry/{name} Get a registry

    Loading…

  • GET /api/v1beta/registry/{name}/servers List servers in a registry

    Loading…

  • GET /api/v1beta/registry/{name}/servers/{serverName} Get a server from a registry

    Loading…

  • POST /api/v1beta/registry Add a registry (unavailable)

    Loading…

  • POST /api/v1beta/registry/auth/login Registry login

    Loading…

  • POST /api/v1beta/registry/auth/logout Registry logout

    Loading…

  • POST /api/v1beta/registry/{name}/refresh Refresh registry cache

    Loading…

  • PUT /api/v1beta/registry/{name} Update registry configuration

    Loading…

Clients 6

  • DELETE /api/v1beta/clients/{name} Unregister a client

    Loading…

  • DELETE /api/v1beta/clients/{name}/groups/{group} Unregister a client from a specific group

    Loading…

  • GET /api/v1beta/clients List all clients

    Loading…

  • POST /api/v1beta/clients Register a new client

    Loading…

  • POST /api/v1beta/clients/register Register multiple clients

    Loading…

  • POST /api/v1beta/clients/unregister Unregister multiple clients

    Loading…

Secrets 6

  • DELETE /api/v1beta/secrets/default/keys/{key} Delete a secret

    Loading…

  • GET /api/v1beta/secrets/default Get secrets provider details

    Loading…

  • GET /api/v1beta/secrets/default/keys List secrets

    Loading…

  • POST /api/v1beta/secrets Setup or reconfigure secrets provider

    Loading…

  • POST /api/v1beta/secrets/default/keys Create a new secret

    Loading…

  • PUT /api/v1beta/secrets/default/keys/{key} Update a secret

    Loading…

Groups 4

  • DELETE /api/v1beta/groups/{name} Delete a group

    Loading…

  • GET /api/v1beta/groups List all groups

    Loading…

  • GET /api/v1beta/groups/{name} Get group details

    Loading…

  • POST /api/v1beta/groups Create a new group

    Loading…

Logs 2

  • GET /api/v1beta/workloads/{name}/logs Get logs for a specific workload

    Loading…

  • GET /api/v1beta/workloads/{name}/proxy-logs Get proxy logs for a specific workload

    Loading…

Registry Plugins 2

  • GET /registry/{registryName}/v0.1/x/dev.toolhive/plugins List available registry plugins

    Loading…

  • GET /registry/{registryName}/v0.1/x/dev.toolhive/plugins/{namespace}/{pluginName} Get a registry plugin

    Loading…

Registry Servers 2

  • GET /registry/{registryName}/v0.1/servers List available registry servers

    Loading…

  • GET /registry/{registryName}/v0.1/servers/{serverName}/versions/latest Get a registry server

    Loading…

Registry Skills 2

  • GET /registry/{registryName}/v0.1/x/dev.toolhive/skills List available registry skills

    Loading…

  • GET /registry/{registryName}/v0.1/x/dev.toolhive/skills/{namespace}/{skillName} Get a registry skill

    Loading…

System 2

  • GET /api/openapi.json Get OpenAPI specification

    Loading…

  • GET /health Health check

    Loading…

Discovery 1

  • GET /api/v1beta/discovery/clients List all clients status

    Loading…

Version 1

  • GET /api/v1beta/version Get server version

    Loading…

Saved in this browser. Sign in to sync your tools.