REST API - KmerHosting

Base URL and authentication

The production base URL is https://api.kmerhosting.com. Authenticate with an API key or, for the hosted MCP flow, a user-scoped OAuth access token.

Authorization: Bearer kh_live_...

Open interactive API docs

Try the REST API in Swagger UI and inspect the live schema.

Download the OpenAPI document

Use the machine-readable contract with generators and API clients.

Domain availability API

Check domain availability publicly, with single and bulk search.

The interactive documentation is served by the API itself at api.kmerhosting.com/docs. It always reflects the deployed gateway contract; use the reference pages in this site for KmerHosting workflows and security guidance. The health endpoint is public: GET /health. All /v1/* operations require an appropriate scope. For public domain availability checks without an API key, use the separate Domain availability API. It is not part of the api.kmerhosting.com OpenAPI contract.

Response envelopes

Successful responses use this shape:

{ "data": {}, "request_id": "UUID" }

Error responses use this shape:

{ "error": { "code": "string", "message": "string", "request_id": "UUID" } }

Writes and idempotency

Every documented mutation requires Idempotency-Key, 8–128 characters using letters, digits, ., _, :, or -. Generate it once per logical operation and reuse it only when retrying that exact operation.

curl --fail-with-body -X PUT \
  "https://api.kmerhosting.com/v1/domains/DOMAIN_ID/auto-renew" \
  -H "Authorization: Bearer $KMERHOSTING_API_KEY" \
  -H "Idempotency-Key: domain-renewal-20260831" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true}'

Some writes return an accepted or queued result. Poll the relevant read endpoint, the Customer Dash, or the service’s dedicated management application when one is used.

Resource families

The exact endpoint definitions are generated in the OpenAPI reference: account and API activity, service inventory, domains/DNS, Email Hosting, Shared Hosting, LXC inventory/actions/metrics/snapshots/credentials/reinstall/terminal/subscription, KVM management, and ConvertSuite REST processing. Use GET /v1/account/api-usage with account:usage:read to audit product and non-product calls, including operation IDs and source IPv4 values. The former /v1/vps/* resource is retired; use /v1/lxc/* or /v1/kvm/* explicitly.

AI-ready integration prompt

The Customer Dash provides copy-ready versions for ChatGPT, Claude, Gemini, Cursor, and other AI coding clients.

Help me integrate the KmerHosting REST API. Base URL: https://api.kmerhosting.com . Use a scoped KmerHosting API key in Authorization: Bearer and keep it server-side or in a secret manager. Use the documented /v1 endpoints and Idempotency-Key for mutations. Treat the live OpenAPI contract as authoritative for request and response shapes. Official documentation: https://kmerhosting.com/docs/developer/rest-api . API-key guide: https://kmerhosting.com/docs/developer/api-keys . Live API docs: https://api.kmerhosting.com/docs . OpenAPI: https://api.kmerhosting.com/openapi.json . Official GitHub repository: https://github.com/KmerHosting/api . Start by asking what operation I want, then provide the smallest secure implementation and required scopes.

ConvertSuite REST processing

ConvertSuite is available through the KmerHosting gateway at https://api.kmerhosting.com. Active Pro and Business ConvertSuite plans expose the convertsuite:read and convertsuite:process capabilities. The gateway checks the ConvertSuite entitlement again when the request is forwarded, so a key alone does not bypass plan access. A successful POST /v1/convertsuite/prepare-upload reserves exactly one ConvertSuite operation, regardless of the number of input files. Polling a job, starting it, or cancelling it does not reserve another operation. Reuse the same Idempotency-Key only to retry the exact same prepare/start/cancel request.

Discover tools

curl --fail-with-body https://api.kmerhosting.com/v1/convertsuite/tools \
  -H "Authorization: Bearer $KMERHOSTING_API_KEY"

Prepare, upload, and run a job

curl --fail-with-body -X POST \
  https://api.kmerhosting.com/v1/convertsuite/prepare-upload \
  -H "Authorization: Bearer $KMERHOSTING_API_KEY" \
  -H "Idempotency-Key: convertsuite-job-20260920-001" \
  -H "Content-Type: application/json" \
  -d '{
    "tool": "image-convert",
    "options": { "format": "webp", "quality": 82 },
    "files": [
      { "originalName": "photo.png", "mimeType": "image/png", "sizeBytes": 123456 }
    ]
  }'

The response contains a job and one-time signed upload URLs. Upload each file to its returned URL, then call POST /v1/convertsuite/jobs/{jobId}/start with a new idempotency key. Poll GET /v1/convertsuite/jobs/{jobId} until succeeded, then download the short-lived artifact URL. Use POST /v1/convertsuite/jobs/{jobId}/cancel when an upload has not started. The live OpenAPI contract contains the complete request and response schemas and the Swagger UI can execute the authenticated routes.

​Base URL and authentication

Open interactive API docs

Download the OpenAPI document

Domain availability API

​Response envelopes

​Writes and idempotency

​Resource families

​AI-ready integration prompt

​ConvertSuite REST processing

​Discover tools

​Prepare, upload, and run a job