PowerDNS.Client

All the endpoints provide only a very slim wrapper around the PowerDNS API preserving its idiosyncracies.

Authentication

applyXApiKey

Arguments

:: Text

API key

-> ClientEnv

-> ClientEnv

Causes all requests with this ClientEnv to be sent with the specified key embedded in a X-API-Key header.

Zones

See documentation at PowerDNS Zones API

Because the required fields of a Zone differs between various requests and responses, every field is wrapped with Maybe. It is the users responsibility to check with the PowerDNS API to know when a field must be specified. For convenience empty can be used to generate a value of Zone with all fields set to Nothing.

   let zone = empty { zone_name = Just "some.domain."
                    , zone_kind = Just Native
                    , zone_type = Just "zone" }

   in createZone "localhost" -- Server ID
                 Nothing     -- Show RRsets in response
                 zone        -- The zone we are creating

listZones

Arguments

:: Text

Server name

-> Maybe Text

Limit to zone

-> Maybe Bool

Whether or not to include dnssec and edited_serial fields

-> ClientM [Zone]

List all zones for the server. See Zones API Documentation

createZone

Arguments

:: Text

Server name

-> Maybe Bool

Whether or not to include RRsets in the response

-> Zone

The zone to create

-> ClientM Zone

Create a new zone. See Zones API Documentation

empty with record update syntax is useful avoid having to specify Nothing for unwanted fields.

getZone

Arguments

:: Text

Server name

-> Text

Zone ID

-> Maybe Bool

Wheher or not to include RRsets in the response

-> ClientM Zone

Get details for zone. See Zones API Documentation

deleteZone

Arguments

:: Text

Server name

-> Text

Zone ID

-> ClientM NoContent

Delete a given zone by id. See Zones API Documentation

updateRecords

Arguments

:: Text

Server name

-> Text

Zone ID

-> RRSets

The RRsets to create, update or delete.

-> ClientM NoContent

Update records of a zone. See Zones API Documentation

Caution: If rrset_records or rrset_comments is set to Just [] on a Delete changetype, this will delete all existing records or comments respectively for the domain.

updateZone

Arguments

:: Text

Server name

-> Text

Zone ID

-> Zone

Patch record. Fields with Just are changed, Nothing are ignored

-> ClientM NoContent

Modify zone. See Zones API Documentation

empty with record update syntax is useful avoid having to specify Nothing for unwanted fields.

triggerAxfr

Arguments

:: Text

Server name

-> Text

Zone ID

-> ClientM NoContent

Trigger zone transfer on a slave. See Zones API Documentation

notifySlaves

Arguments

:: Text

Server name

-> Text

Zone ID

-> ClientM NoContent

Send DNS notify to slaves. See Zones API Documentation

getZoneAxfr

Arguments

:: Text

Server name

-> Text

Zone ID

-> ClientM Text

Zone in AXFR format

Return zone in AXFR format. See Zones API Documentation

rectifyZone

Arguments

:: Text

Server name

-> Text

Zone ID

-> ClientM Text

Rectify the zone data. See Zones API Documentation

Data types

data Zone

Zone according to PowerDNS Documentation. All fields are optional because the PowerDNS API differs on which fields are required depending on the endpoint.

Constructors

Zone

Fields

• zone_id :: Maybe Text
• zone_name :: Maybe Text
• zone_type :: Maybe Text
• zone_url :: Maybe Text
• zone_kind :: Maybe Kind
• zone_rrsets :: Maybe [RRSet]
• zone_serial :: Maybe Integer
• zone_notified_serial :: Maybe Integer
• zone_edited_serial :: Maybe Integer
• zone_masters :: Maybe [Text]
• zone_dnssec :: Maybe Bool
• zone_nsec3param :: Maybe Text
• zone_nsec3narrow :: Maybe Bool
• zone_presigned :: Maybe Bool
• zone_soa_edit :: Maybe Text
• zone_soa_edit_api :: Maybe Text
• zone_api_rectify :: Maybe Bool
• zone_zone :: Maybe Text
• zone_account :: Maybe Text
• zone_nameservers :: Maybe [Text]
• zone_master_tsig_key_ids :: Maybe [Text]
• zone_slave_tsig_key_ids :: Maybe [Text]

Instances

Eq Zone

Defined in PowerDNS.API.Zones

Methods

(==) :: Zone -> Zone -> Bool

(/=) :: Zone -> Zone -> Bool

Data Zone

Defined in PowerDNS.API.Zones

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Zone -> c Zone

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Zone

toConstr :: Zone -> Constr

dataTypeOf :: Zone -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Zone)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Zone)

gmapT :: (forall b. Data b => b -> b) -> Zone -> Zone

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Zone -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Zone -> r

gmapQ :: (forall d. Data d => d -> u) -> Zone -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Zone -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Zone -> m Zone

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Zone -> m Zone

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Zone -> m Zone

Ord Zone

Defined in PowerDNS.API.Zones

Methods

compare :: Zone -> Zone -> Ordering

(<) :: Zone -> Zone -> Bool

(<=) :: Zone -> Zone -> Bool

(>) :: Zone -> Zone -> Bool

(>=) :: Zone -> Zone -> Bool

max :: Zone -> Zone -> Zone

min :: Zone -> Zone -> Zone

Show Zone

Defined in PowerDNS.API.Zones

Methods

showsPrec :: Int -> Zone -> ShowS

show :: Zone -> String

showList :: [Zone] -> ShowS

Generic Zone

Defined in PowerDNS.API.Zones

Associated Types

type Rep Zone :: Type -> Type

Methods

from :: Zone -> Rep Zone x

to :: Rep Zone x -> Zone

ToJSON Zone

Defined in PowerDNS.API.Zones

Methods

toJSON :: Zone -> Value

toEncoding :: Zone -> Encoding

toJSONList :: [Zone] -> Value

toEncodingList :: [Zone] -> Encoding

FromJSON Zone

Defined in PowerDNS.API.Zones

Methods

parseJSON :: Value -> Parser Zone

parseJSONList :: Value -> Parser [Zone]

NFData Zone

Defined in PowerDNS.API.Zones

Methods

rnf :: Zone -> ()

Empty Zone

Defined in PowerDNS.API.Zones

Methods

empty :: Zone

type Rep Zone

Defined in PowerDNS.API.Zones

type Rep Zone = D1 ('MetaData "Zone" "PowerDNS.API.Zones" "powerdns-0.1.1-3L9A3UJCvVEHahQ3GibYwt" 'False) (C1 ('MetaCons "Zone" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "zone_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "zone_name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "zone_type") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "zone_url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "zone_kind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Kind))))) :*: ((S1 ('MetaSel ('Just "zone_rrsets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [RRSet])) :*: (S1 ('MetaSel ('Just "zone_serial") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "zone_notified_serial") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer)))) :*: (S1 ('MetaSel ('Just "zone_edited_serial") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "zone_masters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "zone_dnssec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))) :*: (((S1 ('MetaSel ('Just "zone_nsec3param") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "zone_nsec3narrow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "zone_presigned") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "zone_soa_edit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "zone_soa_edit_api") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "zone_api_rectify") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "zone_zone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "zone_account") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "zone_nameservers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "zone_master_tsig_key_ids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "zone_slave_tsig_key_ids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Text]))))))))

data Kind

Constructors

Native

Master

Slave

Instances

Eq Kind

Defined in PowerDNS.API.Zones

Methods

(==) :: Kind -> Kind -> Bool

(/=) :: Kind -> Kind -> Bool

Data Kind

Defined in PowerDNS.API.Zones

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Kind -> c Kind

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Kind

toConstr :: Kind -> Constr

dataTypeOf :: Kind -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Kind)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Kind)

gmapT :: (forall b. Data b => b -> b) -> Kind -> Kind

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Kind -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Kind -> r

gmapQ :: (forall d. Data d => d -> u) -> Kind -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Kind -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Kind -> m Kind

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Kind -> m Kind

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Kind -> m Kind

Ord Kind

Defined in PowerDNS.API.Zones

Methods

compare :: Kind -> Kind -> Ordering

(<) :: Kind -> Kind -> Bool

(<=) :: Kind -> Kind -> Bool

(>) :: Kind -> Kind -> Bool

(>=) :: Kind -> Kind -> Bool

max :: Kind -> Kind -> Kind

min :: Kind -> Kind -> Kind

Show Kind

Defined in PowerDNS.API.Zones

Methods

showsPrec :: Int -> Kind -> ShowS

show :: Kind -> String

showList :: [Kind] -> ShowS

Generic Kind

Defined in PowerDNS.API.Zones

Associated Types

type Rep Kind :: Type -> Type

Methods

from :: Kind -> Rep Kind x

to :: Rep Kind x -> Kind

ToJSON Kind

Defined in PowerDNS.API.Zones

Methods

toJSON :: Kind -> Value

toEncoding :: Kind -> Encoding

toJSONList :: [Kind] -> Value

toEncodingList :: [Kind] -> Encoding

FromJSON Kind

Defined in PowerDNS.API.Zones

Methods

parseJSON :: Value -> Parser Kind

parseJSONList :: Value -> Parser [Kind]

NFData Kind

Defined in PowerDNS.API.Zones

Methods

rnf :: Kind -> ()

type Rep Kind

Defined in PowerDNS.API.Zones

type Rep Kind = D1 ('MetaData "Kind" "PowerDNS.API.Zones" "powerdns-0.1.1-3L9A3UJCvVEHahQ3GibYwt" 'False) (C1 ('MetaCons "Native" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Master" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Slave" 'PrefixI 'False) (U1 :: Type -> Type)))

data RRSets

A list of RRSets

Constructors

RRSets

Fields

• rrsets :: [RRSet]

Instances

Eq RRSets

Defined in PowerDNS.API.Zones

Methods

(==) :: RRSets -> RRSets -> Bool

(/=) :: RRSets -> RRSets -> Bool

Data RRSets

Defined in PowerDNS.API.Zones

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RRSets -> c RRSets

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RRSets

toConstr :: RRSets -> Constr

dataTypeOf :: RRSets -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RRSets)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RRSets)

gmapT :: (forall b. Data b => b -> b) -> RRSets -> RRSets

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RRSets -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RRSets -> r

gmapQ :: (forall d. Data d => d -> u) -> RRSets -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RRSets -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RRSets -> m RRSets

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RRSets -> m RRSets

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RRSets -> m RRSets

Ord RRSets

Defined in PowerDNS.API.Zones

Methods

compare :: RRSets -> RRSets -> Ordering

(<) :: RRSets -> RRSets -> Bool

(<=) :: RRSets -> RRSets -> Bool

(>) :: RRSets -> RRSets -> Bool

(>=) :: RRSets -> RRSets -> Bool

max :: RRSets -> RRSets -> RRSets

min :: RRSets -> RRSets -> RRSets

Show RRSets

Defined in PowerDNS.API.Zones

Methods

showsPrec :: Int -> RRSets -> ShowS

show :: RRSets -> String

showList :: [RRSets] -> ShowS

Generic RRSets

Defined in PowerDNS.API.Zones

Associated Types

type Rep RRSets :: Type -> Type

Methods

from :: RRSets -> Rep RRSets x

to :: Rep RRSets x -> RRSets

ToJSON RRSets

Defined in PowerDNS.API.Zones

Methods

toJSON :: RRSets -> Value

toEncoding :: RRSets -> Encoding

toJSONList :: [RRSets] -> Value

toEncodingList :: [RRSets] -> Encoding

FromJSON RRSets

Defined in PowerDNS.API.Zones

Methods

parseJSON :: Value -> Parser RRSets

parseJSONList :: Value -> Parser [RRSets]

NFData RRSets

Defined in PowerDNS.API.Zones

Methods

rnf :: RRSets -> ()

type Rep RRSets

Defined in PowerDNS.API.Zones

type Rep RRSets = D1 ('MetaData "RRSets" "PowerDNS.API.Zones" "powerdns-0.1.1-3L9A3UJCvVEHahQ3GibYwt" 'False) (C1 ('MetaCons "RRSets" 'PrefixI 'True) (S1 ('MetaSel ('Just "rrsets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [RRSet])))

data RRSet

RRSet according to PowerDNS Documentation.

Constructors

RRSet

Fields

• rrset_name :: Text
• rrset_type :: RecordType
• rrset_ttl :: Word32
• rrset_changetype :: Maybe ChangeType
• rrset_records :: Maybe [Record]
• rrset_comments :: Maybe [Comment]

Instances

Eq RRSet

Defined in PowerDNS.API.Zones

Methods

(==) :: RRSet -> RRSet -> Bool

(/=) :: RRSet -> RRSet -> Bool

Data RRSet

Defined in PowerDNS.API.Zones

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RRSet -> c RRSet

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RRSet

toConstr :: RRSet -> Constr

dataTypeOf :: RRSet -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RRSet)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RRSet)

gmapT :: (forall b. Data b => b -> b) -> RRSet -> RRSet

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RRSet -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RRSet -> r

gmapQ :: (forall d. Data d => d -> u) -> RRSet -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RRSet -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RRSet -> m RRSet

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RRSet -> m RRSet

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RRSet -> m RRSet

Ord RRSet

Defined in PowerDNS.API.Zones

Methods

compare :: RRSet -> RRSet -> Ordering

(<) :: RRSet -> RRSet -> Bool

(<=) :: RRSet -> RRSet -> Bool

(>) :: RRSet -> RRSet -> Bool

(>=) :: RRSet -> RRSet -> Bool

max :: RRSet -> RRSet -> RRSet

min :: RRSet -> RRSet -> RRSet

Show RRSet

Defined in PowerDNS.API.Zones

Methods

showsPrec :: Int -> RRSet -> ShowS

show :: RRSet -> String

showList :: [RRSet] -> ShowS

Generic RRSet

Defined in PowerDNS.API.Zones

Associated Types

type Rep RRSet :: Type -> Type

Methods

from :: RRSet -> Rep RRSet x

to :: Rep RRSet x -> RRSet

ToJSON RRSet

Defined in PowerDNS.API.Zones

Methods

toJSON :: RRSet -> Value

toEncoding :: RRSet -> Encoding

toJSONList :: [RRSet] -> Value

toEncodingList :: [RRSet] -> Encoding

FromJSON RRSet

Defined in PowerDNS.API.Zones

Methods

parseJSON :: Value -> Parser RRSet

parseJSONList :: Value -> Parser [RRSet]

NFData RRSet

Defined in PowerDNS.API.Zones

Methods

rnf :: RRSet -> ()

type Rep RRSet

Defined in PowerDNS.API.Zones

type Rep RRSet = D1 ('MetaData "RRSet" "PowerDNS.API.Zones" "powerdns-0.1.1-3L9A3UJCvVEHahQ3GibYwt" 'False) (C1 ('MetaCons "RRSet" 'PrefixI 'True) ((S1 ('MetaSel ('Just "rrset_name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "rrset_type") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RecordType) :*: S1 ('MetaSel ('Just "rrset_ttl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32))) :*: (S1 ('MetaSel ('Just "rrset_changetype") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ChangeType)) :*: (S1 ('MetaSel ('Just "rrset_records") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Record])) :*: S1 ('MetaSel ('Just "rrset_comments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Comment]))))))

data Record

Record according to PowerDNS Documentation

Constructors

Record

Fields

• record_content :: Text
• record_disabled :: Bool

Instances

Eq Record

Defined in PowerDNS.API.Zones

Methods

(==) :: Record -> Record -> Bool

(/=) :: Record -> Record -> Bool

Data Record

Defined in PowerDNS.API.Zones

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Record -> c Record

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Record

toConstr :: Record -> Constr

dataTypeOf :: Record -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Record)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Record)

gmapT :: (forall b. Data b => b -> b) -> Record -> Record

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Record -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Record -> r

gmapQ :: (forall d. Data d => d -> u) -> Record -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Record -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Record -> m Record

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Record -> m Record

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Record -> m Record

Ord Record

Defined in PowerDNS.API.Zones

Methods

compare :: Record -> Record -> Ordering

(<) :: Record -> Record -> Bool

(<=) :: Record -> Record -> Bool

(>) :: Record -> Record -> Bool

(>=) :: Record -> Record -> Bool

max :: Record -> Record -> Record

min :: Record -> Record -> Record

Show Record

Defined in PowerDNS.API.Zones

Methods

showsPrec :: Int -> Record -> ShowS

show :: Record -> String

showList :: [Record] -> ShowS

Generic Record

Defined in PowerDNS.API.Zones

Associated Types

type Rep Record :: Type -> Type

Methods

from :: Record -> Rep Record x

to :: Rep Record x -> Record

ToJSON Record

Defined in PowerDNS.API.Zones

Methods

toJSON :: Record -> Value

toEncoding :: Record -> Encoding

toJSONList :: [Record] -> Value

toEncodingList :: [Record] -> Encoding

FromJSON Record

Defined in PowerDNS.API.Zones

Methods

parseJSON :: Value -> Parser Record

parseJSONList :: Value -> Parser [Record]

NFData Record

Defined in PowerDNS.API.Zones

Methods

rnf :: Record -> ()

type Rep Record

Defined in PowerDNS.API.Zones

type Rep Record = D1 ('MetaData "Record" "PowerDNS.API.Zones" "powerdns-0.1.1-3L9A3UJCvVEHahQ3GibYwt" 'False) (C1 ('MetaCons "Record" 'PrefixI 'True) (S1 ('MetaSel ('Just "record_content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "record_disabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))

data Comment

Comment according to PowerDNS Documentation

Constructors

Comment

Fields

• comment_content :: Maybe Text
• comment_account :: Maybe Text
• commant_modified_at :: Maybe POSIXTime

Instances

Eq Comment

Defined in PowerDNS.API.Zones

Methods

(==) :: Comment -> Comment -> Bool

(/=) :: Comment -> Comment -> Bool

Data Comment

Defined in PowerDNS.API.Zones

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Comment -> c Comment

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Comment

toConstr :: Comment -> Constr

dataTypeOf :: Comment -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Comment)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Comment)

gmapT :: (forall b. Data b => b -> b) -> Comment -> Comment

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Comment -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Comment -> r

gmapQ :: (forall d. Data d => d -> u) -> Comment -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Comment -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Comment -> m Comment

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Comment -> m Comment

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Comment -> m Comment

Ord Comment

Defined in PowerDNS.API.Zones

Methods

compare :: Comment -> Comment -> Ordering

(<) :: Comment -> Comment -> Bool

(<=) :: Comment -> Comment -> Bool

(>) :: Comment -> Comment -> Bool

(>=) :: Comment -> Comment -> Bool

max :: Comment -> Comment -> Comment

min :: Comment -> Comment -> Comment

Show Comment

Defined in PowerDNS.API.Zones

Methods

showsPrec :: Int -> Comment -> ShowS

show :: Comment -> String

showList :: [Comment] -> ShowS

Generic Comment

Defined in PowerDNS.API.Zones

Associated Types

type Rep Comment :: Type -> Type

Methods

from :: Comment -> Rep Comment x

to :: Rep Comment x -> Comment

ToJSON Comment

Defined in PowerDNS.API.Zones

Methods

toJSON :: Comment -> Value

toEncoding :: Comment -> Encoding

toJSONList :: [Comment] -> Value

toEncodingList :: [Comment] -> Encoding

FromJSON Comment

Defined in PowerDNS.API.Zones

Methods

parseJSON :: Value -> Parser Comment

parseJSONList :: Value -> Parser [Comment]

NFData Comment

Defined in PowerDNS.API.Zones

Methods

rnf :: Comment -> ()

Empty Comment

Defined in PowerDNS.API.Zones

Methods

empty :: Comment

type Rep Comment

Defined in PowerDNS.API.Zones

type Rep Comment = D1 ('MetaData "Comment" "PowerDNS.API.Zones" "powerdns-0.1.1-3L9A3UJCvVEHahQ3GibYwt" 'False) (C1 ('MetaCons "Comment" 'PrefixI 'True) (S1 ('MetaSel ('Just "comment_content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "comment_account") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "commant_modified_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe POSIXTime)))))

data ChangeType

Whether or not an RRSet replace or delete an existing entry. If the ChangeType is left at Nothing it will create a new domain entry.

Constructors

Replace

Delete

Instances

Eq ChangeType

Defined in PowerDNS.API.Zones

Methods

(==) :: ChangeType -> ChangeType -> Bool

(/=) :: ChangeType -> ChangeType -> Bool

Data ChangeType

Defined in PowerDNS.API.Zones

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ChangeType -> c ChangeType

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ChangeType

toConstr :: ChangeType -> Constr

dataTypeOf :: ChangeType -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ChangeType)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ChangeType)

gmapT :: (forall b. Data b => b -> b) -> ChangeType -> ChangeType

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ChangeType -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ChangeType -> r

gmapQ :: (forall d. Data d => d -> u) -> ChangeType -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ChangeType -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ChangeType -> m ChangeType

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ChangeType -> m ChangeType

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ChangeType -> m ChangeType

Ord ChangeType

Defined in PowerDNS.API.Zones

Methods

compare :: ChangeType -> ChangeType -> Ordering

(<) :: ChangeType -> ChangeType -> Bool

(<=) :: ChangeType -> ChangeType -> Bool

(>) :: ChangeType -> ChangeType -> Bool

(>=) :: ChangeType -> ChangeType -> Bool

max :: ChangeType -> ChangeType -> ChangeType

min :: ChangeType -> ChangeType -> ChangeType

Show ChangeType

Defined in PowerDNS.API.Zones

Methods

showsPrec :: Int -> ChangeType -> ShowS

show :: ChangeType -> String

showList :: [ChangeType] -> ShowS

Generic ChangeType

Defined in PowerDNS.API.Zones

Associated Types

type Rep ChangeType :: Type -> Type

Methods

from :: ChangeType -> Rep ChangeType x

to :: Rep ChangeType x -> ChangeType

ToJSON ChangeType

Defined in PowerDNS.API.Zones

Methods

toJSON :: ChangeType -> Value

toEncoding :: ChangeType -> Encoding

toJSONList :: [ChangeType] -> Value

toEncodingList :: [ChangeType] -> Encoding

FromJSON ChangeType

Defined in PowerDNS.API.Zones

Methods

parseJSON :: Value -> Parser ChangeType

parseJSONList :: Value -> Parser [ChangeType]

NFData ChangeType

Defined in PowerDNS.API.Zones

Methods

rnf :: ChangeType -> ()

type Rep ChangeType

Defined in PowerDNS.API.Zones

type Rep ChangeType = D1 ('MetaData "ChangeType" "PowerDNS.API.Zones" "powerdns-0.1.1-3L9A3UJCvVEHahQ3GibYwt" 'False) (C1 ('MetaCons "Replace" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Delete" 'PrefixI 'False) (U1 :: Type -> Type))

data RecordType

Constructors

A

AAAA

AFSDB

ALIAS

APL

CAA

CERT

CDNSKEY

CDS

CNAME

DNSKEY

DNAME

DS

HINFO

KEY

LOC

MX

NAPTR

NS

NSEC

NSEC3

NSEC3PARAM

OPENPGPKEY

PTR

RP

RRSIG

SOA

SPF

SSHFP

SRV

TKEY

TSIG

TLSA

SMIMEA

TXT

URI

A6

DHCID

DLV

EUI48

EUI64

IPSECKEY

KX

MAILA

MAILB

MINFO

MR

RKEY

SIG

WKS

Instances

Eq RecordType

Defined in PowerDNS.API.Zones

Methods

(==) :: RecordType -> RecordType -> Bool

(/=) :: RecordType -> RecordType -> Bool

Data RecordType

Defined in PowerDNS.API.Zones

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RecordType -> c RecordType

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RecordType

toConstr :: RecordType -> Constr

dataTypeOf :: RecordType -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RecordType)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RecordType)

gmapT :: (forall b. Data b => b -> b) -> RecordType -> RecordType

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RecordType -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RecordType -> r

gmapQ :: (forall d. Data d => d -> u) -> RecordType -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RecordType -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RecordType -> m RecordType

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RecordType -> m RecordType

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RecordType -> m RecordType

Ord RecordType

Defined in PowerDNS.API.Zones

Methods

compare :: RecordType -> RecordType -> Ordering

(<) :: RecordType -> RecordType -> Bool

(<=) :: RecordType -> RecordType -> Bool

(>) :: RecordType -> RecordType -> Bool

(>=) :: RecordType -> RecordType -> Bool

max :: RecordType -> RecordType -> RecordType

min :: RecordType -> RecordType -> RecordType

Show RecordType

Defined in PowerDNS.API.Zones

Methods

showsPrec :: Int -> RecordType -> ShowS

show :: RecordType -> String

showList :: [RecordType] -> ShowS

Generic RecordType

Defined in PowerDNS.API.Zones

Associated Types

type Rep RecordType :: Type -> Type

Methods

from :: RecordType -> Rep RecordType x

to :: Rep RecordType x -> RecordType

ToJSON RecordType

Defined in PowerDNS.API.Zones

Methods

toJSON :: RecordType -> Value

toEncoding :: RecordType -> Encoding

toJSONList :: [RecordType] -> Value

toEncodingList :: [RecordType] -> Encoding

FromJSON RecordType

Defined in PowerDNS.API.Zones

Methods

parseJSON :: Value -> Parser RecordType

parseJSONList :: Value -> Parser [RecordType]

NFData RecordType

Defined in PowerDNS.API.Zones

Methods

rnf :: RecordType -> ()

type Rep RecordType

Defined in PowerDNS.API.Zones

type Rep RecordType = D1 ('MetaData "RecordType" "PowerDNS.API.Zones" "powerdns-0.1.1-3L9A3UJCvVEHahQ3GibYwt" 'False) (((((C1 ('MetaCons "A" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "AAAA" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AFSDB" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "ALIAS" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "APL" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CAA" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "CERT" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "CDNSKEY" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CDS" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "CNAME" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "DNSKEY" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DNAME" 'PrefixI 'False) (U1 :: Type -> Type))))) :+: (((C1 ('MetaCons "DS" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "HINFO" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "KEY" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "LOC" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "MX" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NAPTR" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "NS" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "NSEC" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NSEC3" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "NSEC3PARAM" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OPENPGPKEY" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PTR" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RP" 'PrefixI 'False) (U1 :: Type -> Type)))))) :+: ((((C1 ('MetaCons "RRSIG" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "SOA" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SPF" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "SSHFP" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "SRV" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TKEY" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "TSIG" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "TLSA" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SMIMEA" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "TXT" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "URI" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "A6" 'PrefixI 'False) (U1 :: Type -> Type))))) :+: (((C1 ('MetaCons "DHCID" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "DLV" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "EUI48" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "EUI64" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "IPSECKEY" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "KX" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "MAILA" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "MAILB" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MINFO" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "MR" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RKEY" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "SIG" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "WKS" 'PrefixI 'False) (U1 :: Type -> Type)))))))

Cryptokeys

See documentation at PowerDNS Cryptokeys API

listCryptoKeys

Arguments

:: Text

Server name

-> Text

Zone ID

-> ClientM [Cryptokey]

List all crypto keys. See Cryptokeys API Documentation

createCryptokey

Arguments

:: Text

Server name

-> Text

Zone ID

-> Cryptokey

Cryptokey to create

-> ClientM Cryptokey

Created cryptokey

Create a new crypto key. See Cryptokeys API Documentation

getCryptokey

Arguments

:: Text

Server name

-> Text

Zone ID

-> Text

Cryptokey ID

-> ClientM Cryptokey

Get existing crypto key. See Cryptokeys API Documentation

updateCryptokey

Arguments

:: Text

Server name

-> Text

Zone ID

-> Text

Cryptokey ID

-> Cryptokey

Patch record. Fields with Just are changed, Nothing are ignored

-> ClientM NoContent

Update existing crypto key. See Cryptokeys API Documentation

deleteCryptokey

Arguments

:: Text

Server name

-> Text

Zone ID

-> Text

Cryptokey ID

-> ClientM NoContent

Delete existing crypto key. See Cryptokeys API Documentation

Data types

data Cryptokey

Instances

Eq Cryptokey

Defined in PowerDNS.API.Cryptokeys

Methods

(==) :: Cryptokey -> Cryptokey -> Bool

(/=) :: Cryptokey -> Cryptokey -> Bool

Data Cryptokey

Defined in PowerDNS.API.Cryptokeys

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Cryptokey -> c Cryptokey

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Cryptokey

toConstr :: Cryptokey -> Constr

dataTypeOf :: Cryptokey -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Cryptokey)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Cryptokey)

gmapT :: (forall b. Data b => b -> b) -> Cryptokey -> Cryptokey

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Cryptokey -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Cryptokey -> r

gmapQ :: (forall d. Data d => d -> u) -> Cryptokey -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Cryptokey -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Cryptokey -> m Cryptokey

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Cryptokey -> m Cryptokey

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Cryptokey -> m Cryptokey

Ord Cryptokey

Defined in PowerDNS.API.Cryptokeys

Methods

compare :: Cryptokey -> Cryptokey -> Ordering

(<) :: Cryptokey -> Cryptokey -> Bool

(<=) :: Cryptokey -> Cryptokey -> Bool

(>) :: Cryptokey -> Cryptokey -> Bool

(>=) :: Cryptokey -> Cryptokey -> Bool

max :: Cryptokey -> Cryptokey -> Cryptokey

min :: Cryptokey -> Cryptokey -> Cryptokey

Show Cryptokey

Defined in PowerDNS.API.Cryptokeys

Methods

showsPrec :: Int -> Cryptokey -> ShowS

show :: Cryptokey -> String

showList :: [Cryptokey] -> ShowS

Generic Cryptokey

Defined in PowerDNS.API.Cryptokeys

Associated Types

type Rep Cryptokey :: Type -> Type

Methods

from :: Cryptokey -> Rep Cryptokey x

to :: Rep Cryptokey x -> Cryptokey

ToJSON Cryptokey

Defined in PowerDNS.API.Cryptokeys

Methods

toJSON :: Cryptokey -> Value

toEncoding :: Cryptokey -> Encoding

toJSONList :: [Cryptokey] -> Value

toEncodingList :: [Cryptokey] -> Encoding

FromJSON Cryptokey

Defined in PowerDNS.API.Cryptokeys

Methods

parseJSON :: Value -> Parser Cryptokey

parseJSONList :: Value -> Parser [Cryptokey]

NFData Cryptokey

Defined in PowerDNS.API.Cryptokeys

Methods

rnf :: Cryptokey -> ()

Empty Cryptokey

Defined in PowerDNS.API.Cryptokeys

Methods

empty :: Cryptokey

type Rep Cryptokey

Defined in PowerDNS.API.Cryptokeys

type Rep Cryptokey = D1 ('MetaData "Cryptokey" "PowerDNS.API.Cryptokeys" "powerdns-0.1.1-3L9A3UJCvVEHahQ3GibYwt" 'False) (C1 ('MetaCons "Cryptokey" 'PrefixI 'True) (((S1 ('MetaSel ('Just "ck_type") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "ck_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "ck_keytype") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "ck_active") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "ck_published") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "ck_dnskey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "ck_ds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "ck_privatekey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "ck_algorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "ck_bits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer)))))))

Servers

See documentation at PowerDNS Servers API

Also contains PowerDNS Search API and PowerDNS Cache API

listServers :: ClientM [Server]

List available servers. See Servers API Documentation

getServer

Arguments

:: Text

Server ID

-> ClientM Server

Get existing server. See Servers API Documentation

search

Arguments

:: Text

Server ID

-> Text

String to search for

-> Integer

Maximum number of results

-> Maybe ObjectType

Limit results to specified object type, if any.

-> ClientM [SearchResult]

Searches in various object types for an arbitrary string. See Search API Documentation

flushCache

Arguments

:: Text

Server ID

-> Text

Domain

-> ClientM CacheFlushResult

Flushes a domain from the cache. See Cache API Documentation

statistics

Arguments

:: Text

Server ID

-> Maybe Text

Only return statistic items with this name.

-> Maybe Bool

Whether or not to return ring items.

-> ClientM [AnyStatisticItem]

Get server wide statistics. See Cache API Documentation

Data types

data Server

Constructors

Server

Fields

• server_type :: Maybe Text
• server_id :: Maybe Text
• server_daemon_type :: Maybe Text
• server_version :: Maybe Text
• server_url :: Maybe Text
• server_config_url :: Maybe Text
• server_zones_url :: Maybe Text

Instances

Eq Server

Defined in PowerDNS.API.Servers

Methods

(==) :: Server -> Server -> Bool

(/=) :: Server -> Server -> Bool

Data Server

Defined in PowerDNS.API.Servers

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Server -> c Server

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Server

toConstr :: Server -> Constr

dataTypeOf :: Server -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Server)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Server)

gmapT :: (forall b. Data b => b -> b) -> Server -> Server

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Server -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Server -> r

gmapQ :: (forall d. Data d => d -> u) -> Server -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Server -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Server -> m Server

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Server -> m Server

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Server -> m Server

Ord Server

Defined in PowerDNS.API.Servers

Methods

compare :: Server -> Server -> Ordering

(<) :: Server -> Server -> Bool

(<=) :: Server -> Server -> Bool

(>) :: Server -> Server -> Bool

(>=) :: Server -> Server -> Bool

max :: Server -> Server -> Server

min :: Server -> Server -> Server

Show Server

Defined in PowerDNS.API.Servers

Methods

showsPrec :: Int -> Server -> ShowS

show :: Server -> String

showList :: [Server] -> ShowS

Generic Server

Defined in PowerDNS.API.Servers

Associated Types

type Rep Server :: Type -> Type

Methods

from :: Server -> Rep Server x

to :: Rep Server x -> Server

ToJSON Server

Defined in PowerDNS.API.Servers

Methods

toJSON :: Server -> Value

toEncoding :: Server -> Encoding

toJSONList :: [Server] -> Value

toEncodingList :: [Server] -> Encoding

FromJSON Server

Defined in PowerDNS.API.Servers

Methods

parseJSON :: Value -> Parser Server

parseJSONList :: Value -> Parser [Server]

NFData Server

Defined in PowerDNS.API.Servers

Methods

rnf :: Server -> ()

Empty Server

Defined in PowerDNS.API.Servers

Methods

empty :: Server

type Rep Server

Defined in PowerDNS.API.Servers

type Rep Server = D1 ('MetaData "Server" "PowerDNS.API.Servers" "powerdns-0.1.1-3L9A3UJCvVEHahQ3GibYwt" 'False) (C1 ('MetaCons "Server" 'PrefixI 'True) ((S1 ('MetaSel ('Just "server_type") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "server_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "server_daemon_type") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "server_version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "server_url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "server_config_url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "server_zones_url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))))

data SearchResult

Constructors

SearchResult

Fields

• sr_content :: Text
• sr_disabled :: Bool
• sr_name :: Text
• sr_object_type :: ObjectType
• sr_zone_id :: Text
• sr_zone :: Text
• sr_type :: Text
• sr_ttl :: Integer

Instances

Eq SearchResult

Defined in PowerDNS.API.Servers

Methods

(==) :: SearchResult -> SearchResult -> Bool

(/=) :: SearchResult -> SearchResult -> Bool

Data SearchResult

Defined in PowerDNS.API.Servers

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SearchResult -> c SearchResult

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SearchResult

toConstr :: SearchResult -> Constr

dataTypeOf :: SearchResult -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SearchResult)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SearchResult)

gmapT :: (forall b. Data b => b -> b) -> SearchResult -> SearchResult

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SearchResult -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SearchResult -> r

gmapQ :: (forall d. Data d => d -> u) -> SearchResult -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SearchResult -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SearchResult -> m SearchResult

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchResult -> m SearchResult

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchResult -> m SearchResult

Ord SearchResult

Defined in PowerDNS.API.Servers

Methods

compare :: SearchResult -> SearchResult -> Ordering

(<) :: SearchResult -> SearchResult -> Bool

(<=) :: SearchResult -> SearchResult -> Bool

(>) :: SearchResult -> SearchResult -> Bool

(>=) :: SearchResult -> SearchResult -> Bool

max :: SearchResult -> SearchResult -> SearchResult

min :: SearchResult -> SearchResult -> SearchResult

Show SearchResult

Defined in PowerDNS.API.Servers

Methods

showsPrec :: Int -> SearchResult -> ShowS

show :: SearchResult -> String

showList :: [SearchResult] -> ShowS

Generic SearchResult

Defined in PowerDNS.API.Servers

Associated Types

type Rep SearchResult :: Type -> Type

Methods

from :: SearchResult -> Rep SearchResult x

to :: Rep SearchResult x -> SearchResult

ToJSON SearchResult

Defined in PowerDNS.API.Servers

Methods

toJSON :: SearchResult -> Value

toEncoding :: SearchResult -> Encoding

toJSONList :: [SearchResult] -> Value

toEncodingList :: [SearchResult] -> Encoding

FromJSON SearchResult

Defined in PowerDNS.API.Servers

Methods

parseJSON :: Value -> Parser SearchResult

parseJSONList :: Value -> Parser [SearchResult]

NFData SearchResult

Defined in PowerDNS.API.Servers

Methods

rnf :: SearchResult -> ()

type Rep SearchResult

Defined in PowerDNS.API.Servers

type Rep SearchResult = D1 ('MetaData "SearchResult" "PowerDNS.API.Servers" "powerdns-0.1.1-3L9A3UJCvVEHahQ3GibYwt" 'False) (C1 ('MetaCons "SearchResult" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sr_content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "sr_disabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "sr_name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "sr_object_type") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ObjectType))) :*: ((S1 ('MetaSel ('Just "sr_zone_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "sr_zone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "sr_type") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "sr_ttl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)))))

data ObjectType

Constructors

TyAll

TyZone

TyRecord

TyComment

Instances

Eq ObjectType

Defined in PowerDNS.API.Servers

Methods

(==) :: ObjectType -> ObjectType -> Bool

(/=) :: ObjectType -> ObjectType -> Bool

Data ObjectType

Defined in PowerDNS.API.Servers

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ObjectType -> c ObjectType

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ObjectType

toConstr :: ObjectType -> Constr

dataTypeOf :: ObjectType -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ObjectType)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ObjectType)

gmapT :: (forall b. Data b => b -> b) -> ObjectType -> ObjectType

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ObjectType -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ObjectType -> r

gmapQ :: (forall d. Data d => d -> u) -> ObjectType -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ObjectType -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ObjectType -> m ObjectType

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ObjectType -> m ObjectType

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ObjectType -> m ObjectType

Ord ObjectType

Defined in PowerDNS.API.Servers

Methods

compare :: ObjectType -> ObjectType -> Ordering

(<) :: ObjectType -> ObjectType -> Bool

(<=) :: ObjectType -> ObjectType -> Bool

(>) :: ObjectType -> ObjectType -> Bool

(>=) :: ObjectType -> ObjectType -> Bool

max :: ObjectType -> ObjectType -> ObjectType

min :: ObjectType -> ObjectType -> ObjectType

Show ObjectType

Defined in PowerDNS.API.Servers

Methods

showsPrec :: Int -> ObjectType -> ShowS

show :: ObjectType -> String

showList :: [ObjectType] -> ShowS

Generic ObjectType

Defined in PowerDNS.API.Servers

Associated Types

type Rep ObjectType :: Type -> Type

Methods

from :: ObjectType -> Rep ObjectType x

to :: Rep ObjectType x -> ObjectType

ToJSON ObjectType

Defined in PowerDNS.API.Servers

Methods

toJSON :: ObjectType -> Value

toEncoding :: ObjectType -> Encoding

toJSONList :: [ObjectType] -> Value

toEncodingList :: [ObjectType] -> Encoding

FromJSON ObjectType

Defined in PowerDNS.API.Servers

Methods

parseJSON :: Value -> Parser ObjectType

parseJSONList :: Value -> Parser [ObjectType]

NFData ObjectType

Defined in PowerDNS.API.Servers

Methods

rnf :: ObjectType -> ()

ToHttpApiData ObjectType

Defined in PowerDNS.API.Servers

Methods

toUrlPiece :: ObjectType -> Text

toEncodedUrlPiece :: ObjectType -> Builder

toHeader :: ObjectType -> ByteString

toQueryParam :: ObjectType -> Text

type Rep ObjectType

Defined in PowerDNS.API.Servers

type Rep ObjectType = D1 ('MetaData "ObjectType" "PowerDNS.API.Servers" "powerdns-0.1.1-3L9A3UJCvVEHahQ3GibYwt" 'False) ((C1 ('MetaCons "TyAll" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TyZone" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "TyRecord" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TyComment" 'PrefixI 'False) (U1 :: Type -> Type)))

data CacheFlushResult

Constructors

CacheFlushResult

Fields

• cfr_count :: Integer
• cfr_result :: Text

Instances

Eq CacheFlushResult

Defined in PowerDNS.API.Servers

Methods

(==) :: CacheFlushResult -> CacheFlushResult -> Bool

(/=) :: CacheFlushResult -> CacheFlushResult -> Bool

Data CacheFlushResult

Defined in PowerDNS.API.Servers

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CacheFlushResult -> c CacheFlushResult

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CacheFlushResult

toConstr :: CacheFlushResult -> Constr

dataTypeOf :: CacheFlushResult -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CacheFlushResult)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CacheFlushResult)

gmapT :: (forall b. Data b => b -> b) -> CacheFlushResult -> CacheFlushResult

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CacheFlushResult -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CacheFlushResult -> r

gmapQ :: (forall d. Data d => d -> u) -> CacheFlushResult -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CacheFlushResult -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CacheFlushResult -> m CacheFlushResult

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CacheFlushResult -> m CacheFlushResult

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CacheFlushResult -> m CacheFlushResult

Ord CacheFlushResult

Defined in PowerDNS.API.Servers

Methods

compare :: CacheFlushResult -> CacheFlushResult -> Ordering

(<) :: CacheFlushResult -> CacheFlushResult -> Bool

(<=) :: CacheFlushResult -> CacheFlushResult -> Bool

(>) :: CacheFlushResult -> CacheFlushResult -> Bool

(>=) :: CacheFlushResult -> CacheFlushResult -> Bool

max :: CacheFlushResult -> CacheFlushResult -> CacheFlushResult

min :: CacheFlushResult -> CacheFlushResult -> CacheFlushResult

Show CacheFlushResult

Defined in PowerDNS.API.Servers

Methods

showsPrec :: Int -> CacheFlushResult -> ShowS

show :: CacheFlushResult -> String

showList :: [CacheFlushResult] -> ShowS

Generic CacheFlushResult

Defined in PowerDNS.API.Servers

Associated Types

type Rep CacheFlushResult :: Type -> Type

Methods

from :: CacheFlushResult -> Rep CacheFlushResult x

to :: Rep CacheFlushResult x -> CacheFlushResult

ToJSON CacheFlushResult

Defined in PowerDNS.API.Servers

Methods

toJSON :: CacheFlushResult -> Value

toEncoding :: CacheFlushResult -> Encoding

toJSONList :: [CacheFlushResult] -> Value

toEncodingList :: [CacheFlushResult] -> Encoding

FromJSON CacheFlushResult

Defined in PowerDNS.API.Servers

Methods

parseJSON :: Value -> Parser CacheFlushResult

parseJSONList :: Value -> Parser [CacheFlushResult]

NFData CacheFlushResult

Defined in PowerDNS.API.Servers

Methods

rnf :: CacheFlushResult -> ()

type Rep CacheFlushResult

Defined in PowerDNS.API.Servers

type Rep CacheFlushResult = D1 ('MetaData "CacheFlushResult" "PowerDNS.API.Servers" "powerdns-0.1.1-3L9A3UJCvVEHahQ3GibYwt" 'False) (C1 ('MetaCons "CacheFlushResult" 'PrefixI 'True) (S1 ('MetaSel ('Just "cfr_count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer) :*: S1 ('MetaSel ('Just "cfr_result") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Metadata

See documentation at PowerDNS Metadata API

listMetadata

Arguments

:: Text

Server ID

-> Text

Zone ID

-> ClientM [Metadata]

List metadata for existing zone. See Metadata API Documentation

createMetadata

Arguments

:: Text

Server ID

-> Text

Zone ID

-> Metadata

-> ClientM NoContent

Create metadata for zone. See Metadata API Documentation

getMetadata

Arguments

:: Text

Server ID

-> Text

Zone ID

-> Text

Kind

-> ClientM Metadata

Get metadata for zone by kind. See Metadata API Documentation

updateMetadata

Arguments

:: Text

Server ID

-> Text

Zone ID

-> Text

Kind

-> Metadata

-> ClientM Metadata

Update metadata for zone by kind. See Metadata API Documentation

deleteMetadata

Arguments

:: Text

Server ID

-> Text

Zone ID

-> Text

Kind

-> ClientM NoContent

Delete metadata for zone by kind. See Metadata API Documentation

Data types

data Metadata

Constructors

Metadata

Fields

• md_kind :: Text
• md_metadata :: [Text]

Instances

Eq Metadata

Defined in PowerDNS.API.Metadata

Methods

(==) :: Metadata -> Metadata -> Bool

(/=) :: Metadata -> Metadata -> Bool

Data Metadata

Defined in PowerDNS.API.Metadata

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Metadata -> c Metadata

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Metadata

toConstr :: Metadata -> Constr

dataTypeOf :: Metadata -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Metadata)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Metadata)

gmapT :: (forall b. Data b => b -> b) -> Metadata -> Metadata

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Metadata -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Metadata -> r

gmapQ :: (forall d. Data d => d -> u) -> Metadata -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Metadata -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Metadata -> m Metadata

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Metadata -> m Metadata

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Metadata -> m Metadata

Ord Metadata

Defined in PowerDNS.API.Metadata

Methods

compare :: Metadata -> Metadata -> Ordering

(<) :: Metadata -> Metadata -> Bool

(<=) :: Metadata -> Metadata -> Bool

(>) :: Metadata -> Metadata -> Bool

(>=) :: Metadata -> Metadata -> Bool

max :: Metadata -> Metadata -> Metadata

min :: Metadata -> Metadata -> Metadata

Show Metadata

Defined in PowerDNS.API.Metadata

Methods

showsPrec :: Int -> Metadata -> ShowS

show :: Metadata -> String

showList :: [Metadata] -> ShowS

Generic Metadata

Defined in PowerDNS.API.Metadata

Associated Types

type Rep Metadata :: Type -> Type

Methods

from :: Metadata -> Rep Metadata x

to :: Rep Metadata x -> Metadata

ToJSON Metadata

Defined in PowerDNS.API.Metadata

Methods

toJSON :: Metadata -> Value

toEncoding :: Metadata -> Encoding

toJSONList :: [Metadata] -> Value

toEncodingList :: [Metadata] -> Encoding

FromJSON Metadata

Defined in PowerDNS.API.Metadata

Methods

parseJSON :: Value -> Parser Metadata

parseJSONList :: Value -> Parser [Metadata]

NFData Metadata

Defined in PowerDNS.API.Metadata

Methods

rnf :: Metadata -> ()

type Rep Metadata

Defined in PowerDNS.API.Metadata

type Rep Metadata = D1 ('MetaData "Metadata" "PowerDNS.API.Metadata" "powerdns-0.1.1-3L9A3UJCvVEHahQ3GibYwt" 'False) (C1 ('MetaCons "Metadata" 'PrefixI 'True) (S1 ('MetaSel ('Just "md_kind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "md_metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])))

TSIGKeys

See documentation at PowerDNS TSIGKeys API as well as related TSIG documentation

listTSIGKeys :: Text -> ClientM [TSIGKey]

List all TSIG keys. See TSIGKeys API Documentation

createTSIGKey :: Text -> TSIGKey -> ClientM TSIGKey

Create a new TSIG key. If the key is left empty, the server will generate one. See TSIGKeys API Documentation

getTSIGKey :: Text -> Text -> ClientM TSIGKey

Get TSIG key by its id. See TSIGKeys API Documentation

updateTSIGKey :: Text -> Text -> TSIGKey -> ClientM TSIGKey

Update existig TSIG key. See TSIGKeys API Documentation

deleteTSIGKey :: Text -> Text -> ClientM NoContent

Delete existing TSIG key. See TSIGKeys API Documentation

Data types

data TSIGKey

Constructors

TSIGKey

Fields

• tsk_name :: Text
• tsk_id :: Text
• tsk_algorithm :: Maybe TSIGAlgorithm
• tsk_key :: Maybe ByteString

  Unlike the original PowerDNS API we do not require the key to be base64 encoded.

Instances

Eq TSIGKey

Defined in PowerDNS.API.TSIGKeys

Methods

(==) :: TSIGKey -> TSIGKey -> Bool

(/=) :: TSIGKey -> TSIGKey -> Bool

Data TSIGKey

Defined in PowerDNS.API.TSIGKeys

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TSIGKey -> c TSIGKey

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TSIGKey

toConstr :: TSIGKey -> Constr

dataTypeOf :: TSIGKey -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TSIGKey)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TSIGKey)

gmapT :: (forall b. Data b => b -> b) -> TSIGKey -> TSIGKey

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TSIGKey -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TSIGKey -> r

gmapQ :: (forall d. Data d => d -> u) -> TSIGKey -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> TSIGKey -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TSIGKey -> m TSIGKey

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TSIGKey -> m TSIGKey

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TSIGKey -> m TSIGKey

Ord TSIGKey

Defined in PowerDNS.API.TSIGKeys

Methods

compare :: TSIGKey -> TSIGKey -> Ordering

(<) :: TSIGKey -> TSIGKey -> Bool

(<=) :: TSIGKey -> TSIGKey -> Bool

(>) :: TSIGKey -> TSIGKey -> Bool

(>=) :: TSIGKey -> TSIGKey -> Bool

max :: TSIGKey -> TSIGKey -> TSIGKey

min :: TSIGKey -> TSIGKey -> TSIGKey

Show TSIGKey

Defined in PowerDNS.API.TSIGKeys

Methods

showsPrec :: Int -> TSIGKey -> ShowS

show :: TSIGKey -> String

showList :: [TSIGKey] -> ShowS

Generic TSIGKey

Defined in PowerDNS.API.TSIGKeys

Associated Types

type Rep TSIGKey :: Type -> Type

Methods

from :: TSIGKey -> Rep TSIGKey x

to :: Rep TSIGKey x -> TSIGKey

ToJSON TSIGKey

Defined in PowerDNS.API.TSIGKeys

Methods

toJSON :: TSIGKey -> Value

toEncoding :: TSIGKey -> Encoding

toJSONList :: [TSIGKey] -> Value

toEncodingList :: [TSIGKey] -> Encoding

FromJSON TSIGKey

Defined in PowerDNS.API.TSIGKeys

Methods

parseJSON :: Value -> Parser TSIGKey

parseJSONList :: Value -> Parser [TSIGKey]

NFData TSIGKey

Defined in PowerDNS.API.TSIGKeys

Methods

rnf :: TSIGKey -> ()

type Rep TSIGKey

Defined in PowerDNS.API.TSIGKeys

type Rep TSIGKey = D1 ('MetaData "TSIGKey" "PowerDNS.API.TSIGKeys" "powerdns-0.1.1-3L9A3UJCvVEHahQ3GibYwt" 'False) (C1 ('MetaCons "TSIGKey" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tsk_name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "tsk_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "tsk_algorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe TSIGAlgorithm)) :*: S1 ('MetaSel ('Just "tsk_key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ByteString)))))

data TSIGAlgorithm

Supported algorithms according to PowerDNS TSIG Documentation

Constructors

HMAC_MD5

HMAC_SHA1

HMAC_SHA224

HMAC_SHA256

HMAC_SHA384

HMAC_SHA512

Instances

Eq TSIGAlgorithm

Defined in PowerDNS.API.TSIGKeys

Methods

(==) :: TSIGAlgorithm -> TSIGAlgorithm -> Bool

(/=) :: TSIGAlgorithm -> TSIGAlgorithm -> Bool

Data TSIGAlgorithm

Defined in PowerDNS.API.TSIGKeys

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TSIGAlgorithm -> c TSIGAlgorithm

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TSIGAlgorithm

toConstr :: TSIGAlgorithm -> Constr

dataTypeOf :: TSIGAlgorithm -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TSIGAlgorithm)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TSIGAlgorithm)

gmapT :: (forall b. Data b => b -> b) -> TSIGAlgorithm -> TSIGAlgorithm

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TSIGAlgorithm -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TSIGAlgorithm -> r

gmapQ :: (forall d. Data d => d -> u) -> TSIGAlgorithm -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> TSIGAlgorithm -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TSIGAlgorithm -> m TSIGAlgorithm

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TSIGAlgorithm -> m TSIGAlgorithm

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TSIGAlgorithm -> m TSIGAlgorithm

Ord TSIGAlgorithm

Defined in PowerDNS.API.TSIGKeys

Methods

compare :: TSIGAlgorithm -> TSIGAlgorithm -> Ordering

(<) :: TSIGAlgorithm -> TSIGAlgorithm -> Bool

(<=) :: TSIGAlgorithm -> TSIGAlgorithm -> Bool

(>) :: TSIGAlgorithm -> TSIGAlgorithm -> Bool

(>=) :: TSIGAlgorithm -> TSIGAlgorithm -> Bool

max :: TSIGAlgorithm -> TSIGAlgorithm -> TSIGAlgorithm

min :: TSIGAlgorithm -> TSIGAlgorithm -> TSIGAlgorithm

Show TSIGAlgorithm

Defined in PowerDNS.API.TSIGKeys

Methods

showsPrec :: Int -> TSIGAlgorithm -> ShowS

show :: TSIGAlgorithm -> String

showList :: [TSIGAlgorithm] -> ShowS

Generic TSIGAlgorithm

Defined in PowerDNS.API.TSIGKeys

Associated Types

type Rep TSIGAlgorithm :: Type -> Type

Methods

from :: TSIGAlgorithm -> Rep TSIGAlgorithm x

to :: Rep TSIGAlgorithm x -> TSIGAlgorithm

ToJSON TSIGAlgorithm

Defined in PowerDNS.API.TSIGKeys

Methods

toJSON :: TSIGAlgorithm -> Value

toEncoding :: TSIGAlgorithm -> Encoding

toJSONList :: [TSIGAlgorithm] -> Value

toEncodingList :: [TSIGAlgorithm] -> Encoding

FromJSON TSIGAlgorithm

Defined in PowerDNS.API.TSIGKeys

Methods

parseJSON :: Value -> Parser TSIGAlgorithm

parseJSONList :: Value -> Parser [TSIGAlgorithm]

NFData TSIGAlgorithm

Defined in PowerDNS.API.TSIGKeys

Methods

rnf :: TSIGAlgorithm -> ()

type Rep TSIGAlgorithm

Defined in PowerDNS.API.TSIGKeys

type Rep TSIGAlgorithm = D1 ('MetaData "TSIGAlgorithm" "PowerDNS.API.TSIGKeys" "powerdns-0.1.1-3L9A3UJCvVEHahQ3GibYwt" 'False) ((C1 ('MetaCons "HMAC_MD5" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "HMAC_SHA1" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "HMAC_SHA224" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "HMAC_SHA256" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "HMAC_SHA384" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "HMAC_SHA512" 'PrefixI 'False) (U1 :: Type -> Type))))

Utilities

empty :: Empty a => a

Produce an empty value