class Pdns::API::Endpoints::Cryptokeys

Defined in:

pdns/api/endpoints/cryptokeys.cr

Instance Method Summary

Constructor methods inherited from class Pdns::API::Endpoint

new(api : API, base_path : String) new

Instance Method Detail

def activate(id : Int32) : Void #

This method activates a key from zone_name specified by cryptokey_id


[View source]
def create(cryptokey : Cryptokey) : Cryptokey #

Creates a Cryptokey

This method adds a new key to a zone. The key can either be generated or imported by supplying the private_key parameter of the given Cryptokey.

if private_key, bits and algorithm aren't set, a key will be generated based on the default-ksk-algorithm and default-ksk-size settings for a "ksk" key_type and the default-zsk-algorithm and default-zsk-size options for a "zsk" key_type.


[View source]
def deactivate(id : Int32) : Void #

This method deactivates a key from zone_name specified by cryptokey_id


[View source]
def delete(id : Int32) : Void #

This method deletes a key specified by cryptokey_id.


[View source]
def get(id : Int32) : Cryptokey #

Returns all data about the CryptoKey, including the privatekey.


[View source]
def list : Array(Cryptokey) #

Get all CryptoKeys for a zone, except the privatekey


[View source]