NAV

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": "www.hirefire.io",
      "token": "ce4cd30d-f88b-4d37-a107-a4a8866d9576",
      "ssl": true,
      "restart_crashed_dynos": false,
      "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": {
    "name": ["can't be blank"]
  }
}

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",
      "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",
    "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",
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z"
  }
}

Only authorized to update self.

Parameter Type Required Description
id String Yes The user's id
user[current_password] String Yes The user's current password
user[email] String No The user's email address
user[password] String No The user's new password

User - Delete

DELETE

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

RESPONSE

{
  "user": {
    "id": "b1d994bd-1b57-4088-ab9d-bd2501d9612d",
    "email": "example+user@hirefire.io",
    "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",
      "manager_hours": 720,
      "hourly_rate": 0.03375,
      "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",
    "manager_hours": 720,
    "hourly_rate": 0.03375,
    "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",
    "manager_hours": 720,
    "hourly_rate": 0.03375,
    "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 Description
organization[name] String Yes The organization name
organization[time_zone] String Yes The organization time zone
organization[otp_required] Boolean Yes 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",
    "manager_hours": 720,
    "hourly_rate": 0.03375,
    "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 Description
id String Yes The organization id
organization[name] String Yes The organization name
organization[time_zone] String Yes The organization time zone
organization[otp_required] Boolean Yes 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",
    "manager_hours": 720,
    "hourly_rate": 0.03375,
    "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 Description
membership[user_id] String Yes The id of the user
membership[organization_id] String Yes The id of the organization
membership[owner] Boolean Yes 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 Description
id String Yes The membership id
membership[owner] Boolean Yes 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": "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"
  }
}

Creates a new account.

Note that this account must still be authorized in order to perform API calls against the Heroku Platform API. Use the browser to initiate an OAuth 2.0 operation by visiting the following URL:

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

Where the ACCOUNT_ID is the id of the newly created account.

The above URL will redirect the browser to Heroku to request authorization for the newly created account. After clicking “Allow” on Heroku’s OAuth page, the browser will be redirected back to HireFire, after which the newly created account is authorized.

The same URL can also be used to reauthorize accounts were authorization was previously revoked by the user. In addition to that, it can also be used to switch Heroku accounts by logging into a different Heroku account prior to visiting the URL.

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": "www.hirefire.io",
      "token": "ce4cd30d-f88b-4d37-a107-a4a8866d9576",
      "ssl": true,
      "restart_crashed_dynos": false,
      "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": {
    "id": "d53a72ef-884e-4af3-aa25-824b631e2634",
    "account_id": "6439cf4f-1f98-48fb-8058-2bea32ef4e1f",
    "name": "hirefire",
    "custom_domain": "www.hirefire.io",
    "token": "ce4cd30d-f88b-4d37-a107-a4a8866d9576",
    "ssl": true,
    "restart_crashed_dynos": false,
    "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 No 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": "www.hirefire.io",
    "token": "ce4cd30d-f88b-4d37-a107-a4a8866d9576",
    "ssl": true,
    "restart_crashed_dynos": false,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "issue": null
  }
}

Creates an application.

Parameter Type Required 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 Yes The frequency (in seconds) at which autoscaling operations are performed
application[custom_domain] String No The custom domain of the application
application[logplex_drain_token] String No The Heroku logplex drain token of the application
application[ssl] Boolean Yes Use SSL/TLS when performing requests to the application's backend
application[restart_crashed_dynos] Boolean Yes Restart dynos that entered a "crashed" state
application[new_issue_notifications] Boolean Yes Receive notifications when new issues occur
application[resolved_issue_notifications] Boolean Yes 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": "www.hirefire.io",
    "token": "ce4cd30d-f88b-4d37-a107-a4a8866d9576",
    "ssl": true,
    "restart_crashed_dynos": false,
    "created_at": "2015-01-01T00:00:00.000Z",
    "updated_at": "2015-01-01T00:00:00.000Z",
    "issue": null
  }
}

Updates an application.

Parameter Type Required Description
id String Yes The membership id
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 Yes The frequency (in seconds) at which autoscaling operations are performed
application[custom_domain] String No The custom domain of the application
application[logplex_drain_token] String No The Heroku logplex drain token of the application
application[ssl] Boolean Yes Use SSL/TLS when performing requests to the application's backend
application[restart_crashed_dynos] Boolean Yes Restart dynos that entered a "crashed" state
application[new_issue_notifications] Boolean Yes Receive notifications when new issues occur
application[resolved_issue_notifications] Boolean Yes 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": "www.hirefire.io",
    "token": "ce4cd30d-f88b-4d37-a107-a4a8866d9576",
    "ssl": true,
    "restart_crashed_dynos": false,
    "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 - Example manager.issue object

{
  "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."
    }
  }
}

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_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_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,
    "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_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_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,
    "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": "bar",
    "new_relic_app_id": "foo",
    "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,
    "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": "bar",
    "new_relic_app_id": "foo",
    "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": "bar",
    "new_relic_app_id": "foo",
    "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_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_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,
    "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_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_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,
    "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": "bar",
    "new_relic_app_id": "foo",
    "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,
    "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": "bar",
    "new_relic_app_id": "foo",
    "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": "bar",
    "new_relic_app_id": "foo",
    "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 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 Yes Set to true to enable the manager (autoscaling)
manager[minimum] Integer Yes The minimum amount of dynos to run at any given time
manager[maximum] Integer Yes The maximum amount of dynos to run at any given time
manager[ratio] Integer Yes Maintains a dyno/job ratio
manager[decrementable] Boolean Yes Allows scaling down to non-zero values when there are still jobs in the queue
manager[upscale_limit] Integer Yes Limits the amount of dynos by which the manager scales up at a time (0 means no limit)
manager[downscale_limit] Integer Yes Limits the amount of dynos by which the manager scales down at a time (0 means no limit)
manager[upscale_sensitivity] Integer Yes The amount of times to wait before actually scaling up
manager[downscale_sensitivity] Integer Yes The amount of times to wait before actually scaling down
manager[upscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing upscale operations
manager[downscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing downscale operations
manager[notify] Boolean Yes Whether or not to send notifications
manager[notify_quantity] Integer No Notify when your dyno quantity exceeds this amount
manager[notify_after] Integer No Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Worker::HireFire::JobLatency

Parameter Type Required 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 Yes Set to true to enable the manager (autoscaling)
manager[minimum] Integer Yes The minimum amount of dynos to run at any given time
manager[maximum] Integer Yes The maximum amount of dynos to run at any given time
manager[minimum_latency] Integer Yes Scale down when latency gets below N seconds.
manager[maximum_latency] Integer Yes Scale up when latency exceeds N seconds.
manager[upscale_quantity] Integer Yes The amount of dynos to scale up at a time
manager[downscale_quantity] Integer Yes The amount of dynos to scale down at a time
manager[upscale_sensitivity] Integer Yes The amount of times to wait before actually scaling up
manager[downscale_sensitivity] Integer Yes The amount of times to wait before actually scaling down
manager[upscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing upscale operations
manager[downscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing downscale operations
manager[notify] Boolean Yes Whether or not to send notifications
manager[notify_quantity] Integer No Notify when your dyno quantity exceeds this amount
manager[notify_after] Integer No Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::Logplex::Load

Parameter Type Required 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 Yes Set to true to enable the manager (autoscaling)
manager[minimum] Integer Yes The minimum amount of dynos to run at any given time
manager[maximum] Integer Yes The maximum amount of dynos to run at any given time
manager[minimum_load] Integer Yes Scales down if your application's load goes below this amount
manager[maximum_load] Integer Yes Scales up if your application's load exceeds this amount
manager[last_minutes] Integer Yes The load average over the last n minutes. Possible values are 1, 5 and 15
manager[upscale_quantity] Integer Yes The amount of dynos to scale up at a time
manager[downscale_quantity] Integer Yes The amount of dynos to scale down at a time
manager[upscale_sensitivity] Integer Yes The amount of times to wait before actually scaling up
manager[downscale_sensitivity] Integer Yes The amount of times to wait before actually scaling down
manager[upscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing upscale operations
manager[downscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing downscale operations
manager[notify] Boolean Yes Whether or not to send notifications
manager[notify_quantity] Integer No Notify when your dyno quantity exceeds this amount
manager[notify_after] Integer No Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::Logplex::QueueTime

Parameter Type Required 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 Yes Set to true to enable the manager (autoscaling)
manager[minimum] Integer Yes The minimum amount of dynos to run at any given time
manager[maximum] Integer Yes The maximum amount of dynos to run at any given time
manager[minimum_queue_time] Integer Yes Scale down when queue times get below N milliseconds
manager[maximum_queue_time] Integer Yes Scale up when queue times exceed N milliseconds
manager[aggregation] String Yes Determines how the metric is aggregated. Possible values are "average" and "percentile"
manager[percentile] Integer No The percentile to use (when aggregation is set to "percentile")
manager[upscale_quantity] Integer Yes The amount of dynos to scale up at a time
manager[downscale_quantity] Integer Yes The amount of dynos to scale down at a time
manager[upscale_sensitivity] Integer Yes The amount of times to wait before actually scaling up
manager[downscale_sensitivity] Integer Yes The amount of times to wait before actually scaling down
manager[upscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing upscale operations
manager[downscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing downscale operations
manager[notify] Boolean Yes Whether or not to send notifications
manager[notify_quantity] Integer No Notify when your dyno quantity exceeds this amount
manager[notify_after] Integer No Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::Logplex::ResponseTime

Parameter Type Required 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 Yes Set to true to enable the manager (autoscaling)
manager[minimum] Integer Yes The minimum amount of dynos to run at any given time
manager[maximum] Integer Yes The maximum amount of dynos to run at any given time
manager[minimum_response_time] Integer Yes Scales down if your application's response time goes below this amount
manager[maximum_response_time] Integer Yes Scales up if your application's response time exceeds this amount
manager[aggregation] String Yes Determines how the metric is aggregated. Possible values are "average" and "percentile"
manager[percentile] Integer No The percentile to use (when aggregation is set to "percentile")
manager[upscale_quantity] Integer Yes The amount of dynos to scale up at a time
manager[downscale_quantity] Integer Yes The amount of dynos to scale down at a time
manager[upscale_sensitivity] Integer Yes The amount of times to wait before actually scaling up
manager[downscale_sensitivity] Integer Yes The amount of times to wait before actually scaling down
manager[upscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing upscale operations
manager[downscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing downscale operations
manager[notify] Boolean Yes Whether or not to send notifications
manager[notify_quantity] Integer No Notify when your dyno quantity exceeds this amount
manager[notify_after] Integer No Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::Logplex::ConnectTime

Parameter Type Required 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 Yes Set to true to enable the manager (autoscaling)
manager[minimum] Integer Yes The minimum amount of dynos to run at any given time
manager[maximum] Integer Yes The maximum amount of dynos to run at any given time
manager[minimum_connect_time] Integer Yes Scale down when connect times get below N milliseconds
manager[maximum_connect_time] Integer Yes Scale up when connect times exceed N milliseconds
manager[aggregation] String Yes Determines how the metric is aggregated. Possible values are "average" and "percentile"
manager[percentile] Integer No The percentile to use (when aggregation is set to "percentile")
manager[upscale_quantity] Integer Yes The amount of dynos to scale up at a time
manager[downscale_quantity] Integer Yes The amount of dynos to scale down at a time
manager[upscale_sensitivity] Integer Yes The amount of times to wait before actually scaling up
manager[downscale_sensitivity] Integer Yes The amount of times to wait before actually scaling down
manager[upscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing upscale operations
manager[downscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing downscale operations
manager[notify] Boolean Yes Whether or not to send notifications
manager[notify_quantity] Integer No Notify when your dyno quantity exceeds this amount
manager[notify_after] Integer No Notify after the quantity has been exceeded for this amount (in minutes)

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

Parameter Type Required 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 Yes Set to true to enable the manager (autoscaling)
manager[minimum] Integer Yes The minimum amount of dynos to run at any given time
manager[maximum] Integer Yes The maximum amount of dynos to run at any given time
manager[minimum_response_time] Integer Yes Scales down if your application's response time goes below this amount
manager[maximum_response_time] Integer Yes 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 Yes The amount of dynos to scale up at a time
manager[downscale_quantity] Integer Yes The amount of dynos to scale down at a time
manager[upscale_sensitivity] Integer Yes The amount of times to wait before actually scaling up
manager[downscale_sensitivity] Integer Yes The amount of times to wait before actually scaling down
manager[upscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing upscale operations
manager[downscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing downscale operations
manager[scale_up_on_503] Boolean Yes Scale up when your application returns HTTP/503 (Serivce Unavailable)
manager[url] String No Specify an URL to check for 503 responses
manager[notify] Boolean Yes Whether or not to send notifications
manager[notify_quantity] Integer No Notify when your dyno quantity exceeds this amount
manager[notify_after] Integer No Notify after the quantity has been exceeded for this amount (in minutes)

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

Parameter Type Required 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 Yes Set to true to enable the manager (autoscaling)
manager[minimum] Integer Yes The minimum amount of dynos to run at any given time
manager[maximum] Integer Yes The maximum amount of dynos to run at any given time
manager[ratio] Integer Yes 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 Yes The amount of times to wait before actually scaling up
manager[downscale_sensitivity] Integer Yes The amount of times to wait before actually scaling down
manager[upscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing upscale operations
manager[downscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing downscale operations
manager[notify] Boolean Yes Whether or not to send notifications
manager[notify_quantity] Integer No Notify when your dyno quantity exceeds this amount
manager[notify_after] Integer No Notify after the quantity has been exceeded for this amount (in minutes)

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

Parameter Type Required 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 Yes Set to true to enable the manager (autoscaling)
manager[minimum] Integer Yes The minimum amount of dynos to run at any given time
manager[maximum] Integer Yes The maximum amount of dynos to run at any given time
manager[minimum_apdex] Integer Yes Scales up if your application's apdex goes below this amount
manager[maximum_apdex] Integer Yes Scales down if your application's apdex 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 Yes The amount of dynos to scale up at a time
manager[downscale_quantity] Integer Yes The amount of dynos to scale down at a time
manager[upscale_sensitivity] Integer Yes The amount of times to wait before actually scaling up
manager[downscale_sensitivity] Integer Yes The amount of times to wait before actually scaling down
manager[upscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing upscale operations
manager[downscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing downscale operations
manager[scale_up_on_503] Boolean Yes Scale up when your application returns HTTP/503 (Serivce Unavailable)
manager[url] String No Specify an URL to check for 503 responses
manager[notify] Boolean Yes Whether or not to send notifications
manager[notify_quantity] Integer No Notify when your dyno quantity exceeds this amount
manager[notify_after] Integer No Notify after the quantity has been exceeded for this amount (in minutes)

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

Parameter Type Required 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 Yes Set to true to enable the manager (autoscaling)
manager[minimum] Integer Yes The minimum amount of dynos to run at any given time
manager[maximum] Integer Yes The maximum amount of dynos to run at any given time
manager[minimum_response_time] Integer Yes Scales down if your application's response time goes below this amount
manager[maximum_response_time] Integer Yes 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 Yes The amount of dynos to scale up at a time
manager[downscale_quantity] Integer Yes The amount of dynos to scale down at a time
manager[upscale_sensitivity] Integer Yes The amount of times to wait before actually scaling up
manager[downscale_sensitivity] Integer Yes The amount of times to wait before actually scaling down
manager[upscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing upscale operations
manager[downscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing downscale operations
manager[scale_up_on_503] Boolean Yes Scale up when your application returns HTTP/503 (Serivce Unavailable)
manager[url] String No Specify an URL to check for 503 responses
manager[notify] Boolean Yes Whether or not to send notifications
manager[notify_quantity] Integer No Notify when your dyno quantity exceeds this amount
manager[notify_after] Integer No Notify after the quantity has been exceeded for this amount (in minutes)

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

Parameter Type Required 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 Yes Set to true to enable the manager (autoscaling)
manager[minimum] Integer Yes The minimum amount of dynos to run at any given time
manager[maximum] Integer Yes The maximum amount of dynos to run at any given time
manager[ratio] Integer Yes 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 Yes The amount of times to wait before actually scaling up
manager[downscale_sensitivity] Integer Yes The amount of times to wait before actually scaling down
manager[upscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing upscale operations
manager[downscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing downscale operations
manager[notify] Boolean Yes Whether or not to send notifications
manager[notify_quantity] Integer No Notify when your dyno quantity exceeds this amount
manager[notify_after] Integer No Notify after the quantity has been exceeded for this amount (in minutes)

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

Parameter Type Required 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 Yes Set to true to enable the manager (autoscaling)
manager[minimum] Integer Yes The minimum amount of dynos to run at any given time
manager[maximum] Integer Yes The maximum amount of dynos to run at any given time
manager[minimum_apdex] Integer Yes Scales up if your application's apdex goes below this amount
manager[maximum_apdex] Integer Yes Scales down if your application's apdex 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 Yes The amount of dynos to scale up at a time
manager[downscale_quantity] Integer Yes The amount of dynos to scale down at a time
manager[upscale_sensitivity] Integer Yes The amount of times to wait before actually scaling up
manager[downscale_sensitivity] Integer Yes The amount of times to wait before actually scaling down
manager[upscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing upscale operations
manager[downscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing downscale operations
manager[scale_up_on_503] Boolean Yes Scale up when your application returns HTTP/503 (Serivce Unavailable)
manager[url] String No Specify an URL to check for 503 responses
manager[notify] Boolean Yes Whether or not to send notifications
manager[notify_quantity] Integer No Notify when your dyno quantity exceeds this amount
manager[notify_after] Integer No Notify after the quantity has been exceeded for this amount (in minutes)

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

Parameter Type Required 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 Yes Set to true to enable the manager (autoscaling)
manager[minimum] Integer Yes The minimum amount of dynos to run at any given time
manager[maximum] Integer Yes The maximum amount of dynos to run at any given time
manager[minimum_response_time] Integer Yes Scales down if your application's response time goes below this amount
manager[maximum_response_time] Integer Yes Scales up if your application's response time exceeds this amount
manager[url] String No Specify an alternative URL to request for basic http checkups
manager[upscale_quantity] Integer Yes The amount of dynos to scale up at a time
manager[downscale_quantity] Integer Yes The amount of dynos to scale down at a time
manager[upscale_sensitivity] Integer Yes The amount of times to wait before actually scaling up
manager[downscale_sensitivity] Integer Yes The amount of times to wait before actually scaling down
manager[upscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing upscale operations
manager[downscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing downscale operations
manager[scale_up_on_503] Boolean Yes Scale up when your application returns HTTP/503 (Serivce Unavailable)
manager[notify] Boolean Yes Whether or not to send notifications
manager[notify_quantity] Integer No Notify when your dyno quantity exceeds this amount
manager[notify_after] Integer No 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_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_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,
    "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_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_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,
    "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": "bar",
    "new_relic_app_id": "foo",
    "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,
    "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": "bar",
    "new_relic_app_id": "foo",
    "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": "bar",
    "new_relic_app_id": "foo",
    "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 Description
id String Yes The id of the manager to update
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 Yes Set to true to enable the manager (autoscaling)
manager[minimum] Integer Yes The minimum amount of dynos to run at any given time
manager[maximum] Integer Yes The maximum amount of dynos to run at any given time
manager[ratio] Integer Yes Maintains a dyno/job ratio
manager[decrementable] Boolean Yes Allows scaling down to non-zero values when there are still jobs in the queue
manager[upscale_limit] Integer Yes Limits the amount of dynos by which the manager scales up at a time (0 means no limit)
manager[downscale_limit] Integer Yes Limits the amount of dynos by which the manager scales down at a time (0 means no limit)
manager[upscale_sensitivity] Integer Yes The amount of times to wait before actually scaling up
manager[downscale_sensitivity] Integer Yes The amount of times to wait before actually scaling down
manager[upscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing upscale operations
manager[downscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing downscale operations
manager[notify] Boolean Yes Whether or not to send notifications
manager[notify_quantity] Integer No Notify when your dyno quantity exceeds this amount
manager[notify_after] Integer No Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Worker::HireFire::JobLatency

Parameter Type Required Description
id String Yes The id of the manager to update
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 Yes Set to true to enable the manager (autoscaling)
manager[minimum] Integer Yes The minimum amount of dynos to run at any given time
manager[maximum] Integer Yes The maximum amount of dynos to run at any given time
manager[minimum_latency] Integer Yes Scale down when latency gets below N seconds.
manager[maximum_latency] Integer Yes Scale up when latency exceeds N seconds.
manager[upscale_quantity] Integer Yes The amount of dynos to scale up at a time
manager[downscale_quantity] Integer Yes The amount of dynos to scale down at a time
manager[upscale_sensitivity] Integer Yes The amount of times to wait before actually scaling up
manager[downscale_sensitivity] Integer Yes The amount of times to wait before actually scaling down
manager[upscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing upscale operations
manager[downscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing downscale operations
manager[notify] Boolean Yes Whether or not to send notifications
manager[notify_quantity] Integer No Notify when your dyno quantity exceeds this amount
manager[notify_after] Integer No Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::Logplex::Load

Parameter Type Required Description
id String Yes The id of the manager to update
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 Yes Set to true to enable the manager (autoscaling)
manager[minimum] Integer Yes The minimum amount of dynos to run at any given time
manager[maximum] Integer Yes The maximum amount of dynos to run at any given time
manager[minimum_load] Integer Yes Scales down if your application's load goes below this amount
manager[maximum_load] Integer Yes Scales up if your application's load exceeds this amount
manager[last_minutes] Integer Yes The load average over the last n minutes. Possible values are 1, 5 and 15
manager[upscale_quantity] Integer Yes The amount of dynos to scale up at a time
manager[downscale_quantity] Integer Yes The amount of dynos to scale down at a time
manager[upscale_sensitivity] Integer Yes The amount of times to wait before actually scaling up
manager[downscale_sensitivity] Integer Yes The amount of times to wait before actually scaling down
manager[upscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing upscale operations
manager[downscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing downscale operations
manager[notify] Boolean Yes Whether or not to send notifications
manager[notify_quantity] Integer No Notify when your dyno quantity exceeds this amount
manager[notify_after] Integer No Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::Logplex::QueueTime

Parameter Type Required Description
id String Yes The id of the manager to update
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 Yes Set to true to enable the manager (autoscaling)
manager[minimum] Integer Yes The minimum amount of dynos to run at any given time
manager[maximum] Integer Yes The maximum amount of dynos to run at any given time
manager[minimum_queue_time] Integer Yes Scale down when queue times get below N milliseconds
manager[maximum_queue_time] Integer Yes Scale up when queue times exceed N milliseconds
manager[aggregation] String Yes Determines how the metric is aggregated. Possible values are "average" and "percentile"
manager[percentile] Integer No The percentile to use (when aggregation is set to "percentile")
manager[upscale_quantity] Integer Yes The amount of dynos to scale up at a time
manager[downscale_quantity] Integer Yes The amount of dynos to scale down at a time
manager[upscale_sensitivity] Integer Yes The amount of times to wait before actually scaling up
manager[downscale_sensitivity] Integer Yes The amount of times to wait before actually scaling down
manager[upscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing upscale operations
manager[downscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing downscale operations
manager[notify] Boolean Yes Whether or not to send notifications
manager[notify_quantity] Integer No Notify when your dyno quantity exceeds this amount
manager[notify_after] Integer No Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::Logplex::ResponseTime

Parameter Type Required Description
id String Yes The id of the manager to update
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 Yes Set to true to enable the manager (autoscaling)
manager[minimum] Integer Yes The minimum amount of dynos to run at any given time
manager[maximum] Integer Yes The maximum amount of dynos to run at any given time
manager[minimum_response_time] Integer Yes Scales down if your application's response time goes below this amount
manager[maximum_response_time] Integer Yes Scales up if your application's response time exceeds this amount
manager[aggregation] String Yes Determines how the metric is aggregated. Possible values are "average" and "percentile"
manager[percentile] Integer No The percentile to use (when aggregation is set to "percentile")
manager[upscale_quantity] Integer Yes The amount of dynos to scale up at a time
manager[downscale_quantity] Integer Yes The amount of dynos to scale down at a time
manager[upscale_sensitivity] Integer Yes The amount of times to wait before actually scaling up
manager[downscale_sensitivity] Integer Yes The amount of times to wait before actually scaling down
manager[upscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing upscale operations
manager[downscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing downscale operations
manager[notify] Boolean Yes Whether or not to send notifications
manager[notify_quantity] Integer No Notify when your dyno quantity exceeds this amount
manager[notify_after] Integer No Notify after the quantity has been exceeded for this amount (in minutes)

Manager::Web::Logplex::ConnectTime

Parameter Type Required Description
id String Yes The id of the manager to update
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 Yes Set to true to enable the manager (autoscaling)
manager[minimum] Integer Yes The minimum amount of dynos to run at any given time
manager[maximum] Integer Yes The maximum amount of dynos to run at any given time
manager[minimum_connect_time] Integer Yes Scale down when connect times get below N milliseconds
manager[maximum_connect_time] Integer Yes Scale up when connect times exceed N milliseconds
manager[aggregation] String Yes Determines how the metric is aggregated. Possible values are "average" and "percentile"
manager[percentile] Integer No The percentile to use (when aggregation is set to "percentile")
manager[upscale_quantity] Integer Yes The amount of dynos to scale up at a time
manager[downscale_quantity] Integer Yes The amount of dynos to scale down at a time
manager[upscale_sensitivity] Integer Yes The amount of times to wait before actually scaling up
manager[downscale_sensitivity] Integer Yes The amount of times to wait before actually scaling down
manager[upscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing upscale operations
manager[downscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing downscale operations
manager[notify] Boolean Yes Whether or not to send notifications
manager[notify_quantity] Integer No Notify when your dyno quantity exceeds this amount
manager[notify_after] Integer No Notify after the quantity has been exceeded for this amount (in minutes)

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

Parameter Type Required Description
id String Yes The id of the manager to update
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 Yes Set to true to enable the manager (autoscaling)
manager[minimum] Integer Yes The minimum amount of dynos to run at any given time
manager[maximum] Integer Yes The maximum amount of dynos to run at any given time
manager[minimum_response_time] Integer Yes Scales down if your application's response time goes below this amount
manager[maximum_response_time] Integer Yes 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 Yes The amount of dynos to scale up at a time
manager[downscale_quantity] Integer Yes The amount of dynos to scale down at a time
manager[upscale_sensitivity] Integer Yes The amount of times to wait before actually scaling up
manager[downscale_sensitivity] Integer Yes The amount of times to wait before actually scaling down
manager[upscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing upscale operations
manager[downscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing downscale operations
manager[scale_up_on_503] Boolean Yes Scale up when your application returns HTTP/503 (Serivce Unavailable)
manager[url] String No Specify an URL to check for 503 responses
manager[notify] Boolean Yes Whether or not to send notifications
manager[notify_quantity] Integer No Notify when your dyno quantity exceeds this amount
manager[notify_after] Integer No Notify after the quantity has been exceeded for this amount (in minutes)

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

Parameter Type Required Description
id String Yes The id of the manager to update
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 Yes Set to true to enable the manager (autoscaling)
manager[minimum] Integer Yes The minimum amount of dynos to run at any given time
manager[maximum] Integer Yes The maximum amount of dynos to run at any given time
manager[ratio] Integer Yes 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 Yes The amount of times to wait before actually scaling up
manager[downscale_sensitivity] Integer Yes The amount of times to wait before actually scaling down
manager[upscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing upscale operations
manager[downscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing downscale operations
manager[notify] Boolean Yes Whether or not to send notifications
manager[notify_quantity] Integer No Notify when your dyno quantity exceeds this amount
manager[notify_after] Integer No Notify after the quantity has been exceeded for this amount (in minutes)

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

Parameter Type Required Description
id String Yes The id of the manager to update
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 Yes Set to true to enable the manager (autoscaling)
manager[minimum] Integer Yes The minimum amount of dynos to run at any given time
manager[maximum] Integer Yes The maximum amount of dynos to run at any given time
manager[minimum_apdex] Integer Yes Scales up if your application's apdex goes below this amount
manager[maximum_apdex] Integer Yes Scales down if your application's apdex 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 Yes The amount of dynos to scale up at a time
manager[downscale_quantity] Integer Yes The amount of dynos to scale down at a time
manager[upscale_sensitivity] Integer Yes The amount of times to wait before actually scaling up
manager[downscale_sensitivity] Integer Yes The amount of times to wait before actually scaling down
manager[upscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing upscale operations
manager[downscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing downscale operations
manager[scale_up_on_503] Boolean Yes Scale up when your application returns HTTP/503 (Serivce Unavailable)
manager[url] String No Specify an URL to check for 503 responses
manager[notify] Boolean Yes Whether or not to send notifications
manager[notify_quantity] Integer No Notify when your dyno quantity exceeds this amount
manager[notify_after] Integer No Notify after the quantity has been exceeded for this amount (in minutes)

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

Parameter Type Required Description
id String Yes The id of the manager to update
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 Yes Set to true to enable the manager (autoscaling)
manager[minimum] Integer Yes The minimum amount of dynos to run at any given time
manager[maximum] Integer Yes The maximum amount of dynos to run at any given time
manager[minimum_response_time] Integer Yes Scales down if your application's response time goes below this amount
manager[maximum_response_time] Integer Yes 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 Yes The amount of dynos to scale up at a time
manager[downscale_quantity] Integer Yes The amount of dynos to scale down at a time
manager[upscale_sensitivity] Integer Yes The amount of times to wait before actually scaling up
manager[downscale_sensitivity] Integer Yes The amount of times to wait before actually scaling down
manager[upscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing upscale operations
manager[downscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing downscale operations
manager[scale_up_on_503] Boolean Yes Scale up when your application returns HTTP/503 (Serivce Unavailable)
manager[url] String No Specify an URL to check for 503 responses
manager[notify] Boolean Yes Whether or not to send notifications
manager[notify_quantity] Integer No Notify when your dyno quantity exceeds this amount
manager[notify_after] Integer No Notify after the quantity has been exceeded for this amount (in minutes)

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

Parameter Type Required Description
id String Yes The id of the manager to update
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 Yes Set to true to enable the manager (autoscaling)
manager[minimum] Integer Yes The minimum amount of dynos to run at any given time
manager[maximum] Integer Yes The maximum amount of dynos to run at any given time
manager[ratio] Integer Yes 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 Yes The amount of times to wait before actually scaling up
manager[downscale_sensitivity] Integer Yes The amount of times to wait before actually scaling down
manager[upscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing upscale operations
manager[downscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing downscale operations
manager[notify] Boolean Yes Whether or not to send notifications
manager[notify_quantity] Integer No Notify when your dyno quantity exceeds this amount
manager[notify_after] Integer No Notify after the quantity has been exceeded for this amount (in minutes)

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

Parameter Type Required Description
id String Yes The id of the manager to update
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 Yes Set to true to enable the manager (autoscaling)
manager[minimum] Integer Yes The minimum amount of dynos to run at any given time
manager[maximum] Integer Yes The maximum amount of dynos to run at any given time
manager[minimum_apdex] Integer Yes Scales up if your application's apdex goes below this amount
manager[maximum_apdex] Integer Yes Scales down if your application's apdex 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 Yes The amount of dynos to scale up at a time
manager[downscale_quantity] Integer Yes The amount of dynos to scale down at a time
manager[upscale_sensitivity] Integer Yes The amount of times to wait before actually scaling up
manager[downscale_sensitivity] Integer Yes The amount of times to wait before actually scaling down
manager[upscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing upscale operations
manager[downscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing downscale operations
manager[scale_up_on_503] Boolean Yes Scale up when your application returns HTTP/503 (Serivce Unavailable)
manager[url] String No Specify an URL to check for 503 responses
manager[notify] Boolean Yes Whether or not to send notifications
manager[notify_quantity] Integer No Notify when your dyno quantity exceeds this amount
manager[notify_after] Integer No Notify after the quantity has been exceeded for this amount (in minutes)

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

Parameter Type Required Description
id String Yes The id of the manager to update
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 Yes Set to true to enable the manager (autoscaling)
manager[minimum] Integer Yes The minimum amount of dynos to run at any given time
manager[maximum] Integer Yes The maximum amount of dynos to run at any given time
manager[minimum_response_time] Integer Yes Scales down if your application's response time goes below this amount
manager[maximum_response_time] Integer Yes Scales up if your application's response time exceeds this amount
manager[url] String No Specify an alternative URL to request for basic http checkups
manager[upscale_quantity] Integer Yes The amount of dynos to scale up at a time
manager[downscale_quantity] Integer Yes The amount of dynos to scale down at a time
manager[upscale_sensitivity] Integer Yes The amount of times to wait before actually scaling up
manager[downscale_sensitivity] Integer Yes The amount of times to wait before actually scaling down
manager[upscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing upscale operations
manager[downscale_timeout] Integer Yes The amount of time to wait (in minutes) before performing downscale operations
manager[scale_up_on_503] Boolean Yes Scale up when your application returns HTTP/503 (Serivce Unavailable)
manager[notify] Boolean Yes Whether or not to send notifications
manager[notify_quantity] Integer No Notify when your dyno quantity exceeds this amount
manager[notify_after] Integer No 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_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_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,
    "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_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_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,
    "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": "bar",
    "new_relic_app_id": "foo",
    "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,
    "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": "bar",
    "new_relic_app_id": "foo",
    "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": "bar",
    "new_relic_app_id": "foo",
    "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:

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 No 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 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 Description
id String Yes The recipient id
recipient[email] String Yes 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.

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": 0,
      "until_minute": 720,
      "minimum": 1,
      "maximum": 3,
      "position": 0,
      "monday": true,
      "tuesday": true,
      "wednesday": true,
      "thursday": true,
      "friday": true,
      "saturday": false,
      "sunday": false
    }
  ]
}

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": 0,
    "until_minute": 720,
    "minimum": 1,
    "maximum": 3,
    "position": 0,
    "monday": true,
    "tuesday": true,
    "wednesday": true,
    "thursday": true,
    "friday": true,
    "saturday": false,
    "sunday": false
  }
}

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": 0,
    "until_minute": 720,
    "minimum": 1,
    "maximum": 3,
    "position": 0,
    "monday": true,
    "tuesday": true,
    "wednesday": true,
    "thursday": true,
    "friday": true,
    "saturday": false,
    "sunday": false
  }
}

Creates a time range.

Parameter Type Required 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
time_range[until_minute] Integer Yes The minute of the day when this time range should no longer apply
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 The position (order) of the time range
time_range[monday] Boolean Yes The time range should apply on Monday
time_range[tuesday] Boolean Yes The time range should apply on Tuesday
time_range[wednesday] Boolean Yes The time range should apply on Wednesday
time_range[thursday] Boolean Yes The time range should apply on Thursday
time_range[friday] Boolean Yes The time range should apply on Friday
time_range[saturday] Boolean Yes The time range should apply on Saturday
time_range[sunday] Boolean Yes The time range should apply on Sunday

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": 0,
    "until_minute": 720,
    "minimum": 1,
    "maximum": 3,
    "position": 0,
    "monday": true,
    "tuesday": true,
    "wednesday": true,
    "thursday": true,
    "friday": true,
    "saturday": false,
    "sunday": false
  }
}

Updates a time range.

Parameter Type Required Description
id String Yes The time range id
time_range[from_minute] Integer Yes The minute of the day that this time range should start applying
time_range[until_minute] Integer Yes The minute of the day when this time range should no longer apply
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 The position (order) of the time range
time_range[monday] Boolean Yes The time range should apply on Monday
time_range[tuesday] Boolean Yes The time range should apply on Tuesday
time_range[wednesday] Boolean Yes The time range should apply on Wednesday
time_range[thursday] Boolean Yes The time range should apply on Thursday
time_range[friday] Boolean Yes The time range should apply on Friday
time_range[saturday] Boolean Yes The time range should apply on Saturday
time_range[sunday] Boolean Yes The time range should apply on Sunday

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": 0,
    "until_minute": 720,
    "minimum": 1,
    "maximum": 3,
    "position": 0,
    "monday": true,
    "tuesday": true,
    "wednesday": true,
    "thursday": true,
    "friday": true,
    "saturday": false,
    "sunday": false
  }
}

Deletes a time range.

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