Create CPMS

POST

/tenant/{tenantId}/cpms

curl --request POST \
  --url https://api.exolink.cloud/tenant/example/cpms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "displayName": "example", "url": "wss://cpms.example.com" }'

• Exolink Production

Create a new CPMS backend

Authorizations

• bearerToken

Parameters

Path Parameters

tenantId

required

string

Tenant domain prefix

Request Body^required

Media typeapplication/json

object

displayName

required

CPMS backend display name

string

url

required

WebSocket URL for CPMS backend

string format: uri

Example

wss://cpms.example.com

Responses

200

CPMS created successfully

Media typeapplication/json

object

id

Unique identifier for the CPMS backend

integer

tenantId

ID of the tenant that owns this CPMS backend

integer

displayName

User-friendly name for the CPMS backend

string

url

WebSocket URL endpoint for the CPMS backend connection

string

createdAt

Timestamp when the CPMS backend record was created

string

updatedAt

Timestamp when the CPMS backend record was last updated

string

deletedAt

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

string

nullable

Example

{
  "id": 1,
  "tenantId": 1,
  "displayName": "My Charger",
  "url": "ws://cpms.example.com",
  "createdAt": "2025-10-15T15:19:50.834Z",
  "updatedAt": "2025-10-15T15:19:50.834Z",
  "deletedAt": "2025-10-15T15:19:50.834Z"
}

400

Malformed request

Media typeapplication/json

Error response. Some rejections carry only message.

object

message

required

Error message

string

errorCode

Error code

string

Allowed values: ERR_API_BAD_REQUEST ERR_API_NOT_AUTHORIZED ERR_API_PAYMENT_REQUIRED ERR_API_FORBIDDEN ERR_API_RESOURCE_NOT_FOUND ERR_API_RESOURCE_IN_USE ERR_API_RESOURCE_ALREADY_EXISTS ERR_API_UNEXPECTED_STATE ERR_API_CONTENT_TOO_LARGE ERR_API_VALIDATION_FAILED ERR_API_VERIFICATION_FAILED ERR_API_NO_TENANT ERR_API_INVALID_INVITATION ERR_API_USER_DISABLED ERR_API_FAILED_DEPENDENCY ERR_EXOLINK_GENERIC

details

Failed validations, for requests checked against a schema

Array<object>

object

path

Path of the invalid field

string

message

string

code

string

Example

{
  "message": "Bad Request",
  "errorCode": "ERR_API_BAD_REQUEST"
}

401

Missing, invalid or expired credentials

Media typeapplication/json

Error response. Some rejections carry only message.

object

message

required

Error message

string

errorCode

Error code

string

Allowed values: ERR_API_BAD_REQUEST ERR_API_NOT_AUTHORIZED ERR_API_PAYMENT_REQUIRED ERR_API_FORBIDDEN ERR_API_RESOURCE_NOT_FOUND ERR_API_RESOURCE_IN_USE ERR_API_RESOURCE_ALREADY_EXISTS ERR_API_UNEXPECTED_STATE ERR_API_CONTENT_TOO_LARGE ERR_API_VALIDATION_FAILED ERR_API_VERIFICATION_FAILED ERR_API_NO_TENANT ERR_API_INVALID_INVITATION ERR_API_USER_DISABLED ERR_API_FAILED_DEPENDENCY ERR_EXOLINK_GENERIC

details

Failed validations, for requests checked against a schema

Array<object>

object

path

Path of the invalid field

string

message

string

code

string

Example

{
  "message": "Not authorized",
  "errorCode": "ERR_API_NOT_AUTHORIZED"
}

403

The caller may not perform this action

Media typeapplication/json

Error response. Some rejections carry only message.

object

message

required

Error message

string

errorCode

Error code

string

Allowed values: ERR_API_BAD_REQUEST ERR_API_NOT_AUTHORIZED ERR_API_PAYMENT_REQUIRED ERR_API_FORBIDDEN ERR_API_RESOURCE_NOT_FOUND ERR_API_RESOURCE_IN_USE ERR_API_RESOURCE_ALREADY_EXISTS ERR_API_UNEXPECTED_STATE ERR_API_CONTENT_TOO_LARGE ERR_API_VALIDATION_FAILED ERR_API_VERIFICATION_FAILED ERR_API_NO_TENANT ERR_API_INVALID_INVITATION ERR_API_USER_DISABLED ERR_API_FAILED_DEPENDENCY ERR_EXOLINK_GENERIC

details

Failed validations, for requests checked against a schema

Array<object>

object

path

Path of the invalid field

string

message

string

code

string

Example

{
  "message": "Forbidden",
  "errorCode": "ERR_API_FORBIDDEN"
}

417

Validation or verification failed

Media typeapplication/json

Error response. Some rejections carry only message.

object

message

required

Error message

string

errorCode

Error code

string

Allowed values: ERR_API_BAD_REQUEST ERR_API_NOT_AUTHORIZED ERR_API_PAYMENT_REQUIRED ERR_API_FORBIDDEN ERR_API_RESOURCE_NOT_FOUND ERR_API_RESOURCE_IN_USE ERR_API_RESOURCE_ALREADY_EXISTS ERR_API_UNEXPECTED_STATE ERR_API_CONTENT_TOO_LARGE ERR_API_VALIDATION_FAILED ERR_API_VERIFICATION_FAILED ERR_API_NO_TENANT ERR_API_INVALID_INVITATION ERR_API_USER_DISABLED ERR_API_FAILED_DEPENDENCY ERR_EXOLINK_GENERIC

details

Failed validations, for requests checked against a schema

Array<object>

object

path

Path of the invalid field

string

message

string

code

string

Example

{
  "message": "Missing parameter: displayName",
  "errorCode": "ERR_API_VALIDATION_FAILED"
}