Safe Haskell	Safe-Inferred
Language	Haskell2010

Hetzner.DNS

Contents

Tokens
Hetzner DNS
- Zones
- Records
Exceptions
Streaming
Generic interface

Description

Client for the Hetzner DNS API.

Synopsis

newtype Token = Token ByteString
getTokenFromEnv :: IO (Maybe Token)
newtype ZoneID = ZoneID Text
data ZoneStatus
- = Verified
- | Failed
- | Pending
data Zone = Zone {
- zoneCreated :: ZonedTime
- zoneModified :: ZonedTime
- zoneID :: ZoneID
- zoneName :: Text
- zoneIsSecondary :: Bool
- zoneStatus :: ZoneStatus
- zoneRecordCount :: Int
- zoneTTL :: Int
}
getZones :: Token -> Maybe Int -> IO (WithMeta "zones" [Zone])
getZone :: Token -> ZoneID -> IO Zone
updateZone :: Token -> ZoneID -> Text -> Maybe Int -> IO Zone
deleteZone :: Token -> ZoneID -> IO ()
newtype RecordID = RecordID Text
data RecordType
- = A
- | AAAA
- | CAA
- | CNAME
- | DANE
- | DS
- | HINFO
- | MX
- | NS
- | PTR
- | RP
- | SOA
- | SRV
- | TLS
- | TXT
allRecordTypes :: [RecordType]
data Record = Record {
- recordCreated :: ZonedTime
- recordModified :: ZonedTime
- recordID :: RecordID
- recordName :: Text
- recordType :: RecordType
- recordValue :: Text
- recordTTL :: Int
- recordZone :: ZoneID
}
getRecords :: Token -> Maybe ZoneID -> IO [Record]
getRecord :: Token -> RecordID -> IO Record
createRecord :: Token -> ZoneID -> Text -> RecordType -> Text -> Maybe Int -> IO Record
updateRecord :: Token -> RecordID -> ZoneID -> Text -> RecordType -> Text -> Maybe Int -> IO Record
deleteRecord :: Token -> RecordID -> IO ()
data DNSException
- = DNSError (Response ByteString)
- | JSONError (Response ByteString) String
streamPages :: forall key f a i m. (Foldable f, MonadIO m) => (Maybe Int -> IO (WithMeta key (f a))) -> ConduitT i a m ()
streamToList :: Monad m => ConduitT () a m () -> m [a]
dnsQuery :: (ToJSON body, FromJSON a) => ByteString -> ByteString -> Maybe body -> Query -> Token -> Maybe Int -> IO a
noBody :: Maybe Void
data WithKey (key :: Symbol) a = WithKey {
- withoutKey :: a
}
data WithMeta (key :: Symbol) a = WithMeta {
- responseMeta :: ResponseMeta
- withoutMeta :: a
}
data ResponseMeta = ResponseMeta {
- pagination :: Pagination
}
data Pagination = Pagination {
- currentPage :: Int
- itemsPerPage :: Int
- previousPage :: Maybe Int
- nextPage :: Maybe Int
- lastPage :: Maybe Int
- totalEntries :: Maybe Int
}

Tokens

newtype Token Source #

A token used to authenticate requests.

You can create one in the Hetzner DNS Console.

Constructors

Token ByteString

Instances

Instances details

IsString Token Source #
Instance details Defined in Hetzner.DNS Methods fromString :: String -> Token #
Show Token Source #
Instance details Defined in Hetzner.DNS Methods showsPrec :: Int -> Token -> ShowS # show :: Token -> String # showList :: [Token] -> ShowS #
Eq Token Source #
Instance details Defined in Hetzner.DNS Methods (==) :: Token -> Token -> Bool # (/=) :: Token -> Token -> Bool #
Ord Token Source #
Instance details Defined in Hetzner.DNS Methods compare :: Token -> Token -> Ordering # (<) :: Token -> Token -> Bool # (<=) :: Token -> Token -> Bool # (>) :: Token -> Token -> Bool # (>=) :: Token -> Token -> Bool # max :: Token -> Token -> Token # min :: Token -> Token -> Token #

getTokenFromEnv :: IO (Maybe Token) Source #

Lookup Token from the environment variable HETZNER_DNS_TOKEN.

Hetzner DNS

Zones

newtype ZoneID Source #

Zone identifier.

Constructors

ZoneID Text

Instances

Instances details

FromJSON ZoneID Source #
Instance details Defined in Hetzner.DNS Methods parseJSON :: Value -> Parser ZoneID # parseJSONList :: Value -> Parser [ZoneID] #
ToJSON ZoneID Source #
Instance details Defined in Hetzner.DNS Methods toJSON :: ZoneID -> Value # toEncoding :: ZoneID -> Encoding # toJSONList :: [ZoneID] -> Value # toEncodingList :: [ZoneID] -> Encoding #
Show ZoneID Source #
Instance details Defined in Hetzner.DNS Methods showsPrec :: Int -> ZoneID -> ShowS # show :: ZoneID -> String # showList :: [ZoneID] -> ShowS #
Eq ZoneID Source #
Instance details Defined in Hetzner.DNS Methods (==) :: ZoneID -> ZoneID -> Bool # (/=) :: ZoneID -> ZoneID -> Bool #
Ord ZoneID Source #
Instance details Defined in Hetzner.DNS Methods compare :: ZoneID -> ZoneID -> Ordering # (<) :: ZoneID -> ZoneID -> Bool # (<=) :: ZoneID -> ZoneID -> Bool # (>) :: ZoneID -> ZoneID -> Bool # (>=) :: ZoneID -> ZoneID -> Bool # max :: ZoneID -> ZoneID -> ZoneID # min :: ZoneID -> ZoneID -> ZoneID #

data ZoneStatus Source #

Status of a Zone.

Constructors

Verified
Failed
Pending

Instances

Instances details

FromJSON ZoneStatus Source #
Instance details Defined in Hetzner.DNS Methods parseJSON :: Value -> Parser ZoneStatus # parseJSONList :: Value -> Parser [ZoneStatus] #
Show ZoneStatus Source #
Instance details Defined in Hetzner.DNS Methods showsPrec :: Int -> ZoneStatus -> ShowS # show :: ZoneStatus -> String # showList :: [ZoneStatus] -> ShowS #

data Zone Source #

DNS zone.

Constructors

Zone
Fields zoneCreated :: ZonedTime zoneModified :: ZonedTime zoneID :: ZoneID zoneName :: Text zoneIsSecondary :: Bool zoneStatus :: ZoneStatus zoneRecordCount :: Int zoneTTL :: Int

Instances

Instances details

FromJSON Zone Source #
Instance details Defined in Hetzner.DNS Methods parseJSON :: Value -> Parser Zone # parseJSONList :: Value -> Parser [Zone] #
Show Zone Source #
Instance details Defined in Hetzner.DNS Methods showsPrec :: Int -> Zone -> ShowS # show :: Zone -> String # showList :: [Zone] -> ShowS #

getZones :: Token -> Maybe Int -> IO (WithMeta "zones" [Zone]) Source #

Get zones.

getZone :: Token -> ZoneID -> IO Zone Source #

Get a single zone.

updateZone Source #

Arguments

:: Token
-> ZoneID	ID of zone to update.
-> Text	New zone name.
-> Maybe Int	New TTL. If not provided, it won't change.
-> IO Zone

Update a zone's name and TTL.

deleteZone :: Token -> ZoneID -> IO () Source #

Delete a zone.

Records

newtype RecordID Source #

A record identifier.

Constructors

RecordID Text

Instances

Instances details

FromJSON RecordID Source #
Instance details Defined in Hetzner.DNS Methods parseJSON :: Value -> Parser RecordID # parseJSONList :: Value -> Parser [RecordID] #
ToJSON RecordID Source #
Instance details Defined in Hetzner.DNS Methods toJSON :: RecordID -> Value # toEncoding :: RecordID -> Encoding # toJSONList :: [RecordID] -> Value # toEncodingList :: [RecordID] -> Encoding #
Show RecordID Source #
Instance details Defined in Hetzner.DNS Methods showsPrec :: Int -> RecordID -> ShowS # show :: RecordID -> String # showList :: [RecordID] -> ShowS #
Eq RecordID Source #
Instance details Defined in Hetzner.DNS Methods (==) :: RecordID -> RecordID -> Bool # (/=) :: RecordID -> RecordID -> Bool #
Ord RecordID Source #
Instance details Defined in Hetzner.DNS Methods compare :: RecordID -> RecordID -> Ordering # (<) :: RecordID -> RecordID -> Bool # (<=) :: RecordID -> RecordID -> Bool # (>) :: RecordID -> RecordID -> Bool # (>=) :: RecordID -> RecordID -> Bool # max :: RecordID -> RecordID -> RecordID # min :: RecordID -> RecordID -> RecordID #

data RecordType Source #

Record type.

Constructors

A
AAAA
CAA
CNAME
DANE
DS
HINFO
MX
NS
PTR
RP
SOA
SRV
TLS
TXT

Instances

Instances details

FromJSON RecordType Source #
Instance details Defined in Hetzner.DNS Methods parseJSON :: Value -> Parser RecordType # parseJSONList :: Value -> Parser [RecordType] #
ToJSON RecordType Source #
Instance details Defined in Hetzner.DNS Methods toJSON :: RecordType -> Value # toEncoding :: RecordType -> Encoding # toJSONList :: [RecordType] -> Value # toEncodingList :: [RecordType] -> Encoding #
Enum RecordType Source #
Instance details Defined in Hetzner.DNS Methods succ :: RecordType -> RecordType # pred :: RecordType -> RecordType # toEnum :: Int -> RecordType # fromEnum :: RecordType -> Int # enumFrom :: RecordType -> [RecordType] # enumFromThen :: RecordType -> RecordType -> [RecordType] # enumFromTo :: RecordType -> RecordType -> [RecordType] # enumFromThenTo :: RecordType -> RecordType -> RecordType -> [RecordType] #
Show RecordType Source #
Instance details Defined in Hetzner.DNS Methods showsPrec :: Int -> RecordType -> ShowS # show :: RecordType -> String # showList :: [RecordType] -> ShowS #
Eq RecordType Source #
Instance details Defined in Hetzner.DNS Methods (==) :: RecordType -> RecordType -> Bool # (/=) :: RecordType -> RecordType -> Bool #

allRecordTypes :: [RecordType] Source #

List with all supported record types.

data Record Source #

A DNS record.

Constructors

Record
Fields recordCreated :: ZonedTime recordModified :: ZonedTime recordID :: RecordID recordName :: Text recordType :: RecordType recordValue :: Text recordTTL :: Int recordZone :: ZoneID ID of the zone this record is associated with.

Instances

Instances details

FromJSON Record Source #
Instance details Defined in Hetzner.DNS Methods parseJSON :: Value -> Parser Record # parseJSONList :: Value -> Parser [Record] #
Show Record Source #
Instance details Defined in Hetzner.DNS Methods showsPrec :: Int -> Record -> ShowS # show :: Record -> String # showList :: [Record] -> ShowS #

getRecords Source #

Arguments

:: Token
-> Maybe ZoneID	Optionally filter by zone.
-> IO [Record]

Get DNS records.

getRecord :: Token -> RecordID -> IO Record Source #

Get a single DNS record.

createRecord Source #

Arguments

:: Token
-> ZoneID	Zone to add the record to.
-> Text	Record name.
-> RecordType	Record type.
-> Text	Record value.
-> Maybe Int	Optional TTL.
-> IO Record

Create a DNS record.

updateRecord Source #

Arguments

:: Token
-> RecordID	Record to update.
-> ZoneID	Zone for the record.
-> Text	New record name.
-> RecordType	New recored type.
-> Text	New record value.
-> Maybe Int	Optinally, a new TTL.
-> IO Record

Update a DNS record.

deleteRecord :: Token -> RecordID -> IO () Source #

Delete a DNS record.

Exceptions

data DNSException Source #

Exception produced while performing a request to Hetzner DNS.

Constructors

DNSError (Response ByteString)
JSONError (Response ByteString) String

Instances

Instances details

Exception DNSException Source #
Instance details Defined in Hetzner.DNS Methods toException :: DNSException -> SomeException # fromException :: SomeException -> Maybe DNSException # displayException :: DNSException -> String #
Show DNSException Source #
Instance details Defined in Hetzner.DNS Methods showsPrec :: Int -> DNSException -> ShowS # show :: DNSException -> String # showList :: [DNSException] -> ShowS #

Streaming

streamPages Source #

Arguments

:: forall key f a i m. (Foldable f, MonadIO m)
=> (Maybe Int -> IO (WithMeta key (f a)))	Function that takes page number and returns result.
-> ConduitT i a m ()	Conduit-based stream that yields results downstream.

Stream results using a function that takes a page number, going through all the pages.

streamToList :: Monad m => ConduitT () a m () -> m [a] Source #

Convenient function to turn streams into lists.

Generic interface

Generic queries

dnsQuery Source #

Arguments

:: (ToJSON body, FromJSON a)
=> ByteString	Method.
-> ByteString	Path.
-> Maybe body	Request body. You may use `noBody` to skip.
-> Query	Additional query options.
-> Token	Authorization token.
-> Maybe Int	Page.
-> IO a

Generic Hetzner DNS query.

noBody :: Maybe Void Source #

Used to send requests without a body.

JSON Wrappers

data WithKey (key :: Symbol) a Source #

Wrap a value with the key of the value within a JSON object.

Constructors

WithKey
Fields withoutKey :: a

Instances

Instances details

Foldable (WithKey key) Source #
Instance details Defined in Hetzner.Cloud Methods fold :: Monoid m => WithKey key m -> m # foldMap :: Monoid m => (a -> m) -> WithKey key a -> m # foldMap' :: Monoid m => (a -> m) -> WithKey key a -> m # foldr :: (a -> b -> b) -> b -> WithKey key a -> b # foldr' :: (a -> b -> b) -> b -> WithKey key a -> b # foldl :: (b -> a -> b) -> b -> WithKey key a -> b # foldl' :: (b -> a -> b) -> b -> WithKey key a -> b # foldr1 :: (a -> a -> a) -> WithKey key a -> a # foldl1 :: (a -> a -> a) -> WithKey key a -> a # toList :: WithKey key a -> [a] # null :: WithKey key a -> Bool # length :: WithKey key a -> Int # elem :: Eq a => a -> WithKey key a -> Bool # maximum :: Ord a => WithKey key a -> a # minimum :: Ord a => WithKey key a -> a # sum :: Num a => WithKey key a -> a # product :: Num a => WithKey key a -> a #
Functor (WithKey key) Source #
Instance details Defined in Hetzner.Cloud Methods fmap :: (a -> b) -> WithKey key a -> WithKey key b # (<$) :: a -> WithKey key b -> WithKey key a #
(KnownSymbol key, FromJSON a) => FromJSON (WithKey key a) Source #
Instance details Defined in Hetzner.Cloud Methods parseJSON :: Value -> Parser (WithKey key a) # parseJSONList :: Value -> Parser [WithKey key a] #
Show a => Show (WithKey key a) Source #
Instance details Defined in Hetzner.Cloud Methods showsPrec :: Int -> WithKey key a -> ShowS # show :: WithKey key a -> String # showList :: [WithKey key a] -> ShowS #

data WithMeta (key :: Symbol) a Source #

A value together with response metadata. The type is annotated with the JSON key of the value.

Constructors

WithMeta
Fields responseMeta :: ResponseMeta Response metadata. withoutMeta :: a The value alone, without the metadata.

Instances

Instances details

Foldable (WithMeta key) Source #
Instance details Defined in Hetzner.Cloud Methods fold :: Monoid m => WithMeta key m -> m # foldMap :: Monoid m => (a -> m) -> WithMeta key a -> m # foldMap' :: Monoid m => (a -> m) -> WithMeta key a -> m # foldr :: (a -> b -> b) -> b -> WithMeta key a -> b # foldr' :: (a -> b -> b) -> b -> WithMeta key a -> b # foldl :: (b -> a -> b) -> b -> WithMeta key a -> b # foldl' :: (b -> a -> b) -> b -> WithMeta key a -> b # foldr1 :: (a -> a -> a) -> WithMeta key a -> a # foldl1 :: (a -> a -> a) -> WithMeta key a -> a # toList :: WithMeta key a -> [a] # null :: WithMeta key a -> Bool # length :: WithMeta key a -> Int # elem :: Eq a => a -> WithMeta key a -> Bool # maximum :: Ord a => WithMeta key a -> a # minimum :: Ord a => WithMeta key a -> a # sum :: Num a => WithMeta key a -> a # product :: Num a => WithMeta key a -> a #
Functor (WithMeta key) Source #
Instance details Defined in Hetzner.Cloud Methods fmap :: (a -> b) -> WithMeta key a -> WithMeta key b # (<$) :: a -> WithMeta key b -> WithMeta key a #
(KnownSymbol key, FromJSON a) => FromJSON (WithMeta key a) Source #
Instance details Defined in Hetzner.Cloud Methods parseJSON :: Value -> Parser (WithMeta key a) # parseJSONList :: Value -> Parser [WithMeta key a] #
Show a => Show (WithMeta key a) Source #
Instance details Defined in Hetzner.Cloud Methods showsPrec :: Int -> WithMeta key a -> ShowS # show :: WithMeta key a -> String # showList :: [WithMeta key a] -> ShowS #

Response metadata

data ResponseMeta Source #

Metadata attached to a response.

Constructors

ResponseMeta
Fields pagination :: Pagination

Instances

Instances details

FromJSON ResponseMeta Source #
Instance details Defined in Hetzner.Cloud Methods parseJSON :: Value -> Parser ResponseMeta # parseJSONList :: Value -> Parser [ResponseMeta] #
Show ResponseMeta Source #
Instance details Defined in Hetzner.Cloud Methods showsPrec :: Int -> ResponseMeta -> ShowS # show :: ResponseMeta -> String # showList :: [ResponseMeta] -> ShowS #

data Pagination Source #

Pagination information.

Constructors

Pagination
Fields currentPage :: Int itemsPerPage :: Int previousPage :: Maybe Int nextPage :: Maybe Int lastPage :: Maybe Int totalEntries :: Maybe Int

FromJSON Pagination Source #
Instance details Defined in Hetzner.Cloud Methods parseJSON :: Value -> Parser Pagination # parseJSONList :: Value -> Parser [Pagination] #
Show Pagination Source #
Instance details Defined in Hetzner.Cloud Methods showsPrec :: Int -> Pagination -> ShowS # show :: Pagination -> String # showList :: [Pagination] -> ShowS #