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

# Quick Start

Get bindcar up and running in minutes with this quick start guide.

## Using Docker

The fastest way to try bindcar:

```bash
# Pull the latest image
docker pull ghcr.io/firestoned/bindcar:latest

# Run bindcar
docker run -d \
  --name bindcar \
  -p 8080:8080 \
  -v /var/cache/bind:/var/cache/bind \
  -e RUST_LOG=info \
  ghcr.io/firestoned/bindcar:latest
```

## Verify It's Running

Check the health endpoint:

```bash
curl http://localhost:8080/api/v1/health
```

Expected response:
```json
{"healthy":true}
```

## Create Your First Zone

```bash
curl -X POST http://localhost:8080/api/v1/zones \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer your-token-here" \
  -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": [
        {
          "name": "@",
          "type": "A",
          "value": "192.0.2.1",
          "ttl": 3600
        }
      ]
    }
  }'
```

## List Zones

```bash
curl http://localhost:8080/api/v1/zones \
  -H "Authorization: Bearer your-token-here"
```

## Get Zone Status

```bash
curl http://localhost:8080/api/v1/zones/example.com/status \
  -H "Authorization: Bearer your-token-here"
```

## Interactive API Documentation

bindcar provides interactive Swagger UI documentation:

```bash
open http://localhost:8080/api/v1/docs
```

## Next Steps

- [Configuration](../operations/configuration.md) - Configure environment variables
- [Authentication](../operations/authentication.md) - Set up authentication
- [Creating Zones](../user-guide/creating-zones.md) - Learn more about zone creation
- [API Reference](../reference/api.md) - Complete API documentation