{"type":"api","title":"Get Deployment","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/7d836703-14a3-32cb-ad8e-6816d26ee7c8","info":{"title":"Device Configuration Deployments API","description":"Device Configuration Deployments API","version":"1.0.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"}},"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/Device Configuration/device-config-deployments-api-overview.md"}},"openapi":"3.1.0","servers":[{"url":"https://{server-ip}:30603/crosswork/config/v1/templates","description":"Generated server url"}]},"spec":{"tags":["Template API"],"operationId":"getDeployment","parameters":[{"description":"Deployment Id","name":"deployment_id","in":"path","required":true,"schema":{"type":"string"}},{"description":"Page number","name":"page","in":"query","required":false,"schema":{"minimum":0,"type":"integer","format":"int32"}},{"description":"Page Size","name":"size","in":"query","required":false,"schema":{"minimum":0,"type":"integer","format":"int32"}},{"description":"Sort","name":"sort","in":"query","required":false,"schema":{"type":"string"},"example":"duration,desc"}],"requestBody":{"content":{"application/json":{"schema":{"description":"Deployment Filter Request","type":"object","properties":{"status":{"description":"Status List","type":"array","properties":{"empty":{"description":"Empty","type":"boolean"}},"items":{"type":"string"}},"device_uuid":{"description":"Device Uuid","type":"string"}},"$$ref":"#/components/schemas/DeploymentFilterReq"},"example":{"status":["SUCCESS","IN_PROGRESS","FAILED"]}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"Deployment Details Page","type":"object","properties":{"details":{"description":"Details List","type":"array","items":{"description":"Deployment Details","type":"object","properties":{"status_value":{"description":"Status Value","type":"integer","format":"int32"},"deployment_id":{"description":"Deployment Id","type":"string"},"params":{"description":"Params","type":"object","additionalProperties":{"description":"Any","type":"object","properties":{"type_url":{"description":"Type Url","type":"string"},"value":{"description":"Value","type":"string"}},"$$ref":"#/components/schemas/Any"},"deprecated":true},"params_map":{"description":"ParamsMap","type":"object","additionalProperties":{"description":"Any","type":"object","properties":{"type_url":{"description":"Type Url","type":"string"},"value":{"description":"Value","type":"string"}},"$$ref":"#/components/schemas/Any"}},"device_uuid":{"description":"Device Uuid","type":"string"},"template_name":{"description":"Template Name","type":"string"},"variables":{"description":"Variables List","type":"array","items":{"description":"Deployment Variable","type":"object","properties":{"name":{"description":"Name","type":"string"},"value":{"description":"Value","type":"string"}},"$$ref":"#/components/schemas/DeploymentVariable"}},"deployed_configlet":{"description":"Deployed Configlet","type":"string"},"deployed_at":{"description":"Deployed At Time","format":"date-time","type":"string"},"status":{"description":"Status","type":"string","enum":["NOT_STARTED","FAILED","PARTIAL","IN_PROGRESS","SUCCESS","NOT_DEPLOYED","SYSTEM_FAILURE","UNRECOGNIZED"]},"duration":{"description":"Duration","type":"integer","format":"int64"},"version":{"description":"Version","type":"number","format":"float"},"result":{"description":"Result","type":"string"}},"$$ref":"#/components/schemas/DeploymentDetails"}},"total_pages":{"description":"Total Pages","type":"integer","format":"int32"},"total_elements":{"description":"Total Elements","type":"integer","format":"int64"},"page_number":{"description":"Page Number","type":"integer","format":"int32"},"page_size":{"description":"Page Size","type":"integer","format":"int32"}},"$$ref":"#/components/schemas/DeploymentDetailsPage"},"example":{"details":[{"deployment_id":"Template 1_DeployJob_2025-02-19_10:31:13","template_name":"","version":5,"device_uuid":"leaf-1-125","deployed_configlet":"fgfghf\ndf\ng'.dfg,dflk;gmdf\n'\ndf.gdf';g,fd;lmgfd\n\ndfgdfgfdgdlkmlkdfmgdf\nfgfdgfd\n'\n'","deployed_at":"2025-02-19T10:31:19.067Z","status":"FAILED","result":"Deployment Failed with error : Feature not found to run","variables":[{"name":"uhuihu","value":"123232"}],"params":{},"duration":"127"},{"deployment_id":"Template 1_DeployJob_2025-02-19_10:31:13","template_name":"","version":5,"device_uuid":"nexus9k_253","deployed_configlet":"fgfghf\ndf\ng'.dfg,dflk;gmdf\n'\ndf.gdf';g,fd;lmgfd\n\ndfgdfgfdgdlkmlkdfmgdf\nfgfdgfd\n'\n'","deployed_at":"2025-02-19T10:31:19.073Z","status":"FAILED","result":"Deployment Failed with error : Feature not found to run","variables":[{"name":"uhuihu","value":"123232"}],"params":{},"duration":"115"}],"page_size":100,"page_number":0,"total_pages":1,"total_elements":2}}}},"403":{"description":"Forbidden. The server recognizes the authentication credentials, but the client is not authorized to perform this request."}},"method":"post","path":"/deploy-template/{deployment_id}/query"}}