## GET /api/v2/domains/{id}/redirects

**List domain redirects**

Return URL redirect rules for one domain plus the per-domain rule limit and create gate. Get `{id}` from `GET /api/v2/domains` `data[].id`. Redirects are not DNS records: create, update, and delete them through the redirect routes, not by writing A/AAAA/CNAME records directly. The API prepares the DNS anchor records a redirect needs; deleting or replacing those records can make existing redirects stop working. Use `include=orphans` only when repairing active redirect/proxy rules with no saved redirect row. Redirects can be saved before DNS is fully ready; a rule may show `status: "pending_dns"` until nameservers/DNS are correct.

### Related Endpoints

- `POST /api/v2/domains/{id}/redirects`: Create domain redirect
- `PATCH /api/v2/domains/{id}/redirects/{ruleId}`: Update domain redirect
- `DELETE /api/v2/domains/{id}/redirects/{ruleId}`: Delete domain redirect

### Headers

- `Accept`: application/json
- `Authorization`: Bearer YOUR_API_KEY
- Required API scope: `read:domains`

### Parameters

- `id` (path, string, required): Public domain ID from `GET /api/v2/domains` `data[].id`. Do not invent this value; use the exact ID returned by the referenced API response. Example: `dom_01hxa3b4c5d6e7f8g9h0j1k2m3`
- `include` (query, string): Optional repair view that includes upstream proxy rules not represented by saved redirect rows. Example: `orphans`
  Allowed values: orphans

### Request Example

```bash
curl -X GET "https://cloud.hostup.se/api/v2/domains/dom_01hxa3b4c5d6e7f8g9h0j1k2m3/redirects" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
```

### Response Schema

- `domainId` (string, optional) Example: `dom_01hxa3b4c5d6e7f8g9h0j1k2m3`
- `rules` (array<object>, optional)
- `rules[].id` (string, required) Example: `redir_01hxa3b4c5d6e7f8g9h0j1k2m3`
- `rules[].domainId` (string, required) Example: `dom_01hxa3b4c5d6e7f8g9h0j1k2m3`
- `rules[].sourceHost` (string, required) Example: `www.example.com`
- `rules[].sourcePath` (string,null, required) Example: `null`
- `rules[].sourceUrl` (string, required) Example: `https://www.example.com`
- `rules[].targetUrl` (string, required) Example: `https://example.com`
- `rules[].httpStatusCode` (integer, required) Example: `301`
  Allowed values: 301, 302, 307, 308
- `rules[].scope` (string, required) Example: `root_www`
  Allowed values: exact, root_www, subdomains, all
- `rules[].preservePath` (boolean, required) Example: `false`
- `rules[].preserveQuery` (boolean, required) Example: `false`
- `rules[].includeSubdomains` (boolean, required) Example: `false`
- `rules[].status` (string, required) Example: `active`
  Allowed values: active, pending_dns, error, disabled
- `rules[].reason` (string,null, required) Example: `null`
- `rules[].description` (string,null, required) Example: `Redirect www to apex`
- `rules[].createdAt` (string,null, required) Example: `2026-04-27T12:00:00.000Z`
- `rules[].updatedAt` (string,null, required) Example: `2026-04-27T12:00:00.000Z`
- `limitPerDomain` (integer, optional) Example: `10`
- `redirectCount` (integer, optional) Example: `1`
- `actions` (object, optional)
- `actions.canCreateNewRule` (object, required)
- `actions.canCreateNewRule.allowed` (boolean, required) Example: `true`
- `actions.canCreateNewRule.reason` (string,null, required) Example: `null`
- `actions.canCreateNewRule.code` (string,null, optional): Machine-readable reason code when an action is blocked. Example: `pending_order`
- `orphanedProxyRules` (array<object>, optional): Only present when `include=orphans` is sent.

### Responses

#### 200 - Redirect rules and create gate.
```json
{
  "domainId": "dom_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "rules": [
    {
      "id": "redir_01hxa3b4c5d6e7f8g9h0j1k2m3",
      "domainId": "dom_01hxa3b4c5d6e7f8g9h0j1k2m3",
      "sourceHost": "www.example.com",
      "sourcePath": null,
      "sourceUrl": "https://www.example.com",
      "targetUrl": "https://example.com",
      "httpStatusCode": 301,
      "scope": "root_www",
      "preservePath": false,
      "preserveQuery": false,
      "includeSubdomains": false,
      "status": "active",
      "reason": null,
      "description": "Redirect www to apex",
      "createdAt": "2026-04-27T12:00:00.000Z",
      "updatedAt": "2026-04-27T12:00:00.000Z"
    }
  ],
  "limitPerDomain": 10,
  "redirectCount": 1,
  "actions": {
    "canCreateNewRule": {
      "allowed": true,
      "reason": null
    }
  }
}
```

#### 400 - Invalid request. The response body is an RFC 7807 Problem Details document.
```json
{
  "type": "https://developer.hostup.se/errors/invalid_request",
  "title": "Invalid request",
  "status": 400,
  "detail": "The request body failed validation.",
  "code": "invalid_request",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z",
  "errors": [
    {
      "pointer": "/items/0/domainName",
      "detail": "`domainName` is required.",
      "code": "invalid_request"
    }
  ]
}
```

#### 401 - Unauthorized. Authentication is required.
```json
{
  "type": "https://developer.hostup.se/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication is required.",
  "code": "unauthorized",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 403 - Forbidden. The caller lacks a required scope or does not own the resource.
```json
{
  "type": "https://developer.hostup.se/errors/forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "The caller lacks a required scope or does not own the resource.",
  "code": "forbidden",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 404 - Not found. The resource does not exist or is not owned by the caller.
```json
{
  "type": "https://developer.hostup.se/errors/not_found",
  "title": "Not found",
  "status": 404,
  "detail": "The requested resource could not be found.",
  "code": "not_found",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 429 - Rate limited. Retry after the limit resets. 429 responses include `Retry-After` seconds plus `X-RateLimit-*` headers.
```json
{
  "type": "https://developer.hostup.se/errors/rate_limit_exceeded",
  "title": "Too many requests",
  "status": 429,
  "detail": "Too many requests. Retry after the limit resets.",
  "code": "rate_limit_exceeded",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 500 - Internal error. Retry later or contact support if the issue persists.
```json
{
  "type": "https://developer.hostup.se/errors/internal_error",
  "title": "Internal server error",
  "status": 500,
  "detail": "An unexpected error occurred. Retry later or contact support if the issue persists.",
  "code": "internal_error",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```