Update manager
Description
Updates an existing manager.
Not all parameters apply for each manager[type]. See list below.
Available Manager types
- Manager::Web::HireFire::ResponseTime
- Manager::Worker::HireFire::JobQueue
- Manager::Web::Logplex::Load
- Manager::Web::Logplex::ResponseTime
- Manager::Web::Logplex::RPM
- Manager::Web::NewRelic::V1::Apdex
- Manager::Web::NewRelic::V1::ResponseTime
- Manager::Web::NewRelic::V1::RPM
- Manager::Web::NewRelic::V2::Apdex
- Manager::Web::NewRelic::V2::ResponseTime
- Manager::Web::NewRelic::V2::RPM
All:
- name
- type
- enabled
- minimum
- maximum
- notify
- notify_quantity
- notify_after
Manager::Worker::HireFire::JobQueue:
- decrementable
Manager::Worker::HireFire::JobQueue, Manager::Web::Logplex::RPM, Manager::Web::NewRelic::V1::RPM, Manager::Web::NewRelic::V2::RPM:
- ratio
Manager::Web::HireFire::ResponseTime, Manager::Web::NewRelic::V1::ResponseTime, Manager::Web::Newrelic::V2::ResponseTime:
- url
- scale_up_on_503
Manager::Web::HireFire::ResponseTime, Manager::Web::Logplex::ResponseTime, Manager::Web::NewRelic::V1::ResponseTime, Manager::Web::NewRelic::V2::ResponseTime:
- minimum_response_time
- maximum_response_time
Manager::Web::NewRelic::V1::Apdex, Manager::Web::NewRelic::V2::Apdex:
- minimum_apdex
- maximum_apdex
Manager::Web::NewRelic::V1::Apdex, Manager::Web::NewRelic::V1::ResponseTime, Manager::Web::NewRelic::V1::RPM, Manager::Web::NewRelic::V2::Apdex, Manager::Web::NewRelic::V2::ResponseTime, Manager::Web::NewRelic::V2::RPM:
- new_relic_account_id
- new_relic_api_key
- new_relic_app_id
Manager::Web::HireFire::ResponseTime, Manager::Web::NewRelic::V1::Apdex, Manager::Web::NewRelic::V1::ResponseTime, Manager::Web::NewRelic::V2::Apdex, Manager::Web::NewRelic::V2::ResponseTime:
- upscale_quantity
- downscale_quantity
- upscale_sensitivity
- downscale_sensitivity
- upscale_timeout
- downscale_timeout
Manager::Web::Logplex::Load
- minimum_load
- maximum_load
Definition
PATCH https://api.hirefire.io/managers/:id
Parameters
id required | string |
The id of the manager to update | |
manager[name] optional | string |
The name of the manager (should match the name of the Procfile entry) | |
manager[type] optional | string |
The manager type (see above list for available types) | |
manager[enabled] optional | boolean (false) |
Whether to enable/disable the manager | |
manager[minimum] optional | integer |
The minimum amount of dynos to run at any given time | |
manager[maximum] optional | integer |
The maximum amount of dynos to run at any given time | |
manager[minimum_response_time] optional | integer |
Scales down if your application's response time goes below this amount | |
manager[maximum_response_time] optional | integer |
Scales up if your application's response time exceeds this amount | |
manager[minimum_load] optional | integer |
Scales down if your application's load goes below this amount | |
manager[maximum_load] optional | integer |
Scales up if your application's load exceeds this amount | |
manager[minimum_apdex] optional | integer |
Scales up if your application's apdex goes below this amount | |
manager[maximum_apdex] optional | integer |
Scales down if your application's apdex exceeds this amount | |
manager[ratio] optional | integer |
Maintains a web:rpm/worker:job ratio by scaling based on the rpm or queue size | |
manager[decrementable] optional | boolean (false) |
Allows scaling down to non-zero values when there are still jobs in the queue (worker-type only) | |
manager[url] optional | string |
Specific URL to request for basic http checkups | |
manager[upscale_quantity] optional | integer |
The amount of dynos to scale up at a time | |
manager[downscale_quantity] optional | integer |
The amount of dynos to scale down at a time | |
manager[upscale_sensitivity] optional | integer |
The amount of times to wait before actually scaling up | |
manager[downscale_sensitivity] optional | integer |
The amount of times to wait before actually scaling down | |
manager[upscale_timeout] optional | integer |
The amount of time to wait (in minutes) before performing upscale operations | |
manager[downscale_timeout] optional | integer |
The amount of time to wait (in minutes) before performing downscale operations | |
manager[scale_up_on_503] optional | boolean (false) |
Scale up when your application returns HTTP/503 (Serivce Unavailable) | |
manager[new_relic_api_key] optional | string |
Your New Relic api key | |
manager[new_relic_account_id] optional | string |
Your New Relic account id | |
manager[new_relic_app_id] optional | string |
Your New Relic application id | |
manager[notify] optional | boolean (false) |
Whether or not to send notifications | |
manager[notify_quantity] optional | integer |
Notify when your dyno quantity exceeds this amount | |
manager[notify_after] optional | integer |
Notify after the quantity has been exceeded for this amount (in minutes) |
Result Format
200 OK - Manager::Worker::HireFire::JobQueue
{
"manager": {
"id": "c9107d8c-5179-4eb7-b0d5-f390e51dd2ac",
"type": "Manager::Worker::HireFire::JobQueue",
"application_id": "d53a72ef-884e-4af3-aa25-824b631e2634",
"name": "worker",
"enabled": false,
"metric_value": "50",
"dyno_quantity": 5,
"last_checkup_time": "2015-01-01T00:00:00.000Z",
"last_scale_time": "2015-01-01T00:00:00.000Z",
"minimum": 1,
"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,
"issue": null
}
}
200 OK - Manager::Web::HireFire::ResponseTime
{
"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": "http://hirefire.io",
"issue": null
}
}
200 OK - 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_api_key": "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,
"issue": {
"id": "d44b79b0-da8f-45aa-b817-56e305ee1e95",
"parent_id": "efb7caff-c915-4344-ab32-f1430a17ba14",
"parent_type": "Manager",
"operation": "Metric::Fetcher::Web::NewRelic::V2::ResponseTime",
"response": "Unauthorized",
"message": "Couldnt fetch apdex. Ensure that your New Relic credentials are valid."
}
}
}
200 OK - 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_api_key": "bar",
"new_relic_app_id": "foo",
"ratio": 3000,
"upscale_timeout": 1,
"downscale_timeout": 1,
"issue": {
"id": "d44b79b0-da8f-45aa-b817-56e305ee1e95",
"parent_id": "1f757cf3-5f4a-46e9-b144-4a8983f563a7",
"parent_type": "Manager",
"operation": "Metric::Fetcher::Web::NewRelic::V2::RPM",
"response": "Unauthorized",
"message": "Couldnt fetch apdex. Ensure that your New Relic credentials are valid."
}
}
}
200 OK - 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_api_key": "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,
"issue": {
"id": "d44b79b0-da8f-45aa-b817-56e305ee1e95",
"parent_id": "e038a93b-91a1-443e-b3cd-554dca60cb5b",
"parent_type": "Manager",
"operation": "Metric::Fetcher::Web::NewRelic::V2::Apdex",
"response": "Unauthorized",
"message": "Couldnt fetch apdex. Ensure that your New Relic credentials are valid."
}
}
}
200 OK - 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
}
}
200 OK - 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,
"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
}
}
200 OK - Manager::Web::Logplex::RPM
{
"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",
"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
}
}