Skip to content
/CPMS

Exolink API (1.0.0)

Download OpenAPI description
exolink_api.json
exolink_api.yaml
Overview
Exolink Support
support@exolink.com
Languages
Servers
Mock server
https://guides.exolink.com/_mock/apis/exolink_api
https://api.exolink.cloud

Public

Public endpoints

Operations

Auth

Authentication and authorization endpoints

Operations

User

User management endpoints

Operations

Product

Product and pricing endpoints

Operations

Static

Static configuration endpoints

Tenant

Tenant management endpoints

Operations

CPMS

CPMS management endpoints

Operations

List CPMS

Request

Return the list of CPMS for the given tenant

Security
bearerToken
Path
tenantstringrequired
curl -i -X GET \
  'https://guides.exolink.com/_mock/apis/exolink_api/tenant/{tenant}/cpms' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List of CPMS

Bodyapplication/jsonArray [
idinteger

Unique identifier for the CPMS backend

Example: 1
tenantIdinteger

ID of the tenant that owns this CPMS backend

Example: 1
displayNamestring

User-friendly name for the CPMS backend

Example: "My Charger"
urlstring

WebSocket URL endpoint for the CPMS backend connection

Example: "ws://cpms.exolink.com"
authPassThroughboolean

Indicates whether authentication credentials are passed through to the CPMS backend

Example: true
intervalnumber

Heartbeat or connection check interval in seconds

Example: 30
createdAtstring

Timestamp when the CPMS backend record was created

Example: "2025-10-15T15:19:50.834Z"
updatedAtstring

Timestamp when the CPMS backend record was last updated

Example: "2025-10-15T15:19:50.834Z"
deletedAtstring

Timestamp when the CPMS backend record was soft-deleted (null if active)

Example: "2025-10-15T15:19:50.834Z"
]
Response
application/json
{
  "$ref": "#/components/examples/CPMSList"
}

Create CPMS

Request

Create a new CPMS backend

Security
bearerToken
Path
tenantstringrequired
Bodyapplication/jsonrequired
displayNamestringrequired

CPMS backend display name

urlstring(uri)required

WebSocket URL for CPMS backend

Example: "wss://cpms.example.com"
intervalintegerrequired

Heartbeat interval in seconds

Example: 30
curl -i -X POST \
  'https://guides.exolink.com/_mock/apis/exolink_api/tenant/{tenant}/cpms' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "displayName": "string",
    "url": "wss://cpms.example.com",
    "interval": 30
  }'

Responses

CPMS created successfully

Get CPMS

Request

Get details of a specific CPMS backend

Security
bearerToken
Path
tenantstringrequired
cpmsIdintegerrequired
curl -i -X GET \
  'https://guides.exolink.com/_mock/apis/exolink_api/tenant/{tenant}/cpms/{cpmsId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

CPMS details

Bodyapplication/json
idinteger

Unique identifier for the CPMS backend

Example: 1
tenantIdinteger

ID of the tenant that owns this CPMS backend

Example: 1
displayNamestring

User-friendly name for the CPMS backend

Example: "My Charger"
urlstring

WebSocket URL endpoint for the CPMS backend connection

Example: "ws://cpms.exolink.com"
authPassThroughboolean

Indicates whether authentication credentials are passed through to the CPMS backend

Example: true
intervalnumber

Heartbeat or connection check interval in seconds

Example: 30
createdAtstring

Timestamp when the CPMS backend record was created

Example: "2025-10-15T15:19:50.834Z"
updatedAtstring

Timestamp when the CPMS backend record was last updated

Example: "2025-10-15T15:19:50.834Z"
deletedAtstring

Timestamp when the CPMS backend record was soft-deleted (null if active)

Example: "2025-10-15T15:19:50.834Z"
Response
application/json
{
  "id": 1,
  "tenantId": 1,
  "displayName": "My Charger",
  "url": "ws://cpms.exolink.com",
  "authPassThrough": true,
  "interval": 30,
  "createdAt": "2025-10-15T15:19:50.834Z",
  "updatedAt": "2025-10-15T15:19:50.834Z",
  "deletedAt": "2025-10-15T15:19:50.834Z"
}

Update CPMS

Request

Update CPMS backend information

Security
bearerToken
Path
tenantstringrequired
cpmsIdintegerrequired
Bodyapplication/jsonrequired
urlstring

CPMS WebSocket URL

curl -i -X PUT \
  'https://guides.exolink.com/_mock/apis/exolink_api/tenant/{tenant}/cpms/{cpmsId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "string"
  }'

Responses

CPMS updated successfully

Delete CPMS

Request

Delete a CPMS backend

Security
bearerToken
Path
tenantstringrequired
cpmsIdintegerrequired
curl -i -X DELETE \
  'https://guides.exolink.com/_mock/apis/exolink_api/tenant/{tenant}/cpms/{cpmsId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

CPMS deleted successfully

Charger

Charger management endpoints

Operations

Lab

Lab management endpoints

Operations

Logs

Log endpoints

Operations

Domain

Custom Domain endpoints

Operations