{"__v":2,"_id":"55fcb69cb652110d00758aec","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"},"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-19T01:13:00.116Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"A Deployment defines a schedule for how often and from where an API Call (or Workflow) is made.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"meta\",\n    \"0-1\": \"See below\",\n    \"0-2\": \"N\",\n    \"1-0\": \"deployment\",\n    \"1-1\": \"See below\",\n    \"1-2\": \"Y\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Required?\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"meta\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Required?\",\n    \"0-2\": \"N - read only\",\n    \"0-1\": \"Owner of deployment\",\n    \"0-0\": \"owner\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"deployment\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Required?\",\n    \"0-0\": \"target_id\",\n    \"0-1\": \"ID of API Call or Workflow that is deployed?\",\n    \"0-2\": \"Y\",\n    \"1-0\": \"location_id\",\n    \"1-1\": \"ID of Location to be deployed at.\",\n    \"1-2\": \"Y\",\n    \"2-0\": \"frequency\",\n    \"2-1\": \"Frequency to make call in minutes.\",\n    \"2-2\": \"Y\",\n    \"3-0\": \"run_delay\",\n    \"3-1\": \"How many seconds after trigger time to actually make call.\",\n    \"3-2\": \"N\",\n    \"4-0\": \"between_calls_delay\",\n    \"4-1\": \"How many seconds to wait in-between calls for a Workflow.\",\n    \"4-2\": \"N\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","excerpt":"Description of the JSON representing a Deployment","slug":"deployment-object","type":"basic","title":"Deployment Object"}

Deployment Object

Description of the JSON representing a Deployment

A Deployment defines a schedule for how often and from where an API Call (or Workflow) is made. [block:parameters] { "data": { "0-0": "meta", "0-1": "See below", "0-2": "N", "1-0": "deployment", "1-1": "See below", "1-2": "Y", "h-0": "Name", "h-1": "Description", "h-2": "Required?" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "meta" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "h-2": "Required?", "0-2": "N - read only", "0-1": "Owner of deployment", "0-0": "owner" }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "deployment" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "h-2": "Required?", "0-0": "target_id", "0-1": "ID of API Call or Workflow that is deployed?", "0-2": "Y", "1-0": "location_id", "1-1": "ID of Location to be deployed at.", "1-2": "Y", "2-0": "frequency", "2-1": "Frequency to make call in minutes.", "2-2": "Y", "3-0": "run_delay", "3-1": "How many seconds after trigger time to actually make call.", "3-2": "N", "4-0": "between_calls_delay", "4-1": "How many seconds to wait in-between calls for a Workflow.", "4-2": "N" }, "cols": 3, "rows": 5 } [/block]