API docs by Redocly

Bindizr HTTP API (1.0.0)

Download OpenAPI specification:

E-mail: kevin136583@gmail.com License: Apache 2.0

This is the API documentation for Bindizr

Zone

Manage DNS zones including creation, update, deletion, and retrieval.

List all DNS zones

Retrieves a list of all DNS zones.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "zones": [
    ]
}

Create a new DNS zone

Creates a new DNS zone with the specified details.

Authorizations:
bearerAuth
Request Body schema: application/json
required
Any of
name
required
string
primary_ns
required
string
primary_ns_ip
required
string <ipv4>
primary_ns_ipv6
string <ipv6>
admin_email
required
string <email>
ttl
required
integer <int32>
serial
required
integer <int32>
refresh
integer <int32>
retry
integer <int32>
expire
integer <int32>
minimum_ttl
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "name": "example.com",
  • "primary_ns": "ns1.example.com",
  • "primary_ns_ip": "127.0.0.1",
  • "primary_ns_ipv6": "::1",
  • "admin_email": "admin@example.com",
  • "ttl": 3600,
  • "serial": 2025100101,
  • "refresh": 7200,
  • "retry": 3600,
  • "expire": 604800,
  • "minimum_ttl": 3600
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "example.com",
  • "primary_ns": "ns1.example.com",
  • "primary_ns_ip": "127.0.0.1",
  • "primary_ns_ipv6": "::1",
  • "admin_email": "admin@example.com",
  • "ttl": 3600,
  • "serial": 2025100101,
  • "refresh": 7200,
  • "retry": 3600,
  • "expire": 604800,
  • "minimum_ttl": 3600
}

Get a specific DNS zone

Retrieves details of a specific DNS zone by its ID.

Authorizations:
bearerAuth
path Parameters
zone_id
required
integer <int32>

The ID of the DNS zone to retrieve.

query Parameters
records
boolean
Default: false

Whether to include the history of the DNS zone.

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "example.com",
  • "primary_ns": "ns1.example.com",
  • "primary_ns_ip": "127.0.0.1",
  • "primary_ns_ipv6": "::1",
  • "admin_email": "admin@example.com",
  • "ttl": 3600,
  • "serial": 2025100101,
  • "refresh": 7200,
  • "retry": 3600,
  • "expire": 604800,
  • "minimum_ttl": 3600
}

Update a specific DNS zone

Updates the details of a specific DNS zone.

Authorizations:
bearerAuth
path Parameters
zone_id
required
integer <int32>

The ID of the DNS zone to update.

Request Body schema: application/json
required
Any of
name
required
string
primary_ns
required
string
primary_ns_ip
required
string <ipv4>
primary_ns_ipv6
string <ipv6>
admin_email
required
string <email>
ttl
required
integer <int32>
serial
required
integer <int32>
refresh
integer <int32>
retry
integer <int32>
expire
integer <int32>
minimum_ttl
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "name": "example.com",
  • "primary_ns": "ns1.example.com",
  • "primary_ns_ip": "127.0.0.1",
  • "primary_ns_ipv6": "::1",
  • "admin_email": "admin@example.com",
  • "ttl": 3600,
  • "serial": 2025100101,
  • "refresh": 7200,
  • "retry": 3600,
  • "expire": 604800,
  • "minimum_ttl": 3600
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "example.com",
  • "primary_ns": "ns1.example.com",
  • "primary_ns_ip": "127.0.0.1",
  • "primary_ns_ipv6": "::1",
  • "admin_email": "admin@example.com",
  • "ttl": 3600,
  • "serial": 2025100101,
  • "refresh": 7200,
  • "retry": 3600,
  • "expire": 604800,
  • "minimum_ttl": 3600
}

Delete a specific DNS zone

Deletes a specific DNS zone by its ID.

Authorizations:
bearerAuth
path Parameters
zone_id
required
integer <int32>

The ID of the DNS zone to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "Zone deleted successfully"
}

Get rendered DNS zone file

Retrieves the rendered content of a specific DNS zone file.

Authorizations:
bearerAuth
path Parameters
zone_id
required
integer <int32>

The ID of the DNS zone to retrieve.

Responses

Response samples

Content type
application/json
{
  • "error": "No authorization header"
}

Zone History

Manage DNS zone history including creation, update, deletion, and retrieval.

List history of a specific DNS zone

Retrieves the history of changes made to a specific DNS zone.

Authorizations:
bearerAuth
path Parameters
zone_id
required
integer <int32>

The ID of the DNS zone to retrieve history for.

Responses

Response samples

Content type
application/json
{
  • "zone_histories": [
    ]
}

Delete a specific DNS zone history

Deletes a specific history of a DNS zone by its ID.

Authorizations:
bearerAuth
path Parameters
zone_id
required
integer <int32>

The ID of the DNS zone to delete history for.

history_id
required
integer <int32>

The ID of the history to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "Zone history deleted successfully"
}

Record

Manage DNS records including creation, update, deletion, and retrieval.

List all DNS records

Retrieves a list of all DNS records.

Authorizations:
bearerAuth
query Parameters
zone_id
integer <int32>

The ID of the DNS zone to filter records by.

Responses

Response samples

Content type
application/json
{
  • "records": [
    ]
}

Create a new DNS record

Creates a new DNS record with the specified details.

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string
record_type
required
string
Enum: "A" "AAAA" "CNAME" "MX" "TXT" "NS" "SOA" "SRV" "PTR"
value
required
string
ttl
integer <int32>
priority
integer <int32>
zone_id
required
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "name": "sub",
  • "record_type": "A",
  • "value": "127.0.0.1",
  • "ttl": 3600,
  • "priority": 10,
  • "zone_id": 1
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "sub",
  • "record_type": "A",
  • "value": "127.0.0.1",
  • "zone_id": 1
}

Get a specific DNS record

Retrieves details of a specific DNS record by its ID.

Authorizations:
bearerAuth
path Parameters
record_id
required
integer <int32>

The ID of the DNS record to retrieve.

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "sub",
  • "record_type": "A",
  • "value": "127.0.0.1",
  • "zone_id": 1
}

Update a specific DNS record

Updates the details of a specific DNS record.

Authorizations:
bearerAuth
path Parameters
record_id
required
integer <int32>

The ID of the DNS record to update.

Request Body schema: application/json
required
name
required
string
record_type
required
string
Enum: "A" "AAAA" "CNAME" "MX" "TXT" "NS" "SOA" "SRV" "PTR"
value
required
string
ttl
integer <int32>
priority
integer <int32>
zone_id
required
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "name": "sub",
  • "record_type": "A",
  • "value": "127.0.0.1",
  • "ttl": 3600,
  • "priority": 10,
  • "zone_id": 1
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "sub",
  • "record_type": "A",
  • "value": "127.0.0.1",
  • "zone_id": 1
}

Delete a specific DNS record

Deletes a specific DNS record by its ID.

Authorizations:
bearerAuth
path Parameters
record_id
required
integer <int32>

The ID of the DNS record to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "Record deleted successfully"
}

Record History

Manage DNS record history including creation, update, deletion, and retrieval.

List history of a specific DNS record

Retrieves the history of changes made to a specific DNS record.

Authorizations:
bearerAuth
path Parameters
record_id
required
integer <int32>

The ID of the DNS record to retrieve history for.

Responses

Response samples

Content type
application/json
{
  • "record_histories": [
    ]
}

Delete a specific DNS record history

Deletes a specific history of a DNS record by its ID.

Authorizations:
bearerAuth
path Parameters
record_id
required
integer <int32>

The ID of the DNS record to delete history for.

history_id
required
integer <int32>

The ID of the history to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "Record history deleted successfully"
}

DNS

Manage DNS server operations including status check, reload, and configuration.

Get DNS server status

Retrieves the current status of the DNS server.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": "Bind9 is running"
}

Reload DNS server configuration

Reloads the DNS server configuration to apply any changes.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "message": "DNS server reloaded successfully"
}

Write DNS server configuration

Writes the DNS server configuration

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "msg": "DNS configuration written successfully"
}