Web forwards

Web forwards redirect visitors of your domain to another target URL.

Get all DNS web forwards

You retrieve a list of all configured web redirects for a specific DNS zone. This endpoint provides details about the established redirects, including the internal IDs required for later updates or deletions.

URL: GET /api/v1/organizations/{organizationId}/dns-zones/{dnsZoneId}/web-forwards

Example Response (200 OK):

[
  {
    "dnsWebForwardId": "1197eb24-059e-4252-9b22-eae96645435f",
    "source": "@",
    "sourcePath": "/altes-verzeichnis",
    "target": "https://stackit.de/neu",
    "via": "permanent",
    "keepPath": false
  },
  {
    "dnsWebForwardId": "2298fb35-060f-5363-ac33-fbf07756546g",
    "source": "blog",
    "target": "https://mein-blog-extern.de",
    "via": "frame",
    "keepPath": false
  }
]

Add DNS web forward

You create a new web redirect for a specific zone. The service supports permanent redirects (301) and frame redirects (masking).

URL: POST /api/v1/organizations/{organizationId}/dns-zones/{dnsZoneId}/web-forwards

Request Body:

{
  "source": "shop",
  "target": "https://mein-externer-shop.de/produkte",
  "via": "permanent",
  "keepPath": true
}

Update DNS web forward

You update an existing redirect, for example to set a new target.

URL: PATCH /api/v1/organizations/{organizationId}/dns-zones/{dnsZoneId}/web-forwards/{dnsWebForwardId}

Delete DNS web forward

You remove a specific web redirect permanently from a DNS zone. This call deletes the redirect and automatically cleans up the associated system-managed DNS records (provider locks).

URL: DELETE /api/v1/organizations/{organizationId}/dns-zones/{dnsZoneId}/web-forwards/{dnsWebForwardId}

Response (Deleted successfully):

204 No Content