Cisco Crosswork Payload API

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 Payload 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: Payload
paths:
  /payload/{key}:
    get:
      description: Fetches encoded payload data by key from the configured namespace, automatically decodes base64 encoding, and decrypts encrypted data when detected. Returns the raw decoded data.
      tags:
      - Payload
      summary: Retrieve and decode payload data by key
      parameters:
      - description: Payload key
        name: key
        in: path
        required: true
        schema:
          type: string
      - description: 'Attempt to decrypt data if encrypted (default: true)'
        name: decrypt
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: Successfully retrieved and decoded payload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/server.DecodedPayloadResponse'
        '400':
          description: Bad request - invalid payload key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors.InternalAPIError'
        '404':
          description: Payload not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors.InternalAPIError'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors.InternalAPIError'
      method: get
      path: /payload/{key}
      operationId: getPayloadByKey
      x-operation-id-source: derived
components:
  schemas:
    errors.InternalAPIError:
      type: object
      properties:
        code:
          type: integer
        details:
          type: string
        err: {}
        message:
          type: string
    server.DecodedPayloadResponse:
      type: object
      properties:
        data:
          description: actual decoded data (JSON object/array/string/number)
        decoded:
          description: whether data was successfully decoded
          type: boolean
          example: true
        encrypted:
          description: whether data appears to be encrypted
          type: boolean
          example: false
        raw_data:
          description: base64 encoded raw data if decoding fails
          type: string
        size:
          description: size in bytes
          type: integer
          example: 11
  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