{"_id":"55fcaf92b652110d00758ae6","editedParams":true,"__v":0,"category":{"_id":"56394a462fc5520d001a4db3","__v":0,"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,"version":{"_id":"55fc9b793c21291900e7e0d7","__v":12,"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"},"editedParams2":true,"project":"5553d36165e8260d0024419a","user":"5553d33065e8260d00244199","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-19T00:42:58.260Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n  \"meta\": {\n    \"next_cursor\": \"ClgKKQoEbmFtZRIhGh9UZXN0IDIwMTUtMDktMTQgMjA6MjE6MDcuNzk1ODAxEidqDGRldn52aWF0ZXN0c3IXCxIKVGVzdFNldHVwMhiAgICAoN25CwwYACAA\", \n    \"more\": false\n  }, \n  \"results\": [\n    {\n      \"meta\": {\n        \"owner\": \"agxkZXZ-dmlhdGVzdHNyEQsSBFVzZXIYgICAgICAgAoM\", \n        \"last_update\": \"2015-09-15T00:21:10.364834Z\", \n        \"created\": \"2015-09-15T00:21:10.364821Z\"\n      }, \n      \"id\": \"agxkZXZ-dmlhdGVzdHNyFwsSCkRlcGxveW1lbnQYgICAgKDdgwgM\", \n      \"deployment\": {\n        \"location_id\": \"\", \n        \"run_delay\": 0, \n        \"frequency\": 12, \n        \"target_id\": \"agxkZXZ-dmlhdGVzdHNyFwsSClRlc3RTZXR1cDIYgICAgKDd_QsM\", \n        \"between_calls_delay\": 0\n      }\n    }, \n\t\t... list of Deployments ...\n  ]\n}","language":"json","status":200}]},"settings":"","examples":{"codes":[{"language":"text","code":""}]},"method":"get","auth":"required","params":[{"_id":"55fcaf55342d1e0d000b21c4","ref":"","in":"path","required":false,"desc":"ID of the Workflow","default":"","type":"string","name":"workflow_id"}],"url":"/deployments/workflow/:workflow_id/"},"isReference":false,"order":4,"body":"Use this API to list the Deployments in your account.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"import APImetrics\\n\\nobj_id = 'SOME_WORKFLOW_ID'\\n\\napimetrics = APImetrics.APImetricsAPI(apimetrics_key=\\\"your_api_key\\\")\\ncursor = None\\nmore = False\\nwhile more:\\n\\tresp = apimetrics.list_deployments_by_workflow(obj_id, cursor=cursor, limit=200)\\n\\tmore = resp['meta']['more']\\n  cursor = resp['meta']['cursor']\\n  for result in resp['results']\\n  \\tprint result['name']\\n\",\n      \"language\": \"python\"\n    }\n  ]\n}\n[/block]","excerpt":"List Deployments for a specific API Call","slug":"deploymentsworkflowworkflow_id","type":"endpoint","title":"Get all Deployments for a Workflow"}

getGet all Deployments for a Workflow

List Deployments for a specific API Call

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

workflow_id:
string
ID of the Workflow

Result Format


Documentation

Use this API to list the Deployments in your account. [block:code] { "codes": [ { "code": "import APImetrics\n\nobj_id = 'SOME_WORKFLOW_ID'\n\napimetrics = APImetrics.APImetricsAPI(apimetrics_key=\"your_api_key\")\ncursor = None\nmore = False\nwhile more:\n\tresp = apimetrics.list_deployments_by_workflow(obj_id, cursor=cursor, limit=200)\n\tmore = resp['meta']['more']\n cursor = resp['meta']['cursor']\n for result in resp['results']\n \tprint result['name']\n", "language": "python" } ] } [/block]

User Information

Try It Out

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