How to Use API Access

How to Use API Access
Customer Guide

How to Use API Access

Create and secure an API credential, authenticate with a Bearer token, and manage supported VPS and VPN services through the MAXKO API.

MAXKO Hosting API Access lets you securely use supported account, VPS, and VPN operations from your own applications, scripts, or integrations.

Step 1 - Create an API Credential

Log in to the MAXKO Hosting client panel, open API Access, and create a new API credential. Enter a recognizable name so you can identify where the credential is used.

IP Whitelist
  • The IP Whitelist is optional.
  • Leave it empty to allow API access from any IP address.
  • Enter an individual IP address or a CIDR range when access should be restricted.
Create an API credential and optionally configure an IP whitelist
Create a named API credential and optionally restrict it by IP address or CIDR range.

Step 2 - Copy the API Key

After the credential is generated, its API key is displayed. The full API key is displayed only once. Copy it immediately and store it securely before leaving the page.

API credential created confirmation
Copy the generated API key immediately because the full key cannot be displayed again.

Step 3 - Open the API Documentation

The MAXKO API Documentation contains the available endpoints, authentication information, request parameters, and examples. API requests authenticate with a Bearer token:

Authorization: Bearer YOUR_API_KEY
MAXKO API Documentation overview
Use the API Documentation as the source for current endpoints, parameters, and examples.

Step 4 - VPS API Operations

The VPS section of the API Documentation contains the currently supported VPS operations. Examples include:

  • Listing VPS services
  • Purchasing a VPS using Account Credits
  • Viewing VPS details and status
  • Viewing networking, IPv4, and IPv6 information
  • Starting, shutting down, stopping, and rebooting a VPS
  • Reinstalling a VPS
  • Using console access
  • Managing reverse DNS
  • Cancelling a VPS

Refer to the API Documentation for the exact current endpoint definitions and request parameters.

VPS endpoints in the MAXKO API Documentation
Browse the VPS section for supported service, power, networking, console, and management operations.

Step 5 - VPN API Operations

Supported VPN services can also be managed through the API. Examples include:

  • Listing VPN services
  • Purchasing a VPN using Account Credits
  • Viewing VPN details
  • Renewing a VPN
  • Adding bandwidth
  • Suspending and unsuspending a VPN
  • Resetting consumed VPN traffic where supported

Refer to the API Documentation for the exact current endpoint definitions and request parameters.

VPN endpoints in the MAXKO API Documentation
Browse the VPN section for the curre

Step 6 — Revoke an API Credential

Return to API Access in the client panel to view your credentials. Revoke any credential that is no longer needed or may have been exposed. Once revoked, it can no longer authenticate API requests.

Revoke a MAXKO Hosting API credential
Revoke credentials that are unused, exposed, or potentially compromised.

Keep Your API Credentials Secure

  • Treat API credentials like passwords.
  • Never publish API keys in public repositories.
  • Never expose API keys in frontend or client-side JavaScript.
  • Use IP restrictions where appropriate.
  • Use separate credentials for separate applications where practical.
  • Revoke credentials that are no longer needed or may have been compromised.