Hexoku v0.1.0

Modules summary

Hexoku

Basic API support and MIX tasks for Heroku support

Hexoku.API.Account

An account represents an individual signed up to use the Heroku platform

Hexoku.API.Account.Keys

Keys represent public SSH keys associated with an account and are used to authorize accounts as they are performing git operations

Hexoku.API.Addons

Add-ons represent add-ons that have been provisioned for an app

Hexoku.API.Addons.Available

Add-on Services represent add-ons that may be provisioned for apps. Plans represent different configurations of add-ons that may be added to apps

Hexoku.API.Apps

An app represents the program that you would like to deploy and run on Heroku

Hexoku.API.Builds

A build represents the process of transforming a code tarball into a slug

Hexoku.API.Config

Config Vars allow you to manage the configuration information provided to an app on Heroku

Hexoku.API.Domains

Domains define what web routes should be routed to an app on Heroku

Hexoku.API.Dynos

Dynos encapsulate running processes of an app on Heroku

Hexoku.API.Formation

The formation of processes that should be maintained for an app. Update the formation to scale processes or change dyno sizes. Available process type names and commands are defined by the process_types attribute for the slug currently released on an app

Hexoku.API.LogDrains

Log drains provide a way to forward your Heroku logs to an external syslog server for long-term archiving. This external service must be configured to receive syslog packets from Heroku, whereupon its URL can be added to an app using this API

Hexoku.API.LogSession

A log session is a reference to the http based log stream for an app

Hexoku.API.Organizations

Organizations allow you to manage access to a shared group of applications across your development team

Hexoku.API.Organizations.Apps

An organization app encapsulates the organization specific functionality of Heroku apps

Hexoku.API.Organizations.Members

An organization member is an individual with access to an organization

Hexoku.API.Regions

A region represents a geographic location in which your application may run

Hexoku.API.Releases

A release represents a combination of code, config vars and add-ons for an app on Heroku

Hexoku.API.SSL

SSL Endpoint is a public address serving custom SSL cert for HTTPS traffic to a Heroku app. Note that an app must have the ssl:endpoint addon installed before it can provision an SSL Endpoint using these APIs

Hexoku.API.Slugs

A slug is a snapshot of your application code that is ready to run on the platform

Hexoku.API.Sources

A source is a location for uploading and downloading an application’s source code

Hexoku.API.Stacks

Stacks are the different application execution environments available in the Heroku platform

Hexoku.Request

Make generic Heroku HTTP requests

Mix.Tasks.Hexoku

Hexoku adds some common Heroku commands to your Mix. It relies on Heroku Toolbet being installed and logged in

Exceptions summary

Hexoku.Request.RequestError
Hexoku.Request.ServerError

Protocols summary

Hexoku.Client.Auth.Authenticate