{"type":"api","title":"Get image by Id","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/cb543f21-98ee-3eba-a234-d30581f8b67c","info":{"title":"Crosswork ZTP Image Service API","version":"7.1.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"},"description":"This document explains the Crosswork REST APIs that you can use to manage software image files for Zero Touch Provisioning (ZTP) devices."},"security":[{"bearerAuth":[]}],"tags":[{"name":"Device Platform APIs","description":"List of Device Platform APIs."},{"name":"Image APIs","description":"List of Image APIs."}],"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/ztp-image-service-deprecated-api-overview.md"}},"openapi":"3.0.1","servers":[{"url":"/crosswork/imagesvc/v1"}],"securitySchemes":{"bearerAuth":{"description":"Security definition details.","in":"header","name":"Authorization","type":"apiKey"}}},"spec":{"parameters":[{"description":"ID of the image.","in":"path","name":"imageId","required":true,"schema":{"type":"string"}},{"description":"Crosswork host IP","in":"header","name":"X-Real-IP","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"createdBy":{"description":"Created by user id.","type":"string"},"createdTime":{"description":"Creation time. Time since Unix epoch, in milliseconds.","type":"integer"},"deviceFamily":{"description":"Device family.","type":"string"},"downloadURL":{"description":"Image download URL string.","type":"string"},"id":{"description":"Unique image id.","type":"string"},"imageFileName":{"description":"Image file name.","type":"string"},"imagePlatform":{"description":"Image platform.","type":"string"},"imageSource":{"description":"Image source path.","type":"string"},"imageTitle":{"description":"Image title.","type":"string"},"imageType":{"description":"Image type","type":"string"},"imageVersion":{"description":"Image version","type":"string"},"modifiedBy":{"description":"Id of the user who last updated the image.","type":"string"},"modifiedTime":{"description":"Modification time. Time since Unix epoch, in milliseconds.","type":"integer"},"vendor":{"description":"Device vendor.","type":"string"}},"description":"ImageDto object","type":"object","$$ref":"#/components/schemas/ImageDto"},"example":{"createdBy":"","createdTime":1686974151894,"deviceFamily":"CISCO NCS5500","downloadURL":"http://\u003cIP\u003e:30604/crosswork/imagesvc/v1/device/files/cw-image-uuid-fa0541af-88d1-448f-b5fa-b6296ef6bf9f","id":"cw-image-uuid-fa0541af-88d1-448f-b5fa-b6296ef6bf9f","imageFileName":"ncs5500-mini-x-7.8.1.iso","imagePlatform":"IOS XR","imageSource":"local","imageTitle":"img1","imageType":"Image","imageVersion":"7.3.1","modifiedBy":"","modifiedTime":1686974192879,"vendor":"CISCO"}}},"description":"OK. The request was successful. The result is contained in the response body."},"401":{"description":"Unauthorized. The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden. The server recognizes the authentication credentials, but the client is not authorized to perform this request."},"404":{"description":"Not Found. The client made a request for a resource that does not exist."}},"tags":["Image APIs"],"operationId":"getImageByIdUsingGET","deprecated":true,"summary":"Get image by Id","description":"This API retrieves an image metadata based on the input image id.","__originalOperationId":"getImageByIdUsingGET","security":[{"bearerAuth":[]}],"method":"get","path":"/images/{imageId}"}}