Cisco Crosswork Image Platform Controller API

openapi: 3.2.0
info:
  title: Crosswork ZTP Image Service Image Platform Controller API
  version: 2.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
  description: This document details the Crosswork REST APIs that you can use to manage software image files for Zero Touch Provisioning (ZTP) devices.
  x-provenance:
    method: harvested
    authored_by: Cisco Crosswork
    harvested_by: API Evangelist
    harvested_on: '2026-08-19'
    first_party: true
    note: Published by Cisco. Retrieved unmodified except for this x-provenance block.
    provider_published: true
  x-evidence:
  - type: source
    url: https://github.com/CiscoDevNet/crosswork-openapi-spec/blob/master/ZTP/2.0APIs/cw_image_service.swagger.json
  - type: raw
    url: https://raw.githubusercontent.com/CiscoDevNet/crosswork-openapi-spec/master/ZTP/2.0APIs/cw_image_service.swagger.json
servers:
- url: /crosswork/imagesvc/
security:
- bearerAuth: []
tags:
- name: image-platform-controller
  description: Image Platform Controller
paths:
  /v1/platforms:
    get:
      tags:
      - image-platform-controller
      summary: Retrieves all supported platforms
      operationId: getPlatformsUsingGET
      parameters:
      - name: fetchCustomData
        in: query
        description: fetchCustomData
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK. The request was successful. The result is contained in the response body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDto'
        '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.
  /v1/platforms/{platform}/families:
    get:
      tags:
      - image-platform-controller
      summary: Retrieves all supported families, for a specific platform
      operationId: getFamiliesByPlatformUsingGET
      parameters:
      - name: platform
        in: path
        description: platform
        required: true
        schema:
          type: string
      - name: fetchCustomData
        in: query
        description: Retrieve all custom configured device families based on device OS platform
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK. The request was successful. The result is contained in the response body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDto'
        '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.
  /v1/platforms/{platform}/versions:
    get:
      tags:
      - image-platform-controller
      summary: Retrieves all supported versions, for a specific platform
      operationId: getVersionsByPlatformUsingGET
      parameters:
      - name: platform
        in: path
        description: platform
        required: true
        schema:
          type: string
      - name: fetchCustomData
        in: query
        description: Retrieves all custom configured image software versions based on OS platform
        required: false
        schema:
          type: boolean
          default: false
      - name: secured
        in: query
        description: secured
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK. The request was successful. The result is contained in the response body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDto'
        '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.
components:
  schemas:
    ResponseDto:
      type: object
      properties:
        content:
          type: array
          items:
            type: object
        pageNumber:
          type: integer
          format: int32
        pageSize:
          type: integer
          format: int32
      title: ResponseDto
  securitySchemes:
    bearerAuth:
      type: apiKey
      name: Authorization
      in: header