API Reference

The smoxy public API lets you automate everything you can do in the Hub: zones, hostnames, DNS, certificates, security rules and more. Pick an endpoint from the sidebar to see its parameters, the full request body schema, response examples and ready-to-use code snippets - or try it directly from the browser.

Base URL

All endpoints are served at:

https://api.smoxy.eu

Authentication

Authenticate each request by sending a personal access token in the X-API-TOKEN HTTP header:

curl -H "X-API-TOKEN: <token>" https://api.smoxy.eu/api/zones

Tokens are created in the Hub under your account settings. See API Tokens for how to create and manage them.

Request & Response Formats

The API speaks JSON-LD (Hydra) by default and plain JSON on request:

• Responses default to application/ld+json. Send Accept: application/json for plain JSON.
• POST and PUT requests accept application/ld+json or application/json.
• PATCH requests use JSON Merge Patch: send only the fields to change with Content-Type: application/merge-patch+json. An explicit null clears a field.

Resources reference each other by IRI, e.g. a zone's organization is /api/organizations/1.