Safe Haskell	Safe-Inferred
Language	Haskell2010

PowerDNS.Client

Contents

Authentication
Version
Zones
- Data types
Cryptokeys
- Data types
Servers
- Data types
Metadata
- Data types
TSIGKeys
- Data types
Utilities

Description

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

Synopsis

applyXApiKey :: Text -> ClientEnv -> ClientEnv
listVersions :: ClientM [Version]
data Version = Version {
- version_version :: Int
- version_url :: Text
}
listZones :: Text -> Maybe Text -> Maybe Bool -> ClientM [Zone]
createZone :: Text -> Maybe Bool -> Zone -> ClientM Zone
getZone :: Text -> Text -> Maybe Bool -> ClientM Zone
deleteZone :: Text -> Text -> ClientM NoContent
updateRecords :: Text -> Text -> RRSets -> ClientM NoContent
updateZone :: Text -> Text -> Zone -> ClientM NoContent
triggerAxfr :: Text -> Text -> ClientM Result
notifySlaves :: Text -> Text -> ClientM Result
getZoneAxfr :: Text -> Text -> ClientM Result
rectifyZone :: Text -> Text -> ClientM Result
data Zone = Zone {
- zone_id :: Maybe Text
- zone_name :: Maybe CIText
- 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]
}
data Kind
- = Native
- | Master
- | Slave
data RRSets = RRSets {
- rrsets :: [RRSet]
}
data RRSet = RRSet {
- rrset_name :: CIText
- rrset_type :: RecordType
- rrset_ttl :: Maybe Word32
- rrset_changetype :: Maybe ChangeType
- rrset_records :: Maybe [Record]
- rrset_comments :: Maybe [Comment]
}
data Record = Record {
- record_content :: Text
- record_disabled :: Bool
}
data Comment = Comment {
- comment_content :: Maybe Text
- comment_account :: Maybe Text
- comment_modified_at :: Maybe POSIXTime
}
data ChangeType
- = Replace
- | Delete
data RecordType
- = 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
newtype Result = Result Text
listCryptoKeys :: Text -> Text -> ClientM [Cryptokey]
createCryptokey :: Text -> Text -> Cryptokey -> ClientM Cryptokey
getCryptokey :: Text -> Text -> Text -> ClientM Cryptokey
updateCryptokey :: Text -> Text -> Text -> Cryptokey -> ClientM NoContent
deleteCryptokey :: Text -> Text -> Text -> ClientM NoContent
data Cryptokey
listServers :: ClientM [Server]
getServer :: Text -> ClientM Server
search :: Text -> Text -> Integer -> Maybe ObjectType -> ClientM [SearchResult]
flushCache :: Text -> Text -> ClientM CacheFlushResult
statistics :: Text -> Maybe Text -> Maybe Bool -> ClientM [AnyStatisticItem]
data Server = Server {
- 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
}
data SearchResult = SearchResult {
- 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
}
data ObjectType
- = TyAll
- | TyZone
- | TyRecord
- | TyComment
data CacheFlushResult = CacheFlushResult {
- cfr_count :: Integer
- cfr_result :: Text
}
listMetadata :: Text -> Text -> ClientM [Metadata]
createMetadata :: Text -> Text -> Metadata -> ClientM NoContent
getMetadata :: Text -> Text -> Text -> ClientM Metadata
updateMetadata :: Text -> Text -> Text -> Metadata -> ClientM Metadata
deleteMetadata :: Text -> Text -> Text -> ClientM NoContent
data Metadata = Metadata {
- md_kind :: Text
- md_metadata :: [Text]
}
listTSIGKeys :: Text -> ClientM [TSIGKey]
createTSIGKey :: Text -> TSIGKey -> ClientM TSIGKey
getTSIGKey :: Text -> Text -> ClientM TSIGKey
updateTSIGKey :: Text -> Text -> TSIGKey -> ClientM TSIGKey
deleteTSIGKey :: Text -> Text -> ClientM NoContent
data TSIGKey = TSIGKey {
- tsk_name :: Text
- tsk_id :: Text
- tsk_algorithm :: Maybe TSIGAlgorithm
- tsk_key :: Maybe ByteString
}
data TSIGAlgorithm
- = HMAC_MD5
- | HMAC_SHA1
- | HMAC_SHA224
- | HMAC_SHA256
- | HMAC_SHA384
- | HMAC_SHA512
empty :: Empty a => a

Authentication

applyXApiKey Source #

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.

Version

listVersions :: ClientM [Version] Source #

List the API versions and urls from the server. This is an undocumented endpoint.

data Version Source #

Constructors

Version
Fields version_version :: Int version_url :: Text

Instances

Instances details

FromJSON Version Source #
Instance details Defined in PowerDNS.API.Version Methods parseJSON :: Value -> Parser Version parseJSONList :: Value -> Parser [Version]
ToJSON Version Source #
Instance details Defined in PowerDNS.API.Version Methods toJSON :: Version -> Value toEncoding :: Version -> Encoding toJSONList :: [Version] -> Value toEncodingList :: [Version] -> Encoding
Data Version Source #
Instance details Defined in PowerDNS.API.Version Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Version -> c Version # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Version # toConstr :: Version -> Constr # dataTypeOf :: Version -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Version) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Version) # gmapT :: (forall b. Data b => b -> b) -> Version -> Version # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Version -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Version -> r # gmapQ :: (forall d. Data d => d -> u) -> Version -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Version -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Version -> m Version # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Version -> m Version # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Version -> m Version #
Generic Version Source #
Instance details Defined in PowerDNS.API.Version Associated Types type Rep Version :: Type -> Type # Methods from :: Version -> Rep Version x # to :: Rep Version x -> Version #
Show Version Source #
Instance details Defined in PowerDNS.API.Version Methods showsPrec :: Int -> Version -> ShowS # show :: Version -> String # showList :: [Version] -> ShowS #
NFData Version Source #
Instance details Defined in PowerDNS.API.Version Methods rnf :: Version -> () #
Eq Version Source #
Instance details Defined in PowerDNS.API.Version Methods (==) :: Version -> Version -> Bool # (/=) :: Version -> Version -> Bool #
Ord Version Source #
Instance details Defined in PowerDNS.API.Version Methods compare :: Version -> Version -> Ordering # (<) :: Version -> Version -> Bool # (<=) :: Version -> Version -> Bool # (>) :: Version -> Version -> Bool # (>=) :: Version -> Version -> Bool # max :: Version -> Version -> Version # min :: Version -> Version -> Version #
type Rep Version Source #
Instance details Defined in PowerDNS.API.Version type Rep Version = D1 ('MetaData "Version" "PowerDNS.API.Version" "powerdns-0.4.3-inplace" 'False) (C1 ('MetaCons "Version" 'PrefixI 'True) (S1 ('MetaSel ('Just "version_version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "version_url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

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 Source #

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 Source #

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 Source #

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 Source #

Arguments

:: Text	Server name
-> Text	Zone ID
-> ClientM NoContent

Delete a given zone by id. See Zones API Documentation

updateRecords Source #

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 Source #

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 Source #

Arguments

:: Text	Server name
-> Text	Zone ID
-> ClientM Result

Trigger zone transfer on a slave. See Zones API Documentation

notifySlaves Source #

Arguments

:: Text	Server name
-> Text	Zone ID
-> ClientM Result

Send DNS notify to slaves. See Zones API Documentation

getZoneAxfr Source #

Arguments

:: Text	Server name
-> Text	Zone ID
-> ClientM Result	Zone in AXFR format

Return zone in AXFR format. See Zones API Documentation

rectifyZone Source #

Arguments

:: Text	Server name
-> Text	Zone ID
-> ClientM Result

Rectify the zone data. See Zones API Documentation

Data types

data Zone Source #

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

Note that Eq and Ord use limited case-sensitivity on zone_name and equivalently contained rrset names as per RFC4343

Constructors

Zone

Fields

zone_id :: Maybe Text
zone_name :: Maybe CIText
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

Instances details

FromJSON Zone Source #
Instance details Defined in PowerDNS.API.Zones Methods parseJSON :: Value -> Parser Zone parseJSONList :: Value -> Parser [Zone]
ToJSON Zone Source #
Instance details Defined in PowerDNS.API.Zones Methods toJSON :: Zone -> Value toEncoding :: Zone -> Encoding toJSONList :: [Zone] -> Value toEncodingList :: [Zone] -> Encoding
Data Zone Source #
Instance details 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 #
Generic Zone Source #
Instance details Defined in PowerDNS.API.Zones Associated Types type Rep Zone :: Type -> Type # Methods from :: Zone -> Rep Zone x # to :: Rep Zone x -> Zone #
Show Zone Source #
Instance details Defined in PowerDNS.API.Zones Methods showsPrec :: Int -> Zone -> ShowS # show :: Zone -> String # showList :: [Zone] -> ShowS #
NFData Zone Source #
Instance details Defined in PowerDNS.API.Zones Methods rnf :: Zone -> () #
Eq Zone Source #
Instance details Defined in PowerDNS.API.Zones Methods (==) :: Zone -> Zone -> Bool # (/=) :: Zone -> Zone -> Bool #
Ord Zone Source #
Instance details 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 #
Empty Zone Source #
Instance details Defined in PowerDNS.API.Zones Methods empty :: Zone Source #
type Rep Zone Source #
Instance details Defined in PowerDNS.API.Zones type Rep Zone = D1 ('MetaData "Zone" "PowerDNS.API.Zones" "powerdns-0.4.3-inplace" '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 CIText))) :: (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 Source #

Constructors

Native
Master
Slave

Instances

Instances details

FromJSON Kind Source #
Instance details Defined in PowerDNS.API.Zones Methods parseJSON :: Value -> Parser Kind parseJSONList :: Value -> Parser [Kind]
ToJSON Kind Source #
Instance details Defined in PowerDNS.API.Zones Methods toJSON :: Kind -> Value toEncoding :: Kind -> Encoding toJSONList :: [Kind] -> Value toEncodingList :: [Kind] -> Encoding
Data Kind Source #
Instance details 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 #
Generic Kind Source #
Instance details Defined in PowerDNS.API.Zones Associated Types type Rep Kind :: Type -> Type # Methods from :: Kind -> Rep Kind x # to :: Rep Kind x -> Kind #
Show Kind Source #
Instance details Defined in PowerDNS.API.Zones Methods showsPrec :: Int -> Kind -> ShowS # show :: Kind -> String # showList :: [Kind] -> ShowS #
NFData Kind Source #
Instance details Defined in PowerDNS.API.Zones Methods rnf :: Kind -> () #
Eq Kind Source #
Instance details Defined in PowerDNS.API.Zones Methods (==) :: Kind -> Kind -> Bool # (/=) :: Kind -> Kind -> Bool #
Ord Kind Source #
Instance details 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 #
type Rep Kind Source #
Instance details Defined in PowerDNS.API.Zones type Rep Kind = D1 ('MetaData "Kind" "PowerDNS.API.Zones" "powerdns-0.4.3-inplace" '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 Source #

A list of RRSets

Constructors

RRSets
Fields rrsets :: [RRSet]

Instances

Instances details

FromJSON RRSets Source #
Instance details Defined in PowerDNS.API.Zones Methods parseJSON :: Value -> Parser RRSets parseJSONList :: Value -> Parser [RRSets]
ToJSON RRSets Source #
Instance details Defined in PowerDNS.API.Zones Methods toJSON :: RRSets -> Value toEncoding :: RRSets -> Encoding toJSONList :: [RRSets] -> Value toEncodingList :: [RRSets] -> Encoding
Data RRSets Source #
Instance details 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 #
Generic RRSets Source #
Instance details Defined in PowerDNS.API.Zones Associated Types type Rep RRSets :: Type -> Type # Methods from :: RRSets -> Rep RRSets x # to :: Rep RRSets x -> RRSets #
Show RRSets Source #
Instance details Defined in PowerDNS.API.Zones Methods showsPrec :: Int -> RRSets -> ShowS # show :: RRSets -> String # showList :: [RRSets] -> ShowS #
NFData RRSets Source #
Instance details Defined in PowerDNS.API.Zones Methods rnf :: RRSets -> () #
Eq RRSets Source #
Instance details Defined in PowerDNS.API.Zones Methods (==) :: RRSets -> RRSets -> Bool # (/=) :: RRSets -> RRSets -> Bool #
Ord RRSets Source #
Instance details 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 #
type Rep RRSets Source #
Instance details Defined in PowerDNS.API.Zones type Rep RRSets = D1 ('MetaData "RRSets" "PowerDNS.API.Zones" "powerdns-0.4.3-inplace" 'False) (C1 ('MetaCons "RRSets" 'PrefixI 'True) (S1 ('MetaSel ('Just "rrsets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [RRSet])))

data RRSet Source #

RRSet according to PowerDNS Documentation.

Note that Eq and Ord use limited case-sensitivity on rrset_name as per RFC4343

Constructors

RRSet
Fields rrset_name :: CIText rrset_type :: RecordType rrset_ttl :: Maybe Word32 rrset_changetype :: Maybe ChangeType rrset_records :: Maybe [Record] rrset_comments :: Maybe [Comment]

Instances

Instances details

FromJSON RRSet Source #
Instance details Defined in PowerDNS.API.Zones Methods parseJSON :: Value -> Parser RRSet parseJSONList :: Value -> Parser [RRSet]
ToJSON RRSet Source #
Instance details Defined in PowerDNS.API.Zones Methods toJSON :: RRSet -> Value toEncoding :: RRSet -> Encoding toJSONList :: [RRSet] -> Value toEncodingList :: [RRSet] -> Encoding
Data RRSet Source #
Instance details 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 #
Generic RRSet Source #
Instance details Defined in PowerDNS.API.Zones Associated Types type Rep RRSet :: Type -> Type # Methods from :: RRSet -> Rep RRSet x # to :: Rep RRSet x -> RRSet #
Show RRSet Source #
Instance details Defined in PowerDNS.API.Zones Methods showsPrec :: Int -> RRSet -> ShowS # show :: RRSet -> String # showList :: [RRSet] -> ShowS #
NFData RRSet Source #
Instance details Defined in PowerDNS.API.Zones Methods rnf :: RRSet -> () #
Eq RRSet Source #
Instance details Defined in PowerDNS.API.Zones Methods (==) :: RRSet -> RRSet -> Bool # (/=) :: RRSet -> RRSet -> Bool #
Ord RRSet Source #
Instance details 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 #
type Rep RRSet Source #
Instance details Defined in PowerDNS.API.Zones type Rep RRSet = D1 ('MetaData "RRSet" "PowerDNS.API.Zones" "powerdns-0.4.3-inplace" 'False) (C1 ('MetaCons "RRSet" 'PrefixI 'True) ((S1 ('MetaSel ('Just "rrset_name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CIText) :: (S1 ('MetaSel ('Just "rrset_type") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RecordType) :: S1 ('MetaSel ('Just "rrset_ttl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe 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 Source #

Record according to PowerDNS Documentation

Constructors

Record
Fields record_content :: Text record_disabled :: Bool

Instances

Instances details

FromJSON Record Source #
Instance details Defined in PowerDNS.API.Zones Methods parseJSON :: Value -> Parser Record parseJSONList :: Value -> Parser [Record]
ToJSON Record Source #
Instance details Defined in PowerDNS.API.Zones Methods toJSON :: Record -> Value toEncoding :: Record -> Encoding toJSONList :: [Record] -> Value toEncodingList :: [Record] -> Encoding
Data Record Source #
Instance details 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 #
Generic Record Source #
Instance details Defined in PowerDNS.API.Zones Associated Types type Rep Record :: Type -> Type # Methods from :: Record -> Rep Record x # to :: Rep Record x -> Record #
Show Record Source #
Instance details Defined in PowerDNS.API.Zones Methods showsPrec :: Int -> Record -> ShowS # show :: Record -> String # showList :: [Record] -> ShowS #
NFData Record Source #
Instance details Defined in PowerDNS.API.Zones Methods rnf :: Record -> () #
Eq Record Source #
Instance details Defined in PowerDNS.API.Zones Methods (==) :: Record -> Record -> Bool # (/=) :: Record -> Record -> Bool #
Ord Record Source #
Instance details 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 #
type Rep Record Source #
Instance details Defined in PowerDNS.API.Zones type Rep Record = D1 ('MetaData "Record" "PowerDNS.API.Zones" "powerdns-0.4.3-inplace" '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 Source #

Comment according to PowerDNS Documentation

Constructors

Comment
Fields comment_content :: Maybe Text comment_account :: Maybe Text comment_modified_at :: Maybe POSIXTime

Instances

Instances details

FromJSON Comment Source #
Instance details Defined in PowerDNS.API.Zones Methods parseJSON :: Value -> Parser Comment parseJSONList :: Value -> Parser [Comment]
ToJSON Comment Source #
Instance details Defined in PowerDNS.API.Zones Methods toJSON :: Comment -> Value toEncoding :: Comment -> Encoding toJSONList :: [Comment] -> Value toEncodingList :: [Comment] -> Encoding
Data Comment Source #
Instance details 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 #
Generic Comment Source #
Instance details Defined in PowerDNS.API.Zones Associated Types type Rep Comment :: Type -> Type # Methods from :: Comment -> Rep Comment x # to :: Rep Comment x -> Comment #
Show Comment Source #
Instance details Defined in PowerDNS.API.Zones Methods showsPrec :: Int -> Comment -> ShowS # show :: Comment -> String # showList :: [Comment] -> ShowS #
NFData Comment Source #
Instance details Defined in PowerDNS.API.Zones Methods rnf :: Comment -> () #
Eq Comment Source #
Instance details Defined in PowerDNS.API.Zones Methods (==) :: Comment -> Comment -> Bool # (/=) :: Comment -> Comment -> Bool #
Ord Comment Source #
Instance details 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 #
Empty Comment Source #
Instance details Defined in PowerDNS.API.Zones Methods empty :: Comment Source #
type Rep Comment Source #
Instance details Defined in PowerDNS.API.Zones type Rep Comment = D1 ('MetaData "Comment" "PowerDNS.API.Zones" "powerdns-0.4.3-inplace" '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 "comment_modified_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe POSIXTime)))))

data ChangeType Source #

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

Instances details

FromJSON ChangeType Source #
Instance details Defined in PowerDNS.API.Zones Methods parseJSON :: Value -> Parser ChangeType parseJSONList :: Value -> Parser [ChangeType]
ToJSON ChangeType Source #
Instance details Defined in PowerDNS.API.Zones Methods toJSON :: ChangeType -> Value toEncoding :: ChangeType -> Encoding toJSONList :: [ChangeType] -> Value toEncodingList :: [ChangeType] -> Encoding
Data ChangeType Source #
Instance details 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 #
Generic ChangeType Source #
Instance details Defined in PowerDNS.API.Zones Associated Types type Rep ChangeType :: Type -> Type # Methods from :: ChangeType -> Rep ChangeType x # to :: Rep ChangeType x -> ChangeType #
Show ChangeType Source #
Instance details Defined in PowerDNS.API.Zones Methods showsPrec :: Int -> ChangeType -> ShowS # show :: ChangeType -> String # showList :: [ChangeType] -> ShowS #
NFData ChangeType Source #
Instance details Defined in PowerDNS.API.Zones Methods rnf :: ChangeType -> () #
Eq ChangeType Source #
Instance details Defined in PowerDNS.API.Zones Methods (==) :: ChangeType -> ChangeType -> Bool # (/=) :: ChangeType -> ChangeType -> Bool #
Ord ChangeType Source #
Instance details 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 #
type Rep ChangeType Source #
Instance details Defined in PowerDNS.API.Zones type Rep ChangeType = D1 ('MetaData "ChangeType" "PowerDNS.API.Zones" "powerdns-0.4.3-inplace" 'False) (C1 ('MetaCons "Replace" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Delete" 'PrefixI 'False) (U1 :: Type -> Type))

data RecordType Source #

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

Instances details

FromJSON RecordType Source #
Instance details Defined in PowerDNS.API.Zones Methods parseJSON :: Value -> Parser RecordType parseJSONList :: Value -> Parser [RecordType]
ToJSON RecordType Source #
Instance details Defined in PowerDNS.API.Zones Methods toJSON :: RecordType -> Value toEncoding :: RecordType -> Encoding toJSONList :: [RecordType] -> Value toEncodingList :: [RecordType] -> Encoding
Data RecordType Source #
Instance details 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 #
Generic RecordType Source #
Instance details Defined in PowerDNS.API.Zones Associated Types type Rep RecordType :: Type -> Type # Methods from :: RecordType -> Rep RecordType x # to :: Rep RecordType x -> RecordType #
Show RecordType Source #
Instance details Defined in PowerDNS.API.Zones Methods showsPrec :: Int -> RecordType -> ShowS # show :: RecordType -> String # showList :: [RecordType] -> ShowS #
NFData RecordType Source #
Instance details Defined in PowerDNS.API.Zones Methods rnf :: RecordType -> () #
Eq RecordType Source #
Instance details Defined in PowerDNS.API.Zones Methods (==) :: RecordType -> RecordType -> Bool # (/=) :: RecordType -> RecordType -> Bool #
Ord RecordType Source #
Instance details 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 #
type Rep RecordType Source #
Instance details Defined in PowerDNS.API.Zones type Rep RecordType = D1 ('MetaData "RecordType" "PowerDNS.API.Zones" "powerdns-0.4.3-inplace" '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)))))))

newtype Result Source #

A simple newtype wrapper, because the original PowerDNS API encodes some textual result types more equal than others.

Constructors

Result Text

Instances

Instances details

FromJSON Result Source #
Instance details Defined in PowerDNS.API.Zones Methods parseJSON :: Value -> Parser Result parseJSONList :: Value -> Parser [Result]
ToJSON Result Source #
Instance details Defined in PowerDNS.API.Zones Methods toJSON :: Result -> Value toEncoding :: Result -> Encoding toJSONList :: [Result] -> Value toEncodingList :: [Result] -> Encoding

Cryptokeys

See documentation at PowerDNS Cryptokeys API

listCryptoKeys Source #

Arguments

:: Text	Server name
-> Text	Zone ID
-> ClientM [Cryptokey]

List all crypto keys. See Cryptokeys API Documentation

createCryptokey Source #

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 Source #

Arguments

:: Text	Server name
-> Text	Zone ID
-> Text	Cryptokey ID
-> ClientM Cryptokey

Get existing crypto key. See Cryptokeys API Documentation

updateCryptokey Source #

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 Source #

Arguments

:: Text	Server name
-> Text	Zone ID
-> Text	Cryptokey ID
-> ClientM NoContent

Delete existing crypto key. See Cryptokeys API Documentation

Data types

data Cryptokey Source #

Instances

Instances details

FromJSON Cryptokey Source #
Instance details Defined in PowerDNS.API.Cryptokeys Methods parseJSON :: Value -> Parser Cryptokey parseJSONList :: Value -> Parser [Cryptokey]
ToJSON Cryptokey Source #
Instance details Defined in PowerDNS.API.Cryptokeys Methods toJSON :: Cryptokey -> Value toEncoding :: Cryptokey -> Encoding toJSONList :: [Cryptokey] -> Value toEncodingList :: [Cryptokey] -> Encoding
Data Cryptokey Source #
Instance details 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 #
Generic Cryptokey Source #
Instance details Defined in PowerDNS.API.Cryptokeys Associated Types type Rep Cryptokey :: Type -> Type # Methods from :: Cryptokey -> Rep Cryptokey x # to :: Rep Cryptokey x -> Cryptokey #
Show Cryptokey Source #
Instance details Defined in PowerDNS.API.Cryptokeys Methods showsPrec :: Int -> Cryptokey -> ShowS # show :: Cryptokey -> String # showList :: [Cryptokey] -> ShowS #
NFData Cryptokey Source #
Instance details Defined in PowerDNS.API.Cryptokeys Methods rnf :: Cryptokey -> () #
Eq Cryptokey Source #
Instance details Defined in PowerDNS.API.Cryptokeys Methods (==) :: Cryptokey -> Cryptokey -> Bool # (/=) :: Cryptokey -> Cryptokey -> Bool #
Ord Cryptokey Source #
Instance details 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 #
Empty Cryptokey Source #
Instance details Defined in PowerDNS.API.Cryptokeys Methods empty :: Cryptokey Source #
type Rep Cryptokey Source #
Instance details Defined in PowerDNS.API.Cryptokeys type Rep Cryptokey = D1 ('MetaData "Cryptokey" "PowerDNS.API.Cryptokeys" "powerdns-0.4.3-inplace" '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] Source #

List available servers. See Servers API Documentation

getServer Source #

Arguments

:: Text	Server ID
-> ClientM Server

Get existing server. See Servers API Documentation

search Source #

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 Source #

Arguments

:: Text	Server ID
-> Text	Domain
-> ClientM CacheFlushResult

Flushes a domain from the cache. See Cache API Documentation

statistics Source #

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 Source #

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

Instances details

FromJSON Server Source #
Instance details Defined in PowerDNS.API.Servers Methods parseJSON :: Value -> Parser Server parseJSONList :: Value -> Parser [Server]
ToJSON Server Source #
Instance details Defined in PowerDNS.API.Servers Methods toJSON :: Server -> Value toEncoding :: Server -> Encoding toJSONList :: [Server] -> Value toEncodingList :: [Server] -> Encoding
Data Server Source #
Instance details 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 #
Generic Server Source #
Instance details Defined in PowerDNS.API.Servers Associated Types type Rep Server :: Type -> Type # Methods from :: Server -> Rep Server x # to :: Rep Server x -> Server #
Show Server Source #
Instance details Defined in PowerDNS.API.Servers Methods showsPrec :: Int -> Server -> ShowS # show :: Server -> String # showList :: [Server] -> ShowS #
NFData Server Source #
Instance details Defined in PowerDNS.API.Servers Methods rnf :: Server -> () #
Eq Server Source #
Instance details Defined in PowerDNS.API.Servers Methods (==) :: Server -> Server -> Bool # (/=) :: Server -> Server -> Bool #
Ord Server Source #
Instance details 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 #
Empty Server Source #
Instance details Defined in PowerDNS.API.Servers Methods empty :: Server Source #
type Rep Server Source #
Instance details Defined in PowerDNS.API.Servers type Rep Server = D1 ('MetaData "Server" "PowerDNS.API.Servers" "powerdns-0.4.3-inplace" '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 Source #

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

Instances details

FromJSON SearchResult Source #
Instance details Defined in PowerDNS.API.Servers Methods parseJSON :: Value -> Parser SearchResult parseJSONList :: Value -> Parser [SearchResult]
ToJSON SearchResult Source #
Instance details Defined in PowerDNS.API.Servers Methods toJSON :: SearchResult -> Value toEncoding :: SearchResult -> Encoding toJSONList :: [SearchResult] -> Value toEncodingList :: [SearchResult] -> Encoding
Data SearchResult Source #
Instance details 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 #
Generic SearchResult Source #
Instance details Defined in PowerDNS.API.Servers Associated Types type Rep SearchResult :: Type -> Type # Methods from :: SearchResult -> Rep SearchResult x # to :: Rep SearchResult x -> SearchResult #
Show SearchResult Source #
Instance details Defined in PowerDNS.API.Servers Methods showsPrec :: Int -> SearchResult -> ShowS # show :: SearchResult -> String # showList :: [SearchResult] -> ShowS #
NFData SearchResult Source #
Instance details Defined in PowerDNS.API.Servers Methods rnf :: SearchResult -> () #
Eq SearchResult Source #
Instance details Defined in PowerDNS.API.Servers Methods (==) :: SearchResult -> SearchResult -> Bool # (/=) :: SearchResult -> SearchResult -> Bool #
Ord SearchResult Source #
Instance details 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 #
type Rep SearchResult Source #
Instance details Defined in PowerDNS.API.Servers type Rep SearchResult = D1 ('MetaData "SearchResult" "PowerDNS.API.Servers" "powerdns-0.4.3-inplace" '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 Source #

Constructors

TyAll
TyZone
TyRecord
TyComment

Instances

Instances details

FromJSON ObjectType Source #
Instance details Defined in PowerDNS.API.Servers Methods parseJSON :: Value -> Parser ObjectType parseJSONList :: Value -> Parser [ObjectType]
ToJSON ObjectType Source #
Instance details Defined in PowerDNS.API.Servers Methods toJSON :: ObjectType -> Value toEncoding :: ObjectType -> Encoding toJSONList :: [ObjectType] -> Value toEncodingList :: [ObjectType] -> Encoding
Data ObjectType Source #
Instance details 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 #
Generic ObjectType Source #
Instance details Defined in PowerDNS.API.Servers Associated Types type Rep ObjectType :: Type -> Type # Methods from :: ObjectType -> Rep ObjectType x # to :: Rep ObjectType x -> ObjectType #
Show ObjectType Source #
Instance details Defined in PowerDNS.API.Servers Methods showsPrec :: Int -> ObjectType -> ShowS # show :: ObjectType -> String # showList :: [ObjectType] -> ShowS #
NFData ObjectType Source #
Instance details Defined in PowerDNS.API.Servers Methods rnf :: ObjectType -> () #
Eq ObjectType Source #
Instance details Defined in PowerDNS.API.Servers Methods (==) :: ObjectType -> ObjectType -> Bool # (/=) :: ObjectType -> ObjectType -> Bool #
Ord ObjectType Source #
Instance details 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 #
FromHttpApiData ObjectType Source #
Instance details Defined in PowerDNS.API.Servers Methods parseUrlPiece :: Text -> Either Text ObjectType # parseHeader :: ByteString -> Either Text ObjectType # parseQueryParam :: Text -> Either Text ObjectType #
ToHttpApiData ObjectType Source #
Instance details Defined in PowerDNS.API.Servers Methods toUrlPiece :: ObjectType -> Text # toEncodedUrlPiece :: ObjectType -> Builder # toHeader :: ObjectType -> ByteString # toQueryParam :: ObjectType -> Text # toEncodedQueryParam :: ObjectType -> Builder #
type Rep ObjectType Source #
Instance details Defined in PowerDNS.API.Servers type Rep ObjectType = D1 ('MetaData "ObjectType" "PowerDNS.API.Servers" "powerdns-0.4.3-inplace" '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 Source #

Constructors

CacheFlushResult
Fields cfr_count :: Integer cfr_result :: Text

Instances

Instances details

FromJSON CacheFlushResult Source #
Instance details Defined in PowerDNS.API.Servers Methods parseJSON :: Value -> Parser CacheFlushResult parseJSONList :: Value -> Parser [CacheFlushResult]
ToJSON CacheFlushResult Source #
Instance details Defined in PowerDNS.API.Servers Methods toJSON :: CacheFlushResult -> Value toEncoding :: CacheFlushResult -> Encoding toJSONList :: [CacheFlushResult] -> Value toEncodingList :: [CacheFlushResult] -> Encoding
Data CacheFlushResult Source #
Instance details 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 #
Generic CacheFlushResult Source #
Instance details Defined in PowerDNS.API.Servers Associated Types type Rep CacheFlushResult :: Type -> Type # Methods from :: CacheFlushResult -> Rep CacheFlushResult x # to :: Rep CacheFlushResult x -> CacheFlushResult #
Show CacheFlushResult Source #
Instance details Defined in PowerDNS.API.Servers Methods showsPrec :: Int -> CacheFlushResult -> ShowS # show :: CacheFlushResult -> String # showList :: [CacheFlushResult] -> ShowS #
NFData CacheFlushResult Source #
Instance details Defined in PowerDNS.API.Servers Methods rnf :: CacheFlushResult -> () #
Eq CacheFlushResult Source #
Instance details Defined in PowerDNS.API.Servers Methods (==) :: CacheFlushResult -> CacheFlushResult -> Bool # (/=) :: CacheFlushResult -> CacheFlushResult -> Bool #
Ord CacheFlushResult Source #
Instance details 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 #
type Rep CacheFlushResult Source #
Instance details Defined in PowerDNS.API.Servers type Rep CacheFlushResult = D1 ('MetaData "CacheFlushResult" "PowerDNS.API.Servers" "powerdns-0.4.3-inplace" '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 Source #

Arguments

:: Text	Server ID
-> Text	Zone ID
-> ClientM [Metadata]

List metadata for existing zone. See Metadata API Documentation

createMetadata Source #

Arguments

:: Text	Server ID
-> Text	Zone ID
-> Metadata
-> ClientM NoContent

Create metadata for zone. See Metadata API Documentation

getMetadata Source #

Arguments

:: Text	Server ID
-> Text	Zone ID
-> Text	Kind
-> ClientM Metadata

Get metadata for zone by kind. See Metadata API Documentation

updateMetadata Source #

Arguments

:: Text	Server ID
-> Text	Zone ID
-> Text	Kind
-> Metadata
-> ClientM Metadata

Update metadata for zone by kind. See Metadata API Documentation

deleteMetadata Source #

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 Source #

Constructors

Metadata
Fields md_kind :: Text md_metadata :: [Text]

Instances

Instances details

FromJSON Metadata Source #
Instance details Defined in PowerDNS.API.Metadata Methods parseJSON :: Value -> Parser Metadata parseJSONList :: Value -> Parser [Metadata]
ToJSON Metadata Source #
Instance details Defined in PowerDNS.API.Metadata Methods toJSON :: Metadata -> Value toEncoding :: Metadata -> Encoding toJSONList :: [Metadata] -> Value toEncodingList :: [Metadata] -> Encoding
Data Metadata Source #
Instance details 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 #
Generic Metadata Source #
Instance details Defined in PowerDNS.API.Metadata Associated Types type Rep Metadata :: Type -> Type # Methods from :: Metadata -> Rep Metadata x # to :: Rep Metadata x -> Metadata #
Show Metadata Source #
Instance details Defined in PowerDNS.API.Metadata Methods showsPrec :: Int -> Metadata -> ShowS # show :: Metadata -> String # showList :: [Metadata] -> ShowS #
NFData Metadata Source #
Instance details Defined in PowerDNS.API.Metadata Methods rnf :: Metadata -> () #
Eq Metadata Source #
Instance details Defined in PowerDNS.API.Metadata Methods (==) :: Metadata -> Metadata -> Bool # (/=) :: Metadata -> Metadata -> Bool #
Ord Metadata Source #
Instance details 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 #
type Rep Metadata Source #
Instance details Defined in PowerDNS.API.Metadata type Rep Metadata = D1 ('MetaData "Metadata" "PowerDNS.API.Metadata" "powerdns-0.4.3-inplace" '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] Source #

List all TSIG keys. See TSIGKeys API Documentation

createTSIGKey :: Text -> TSIGKey -> ClientM TSIGKey Source #

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 Source #

Get TSIG key by its id. See TSIGKeys API Documentation

updateTSIGKey :: Text -> Text -> TSIGKey -> ClientM TSIGKey Source #

Update existig TSIG key. See TSIGKeys API Documentation

deleteTSIGKey :: Text -> Text -> ClientM NoContent Source #

Delete existing TSIG key. See TSIGKeys API Documentation

Data types

data TSIGKey Source #

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

Instances details

FromJSON TSIGKey Source #
Instance details Defined in PowerDNS.API.TSIGKeys Methods parseJSON :: Value -> Parser TSIGKey parseJSONList :: Value -> Parser [TSIGKey]
ToJSON TSIGKey Source #
Instance details Defined in PowerDNS.API.TSIGKeys Methods toJSON :: TSIGKey -> Value toEncoding :: TSIGKey -> Encoding toJSONList :: [TSIGKey] -> Value toEncodingList :: [TSIGKey] -> Encoding
Data TSIGKey Source #
Instance details 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 #
Generic TSIGKey Source #
Instance details Defined in PowerDNS.API.TSIGKeys Associated Types type Rep TSIGKey :: Type -> Type # Methods from :: TSIGKey -> Rep TSIGKey x # to :: Rep TSIGKey x -> TSIGKey #
Show TSIGKey Source #
Instance details Defined in PowerDNS.API.TSIGKeys Methods showsPrec :: Int -> TSIGKey -> ShowS # show :: TSIGKey -> String # showList :: [TSIGKey] -> ShowS #
NFData TSIGKey Source #
Instance details Defined in PowerDNS.API.TSIGKeys Methods rnf :: TSIGKey -> () #
Eq TSIGKey Source #
Instance details Defined in PowerDNS.API.TSIGKeys Methods (==) :: TSIGKey -> TSIGKey -> Bool # (/=) :: TSIGKey -> TSIGKey -> Bool #
Ord TSIGKey Source #
Instance details 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 #
type Rep TSIGKey Source #
Instance details Defined in PowerDNS.API.TSIGKeys type Rep TSIGKey = D1 ('MetaData "TSIGKey" "PowerDNS.API.TSIGKeys" "powerdns-0.4.3-inplace" '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 Source #

Supported algorithms according to PowerDNS TSIG Documentation

Constructors

HMAC_MD5
HMAC_SHA1
HMAC_SHA224
HMAC_SHA256
HMAC_SHA384
HMAC_SHA512

Instances

Instances details

FromJSON TSIGAlgorithm Source #
Instance details Defined in PowerDNS.API.TSIGKeys Methods parseJSON :: Value -> Parser TSIGAlgorithm parseJSONList :: Value -> Parser [TSIGAlgorithm]
ToJSON TSIGAlgorithm Source #
Instance details Defined in PowerDNS.API.TSIGKeys Methods toJSON :: TSIGAlgorithm -> Value toEncoding :: TSIGAlgorithm -> Encoding toJSONList :: [TSIGAlgorithm] -> Value toEncodingList :: [TSIGAlgorithm] -> Encoding
Data TSIGAlgorithm Source #
Instance details 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 #
Generic TSIGAlgorithm Source #
Instance details Defined in PowerDNS.API.TSIGKeys Associated Types type Rep TSIGAlgorithm :: Type -> Type # Methods from :: TSIGAlgorithm -> Rep TSIGAlgorithm x # to :: Rep TSIGAlgorithm x -> TSIGAlgorithm #
Show TSIGAlgorithm Source #
Instance details Defined in PowerDNS.API.TSIGKeys Methods showsPrec :: Int -> TSIGAlgorithm -> ShowS # show :: TSIGAlgorithm -> String # showList :: [TSIGAlgorithm] -> ShowS #
NFData TSIGAlgorithm Source #
Instance details Defined in PowerDNS.API.TSIGKeys Methods rnf :: TSIGAlgorithm -> () #
Eq TSIGAlgorithm Source #
Instance details Defined in PowerDNS.API.TSIGKeys Methods (==) :: TSIGAlgorithm -> TSIGAlgorithm -> Bool # (/=) :: TSIGAlgorithm -> TSIGAlgorithm -> Bool #
Ord TSIGAlgorithm Source #
Instance details 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 #
type Rep TSIGAlgorithm Source #
Instance details Defined in PowerDNS.API.TSIGKeys type Rep TSIGAlgorithm = D1 ('MetaData "TSIGAlgorithm" "PowerDNS.API.TSIGKeys" "powerdns-0.4.3-inplace" '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 Source #

Produce an empty value