Skip to content

Exolink API (1.0.0)

Download OpenAPI description
Overview
Exolink Support
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

Charger

Charger management endpoints

Operations

Lab

Lab management endpoints

Operations

List Labs

Request

Get list of lab environments

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

Responses

List of labs

Bodyapplication/jsonArray [
idinteger

Lab ID

tenantIdinteger

Tenant ID

displayNamestring

Lab display name

initialProfileIdinteger

Initial profile ID for the lab

versionstring

Lab software version

tenantSubscriptionIdinteger

Associated subscription ID

healthstring

Lab health status

statusstring

Lab status

Enum"READY""PENDING"
urlstring

Lab access URL

createdAtstring(date-time)
updatedAtstring(date-time)
deletedAtstring(date-time)
]
Response
application/json
[ { "id": 0, "tenantId": 0, "displayName": "string", "initialProfileId": 0, "version": "string", "tenantSubscriptionId": 0, "health": "string", "status": "READY", "url": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "deletedAt": "2019-08-24T14:15:22Z" } ]

Create Lab

Request

Create a new lab environment

Security
bearerToken
Path
tenantstringrequired
Bodyapplication/jsonrequired
displayNamestringrequired

Lab display name

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

Responses

Lab created successfully

Update Lab

Request

Update lab information

Security
bearerToken
Path
tenantstringrequired
labIdintegerrequired
Bodyapplication/jsonrequired
displayNamestring
curl -i -X PUT \
  'https://guides.exolink.com/_mock/apis/exolink_api/tenant/{tenant}/lab/{labId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "displayName": "string"
  }'

Responses

Lab updated successfully

Update Lab Task

Request

Update lab task configuration

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

Responses

Task updated successfully

Delete Lab

Request

Delete a lab environment

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

Responses

Lab deleted successfully

List Config Versions

Request

Get list of lab configuration versions

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

Responses

List of config versions

Get Latest Config

Request

Get latest lab configuration

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

Responses

Latest configuration

Get Config Version

Request

Get specific lab configuration version

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

Responses

Configuration version

Get Latest Lab Version

Request

Get latest available lab software version

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

Responses

Latest lab version

Logs

Log endpoints

Operations

Domain

Custom Domain endpoints

Operations