jeremib/pdns-php-api

RESTful PHP API server for PowerDNS

# Pdns-PhpApi

PHP RESTful API for PowerDNS, _(*1)

Usage

The following shows how to call the API. Pdns-PhpApi adheres to the RESTful practice of ustilizing POST, PUT, DELETE and GET., _(*2)

The default username/password is admin/foo., _(*3)

Domain Actions

The following calls are for adding/editing/deleting domain information. Primary key is the domain name., _(*4)

List Domains

Returns all the domains, but does not include their records., _(*5)

GET /domain/ HTTP/1.1, _(*6)

Get Domain Info

Returns all the domain information for the specified domain, including records associated with that domain., _(*7)

GET /domain/<domain.com> HTTP/1.1, _(*8)

Create Domain Record

Creates a domain record, _(*9)

POST /domain HTTP/1.1, _(*10)

Parameters - domain : domain name of the new record [Required] - type : type of the new record, either MASTER or SLAVE [Optional] [Default MASTER] - master : master record if type is SLAVE [Optional] [Default null], _(*11)

Update Domain Record

Updates a domain record, _(*12)

POST /domain HTTP/1.1, _(*13)

Parameters - domain : domain name of the new record [Optional] [Default null] - type : type of the new record, either MASTER or SLAVE [Optional] [Default MASTER] - master : master record if type is SLAVE [Optional] [Default null], _(*14)

Delete Domain Info

Deletes the specified domain and all associated records, _(*15)

DELETE /domain/<domain.com> HTTP/1.1, _(*16)

Record Actions

The following calls are for add/editing/deleting/listing records for the domain. Primary key is the record id., _(*17)

Get Record Info

Returns the record information for the specified name, for example ns1.mydomain.com. Key can also be the id of the record you want information for., _(*18)

GET /record/<key> HTTP/1.1, _(*19)

Get Record Info For Domain and Type

Returns the record information for the specified domain and type. For example to list all NS records for a domain, _(*20)

GET /record/<domain>/<type> HTTP/1.1, _(*21)

Create Record

Creates a record for a domain, _(*22)

POST /record HTTP/1.1, _(*23)

Parameters - domain : domain name for the record [Required] - name : name of the record [Required] - type : type of the record [Required] - content : content of the record [Required] - ttl : time to live [Optional] [Default 3600] - prio : priority of the record [Optional], _(*24)

Update Record

Updates a record for the id specified., _(*25)

PUT /record/<id> HTTP/1.1, _(*26)

Parameters - name : name of the record [Required] - type : type of the record [Required] - content : content of the record [Required] - ttl : time to live [Optional] [Default 3600] - prio : priority of the record [Optional], _(*27)

Delete Info

Deletes the specified record, _(*28)

DELETE /record/<id> HTTP/1.1, _(*29)