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
name
required
string
primary_ns
required
string
admin_email
required
string <email>
ttl
required
integer <int32>
serial
integer <int32>

Optional. Auto-generated in YYYYMMDDNN format if not provided

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",
  • "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",
  • "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 name.

Authorizations:
bearerAuth
path Parameters
zone_name
required
string

The name 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",
  • "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_name
required
string

The name of the DNS zone to update.

Request Body schema: application/json
required
name
required
string
primary_ns
required
string
admin_email
required
string <email>
ttl
required
integer <int32>
serial
integer <int32>

Optional. Auto-generated in YYYYMMDDNN format if not provided

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",
  • "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",
  • "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 name.

Authorizations:
bearerAuth
path Parameters
zone_name
required
string

The name of the DNS zone to delete.

Responses

Response samples

Content type
application/json
{
  • "message": "Zone 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_name
string
Example: zone_name=example.com

The name 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

The name of the DNS record

record_type
required
string
Enum: "A" "AAAA" "CNAME" "MX" "TXT" "NS" "SOA" "SRV" "PTR"

The type of the DNS record

value
required
string

The value of the DNS record

ttl
integer <int32>

Time to live in seconds (optional)

priority
integer <int32>

Priority for MX and SRV records (optional)

zone_name
required
string

The name of the zone this record belongs to

Responses

Request samples

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

Response samples

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

Get a specific DNS record

Retrieves details of a specific DNS record by its name and type.

Authorizations:
bearerAuth
path Parameters
record_name
required
string

The name of the DNS record to retrieve.

record_type
required
string

The type 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",
  • "ttl": 3600,
  • "priority": 10,
  • "zone_id": 1,
  • "zone_name": "example.com"
}

Update a specific DNS record

Updates the details of a specific DNS record.

Authorizations:
bearerAuth
path Parameters
record_name
required
string

The name of the DNS record to update.

record_type
required
string

The type of the DNS record to update.

Request Body schema: application/json
required
name
required
string

The name of the DNS record

record_type
required
string
Enum: "A" "AAAA" "CNAME" "MX" "TXT" "NS" "SOA" "SRV" "PTR"

The type of the DNS record

value
required
string

The value of the DNS record

ttl
integer <int32>

Time to live in seconds (optional)

priority
integer <int32>

Priority for MX and SRV records (optional)

zone_name
required
string

The name of the zone this record belongs to

Responses

Request samples

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

Response samples

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

Delete a specific DNS record

Deletes a specific DNS record by its name and type.

Authorizations:
bearerAuth
path Parameters
record_name
required
string

The name of the DNS record to delete.

record_type
required
string

The type of the DNS record to delete.

Responses

Response samples

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