openapi: 3.2.0
info:
  description: Cisco Crosswork Workflow Manager (CWM) 2.1 offers RESTful APIs that enable automation engineers and developers to create, deploy, and manage workflows, adapters, jobs, resources, events, and workers within the Cisco CWM platform.
  title: Cisco Crosswork Workflow Manager Public Key API
  termsOfService: www.cisco.com
  contact:
    name: API Support
    url: https://www.cisco.com/support
  version: 2.1.0
  x-provenance:
    method: harvested
    authored_by: Cisco Crosswork
    harvested_by: API Evangelist
    harvested_on: '2026-08-19'
    first_party: true
    provider_published: true
    note: 'Reconstructed verbatim from the per-operation Swagger 2.0 JSON fragments Cisco serves for the Crosswork Workflow Manager API reference at developer.cisco.com/docs/crosswork/workflow-manager/. info, basePath and securityDefinitions are Cisco''s own meta block; each path/method object is Cisco''s own spec object, unmodified except that inline schemas carrying the swagger-ui $$ref marker were hoisted back into #/definitions and replaced with a real $ref.'
servers:
- url: /crosswork/cwm/v2
tags:
- name: Public Key
paths:
  /publicKey:
    get:
      description: Retrieves all public keys in the system with optional filtering by author and enabled status.
      tags:
      - Public Key
      summary: List all registered public keys
      parameters:
      - description: Filter by author
        name: author
        in: query
        schema:
          type: string
      - description: Filter by enabled status (true/false)
        name: enabled
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/server.PublicKeyResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: string
      method: get
      path: /publicKey
      operationId: getPublicKey
      x-operation-id-source: derived
    post:
      description: Adds a new RSA public key to the system for encryption and signature verification. Supports PKCS#1 (RSA PUBLIC KEY) and PKCS#8 (PUBLIC KEY) PEM formats.
      tags:
      - Public Key
      summary: Register a new RSA public key
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/server.PublicKeyResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: string
        '409':
          description: Public key with this name already exists
          content:
            application/json:
              schema:
                type: string
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: string
      method: post
      path: /publicKey
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/server.PublicKeyCreateRequest'
        description: Public Key to add
        required: true
      operationId: postPublicKey
      x-operation-id-source: derived
  /publicKey/{publicKeyName}:
    delete:
      description: Permanently removes a public key from the system by its unique name.
      tags:
      - Public Key
      summary: Delete a public key
      parameters:
      - description: Public Key Name
        name: publicKeyName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '404':
          description: Public key not found
          content:
            application/json:
              schema:
                type: string
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: string
      method: delete
      path: /publicKey/{publicKeyName}
      operationId: deletePublicKeyByPublicKeyName
      x-operation-id-source: derived
    get:
      description: Fetches a public key's complete details including PEM format, key type, and metadata by its unique name.
      tags:
      - Public Key
      summary: Retrieve a public key by name
      parameters:
      - description: Public Key Name
        name: publicKeyName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/server.PublicKeyResponse'
        '404':
          description: Public key not found
          content:
            application/json:
              schema:
                type: string
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: string
      method: get
      path: /publicKey/{publicKeyName}
      operationId: getPublicKeyByPublicKeyName
      x-operation-id-source: derived
    patch:
      description: Modifies an existing public key's properties including the PEM key itself, author, or enabled status.
      tags:
      - Public Key
      summary: Update an existing public key
      parameters:
      - description: Public Key Name
        name: publicKeyName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/server.PublicKeyResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: string
        '404':
          description: Public key not found
          content:
            application/json:
              schema:
                type: string
        '409':
          description: Public key name already exists
          content:
            application/json:
              schema:
                type: string
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: string
      method: patch
      path: /publicKey/{publicKeyName}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/server.PublicKeyUpdateRequest'
        description: Public Key updates
        required: true
      operationId: patchPublicKeyByPublicKeyName
      x-operation-id-source: derived
components:
  schemas:
    server.PublicKeyCreateRequest:
      type: object
      required:
      - author
      - name
      - publicKey
      properties:
        author:
          type: string
        enabled:
          type: boolean
        name:
          type: string
        publicKey:
          type: string
    server.PublicKeyUpdateRequest:
      type: object
      properties:
        author:
          type: string
        enabled:
          type: boolean
        publicKey:
          type: string
    server.PublicKeyResponse:
      type: object
      properties:
        author:
          type: string
        createdAt:
          type: string
        enabled:
          type: boolean
        keyAlgorithm:
          description: RSA
          type: string
        keyFormat:
          description: PKCS#1 or PKCS#8
          type: string
        name:
          type: string
        publicKey:
          type: string
        updatedAt:
          type: string
  securitySchemes:
    Bearer:
      type: apiKey
      name: Authorization
      in: header
      description: 'JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"'
x-evidence:
- type: reference
  url: https://developer.cisco.com/docs/crosswork/workflow-manager/
- type: fragment-index
  url: https://pubhub.devnetcloud.com/media/crosswork-workflow-manager-api-document/docs/262737b2-b3c2-32cd-b07b-fdbdcd23918f/apis/
  count: 90