> ## Documentation Index > Fetch the complete documentation index at: https://chargecloud.dev/llms.txt > Use this file to discover all available pages before exploring further. # Returns a health snapshot of a charge point > Returns an aggregated diagnostic snapshot of a charge point: location and controller, the last 5 status entries, the last 5 issues, the last 100 OCPP log entries, the last 10 authorization requests, the last boot notification, the parking sensor with its last 3 status entries, and assigned service partners. Required permission: asset:chargepoints:health. Available contexts: API Key. ## OpenAPI ````yaml /api/core-api/crmiapi.json get /api/v1/assets/chargepoints/{uuid}/health openapi: 3.2.0 info: title: chargecloud - Core API summary: chargecloud Core API. All around CRM, Asset Management and more. version: 1.135.0 description: chargecloud Core API. All around CRM, Asset Management and more. servers: - url: https://api.chargecloud.dev description: Production - chargecloud Core API - url: https://demo.chargecloud.de description: Sandbox/Dev - chargecloud Core API security: [] paths: /api/v1/assets/chargepoints/{uuid}/health: get: tags: - ChargePoints summary: Returns a health snapshot of a charge point description: >- Returns an aggregated diagnostic snapshot of a charge point: location and controller, the last 5 status entries, the last 5 issues, the last 100 OCPP log entries, the last 10 authorization requests, the last boot notification, the parking sensor with its last 3 status entries, and assigned service partners. Required permission: asset:chargepoints:health. Available contexts: API Key. operationId: /api/v1/assets/chargepoints/{uuid}/health_GET parameters: - name: uuid in: path description: >- UUID of the charge point whose health snapshot should be returned. Obtain this from the chargepoint list endpoint (GET /api/v1/assets/chargepoints) — typically after searching by EVSE-ID. required: true schema: type: string pattern: >- ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89ab][a-f0-9]{3}\-[a-f0-9]{12}$ description: >- UUID of the charge point whose health snapshot should be returned. Obtain this from the chargepoint list endpoint (GET /api/v1/assets/chargepoints) — typically after searching by EVSE-ID. responses: '200': content: application/json: schema: type: object required: - chargepoint_health properties: chargepoint_health: type: object properties: chargepoint: type: object properties: uuid: type: string pattern: >- ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89ab][a-f0-9]{3}\-[a-f0-9]{12}$ description: UUID of the charge point. evse_id: type: string description: >- Publicly advertised EVSE-ID of the charge point, including the `*` separators defined by ISO 15118. clean_evse_id: type: string description: >- Normalized form of evse_id without any `*` separators, matching the format used by the list endpoint's EVSE-ID search. status: type: string description: >- Last-known OCPP status of the charge point (e.g., Available, Charging, Faulted). connector_id: type: integer format: int32 description: >- OCPP connector number of this charge point within its controller. name: type: string description: >- Operator-assigned display name of the charge point. station_uuid: type: string pattern: >- ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89ab][a-f0-9]{3}\-[a-f0-9]{12}$ description: >- UUID of the station the charge point belongs to (several connectors can share one station). controller_uuid: type: string pattern: >- ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89ab][a-f0-9]{3}\-[a-f0-9]{12}$ description: >- UUID of the OCPP controller driving this charge point, or null when not yet associated. location_uuid: type: string pattern: >- ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89ab][a-f0-9]{3}\-[a-f0-9]{12}$ description: >- UUID of the location the charge point physically sits in. description: >- Identity and structural references of the requested charge point. location: type: object properties: uuid: type: string pattern: >- ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89ab][a-f0-9]{3}\-[a-f0-9]{12}$ description: UUID of the location. name: type: string description: Operator-assigned name of the location. street: type: string description: Street name of the location's postal address. house_number: type: string description: >- House number of the location's postal address. May contain letters or suffixes. postcode: type: string description: Postal code of the location. city: type: string description: City the location sits in. latitude: type: number format: float description: >- Latitude of the location in decimal degrees (WGS 84). Null when the position has not been recorded. longitude: type: number format: float description: >- Longitude of the location in decimal degrees (WGS 84). Null when the position has not been recorded. status: type: string description: Operational status of the location. time_zone: type: string description: >- IANA time-zone identifier of the location (e.g., Europe/Berlin). support_hotline: type: string description: >- Support phone number displayed to end users for this location. description: >- The location enclosing the charge point. Null when the location is not visible to the caller's client. controller: type: object properties: uuid: type: string pattern: >- ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89ab][a-f0-9]{3}\-[a-f0-9]{12}$ description: UUID of the controller. name: type: string description: Operator-assigned display name of the controller. manufacturer: type: string description: Controller hardware manufacturer. serial_number: type: string description: Serial number reported by the controller. article_number: type: string description: >- Manufacturer article/part number of the controller. firmware: type: string description: >- Firmware version currently running on the controller (corresponds to firmwareVersion in storage). fairmode: type: boolean default: false description: >- True when the controller is configured to operate under German Eichrecht/fair-mode billing rules. software: type: string description: >- Software stack identifier reported by the controller (e.g., OCPP implementation vendor). status: type: string description: >- Operational status of the controller as tracked by the platform. last_ocpp_activity: type: string format: date-time pattern: >- ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(Z|[+-]\d{2}:\d{2})$ description: >- Last time the controller was seen on the OCPP wire (any inbound OCPP message). Null when the controller has never reported activity yet. required: - fairmode description: >- Hardware controller driving the requested charge point. Null when the charge point is not yet bound to any controller. statuses: type: array items: type: object properties: status: type: string description: >- OCPP status code (e.g., Available, Charging, Faulted) as reported by the controller. error_code: type: string description: >- OCPP error code reported alongside the status (e.g., NoError, GroundFailure). vendor_id: type: string description: >- Vendor identifier, when the status carried vendor-specific error information. vendor_error_code: type: string description: >- Vendor-specific error code that complements error_code. info: type: string description: >- Free-text additional information attached to the status by the controller. created_at: type: string format: date-time pattern: >- ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(Z|[+-]\d{2}:\d{2})$ description: >- Timestamp when the status entry was recorded by the platform (ISO 8601). description: >- A single historical status entry of the charge point. description: Last 5 charge-point status entries, newest first. issues: type: array items: type: object properties: created_at: type: string format: date-time pattern: >- ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(Z|[+-]\d{2}:\d{2})$ description: >- Timestamp when the issue was recorded (ISO 8601). error_at: type: string format: date-time pattern: >- ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(Z|[+-]\d{2}:\d{2})$ description: >- Timestamp when the underlying error is considered to have happened, if known (ISO 8601). status: type: string description: 'Workflow state of the issue: new or resolved.' type: type: string description: Domain classification of the issue. controller_uuid: type: string pattern: >- ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89ab][a-f0-9]{3}\-[a-f0-9]{12}$ description: >- UUID of the controller the issue is attributed to, or null when it is attributed to the charge point. charge_point_uuid: type: string pattern: >- ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89ab][a-f0-9]{3}\-[a-f0-9]{12}$ description: >- UUID of the charge point the issue is attributed to, or null when it is attributed to the controller. subject: type: string description: Short headline describing the issue. comment: type: string description: >- Free-text details or notes attached to the issue. description: >- A single issue/error record attributed to the controller or the charge point. description: >- Last 5 issue records attributed to the controller OR the charge point, newest first. ocpp_logs: type: array items: type: object properties: timestamp: type: string format: date-time pattern: >- ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(Z|[+-]\d{2}:\d{2})$ description: >- Time the frame was recorded by the broker, in Europe/Berlin local time. ocpp_message_id: type: string description: >- OCPP protocol call/callresult message id, as reported by the charge point. ocpp_version: type: string description: >- OCPP protocol version reported by the broker (e.g., 1.6, 2.0.1). ocpp_action: type: string description: >- OCPP action name (e.g., StatusNotification, BootNotification). Null for frames without an action. direction: type: string description: >- Direction of the frame as reported by the broker (e.g., inbound = charge point to backend, outbound = backend to charge point). request: type: string description: >- OCPP request frame as returned by the broker (JSON string). The fields `token`, `authorizationData` and `customData` are replaced with "[REDACTED]"; per-transaction identifiers (`idTag`, `idToken`, `parentIdTag`) are kept raw. response: type: string description: >- OCPP response frame as returned by the broker (JSON string), redacted the same way as `request`. Null when the frame has no response. description: >- A single OCPP frame from the OCPP broker message stream with sensitive fields redacted. description: >- Up to 100 OCPP frames from the OCPP message stream (broker analytics API), newest first. Empty when the charge point has no controller, the controller is not connected to the OCPP broker, or the broker stream is temporarily unavailable. authorization_requests: type: array items: type: object properties: message: type: string description: >- Human-readable outcome or reason message recorded with the request. status: type: string description: >- Authorization outcome status (e.g., Accepted, Blocked, Invalid) as reported by the platform. requested_at: type: string format: date-time pattern: >- ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(Z|[+-]\d{2}:\d{2})$ description: >- Timestamp when the authorization request reached the backend (ISO 8601). command_type: type: string description: >- OCPP command type that triggered the authorization (e.g., Authorize, StartTransaction). description: >- A single authorization attempt between the charge point and the backend. description: >- Last 10 authorization attempts against the controller, newest first. Empty when no controller. last_reboot: type: object properties: notified_at: type: string format: date-time pattern: >- ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(Z|[+-]\d{2}:\d{2})$ description: >- Timestamp when the controller sent this BootNotification (ISO 8601). charge_point_vendor: type: string description: >- Vendor string announced by the controller at boot time. charge_point_model: type: string description: >- Model string announced by the controller at boot time. charge_point_serial_number: type: string description: >- Serial number the controller reported at boot time. firmware_version: type: string description: >- Firmware version the controller reported at boot time. icc_id: type: string description: >- SIM card ICCID the controller reported at boot time, when available. description: >- The most recent BootNotification received from the controller. parking_sensor: type: object properties: sensor: type: object properties: uuid: type: string pattern: >- ^[a-f0-9]{8}\-[a-f0-9]{4}\-4[a-f0-9]{3}\-[89ab][a-f0-9]{3}\-[a-f0-9]{12}$ description: UUID of the parking sensor. name: type: string description: >- Sensor name, usually assigned by the installer. ext_id: type: string description: >- External identifier from the sensor vendor's backend (if any). last_status: type: string description: >- Most recent occupancy state reported by the sensor. Exact values depend on the sensor's vendor. last_status_changed_at: type: string format: date-time pattern: >- ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(Z|[+-]\d{2}:\d{2})$ description: >- Timestamp when last_status last changed (ISO 8601). interface_name: type: string description: >- Identifier of the integration interface the sensor is attached to. description: >- The parking sensor tied to the requested charge point. statuses: type: array items: type: object properties: status: type: string description: >- Reported parking state (e.g., OCCUPIED, FREE). Exact values depend on the sensor's vendor. error_code: type: string description: Sensor-reported error code, if any. changed_at: type: string format: date-time pattern: >- ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(Z|[+-]\d{2}:\d{2})$ description: >- Timestamp when the underlying occupancy state changed (ISO 8601). reported_at: type: string format: date-time pattern: >- ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(Z|[+-]\d{2}:\d{2})$ description: >- Timestamp when this status entry was recorded by the platform (ISO 8601). description: >- A single status entry reported by the parking sensor. description: >- Last 3 status entries reported by the sensor, newest first. required: - sensor - statuses description: >- The parking sensor attached to the charge point together with its last 3 status entries. Null on the response level when no parking sensor is configured. service_partners: type: array items: type: object properties: partner_name: type: string description: Display name of the partner organization. partner_type: type: string description: >- Human-readable role of the partner (e.g., Service, Installation). Derived from the partner-type lookup. description: >- A single service partner linked to the charge point's location. description: >- Service partners linked to the charge point's location, in no particular order. required: - chargepoint - statuses - issues - ocpp_logs - authorization_requests - service_partners description: >- Aggregated charge point health snapshot combining identity, location, controller, recent statuses and issues, OCPP frames from the broker message stream (credentials redacted), authorization attempts, last reboot, parking sensor, and service partners. description: >- Aggregated charge point health snapshot wrapped in a single top-level `chargepoint_health` object. Sections within the wrapper are documented via their own Object classes. '401': content: application/json: schema: type: object required: - error properties: error: type: string description: Error message description: Unauthorized '403': content: application/json: schema: type: object required: - error properties: error: type: string description: Error message description: Forbidden '404': content: application/json: schema: type: object required: - error properties: error: type: string description: Error message description: Not found '405': content: application/json: schema: type: object required: - error properties: error: type: string description: Error message description: Method not allowed '422': content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object properties: errorKey: type: string description: A key identifying the error message: type: string description: The error message parameter: type: string description: The parameter that caused the error, if any required: - errorKey - message - parameter description: Error description: List of errors description: Request validation failed security: - bearer: - asset:chargepoints components: securitySchemes: bearer: type: http description: OAuth2 Bearer Authorization scheme: bearer bearerFormat: JWT ```` ## Related topics - [Charging point health](/charging-point-health.md) - [Asset management](/asset-management.md) - [Creates a chargepoint](/api-reference/chargepoints/creates-a-chargepoint.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.