For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Studio Get an API key

Get started SDKs CLI MCP API Reference

Skip to navigation

Health Check

GET

https://api.ocpplab.io/health

GET

/health

import { OcpplabSDK } from "ocpplab";
async function main() {
    const client = new OcpplabSDK({
        token: "YOUR_TOKEN_HERE",
    });
    await client.health.check();
}
main();

200Retrieved

{
  "status": "ok"
}

Return a lightweight liveness probe for monitoring.

Response

Successful Response

statusstringOptionalDefaults to ok

Was this page helpful?

Get started SDKs CLI MCP API Reference

Virtual chargers
CPO
eMSP
OCPI roaming
Proxy
Bookings
Energy management
Webhooks
Health

Stop, restart, or delete deployed charger runtimes
Why a deployed charger is not running: pods, events and system logs
Current deployment stage of lab chargers
Recent deployment stage changes for the organization
List catalog brands
List catalog brand models
Get catalog brand model
List OCPP + OCPI location templates
Create charger deployment
Delete one charger deployment
Create location, optionally with chargers
Delete a deployment location and its chargers
Send a raw OCPP proxy message
Change charger configuration
Reset charger authorization cache
Send a local authorization list
Clear charger local authorization list
Inject a charger fault
Clear a charger fault
Plug a connector
Unplug a connector
Start a charging session
Stop a charging session
Authorize an id tag
Signal that the EV requests energy
Signal that the EV stops requesting energy
Update delivered power
List recent command results for a charger
Get the status of a queued command
List charger OCPP logs
Delete charger OCPP logs
Get AFIR EVSE statuses
Get AFIR static data
List CDRs
Get a CDR
Push a CDR to a partner
List EVSEs
Create an EVSE
Get an EVSE
Delete an EVSE
Update an EVSE
List temporary EVSE statuses
Create a temporary EVSE status
Get a temporary EVSE status
Delete a temporary EVSE status
Update a temporary EVSE status
List app users
Create an app user
Get an app user
Replace an app user
List audit log entries
List charger models
Get the tariff-signing public key
List charge points
Create a charge point
Get a charge point
Delete a charge point
Update a charge point
List a charge point's CDRs
List a charge point's connectors
List a charge point's EVSEs
Reboot a charger
Reset a charger
List a charge point's sessions
List connectors
Create a connector
Get a connector
Delete a connector
Update a connector
Change a connector's availability
Start charging remotely
Stop charging remotely
Unlock a connector
List customers
Create a customer
Get a customer
Replace a customer
Delete a customer
Check the CPO service
List locations
Create a location
Get a location
Delete a location
Update a location
Push a location to a partner
List sessions
Get a session
Get a session's CDR
Push a session to a partner
List tariff assignments
List tariffs
Create a tariff
Get a tariff
Delete a tariff
Update a tariff
Assign a tariff to a connector
Push a tariff to a partner
Unassign a tariff from a connector
List token groups
Create a token group
Get a token group
Delete a token group
Update a token group
Disable a token group
Enable a token group
List a token group's locations
Link a location to a token group
Unlink a location from a token group
List a token group's tokens
Add a token to a token group
Remove a token from a token group
List voucher groups
Create a voucher group
Get a voucher group
Delete a voucher group
Update a voucher group
List a voucher group's locations
Link a location to a voucher group
Unlink a location from a voucher group
List a voucher group's vouchers
List vouchers
Create a voucher
Get a voucher
Delete a voucher
Update a voucher
List a voucher's tokens
Give a token a voucher
Take a voucher from a token
List CDRs
Get a CDR
List your roaming identities
Register a roaming identity
Get a roaming identity
Update a roaming identity
Deregister a roaming identity
Get an EVSE's live status
Check the eMSP gateway
Search locations
Check availability of several locations
Cluster partner locations for a map (deprecated)
List facilities at partner locations
Map viewport: clusters or pins
Search by text or EVSE id
Locations along a route
Look up many locations at once
Get a location by uid
Get a location
List your networks
Create a sub-network
Create a base network
See which CPOs your drivers reach
Get a network
Delete a sub-network
Update a network
List who uses your published network
List the locations a network reaches
Publish or withdraw a base network
List a network's access rules
Add an access rule
Remove an access rule
Get your eMSP profile
Update your eMSP profile
Get your published-network ranking
Set your published-network ranking
List token groups
Create a token group
Get a token group
Update a token group
Activate a token group
List the networks assigned to a group
Assign a network to a group
Remove a network from a group
Reactivate a token group
Revoke a token group
Suspend a token group
Add tokens to a group
Remove a token from a group
List your tokens
Provision a token
Provision up to 1000 tokens
Get a token
Update a token
Activate a token
Get a token's history
Reactivate a token
Revoke a token
Suspend a token
List tariffs
Get a tariff
Estimate the price of a session
Resolve a charger's route
Send a command
List commands
Get a command
List sessions
Get a session
List callback deliveries
Create or replace a location
Update part of a location
Update an EVSE (usually its status)
Update a connector
Create or replace a charging session
Update part of a charging session
Create a CDR
Create or replace a tariff
Delete a tariff
Cancel a reservation and notify the eMSP (2.2.1 / 2.3.0)
Send a session's ActiveChargingProfile to its eMSP (2.2.1 / 2.3.0)
Create or replace a token
Update part of a token (e.g. block it)
Send a command to a partner CPO
Set charging preferences on a partner session (2.2.1 / 2.3.0)
Request the active charging profile of a partner session (2.2.1 / 2.3.0)
Set a charging profile on a partner session (2.2.1 / 2.3.0)
Clear the charging profile of a partner session (2.2.1 / 2.3.0)
List OCPI + OCPP location templates
Invite a roaming partner (admin)
Rotate an invite's Token A (admin)
Revoke an invite (admin)
List roaming partners
Register a roaming partner
Get a roaming partner
Remove a roaming partner (admin)
Update a roaming partner
Read the stored handshake with a partner (admin)
Register with a partner (credentials handshake, admin)
Rotate credentials with a partner (admin)
Unregister from a partner (admin)
Discover a partner's OCPI versions and endpoints (admin)
Push a stored location to a partner eMSP
Push a stored CDR to a partner eMSP
Push a stored tariff to a partner eMSP
Push a stored session to a partner eMSP (full, or a PATCH with patch_body)
Push a stored token to a partner CPO (full, or a PATCH with patch_body)
Pull tokens from a partner eMSP
Pull locations from a partner CPO
Pull sessions from a partner CPO
Pull CDRs from a partner CPO
Pull tariffs from a partner CPO
Pull a Hub's ClientInfo list into our eMSP side (2.2.1 / 2.3.0)
Pull a Hub's ClientInfo list into our CPO side (2.2.1 / 2.3.0)
Send an OCPP command to a charger
Read the status of an OCPP command
Send an OCPI command to a charger
Read the OCPI CommandResult of an OCPI command
List charger points
Register a charger point
Get a charger point
Delete a charger point
Update a charger point
List authorization tokens
Register an authorization token
Get an authorization token by idTag
Get an authorization token by printed card number
Get an authorization token
Delete an authorization token
Update an authorization token
Activate an Unused card
Block an authorization token (reason required)
Unblock an authorization token
Reprovision a card with a new chip
List CSMS backends
Register a CSMS backend
Get a CSMS backend by name
Get a CSMS backend
Delete a CSMS backend
Update a CSMS backend
List routing rules
Create a routing rule
Get a routing rule
Delete a routing rule
Update a routing rule
List bookable sites
Create a bookable site
Get a bookable site
Delete a bookable site
Update a bookable site
List reservations
Create a reservation
Get a reservation
Update a reservation
Cancel a reservation
Mark a reservation as failed
Mark a reservation as fulfilled
Mark a reservation as a no-show
Reject a reservation
Confirm a reservation
Check the booking service
List control requests
Set or clear a charger's input limit
Get a control request and its outcome
Check energy management health
Read a charger's active power
Read a charger's latest power per connector
Publish a webhook event
Check webhook gateway health
Check the webhook delivery queue
List webhook delivery attempts
List webhook event types
Get a webhook event type
List webhook subscriptions
Create a webhook subscription
Get a webhook subscription
Delete a webhook subscription
Update a webhook subscription
Send a test delivery
Health Check
Health Live
Health Ready