SkyCompute VPS API Documentation
The SkyCompute API is designed to simplify the management of Virtual Private Server resources through secure programmatic access. Where API functionality is available, developers can integrate supported operations into their own applications, automation workflows, deployment pipelines, and infrastructure management tools.
This documentation provides an overview of the API structure, authentication principles, request formats, and general implementation guidance. Specific API capabilities may vary depending on service availability, account permissions, and future platform enhancements.
Infrastructure
Interact with supported VPS resources through a consistent and developer-friendly REST interface where available.
Authentication
Secure API authentication helps protect customer accounts and authorized access to supported resources.
Automation
Integrate VPS management into deployment scripts, monitoring platforms, and development workflows.
Security
API requests should always be transmitted securely while protecting authentication credentials and access tokens.
Overview
The SkyCompute API follows common REST principles and is intended to provide a predictable interface for supported VPS management operations. Depending on the available features of your account, supported endpoints may allow customers to retrieve service information, monitor resource status, or perform selected infrastructure actions through authenticated API requests.
Unless otherwise stated, API communication uses HTTPS together with standard HTTP request methods and JSON data structures. Developers are encouraged to validate request parameters, handle error responses appropriately, and implement secure storage practices for API credentials.
Examples provided throughout this documentation are intended for demonstration purposes only. Available endpoints, request parameters, authentication methods, and supported operations may evolve over time as SkyCompute continues to improve its VPS platform and developer services.
Authentication
Where API access is available, every request should be authenticated using the credentials or API token issued to your account. Authentication helps ensure that only authorized users can access supported VPS resources and perform permitted operations.
API credentials should be treated as confidential information. Never embed API keys in publicly accessible applications, repositories, or client-side code. We recommend storing credentials securely using environment variables or a dedicated secret management solution.
Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json
Accept: application/json
Base URL
API requests should be sent over encrypted HTTPS connections. The production endpoint may vary depending on service availability and future platform updates.
https://api.skycompute.online/v1/
Request & Response Format
The SkyCompute API uses JSON for request and response payloads. Applications should always validate responses and gracefully handle unexpected values or error conditions.
GET /v1/vps
Host: api.skycompute.online
Authorization: Bearer YOUR_API_TOKEN
Example Response
{
"success": true,
"data": [
{
"id": "vps_1001",
"hostname": "vps-s1",
"status": "running"
}
]
}
Rate Limits
To maintain service stability and ensure fair access for all customers, API requests may be subject to rate limiting. Applications should avoid excessive request frequency and implement retry logic with reasonable delays when appropriate.
Available Endpoints
The examples below illustrate common VPS management endpoints that may be available depending on your account permissions and current platform capabilities. Endpoint availability may change as SkyCompute continues to expand its developer services.
GET /v1/vps
GET /v1/vps/{id}
POST /v1/vps/{id}/reboot
POST /v1/vps/{id}/shutdown
POST /v1/vps/{id}/start
GET /v1/account
GET /v1/usage
HTTP Status Codes
API responses use standard HTTP status codes together with JSON response bodies. Applications should always verify both the HTTP status code and the response payload before processing returned data.
Request completed successfully.
A resource was created successfully.
Invalid request or missing parameters.
Authentication failed or credentials are invalid.
The requested operation is not permitted.
The requested resource could not be located.
Rate limit exceeded. Retry later.
Unexpected server-side error occurred.
Development Best Practices
When integrating with the SkyCompute API, developers should implement secure authentication, validate all responses, and design applications to gracefully handle temporary failures. Following industry best practices helps improve reliability and security.
Support
If you have questions regarding API integration, authentication, or supported VPS features, please contact SkyCompute through the contact information available on our website. Our documentation is updated periodically as new functionality becomes available.
Examples contained within this documentation are provided for illustrative purposes only. API endpoints, request formats, authentication methods, and available functionality may be modified, expanded, or deprecated as the SkyCompute platform evolves.
