bindcar 0.6.0

HTTP REST API for managing BIND9 zones via rndc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

# Zone Operations

Overview of zone management operations available through the bindcar API.

## Available Operations

### Zone Lifecycle

1. **Create Zone** - Create a new DNS zone
2. **List Zones** - Get all zones
3. **Get Zone** - Get specific zone information
4. **Modify Zone** - Update zone configuration (also-notify, allow-transfer)
5. **Delete Zone** - Remove a zone
6. **Reload Zone** - Reload zone from file
7. **Zone Status** - Get zone status from BIND9

### Zone Management

8. **Freeze Zone** - Disable dynamic updates
9. **Thaw Zone** - Enable dynamic updates
10. **Notify Secondaries** - Trigger zone transfer notifications
11. **Retransfer Zone** - Force zone retransfer from primary

## Quick Reference

| Operation | Method | Endpoint | Auth Required |
|-----------|--------|----------|---------------|
| Create Zone | POST | `/api/v1/zones` | Yes |
| List Zones | GET | `/api/v1/zones` | Yes |
| Get Zone | GET | `/api/v1/zones/{name}` | Yes |
| Modify Zone | PATCH | `/api/v1/zones/{name}` | Yes |
| Delete Zone | DELETE | `/api/v1/zones/{name}` | Yes |
| Reload Zone | POST | `/api/v1/zones/{name}/reload` | Yes |
| Zone Status | GET | `/api/v1/zones/{name}/status` | Yes |
| Freeze Zone | POST | `/api/v1/zones/{name}/freeze` | Yes |
| Thaw Zone | POST | `/api/v1/zones/{name}/thaw` | Yes |
| Notify Secondaries | POST | `/api/v1/zones/{name}/notify` | Yes |
| Retransfer Zone | POST | `/api/v1/zones/{name}/retransfer` | Yes |

## Common Workflows

### Creating a New Zone

```bash
# 1. Create zone with configuration
curl -X POST http://localhost:8080/api/v1/zones \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "zoneName": "example.com",
    "zoneType": "primary",
    "zoneConfig": {
      "ttl": 3600,
      "soa": {
        "primaryNs": "ns1.example.com.",
        "adminEmail": "admin.example.com.",
        "serial": 1,
        "refresh": 3600,
        "retry": 1800,
        "expire": 604800,
        "negativeTtl": 86400
      },
      "nameservers": ["ns1.example.com.", "ns2.example.com."],
      "records": []
    }
  }'

# 2. Verify zone was created
curl http://localhost:8080/api/v1/zones/example.com \
  -H "Authorization: Bearer $TOKEN"
```

### Modifying Zone Configuration

```bash
# 1. Update zone transfer settings (also-notify, allow-transfer)
curl -X PATCH http://localhost:8080/api/v1/zones/example.com \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "alsoNotify": ["10.244.2.101", "10.244.2.102"],
    "allowTransfer": ["10.244.2.101", "10.244.2.102"]
  }'

# 2. Verify changes were applied
curl http://localhost:8080/api/v1/zones/example.com/status \
  -H "Authorization: Bearer $TOKEN"
```

### Updating Zone Records

```bash
# 1. Modify zone file directly on filesystem
#    (bindcar and BIND9 share the same volume)

# 2. Reload the zone in BIND9
curl -X POST http://localhost:8080/api/v1/zones/example.com/reload \
  -H "Authorization: Bearer $TOKEN"

# 3. Verify changes were applied
curl http://localhost:8080/api/v1/zones/example.com/status \
  -H "Authorization: Bearer $TOKEN"
```

### Deleting a Zone

```bash
# 1. Check zone exists
curl http://localhost:8080/api/v1/zones \
  -H "Authorization: Bearer $TOKEN"

# 2. Delete the zone
curl -X DELETE http://localhost:8080/api/v1/zones/example.com \
  -H "Authorization: Bearer $TOKEN"

# 3. Verify deletion
curl http://localhost:8080/api/v1/zones \
  -H "Authorization: Bearer $TOKEN"
```

## Next Steps

- [Creating Zones](./creating-zones.md) - Detailed zone creation guide
- [Managing Zones](./zones.md) - Zone management operations
- [API Reference](../reference/api-zones.md) - Complete zone endpoint reference