Create a redirect
POST
/api/organizations/{organizationId}/redirects
Creates a redirect from a source hostname to a target hostname. The root domain for the source hostname is found or created for the organization (bootstrapping a certificate for non-shared domains), and a unique CNAME target is generated and assigned to the source hostname; the customer must point the source hostname's DNS CNAME at that value for the redirect to activate. The mapping then takes effect on the live configuration.
Authorizations
ApiToken
Long-lived API token created via POST /api/api-tokens (returned once in plaintext).
Type
API Key (header: X-API-TOKEN)
or
JWT
JWT access token obtained via POST /api/auth/login. Send as: Authorization: Bearer
Type
HTTP (bearer)
Parameters
Path Parameters
organizationId*
Organization identifier
Type
Requiredstring
Request Body
JSON "targetHostname": "www.example.com", "mode": "path", "sourceHostname": "old.example.com"
{
}
Responses
redirect resource created
JSON "@context": "string", "@id": "string", "@type": "string", "id": 42, "targetHostname": "www.example.com", "mode": "path", "createdAt": "2026-07-01T12:34:56+00:00", "updatedAt": "2026-07-01T12:34:56+00:00", "sourceHostname": "old.example.com", "cnameTarget": "abc123.cname.smoxy.eu", "dnsTargetStatus": "pending", "dnsObservedValue": "abc123.cname.smoxy.eu", "dnsLastCheckedAt": "2026-07-01T12:34:56+00:00", "domain": "https://example.com/"
{
}