The Veyon Developers Platform provides a RESTful API designed to allow developers, DevOps engineers, and system administrators to programmatically interact with their Veyon infrastructure. By exposing core platform capabilities through HTTP endpoints, Veyon enables seamless integration into custom dashboards, internal IT Service Management (ITSM) tools, deployment pipelines, and automated monitoring workflows.


Instead of manually configuring services through the web UI, the API enables full programmatic lifecycle management—from creating automated monitors during server provisioning to dynamically updating status page incidents during deployment windows.

Core Capabilities & Key Use Cases

  • Automated Monitor Provisioning: Automatically register, update, or remove endpoint monitors as infrastructure scales up or down in CI/CD pipelines.

  • Incident Management Automation: Trigger and update service incidents directly from internal alert channels (e.g., custom webhooks, PagerDuty, or Slack bots).

  • Dynamic Status Pages: Programmatically manage service visibility and group component statuses across custom status pages.

  • Metrics & Analytics Extraction: Pull raw uptime stats, performance latency, and audit data into centralized business intelligence or observability tools.

Authentication & Authorization

All requests to the Veyon API require authentication using an API Bearer Token.

Include your API key in the Authorization header of every HTTP request:

HTTP
Authorization: Bearer {api_key}
Accept: application/json

⚠️ Security Note: Treat API tokens as sensitive credentials. Never expose tokens in client-side applications, public repositories, or frontend scripts.