Get All Job History - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get All Job History","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/54f4ba30-7fe2-3433-bbd5-a4d458aee37e","info":{"title":"Cisco Cloud-delivered Firewall Management Center (cdFMC) API","version":"1.15.0","description":"Use the documentation to explore the endpoints the cdFMC has to offer","contact":{"name":"Cisco Firepower TAC","email":"ngfw-support@cisco.com"}},"tags":[{"name":"Analysis"},{"name":"Audit"},{"name":"Backup"},{"name":"Change Management"},{"name":"Chassis"},{"name":"Deployment"},{"name":"Device Clusters"},{"name":"Device Groups"},{"name":"Device HA Pairs"},{"name":"Devices"},{"name":"Health"},{"name":"Integration"},{"name":"Intelligence"},{"name":"License"},{"name":"Network Map"},{"name":"Object"},{"name":"Policy"},{"name":"Policy Assignments"},{"name":"Search"},{"name":"Status"},{"name":"System Configuration"},{"name":"System Information"},{"name":"Templates"},{"name":"Troubleshoot"},{"name":"Updates"},{"name":"Users"}],"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"deprecated":false,"description":"**Gets all deployment jobs.**","operationId":"getAllJobHistory","parameters":[{"description":"Various filter criteria can be specified using the format \u003ccode\u003edeviceUUID:{uuid};startTime:start_time_in_secs;endTime:end_time_in_secs;rollbackApplicable:true_or_false;status:job_status;jobType:job_type\u003c/code\u003e. \u003cbr/\u003e\u003cbr/\u003e\u003ccode\u003estartTime\u003c/code\u003e -- start time in unix format (in seconds). startTime and endTime should be specified together.\u003cbr/\u003e\u003cbr/\u003e\u003ccode\u003eendTime\u003c/code\u003e -- end time in unix format (in seconds). startTime and endTime should be specified together.\u003cbr/\u003e\u003cbr/\u003e\u003ccode\u003erollbackApplicable\u003c/code\u003e -- true/false. Not a mandatory field.\u003cbr/\u003e\u003cbr/\u003e\u003ccode\u003estatus\u003c/code\u003e -- {DEPLOYING, DEPLOYED, FAILED, ABORTED, EDIT_INUSE}. Not a mandatory field.\u003cbr/\u003e\u003cbr/\u003e\u003ccode\u003ejobType\u003c/code\u003e -- {DEPLOYMENT, ROLLBACK, CERTIFICATE}. Not a mandatory field.","in":"query","name":"filter","required":false,"schema":{"type":"string"}},{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"},{"name":"offset","description":"Index of first item to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/offset"},{"name":"limit","description":"Number of items to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/limit"},{"name":"expanded","description":"If set to true, the GET response displays a list of objects with additional attributes.","in":"query","required":false,"schema":{"type":"boolean"},"$$ref":"#/components/parameters/expanded"}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : GET /fmc_config/v1/domain/DomainUUID/deployment/jobhistories ( GET All paginated Job Histories instances. )":{"value":{"items":[{"deploymentNote":"yournotescomehere","deviceList":[{"deployedVersion":2,"deploymentStatus":"SUCCEEDED","deviceName":"10.10.6.104","deviceUUID":"d0c422c8-9756-11ea-acb6-961f407b1a9c"},{"containerName":"vFTD-HA","containerUUID":"8c363564-518d-11eb-899b-e37ea1f51142","deployedVersion":2,"deploymentStatus":"SUCCEEDED","deviceName":"10.10.6.100","deviceUUID":"a6b42c18-50c8-11eb-8556-880cc814430c"},{"deployedVersion":2,"deploymentStatus":"SUCCEEDED","deviceName":"10.10.6.102","deviceUUID":"73dee6c4-9756-11ea-b7d5-c46fa36556b5"}],"endTime":"2020-05-16T10:30:26Z","id":"0050568B-9937-0ed3-0000-463856468766","jobName":"Deploy_Job_6","jobStatus":"Deployed","jobType":"DEPLOYMENT","startTime":"2020-05-16T10:29:01Z","type":"JobHistory","user":"admin"},{"deploymentNote":"yournotescomehere","endTime":"2020-05-16T10:16:56Z","id":"0050568B-AFA9-0ed3-0000-017179869494","jobName":"Deploy_Job_5","jobStatus":"DEPLOYED","jobType":"UNKNOWN","startTime":"2020-05-16T10:15:19Z","type":"JobHistory","user":"System"},{"deploymentNote":"yournotescomehere","deviceList":[{"deployedVersion":-1,"deploymentStatus":"SUCCEEDED","deviceName":"10.10.6.104","deviceUUID":"d0c422c8-9756-11ea-acb6-961f407b1a9c"}],"endTime":"2020-05-16T10:10:45Z","id":"0050568B-9937-0ed3-0000-463856468569","jobName":"Deploy_Job_4","jobStatus":"Deployed","jobType":"ROLLBACK","startTime":"2020-05-16T10:09:10Z","type":"JobHistory","user":"System"},{"deploymentNote":"yournotescomehere","deviceList":[{"deployedVersion":1,"deploymentStatus":"SUCCEEDED","deviceName":"10.10.6.102","deviceUUID":"73dee6c4-9756-11ea-b7d5-c46fa36556b5"}],"endTime":"2020-05-16T10:06:28Z","id":"0050568B-9937-0ed3-0000-463856468258","jobName":"Deploy_Job_3","jobStatus":"Deployed","jobType":"DEPLOYMENT","startTime":"2020-05-16T10:04:22Z","type":"JobHistory","user":"System"}],"links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/deployment/jobhistories?offset=0&limit=41&expanded=true"},"paging":{"count":3,"limit":3,"offset":0,"pages":1}}},"Example 2 : GET /fmc_config/v1/domain/DomainUUID/deployment/jobhistories ( GET ALL paginated Job Histories instances with canRollback response where filter param rollbackApplicable is set as true. )":{"value":{"items":[{"deviceList":[{"canRollback":false,"deviceName":"10.10.18.28","deviceUUID":"9b1a4496-f191-11ea-a46b-dbe601ec8233"},{"canRollback":true,"deviceName":"10.10.18.11","deviceUUID":"6bc51b26-401f-11eb-8a50-866b03f66226"},{"canRollback":true,"deviceName":"10.10.18.12","deviceUUID":"4f1e003c-401f-11eb-9c14-d0c01de8132e"}],"id":"0050568A-6DDA-0ed3-0000-012884903748","jobName":"Deploy_Job_4","jobType":"DEPLOYMENT","type":"JobHistory"},{"deviceList":[{"canRollback":false,"deviceName":"10.10.18.28","deviceUUID":"9b1a4496-f191-11ea-a46b-dbe601ec8233"}],"id":"0050568A-6DDA-0ed3-0000-012884903564","jobName":"Deploy_Job_3","jobType":"DEPLOYMENT","type":"JobHistory"},{"deviceList":[{"canRollback":true,"deviceName":"10.10.18.12","deviceUUID":"4f1e003c-401f-11eb-9c14-d0c01de8132e"}],"id":"0050568A-6DDA-0ed3-0000-012884903413","jobName":"Deploy_Job_2","jobType":"DEPLOYMENT","type":"JobHistory"},{"deviceList":[{"canRollback":true,"deviceName":"10.10.18.11","deviceUUID":"6bc51b26-401f-11eb-8a50-866b03f66226"}],"id":"0050568A-6DDA-0ed3-0000-012884902592","jobName":"Deploy_Job_1","jobType":"DEPLOYMENT","type":"JobHistory"}],"links":{"self":"https://example.cisco.com/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/deployment/jobhistories?filter=rollbackApplicable%3Atrue&offset=0&limit=1000&expanded=true"},"paging":{"count":4,"limit":4,"offset":0,"pages":1}}}},"schema":{"type":"object","properties":{"items":{"type":"array","properties":{"deploymentNote":{"description":"User provided job note","type":"string"},"deviceList":{"description":"List of devices which have been part of the job.","items":{"type":"object","properties":{"canRollback":{"description":"Indicates whether the deployed version to device in the deployment job is rollback capable. This field is available only if context filter parameter has value as RollbackApplicable.","type":"boolean"},"containerName":{"description":"Name of the container. This will still be displayed after deletion.","type":"string"},"containerUUID":{"description":"UUID of the container","type":"string"},"deployedVersion":{"description":"Config version of the device in the deployment job","format":"int32","type":"integer"},"deploymentStatus":{"description":"Deployment status of the device in the deployment job","enum":["DEPLOYING","SUCCEEDED","PARTIALLY_SUCCEEDED","FAILED","SSP_SUCCEEDED","SSP_FAILED","SSP_PRIMARY_BOOTSTRAP_SUCCEEDED","SSP_PRIMARY_BOOTSTRAP_FAILED","SSP_SECONDARY_BOOTSTRAP_SUCCEEDED","SSP_SECONDARY_BOOTSTRAP_FAILED","PRIMARY_BOOTSTRAP_SUCCEEDED","PRIMARY_BOOTSTRAP_FAILED","SECONDARY_BOOTSTRAP_SUCCEEDED","SECONDARY_BOOTSTRAP_FAILED","BREAK_SUCCEEDED","BREAK_FAILED","PRIMARY_BOOTSTRAP_PARTIALLY_SUCCEEDED","SECONDARY_BOOTSTRAP_PARTIALLY_SUCCEEDED","SSP_PRIMARY_BOOTSTRAP_PARTIALLY_SUCCEEDED","SSP_SECONDARY_BOOTSTRAP_PARTIALLY_SUCCEEDED","BREAK_PARTIALLY_SUCCEEDED","CANCELLED","NONE"],"type":"string"},"deviceName":{"description":"Name of the device","type":"string"},"deviceUUID":{"description":"UUID of the device","type":"string"}},"$$ref":"#/components/schemas/IDeviceListEntry"},"type":"array"},"endTime":{"description":"Indicates the end time (in ISO 8601 format) of the deployment job.","type":"string"},"id":{"description":"UUID of the deployment job.","type":"string"},"jobName":{"description":"Name of the deployed job","type":"string"},"jobStatus":{"description":"Represents the status of the job","enum":["DEPLOYING","DEPLOYED","FAILED","ABORTED","EDIT_INUSE"],"type":"string"},"jobType":{"enum":["DEPLOYMENT","ROLLBACK","CERTIFICATE","UNKNOWN"],"type":"string"},"startTime":{"description":"Indicates the start time (in ISO 8601 format) of the deployment job.","type":"string"},"type":{"description":"Type must be JobHistory.","type":"string"},"user":{"description":"Creator of the deployment task.","type":"string"}},"$$ref":"#/components/schemas/JobHistory"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"paging":{"type":"object","properties":{"count":{"format":"int32","type":"integer"},"limit":{"format":"int32","type":"integer"},"offset":{"format":"int32","type":"integer"},"pages":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/PagingContainer"}},"$$ref":"#/components/schemas/JobHistoryListContainer"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"description":"Describes the category of the error thrown.","enum":["FRAMEWORK","OTHER","VALIDATION"],"type":"string"},"messages":{"description":"List of error messages which the response has.","items":{"type":"object","properties":{"bulkPayloadIndex":{"description":"More details about the error.","type":"string"},"code":{"description":"More details about the error.","type":"string"},"description":{"description":"More details about the error.","type":"string"},"details":{"description":"More details about the error.","type":"string"},"errorCode":{"description":"More details about the error.","type":"string"},"location":{"description":"More details about the error.","type":"string"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorMessagesContainer"},"type":"array"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error"}},"tags":["Deployment"],"__originalOperationId":"getAllJobHistory","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/deployment/jobhistories"}}