{"__v":0,"_id":"55fca9013734100d00a9880d","category":{"__v":0,"_id":"56394a462fc5520d001a4db3","pages":[],"project":"5553d36165e8260d0024419a","version":"55fc9b793c21291900e7e0d7","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-11-03T23:59:02.240Z","from_sync":false,"order":18,"slug":"api-deployments","title":"API: Deployments"},"editedParams":true,"editedParams2":true,"parentDoc":null,"project":"5553d36165e8260d0024419a","user":"5553d33065e8260d00244199","version":{"__v":12,"_id":"55fc9b793c21291900e7e0d7","project":"5553d36165e8260d0024419a","createdAt":"2015-09-18T23:17:13.545Z","releaseDate":"2015-09-18T23:17:13.545Z","categories":["55fc9b7a3c21291900e7e0d8","55fc9b7a3c21291900e7e0d9","55fc9b7a3c21291900e7e0da","55fc9b7a3c21291900e7e0db","55fc9b7a3c21291900e7e0dc","55fc9b7a3c21291900e7e0dd","55fc9b7a3c21291900e7e0de","55fc9b7a3c21291900e7e0df","55fc9b7a3c21291900e7e0e0","55fc9b7a3c21291900e7e0e1","55fc9b7a3c21291900e7e0e2","55fc9b7a3c21291900e7e0e3","55fc9bad4c80910d00b9bece","56394a0c3539050d00082122","56394a2f68b11f0d0048c9ff","56394a462fc5520d001a4db3","56394a4c2fc5520d001a4db4","56394a5b049e420d00476b5c","56394a6a2fc5520d001a4db5","56394f791593e4190073a44b","567b3adfb56bac0d0019d8d9","569d590e5a2b060d008741eb","569ea93dffccd10d00a05c7f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-19T00:14:57.041Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"{\n    \"deployment\": {\n        \"target_id\": \"__PARENT_ID__\", \n        \"frequency\": 15,\n        \"location_id\": \"\"\n    }\n}","language":"json"}]},"method":"put","results":{"codes":[{"name":"","code":"{\n  \"meta\": {\n    \"owner\": \"agxkZXZ-dmlhdGVzdHNyEQsSBFVzZXIYgICAgICAgAoM\", \n    \"last_update\": \"2015-09-18T23:29:41.079995Z\", \n    \"created\": \"2015-09-18T23:29:41.079989Z\"\n  }, \n  \"id\": \"agxkZXZ-dmlhdGVzdHNyFwsSCkRlcGxveW1lbnQYgICAgKDLmggM\", \n  \"deployment\": {\n    \"location_id\": \"\", \n    \"run_delay\": 0, \n    \"frequency\": 12, \n    \"target_id\": \"agxkZXZ-dmlhdGVzdHNyFwsSClRlc3RTZXR1cDIYgICAgKDL6gsM\", \n    \"between_calls_delay\": 0\n  }\n}","language":"json","status":200},{"name":"","code":"{\n  \"error_msg\": \"deployment.frequency: 7 is not one of [1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30, 60, 120, 180, 240, 360, 480, 720, 1440]\", \n  \"error\": 400\n}","language":"json","status":400}]},"settings":"","auth":"required","params":[{"_id":"55fca80e3734100d00a9880c","ref":"","in":"path","required":true,"desc":"ID string of Deployment you're updating","default":"","type":"string","name":"id"}],"url":"/deployments/:id/"},"isReference":false,"order":6,"body":"Use this API to create a new Workflow in your account. The JSON schema for the input is available at ./schema.json\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"import APImetrics\\n\\nobj_id = \\\"ID_OF_OBJECT\\\"\\n\\napimetrics = APImetrics.APImetricsAPI(apimetrics_key=\\\"your_api_key\\\")\\nwith open('update.json') as handle:\\n  data = json.loads(handle.read())\\n  resp = apimetrics.update_deployment(obj_id, data)\\n  print result['id']\",\n      \"language\": \"python\"\n    }\n  ]\n}\n[/block]","excerpt":"Use this API to update an Authentication Setting.","slug":"deploymentsid","type":"endpoint","title":"Update an existing Deployment"}

putUpdate an existing Deployment

Use this API to update an Authentication Setting.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
ID string of Deployment you're updating

Examples


Result Format


Documentation

Use this API to create a new Workflow in your account. The JSON schema for the input is available at ./schema.json [block:code] { "codes": [ { "code": "import APImetrics\n\nobj_id = \"ID_OF_OBJECT\"\n\napimetrics = APImetrics.APImetricsAPI(apimetrics_key=\"your_api_key\")\nwith open('update.json') as handle:\n data = json.loads(handle.read())\n resp = apimetrics.update_deployment(obj_id, data)\n print result['id']", "language": "python" } ] } [/block]

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}