API docs by Redocly

Bindizr HTTP API (0.1.0-beta.5)

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

query Parameters
name
string

Filter by zone name.

id
integer <int32>

Filter by zone ID.

primary_ns
string

Filter by primary name server.

admin_email
string

Filter by admin email.

ttl
integer <int32>

Filter by TTL.

min_ttl
integer <int32>

Filter by minimum TTL.

max_ttl
integer <int32>

Filter by maximum TTL.

serial
integer <int32>

Filter by serial.

search
string

Partially search zones.

limit
integer <int32>

Maximum number of zones to return.

offset
integer <int64>

Number of zones to skip.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    }
}

Create a new DNS zone

Request Body schema: application/json
required
admin_email
required
string
expire
integer or null <int32>
minimum_ttl
integer or null <int32>
name
required
string
primary_ns
required
string
refresh
integer or null <int32>
retry
integer or null <int32>
serial
integer or null <int32>
ttl
required
integer <int32>

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "zone": {
    }
}

Get a specific DNS zone

path Parameters
name
required
string

The name of the DNS zone to retrieve.

query Parameters
records
boolean

Whether to include records for the DNS zone.

Responses

Response samples

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

Update a specific DNS zone

path Parameters
name
required
string

The name of the DNS zone to update.

Request Body schema: application/json
required
admin_email
required
string
expire
integer or null <int32>
minimum_ttl
integer or null <int32>
name
required
string
primary_ns
required
string
refresh
integer or null <int32>
retry
integer or null <int32>
serial
integer or null <int32>
ttl
required
integer <int32>

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "zone": {
    }
}

Delete a specific DNS zone

path Parameters
name
required
string

The name of the DNS zone to delete.

Responses

Response samples

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

Record

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

List all DNS records

query Parameters
zone_name
string

The name of the DNS zone to filter records by.

name
string

Filter by record name.

record_type
string

Filter by record type.

value
string

Partially filter by record value.

ttl
integer <int32>

Filter by TTL.

min_ttl
integer <int32>

Filter by minimum TTL.

max_ttl
integer <int32>

Filter by maximum TTL.

priority
integer <int32>

Filter by priority.

min_priority
integer <int32>

Filter by minimum priority.

max_priority
integer <int32>

Filter by maximum priority.

search
string

Partially search records.

limit
integer <int32>

Maximum number of records to return.

offset
integer <int64>

Number of records to skip.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    }
}

Create a new DNS record

Request Body schema: application/json
required
name
required
string
priority
integer or null <int32>
record_type
required
string
ttl
integer or null <int32>
required
string or Array of strings (RecordValueRequest)
zone_name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "sub",
  • "priority": 10,
  • "record_type": "A",
  • "ttl": 3600,
  • "value": "192.168.1.100",
  • "zone_name": "example.com"
}

Response samples

Content type
application/json
{
  • "record": {
    }
}

Get a specific DNS record

path Parameters
record_id
required
integer <int32>

The ID of the DNS record to retrieve.

Responses

Response samples

Content type
application/json
{
  • "record": {
    }
}

Update a specific DNS record

path Parameters
record_id
required
integer <int32>

The ID of the DNS record to update.

Request Body schema: application/json
required
name
required
string
priority
integer or null <int32>
record_type
required
string
ttl
integer or null <int32>
required
string or Array of strings (RecordValueRequest)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "record": {
    }
}

Delete a specific DNS record

path Parameters
record_id
required
integer <int32>

The ID of the DNS record to delete.

Responses

Response samples

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

Notify

Send DNS NOTIFY messages to secondary servers.

Send DNS NOTIFY messages for a zone or all zones

Request Body schema: application/json
required
force
boolean
zone_name
string or null

Responses

Request samples

Content type
application/json
{
  • "force": true,
  • "zone_name": "example.com"
}

Response samples

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