Docs

Documentation

Everything you need to know about using Arxentra's cloud infrastructure. From getting started to advanced configurations and best practices.

API

Live API Endpoints

Complete reference for Arxentra's REST API. All endpoints are live and ready to use. Base URL: https://arxentra.com (paths below already include the /api prefix)

Public Endpoints

Authentication

MethodPathDescriptionAccess
POST/api/auth/registerRegister new user account with validationNo Auth
POST/api/auth/loginUser login with rate limiting (5/15min)No Auth
GET/api/auth/sessionGet current session informationNo Auth
POST/api/auth/logoutUser logout and session cleanupAuth Required
PUT/api/auth/profileUpdate user profile informationAuth Required
PUT/api/auth/passwordChange user passwordAuth Required

Public Information

MethodPathDescriptionAccess
GET/api/healthComprehensive system health check with DB statusNo Auth
GET/api/statusService status and uptime informationNo Auth
POST/api/contactSubmit contact form with validationNo Auth
GET/api/documentation/searchSearch documentation with categoriesNo Auth
GET/api/documentation/categoriesGet documentation categoriesNo Auth
GET/api/blogGet blog posts and articlesNo Auth
GET/api/careersGet career listings and job postsNo Auth
POST/api/job-applicationSubmit job application (legacy endpoint)No Auth
GET/api/helpGet help and FAQ informationNo Auth
GET/api/communityCommunity resources and forumsNo Auth
GET/api/metricsPublic metrics and system statisticsNo Auth

Protected Endpoints

These endpoints require authentication. Include your session token or API key in the Authorization header.

Services Management

MethodPathDescriptionAccess
GET/api/servicesList all user services with filteringAuth Required
POST/api/servicesCreate new service with validationAuth Required
GET/api/services/statsGet service statistics and metricsAuth Required
GET/api/services/:idGet detailed service informationAuth Required
PUT/api/services/:idUpdate service configurationAuth Required
DELETE/api/services/:idDelete service and resourcesAuth Required
POST/api/services/:id/startStart service instanceAuth Required
POST/api/services/:id/stopStop service instanceAuth Required
POST/api/services/:id/pausePause service instanceAuth Required
POST/api/services/:id/restartRestart service instanceAuth Required
POST/api/services/bulk-actionBulk operations on multiple servicesAuth Required
PUT/api/servicesBulk update multiple servicesAuth Required

Billing & Analytics

MethodPathDescriptionAccess
GET/api/billingGet billing information and current usageAuth Required
GET/api/billing/invoicesList invoices and payment historyAuth Required
GET/api/billing/usageGet detailed usage statisticsAuth Required
GET/api/analyticsGet analytics dashboard dataAuth Required
GET/api/analytics/usageGet usage analytics and trendsAuth Required
GET/api/analytics/performanceGet performance metricsAuth Required

Infrastructure & Management

MethodPathDescriptionAccess
GET/api/monitoringGet monitoring data and alertsAuth Required
GET/api/monitoring/metricsGet system metrics and health dataAuth Required
GET/api/orchestrationContainer orchestration statusAuth Required
POST/api/orchestration/deployDeploy container orchestrationAuth Required
GET/api/networkingNetwork configuration and statusAuth Required
POST/api/networking/configureConfigure network settingsAuth Required
GET/api/websocket/tokenGet WebSocket authentication tokenAuth Required
GET/api/users/profileGet user profile and settingsAuth Required
PUT/api/users/settingsUpdate user settingsAuth Required

Admin Endpoints

These endpoints require admin privileges. Only accessible to users with administrator roles.

System Administration

MethodPathDescriptionAccess
GET/api/admin/dashboardAdmin dashboard with system overviewAdmin Only
GET/api/admin/usersList and manage all usersAdmin Only
GET/api/admin/servicesSystem-wide service managementAdmin Only
GET/api/admin/analyticsSystem-wide analytics and reportingAdmin Only
GET/api/admin/billingSystem billing and revenue dataAdmin Only
GET/api/admin/monitoringSystem monitoring and healthAdmin Only

System Management

MethodPathDescriptionAccess
GET/api/system/db-statsDatabase performance and statisticsAdmin Only
GET/api/system/healthComprehensive system health checkAdmin Only
POST/api/system/maintenanceTrigger maintenance operationsAdmin Only
GET/api/system/logsSystem logs and audit trailAdmin Only

Guides

Documentation Guides

Comprehensive guides and tutorials to help you get the most out of Arxentra's platform.

Getting Started

Quick start guides and basic concepts

  • Account Setup and Configuration
  • Your First Virtual Machine
  • Understanding Billing and Pricing
  • Basic Security Setup
View All Articles →

API Reference

Complete REST API documentation with real endpoints

  • Authentication (/api/auth/*)
  • Services Management (/api/services/*)
  • Billing & Analytics (/api/billing/*)
  • Monitoring & WebSocket (/api/monitoring/*)
View All Articles →

CLI Tools

Command-line interface documentation

  • CLI Installation and Setup
  • Common Commands
  • Automation Scripts
  • Configuration Management
View All Articles →

Services Guide

Detailed guides for each service

  • Virtual Machines & Containers
  • Database Services
  • Object Storage
  • Networking & Orchestration
View All Articles →

Security

Security best practices and compliance

  • Identity and Access Management
  • Network Security
  • Data Encryption
  • Compliance and Certifications
View All Articles →

Tutorials

Step-by-step tutorials and guides

  • Deploying a Web Application
  • Setting Up Load Balancing
  • Database Migration Guide
  • Monitoring and Alerting
View All Articles →

Popular

Popular Resources

Quick access to our most frequently accessed documentation and guides.

API Quick Start

Get up and running with our API in 5 minutes

5 min read

Migration Guide

Step-by-step guide to migrate from other providers

15 min read

Security Checklist

Essential security configurations for your account

10 min read

Cost Optimization

Best practices to optimize your cloud spending

12 min read

Monitoring Setup

Configure monitoring and alerting for your services

8 min read

Backup Strategies

Implement robust backup and disaster recovery

20 min read

FAQ

Frequently Asked Questions

Common questions about Arxentra documentation and getting started.

How do I get started with Arxentra's platform?

Create a free account, then follow our Getting Started guide to deploy your first virtual machine in under 5 minutes. The guide covers account setup, SSH key configuration, and launching your first instance with our one-click provisioning.

Where can I find the API reference documentation?

The full REST API reference is available on this page under the Live API Endpoints section. It covers all public, authenticated, and admin endpoints with request/response formats. All endpoints are served from https://arxentra.com, so the paths below (for example /api/auth/login) are used as-is.

Does Arxentra provide CLI tools?

Yes, Arxentra offers a command-line interface that supports all platform operations. Install it via npm or download the binary directly. The CLI documentation covers installation, authentication, common commands, and automation scripting.

How do I migrate from another cloud provider?

Our Migration Guide provides step-by-step instructions for moving workloads from AWS, Google Cloud, or Azure. The process typically takes 15-30 minutes for standard deployments and includes tools for database migration, DNS cutover, and validation.

What authentication methods does the API support?

The API supports JWT token authentication for session-based access and API keys for programmatic access. Tokens are obtained via the /api/auth/login endpoint and should be included in the Authorization header of subsequent requests.

Support

Need More Help?

Can't find what you're looking for? Our support team is here to help you succeed with personalized assistance and expert guidance.

Contact SupportJoin Community