Easee Cloud OCPP API

openapi: 3.2.0
info:
  title: Easee Cloud Cloud OCPP API
  description: OpenAPI Definitions for Easee Cloud APIs.
  version: v1
servers:
- url: https://api.easee.com
security:
- Bearer: []
tags:
- name: Cloud OCPP
  description: Configure Cloud OCPP settings and custom endpoints for operators.
  x-displayName: Cloud OCPP
paths:
  /api/cloud-ocpp/partners/{partnerId}:
    get:
      tags:
      - Cloud OCPP
      summary: GetOcppConfig
      description: Returns operator ocpp config.
      operationId: Partners_GetOcppConfig
      parameters:
      - name: partnerId
        in: path
        required: true
        description: operator id
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: ''
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
    post:
      tags:
      - Cloud OCPP
      summary: SaveOcppConfig
      description: Updates existing ocpp config for operator.
      operationId: Partners_SaveOcppConfig
      parameters:
      - name: partnerId
        in: path
        required: true
        description: operator id
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Easee_Cloud_Ocpp_Api_SaveOcppConfigRequest'
        required: true
        x-position: 2
      responses:
        '200':
          description: ''
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
  /api/cloud-ocpp/partners/{partnerId}/sites:
    get:
      tags:
      - Cloud OCPP
      summary: GetAllCustomEndpoints
      description: Returns all custom endpoints for operator.
      operationId: Partners_GetAllCustomEndpoints
      parameters:
      - name: partnerId
        in: path
        required: true
        description: operator id
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: ''
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
  /api/cloud-ocpp/partners/{partnerId}/sites/{siteId}:
    get:
      tags:
      - Cloud OCPP
      summary: GetCustomEndpointsOnSite
      description: Returns all custom endpoints for operator on requested site.
      operationId: Partners_GetCustomEndpointsOnSite
      parameters:
      - name: partnerId
        in: path
        required: true
        description: operator id
        schema:
          type: string
        x-position: 1
      - name: siteId
        in: path
        required: true
        schema:
          type: integer
          format: int32
        x-position: 2
      responses:
        '200':
          description: ''
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
    post:
      tags:
      - Cloud OCPP
      summary: SetCustomEndpoint
      description: Create or update custom endpoint for operator on requested site.
      operationId: Partners_SetCustomEndpoint
      parameters:
      - name: partnerId
        in: path
        required: true
        description: operator id
        schema:
          type: string
        x-position: 1
      - name: siteId
        in: path
        required: true
        schema:
          type: integer
          format: int32
        x-position: 2
      requestBody:
        x-name: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Easee_Cloud_Ocpp_Api_SetCustomEndpointRequest'
        required: true
        x-position: 3
      responses:
        '200':
          description: ''
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
    delete:
      tags:
      - Cloud OCPP
      summary: DeleteCustomEndpoint
      description: Deletes custom endpoint for specified serial numbers on the site.
      operationId: Partners_DeleteCustomEndpoint
      parameters:
      - name: partnerId
        in: path
        required: true
        description: operator id
        schema:
          type: string
        x-position: 1
      - name: siteId
        in: path
        required: true
        schema:
          type: integer
          format: int32
        x-position: 2
      - name: serialNumbers
        in: query
        style: form
        explode: true
        schema:
          type:
          - array
          - 'null'
          items:
            type: string
        x-position: 3
      responses:
        '200':
          description: ''
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
components:
  schemas:
    Easee_Cloud_Ocpp_Api_CustomEndpointDto:
      type: object
      additionalProperties: false
      required:
      - serialNumber
      properties:
        serialNumber:
          type:
          - string
          - 'null'
        url:
          type:
          - string
          - 'null'
        urlAppendix:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
    Easee_Cloud_Ocpp_Api_SaveOcppConfigRequest:
      type: object
      description: Connection details and OCPP messages configuration for a partner.
      additionalProperties: false
      required:
      - partnerName
      - url
      - httpBasicAuth
      - timeFormat
      - jsonIgnoreNulls
      - maxBootChunk
      - maxCsmsConnects
      - networkEnableDnsRoundRobin
      properties:
        partnerName:
          type: string
          description: The name of the partner.
          minLength: 1
        url:
          type: string
          description: Web socket URL for the backoffice system.
          minLength: 1
        httpBasicAuth:
          type: string
          description: Hexadecimal representation of password for basic authentication.
        timeFormat:
          type: string
          description: DateTime data types formatting in OCPP messages.
          minLength: 1
        jsonIgnoreNulls:
          type: boolean
          description: Skip properties with null values when sending OCPP messages.
        maxBootChunk:
          type: integer
          description: Number of charge points to connect to Csms and maximum queue length for Bulkhead Policy.
          format: int32
        maxCsmsConnects:
          type: integer
          description: Maximum number of concurrent executions for Bulkhead Policy.
          format: int32
        networkDnsRefreshTimeout:
          type:
          - integer
          - 'null'
          description: Defines when to refresh Domain Name Service (DNS) resolution in milliseconds. If not set, the default value is used.
          format: int32
        networkEnableDnsRoundRobin:
          type: boolean
          description: Indicates whether a Domain Name Service (DNS) resolution rotates among the applicable Internet Protocol (IP) addresses.
    Easee_Cloud_Ocpp_Api_SetCustomEndpointRequest:
      type: object
      additionalProperties: false
      required:
      - customEndpoints
      properties:
        customEndpoints:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Easee_Cloud_Ocpp_Api_CustomEndpointDto'
  securitySchemes:
    Bearer:
      type: apiKey
      description: 'JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"'
      name: Authorization
      in: header
x-provenance:
  method: searched
  source: https://developer.easee.com/reference
  harvested: '2026-10-27'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.easee.com/reference/account_addchargerfavoritebypin.md
  - https://developer.easee.com/reference/account_authenticate.md
  - https://developer.easee.com/reference/account_getchargerfavorites.md
  - https://developer.easee.com/reference/account_getfavorites.md
  - https://developer.easee.com/reference/account_getproductfavorites.md
  - https://developer.easee.com/reference/account_getprofile.md
  - https://developer.easee.com/reference/account_invalidatetoken.md
  - https://developer.easee.com/reference/account_refreshtoken.md
  - https://developer.easee.com/reference/account_removechargerfavorite.md
  - https://developer.easee.com/reference/applyocppforchargerendpoint.md
  - https://developer.easee.com/reference/applyocppforsiteendpoint.md
  - https://developer.easee.com/reference/applyocppforuserchargerendpoint.md
  - https://developer.easee.com/reference/authorizecharging_startcharging.md
  - https://developer.easee.com/reference/charger_acceptchargerinvitationlink.md
  - https://developer.easee.com/reference/charger_addchargeplan.md
  - https://developer.easee.com/reference/charger_addchargertoaccount.md
  - https://developer.easee.com/reference/charger_addweeklychargeschedule.md
  - https://developer.easee.com/reference/charger_createchargerinvitationlink.md
  - https://developer.easee.com/reference/charger_deletechargeplan.md
  - https://developer.easee.com/reference/charger_deleteuserchargeraccess.md
  - https://developer.easee.com/reference/charger_deleteweeklychargeschedule.md
  - https://developer.easee.com/reference/charger_enable_smart_charging.md
  - https://developer.easee.com/reference/charger_getall.md
  - https://developer.easee.com/reference/charger_getcachedchargerconfig.md
  - https://developer.easee.com/reference/charger_getchargeplan.md
  - https://developer.easee.com/reference/charger_getchargerbyid.md
  - https://developer.easee.com/reference/charger_getchargerdetails.md
  - https://developer.easee.com/reference/charger_getchargerinvitationpreview.md
  - https://developer.easee.com/reference/charger_getchargeroperator.md
  - https://developer.easee.com/reference/charger_getchargersite.md
  - https://developer.easee.com/reference/charger_getchargerusers.md
  - https://developer.easee.com/reference/charger_gethourlyaggregatedusage.md
  - https://developer.easee.com/reference/charger_getweeklychargeschedule.md
  - https://developer.easee.com/reference/charger_linkcharger.md
  - https://developer.easee.com/reference/charger_overrideschedule.md
  - https://developer.easee.com/reference/charger_pair_rfid_tag.md
  - https://developer.easee.com/reference/charger_pausesession.md
  - https://developer.easee.com/reference/charger_reboot.md
  - https://developer.easee.com/reference/charger_removechargerfromaccount.md
  - https://developer.easee.com/reference/charger_removechargerinvitationlink.md
  - https://developer.easee.com/reference/charger_removechargeroperator.md
  - https://developer.easee.com/reference/charger_resendchargerinvitationlink.md
  - https://developer.easee.com/reference/charger_resumesession.md
  - https://developer.easee.com/reference/charger_scan_wifi.md
  - https://developer.easee.com/reference/charger_set_cable_lock_state.md
  - https://developer.easee.com/reference/charger_set_dynamic_charger_current.md
  - https://developer.easee.com/reference/charger_set_phase_mode.md
  - https://developer.easee.com/reference/charger_set_wifi_configuration.md
  - https://developer.easee.com/reference/charger_setchargeraccesslevel.md
  - https://developer.easee.com/reference/charger_setchargersetting.md
  - https://developer.easee.com/reference/charger_setchargeschedulefeatures.md
  - https://developer.easee.com/reference/charger_setoperator.md
  - https://developer.easee.com/reference/charger_stop_charging.md
  - https://developer.easee.com/reference/charger_togglecharging.md
  - https://developer.easee.com/reference/charger_update_firmware.md
  - https://developer.easee.com/reference/chargers_deletechargingsession.md
  - https://developer.easee.com/reference/chargers_getlastupdatedchargesession.md
  - https://developer.easee.com/reference/chargers_getongoingsessiondetails.md
  - https://developer.easee.com/reference/chargesession_exportconsumption.md
  - https://developer.easee.com/reference/chargingsessionscharger_getchargersessionsbycharger.md
  - https://developer.easee.com/reference/chargingsessionscharger_getdailysummarybycharger.md
  - https://developer.easee.com/reference/chargingsessionscharger_gethourlysummarybycharger.md
  - https://developer.easee.com/reference/chargingsessionscharger_getlimitchargersessionsbycharger.md
  - https://developer.easee.com/reference/chargingsessionscharger_getmonthlysummarybycharger.md
  - https://developer.easee.com/reference/chargingsessionscharger_gettotalkwhamountbycharger.md
  - https://developer.easee.com/reference/chargingsessionscharger_getyearlysummarybycharger.md
  - https://developer.easee.com/reference/chargingsessionssite_getchargesessionbreakdownbyuser.md
  - https://developer.easee.com/reference/chargingsessionssite_getdailysummarybysite.md
  - https://developer.easee.com/reference/chargingsessionssite_getmonthlysummarybysite.md
  - https://developer.easee.com/reference/chargingsessionssite_getweeklysummarybysite.md
  - https://developer.easee.com/reference/chargingsessionssite_getyearlysummarybysite.md
  - https://developer.easee.com/reference/chargingsessionsuser_getchargersessionsbyuser.md
  - https://developer.easee.com/reference/chargingsessionsuser_getchargesessionbreakdownbyuser.md
  - https://developer.easee.com/reference/chargingsessionsuser_getmonthlysummarybyuser.md
  - https://developer.easee.com/reference/chargingsessionsuser_gettotalkwhamountbyuser.md
  - https://developer.easee.com/reference/chargingsessionsuser_getweeklysummarybyuser.md
  - https://developer.easee.com/reference/chargingsessionsuser_getyearlysummarybyuser.md
  - https://developer.easee.com/reference/deletechargersschedulesdaily.md
  - https://developer.easee.com/reference/deletechargersschedulesdelayed.md
  - https://developer.easee.com/reference/deletechargersschedulesweekly.md
  - https://developer.easee.com/reference/disableocppforchargerendpoint.md
  - https://developer.easee.com/reference/disableocppforuserchargerendpoint.md
  - https://developer.easee.com/reference/easeekeys_addeaseekey.md
  - https://developer.easee.com/reference/easeekeys_deleteeaseekey.md
  - https://developer.easee.com/reference/easeekeys_geteaseekeys.md
  - https://developer.easee.com/reference/easeekeys_updateeaseekey.md
  - https://developer.easee.com/reference/equalizer_configureallocatedcurrent.md
  - https://developer.easee.com/reference/equalizer_configuremetertype.md
  - https://developer.easee.com/reference/equalizer_geequalizerconfig.md
  - https://developer.easee.com/reference/equalizer_getdetailedequalizer.md
  - https://developer.easee.com/reference/equalizer_getequalizer.md
  - https://developer.easee.com/reference/equalizer_getequalizersite.md
  - https://developer.easee.com/reference/equalizer_reboot.md
  - https://developer.easee.com/reference/equalizer_updatefirmware.md
  - https://developer.easee.com/reference/getchargerconnectiondetailsendpoint.md
  - https://developer.easee.com/reference/getchargersschedules.md
  - https://developer.easee.com/reference/getchargersschedulesdaily.md
  - https://developer.easee.com/reference/getchargersschedulesdelayed.md
  - https://developer.easee.com/reference/getchargersschedulesweekly.md
  - https://developer.easee.com/reference/getobservations.md
  - https://developer.easee.com/reference/getoperatorconnectiondetailsendpoint.md
  - https://developer.easee.com/reference/getuserchargerconnectiondetailsendpoint.md
  - https://developer.easee.com/reference/getworkflowresultsendpoint.md
  - https://developer.easee.com/reference/getworkflowstreamendpoint.md
  - https://developer.easee.com/reference/lifetimeenergyreporting_configure.md
  - https://developer.easee.com/reference/lifetimeenergyreporting_getchargerbyid.md
  - https://developer.easee.com/reference/lifetimeenergyreporting_getdailyforperiod.md
  - https://developer.easee.com/reference/lifetimeenergyreporting_gethourlyforperiod.md
  - https://developer.easee.com/reference/lifetimeenergyreporting_getmonthlyforperiod.md
  - https://developer.easee.com/reference/lifetimeenergyreporting_getyearlyforperiod.md
  - https://developer.easee.com/reference/partners_deletecustomendpoint.md
  - https://developer.easee.com/reference/partners_getallcustomendpoints.md
  - https://developer.easee.com/reference/partners_getcustomendpointsonsite.md
  - https://developer.easee.com/reference/partners_getocppconfig.md
  - https://developer.easee.com/reference/partners_saveocppconfig.md
  - https://developer.easee.com/reference/partners_setcustomendpoint.md
  - https://developer.easee.com/reference/postchargerconnectiondetailsendpoint.md
  - https://developer.easee.com/reference/postchargersschedulesdaily.md
  - https://developer.easee.com/reference/postchargersschedulesdailydisable.md
  - https://developer.easee.com/reference/postchargersschedulesdailyenable.md
  - https://developer.easee.com/reference/postchargersschedulesdelayed.md
  - https://developer.easee.com/reference/postchargersschedulesdelayeddisable.md
  - https://developer.easee.com/reference/postchargersschedulesdelayedenable.md
  - https://developer.easee.com/reference/postchargersschedulesweekly.md
  - https://developer.easee.com/reference/postchargersschedulesweeklydisable.md
  - https://developer.easee.com/reference/postchargersschedulesweeklyenable.md
  - https://developer.easee.com/reference/postoperatorconnectiondetailsendpoint.md
  - https://developer.easee.com/reference/postuserchargerconnectiondetailsendpoint.md
  - https://developer.easee.com/reference/resources_getactivecountries.md
  - https://developer.easee.com/reference/resources_getallcountries.md
  - https://developer.easee.com/reference/resources_getcurrencies.md
  - https://developer.easee.com/reference/resources_getobservationproperties.md
  - https://developer.easee.com/reference/site_acceptsiteinvitationlink.md
  - https://developer.easee.com/reference/site_attachchargerstobackplates.md
  - https://developer.easee.com/reference/site_createsiteinvitationlink.md
  - https://developer.easee.com/reference/site_deleteaccesslevelforchargers.md
  - https://developer.easee.com/reference/site_deletecircuit.md
  - https://developer.easee.com/reference/site_deletesite.md
  - https://developer.easee.com/reference/site_deletesiteinvitation.md
  - https://developer.easee.com/reference/site_deletesitepermission.md
  - https://developer.easee.com/reference/site_deletesiteuser.md
  - https://developer.easee.com/reference/site_disablecontrolaccess.md
  - https://developer.easee.com/reference/site_getall.md
  - https://developer.easee.com/reference/site_getchargerenergybysite.md
  - https://developer.easee.com/reference/site_getchargers.md
  - https://developer.easee.com/reference/site_getcircuitattachedsite.md
  - https://developer.easee.com/reference/site_getcircuitsettings.md
  - https://developer.easee.com/reference/site_getdynamiccircuitcurrent.md
  - https://developer.easee.com/reference/site_geteaseecontroluiaccessrequest.md
  - https://developer.easee.com/reference/site_getmonthlyconsumptionbyuser.md
  - https://developer.easee.com/reference/site_getmonthlyconsumptionbyuserandcharger.md
  - https://developer.easee.com/reference/site_getsitebyid.md
  - https://developer.easee.com/reference/site_getsiteinvitationpreview.md
  - https://developer.easee.com/reference/site_getsitestate.md
  - https://developer.easee.com/reference/site_getsiteusers.md
  - https://developer.easee.com/reference/site_getyearlyconsumptionbyuser.md
  - https://developer.easee.com/reference/site_getyearlyconsumptionbyuserandcharger.md
  - https://developer.easee.com/reference/site_removeequalizerfromsite.md
  - https://developer.easee.com/reference/site_requestcontrolaccess.md
  - https://developer.easee.com/reference/site_requestsiteaccess.md
  - https://developer.easee.com/reference/site_resendsiteinvitationlink.md
  - https://developer.easee.com/reference/site_savechargingprice.md
  - https://developer.easee.com/reference/site_setaccesslevel.md
  - https://developer.easee.com/reference/site_setaccesslevelforchargers.md
  - https://developer.easee.com/reference/site_setcircuit.md
  - https://developer.easee.com/reference/site_setcircuitmaster.md
  - https://developer.easee.com/reference/site_setcircuitsettings.md
  - https://developer.easee.com/reference/site_setdynamiccircuitcurrent.md
  - https://developer.easee.com/reference/site_setsiteowner.md
  - https://developer.easee.com/reference/site_updatechargers.md
  - https://developer.easee.com/reference/site_updatecircuitcollection.md
  - https://developer.easee.com/reference/site_updatecircuits.md
  - https://developer.easee.com/reference/site_updatesitepatch.md
  - https://developer.easee.com/reference/site_updatesitepermission.md
  - https://developer.easee.com/reference/siteintegration_setaccesslevel.md
  merge:
    pages: 175
    deduped: 474
    conflicts_kept_first: 0