ex_heroku_client v0.1.0 Heroku.Dyno

Summary

Functions

Calls POST /apps/#{app_identity}/dynos

Calls DELETE /apps/#{app_identity}/dynos/#{dyno_identity}

Calls DELETE /apps/#{app_identity}/dynos

Calls POST /apps/#{app_identity}/dynos/#{dyno_identity}/actions/stop

Calls GET /apps/#{app_identity}/dynos/#{dyno_identity}

Calls GET /apps/#{app_identity}/dynos

Functions

create(app_identity, params)

Calls POST /apps/#{app_identity}/dynos

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "attach": {
      "description": "whether to stream output or not",
      "example": true,
      "readOnly": false,
      "type": [
        "boolean"
      ]
    },
    "command": {
      "description": "command used to start this process",
      "example": "bash",
      "readOnly": false,
      "type": [
        "string"
      ]
    },
    "env": {
      "additionalProperties": false,
      "description": "custom environment to add to the dyno config vars",
      "example": {
        "COLUMNS": "80",
        "LINES": "24"
      },
      "patternProperties": {
        "^\\w+$": {
          "type": [
            "string"
          ]
        }
      },
      "properties": {},
      "readOnly": false,
      "strictProperties": true,
      "type": [
        "object"
      ]
    },
    "force_no_tty": {
      "description": "force an attached one-off dyno to not run in a tty",
      "example": null,
      "readOnly": false,
      "type": [
        "boolean",
        "null"
      ]
    },
    "size": {
      "description": "dyno size (default: \"standard-1X\")",
      "example": "standard-1X",
      "readOnly": false,
      "type": [
        "string"
      ]
    },
    "time_to_live": {
      "description": "seconds until dyno expires, after which it will soon be killed",
      "example": 1800,
      "readOnly": false,
      "type": [
        "integer"
      ]
    },
    "type": {
      "description": "type of process",
      "example": "run",
      "readOnly": false,
      "type": [
        "string"
      ]
    }
  },
  "required": [
    "command"
  ],
  "type": [
    "object"
  ]
}
empty_2(app_identity, dyno_identity)

Calls DELETE /apps/#{app_identity}/dynos/#{dyno_identity}

empty_3(app_identity)

Calls DELETE /apps/#{app_identity}/dynos

empty_4(app_identity, dyno_identity)

Calls POST /apps/#{app_identity}/dynos/#{dyno_identity}/actions/stop

get(app_identity, dyno_identity)

Calls GET /apps/#{app_identity}/dynos/#{dyno_identity}

index(app_identity)

Calls GET /apps/#{app_identity}/dynos