Safe Haskell	None
Language	Haskell2010

PowerDNS.API.TSIGKeys

Contents

API
Data types

Description

Implementation of the API endpoints described at PowerDNS TSIGKeys API

Synopsis

data TSIGKeysAPI f = TSIGKeysAPI {
- apiListTSIGKeys :: f :- ("servers" :> (Capture "server_id" Text :> ("tsigkeys" :> Get '[JSON] [TSIGKey])))
- apiCreateTSIGKey :: f :- ("servers" :> (Capture "server_id" Text :> ("tsigkeys" :> (ReqBody '[JSON] TSIGKey :> PostCreated '[JSON] TSIGKey))))
- apiGetTSIGKey :: f :- ("servers" :> (Capture "server_id" Text :> ("tsigkeys" :> (Capture "tsigkey_id" Text :> Get '[JSON] TSIGKey))))
- apiUpdateTSIGKey :: f :- ("servers" :> (Capture "server_id" Text :> ("tsigkeys" :> (Capture "tsigkey_id" Text :> (ReqBody '[JSON] TSIGKey :> Put '[JSON] TSIGKey)))))
- apiDeleteTSIGKey :: f :- ("servers" :> (Capture "server_id" Text :> ("tsigkeys" :> (Capture "tsigkey_id" Text :> DeleteNoContent))))
}
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

API

data TSIGKeysAPI f Source #

Constructors

TSIGKeysAPI

Fields

apiListTSIGKeys :: f :- ("servers" :> (Capture "server_id" Text :> ("tsigkeys" :> Get '[JSON] [TSIGKey])))
apiCreateTSIGKey :: f :- ("servers" :> (Capture "server_id" Text :> ("tsigkeys" :> (ReqBody '[JSON] TSIGKey :> PostCreated '[JSON] TSIGKey))))
apiGetTSIGKey :: f :- ("servers" :> (Capture "server_id" Text :> ("tsigkeys" :> (Capture "tsigkey_id" Text :> Get '[JSON] TSIGKey))))
apiUpdateTSIGKey :: f :- ("servers" :> (Capture "server_id" Text :> ("tsigkeys" :> (Capture "tsigkey_id" Text :> (ReqBody '[JSON] TSIGKey :> Put '[JSON] TSIGKey)))))
apiDeleteTSIGKey :: f :- ("servers" :> (Capture "server_id" Text :> ("tsigkeys" :> (Capture "tsigkey_id" Text :> DeleteNoContent))))

Instances

Instances details

Generic (TSIGKeysAPI f) Source #
Instance details Defined in PowerDNS.API.TSIGKeys Associated Types type Rep (TSIGKeysAPI f) :: Type -> Type # Methods from :: TSIGKeysAPI f -> Rep (TSIGKeysAPI f) x # to :: Rep (TSIGKeysAPI f) x -> TSIGKeysAPI f #
type Rep (TSIGKeysAPI f) Source #
Instance details Defined in PowerDNS.API.TSIGKeys type Rep (TSIGKeysAPI f) = D1 ('MetaData "TSIGKeysAPI" "PowerDNS.API.TSIGKeys" "powerdns-0.2.0-KVEAOheVEexEs5OVtLI9gW" 'False) (C1 ('MetaCons "TSIGKeysAPI" 'PrefixI 'True) ((S1 ('MetaSel ('Just "apiListTSIGKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- ("servers" :> (Capture "server_id" Text :> ("tsigkeys" :> Get '[JSON] [TSIGKey]))))) :: S1 ('MetaSel ('Just "apiCreateTSIGKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- ("servers" :> (Capture "server_id" Text :> ("tsigkeys" :> (ReqBody '[JSON] TSIGKey :> PostCreated '[JSON] TSIGKey))))))) :: (S1 ('MetaSel ('Just "apiGetTSIGKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- ("servers" :> (Capture "server_id" Text :> ("tsigkeys" :> (Capture "tsigkey_id" Text :> Get '[JSON] TSIGKey)))))) :: (S1 ('MetaSel ('Just "apiUpdateTSIGKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- ("servers" :> (Capture "server_id" Text :> ("tsigkeys" :> (Capture "tsigkey_id" Text :> (ReqBody '[JSON] TSIGKey :> Put '[JSON] TSIGKey))))))) :: S1 ('MetaSel ('Just "apiDeleteTSIGKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- ("servers" :> (Capture "server_id" Text :> ("tsigkeys" :> (Capture "tsigkey_id" Text :> DeleteNoContent))))))))))

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

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

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