find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/cisco-crosswork-image-controller-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Crosswork ZTP Image Service Image 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-controller
  description: Image Controller
paths:
  /v1/images:
    get:
      tags:
      - image-controller
      summary: Get images
      operationId: getAllImagesUsingGET
      parameters:
      - name: pageNumber
        in: query
        description: pageNumber
        required: false
        schema:
          type: integer
          format: int32
      - name: pageSize
        in: query
        description: pageSize
        required: false
        schema:
          type: integer
          format: int32
      - name: sortBy
        in: query
        description: sortBy
        required: false
        schema:
          type: string
      - name: descending
        in: query
        description: descending
        required: false
        schema:
          type: boolean
      - name: imageId
        in: query
        description: imageId
        required: false
        schema:
          type: string
      - name: imageType
        in: query
        description: imageType
        required: false
        schema:
          type: string
      - name: imagePlatform
        in: query
        description: imagePlatform
        required: false
        schema:
          type: string
      - name: imageVersion
        in: query
        description: imageVersion
        required: false
        schema:
          type: string
      - name: imageTitle
        in: query
        description: imageTitle
        required: false
        schema:
          type: string
      - name: deviceFamily
        in: query
        description: deviceFamily
        required: false
        schema:
          type: string
      - name: searchType
        in: query
        description: searchType
        required: false
        schema:
          type: string
      - name: X-Real-IP
        in: header
        description: X-Real-IP
        required: false
        schema:
          type: string
      - name: imageFileName
        in: query
        description: imageFileName
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK. The request was successful. The result is contained in the response body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseDtoOfImageDto'
        '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.
    delete:
      tags:
      - image-controller
      summary: Delete images by a list of IDs
      operationId: deleteImagesByIdListUsingDELETE
      responses:
        '200':
          description: OK. The request was successful. The result is contained in the response body.
          content:
            application/json:
              schema:
                type: object
        '204':
          description: No Content. The request was successful and there is no additional content 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.
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
        description: idList
        required: true
  /v1/images/count:
    get:
      tags:
      - image-controller
      summary: Get total count of images
      operationId: getImageCountUsingGET
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: integer
                format: int64
        '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/images/{imageId}:
    get:
      tags:
      - image-controller
      summary: Get image by ID
      operationId: getImageByIdUsingGET
      parameters:
      - name: imageId
        in: path
        description: imageId
        required: true
        schema:
          type: string
      - name: X-Real-IP
        in: header
        description: X-Real-IP
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK. The request was successful. The result is contained in the response body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageDto'
        '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.
    put:
      tags:
      - image-controller
      summary: Update the image metadata
      operationId: updateImageInfoUsingPUT
      parameters:
      - name: imageId
        in: path
        description: imageId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK. The request was successful. The result is contained in the response body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageDto'
        '201':
          description: Created
        '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.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImageDto'
        description: imageDto
        required: true
    delete:
      tags:
      - image-controller
      summary: Delete image by ID
      operationId: deleteImageByIdUsingDELETE
      parameters:
      - name: imageId
        in: path
        description: imageId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK. The request was successful. The result is contained in the response body.
          content:
            application/json:
              schema:
                type: object
        '204':
          description: No Content. The request was successful and there is no additional content 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.
components:
  schemas:
    ResponseDtoOfImageDto:
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/ImageDto'
        pageNumber:
          type: integer
          format: int32
        pageSize:
          type: integer
          format: int32
      title: ResponseDtoOfImageDto
    ImageDto:
      type: object
      properties:
        createdBy:
          type: string
        deviceFamily:
          type: string
        downloadURL:
          type: string
        id:
          type: string
        imageFileName:
          type: string
        imagePlatform:
          type: string
        imageSource:
          type: string
        imageTitle:
          type: string
        imageType:
          type: string
        imageVersion:
          type: string
        modifiedBy:
          type: string
      title: ImageDto
  securitySchemes:
    bearerAuth:
      type: apiKey
      name: Authorization
      in: header