How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SPAN Circuits API

The Circuits API from SPAN — 2 operation(s) for circuits.

SPAN Circuits API is one of 9 APIs that SPAN publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Circuits. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 1 JSON Schema.

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

Requests are made against the base URL http://span-{serial-number}.local/api/v1.

3 operations 2 paths 11 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
v1
Base URL
http://span-{serial-number}.local/api/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

SPAN Circuits API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

Paths & Operations 3

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

Circuits 3
GET
/api/v1/circuits
Get Circuits
get_circuits_api_v1_circuits_get → 200
GET
/api/v1/circuits/{circuitId}
Get Circuit State
get_circuit_state_api_v1_circuits__circuitId__get 1 param → 200422
POST
/api/v1/circuits/{circuitId}
Set Circuit State
set_circuit_state_api_v1_circuits__circuitId__post 1 param body → 200422

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Circuit (13 properties), Body_set_circuit_state_api_v1_circuits__circuitId__post (6 properties), ValidationError (3 properties), CircuitsOut (1 property). Each schema is shown below with its type and property counts.

Body_set_circuit_state_api_v1_circuits__circuitId__post
object
6 properties
BooleanIn
object
1 property 1 required
Circuit
object
13 properties 11 required
CircuitNameIn
object
1 property 1 required
Priority
string
An enumeration.
PriorityIn
object
1 property 1 required
ValidationError
object
3 properties 3 required
RelayState
string
An enumeration.
RelayStateIn
object
1 property 1 required
CircuitsOut
object
1 property 1 required
HTTPValidationError
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

span-io-circuits-api-openapi.yml Raw ↑

Other APIs SPAN publishes across the network.

SPAN eBus MQTT API
SPAN Auth API
SPAN Islanding State API
SPAN Panel API
SPAN Spaces API
SPAN Status API
SPAN Storage API
SPAN Wifi API
Where this information came from

This is an independent, third-party profile of SPAN Circuits API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.