Skip to main content

REST Endpoints

REST Endpoints

Field Value
Distribution BSS — OpenC5ISR
Product OpenC5ISR
Release 0.15.1
Deployment openc5isr.bss.dev
Source /srv/bss/releases/OpenC5ISR-v0.15.0-20app
Evidence Static route extraction
Source fingerprint 93926e8c834f1ed79c9017a4096f70c76d73ce4f870f104fbd0cf54b2bed50ee
Status Generated baseline — human review required

Verification boundary: This page combines platform design guidance with static evidence from the release. It does not prove that every detected interface is enabled, reachable, secure, or operational in the deployed environment.

Candidate endpoints

Method Path Framework/evidence Confidence Source
GET api_path express server declaration drivers/openanalytics_agent.py
GET base_url express server declaration drivers/openanalytics_agent.py
GET http://127.0.0.1:18782/api/integrations client-reference client reference tests/compiled_deployment_smoke_test.py
GET id express server declaration drivers/openanalytics_agent.py
GET lab_path express server declaration drivers/openanalytics_agent.py
GET location express server declaration drivers/openanalytics_agent.py
GET max_notebooks express server declaration drivers/openanalytics_agent.py
GET name express server declaration drivers/openanalytics_agent.py
GET owner express server declaration drivers/openanalytics_agent.py
GET token express server declaration drivers/openanalytics_agent.py
GET token_env express server declaration drivers/openanalytics_agent.py

Interpretation

“Server declaration” is stronger evidence than a client reference, but neither proves the route is mounted at the shown base path or exposed in this edition. Routers may add prefixes dynamically; middleware may block access; and feature flags may disable handlers.

Endpoint documentation template

METHOD /base/path
Purpose:
Authentication/authorization:
Request headers/path/query/body schema:
Semantic type and units:
Success response:
Error responses:
Idempotency/retry behavior:
Rate/size/timeout limits:
Audit/correlation behavior:
Example request and tested release:

Acceptance rule

Promote a candidate endpoint to an authoritative API only after an authenticated test verifies status, schema, policy, failure behavior and the public/base-path mapping.


Maintainer Notes

Add human-reviewed deployment notes, corrections, decisions, screenshots, and links here. Content outside the generated block is preserved on future runs.