Safe Haskell	Safe-Inferred
Language	Haskell2010

Hetzner.Cloud

Contents

Tokens
Server metadata
Hetzner Cloud API
Exceptions
Labels
Other types
Streaming
Generic interface

Description

Hetzner Cloud API client.

More information can be found on the official documentation.

Although not necessary, this module was designed with qualified imports in mind. For example:

import qualified Hetzner.Cloud as Hetzner

Pagination

Some requests use pagination. These take a page argument of type Maybe Int. You can use streamPages to get all pages through a conduit-based stream. For example, to get all servers as a stream:

streamPages $ getServers token :: ConduitT i Server m ()

Or to get all actions as a stream:

streamPages $ getActions token :: ConduitT i Action m ()

If you are not interested in the streaming functionality, you can simply use streamToList to turn the stream into a list:

streamToList $ streamPages $ getServers token :: m [Server]

Exceptions

This library makes extensive use of exceptions. Exceptions from this module have type CloudException. All functions that perform requests to Hetzner Cloud can throw this type of exception.

Synopsis

newtype Token = Token ByteString
data Metadata = Metadata {
- metadataName :: Text
- metadataServerID :: ServerID
- metadataPublicIPv4 :: IPv4
- metadataDatacenter :: Text
- metadataRegion :: Region
}
getMetadata :: IO Metadata
data ActionStatus
- = ActionRunning Int
- | ActionSuccess ZonedTime
- | ActionError ZonedTime Error
data ActionCommand
- = CreateServer
- | DeleteServer
- | StartServer
- | StopServer
- | SetFirewallRules
- | ApplyFirewall
- | CreateVolume
- | AttachVolume
newtype ActionID = ActionID Int
data Action = Action {
- actionID :: ActionID
- actionCommand :: ActionCommand
- actionStatus :: ActionStatus
- actionStarted :: ZonedTime
- actionResources :: [ResourceID]
}
getActions :: Token -> Maybe Int -> IO (WithMeta "actions" [Action])
getAction :: Token -> ActionID -> IO Action
waitForAction :: Token -> ActionID -> IO ZonedTime
newtype DatacenterID = DatacenterID Int
data DatacenterServers = DatacenterServers {
- availableServers :: [ServerTypeID]
- migrationAvailableServers :: [ServerTypeID]
- supportedServers :: [ServerTypeID]
}
data Datacenter = Datacenter {
- datacenterID :: DatacenterID
- datacenterName :: Text
- datacenterDescription :: Text
- datacenterLocation :: Location
- datacenterServers :: DatacenterServers
}
data DatacentersWithRecommendation = DatacentersWithRecommendation {
- datacenters :: [Datacenter]
- datacenterRecommendation :: DatacenterID
}
getDatacenters :: Token -> IO DatacentersWithRecommendation
getDatacenter :: Token -> DatacenterID -> IO Datacenter
newtype FirewallID = FirewallID Int
newtype FloatingIPID = FloatingIPID Int
data OSFlavor
- = Ubuntu
- | CentOS
- | Debian
- | Fedora
- | Rocky
- | Alma
- | UnknownOS
data ImageType
- = SystemImage Text
- | AppImage
- | Snapshot Double
- | Backup ServerID
- | Temporary
newtype ImageID = ImageID Int
data Image = Image {
- imageCreated :: ZonedTime
- imageDeleted :: Maybe ZonedTime
- imageDeprecated :: Maybe ZonedTime
- imageDescription :: Text
- imageDiskSize :: Int
- imageID :: ImageID
- imageLabels :: LabelMap
- imageOSFlavor :: OSFlavor
- imageType :: ImageType
}
getImages :: Token -> Maybe Int -> IO (WithMeta "images" [Image])
getImage :: Token -> ImageID -> IO Image
data City
- = Falkenstein
- | Nuremberg
- | Helsinki
- | AshburnVA
- | HillsboroOR
newtype LocationID = LocationID Int
data Location = Location {
- locationCity :: City
- locationCountry :: Country
- locationDescription :: Text
- locationID :: LocationID
- locationLatitude :: Double
- locationLongitude :: Double
- locationName :: Text
- locationRegion :: Region
}
getLocations :: Token -> IO [Location]
getLocation :: Token -> LocationID -> IO Location
data Price = Price {
- grossPrice :: Scientific
- netPrice :: Scientific
}
data PriceInLocation = PriceInLocation {
- priceLocation :: Text
- hourlyPrice :: Maybe Price
- monthlyPrice :: Price
}
data ServerStatus
- = Running
- | Initializing
- | Starting
- | Stopping
- | Off
- | Deleting
- | Migrating
- | Rebuilding
- | StatusUnknown
newtype ServerID = ServerID Int
data Server = Server {
- serverCreated :: ZonedTime
- serverDatacenter :: Datacenter
- serverID :: ServerID
- serverImage :: Image
- serverLabels :: LabelMap
- serverIsLocked :: Bool
- serverName :: Text
- serverPublicNetwork :: PublicNetwork
- serverType :: ServerType
- serverStatus :: ServerStatus
}
data NewServer = NewServer {
- newServerAutomount :: Bool
- newServerLocation :: Maybe (Either DatacenterID LocationID)
- newServerFirewalls :: [FirewallID]
- newServerImage :: ImageID
- newServerLabels :: [Label]
- newServerName :: Text
- newServerEnableIPv4 :: Bool
- newServerEnableIPv6 :: Bool
- newServerType :: ServerTypeID
- newServerSSHKeys :: [SSHKeyID]
- newServerStart :: Bool
- newServerVolumes :: [VolumeID]
}
defaultNewServer :: Text -> NewServer
data CreatedServer = CreatedServer {
- createdServerAction :: Action
- createdServerNextActions :: [Action]
- createdServerPassword :: Maybe Text
- createdServer :: Server
}
getServers :: Token -> Maybe Int -> IO (WithMeta "servers" [Server])
getServer :: Token -> ServerID -> IO Server
createServer :: Token -> NewServer -> IO CreatedServer
deleteServer :: Token -> ServerID -> IO Action
data Architecture
- = X86
- | Arm
data StorageType
- = LocalStorage
- | NetworkStorage
data CPUType
- = SharedCPU
- | DedicatedCPU
newtype ServerTypeID = ServerTypeID Int
data ServerType = ServerType {
- serverArchitecture :: Architecture
- serverCores :: Int
- serverCPUType :: CPUType
- serverDeprecated :: Bool
- serverTypeDescription :: Text
- serverDisk :: Int
- serverTypeID :: ServerTypeID
- serverMemory :: Int
- serverTypeName :: Text
- serverPricing :: [PriceInLocation]
- serverStorageType :: StorageType
}
getServerTypes :: Token -> IO [ServerType]
newtype SSHKeyID = SSHKeyID Int
data SSHKey = SSHKey {
- sshKeyCreated :: ZonedTime
- sshKeyFingerprint :: Fingerprint
- sshKeyID :: SSHKeyID
- sshKeyLabels :: LabelMap
- sshKeyName :: Text
- sshKeyPublicKey :: Text
}
getSSHKeys :: Token -> IO [SSHKey]
getSSHKey :: Token -> SSHKeyID -> IO SSHKey
createSSHKey :: Token -> Text -> Text -> [Label] -> IO SSHKey
deleteSSHKey :: Token -> SSHKeyID -> IO ()
updateSSHKey :: Token -> SSHKeyID -> Text -> [Label] -> IO ()
newtype VolumeID = VolumeID Int
data Error = Error {
- errorCode :: Text
- errorMessage :: Text
}
data CloudException
- = CloudError Error
- | JSONError (Response ByteString) String
data LabelKey = LabelKey {
- labelKeyPrefix :: Maybe Text
- labelKeyName :: Text
}
data Label = Label {
- labelKey :: LabelKey
- labelValue :: Text
}
type LabelMap = Map LabelKey Text
toLabelMap :: [Label] -> LabelMap
fromLabelMap :: LabelMap -> [Label]
data LabelSelector
- = LabelEqual Label
- | LabelNotEqual Label
- | KeyPresent LabelKey
- | KeyNotPresent LabelKey
- | KeyValueIn LabelKey [Text]
- | KeyValueNotIn LabelKey [Text]
- | LabelAll [LabelSelector]
data Region
- = EUCentral
- | USWest
- | USEast
data ResourceID = ResourceServerID ServerID
data FirewallStatus = FirewallStatus {
- firewallStatusID :: FirewallID
- firewallIsApplied :: Bool
}
data PublicIPInfo dnsptr ip = PublicIPInfo {
- reverseDNS :: dnsptr
- publicIP :: ip
}
data PublicNetwork = PublicNetwork {
- publicNetworkFirewalls :: [FirewallStatus]
- publicNetworkFloatingIPs :: [FloatingIPID]
- publicIPv4 :: Maybe (PublicIPInfo Text IPv4)
- publicIPv6 :: Maybe (PublicIPInfo [PublicIPInfo Text IPv6] IPv6Range)
}
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]
cloudQuery :: (ToJSON body, FromJSON a) => ByteString -> ByteString -> Maybe body -> 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. All requests made with a token will have as scope the project where the token was made.

You can obtain one through the Hetzner Cloud Console.

Constructors

Token ByteString

Server metadata

data Metadata Source #

Metadata that any server in the Hetzner cloud can discover about itself.

Constructors

Metadata
Fields metadataName :: Text Server name. metadataServerID :: ServerID ID of the server. metadataPublicIPv4 :: IPv4 Primary public IPv4 address. metadataDatacenter :: Text Datacenter. metadataRegion :: Region Network zone.

Instances

Instances details

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

getMetadata :: IO Metadata Source #

Obtain metadata from running server.

Hetzner Cloud API

Sections are in the same order as in the official documentation.

Actions

data ActionStatus Source #

Status of an action.

Constructors

ActionRunning Int	Action is still running. The `Int` argument is the progress percentage.
ActionSuccess ZonedTime	Action finished successfully. The finishing time is provided.
ActionError ZonedTime Error	Action finished with an error. The finishing time is provided, together with the error message.

Instances

Instances details

Show ActionStatus Source #
Instance details Defined in Hetzner.Cloud Methods showsPrec :: Int -> ActionStatus -> ShowS # show :: ActionStatus -> String # showList :: [ActionStatus] -> ShowS #

data ActionCommand Source #

Command performed by an action.

Constructors

CreateServer
DeleteServer
StartServer
StopServer
SetFirewallRules
ApplyFirewall
CreateVolume
AttachVolume

Instances

Instances details

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

newtype ActionID Source #

Action identifier.

Constructors

ActionID Int

Instances

Instances details

FromJSON ActionID Source #
Instance details Defined in Hetzner.Cloud Methods parseJSON :: Value -> Parser ActionID # parseJSONList :: Value -> Parser [ActionID] #
Show ActionID Source #
Instance details Defined in Hetzner.Cloud Methods showsPrec :: Int -> ActionID -> ShowS # show :: ActionID -> String # showList :: [ActionID] -> ShowS #
Eq ActionID Source #
Instance details Defined in Hetzner.Cloud Methods (==) :: ActionID -> ActionID -> Bool # (/=) :: ActionID -> ActionID -> Bool #
Ord ActionID Source #
Instance details Defined in Hetzner.Cloud Methods compare :: ActionID -> ActionID -> Ordering # (<) :: ActionID -> ActionID -> Bool # (<=) :: ActionID -> ActionID -> Bool # (>) :: ActionID -> ActionID -> Bool # (>=) :: ActionID -> ActionID -> Bool # max :: ActionID -> ActionID -> ActionID # min :: ActionID -> ActionID -> ActionID #

data Action Source #

Action.

Constructors

Action
Fields actionID :: ActionID actionCommand :: ActionCommand actionStatus :: ActionStatus actionStarted :: ZonedTime actionResources :: [ResourceID] Resources the action relates to.

Instances

Instances details

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

getActions Source #

Arguments

:: Token
-> Maybe Int	Page.
-> IO (WithMeta "actions" [Action])

Get actions.

getAction :: Token -> ActionID -> IO Action Source #

Get a single action.

waitForAction :: Token -> ActionID -> IO ZonedTime Source #

Wait until an action is complete and returns the finishing time. It throws a CloudException if the action fails.

Datacenters

newtype DatacenterID Source #

Datacenter identifier.

Constructors

DatacenterID Int

Instances

Instances details

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

data DatacenterServers Source #

Server types available in a datacenter.

Constructors

DatacenterServers
Fields availableServers :: [ServerTypeID] migrationAvailableServers :: [ServerTypeID] supportedServers :: [ServerTypeID]

Instances

Instances details

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

data Datacenter Source #

A datacenter within a location.

Constructors

Datacenter
Fields datacenterID :: DatacenterID datacenterName :: Text datacenterDescription :: Text datacenterLocation :: Location datacenterServers :: DatacenterServers

Instances

Instances details

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

data DatacentersWithRecommendation Source #

Datacenter list with a datacenter recommendation for new servers.

Constructors

DatacentersWithRecommendation
Fields datacenters :: [Datacenter] datacenterRecommendation :: DatacenterID The datacenter which is recommended to be used to create new servers.

Instances

Instances details

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

getDatacenters :: Token -> IO DatacentersWithRecommendation Source #

Get all datacenters.

getDatacenter :: Token -> DatacenterID -> IO Datacenter Source #

Get a single datacenter.

Firewalls

newtype FirewallID Source #

Firewall identifier.

Constructors

FirewallID Int

Instances

Instances details

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

Floating IPs

newtype FloatingIPID Source #

Floating IP identifier.

Constructors

FloatingIPID Int

Instances

Instances details

FromJSON FloatingIPID Source #
Instance details Defined in Hetzner.Cloud Methods parseJSON :: Value -> Parser FloatingIPID # parseJSONList :: Value -> Parser [FloatingIPID] #
Show FloatingIPID Source #
Instance details Defined in Hetzner.Cloud Methods showsPrec :: Int -> FloatingIPID -> ShowS # show :: FloatingIPID -> String # showList :: [FloatingIPID] -> ShowS #
Eq FloatingIPID Source #
Instance details Defined in Hetzner.Cloud Methods (==) :: FloatingIPID -> FloatingIPID -> Bool # (/=) :: FloatingIPID -> FloatingIPID -> Bool #
Ord FloatingIPID Source #
Instance details Defined in Hetzner.Cloud Methods compare :: FloatingIPID -> FloatingIPID -> Ordering # (<) :: FloatingIPID -> FloatingIPID -> Bool # (<=) :: FloatingIPID -> FloatingIPID -> Bool # (>) :: FloatingIPID -> FloatingIPID -> Bool # (>=) :: FloatingIPID -> FloatingIPID -> Bool # max :: FloatingIPID -> FloatingIPID -> FloatingIPID # min :: FloatingIPID -> FloatingIPID -> FloatingIPID #

Images

data OSFlavor Source #

Flavor of operative system.

Constructors

Ubuntu
CentOS
Debian
Fedora
Rocky
Alma
UnknownOS

Instances

Instances details

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

data ImageType Source #

Image type.

Constructors

SystemImage Text	System image with name.
AppImage
Snapshot Double	Snapshot with size in GB.
Backup ServerID
Temporary

Instances

Instances details

Show ImageType Source #
Instance details Defined in Hetzner.Cloud Methods showsPrec :: Int -> ImageType -> ShowS # show :: ImageType -> String # showList :: [ImageType] -> ShowS #

newtype ImageID Source #

Image identifier.

Constructors

ImageID Int

Instances

Instances details

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

data Image Source #

An image that can be mounted to a server.

Constructors

Image
Fields imageCreated :: ZonedTime imageDeleted :: Maybe ZonedTime imageDeprecated :: Maybe ZonedTime imageDescription :: Text imageDiskSize :: Int Size of the disk contained in the image in GB. imageID :: ImageID imageLabels :: LabelMap imageOSFlavor :: OSFlavor imageType :: ImageType

Instances

Instances details

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

getImages Source #

Arguments

:: Token
-> Maybe Int	Page.
-> IO (WithMeta "images" [Image])

Get images.

getImage :: Token -> ImageID -> IO Image Source #

Get a single image.

Locations

data City Source #

Cities where Hetzner hosts their servers.

Constructors

Falkenstein
Nuremberg
Helsinki
AshburnVA
HillsboroOR

Instances

Instances details

FromJSON City Source #
Instance details Defined in Hetzner.Cloud Methods parseJSON :: Value -> Parser City # parseJSONList :: Value -> Parser [City] #
Show City Source #
Instance details Defined in Hetzner.Cloud Methods showsPrec :: Int -> City -> ShowS # show :: City -> String # showList :: [City] -> ShowS #
Eq City Source #
Instance details Defined in Hetzner.Cloud Methods (==) :: City -> City -> Bool # (/=) :: City -> City -> Bool #

newtype LocationID Source #

Location identifier.

Constructors

LocationID Int

Instances

Instances details

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

data Location Source #

A location.

Constructors

Location
Fields locationCity :: City locationCountry :: Country locationDescription :: Text locationID :: LocationID locationLatitude :: Double locationLongitude :: Double locationName :: Text locationRegion :: Region

Instances

Instances details

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

getLocations :: Token -> IO [Location] Source #

Get all locations.

getLocation :: Token -> LocationID -> IO Location Source #

Get a single location.

Pricing

data Price Source #

A resource's price.

Constructors

Price
Fields grossPrice :: Scientific netPrice :: Scientific

Instances

Instances details

FromJSON Price Source #
Instance details Defined in Hetzner.Cloud Methods parseJSON :: Value -> Parser Price # parseJSONList :: Value -> Parser [Price] #
Show Price Source #
Instance details Defined in Hetzner.Cloud Methods showsPrec :: Int -> Price -> ShowS # show :: Price -> String # showList :: [Price] -> ShowS #
Eq Price Source #
Instance details Defined in Hetzner.Cloud Methods (==) :: Price -> Price -> Bool # (/=) :: Price -> Price -> Bool #
Ord Price Source #	The `Ord` instance can be used to compare prices. Only the gross price is used for comparisons.
Instance details Defined in Hetzner.Cloud Methods compare :: Price -> Price -> Ordering # (<) :: Price -> Price -> Bool # (<=) :: Price -> Price -> Bool # (>) :: Price -> Price -> Bool # (>=) :: Price -> Price -> Bool # max :: Price -> Price -> Price # min :: Price -> Price -> Price #

data PriceInLocation Source #

The price of a resource in a location. Hourly pricing is unavailable for some resources.

Constructors

PriceInLocation
Fields priceLocation :: Text Location name. hourlyPrice :: Maybe Price Hourly price. monthlyPrice :: Price Monthly price.

Instances

Instances details

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

Servers

data ServerStatus Source #

A server status.

Constructors

Running
Initializing
Starting
Stopping
Off
Deleting
Migrating
Rebuilding
StatusUnknown

Instances

Instances details

FromJSON ServerStatus Source #
Instance details Defined in Hetzner.Cloud Methods parseJSON :: Value -> Parser ServerStatus # parseJSONList :: Value -> Parser [ServerStatus] #
Show ServerStatus Source #
Instance details Defined in Hetzner.Cloud Methods showsPrec :: Int -> ServerStatus -> ShowS # show :: ServerStatus -> String # showList :: [ServerStatus] -> ShowS #
Eq ServerStatus Source #
Instance details Defined in Hetzner.Cloud Methods (==) :: ServerStatus -> ServerStatus -> Bool # (/=) :: ServerStatus -> ServerStatus -> Bool #

newtype ServerID Source #

Server identifier.

Constructors

ServerID Int

Instances

Instances details

FromJSON ServerID Source #
Instance details Defined in Hetzner.Cloud Methods parseJSON :: Value -> Parser ServerID # parseJSONList :: Value -> Parser [ServerID] #
ToJSON ServerID Source #
Instance details Defined in Hetzner.Cloud Methods toJSON :: ServerID -> Value # toEncoding :: ServerID -> Encoding # toJSONList :: [ServerID] -> Value # toEncodingList :: [ServerID] -> Encoding #
Show ServerID Source #
Instance details Defined in Hetzner.Cloud Methods showsPrec :: Int -> ServerID -> ShowS # show :: ServerID -> String # showList :: [ServerID] -> ShowS #

data Server Source #

A server.

Constructors

Server
Fields serverCreated :: ZonedTime serverDatacenter :: Datacenter serverID :: ServerID serverImage :: Image serverLabels :: LabelMap serverIsLocked :: Bool serverName :: Text serverPublicNetwork :: PublicNetwork serverType :: ServerType serverStatus :: ServerStatus

Instances

Instances details

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

data NewServer Source #

Server creation configuration to be used with createServer.

Constructors

NewServer

Fields

newServerAutomount :: Bool
Automount attached volumes.
newServerLocation :: Maybe (Either DatacenterID LocationID)
newServerFirewalls :: [FirewallID]
newServerImage :: ImageID
newServerLabels :: [Label]
newServerName :: Text
Name of the server. Must be unique per project and a valid hostname as per RFC 1123.
newServerEnableIPv4 :: Bool
newServerEnableIPv6 :: Bool
newServerType :: ServerTypeID
newServerSSHKeys :: [SSHKeyID]
newServerStart :: Bool
Whether to start the server after creation.
newServerVolumes :: [VolumeID]
Volumes to attach to the server after creation.

Instances

Instances details

ToJSON NewServer Source #
Instance details Defined in Hetzner.Cloud Methods toJSON :: NewServer -> Value # toEncoding :: NewServer -> Encoding # toJSONList :: [NewServer] -> Value # toEncodingList :: [NewServer] -> Encoding #
Show NewServer Source #
Instance details Defined in Hetzner.Cloud Methods showsPrec :: Int -> NewServer -> ShowS # show :: NewServer -> String # showList :: [NewServer] -> ShowS #

defaultNewServer Source #

Arguments

:: Text	Server name.
-> NewServer

Default server configuration that can be used as a starting point for a custom server configuration.

Note that by default no SSH key is installed, which means you'll need the password in the response in order to access the server (you will also receive an e-mail with the password).

data CreatedServer Source #

A server that was just created with createServer.

Constructors

CreatedServer

Fields

createdServerAction :: Action
Server creation action. You can use waitForAction to wait until the server creation is finished.
createdServerNextActions :: [Action]
Additional server actions that are run after the server is created, like mounting volumes or starting the server.
createdServerPassword :: Maybe Text
Root password returned when no SSH keys are provided.
createdServer :: Server
The server being created.

Instances

Instances details

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

getServers Source #

Arguments

:: Token
-> Maybe Int	Page.
-> IO (WithMeta "servers" [Server])

Get servers.

getServer :: Token -> ServerID -> IO Server Source #

Get a single server.

createServer :: Token -> NewServer -> IO CreatedServer Source #

Create a new server.

deleteServer :: Token -> ServerID -> IO Action Source #

Delete a server.

Server types

data Architecture Source #

Computer architecture.

Constructors

X86
Arm

Instances

Instances details

FromJSON Architecture Source #
Instance details Defined in Hetzner.Cloud Methods parseJSON :: Value -> Parser Architecture # parseJSONList :: Value -> Parser [Architecture] #
Show Architecture Source #
Instance details Defined in Hetzner.Cloud Methods showsPrec :: Int -> Architecture -> ShowS # show :: Architecture -> String # showList :: [Architecture] -> ShowS #
Eq Architecture Source #
Instance details Defined in Hetzner.Cloud Methods (==) :: Architecture -> Architecture -> Bool # (/=) :: Architecture -> Architecture -> Bool #

data StorageType Source #

Type of server boot drive.

Constructors

LocalStorage
NetworkStorage

Instances

Instances details

FromJSON StorageType Source #
Instance details Defined in Hetzner.Cloud Methods parseJSON :: Value -> Parser StorageType # parseJSONList :: Value -> Parser [StorageType] #
Show StorageType Source #
Instance details Defined in Hetzner.Cloud Methods showsPrec :: Int -> StorageType -> ShowS # show :: StorageType -> String # showList :: [StorageType] -> ShowS #
Eq StorageType Source #
Instance details Defined in Hetzner.Cloud Methods (==) :: StorageType -> StorageType -> Bool # (/=) :: StorageType -> StorageType -> Bool #

data CPUType Source #

CPU types available.

Constructors

SharedCPU
DedicatedCPU

Instances

Instances details

FromJSON CPUType Source #
Instance details Defined in Hetzner.Cloud Methods parseJSON :: Value -> Parser CPUType # parseJSONList :: Value -> Parser [CPUType] #
Show CPUType Source #
Instance details Defined in Hetzner.Cloud Methods showsPrec :: Int -> CPUType -> ShowS # show :: CPUType -> String # showList :: [CPUType] -> ShowS #
Eq CPUType Source #
Instance details Defined in Hetzner.Cloud Methods (==) :: CPUType -> CPUType -> Bool # (/=) :: CPUType -> CPUType -> Bool #

newtype ServerTypeID Source #

Server type identifier.

Constructors

ServerTypeID Int

Instances

Instances details

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

data ServerType Source #

Server characteristics.

Constructors

ServerType
Fields serverArchitecture :: Architecture serverCores :: Int serverCPUType :: CPUType serverDeprecated :: Bool serverTypeDescription :: Text serverDisk :: Int Disk size a server of this type has in GB. serverTypeID :: ServerTypeID serverMemory :: Int Memory a server of this type has in GB. serverTypeName :: Text serverPricing :: [PriceInLocation] serverStorageType :: StorageType

Instances

Instances details

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

getServerTypes :: Token -> IO [ServerType] Source #

Get all server types.

Volumes

newtype VolumeID Source #

Volume identifier.

Constructors

VolumeID Int

Instances

Instances details

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

Exceptions

data Error Source #

An error returned by Hetzner.

Constructors

Error
Fields errorCode :: Text Error code. errorMessage :: Text Error message.

Instances

Instances details

FromJSON Error Source #
Instance details Defined in Hetzner.Cloud Methods parseJSON :: Value -> Parser Error # parseJSONList :: Value -> Parser [Error] #
ToJSON Error Source #
Instance details Defined in Hetzner.Cloud Methods toJSON :: Error -> Value # toEncoding :: Error -> Encoding # toJSONList :: [Error] -> Value # toEncodingList :: [Error] -> Encoding #
Show Error Source #
Instance details Defined in Hetzner.Cloud Methods showsPrec :: Int -> Error -> ShowS # show :: Error -> String # showList :: [Error] -> ShowS #

data CloudException Source #

Exception produced while performing a request to Hetzner Cloud.

Constructors

CloudError Error
JSONError (Response ByteString) String

Instances

Instances details

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

Labels

data LabelKey Source #

Label key.

Constructors

LabelKey
Fields labelKeyPrefix :: Maybe Text Optional prefix. labelKeyName :: Text Key name.

Instances

Instances details

FromJSON LabelKey Source #
Instance details Defined in Hetzner.Cloud Methods parseJSON :: Value -> Parser LabelKey # parseJSONList :: Value -> Parser [LabelKey] #
FromJSONKey LabelKey Source #
Instance details Defined in Hetzner.Cloud Methods fromJSONKey :: FromJSONKeyFunction LabelKey # fromJSONKeyList :: FromJSONKeyFunction [LabelKey] #
ToJSON LabelKey Source #
Instance details Defined in Hetzner.Cloud Methods toJSON :: LabelKey -> Value # toEncoding :: LabelKey -> Encoding # toJSONList :: [LabelKey] -> Value # toEncodingList :: [LabelKey] -> Encoding #
ToJSONKey LabelKey Source #
Instance details Defined in Hetzner.Cloud Methods toJSONKey :: ToJSONKeyFunction LabelKey # toJSONKeyList :: ToJSONKeyFunction [LabelKey] #
Show LabelKey Source #
Instance details Defined in Hetzner.Cloud Methods showsPrec :: Int -> LabelKey -> ShowS # show :: LabelKey -> String # showList :: [LabelKey] -> ShowS #
Eq LabelKey Source #
Instance details Defined in Hetzner.Cloud Methods (==) :: LabelKey -> LabelKey -> Bool # (/=) :: LabelKey -> LabelKey -> Bool #
Ord LabelKey Source #
Instance details Defined in Hetzner.Cloud Methods compare :: LabelKey -> LabelKey -> Ordering # (<) :: LabelKey -> LabelKey -> Bool # (<=) :: LabelKey -> LabelKey -> Bool # (>) :: LabelKey -> LabelKey -> Bool # (>=) :: LabelKey -> LabelKey -> Bool # max :: LabelKey -> LabelKey -> LabelKey # min :: LabelKey -> LabelKey -> LabelKey #

data Label Source #

Labels are key-value pairs that can be attached to all resources.

Constructors

Label
Fields labelKey :: LabelKey labelValue :: Text

Instances

Instances details

Show Label Source #
Instance details Defined in Hetzner.Cloud Methods showsPrec :: Int -> Label -> ShowS # show :: Label -> String # showList :: [Label] -> ShowS #
Eq Label Source #
Instance details Defined in Hetzner.Cloud Methods (==) :: Label -> Label -> Bool # (/=) :: Label -> Label -> Bool #

type LabelMap = Map LabelKey Text Source #

A label map maps label keys to values.

toLabelMap :: [Label] -> LabelMap Source #

Build a label map from a list of labels.

fromLabelMap :: LabelMap -> [Label] Source #

Get a list of labels from a label map.

data LabelSelector Source #

Label selectors can be used to filter results.

Constructors

LabelEqual Label	Select when label is equal.
LabelNotEqual Label	Select when label is not equal.
KeyPresent LabelKey	Select when key is present.
KeyNotPresent LabelKey	Select when key is not present.
KeyValueIn LabelKey [Text]	Select when label has one of the values.
KeyValueNotIn LabelKey [Text]	Select when label has none of the values.
LabelAll [LabelSelector]	Select only when all selectors succeed.

Instances

Instances details

Monoid LabelSelector Source #	Neutral element is a selector that always succeeds.
Instance details Defined in Hetzner.Cloud Methods mempty :: LabelSelector # mappend :: LabelSelector -> LabelSelector -> LabelSelector # mconcat :: [LabelSelector] -> LabelSelector #
Semigroup LabelSelector Source #	Semigroup under "and" operation.
Instance details Defined in Hetzner.Cloud Methods (<>) :: LabelSelector -> LabelSelector -> LabelSelector # sconcat :: NonEmpty LabelSelector -> LabelSelector # stimes :: Integral b => b -> LabelSelector -> LabelSelector #

Other types

Regions

data Region Source #

Network zones.

Constructors

EUCentral	Nuremberg, Falkenstein, Helsinki.
USWest	Hillsboro (OR).
USEast	Ashburn (VA).

Instances

Instances details

FromJSON Region Source #
Instance details Defined in Hetzner.Cloud Methods parseJSON :: Value -> Parser Region # parseJSONList :: Value -> Parser [Region] #
ToJSON Region Source #
Instance details Defined in Hetzner.Cloud Methods toJSON :: Region -> Value # toEncoding :: Region -> Encoding # toJSONList :: [Region] -> Value # toEncodingList :: [Region] -> Encoding #
Show Region Source #
Instance details Defined in Hetzner.Cloud Methods showsPrec :: Int -> Region -> ShowS # show :: Region -> String # showList :: [Region] -> ShowS #
Eq Region Source #
Instance details Defined in Hetzner.Cloud Methods (==) :: Region -> Region -> Bool # (/=) :: Region -> Region -> Bool #

Resources

data ResourceID Source #

A resource ID is an ID from one of the available resources.

Constructors

ResourceServerID ServerID

Server ID.

Instances

Instances details

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

Public networks

data FirewallStatus Source #

A firewall ID and whether the firewall is applied or not.

Constructors

FirewallStatus
Fields firewallStatusID :: FirewallID firewallIsApplied :: Bool

Instances

Instances details

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

data PublicIPInfo dnsptr ip Source #

Public IP information.

Constructors

PublicIPInfo
Fields reverseDNS :: dnsptr Reverse DNS PTR entry/entries. publicIP :: ip IP address/range.

Instances

Instances details

(FromJSON dnsptr, FromJSON ip) => FromJSON (PublicIPInfo dnsptr ip) Source #
Instance details Defined in Hetzner.Cloud Methods parseJSON :: Value -> Parser (PublicIPInfo dnsptr ip) # parseJSONList :: Value -> Parser [PublicIPInfo dnsptr ip] #
(Show dnsptr, Show ip) => Show (PublicIPInfo dnsptr ip) Source #
Instance details Defined in Hetzner.Cloud Methods showsPrec :: Int -> PublicIPInfo dnsptr ip -> ShowS # show :: PublicIPInfo dnsptr ip -> String # showList :: [PublicIPInfo dnsptr ip] -> ShowS #

data PublicNetwork Source #

Public network information associated with a Server.

Constructors

PublicNetwork
Fields publicNetworkFirewalls :: [FirewallStatus] publicNetworkFloatingIPs :: [FloatingIPID] publicIPv4 :: Maybe (PublicIPInfo Text IPv4) publicIPv6 :: Maybe (PublicIPInfo [PublicIPInfo Text IPv6] IPv6Range)

Instances

Instances details

FromJSON PublicNetwork Source #
Instance details Defined in Hetzner.Cloud Methods parseJSON :: Value -> Parser PublicNetwork # parseJSONList :: Value -> Parser [PublicNetwork] #
Show PublicNetwork Source #
Instance details Defined in Hetzner.Cloud Methods showsPrec :: Int -> PublicNetwork -> ShowS # show :: PublicNetwork -> String # showList :: [PublicNetwork] -> 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

cloudQuery Source #

Arguments

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

Generic Hetzner Cloud query.

This function is used to implement Hetzner Cloud queries.

If there is any issue while performing the request, a CloudException will be thrown.

The page argument determines which page will be requested. If not provided, it will request the first page. If a page is requested outside the valid range, an empty list will be returned, not a failure.

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

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

SSHKey
Fields sshKeyCreated :: ZonedTime sshKeyFingerprint :: Fingerprint sshKeyID :: SSHKeyID sshKeyLabels :: LabelMap sshKeyName :: Text sshKeyPublicKey :: Text

:: Token
-> Text	Name for the SSH key.
-> Text	Public key.
-> [Label]	List of labels to attach to the key.
-> IO SSHKey

:: Token
-> SSHKeyID
-> Text	New name for the key.
-> [Label]	New labels for the key.
-> IO ()

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 #

Pagination

Exceptions

Tokens

Server metadata

Instances

Hetzner Cloud API

Actions

Instances

Instances

Instances

Instances

Datacenters

Instances

Instances

Instances

Instances

Firewalls

Instances

Floating IPs

Instances

Images

Instances

Instances

Instances

Instances

Locations

Instances

Instances

Instances

Pricing

Instances

Instances

Servers

Instances

Instances

Instances

Instances

Instances

Server types

Instances

Instances

Instances

Instances

Instances

SSH Keys

Instances

Instances

Volumes

Instances

Exceptions

Instances

Instances

Labels

Instances

Instances

Instances

Other types

Regions

Instances

Resources

Instances

Public networks

Instances

Instances

Instances

Streaming

Generic interface

Generic queries

JSON Wrappers

Instances

Instances

Response metadata

Instances

Instances