Skip to main content

OakHost Customer API

OakHost offers an API to access and manipulate your resources, such as server information, firewall and more. This allows you to integrate OakHost into your own applications or scripts. The automated creation of servers is currently not supported.

You can access the Swagger endpoint documentation at:

https://www.oakhost.net/api/documentation

info

This API is currently in beta and may change in the future. To request access, please open a support ticket. Please report any issues or suggestions to our support team.

API Overview#

Endpoint#

The base URL for the API is:

https://www.oakhost.net/api/cws

Authentication#

All requests require Bearer token authentication using the Authorization header. Replace [token] with your actual token. The token can be obtained from the OakHost Customer Panel.

Authorization: Bearer [token]

Content Type#

All requests must use JSON content type. Set the following headers in your requests:

Content-Type: application/json
Accept: application/json

Response Codes#

  • 200 OK - Success
  • 400 Bad Request - Invalid request (e.g., malformed JSON, invalid action)
  • 422 Unprocessable Entity - Validation error (e.g., missing required fields)
  • 401 Unauthorized - Invalid or missing token
  • 403 Forbidden - Access denied (e.g., insufficient permissions)
  • 404 Not Found - Resource not found
  • 500 Internal Server Error - Server error

Endpoints#

For a complete list of endpoints, please refer to the Swagger documentation.