Docs/API Reference/Agents API
API4 min read

Agents API

Manage on-premise agents programmatically

Base URL

text
https://app.conexor.io/api/plugins

List Agents

GET /api/plugins

Returns all agents for the authenticated organization.

json
[
  {
    "id": "uuid",
    "name": "SQL Server Production",
    "status": "connected",
    "version": "1.2.0",
    "lastSeen": "2026-02-23T10:00:00Z",
    "ipAddress": "192.168.1.100",
    "dataSourceCount": 3
  }
]

Create Agent

POST /api/plugins
json
// Request
{ "name": "SQL Server Production" }

// Response
{
  "id": "uuid",
  "name": "SQL Server Production",
  "apiKey": "pk_live_xxxxx"
}

Get Agent

GET /api/plugins/{id}
json
{
  "id": "uuid",
  "name": "SQL Server Production",
  "status": "connected",
  "version": "1.2.0",
  "os": "Windows Server 2022",
  "dotnetVersion": "8.0.1",
  "lastSeen": "2026-02-23T10:00:00Z",
  "ipAddress": "192.168.1.100",
  "metadata": { "cpuCores": 8, "memoryGb": 32 }
}

Delete Agent

DELETE /api/plugins/{id}

Returns 204 No Content on success. Cascades to delete all associated data sources.

Regenerate API Key

POST /api/plugins/{id}/regenerate-api-key
json
{ "pluginId": "uuid", "apiKey": "pk_live_new_key_xxxxx" }
Relay

Quick questions

Relay

Quick questions