Quickstart¶

Phase-05 note: this used to be four ~350-400 line, hand-maintained workflow walkthroughs (one per language) that inevitably drifted from the actual API as endpoints changed — nothing regenerated them. They're replaced with this one short page. For the full, always-current endpoint list — every parameter, every response field, every documented error code — use the generated reference instead of hand-written prose:

• API Reference (Redoc) — browse by resource, see real response shapes
• Swagger UI — same spec, interactive "try it now" console
• openapi.json — the raw spec, if you're generating a typed client

Every example below does the same thing: authenticate, then list your domains.

Authentication¶

Every request needs X-API-Key. Get a key from POST /api/v1/bootstrap on a fresh install (see the main Getting Started guide), or from an existing organization's dashboard.

curl¶

export MAILYTE_URL="http://your-server:8083"
export MAILYTE_KEY="your-api-key-here"

curl "$MAILYTE_URL/api/v1/domains/" -H "X-API-Key: $MAILYTE_KEY"

Python¶

import requests

MAILYTE_URL = "http://your-server:8083"
MAILYTE_KEY = "your-api-key-here"

resp = requests.get(
    f"{MAILYTE_URL}/api/v1/domains/",
    headers={"X-API-Key": MAILYTE_KEY},
)
resp.raise_for_status()
print(resp.json()["data"])

JavaScript¶

const MAILYTE_URL = "http://your-server:8083";
const MAILYTE_KEY = "your-api-key-here";

const resp = await fetch(`${MAILYTE_URL}/api/v1/domains/`, {
  headers: { "X-API-Key": MAILYTE_KEY },
});
const { data } = await resp.json();
console.log(data);

PHP¶

<?php
$mailyteUrl = "http://your-server:8083";
$mailyteKey = "your-api-key-here";

$ch = curl_init("$mailyteUrl/api/v1/domains/");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-API-Key: $mailyteKey"]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($response["data"]);

Response envelope¶

Every response is shaped {"type": "success"|"error", "msg": "...", "data": {...}} — data is omitted on responses that have nothing to return (e.g. a bare success message). See Errors for the full status code table and error_code registry.

Idempotent writes¶

Any mutating request (POST/PUT/PATCH/DELETE) accepts an optional Idempotency-Key header. Retry the exact same key + body within 24h and you get the original response back, not a duplicate side effect — safe for network retries.