Skip to content

Admin API

The admin API is accessible to automate administration processes or to enable integration with third party applications.

The Administration API is available over the following endpoint:

{BASE_URL}/api/v1

The BASE_URL is the deployment URL. For Localhost it is http://localhost:3000.

All requests require JSON Body unless specified.

The API accepts API keys that have been generated using the User Interface. Each API call should provide this key in the Authorization header as Bearer Token. An Example Request can be seen below.

POST {BASE_URL}/api/v1/clients/{serverName}
Authorization: Bearer {ADMIN_API_KEY}
Content-Type: application/json
  1. Open the Admin API Integrations Page. API Keys Page
  2. Generate a new API Key. API Keys Page

All responses are wrapped in the following envelope:

{
"success": true,
"message": "The Action was performed successfully",
"data": {
...
}
}

The actual response is available within the data field.

You can create new API Clients for a server using this request.

POST {BASE_URL}/api/v1/clients/{serverId}
Field Type Default Validation
name string “API Key” 1-100 characters (trimmed)
description string “Created with the API” Up to 500 characters(trimmed)
expiresInMinutes number 60 minutes The time this client expires from time of creation.