Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HTTP Toolkit server API

Server lifecycle and version management

HTTP Toolkit server API is one of 4 APIs that HTTP Toolkit publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include server. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.

This API exposes 3 operations across 3 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, http://localhost:45456.

3 operations 3 paths 2 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
http://localhost:45456
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

HTTP Toolkit server API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Token-based authentication using a server-generated bearer token

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

server 3

Server lifecycle and version management

GET
/version
Get server version
getVersion → 200
POST
/update
Trigger server update
updateServer → 200
POST
/shutdown
Shutdown the server
shutdownServer → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are VersionResponse (1 property), SuccessResponse (1 property). Each schema is shown below with its type and property counts.

SuccessResponse
object
1 property 1 required
VersionResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

http-toolkit-server-api-openapi.yml Raw ↑

Other APIs HTTP Toolkit publishes across the network.

HTTP Toolkit client API
HTTP Toolkit config API
HTTP Toolkit interceptors API