Skip to content

Update a redirect

PATCH
/api/organizations/{organizationId}/redirects/{id}

Updates the target hostname and/or mode of a redirect (the source hostname is fixed at creation time and is not writable here). Changing the target or mode updates the live redirect configuration accordingly.

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
string
Required
id*

redirect identifier

Type
string
Required

Request Body

application/merge-patch+json
JSON
{
  
"targetHostname": "www.example.com",
  
"mode": "path"
}

Responses

redirect resource updated

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/"
}

Playground

Authorization
Variables
Key
Value
Body

Samples

Powered by VitePress OpenAPI