OpenAPI reference
GridOS OCPP CSMS HTTP surface
Management-facing HTTP endpoints for OCPP charge-point connectivity on GridOS (registration, status, and remote operations). Protocol wire messages remain OCPP JSON; this spec documents the CSMS control plane used by the Dashboard and integrators.
Management-facing HTTP endpoints for OCPP charge-point connectivity on GridOS (registration, status, and remote operations). Protocol wire messages remain OCPP JSON; this spec documents the CSMS control plane used by the Dashboard and integrators.
All modules and endpoints on this single page. Left rail jumps to # anchors.
Spec version: 1.0.0
Base URL: https://api.gridos.example/v1
Modules (left rail mirrors this list)
- Charge-points — base
/charge-points· 3 endpoints - Sessions —
GET /sessions - Remote — base
/charge-points· 2 endpoints
Charge-points
Charge point registry
Base path: /charge-points
GET · list charge points
GET /charge-pointsAbsolute URL: https://api.gridos.example/v1/charge-points
Returns charge points for the organization, optionally filtered by protocol or online status.
How to call this endpoint
curl -sS -X GET 'https://api.gridos.example/v1/charge-points'Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
protocol | string | No | ocpp1.6 or ocpp2.0.1 |
online | boolean | No | Filter by WebSocket connection state |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Charge point list | — |
200 — charge point list
No response body.
POST · register charge point
POST /charge-pointsAbsolute URL: https://api.gridos.example/v1/charge-points
Creates a charge-point identity and returns the OCPP WebSocket URL / identity key material.
How to call this endpoint
curl -sS -X POST 'https://api.gridos.example/v1/charge-points'Responses
| Status | Description | Schema |
|---|---|---|
201 | Charge point created | — |
201 — charge point created
No response body.
GET · charge point
GET /charge-points/{id}Absolute URL: https://api.gridos.example/v1/charge-points/{id}
How to call this endpoint
curl -sS -X GET 'https://api.gridos.example/v1/charge-points/example'Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Charge point detail | — |
404 | Not found | — |
200 — charge point detail
No response body.
404 — not found
No response body.
Sessions
Charging sessions
Base path: /sessions
GET · list charging sessions
GET /sessionsAbsolute URL: https://api.gridos.example/v1/sessions
How to call this endpoint
curl -sS -X GET 'https://api.gridos.example/v1/sessions'Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
charge_point_id | string | No | — |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Session list | — |
200 — session list
No response body.
Remote
Remote OCPP operations
Base path: /charge-points
POST · remote start transaction
POST /charge-points/{id}/remote-startAbsolute URL: https://api.gridos.example/v1/charge-points/{id}/remote-start
Sends RemoteStartTransaction (1.6) or RequestStartTransaction (2.0.1) to the charge point.
How to call this endpoint
curl -sS -X POST 'https://api.gridos.example/v1/charge-points/example/remote-start'Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Accepted by CSMS; check OCPP response for charger result | — |
409 | Charge point offline | — |
200 — accepted by CSMS; check OCPP response for charger result
No response body.
409 — charge point offline
No response body.
POST · remote stop transaction
POST /charge-points/{id}/remote-stopAbsolute URL: https://api.gridos.example/v1/charge-points/{id}/remote-stop
How to call this endpoint
curl -sS -X POST 'https://api.gridos.example/v1/charge-points/example/remote-stop'Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Stop requested | — |
200 — stop requested
No response body.