class Pdns::API::Endpoints::Zones
- Pdns::API::Endpoints::Zones
- Pdns::API::Endpoint
- Reference
- Object
Defined in:
pdns/api/endpoints/zones.crInstance Method Summary
-
#axfr_retrieve(id : String) : Void
Retrieve slave zone from its master.
-
#create(zone : Zone, *, rrsets : Bool? = nil) : Zone
Creates a new domain
-
#delete(id : String) : Void
Deletes this zone, all attached metadata and rrsets.
-
#edit_metadata(id : String, &block : Zone -> ) : Void
Modifies basic zone data (metadata).
-
#edit_rrsets(id : String, &block : Array(RRSet) -> ) : Void
Creates/modifies/deletes
RRSet
s -
#export(id : String) : String
Returns the zone in AXFR format.
-
#get(id : String) : Zone
Get a zone managed by a server
-
#list : Array(Zone)
List all Zones in a server
-
#notify(id : String) : Void
Send a DNS NOTIFY to all slaves.
-
#rectify(id : String) : Void
Rectify the zone data.
- #with(id : String, &block : Scoped -> T) : T forall T
Constructor methods inherited from class Pdns::API::Endpoint
new(api : API, base_path : String)
new
Instance Method Detail
Retrieve slave zone from its master.
Fails when zone kind is not Slave, or slave is disabled in the configuration.
Creates a new domain
rrsets - set to false
to exclude rrsets from the response
Modifies basic zone data (metadata).
NOTE Switching dnssec to true
(from false
) sets up DNSSEC
signing based on the other flags, this includes running the equivalent
of secure-zone
and rectify-zone
(if api_rectify is set to
true
). This also applies to newly created zones. If presigned is
true, no DNSSEC changes will be made to the zone or cryptokeys.
Send a DNS NOTIFY to all slaves.
Fails when zone kind is not Master or Slave, or master and slave are disabled in the configuration. Only works for Slave if renotify is on.
Rectify the zone data.
This does not take into account the API-RECTIFY metadata. Fails on slave zones and zones that do not have DNSSEC.