Hexoku.API.Apps

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

Attributes

id
unique identifier of app generated by Heroku
name
unique name of app provided by the user
build_stack:id
unique identifier of stack
build_stack:name
unique name of stack
buildpack_provided_description
description from buildpack of app
git_url
git repo URL of app
maintenance
maintenance status of app
owner:email
email address of account
owner:id
unique identifier of owner
region:id
unique identifier of region
region:name
unique name of region
repo_size
git repo size in bytes of app
slug_size
slug size in bytes of app
stack:id
unique identifier of stack
stack:name
unique name of stack
web_url
web URL of app
archived_at
when app was archived
released_at
when app was released
created_at
when app was created
updated_at
when app was last modified

For more info read the Heroku API Reference

Source

Summary

create(client, payload)

Create a new app

create(client, name, region, stack \\ "cedar")

Helper to create a new app

delete(client, app)

Delete an existing app

info(client, app)

Info for existing app

list(client)

List existing apps

Functions

create(client, payload)

Specs:

  • create(Hexoku.Client.t, Map.t) :: Hexoku.Response.t

Create a new app.

Payload Attributes

name
name of app
region
unique identifier or name of region
stack
unique identifier or name of stack

Examples

client |> Hexoku.API.Apps.create(%{name: "myapp"})
Source
create(client, name, region, stack \\ "cedar")

Specs:

  • create(Hexoku.Client.t, binary, binary, binary) :: Hexoku.Response.t

Helper to create a new app.

Examples

client |> Hexoku.API.Apps.create("myapp", "eu", "cedar")
Source
delete(client, app)

Specs:

  • delete(Hexoku.Client.t, binary) :: Hexoku.Response.t

Delete an existing app.

Examples

client |> Hexoku.API.Apps.delete("myapp")
Source
info(client, app)

Specs:

  • info(Hexoku.Client.t, binary) :: Map.t

Info for existing app.

Examples

client |> Hexoku.API.Apps.info("myapp")
Source
list(client)

Specs:

  • list(Hexoku.Client.t) :: [Map.t]

List existing apps.

Examples

client |> Hexoku.API.Apps.list()
Source