Introduction

API Base URL

https://api.hirefire.io

Required Headers

Accept: application/vnd.hirefire.v1+json
Content-Type: application/json
Authorization: Token YOUR_API_KEY

Welcome to the documentation of the HireFire HTTP API.

The API allows you to read and manage various resources. There is currently one version of the API (v1), it uses JSON for serialization, and an API key for authorization.

Log-in to HireFire to acquire your API key.

Example

GET (request a list of applications)

curl https://api.hirefire.io/applications \
  -H "Accept: application/vnd.hirefire.v1+json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Token YOUR_API_KEY"

RESPONSE (json)

{
  "applications": [
    {
      "id": "d53a72ef-884e-4af3-aa25-824b631e2634",
      "account_id": "6439cf4f-1f98-48fb-8058-2bea32ef4e1f",
      "name": "hirefire",
      "custom_domain": "hirefire.io",
      "token": "ce4cd30d-f88b-4d37-a107-a4a8866d9576",
      "logplex_drain_token": "d.67c65a48-c50c-4e4b-95b2-1b51e0d92b93",
      "checkup_frequency": 60,
      "ssl": true,
      "restart_crashed_dynos": false,
      "new_issue_notifications": true,
      "resolved_issue_notifications": true,
      "created_at": "2015-01-01T00:00:00.000Z",
      "updated_at": "2015-01-01T00:00:00.000Z",
      "issue": null
    }
  ]
}

POST (create organization)

curl https://api.hirefire.io/organizations \
  -H "Accept: application/vnd.hirefire.v1+json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Token YOUR_API_KEY" \
  -X POST

RESPONSE (json, error)

{
  "errors": {
    "base": ["organization limit reached"],
    "organization": {
      "name": ["can't be blank"],
      "time_zone": ["is invalid"]
    }
  }
}

These examples demonstrate a GET and POST request using the curl cli program.

User

User - List

GET

https://api.hirefire.io/organizations/:id/users

RESPONSE

{
  "users": [
    {
      "id": "b1d994bd-1b57-4088-ab9d-bd2501d9612d",
      "email": "example+user@hirefire.io",
      "notifications": true,
      "otp_enabled": true,
      "created_at": "2015-01-01T00:00:00.000Z",
      "updated_at": "2015-01-01T00:00:00.000Z"
    }
  ]
}

Returns a list of users.

Parameter	Type	Required	Description
id	String	Yes	The organization id

User - Show

GET

https://api.hirefire.io/users/:id

RESPONSE

{
  "user": {
    "id": "b1d994bd-1b57-4088-ab9d-bd2501d9612d",
    "email": "example+user@hirefire.io",
    "notifications": true,
    "otp_enabled": true,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z"
  }
}

Returns a user across all organizations that the requester is a member of.

Parameter	Type	Required	Description
id	String	Yes	The id of the user

User - Update

PATCH

https://api.hirefire.io/users/:id

RESPONSE

{
  "user": {
    "id": "b1d994bd-1b57-4088-ab9d-bd2501d9612d",
    "email": "example+user@hirefire.io",
    "notifications": true,
    "otp_enabled": true,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z"
  }
}

Only authorized to update self.

Parameter	Type	Required	Default	Description
id	String	Yes	-	The user's id
user[current_password]	String	No	-	The user's current password, required if password changed
user[email]	String	No	-	The user's email address
user[password]	String	No	-	The user's new password
user[notifications]	Boolean	No	True	Whether or not to receive email notifications

User - Delete

DELETE

https://api.hirefire.io/users/:id

RESPONSE

{
  "user": {
    "id": "b1d994bd-1b57-4088-ab9d-bd2501d9612d",
    "email": "example+user@hirefire.io",
    "notifications": true,
    "otp_enabled": true,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z"
  }
}

Only authorized to delete self.

Parameter	Type	Required	Description
id	String	Yes	The user's id

Organization

Organization - List

GET

https://api.hirefire.io/organizations

RESPONSE

{
  "organizations": [
    {
      "id": "c0724202-68fd-45c9-9932-acd6795bfc54",
      "name": "HireFire",
      "time_zone": "UTC",
      "otp_required": false,
      "baseclock_hours": 720,
      "baseclock_rate": 0.0342,
      "overclock_hours": 360,
      "overclock_rate": 0.0684,
      "trial_ends_at": "2015-01-01T00:00:00.000Z",
      "created_at": "2015-01-01T00:00:00.000Z",
      "updated_at": "2015-01-01T00:00:00.000Z"
    }
  ]
}

Returns the requester's organizations.

Organization - Show

GET

https://api.hirefire.io/organizations/:id

RESPONSE

{
  "organization": {
    "id": "c0724202-68fd-45c9-9932-acd6795bfc54",
    "name": "HireFire",
    "time_zone": "UTC",
    "otp_required": false,
    "baseclock_hours": 720,
    "baseclock_rate": 0.0342,
    "overclock_hours": 360,
    "overclock_rate": 0.0684,
    "trial_ends_at": "2015-01-01T00:00:00.000Z",
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z"
  }
}

Returns an organization.

Parameter	Type	Required	Description
id	String	Yes	The organization id

Organization - Create

POST

https://api.hirefire.io/organizations

RESPONSE

{
  "organization": {
    "id": "c0724202-68fd-45c9-9932-acd6795bfc54",
    "name": "HireFire",
    "time_zone": "UTC",
    "otp_required": false,
    "baseclock_hours": 720,
    "baseclock_rate": 0.0342,
    "overclock_hours": 360,
    "overclock_rate": 0.0684,
    "trial_ends_at": "2015-01-01T00:00:00.000Z",
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z"
  }
}

Creates an organization.

Parameter	Type	Required	Default	Description
organization[name]	String	Yes	-	The organization name
organization[time_zone]	String	No	"UTC"	The organization time zone
organization[otp_required]	Boolean	No	False	Require two-factor authentication

Organization - Update

PATCH

https://api.hirefire.io/organizations/:id

RESPONSE

{
  "organization": {
    "id": "c0724202-68fd-45c9-9932-acd6795bfc54",
    "name": "HireFire",
    "time_zone": "UTC",
    "otp_required": false,
    "baseclock_hours": 720,
    "baseclock_rate": 0.0342,
    "overclock_hours": 360,
    "overclock_rate": 0.0684,
    "trial_ends_at": "2015-01-01T00:00:00.000Z",
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z"
  }
}

Updates an organization.

Parameter	Type	Required	Default	Description
id	String	Yes	-	The organization id
organization[name]	String	No	-	The organization name
organization[time_zone]	String	No	"UTC"	The organization time zone
organization[otp_required]	Boolean	No	False	Require two-factor authentication

Organization - Delete

DELETE

https://api.hirefire.io/organizations/:id

RESPONSE

{
  "organization": {
    "id": "c0724202-68fd-45c9-9932-acd6795bfc54",
    "name": "HireFire",
    "time_zone": "UTC",
    "otp_required": false,
    "baseclock_hours": 720,
    "baseclock_rate": 0.0342,
    "overclock_hours": 360,
    "overclock_rate": 0.0684,
    "trial_ends_at": "2015-01-01T00:00:00.000Z",
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z"
  }
}

Deletes an organization.

Parameter	Type	Required	Description
id	String	Yes	The organization id

Membership

Membership - List

GET

https://api.hirefire.io/organizations/:id/memberships

RESPONSE

{
  "memberships": [
    {
      "id": "2b6be8e8-1b98-4582-864d-85c5711de77e",
      "user_id": "5891b322-aec6-4057-901b-28decb54e5a0",
      "organization_id": "98fdc050-b25f-4ea1-851e-7bc984088df5",
      "owner": true,
      "created_at": "2015-01-01T00:00:00.000Z",
      "updated_at": "2015-01-01T00:00:00.000Z"
    }
  ]
}

Parameter	Type	Required	Description
id	String	Yes	The id of the organization

Membership - Show

GET

https://api.hirefire.io/memberships/:id

RESPONSE

{
  "membership": {
    "id": "2b6be8e8-1b98-4582-864d-85c5711de77e",
    "user_id": "5891b322-aec6-4057-901b-28decb54e5a0",
    "organization_id": "98fdc050-b25f-4ea1-851e-7bc984088df5",
    "owner": true,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z"
  }
}

Returns a membership.

Parameter	Type	Required	Description
id	String	Yes	The id of the membership

Membership - Create

POST

https://api.hirefire.io/memberships

RESPONSE

{
  "membership": {
    "id": "2b6be8e8-1b98-4582-864d-85c5711de77e",
    "user_id": "5891b322-aec6-4057-901b-28decb54e5a0",
    "organization_id": "98fdc050-b25f-4ea1-851e-7bc984088df5",
    "owner": true,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z"
  }
}

Creates a membership.

Requires an existing user and organization.

Parameter	Type	Required	Default	Description
membership[user_id]	String	Yes	-	The id of the user
membership[organization_id]	String	Yes	-	The id of the organization
membership[owner]	Boolean	No	False	Grant owner status

Membership - Update

PATCH

https://api.hirefire.io/memberships/:id

RESPONSE

{
  "membership": {
    "id": "2b6be8e8-1b98-4582-864d-85c5711de77e",
    "user_id": "5891b322-aec6-4057-901b-28decb54e5a0",
    "organization_id": "98fdc050-b25f-4ea1-851e-7bc984088df5",
    "owner": true,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z"
  }
}

Updates a membership.

Parameter	Type	Required	Default	Description
id	String	Yes	-	The membership id
membership[owner]	Boolean	No	False	Grant owner status

Membership - Delete

DELETE

https://api.hirefire.io/memberships/:id

RESPONSE

{
  "membership": {
    "id": "2b6be8e8-1b98-4582-864d-85c5711de77e",
    "user_id": "5891b322-aec6-4057-901b-28decb54e5a0",
    "organization_id": "98fdc050-b25f-4ea1-851e-7bc984088df5",
    "owner": true,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z"
  }
}

Deletes a membership.

Parameter	Type	Required	Description
id	String	Yes	The id of the membership

Account

Account - List

GET

https://api.hirefire.io/organizations/:id/accounts

RESPONSE

{
  "accounts": [
    {
      "id": "6439cf4f-1f98-48fb-8058-2bea32ef4e1f",
      "organization_id": "c0724202-68fd-45c9-9932-acd6795bfc54",
      "email": "example+user@hirefire.io",
      "remaining_api_calls": 2399,
      "oauth": true,
      "created_at": "2015-01-01T00:00:00.000Z",
      "updated_at": "2015-01-01T00:00:00.000Z"
    }
  ]
}

Returns a list of accounts.

Parameter	Type	Required	Description
id	String	Yes	The id of the organization

Account - Show

GET

https://api.hirefire.io/accounts/:id

RESPONSE

{
  "account": {
    "id": "6439cf4f-1f98-48fb-8058-2bea32ef4e1f",
    "organization_id": "c0724202-68fd-45c9-9932-acd6795bfc54",
    "email": "example+user@hirefire.io",
    "remaining_api_calls": 2399,
    "oauth": true,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z"
  }
}

Returns an account.

Parameter	Type	Required	Description
id	String	Yes	The id of the account

Account - Create

POST

https://api.hirefire.io/accounts

RESPONSE

{
  "account": {
    "id": "6439cf4f-1f98-48fb-8058-2bea32ef4e1f",
    "organization_id": "c0724202-68fd-45c9-9932-acd6795bfc54",
    "email": null,
    "remaining_api_calls": null,
    "oauth": false,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z"
  }
}

Adds a Heroku Account to the organization. After it has been added, it still needs to be authorized to perform API calls against the Heroku Platform API. To initiate an OAuth 2.0 operation, use a browser and visit the following URL:

https://manager.hirefire.io/heroku-open-auth/authorize/:id

Where :id is the ID of the newly added Heroku Account.

The above URL will redirect the browser to Heroku to request authorization for the newly created account. After selecting "Allow" on Heroku’s OAuth page, the browser will be redirected back to HireFire. Subsequently, the newly created account will be authorized.

This same URL can also be used to reauthorize accounts where authorization was previously revoked by the user. Additionally, it can serve to switch Heroku accounts by logging into a different Heroku account before visiting the URL.

Parameter	Type	Required	Default	Description
account[organization_id]	String	Yes	-	The id of the organization to add the account to

Account - Delete

DELETE

https://api.hirefire.io/accounts/:id

RESPONSE

{
  "account": {
    "id": "6439cf4f-1f98-48fb-8058-2bea32ef4e1f",
    "organization_id": "c0724202-68fd-45c9-9932-acd6795bfc54",
    "email": "example+user@hirefire.io",
    "remaining_api_calls": 2399,
    "oauth": true,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z"
  }
}

Deletes an account.

Parameter	Type	Required	Description
id	String	Yes	The account's id

Application

Application - List

GET

https://api.hirefire.io/accounts/:id/applications

RESPONSE

{
  "applications": [
    {
      "id": "d53a72ef-884e-4af3-aa25-824b631e2634",
      "account_id": "6439cf4f-1f98-48fb-8058-2bea32ef4e1f",
      "name": "hirefire",
      "custom_domain": "hirefire.io",
      "token": "ce4cd30d-f88b-4d37-a107-a4a8866d9576",
      "logplex_drain_token": "d.67c65a48-c50c-4e4b-95b2-1b51e0d92b93",
      "checkup_frequency": 60,
      "ssl": true,
      "restart_crashed_dynos": false,
      "new_issue_notifications": true,
      "resolved_issue_notifications": true,
      "created_at": "2015-01-01T00:00:00.000Z",
      "updated_at": "2015-01-01T00:00:00.000Z",
      "issue": null
    }
  ]
}

Returns a list of applications.

Parameter	Type	Required	Description
id	String	Yes	The account id

Application - Show

GET

https://api.hirefire.io/applications/:id

RESPONSE - application.issue

{
  "application": {
    "issue": {
      "id": "d44b79b0-da8f-45aa-b817-56e305ee1e95",
      "application_id": "cb5153e5-7149-417d-9615-e0b92cd93adc",
      "operation": "Checkup::UpdateDynoFormation",
      "response": "Service Unavailable",
      "message": "Couldn't refresh dyno quantity. Heroku's API appears to be unavailable at this time.",
      "created_at": "2015-01-01T00:00:00.000Z"
    }
  }
}

RESPONSE

{
  "application": {
    "id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "account_id": "6439cf4f-1f98-48fb-8058-2bea32ef4e1f",
    "name": "hirefire",
    "custom_domain": "hirefire.io",
    "token": "ce4cd30d-f88b-4d37-a107-a4a8866d9576",
    "logplex_drain_token": "d.67c65a48-c50c-4e4b-95b2-1b51e0d92b93",
    "checkup_frequency": 60,
    "ssl": true,
    "restart_crashed_dynos": false,
    "new_issue_notifications": true,
    "resolved_issue_notifications": true,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "issue": null
  }
}

Returns an application.

Parameter	Type	Required	Description
id	String	Yes	The id of the application

Application - Create

POST

https://api.hirefire.io/applications

RESPONSE

{
  "application": {
    "id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "account_id": "6439cf4f-1f98-48fb-8058-2bea32ef4e1f",
    "name": "hirefire",
    "custom_domain": "hirefire.io",
    "token": "ce4cd30d-f88b-4d37-a107-a4a8866d9576",
    "logplex_drain_token": "d.67c65a48-c50c-4e4b-95b2-1b51e0d92b93",
    "checkup_frequency": 60,
    "ssl": true,
    "restart_crashed_dynos": false,
    "new_issue_notifications": true,
    "resolved_issue_notifications": true,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "issue": null
  }
}

Creates an application.

Parameter	Type	Required	Default	Description
application[name]	String	Yes	-	The name of the application
application[account_id]	String	Yes	-	The account to add the application to
application[checkup_frequency]	Integer	No	60	The frequency, in seconds, at which checkups are performed
application[custom_domain]	String \| Null	No	Null	The custom domain of the application
application[logplex_drain_token]	String \| Null	No	Null	The Heroku logplex drain token of the application
application[ssl]	Boolean	No	True	Use SSL/TLS when performing requests to the application's backend
application[restart_crashed_dynos]	Boolean	No	False	Restart dynos that entered a "crashed" state
application[new_issue_notifications]	Boolean	No	True	Receive notifications when new issues occur
application[resolved_issue_notifications]	Boolean	No	True	Receive notifications when issues are resolved

Application - Update

PATCH

https://api.hirefire.io/applications/:id

RESPONSE

{
  "application": {
    "id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "account_id": "6439cf4f-1f98-48fb-8058-2bea32ef4e1f",
    "name": "hirefire",
    "custom_domain": "hirefire.io",
    "token": "ce4cd30d-f88b-4d37-a107-a4a8866d9576",
    "logplex_drain_token": "d.67c65a48-c50c-4e4b-95b2-1b51e0d92b93",
    "checkup_frequency": 60,
    "ssl": true,
    "restart_crashed_dynos": false,
    "new_issue_notifications": true,
    "resolved_issue_notifications": true,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "issue": null
  }
}

Updates an application.

Parameter	Type	Required	Default	Description
id	String	Yes	-	The membership id
application[name]	String	No	-	The name of the application
application[account_id]	String	No	-	The account to add the application to
application[checkup_frequency]	Integer	No	60	The frequency, in seconds, at which checkups are performed
application[custom_domain]	String \| Null	No	Null	The custom domain of the application
application[logplex_drain_token]	String \| Null	No	Null	The Heroku logplex drain token of the application
application[ssl]	Boolean	No	True	Use SSL/TLS when performing requests to the application's backend
application[restart_crashed_dynos]	Boolean	No	False	Restart dynos that entered a "crashed" state
application[new_issue_notifications]	Boolean	No	True	Receive notifications when new issues occur
application[resolved_issue_notifications]	Boolean	No	True	Receive notifications when issues are resolved

Application - Delete

DELETE

https://api.hirefire.io/applications/:id

RESPONSE

{
  "application": {
    "id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "account_id": "6439cf4f-1f98-48fb-8058-2bea32ef4e1f",
    "name": "hirefire",
    "custom_domain": "hirefire.io",
    "token": "ce4cd30d-f88b-4d37-a107-a4a8866d9576",
    "logplex_drain_token": "d.67c65a48-c50c-4e4b-95b2-1b51e0d92b93",
    "checkup_frequency": 60,
    "ssl": true,
    "restart_crashed_dynos": false,
    "new_issue_notifications": true,
    "resolved_issue_notifications": true,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "issue": null
  }
}

Deletes an application.

Parameter	Type	Required	Description
id	String	Yes	The id of the application

Manager

Manager - List

GET

https://api.hirefire.io/applications/:id/managers

RESPONSE

{
  "managers": [
    {
      "id": "f7889faa-ed5e-4462-b68c-c2d347dfb5eb",
      "type": "Manager::Worker::HireFire::JobQueue",
      "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
      "name": "worker",
      "enabled": true,
      "metric_value": "0",
      "dyno_quantity": 0,
      "last_checkup_time": "2015-01-01T00:00:00.000Z",
      "last_scale_time": "2015-01-01T00:00:00.000Z",
      "minimum": 0,
      "maximum": 3,
      "notify": false,
      "notify_quantity": 1,
      "notify_after": 1,
      "created_at": "2015-01-01T00:00:00.000Z",
      "updated_at": "2015-01-01T00:00:00.000Z",
      "ratio": 10,
      "decrementable": true,
      "upscale_sensitivity": 1,
      "downscale_sensitivity": 1,
      "upscale_timeout": 1,
      "downscale_timeout": 1,
      "upscale_limit": 0,
      "downscale_limit": 0,
      "issue": null
    }
  ]
}

Returns a list of managers.

See the various manager responses in Manager - Show.

Parameter	Type	Required	Description
id	String	Yes	The application id

Manager - Show

GET

https://api.hirefire.io/managers/:id

RESPONSE - manager.issue

{
  "manager": {
    "issue": {
      "id": "d44b79b0-da8f-45aa-b817-56e305ee1e95",
      "manager_id": "cb5153e5-7149-417d-9615-e0b92cd93adc",
      "operation": "Manager::Metric::Fetcher::Web::Logplex::Load",
      "response": "MissingDrainToken",
      "message": "You haven't configured a drain token.",
      "created_at": "2015-01-01T00:00:00.000Z"
    }
  }
}

RESPONSE - Manager::Worker::HireFire::JobQueue

{
  "manager": {
    "id": "f7889faa-ed5e-4462-b68c-c2d347dfb5eb",
    "type": "Manager::Worker::HireFire::JobQueue",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "worker",
    "enabled": true,
    "metric_value": "0",
    "dyno_quantity": 0,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 0,
    "maximum": 3,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "ratio": 10,
    "decrementable": true,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "upscale_limit": 0,
    "downscale_limit": 0,
    "issue": null
  }
}

RESPONSE - Manager::Worker::HireFire::JobLatency

{
  "manager": {
    "id": "bc6b0b62-24b0-406f-bde3-3356b4da972e",
    "type": "Manager::Worker::HireFire::JobLatency",
    "application_id": "6bba10b2-de1b-4abb-bc3d-7dd4627d29ee",
    "name": "worker",
    "enabled": false,
    "metric_value": "0",
    "dyno_quantity": 0,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 0,
    "maximum": 1,
    "notify": false,
    "notify_quantity": 0,
    "notify_after": 0,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "minimum_latency": 100,
    "maximum_latency": 300,
    "upscale_on_initial_job": true,
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::HireFire::RequestQueueTime

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::HireFire::RequestQueueTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "200",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum_queue_time": 100,
    "maximum_queue_time": 500,
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::Logplex::Load

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::Logplex::Load",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum_load": 100,
    "maximum_load": 400,
    "last_minutes": 5,
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::Logplex::QueueTime

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::Logplex::QueueTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum_queue_time": 500,
    "maximum_queue_time": 2000,
    "aggregation": "average",
    "percentile": 1,
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::Logplex::ResponseTime

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::Logplex::ResponseTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum_response_time": 500,
    "maximum_response_time": 2000,
    "aggregation": "average",
    "percentile": 1,
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::Logplex::ConnectTime

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::Logplex::ConnectTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum_connect_time": 500,
    "maximum_connect_time": 2000,
    "aggregation": "average",
    "percentile": 1,
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1
    "issue": null
  }
}

RESPONSE - Manager::Web::Logplex::RPM

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::Logplex::RPM",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "ratio": 1200,
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1
    "issue": null
  }
}

RESPONSE - Manager::Web::NewRelic::V2::ResponseTime

{
  "manager": {
    "id": "efb7caff-c915-4344-ab32-f1430a17ba14",
    "type": "Manager::Web::NewRelic::V2::ResponseTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "new_relic_app_id": "1234567890",
    "new_relic_api_key": "NRAK-K17EVKVHLLRJAMSJ9V6DXIO8RPM",
    "new_relic_region": "us",
    "minimum_response_time": 100,
    "maximum_response_time": 1000,
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "scale_up_on_503": false,
    "url": "https://example.hirefire.io",
    "issue": null
  }
}

RESPONSE - Manager::Web::NewRelic::V2::RPM

{
  "manager": {
    "id": "1f757cf3-5f4a-46e9-b144-4a8983f563a7",
    "type": "Manager::Web::NewRelic::V2::RPM",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "new_relic_app_id": "1234567890",
    "new_relic_api_key": "NRAK-K17EVKVHLLRJAMSJ9V6DXIO8RPM",
    "new_relic_region": "us",
    "ratio": 3000,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::NewRelic::V2::Apdex

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::NewRelic::V2::Apdex",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "new_relic_app_id": "1234567890",
    "new_relic_api_key": "NRAK-K17EVKVHLLRJAMSJ9V6DXIO8RPM",
    "new_relic_region": "us",
    "minimum_apdex": 90,
    "maximum_apdex": 100,
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "scale_up_on_503": false,
    "url": "https://example.hirefire.io",
    "issue": null
  }
}

RESPONSE - Manager::Web::NewRelic::V1::ResponseTime (Legacy, prefer V2)

{
  "manager": {
    "id": "efb7caff-c915-4344-ab32-f1430a17ba14",
    "type": "Manager::Web::NewRelic::V1::ResponseTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "new_relic_account_id": "1234567890",
    "new_relic_app_id": "1234567890",
    "new_relic_api_key": "NRAK-K17EVKVHLLRJAMSJ9V6DXIO8RPM",
    "minimum_response_time": 100,
    "maximum_response_time": 1000,
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "scale_up_on_503": false,
    "url": "https://example.hirefire.io",
    "issue": null
  }
}

RESPONSE - Manager::Web::NewRelic::V1::RPM (Legacy, prefer V2)

{
  "manager": {
    "id": "1f757cf3-5f4a-46e9-b144-4a8983f563a7",
    "type": "Manager::Web::NewRelic::V1::RPM",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "new_relic_account_id": "1234567890",
    "new_relic_app_id": "1234567890",
    "new_relic_api_key": "NRAK-K17EVKVHLLRJAMSJ9V6DXIO8RPM",
    "ratio": 3000,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::NewRelic::V1::Apdex (Legacy, prefer V2)

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::NewRelic::V1::Apdex",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "new_relic_account_id": "1234567890",
    "new_relic_app_id": "1234567890",
    "new_relic_api_key": "NRAK-K17EVKVHLLRJAMSJ9V6DXIO8RPM",
    "minimum_apdex": 90,
    "maximum_apdex": 100,
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "scale_up_on_503": false,
    "url": "https://example.hirefire.io",
    "issue": null
  }
}

RESPONSE - Manager::Web::HireFire::ResponseTime (Legacy, prefer Logplex)

{
  "manager": {
    "id": "efa63389-688c-44ff-85ee-6b23d839f13d",
    "type": "Manager::Web::HireFire::ResponseTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "461",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 1,
    "notify": true,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "minimum_response_time": 100,
    "maximum_response_time": 800,
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "scale_up_on_503": false,
    "url": "https://example.hirefire.io",
    "issue": null
  }
}

Returns a manager.

Parameter	Type	Required	Description
id	String	Yes	The manager id

Manager - Create

POST

https://api.hirefire.io/managers

RESPONSE - Manager::Worker::HireFire::JobQueue

{
  "manager": {
    "id": "f7889faa-ed5e-4462-b68c-c2d347dfb5eb",
    "type": "Manager::Worker::HireFire::JobQueue",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "worker",
    "enabled": true,
    "metric_value": "0",
    "dyno_quantity": 0,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 0,
    "maximum": 3,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "ratio": 10,
    "decrementable": true,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "upscale_limit": 0,
    "downscale_limit": 0,
    "issue": null
  }
}

RESPONSE - Manager::Worker::HireFire::JobLatency

{
  "manager": {
    "id": "bc6b0b62-24b0-406f-bde3-3356b4da972e",
    "type": "Manager::Worker::HireFire::JobLatency",
    "application_id": "6bba10b2-de1b-4abb-bc3d-7dd4627d29ee",
    "name": "worker",
    "enabled": false,
    "metric_value": "0",
    "dyno_quantity": 0,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 0,
    "maximum": 1,
    "notify": false,
    "notify_quantity": 0,
    "notify_after": 0,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "minimum_latency": 100,
    "maximum_latency": 300,
    "upscale_on_initial_job": true,
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::HireFire::RequestQueueTime

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::HireFire::RequestQueueTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "200",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum_queue_time": 100,
    "maximum_queue_time": 500,
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::Logplex::Load

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::Logplex::Load",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum_load": 100,
    "maximum_load": 400,
    "last_minutes": 5,
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::Logplex::QueueTime

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::Logplex::QueueTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum_queue_time": 500,
    "maximum_queue_time": 2000,
    "aggregation": "average",
    "percentile": 1,
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::Logplex::ResponseTime

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::Logplex::ResponseTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum_response_time": 500,
    "maximum_response_time": 2000,
    "aggregation": "average",
    "percentile": 1,
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::Logplex::ConnectTime

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::Logplex::ConnectTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum_connect_time": 500,
    "maximum_connect_time": 2000,
    "aggregation": "average",
    "percentile": 1,
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1
    "issue": null
  }
}

RESPONSE - Manager::Web::Logplex::RPM

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::Logplex::RPM",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "ratio": 1200,
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1
    "issue": null
  }
}

RESPONSE - Manager::Web::NewRelic::V2::ResponseTime

{
  "manager": {
    "id": "efb7caff-c915-4344-ab32-f1430a17ba14",
    "type": "Manager::Web::NewRelic::V2::ResponseTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "new_relic_app_id": "1234567890",
    "new_relic_api_key": "NRAK-K17EVKVHLLRJAMSJ9V6DXIO8RPM",
    "new_relic_region": "us",
    "minimum_response_time": 100,
    "maximum_response_time": 1000,
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "scale_up_on_503": false,
    "url": "https://example.hirefire.io",
    "issue": null
  }
}

RESPONSE - Manager::Web::NewRelic::V2::RPM

{
  "manager": {
    "id": "1f757cf3-5f4a-46e9-b144-4a8983f563a7",
    "type": "Manager::Web::NewRelic::V2::RPM",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "new_relic_app_id": "1234567890",
    "new_relic_api_key": "NRAK-K17EVKVHLLRJAMSJ9V6DXIO8RPM",
    "new_relic_region": "us",
    "ratio": 3000,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::NewRelic::V2::Apdex

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::NewRelic::V2::Apdex",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "new_relic_app_id": "1234567890",
    "new_relic_api_key": "NRAK-K17EVKVHLLRJAMSJ9V6DXIO8RPM",
    "new_relic_region": "us",
    "minimum_apdex": 90,
    "maximum_apdex": 100,
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "scale_up_on_503": false,
    "url": "https://example.hirefire.io",
    "issue": null
  }
}

RESPONSE - Manager::Web::NewRelic::V1::ResponseTime (Legacy, prefer V2)

{
  "manager": {
    "id": "efb7caff-c915-4344-ab32-f1430a17ba14",
    "type": "Manager::Web::NewRelic::V1::ResponseTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "new_relic_account_id": "1234567890",
    "new_relic_app_id": "1234567890",
    "new_relic_api_key": "NRAK-K17EVKVHLLRJAMSJ9V6DXIO8RPM",
    "minimum_response_time": 100,
    "maximum_response_time": 1000,
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "scale_up_on_503": false,
    "url": "https://example.hirefire.io",
    "issue": null
  }
}

RESPONSE - Manager::Web::NewRelic::V1::RPM (Legacy, prefer V2)

{
  "manager": {
    "id": "1f757cf3-5f4a-46e9-b144-4a8983f563a7",
    "type": "Manager::Web::NewRelic::V1::RPM",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "new_relic_account_id": "1234567890",
    "new_relic_app_id": "1234567890",
    "new_relic_api_key": "NRAK-K17EVKVHLLRJAMSJ9V6DXIO8RPM",
    "ratio": 3000,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::NewRelic::V1::Apdex (Legacy, prefer V2)

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::NewRelic::V1::Apdex",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "new_relic_account_id": "1234567890",
    "new_relic_app_id": "1234567890",
    "new_relic_api_key": "NRAK-K17EVKVHLLRJAMSJ9V6DXIO8RPM",
    "minimum_apdex": 90,
    "maximum_apdex": 100,
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "scale_up_on_503": false,
    "url": "https://example.hirefire.io",
    "issue": null
  }
}

RESPONSE - Manager::Web::HireFire::ResponseTime (Legacy, prefer Logplex)

{
  "manager": {
    "id": "efa63389-688c-44ff-85ee-6b23d839f13d",
    "type": "Manager::Web::HireFire::ResponseTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "461",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 1,
    "notify": true,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "minimum_response_time": 100,
    "maximum_response_time": 800,
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "scale_up_on_503": false,
    "url": "https://example.hirefire.io",
    "issue": null
  }
}

Creates a manager.

The available parameters depends on the manager type, see tables below.

Manager::Worker::HireFire::JobQueue

Parameter	Type	Required	Default	Description
manager[application_id]	String	Yes	-	The id of the application to associate this manager with
manager[name]	String	Yes	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	Yes	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[ratio]	Integer	No	10	Maintains a dyno/job ratio
manager[decrementable]	Boolean	No	True	Allows scaling down to non-zero values when there are still jobs in the queue
manager[upscale_limit]	Integer	No	0	Limits the amount of dynos by which the manager scales up at a time (0 means no limit)
manager[downscale_limit]	Integer	No	0	Limits the amount of dynos by which the manager scales down at a time (0 means no limit)
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Worker::HireFire::JobLatency

Parameter	Type	Required	Default	Description
manager[application_id]	String	Yes	-	The id of the application to associate this manager with
manager[name]	String	Yes	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	Yes	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[minimum_latency]	Integer	No	100	Scale down when latency gets below N seconds.
manager[maximum_latency]	Integer	No	300	Scale up when latency exceeds N seconds.
manager[upscale_on_initial_job]	Boolean	No	True	Ensures the availability of at least one dyno when one or more jobs are enqueued, bypassing the initial maximum latency requirement.
manager[upscale_quantity]	Integer	No	1	The amount of dynos to scale up at a time
manager[downscale_quantity]	Integer	No	1	The amount of dynos to scale down at a time
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::HireFire::RequestQueueTime

Parameter	Type	Required	Default	Description
manager[application_id]	String	Yes	-	The id of the application to associate this manager with
manager[name]	String	Yes	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	Yes	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[minimum_queue_time]	Integer	No	100	Scale down when queue times get below N milliseconds
manager[maximum_queue_time]	Integer	No	300	Scale up when queue times exceed N milliseconds
manager[upscale_quantity]	Integer	No	1	The amount of dynos to scale up at a time
manager[downscale_quantity]	Integer	No	1	The amount of dynos to scale down at a time
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::Logplex::Load

Parameter	Type	Required	Default	Description
manager[application_id]	String	Yes	-	The id of the application to associate this manager with
manager[name]	String	Yes	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	Yes	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[minimum_load]	Integer	No	100	Scales down if your application's load goes below this amount
manager[maximum_load]	Integer	No	300	Scales up if your application's load exceeds this amount
manager[last_minutes]	Integer	No	1	The load average over the last n minutes. Possible values are 1, 5 and 15
manager[upscale_quantity]	Integer	No	1	The amount of dynos to scale up at a time
manager[downscale_quantity]	Integer	No	1	The amount of dynos to scale down at a time
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::Logplex::QueueTime

Parameter	Type	Required	Default	Description
manager[application_id]	String	Yes	-	The id of the application to associate this manager with
manager[name]	String	Yes	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	Yes	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[minimum_queue_time]	Integer	No	100	Scale down when queue times get below N milliseconds
manager[maximum_queue_time]	Integer	No	300	Scale up when queue times exceed N milliseconds
manager[aggregation]	String	No	"percentile"	Determines how the metric is aggregated. Possible values are "average" and "percentile"
manager[percentile]	Integer	No	95	The percentile to use (when aggregation is set to "percentile")
manager[upscale_quantity]	Integer	No	1	The amount of dynos to scale up at a time
manager[downscale_quantity]	Integer	No	1	The amount of dynos to scale down at a time
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::Logplex::ResponseTime

Parameter	Type	Required	Default	Description
manager[application_id]	String	Yes	-	The id of the application to associate this manager with
manager[name]	String	Yes	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	Yes	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[minimum_response_time]	Integer	No	100	Scales down if your application's response time goes below this amount
manager[maximum_response_time]	Integer	No	300	Scales up if your application's response time exceeds this amount
manager[aggregation]	String	No	"percentile"	Determines how the metric is aggregated. Possible values are "average" and "percentile"
manager[percentile]	Integer	No	95	The percentile to use (when aggregation is set to "percentile")
manager[upscale_quantity]	Integer	No	1	The amount of dynos to scale up at a time
manager[downscale_quantity]	Integer	No	1	The amount of dynos to scale down at a time
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::Logplex::ConnectTime

Parameter	Type	Required	Default	Description
manager[application_id]	String	Yes	-	The id of the application to associate this manager with
manager[name]	String	Yes	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	Yes	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[minimum_connect_time]	Integer	No	100	Scale down when connect times get below N milliseconds
manager[maximum_connect_time]	Integer	No	300	Scale up when connect times exceed N milliseconds
manager[aggregation]	String	No	"percentile"	Determines how the metric is aggregated. Possible values are "average" and "percentile"
manager[percentile]	Integer	No	95	The percentile to use (when aggregation is set to "percentile")
manager[upscale_quantity]	Integer	No	1	The amount of dynos to scale up at a time
manager[downscale_quantity]	Integer	No	1	The amount of dynos to scale down at a time
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::NewRelic::V2::ResponseTime

Parameter	Type	Required	Default	Description
manager[application_id]	String	Yes	-	The id of the application to associate this manager with
manager[name]	String	Yes	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	Yes	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[minimum_response_time]	Integer	No	100	Scales down if your application's response time goes below this amount
manager[maximum_response_time]	Integer	No	300	Scales up if your application's response time exceeds this amount
manager[new_relic_region]	String	Yes	-	Your account's region (either "us" or "eu")
manager[new_relic_api_key]	String	Yes	-	Your New Relic API key
manager[new_relic_app_id]	String	Yes	-	Your New Relic application id
manager[upscale_quantity]	Integer	No	1	The amount of dynos to scale up at a time
manager[downscale_quantity]	Integer	No	1	The amount of dynos to scale down at a time
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[scale_up_on_503]	Boolean	No	False	Scale up when your application returns HTTP/503 (Serivce Unavailable)
manager[url]	String \| Null	No	Null	Specify an URL to check for 503 responses
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::NewRelic::V2::RPM

Parameter	Type	Required	Default	Description
manager[application_id]	String	Yes	-	The id of the application to associate this manager with
manager[name]	String	Yes	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	Yes	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[ratio]	Integer	No	10	Maintains a dyno/rpm ratio
manager[new_relic_region]	String	Yes	-	Your account's region (either "us" or "eu")
manager[new_relic_api_key]	String	Yes	-	Your New Relic API key
manager[new_relic_app_id]	String	Yes	-	Your New Relic application id
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::NewRelic::V2::Apdex

Parameter	Type	Required	Default	Description
manager[application_id]	String	Yes	-	The id of the application to associate this manager with
manager[name]	String	Yes	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	Yes	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[minimum_apdex]	Integer	No	90	Scales up if your application's apdex goes below this amount
manager[maximum_apdex]	Integer	No	100	Scales down if your application's apdex is- or exceeds this amount
manager[new_relic_region]	String	Yes	-	Your account's region (either "us" or "eu")
manager[new_relic_api_key]	String	Yes	-	Your New Relic API key
manager[new_relic_app_id]	String	Yes	-	Your New Relic application id
manager[upscale_quantity]	Integer	No	1	The amount of dynos to scale up at a time
manager[downscale_quantity]	Integer	No	1	The amount of dynos to scale down at a time
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[scale_up_on_503]	Boolean	No	False	Scale up when your application returns HTTP/503 (Serivce Unavailable)
manager[url]	String \| Null	No	Null	Specify an URL to check for 503 responses
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::NewRelic::V1::ResponseTime - Legacy, prefer V2

Parameter	Type	Required	Default	Description
manager[application_id]	String	Yes	-	The id of the application to associate this manager with
manager[name]	String	Yes	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	Yes	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[minimum_response_time]	Integer	No	100	Scales down if your application's response time goes below this amount
manager[maximum_response_time]	Integer	No	300	Scales up if your application's response time exceeds this amount
manager[new_relic_api_key]	String	Yes	-	Your New Relic API key
manager[new_relic_account_id]	String	Yes	-	Your New Relic account id
manager[new_relic_app_id]	String	Yes	-	Your New Relic application id
manager[upscale_quantity]	Integer	No	1	The amount of dynos to scale up at a time
manager[downscale_quantity]	Integer	No	1	The amount of dynos to scale down at a time
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[scale_up_on_503]	Boolean	No	False	Scale up when your application returns HTTP/503 (Serivce Unavailable)
manager[url]	String \| Null	No	Null	Specify an URL to check for 503 responses
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::NewRelic::V1::RPM - Legacy, prefer V2

Parameter	Type	Required	Default	Description
manager[application_id]	String	Yes	-	The id of the application to associate this manager with
manager[name]	String	Yes	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	Yes	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[ratio]	Integer	No	10	Maintains a dyno/rpm ratio
manager[new_relic_api_key]	String	Yes	-	Your New Relic API key
manager[new_relic_account_id]	String	Yes	-	Your New Relic account id
manager[new_relic_app_id]	String	Yes	-	Your New Relic application id
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::NewRelic::V1::Apdex - Legacy, prefer V2

Parameter	Type	Required	Default	Description
manager[application_id]	String	Yes	-	The id of the application to associate this manager with
manager[name]	String	Yes	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	Yes	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[minimum_apdex]	Integer	No	90	Scales up if your application's apdex goes below this amount
manager[maximum_apdex]	Integer	No	100	Scales down if your application's apdex is- or exceeds this amount
manager[new_relic_api_key]	String	Yes	-	Your New Relic API key
manager[new_relic_account_id]	String	Yes	-	Your New Relic account id
manager[new_relic_app_id]	String	Yes	-	Your New Relic application id
manager[upscale_quantity]	Integer	No	1	The amount of dynos to scale up at a time
manager[downscale_quantity]	Integer	No	1	The amount of dynos to scale down at a time
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[scale_up_on_503]	Boolean	No	False	Scale up when your application returns HTTP/503 (Serivce Unavailable)
manager[url]	String \| Null	No	Null	Specify an URL to check for 503 responses
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::HireFire::ResponseTime - Legacy, prefer Logplex

Parameter	Type	Required	Default	Description
manager[application_id]	String	Yes	-	The id of the application to associate this manager with
manager[name]	String	Yes	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	Yes	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[minimum_response_time]	Integer	No	100	Scales down if your application's response time goes below this amount
manager[maximum_response_time]	Integer	No	300	Scales up if your application's response time exceeds this amount
manager[url]	String \| Null	No	Null	Specify an alternative URL to request for basic http checkups
manager[upscale_quantity]	Integer	No	1	The amount of dynos to scale up at a time
manager[downscale_quantity]	Integer	No	1	The amount of dynos to scale down at a time
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[scale_up_on_503]	Boolean	No	False	Scale up when your application returns HTTP/503 (Serivce Unavailable)
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager - Update

PATCH

https://api.hirefire.io/managers/:id

RESPONSE - Manager::Worker::HireFire::JobQueue

{
  "manager": {
    "id": "f7889faa-ed5e-4462-b68c-c2d347dfb5eb",
    "type": "Manager::Worker::HireFire::JobQueue",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "worker",
    "enabled": true,
    "metric_value": "0",
    "dyno_quantity": 0,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 0,
    "maximum": 3,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "ratio": 10,
    "decrementable": true,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "upscale_limit": 0,
    "downscale_limit": 0,
    "issue": null
  }
}

RESPONSE - Manager::Worker::HireFire::JobLatency

{
  "manager": {
    "id": "bc6b0b62-24b0-406f-bde3-3356b4da972e",
    "type": "Manager::Worker::HireFire::JobLatency",
    "application_id": "6bba10b2-de1b-4abb-bc3d-7dd4627d29ee",
    "name": "worker",
    "enabled": false,
    "metric_value": "0",
    "dyno_quantity": 0,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 0,
    "maximum": 1,
    "notify": false,
    "notify_quantity": 0,
    "notify_after": 0,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "minimum_latency": 100,
    "maximum_latency": 300,
    "upscale_on_initial_job": true,
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::HireFire::RequestQueueTime

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::HireFire::RequestQueueTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "200",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum_queue_time": 100,
    "maximum_queue_time": 500,
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::Logplex::Load

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::Logplex::Load",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum_load": 100,
    "maximum_load": 400,
    "last_minutes": 5,
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::Logplex::QueueTime

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::Logplex::QueueTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum_queue_time": 500,
    "maximum_queue_time": 2000,
    "aggregation": "average",
    "percentile": 1,
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::Logplex::ResponseTime

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::Logplex::ResponseTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum_response_time": 500,
    "maximum_response_time": 2000,
    "aggregation": "average",
    "percentile": 1,
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::Logplex::ConnectTime

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::Logplex::ConnectTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum_connect_time": 500,
    "maximum_connect_time": 2000,
    "aggregation": "average",
    "percentile": 1,
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1
    "issue": null
  }
}

RESPONSE - Manager::Web::Logplex::RPM

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::Logplex::RPM",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "ratio": 1200,
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1
    "issue": null
  }
}

RESPONSE - Manager::Web::NewRelic::V2::ResponseTime

{
  "manager": {
    "id": "efb7caff-c915-4344-ab32-f1430a17ba14",
    "type": "Manager::Web::NewRelic::V2::ResponseTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "new_relic_app_id": "1234567890",
    "new_relic_api_key": "NRAK-K17EVKVHLLRJAMSJ9V6DXIO8RPM",
    "new_relic_region": "us",
    "minimum_response_time": 100,
    "maximum_response_time": 1000,
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "scale_up_on_503": false,
    "url": "https://example.hirefire.io",
    "issue": null
  }
}

RESPONSE - Manager::Web::NewRelic::V2::RPM

{
  "manager": {
    "id": "1f757cf3-5f4a-46e9-b144-4a8983f563a7",
    "type": "Manager::Web::NewRelic::V2::RPM",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "new_relic_app_id": "1234567890",
    "new_relic_api_key": "NRAK-K17EVKVHLLRJAMSJ9V6DXIO8RPM",
    "new_relic_region": "us",
    "ratio": 3000,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::NewRelic::V2::Apdex

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::NewRelic::V2::Apdex",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "new_relic_app_id": "1234567890",
    "new_relic_api_key": "NRAK-K17EVKVHLLRJAMSJ9V6DXIO8RPM",
    "new_relic_region": "us",
    "minimum_apdex": 90,
    "maximum_apdex": 100,
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "scale_up_on_503": false,
    "url": "https://example.hirefire.io",
    "issue": null
  }
}

RESPONSE - Manager::Web::NewRelic::V1::ResponseTime (Legacy, prefer V2)

{
  "manager": {
    "id": "efb7caff-c915-4344-ab32-f1430a17ba14",
    "type": "Manager::Web::NewRelic::V1::ResponseTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "new_relic_account_id": "1234567890",
    "new_relic_app_id": "1234567890",
    "new_relic_api_key": "NRAK-K17EVKVHLLRJAMSJ9V6DXIO8RPM",
    "minimum_response_time": 100,
    "maximum_response_time": 1000,
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "scale_up_on_503": false,
    "url": "https://example.hirefire.io",
    "issue": null
  }
}

RESPONSE - Manager::Web::NewRelic::V1::RPM (Legacy, prefer V2)

{
  "manager": {
    "id": "1f757cf3-5f4a-46e9-b144-4a8983f563a7",
    "type": "Manager::Web::NewRelic::V1::RPM",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "new_relic_account_id": "1234567890",
    "new_relic_app_id": "1234567890",
    "new_relic_api_key": "NRAK-K17EVKVHLLRJAMSJ9V6DXIO8RPM",
    "ratio": 3000,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::NewRelic::V1::Apdex (Legacy, prefer V2)

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::NewRelic::V1::Apdex",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "new_relic_account_id": "1234567890",
    "new_relic_app_id": "1234567890",
    "new_relic_api_key": "NRAK-K17EVKVHLLRJAMSJ9V6DXIO8RPM",
    "minimum_apdex": 90,
    "maximum_apdex": 100,
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "scale_up_on_503": false,
    "url": "https://example.hirefire.io",
    "issue": null
  }
}

RESPONSE - Manager::Web::HireFire::ResponseTime (Legacy, prefer Logplex)

{
  "manager": {
    "id": "efa63389-688c-44ff-85ee-6b23d839f13d",
    "type": "Manager::Web::HireFire::ResponseTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "461",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 1,
    "notify": true,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "minimum_response_time": 100,
    "maximum_response_time": 800,
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "scale_up_on_503": false,
    "url": "https://example.hirefire.io",
    "issue": null
  }
}

Updates a manager.

The available parameters depends on the manager type, see tables below.

Manager::Worker::HireFire::JobQueue

Parameter	Type	Required	Default	Description
id	String	Yes	-	The id of the manager to update
manager[name]	String	No	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	No	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[ratio]	Integer	No	10	Maintains a dyno/job ratio
manager[decrementable]	Boolean	No	True	Allows scaling down to non-zero values when there are still jobs in the queue
manager[upscale_limit]	Integer	No	0	Limits the amount of dynos by which the manager scales up at a time (0 means no limit)
manager[downscale_limit]	Integer	No	0	Limits the amount of dynos by which the manager scales down at a time (0 means no limit)
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Worker::HireFire::JobLatency

Parameter	Type	Required	Default	Description
id	String	Yes	-	The id of the manager to update
manager[name]	String	No	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	No	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[minimum_latency]	Integer	No	100	Scale down when latency gets below N seconds.
manager[maximum_latency]	Integer	No	300	Scale up when latency exceeds N seconds.
manager[upscale_on_initial_job]	Boolean	No	True	Ensures the availability of at least one dyno when one or more jobs are enqueued, bypassing the initial maximum latency requirement.
manager[upscale_quantity]	Integer	No	1	The amount of dynos to scale up at a time
manager[downscale_quantity]	Integer	No	1	The amount of dynos to scale down at a time
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::HireFire::RequestQueueTime

Parameter	Type	Required	Default	Description
id	String	Yes	-	The id of the manager to update
manager[name]	String	No	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	No	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[minimum_queue_time]	Integer	No	100	Scale down when queue times get below N milliseconds
manager[maximum_queue_time]	Integer	No	300	Scale up when queue times exceed N milliseconds
manager[upscale_quantity]	Integer	No	1	The amount of dynos to scale up at a time
manager[downscale_quantity]	Integer	No	1	The amount of dynos to scale down at a time
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::Logplex::Load

Parameter	Type	Required	Default	Description
id	String	Yes	-	The id of the manager to update
manager[name]	String	No	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	No	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[minimum_load]	Integer	No	100	Scales down if your application's load goes below this amount
manager[maximum_load]	Integer	No	300	Scales up if your application's load exceeds this amount
manager[last_minutes]	Integer	No	1	The load average over the last n minutes. Possible values are 1, 5 and 15
manager[upscale_quantity]	Integer	No	1	The amount of dynos to scale up at a time
manager[downscale_quantity]	Integer	No	1	The amount of dynos to scale down at a time
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::Logplex::QueueTime

Parameter	Type	Required	Default	Description
id	String	Yes	-	The id of the manager to update
manager[name]	String	No	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	No	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[minimum_queue_time]	Integer	No	100	Scale down when queue times get below N milliseconds
manager[maximum_queue_time]	Integer	No	300	Scale up when queue times exceed N milliseconds
manager[aggregation]	String	No	"percentile"	Determines how the metric is aggregated. Possible values are "average" and "percentile"
manager[percentile]	Integer	No	95	The percentile to use (when aggregation is set to "percentile")
manager[upscale_quantity]	Integer	No	1	The amount of dynos to scale up at a time
manager[downscale_quantity]	Integer	No	1	The amount of dynos to scale down at a time
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::Logplex::ResponseTime

Parameter	Type	Required	Default	Description
id	String	Yes	-	The id of the manager to update
manager[name]	String	No	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	No	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[minimum_response_time]	Integer	No	100	Scales down if your application's response time goes below this amount
manager[maximum_response_time]	Integer	No	300	Scales up if your application's response time exceeds this amount
manager[aggregation]	String	No	"percentile"	Determines how the metric is aggregated. Possible values are "average" and "percentile"
manager[percentile]	Integer	No	95	The percentile to use (when aggregation is set to "percentile")
manager[upscale_quantity]	Integer	No	1	The amount of dynos to scale up at a time
manager[downscale_quantity]	Integer	No	1	The amount of dynos to scale down at a time
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::Logplex::ConnectTime

Parameter	Type	Required	Default	Description
id	String	Yes	-	The id of the manager to update
manager[name]	String	No	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	No	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[minimum_connect_time]	Integer	No	100	Scale down when connect times get below N milliseconds
manager[maximum_connect_time]	Integer	No	300	Scale up when connect times exceed N milliseconds
manager[aggregation]	String	No	"percentile"	Determines how the metric is aggregated. Possible values are "average" and "percentile"
manager[percentile]	Integer	No	95	The percentile to use (when aggregation is set to "percentile")
manager[upscale_quantity]	Integer	No	1	The amount of dynos to scale up at a time
manager[downscale_quantity]	Integer	No	1	The amount of dynos to scale down at a time
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::NewRelic::V2::ResponseTime

Parameter	Type	Required	Default	Description
id	String	Yes	-	The id of the manager to update
manager[name]	String	No	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	No	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[minimum_response_time]	Integer	No	100	Scales down if your application's response time goes below this amount
manager[maximum_response_time]	Integer	No	300	Scales up if your application's response time exceeds this amount
manager[new_relic_region]	String	No	-	Your account's region (either "us" or "eu")
manager[new_relic_api_key]	String	No	-	Your New Relic API key
manager[new_relic_app_id]	String	No	-	Your New Relic application id
manager[upscale_quantity]	Integer	No	1	The amount of dynos to scale up at a time
manager[downscale_quantity]	Integer	No	1	The amount of dynos to scale down at a time
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[scale_up_on_503]	Boolean	No	False	Scale up when your application returns HTTP/503 (Serivce Unavailable)
manager[url]	String \| Null	No	Null	Specify an URL to check for 503 responses
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::NewRelic::V2::RPM

Parameter	Type	Required	Default	Description
id	String	Yes	-	The id of the manager to update
manager[name]	String	No	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	No	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[ratio]	Integer	No	10	Maintains a dyno/rpm ratio
manager[new_relic_region]	String	No	-	Your account's region (either "us" or "eu")
manager[new_relic_api_key]	String	No	-	Your New Relic API key
manager[new_relic_app_id]	String	No	-	Your New Relic application id
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::NewRelic::V2::Apdex

Parameter	Type	Required	Default	Description
id	String	Yes	-	The id of the manager to update
manager[name]	String	No	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	No	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[minimum_apdex]	Integer	No	90	Scales up if your application's apdex goes below this amount
manager[maximum_apdex]	Integer	No	100	Scales down if your application's apdex is- or exceeds this amount
manager[new_relic_region]	String	No	-	Your account's region (either "us" or "eu")
manager[new_relic_api_key]	String	No	-	Your New Relic API key
manager[new_relic_app_id]	String	No	-	Your New Relic application id
manager[upscale_quantity]	Integer	No	1	The amount of dynos to scale up at a time
manager[downscale_quantity]	Integer	No	1	The amount of dynos to scale down at a time
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[scale_up_on_503]	Boolean	No	False	Scale up when your application returns HTTP/503 (Serivce Unavailable)
manager[url]	String \| Null	No	Null	Specify an URL to check for 503 responses
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::NewRelic::V1::ResponseTime - Legacy, prefer V2

Parameter	Type	Required	Default	Description
id	String	Yes	-	The id of the manager to update
manager[name]	String	No	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	No	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[minimum_response_time]	Integer	No	100	Scales down if your application's response time goes below this amount
manager[maximum_response_time]	Integer	No	300	Scales up if your application's response time exceeds this amount
manager[new_relic_api_key]	String	No	-	Your New Relic API key
manager[new_relic_account_id]	String	No	-	Your New Relic account id
manager[new_relic_app_id]	String	No	-	Your New Relic application id
manager[upscale_quantity]	Integer	No	1	The amount of dynos to scale up at a time
manager[downscale_quantity]	Integer	No	1	The amount of dynos to scale down at a time
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[scale_up_on_503]	Boolean	No	False	Scale up when your application returns HTTP/503 (Serivce Unavailable)
manager[url]	String \| Null	No	Null	Specify an URL to check for 503 responses
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::NewRelic::V1::RPM - Legacy, prefer V2

Parameter	Type	Required	Default	Description
id	String	Yes	-	The id of the manager to update
manager[name]	String	No	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	No	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[ratio]	Integer	No	10	Maintains a dyno/rpm ratio
manager[new_relic_api_key]	String	No	-	Your New Relic API key
manager[new_relic_account_id]	String	No	-	Your New Relic account id
manager[new_relic_app_id]	String	No	-	Your New Relic application id
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::NewRelic::V1::Apdex - Legacy, prefer V2

Parameter	Type	Required	Default	Description
id	String	Yes	-	The id of the manager to update
manager[name]	String	No	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	No	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[minimum_apdex]	Integer	No	90	Scales up if your application's apdex goes below this amount
manager[maximum_apdex]	Integer	No	100	Scales down if your application's apdex is- or exceeds this amount
manager[new_relic_api_key]	String	No	-	Your New Relic API key
manager[new_relic_account_id]	String	No	-	Your New Relic account id
manager[new_relic_app_id]	String	No	-	Your New Relic application id
manager[upscale_quantity]	Integer	No	1	The amount of dynos to scale up at a time
manager[downscale_quantity]	Integer	No	1	The amount of dynos to scale down at a time
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[scale_up_on_503]	Boolean	No	False	Scale up when your application returns HTTP/503 (Serivce Unavailable)
manager[url]	String \| Null	No	Null	Specify an URL to check for 503 responses
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::HireFire::ResponseTime - Legacy, prefer Logplex

Parameter	Type	Required	Default	Description
id	String	Yes	-	The id of the manager to update
manager[name]	String	No	-	The name of the manager to use (must match dyno name on Heroku)
manager[type]	String	No	-	The manager type (see type list)
manager[enabled]	Boolean	No	False	Set to true to enable the manager (autoscaling)
manager[minimum]	Integer	No	1	The minimum amount of dynos to run at any given time
manager[maximum]	Integer	No	1	The maximum amount of dynos to run at any given time
manager[minimum_response_time]	Integer	No	100	Scales down if your application's response time goes below this amount
manager[maximum_response_time]	Integer	No	300	Scales up if your application's response time exceeds this amount
manager[url]	String \| Null	No	Null	Specify an alternative URL to request for basic http checkups
manager[upscale_quantity]	Integer	No	1	The amount of dynos to scale up at a time
manager[downscale_quantity]	Integer	No	1	The amount of dynos to scale down at a time
manager[upscale_sensitivity]	Integer	No	1	Require N amount of consecutive upscaling events before actually scaling up
manager[downscale_sensitivity]	Integer	No	1	Require N amount of consecutive downscaling events before actually scaling down
manager[upscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another upscaling event since the last upscaling event.
manager[downscale_timeout]	Integer	No	0	The amount of time, in minutes, to wait before allowing another downscaling operation since the last downscaling event.
manager[scale_up_on_503]	Boolean	No	False	Scale up when your application returns HTTP/503 (Serivce Unavailable)
manager[notify]	Boolean	No	False	Whether or not to send notifications
manager[notify_quantity]	Integer	No	0	Notify when your dyno quantity exceeds this amount
manager[notify_after]	Integer	No	0	Notify after the quantity has been exceeded for this amount (in minutes)

Manager - Delete

DELETE

https://api.hirefire.io/managers/:id

RESPONSE - Manager::Worker::HireFire::JobQueue

{
  "manager": {
    "id": "f7889faa-ed5e-4462-b68c-c2d347dfb5eb",
    "type": "Manager::Worker::HireFire::JobQueue",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "worker",
    "enabled": true,
    "metric_value": "0",
    "dyno_quantity": 0,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 0,
    "maximum": 3,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "ratio": 10,
    "decrementable": true,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "upscale_limit": 0,
    "downscale_limit": 0,
    "issue": null
  }
}

RESPONSE - Manager::Worker::HireFire::JobLatency

{
  "manager": {
    "id": "bc6b0b62-24b0-406f-bde3-3356b4da972e",
    "type": "Manager::Worker::HireFire::JobLatency",
    "application_id": "6bba10b2-de1b-4abb-bc3d-7dd4627d29ee",
    "name": "worker",
    "enabled": false,
    "metric_value": "0",
    "dyno_quantity": 0,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 0,
    "maximum": 1,
    "notify": false,
    "notify_quantity": 0,
    "notify_after": 0,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "minimum_latency": 100,
    "maximum_latency": 300,
    "upscale_on_initial_job": true,
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::HireFire::RequestQueueTime

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::HireFire::RequestQueueTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "200",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum_queue_time": 100,
    "maximum_queue_time": 500,
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::Logplex::Load

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::Logplex::Load",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum_load": 100,
    "maximum_load": 400,
    "last_minutes": 5,
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::Logplex::QueueTime

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::Logplex::QueueTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum_queue_time": 500,
    "maximum_queue_time": 2000,
    "aggregation": "average",
    "percentile": 1,
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::Logplex::ResponseTime

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::Logplex::ResponseTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum_response_time": 500,
    "maximum_response_time": 2000,
    "aggregation": "average",
    "percentile": 1,
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::Logplex::ConnectTime

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::Logplex::ConnectTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum_connect_time": 500,
    "maximum_connect_time": 2000,
    "aggregation": "average",
    "percentile": 1,
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1
    "issue": null
  }
}

RESPONSE - Manager::Web::Logplex::RPM

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::Logplex::RPM",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "ratio": 1200,
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1
    "issue": null
  }
}

RESPONSE - Manager::Web::NewRelic::V2::ResponseTime

{
  "manager": {
    "id": "efb7caff-c915-4344-ab32-f1430a17ba14",
    "type": "Manager::Web::NewRelic::V2::ResponseTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "new_relic_app_id": "1234567890",
    "new_relic_api_key": "NRAK-K17EVKVHLLRJAMSJ9V6DXIO8RPM",
    "new_relic_region": "us",
    "minimum_response_time": 100,
    "maximum_response_time": 1000,
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "scale_up_on_503": false,
    "url": "https://example.hirefire.io",
    "issue": null
  }
}

RESPONSE - Manager::Web::NewRelic::V2::RPM

{
  "manager": {
    "id": "1f757cf3-5f4a-46e9-b144-4a8983f563a7",
    "type": "Manager::Web::NewRelic::V2::RPM",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "new_relic_app_id": "1234567890",
    "new_relic_api_key": "NRAK-K17EVKVHLLRJAMSJ9V6DXIO8RPM",
    "new_relic_region": "us",
    "ratio": 3000,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::NewRelic::V2::Apdex

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::NewRelic::V2::Apdex",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "new_relic_app_id": "1234567890",
    "new_relic_api_key": "NRAK-K17EVKVHLLRJAMSJ9V6DXIO8RPM",
    "new_relic_region": "us",
    "minimum_apdex": 90,
    "maximum_apdex": 100,
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "scale_up_on_503": false,
    "url": "https://example.hirefire.io",
    "issue": null
  }
}

RESPONSE - Manager::Web::NewRelic::V1::ResponseTime (Legacy, prefer V2)

{
  "manager": {
    "id": "efb7caff-c915-4344-ab32-f1430a17ba14",
    "type": "Manager::Web::NewRelic::V1::ResponseTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "new_relic_account_id": "1234567890",
    "new_relic_app_id": "1234567890",
    "new_relic_api_key": "NRAK-K17EVKVHLLRJAMSJ9V6DXIO8RPM",
    "minimum_response_time": 100,
    "maximum_response_time": 1000,
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "scale_up_on_503": false,
    "url": "https://example.hirefire.io",
    "issue": null
  }
}

RESPONSE - Manager::Web::NewRelic::V1::RPM (Legacy, prefer V2)

{
  "manager": {
    "id": "1f757cf3-5f4a-46e9-b144-4a8983f563a7",
    "type": "Manager::Web::NewRelic::V1::RPM",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "new_relic_account_id": "1234567890",
    "new_relic_app_id": "1234567890",
    "new_relic_api_key": "NRAK-K17EVKVHLLRJAMSJ9V6DXIO8RPM",
    "ratio": 3000,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "issue": null
  }
}

RESPONSE - Manager::Web::NewRelic::V1::Apdex (Legacy, prefer V2)

{
  "manager": {
    "id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
    "type": "Manager::Web::NewRelic::V1::Apdex",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "500",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 10,
    "notify": false,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "new_relic_account_id": "1234567890",
    "new_relic_app_id": "1234567890",
    "new_relic_api_key": "NRAK-K17EVKVHLLRJAMSJ9V6DXIO8RPM",
    "minimum_apdex": 90,
    "maximum_apdex": 100,
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "scale_up_on_503": false,
    "url": "https://example.hirefire.io",
    "issue": null
  }
}

RESPONSE - Manager::Web::HireFire::ResponseTime (Legacy, prefer Logplex)

{
  "manager": {
    "id": "efa63389-688c-44ff-85ee-6b23d839f13d",
    "type": "Manager::Web::HireFire::ResponseTime",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "name": "web",
    "enabled": true,
    "metric_value": "461",
    "dyno_quantity": 1,
    "last_checkup_time": "2015-01-01T00:00:00.000Z",
    "last_scale_time": "2015-01-01T00:00:00.000Z",
    "minimum": 1,
    "maximum": 1,
    "notify": true,
    "notify_quantity": 1,
    "notify_after": 1,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "minimum_response_time": 100,
    "maximum_response_time": 800,
    "upscale_quantity": 1,
    "downscale_quantity": 1,
    "upscale_sensitivity": 1,
    "downscale_sensitivity": 1,
    "upscale_timeout": 1,
    "downscale_timeout": 1,
    "scale_up_on_503": false,
    "url": "https://example.hirefire.io",
    "issue": null
  }
}

Parameter	Type	Required	Description
id	String	Yes	The manager id

Manager Type List

The following is a list of the available manager types:

Manager::Worker::HireFire::JobQueue
Manager::Worker::HireFire::JobLatency
Manager::Web::HireFire::RequestQueueTime
Manager::Web::HireFire::ResponseTime (Legacy: prefer RequestQueueTime)
Manager::Web::Logplex::Load (Note: also supports worker dynos)
Manager::Web::Logplex::ConnectTime
Manager::Web::Logplex::ResponseTime
Manager::Web::Logplex::QueueTime
Manager::Web::Logplex::RPM
Manager::Web::NewRelic::V2::Apdex
Manager::Web::NewRelic::V2::ResponseTime
Manager::Web::NewRelic::V2::RPM
Manager::Web::NewRelic::V1::Apdex (Legacy, prefer V2)
Manager::Web::NewRelic::V1::ResponseTime (Legacy, prefer V2)
Manager::Web::NewRelic::V1::RPM (Legacy, prefer V2)

Recipient

Recipient - List

GET

https://api.hirefire.io/applications/:id/recipients

RESPONSE

{
  "recipients": [
    {
      "id": "24bcd15d-3bed-475e-8a87-afd3becf6c79",
      "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
      "email": "example+user@hirefire.io",
      "created_at": "2015-01-01T00:00:00.000Z",
      "updated_at": "2015-01-01T00:00:00.000Z"
    }
  ]
}

Returns a list of recipients.

Parameter	Type	Required	Description
id	String	Yes	The application id

Recipient - Show

GET

https://api.hirefire.io/recipients/:id

RESPONSE

{
  "recipient": {
    "id": "24bcd15d-3bed-475e-8a87-afd3becf6c79",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "email": "example+user@hirefire.io",
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z"
  }
}

Returns a recipient.

Parameter	Type	Required	Description
id	String	Yes	The recipient's id

Recipient - Create

POST

https://api.hirefire.io/recipients

RESPONSE

{
  "recipient": {
    "id": "24bcd15d-3bed-475e-8a87-afd3becf6c79",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "email": "example+user@hirefire.io",
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z"
  }
}

Creates a recipient.

Recipients receive new- and resolved issue notifications.

Parameter	Type	Required	Default	Description
recipient[application_id]	String	Yes	-	The application to add the recipient to
recipient[email]	String	Yes	-	The email address of the recipient

Recipient - Update

PATCH

https://api.hirefire.io/recipients/:id

RESPONSE

{
  "recipient": {
    "id": "24bcd15d-3bed-475e-8a87-afd3becf6c79",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "email": "example+user@hirefire.io",
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z"
  }
}

Updates a recipient.

Recipients receive new- and resolved issue notifications.

Parameter	Type	Required	Default	Description
id	String	Yes	-	The recipient id
recipient[email]	String	No	-	The email address of the recipient

Recipient - Delete

DELETE

https://api.hirefire.io/recipients/:id

RESPONSE

{
  "recipient": {
    "id": "24bcd15d-3bed-475e-8a87-afd3becf6c79",
    "application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "email": "example+user@hirefire.io",
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z"
  }
}

Deletes a recipient.

Parameter	Type	Required	Description
id	String	Yes	The id of the recipient

Time Range

Time Range - List

GET

https://api.hirefire.io/managers/:id/time_ranges

RESPONSE

{
  "time_ranges": [
    {
      "id": "bf561643-2fce-4b7b-b2e1-5c010341f824",
      "manager_id": "efa63389-688c-44ff-85ee-6b23d839f13d",
      "from_minute": 360,
      "until_minute": 720,
      "minimum": 1,
      "maximum": 3,
      "position": 0,
      "monday": true,
      "tuesday": true,
      "wednesday": true,
      "thursday": true,
      "friday": true,
      "saturday": false,
      "sunday": false,
      "note": "Configuration for workday mornings"
    }
  ]
}

Returns a list of time ranges.

Parameter	Type	Required	Description
id	String	Yes	The id of the manager

Time Range - Show

GET

https://api.hirefire.io/time_ranges/:id

RESPONSE

{
  "time_range": {
    "id": "bf561643-2fce-4b7b-b2e1-5c010341f824",
    "manager_id": "efa63389-688c-44ff-85ee-6b23d839f13d",
    "from_minute": 360,
    "until_minute": 720,
    "minimum": 1,
    "maximum": 3,
    "position": 0,
    "monday": true,
    "tuesday": true,
    "wednesday": true,
    "thursday": true,
    "friday": true,
    "saturday": false,
    "sunday": false,
    "note": "Configuration for workday mornings"
  }
}

Returns a time range.

Parameter	Type	Required	Description
id	String	Yes	The id of the time range

Time Range - Create

POST

https://api.hirefire.io/time_ranges

RESPONSE

{
  "time_range": {
    "id": "bf561643-2fce-4b7b-b2e1-5c010341f824",
    "manager_id": "efa63389-688c-44ff-85ee-6b23d839f13d",
    "from_minute": 360,
    "until_minute": 720,
    "minimum": 1,
    "maximum": 3,
    "position": 0,
    "monday": true,
    "tuesday": true,
    "wednesday": true,
    "thursday": true,
    "friday": true,
    "saturday": false,
    "sunday": false,
    "note": "Configuration for workday mornings"
  }
}

Creates a time range.

Parameter	Type	Required	Default	Description
time_range[manager_id]	String	Yes	-	The manager to add the time range to
time_range[from_minute]	Integer	Yes	-	The minute of the day that this time range should start applying (min: 0, max: 1439)
time_range[until_minute]	Integer	Yes	-	The minute of the day when this time range should no longer apply (min: 0, max: 1439)
time_range[minimum]	Integer	Yes	-	The minimum dyno quantity while the time range is active
time_range[maximum]	Integer	Yes	-	The maximum dyno quantity while the time range is active
time_range[position]	Integer	No	(1)	The position (order) of the time range
time_range[monday]	Boolean	No	False	The time range should apply on Monday
time_range[tuesday]	Boolean	No	False	The time range should apply on Tuesday
time_range[wednesday]	Boolean	No	False	The time range should apply on Wednesday
time_range[thursday]	Boolean	No	False	The time range should apply on Thursday
time_range[friday]	Boolean	No	False	The time range should apply on Friday
time_range[saturday]	Boolean	No	False	The time range should apply on Saturday
time_range[sunday]	Boolean	No	False	The time range should apply on Sunday
time_range[note]	String \| Null	No	Null	An optional note

Time Range - Update

PATCH

https://api.hirefire.io/time_ranges/:id

RESPONSE

{
  "time_range": {
    "id": "bf561643-2fce-4b7b-b2e1-5c010341f824",
    "manager_id": "efa63389-688c-44ff-85ee-6b23d839f13d",
    "from_minute": 360,
    "until_minute": 720,
    "minimum": 1,
    "maximum": 3,
    "position": 0,
    "monday": true,
    "tuesday": true,
    "wednesday": true,
    "thursday": true,
    "friday": true,
    "saturday": false,
    "sunday": false,
    "note": "Configuration for workday mornings"
  }
}

Updates a time range.

Parameter	Type	Required	Default	Description
id	String	Yes	-	The time range id
time_range[from_minute]	Integer	No	-	The minute of the day that this time range should start applying (min: 0, max: 1439)
time_range[until_minute]	Integer	No	-	The minute of the day when this time range should no longer apply (min: 0, max: 1439)
time_range[minimum]	Integer	No	-	The minimum dyno quantity while the time range is active
time_range[maximum]	Integer	No	-	The maximum dyno quantity while the time range is active
time_range[position]	Integer	No	(1)	The position (order) of the time range
time_range[monday]	Boolean	No	False	The time range should apply on Monday
time_range[tuesday]	Boolean	No	False	The time range should apply on Tuesday
time_range[wednesday]	Boolean	No	False	The time range should apply on Wednesday
time_range[thursday]	Boolean	No	False	The time range should apply on Thursday
time_range[friday]	Boolean	No	False	The time range should apply on Friday
time_range[saturday]	Boolean	No	False	The time range should apply on Saturday
time_range[sunday]	Boolean	No	False	The time range should apply on Sunday
time_range[note]	String \| Null	No	Null	An optional note

Time Range - Delete

DELETE

https://api.hirefire.io/time_ranges/:id

RESPONSE

{
  "time_range": {
    "id": "bf561643-2fce-4b7b-b2e1-5c010341f824",
    "manager_id": "efa63389-688c-44ff-85ee-6b23d839f13d",
    "from_minute": 360,
    "until_minute": 720,
    "minimum": 1,
    "maximum": 3,
    "position": 0,
    "monday": true,
    "tuesday": true,
    "wednesday": true,
    "thursday": true,
    "friday": true,
    "saturday": false,
    "sunday": false,
    "note": "Configuration for workday mornings"
  }
}

Deletes a time range.

Parameter	Type	Required	Description
id	String	Yes	The id of the time range