{"type":"api","title":"Get Deployed Device Changes in Deployment Run","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/241e37f202cf9838405f7ca5ed9f7d31d807d7bd/9b0e4c9a-48cb-3530-a00a-1f32fbf2438c","info":{"title":"Cisco Security Cloud Control Firewall Manager API","version":"1.22.0","description":"Use the documentation to explore the endpoints Security Cloud Control Firewall Manager has to offer","contact":{"name":"Cisco Security Cloud Control TAC","email":"cdo.tac@cisco.com"}},"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.uae.security.cisco.com/firewall","description":"UAE"},{"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://devfed.cdo.cisco.com/api/rest","description":"Devfed"},{"url":"https://manage.dev.secure.cisco/api/rest","description":"Devf9"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"},{"url":"https://manage.secure.cisco/api/rest","description":"ProdF9"},{"url":"https://manage.securitydod.cisco/api/rest","description":"IL5"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"description":"Get the changes that were deployed to a device as part of a deployment run. Changes are represented differently for FTDs and ASAs. For FTDs, this endpoint returns one item per changed entity describing what changed. For ASAs, this endpoint returns the initial configuration, and the configuration that was deployed to the device. The `deploymentType` field on each item identifies which shape it is. If the deployment failed, the changes returned are the changes that were attempted.","operationId":"getChangesDeployedInDeploymentRun","parameters":[{"description":"The unique identifier, represented as a UUID, of the device deployment Run in SCC Firewall Manager.","in":"path","name":"deploymentRunUid","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"The unique identifier, represented as a UUID, of the device in Security Cloud Control.","in":"path","name":"deviceUid","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"oneOf":[{"properties":{"addedReferences":{"description":"The list of references added to this entity as part of the change.","items":{"description":"The list of references deleted from this entity as part of the change.","properties":{"fieldName":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/Reference"},"type":"array"},"addedValues":{"description":"The list of values added to this entity as part of the change.","items":{"description":"The list of values removed from this entity as part of the change.","properties":{"fieldName":{"type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/Value"},"type":"array"},"changeItemType":{"description":"Indicates if this item represents an actual entity change or a grouping header.","enum":["ENTITY_CHANGE","GROUPING_HEADER"],"type":"string"},"changeType":{"description":"The type of the change.","enum":["ADD","DELETE","UPDATE","NOCHANGE"],"type":"string"},"children":{"description":"The children of this change item. This represents changes that rest within the group represented by this change item.","items":{"$ref":"#/components/schemas/FtdChangeItemDto","$$ref":"#/components/schemas/FtdChangeItemDto"},"type":"array"},"deletedReferences":{"description":"The list of references deleted from this entity as part of the change.","items":{"description":"The list of references deleted from this entity as part of the change.","properties":{"fieldName":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/Reference"},"type":"array"},"deletedValues":{"description":"The list of values removed from this entity as part of the change.","items":{"description":"The list of values removed from this entity as part of the change.","properties":{"fieldName":{"type":"string"},"value":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/Value"},"type":"array"},"deploymentType":{"description":"Discriminator identifying this change item as FTD.","enum":["FTD_DEVICE_DEPLOY","ASA_DEVICE_DEPLOY","FTD_DEVICE_DEPLOY"],"type":"string"},"deviceUid":{"description":"The unique identifier, represented as a UUID, of the device the changed entity is associated with.","format":"uuid","type":"string"},"entityType":{"description":"The type of the changed entity.","type":"string"},"entityUid":{"description":"The unique identifier, represented as a UUID, of the changed entity.","format":"uuid","type":"string"},"errorMsg":{"description":"An error message indicating why a diff could not be generated for the changed entity.","type":"string"},"lastUpdatedByUsers":{"description":"The list of users who have made the changes to this entity.","items":{"description":"The list of users who have made the changes to this entity.","type":"string"},"type":"array"},"name":{"description":"The name of the changed entity.","type":"string"},"parentUid":{"description":"The unique identifier, represented as a UUID, of the 'parent' of this change item. The parentUid, if set, can be used to identify the group that this change belongs to.","format":"uuid","type":"string"},"uid":{"description":"The unique identifier, represented as a UUID, of this change item. Note: this is not the unique identifier of the changed entity.","format":"uuid","type":"string"},"updatedValues":{"description":"The list of values updated on this entity as part of the change.","items":{"description":"The list of values updated on this entity as part of the change.","properties":{"fieldName":{"type":"string"},"newValue":{"type":"string"},"oldValue":{"type":"string"}},"type":"object","$$ref":"#/components/schemas/UpdatedValue"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/FtdChangeItemDto"},{"properties":{"deployedConfig":{"description":"The configuration deployed to the device (or the configuration that was attempted to be deployed to the device, in the case of a failed deployment). Note: this field is set to null if the device already had this configuration, or when snapshot capture failed for this device.","type":"string"},"deploymentRunUid":{"description":"The unique identifier, represented as a UUID, of the deployment run the change item is associated with.","format":"uuid","type":"string"},"deploymentType":{"description":"Discriminator identifying this change item as ASA.","enum":["FTD_DEVICE_DEPLOY","ASA_DEVICE_DEPLOY","ASA_DEVICE_DEPLOY"],"type":"string"},"deviceUid":{"description":"The unique identifier, represented as a UUID, of the device the change item is associated with.","format":"uuid","type":"string"},"initialConfig":{"description":"The configuration on the device prior to deployment. Note: this field is set to null if snapshot capture failed for this device.","type":"string"},"uid":{"description":"The unique identifier, represented as a UUID, of this change item.","format":"uuid","type":"string"}},"type":"object","$$ref":"#/components/schemas/AsaChangeItemDto"}],"type":"string"},"type":"array"}}},"description":"The change items captured for the device in this deployment run."},"400":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"type":"object","$$ref":"#/components/schemas/CommonApiError"}}},"description":"Invalid input provided. Check the response for details.","$$ref":"#/components/responses/http400BadRequest"},"401":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A human-readable error description in English.","example":"invalid_token","type":"string"},"errorDescription":{"description":"A human-readable error description in English.","example":"Your token is invalid","type":"string"}},"type":"object","$$ref":"#/components/schemas/AuthenticationError"}}},"description":"Request not authorized.","$$ref":"#/components/responses/http401Unauthorised"},"403":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"type":"object","$$ref":"#/components/schemas/CommonApiError"}}},"description":"User does not have sufficient privileges to perform this operation.","$$ref":"#/components/responses/http403Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"type":"object","$$ref":"#/components/schemas/CommonApiError"}}},"description":"Entity not found.","$$ref":"#/components/responses/http404NotFound"},"500":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"type":"object","$$ref":"#/components/schemas/CommonApiError"}}},"description":"Internal server error."}},"security":[{"bearerAuth":[]}],"summary":"Get Deployed Device Changes in Deployment Run","tags":["Device Deployments"],"__originalOperationId":"getChangesDeployedInDeploymentRun","method":"get","path":"/v1/inventory/devices/deployments/runs/{deploymentRunUid}/devices/{deviceUid}/changes"}}