API Documentation

API Documentation

Manage Your VPS with API

Explore the LoraVPS API structure for programmatic VPS management, automation, server information, and infrastructure workflows. Built around clear HTTP requests and structured JSON responses.

01 API Overview

The LoraVPS API is designed for developers who want to integrate VPS management into applications, scripts, dashboards, and automation workflows.

  • REST-style HTTP API architecture
  • JSON request and response format
  • HTTPS-based API communication
  • Token-based authentication structure
  • Versioned API endpoints
API Availability

API access and specific endpoints are available only when enabled for the applicable LoraVPS service or account.

02 Base URL

API requests should use the official LoraVPS API endpoint assigned to the active API version.

https://api.loravps.monster/v1
Example Documentation Endpoint

The URL above is a documentation structure example and should only be used after the corresponding LoraVPS API service is officially enabled.

03 Authentication

Authenticated API requests should use a private API token. Keep API credentials confidential and never expose them in client-side code, public repositories, browser scripts, or frontend applications.

Authorization: Bearer YOUR_API_TOKEN
  • Store API tokens in environment variables or a secure secret manager.
  • Use separate credentials for different applications when supported.
  • Rotate credentials if exposure is suspected.
  • Do not send API tokens through URLs or query parameters.

04 HTTP Methods

The API structure follows conventional HTTP methods for retrieving, creating, updating, and removing resources.

GET Retrieve resources
POST Create or trigger actions
PATCH Update resources
DELETE Remove resources

05 VPS Endpoints

The following examples illustrate the planned documentation format for common VPS management operations.

GET /servers

Retrieve VPS resources associated with the authenticated account.

GET /servers/{server_id}

Retrieve information for a specific VPS resource.

POST /servers

Create or provision a VPS when provisioning through the API is enabled for the account.

DELETE /servers/{server_id}

Request removal of a VPS resource according to the applicable account and service rules.

Endpoint Notice

Endpoint names and actions shown above are examples for documentation layout. They should not be presented as live API functionality until the corresponding LoraVPS API is implemented and enabled.

06 Example Request

A typical authenticated request can be structured using cURL:

curl -X GET \ "https://api.loravps.monster/v1/servers" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Accept: application/json"

07 JSON Response

API responses should use predictable JSON structures so applications can process VPS information consistently.

{ "data": [ { "id": "server_123456", "name": "example-vps", "status": "active", "ip_address": "203.0.113.10" } ] }

08 Error Handling

Applications should handle HTTP errors and API response messages without exposing sensitive credentials or internal system information.

400 Bad Request

The request format or supplied parameters are invalid.

401 Unauthorized

Authentication is missing or the supplied credential is invalid.

403 Forbidden

The authenticated account does not have permission for the requested resource.

404 Not Found

The requested resource or endpoint could not be found.

429 Too Many Requests

The request rate has exceeded the applicable API limit.

5xx Server Error

The API service encountered an internal or temporary server issue.

09 API Security

API credentials provide access to account resources and should be treated as sensitive information.

  • Use HTTPS for API communication.
  • Never publish private API tokens.
  • Limit application permissions where supported.
  • Rotate compromised or exposed credentials immediately.
  • Monitor API activity and investigate unexpected requests.

10 Usage & Service Terms

API access is provided for legitimate VPS management and automation. API usage remains subject to the LoraVPS Terms of Service, Acceptable Use requirements, applicable service limits, and applicable law.

API access does not change the customer's payment obligations, VPS service terms, refund rules, or account responsibilities.

Need API Access?

Contact LoraVPS Support to ask about API availability, supported features, authentication requirements, and integration options for your VPS service.

Contact Us
API availability, endpoints, authentication methods, rate limits, and supported operations may vary by service and account. Documentation examples do not represent live API functionality unless the corresponding API service has been officially enabled.