{"type":"api","title":"Tagging golden image","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/167ffeffb0ddb8dfdcd104d49c529945120bad81/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.1","servers":[{"url":"/"}]},"spec":{"operationId":"taggingGoldenImage","tags":["Software Image Management (SWIM)"],"deprecated":false,"summary":"Tagging golden image","description":"Creates golden image tagging specifically for a particular device type or supervisor engine module.\nConditions for tagging the golden image:\n\n1) The golden tagging of SMU, PISRT_SMU, APSP, and APDP image type depends on the golden tagged applied on the base image. If any discrepancies are identified in the request payload, the golden tagging process will fail. For example:\n\n a) If the base image is tagged with Device Role: ACCESS, then add-ons can only be done ACCESS role only and the same is applied if any device tag is used. Any other request will fail.\n\n b) If the base image is tagged at global or any site level then add-ons also need to be tagged at site level.\n\n2) Tagging of SUBPACKAGE and ROMMON image type is not supported.\n","parameters":[{"name":"Content-Type","description":"Request body content type","required":true,"schema":{"type":"string","default":"application/json"},"in":"header"},{"name":"id","description":"Software image identifier is used for golden tagging or intent to tag it. The value of `id` can be obtained from the response of the API `/dna/intent/api/v1/images?imported=true&isAddonImages=false` for the base image and `/dna/images/{id}/addonImages` where `id` will be the software image identifier of the base image. ","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"},{"name":"siteId","description":"Site identifier for tagged image or intent to tag it. The default value is global site id. See [https://developer.cisco.com/docs/dna-center](#!get-site) for `siteId` ","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"}],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"object","properties":{"productNameOrdinal":{"type":"number","description":"The product name ordinal is a unique value for each network device product. `productNameOrdinal` can be obtained from the response of API `/dna/intent/api/v1/siteWiseProductNames?siteId=\u003csiteId\u003e`"},"supervisorProductNameOrdinal":{"type":"number","description":"The supervisor engine module ordinal is a unique value for each supervisor module. `supervisorProductNameOrdinal` can be obtained from the response of API `/dna/intent/api/v1/siteWiseProductNames?siteId=\u003csiteId\u003e`"},"deviceRoles":{"type":"array","items":{"type":"string"},"description":"Device Roles. Available value will be [ CORE, DISTRIBUTION, UNKNOWN, ACCESS, BORDER ROUTER ]"},"deviceTags":{"type":"array","items":{"type":"string"},"description":"Device tags can be fetched fom API https://developer.cisco.com/docs/dna-center/#!get-tag"}},"description":"The payload should include either `deviceRoles` or `deviceTags`.","$$ref":"#/components/schemas/TaggingGoldenImageRequest"}}},"required":true},"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"taskId":{"type":"string","description":"The UUID of the task"},"url":{"type":"string","description":"The path to the API endpoint to GET for information on the task"}},"description":"Response"},"version":{"type":"string","description":"Response version"}},"description":"","$$ref":"#/components/schemas/TaggingGoldenImageResponse"}}}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"401":{"description":"The client's authentication credentials included with the request are missing or invalid.","content":{}},"403":{"description":"The server recognizes the authentication credentials, but the client is not authorized to perform this request.","content":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"406":{"description":"The client requested a response in a content format that this server does not support. In some cases, an empty request payload may also result in this response.","content":{}},"500":{"description":"The server could not fulfill the request.","content":{}},"501":{"description":"The server has not implemented the functionality required to fulfill the request.","content":{}},"502":{"description":"The server is (temporarily) unavailable.","content":{}},"503":{"description":"The server is (temporarily) unavailable.","content":{}},"504":{"description":"The server did not respond inside time restrictions and timed-out.","content":{}},"1XX":{"description":"Informational Responses - The server received the request and sent an informational response.","content":{}},"4XX":{"description":"Client Error Responses - The client request caused the error.","content":{}},"5XX":{"description":"Server Error Responses - The server failed to fulfill the request.","content":{}}},"x-rapi-id":"24b1-da62-4c69-9a8c","x-rapi-overview":"Creates golden image tagging specifically for a particular device type or supervisor engine module.\nConditions for tagging the golden image:\n\n1) The golden tagging of SMU, PISRT_SMU, APSP, and APDP image type depends on the golden tagged applied on the base image. If any discrepancies are identified in the request payload, the golden tagging process will fail. For example:\n\n a) If the base image is tagged with Device Role: ACCESS, then add-ons can only be done ACCESS role only and the same is applied if any device tag is used. Any other request will fail.\n\n b) If the base image is tagged at global or any site level then add-ons also need to be tagged at site level.\n\n2) Tagging of SUBPACKAGE and ROMMON image type is not supported.\n","x-rapi-domain":"Site Management","x-rapi-subdomain":"Software Image Management (SWIM)","x-rapi-version":"1.0.0","x-rapi-internalPath":"/intent/api/v1/images/${id}/sites/${siteId}/tagGolden","x-rapi-publicPath":"/dna/intent/api/v1/images/${id}/sites/${siteId}/tagGolden","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"taggingGoldenImage","method":"post","path":"/dna/intent/api/v1/images/{id}/sites/{siteId}/tagGolden"}}