API hub

Use the VexylCloud API to drive the product from CLI tools, automation, and the rest of your stack.

The public API story should answer a buyer question fast: what can we automate, how do we authenticate, and how quickly can we wire VexylCloud into the systems we already run? The current external surface already covers API-key management, outbound webhooks, ticket workflows, search, reporting, backup posture, cloud credentials, and VM actions, with a published OpenAPI spec at /api/openapi.json.

Published OpenAPI External tools can fetch the canonical spec from /api/openapi.json.

Best current uses Tickets, workflow triggers, webhooks, search, asset inventory, backup posture, and cloud automation.

CLI-ready Use curl, Postman, Insomnia, or your own automation once the tenant is authenticated correctly.

Automate the work Create tickets, trigger workflows, pull search results, read reports, and drive cloud actions without living in the browser.

Integrate the stack Push events into other tools with outbound webhooks and use the same published request and response shapes for technical evaluation.

Review safely Start with the OpenAPI spec, then go deeper into auth, examples, rate limits, and webhooks only where your rollout needs it.

Portal map Routes Route families Quickstart

Developer portal map

Access

Authentication

Current session and tenant-key model for external automation.

Events

Webhooks

Outbound event delivery, HMAC verification, and receiver expectations.

Safety

Rate limits

Backoff, retries, provider limits, and high-volume integration guidance.

CLI

Examples

Representative curl patterns for tickets, workflows, search, cloud, and reports.

Change visibility

Changelog

Public-facing product and documentation updates relevant to evaluation and rollout.

Trust

Trust Center

Security review, legal references, status, and support routing.

Start with the right API page

Access

Authentication

See how authenticated operator sessions and tenant API keys fit the current public API surface.

Events

Webhooks

Connect outbound VexylCloud events into PSA, SIEM, orchestration, or internal automation targets.

CLI

Examples

Start from real curl examples for tickets, workflows, search, cloud, and reports.

Rollout

Documentation

Use the rollout and implementation hub when the technical review needs a broader sequence.

Common external routes buyers usually test first

Route	Method	Why it matters	Practical use
`/api/openapi.json`	`GET`	Imports the canonical public schema	Pull into Postman, Insomnia, or your own CLI workflow
`/api/admin/api-keys`	`GET POST PUT DELETE`	Controls tenant API keys	Create keys, rotate access, disable old automation credentials
`/api/admin/webhooks`	`GET POST PUT DELETE`	Controls outbound webhook configuration	Wire ticket and workflow events into SIEM, PSA, or orchestration
`/api/psa/tickets`	`GET POST`	Reads and creates service work	Push incidents into VexylCloud or sync queue views outward
`/api/psa/workflows/trigger`	`GET POST PATCH DELETE`	Runs and manages cross-module workflows	Trigger workflow automation or maintain workflow definitions programmatically
`/api/search`	`GET`	Searches customer and platform context	Find devices, users, orgs, and related entities from external tooling
`/api/rmm/reports/asset-inventory`	`GET`	Reads inventory data for reporting	Export asset data into BI, reports, or reconciliation scripts
`/api/cloud/providers` / `/api/cloud/vms`	`GET POST PUT DELETE` / `GET POST`	Reads provider config and VM fleets	Automate cloud credential setup and VM lifecycle work
`/api/backup/config` / `/api/backup/customer-aggregate`	`GET PUT` / `GET`	Exposes backup posture and configuration	Read posture or adjust backup config from external tooling
`/api/analytics/tenant` / `/api/analytics/platform`	`GET`	Exposes usage and platform analytics	Feed internal reporting or executive dashboards

External API families buyers usually care about first

Control plane API keys and outbound webhooks Create tenant API keys, register webhook endpoints, and control the event-delivery surface from the admin layer.

Representative routes: /api/admin/api-keys and /api/admin/webhooks.

Service workflows Tickets, queue automation, and triggerable workflows Push service work into VexylCloud or trigger existing workflow logic from external tools.

Representative routes: /api/psa/tickets and /api/psa/workflows/trigger.

Search and reporting Search, asset inventory, and analytics reads Pull device, organization, user, inventory, and analytics data into your own reporting or orchestration flow.

Representative routes: /api/search, /api/rmm/reports/asset-inventory, /api/analytics/tenant, and /api/analytics/platform.

Cloud Cloud credentials, VM inventory, and provisioning List credentials, verify provider access, read VM fleets, and provision new cloud instances through the product.

Representative routes: /api/cloud/providers and /api/cloud/vms.

Recovery Backup configuration and customer-level posture reads Read backup posture and adjust backup configuration without dropping into separate tooling.

Representative routes: /api/backup/config and /api/backup/customer-aggregate.

Schema Published OpenAPI for external tooling Use the canonical spec to import the API into Postman, Insomnia, Redoc, or your own tooling.

Canonical endpoint: GET /api/openapi.json

Quickstart

1. Pull the spec

Start by importing /api/openapi.json into the client you already use for technical evaluation.

curl https://dash.vexylcloud.com/api/openapi.json

2. Authenticate

Today’s public API surface is primarily tenant-session driven, with tenant API keys available for admin automation and webhook management.

Cookie: <authenticated VexylCloud session>

3. Run one real workflow

Use a representative route, not just a spec import. The best test is usually ticket creation, search, webhook registration, or a cloud read.

POST /api/psa/tickets
GET /api/search?q=acme
POST /api/admin/webhooks

4. Validate operations

Review webhooks, rate limits, changelog, status, and trust material before you widen the integration beyond a controlled evaluation.

/api/webhooks/
/api/rate-limits/
/documentation/changelog/
/status/

Current public API scope

The customer-facing API story is the external control surface for VexylCloud itself. This page intentionally avoids the internal agent-ingest, cron, and provider-callback plumbing because that is not the buyer question. The practical focus is how your team can script, integrate, and automate the product from outside the UI.

Sandbox and evaluation model

There is no separate public sandbox today. The practical evaluation path is to import the published OpenAPI, review auth and rate-limit behavior, then validate the API against a non-production tenant or controlled rollout environment before wider production use.

Versioning and support

Use the published OpenAPI as the current source of truth, watch the changelog for public-facing updates, and use status plus contact when the API review needs operational or support follow-through. The goal is not just to expose routes, but to make technical evaluation low-risk.

Need the API mapped to your exact integration use case?

Book a technical walkthrough if you want the external API surface tied to your CLI automation, ticketing sync, webhook targets, cloud workflows, or reporting requirements.

CLI and automation focus Auth and webhook review Controlled evaluation path

Book Demo Open API examples