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

Node-RED Auth API

The Auth API from Node-RED — 3 operation(s) for auth.

Node-RED Auth API is one of 6 APIs that Node-RED publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Auth. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 3 operations across 3 paths. It is described by OpenAPI 3.1.0, at version 4.0.0.

Requests are made against a single base URL, http://{host}:{port}.

3 operations 3 paths 0 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
4.0.0
Base URL
http://localhost:1880
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Node-RED Auth API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

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.

Auth 3
GET
/auth/login
Get the active authentication scheme
getAuthLogin → 200
POST
/auth/token
Exchange credentials for an access token
postAuthToken body → 200
POST
/auth/revoke
Revoke an access token
postAuthRevoke → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

node-red-auth-api-openapi.yml Raw ↑

Other APIs Node-RED publishes across the network.

Node-RED Diagnostics API
Node-RED Flow API
Node-RED Flows API
Node-RED Nodes API
Node-RED Settings API