Cisco Crosswork Image Platform Controller API

Image Platform Controller

OpenAPI Specification

cisco-crosswork-image-platform-controller-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Cisco Crosswork Image Platform Controller API
  version: '1.0'
  description: 'Operations tagged image-platform-controller across 2 of this provider''s published API definitions: cisco-crosswork-ncahi-cw-image-service-openapi.json,
    cisco-crosswork-ztp-cw-image-service-openapi.json. Each path carries the servers of the definition it was published in.'
  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
    derived_view: Per-tag view of cisco-crosswork-ncahi-cw-image-service-openapi.json, the provider's source document. Operations
      and schemas are the provider's, unmodified; only the partition is ours.
    derived_from: cisco-crosswork-ncahi-cw-image-service-openapi.json
    operation_coverage: 3/3
  x-evidence:
  - type: source
    url: https://github.com/CiscoDevNet/crosswork-openapi-spec/blob/master/NCAHI/3.2APIs/cw_image_service.swagger.json
  - type: raw
    url: https://raw.githubusercontent.com/CiscoDevNet/crosswork-openapi-spec/master/NCAHI/3.2APIs/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: getPlatforms
      operationId: getPlatformsUsingGET
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDto'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    servers:
    - url: /crosswork/imagesvc/
  /v1/platforms/{platform}/families:
    get:
      tags:
      - image-platform-controller
      summary: getFamiliesByPlatform
      operationId: getFamiliesByPlatformUsingGET
      parameters:
      - name: platform
        in: path
        description: platform
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDto'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    servers:
    - url: /crosswork/imagesvc/
  /v1/platforms/{platform}/versions:
    get:
      tags:
      - image-platform-controller
      summary: getVersionsByPlatform
      operationId: getVersionsByPlatformUsingGET
      parameters:
      - name: platform
        in: path
        description: platform
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDto'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    servers:
    - url: /crosswork/imagesvc/
components:
  schemas:
    ResponseDto:
      type: object
      properties:
        content:
          type: array
          items:
            type: object
        pageNumber:
          type: integer
          format: int32
        pageSize:
          type: integer
          format: int32
    ResponseDto_2:
      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
x-refined-from:
- cisco-crosswork-ncahi-cw-image-service-openapi.json
- cisco-crosswork-ztp-cw-image-service-openapi.json