Skip to content
/Tenant

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

Get Tenant

Request

Retrieve tenant information

Security
bearerToken
Path
tenantstringrequired

Tenant domain prefix

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

Responses

Tenant information

Bodyapplication/json
idinteger

Unique identifier for the tenant

Example: 1
namestring

Tenant display name

Example: "My Company"
domainPrefixstring

Unique domain prefix for the tenant (used in URLs and subdomains)

Example: "abc123"
stripeCustomerIdstring

Stripe customer ID for billing

connectUrlstring

WebSocket connection URL for IoT/OCPP

Example: "wss://abc123.broker.exolink.cloud/"
customDomainstring

Custom domain WebSocket URL (if configured)

Example: "wss://chargers.company.com/"
createdAtstring(date-time)

When the tenant was created

updatedAtstring(date-time)

When the tenant was last updated

deletedAtstring(date-time)

When the tenant was deleted (null if active)

Response
application/json
{
  "id": 1,
  "name": "My Company",
  "domainPrefix": "abc123",
  "stripeCustomerId": "string",
  "connectUrl": "wss://abc123.broker.exolink.cloud/",
  "customDomain": "wss://chargers.company.com/",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z"
}

Update Tenant

Request

Update tenant information

Security
bearerToken
Path
tenantstringrequired

Tenant domain prefix

Bodyapplication/jsonrequired
namestring

Tenant name

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

Responses

Tenant updated successfully

Get Tenant Statistics

Request

Retrieve tenant usage statistics

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

Responses

Tenant statistics

Bodyapplication/json
chargerCountinteger

Total number of chargers

activeChargersinteger

Number of currently connected chargers

totalUsersinteger

Number of users in the tenant

messageCountinteger

Total OCPP messages processed

Response
application/json
{
  "chargerCount": 0,
  "activeChargers": 0,
  "totalUsers": 0,
  "messageCount": 0
}

CPMS

CPMS management endpoints

Operations

Charger

Charger management endpoints

Operations

Lab

Lab management endpoints

Operations

Logs

Log endpoints

Operations

Domain

Custom Domain endpoints

Operations