Client Portal Order Server

API Documentation

Automate server management with our RESTful API

Our comprehensive REST API allows you to programmatically manage servers, automate deployments, and integrate our services into your existing infrastructure.

Getting Started

Access to the API requires authentication using API keys generated from your client portal. All requests must include your API key in the Authorization header.

curl -X GET https://api.dedicated-servers.org/v1/servers \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

API Endpoints

List Servers

GET /v1/servers

Returns a list of all servers associated with your account including status, IP addresses, and configuration details.

Get Server Details

GET /v1/servers/{server_id}

Retrieve detailed information about a specific server including hardware specs, network configuration, and current status.

Reboot Server

POST /v1/servers/{server_id}/reboot

Initiate a soft or hard reboot of the specified server. Returns immediately with operation status.

Reinstall OS

POST /v1/servers/{server_id}/reinstall

Trigger an automated OS reinstallation. Requires operating system parameter and optional SSH key configuration.

Get Server Metrics

GET /v1/servers/{server_id}/metrics

Retrieve real-time performance metrics including CPU usage, memory consumption, and network traffic statistics.

Response Format

All API responses are returned in JSON format with consistent structure. Successful requests return HTTP 200 status code with data payload.

{
  "success": true,
  "data": {
    "id": "srv_abc123",
    "name": "web-server-01",
    "status": "running",
    "ip_address": "192.0.2.100"
  }
}

Rate Limits

API requests are rate limited to 1000 requests per hour per API key. Rate limit headers are included in all responses to help you monitor your usage.

Error Handling

Error responses include appropriate HTTP status codes and detailed error messages to help troubleshoot issues.

{
  "success": false,
  "error": {
    "code": "server_not_found",
    "message": "Server with ID srv_abc123 not found"
  }
}

Need Full Documentation?

Contact support to receive complete API documentation with detailed examples, SDKs, and integration guides.

Contact Support