Cisco Crosswork Update Credentials API

openapi: 3.2.0
info:
  title: Crosswork Inventory Update Credentials API
  version: 1.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 contains details of the Crosswork Inventory RESTful APIs that can be used to onboard and manage Device Groups(Tags), Credentials, Providers and 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/NCAHI/3.2APIs/inventory_api.swagger.json
  - type: raw
    url: https://raw.githubusercontent.com/CiscoDevNet/crosswork-openapi-spec/master/NCAHI/3.2APIs/inventory_api.swagger.json
servers:
- url: /crosswork/inventory/
security:
- bearerAuth: []
tags:
- name: Update Credentials
paths:
  /v1/credentials:
    parameters: []
    patch:
      summary: Updates/Overwrites the bulk of credential profiles.
      tags:
      - Update Credentials
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/robotapiRobotNodeJob'
        '404':
          description: Not Found
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/robotapiRobotNodeCredentialsList'
        required: true
components:
  schemas:
    robotapiRobotUserPassEnable:
      type: string
      enum:
      - ROBOT_USERPASSEN_NONE
      - ROBOT_USERPASSEN_ENABLE
      - ROBOT_USERPASSEN_DISABLE
      default: ROBOT_USERPASSEN_NONE
      description: '- ROBOT_USERPASSEN_ENABLE: enables second level authentication in devices where is feature is available. For e.g. Cisco IOS XE devices. When this option is selected, the password for second level authentication much be given'
    robotapiRobotSnmpV3AuthType:
      type: string
      enum:
      - AT_UNKNOWN
      - AT_HMAC_MD5
      - AT_HMAC_SHA
      default: AT_UNKNOWN
    robotapiRobotUserPass:
      type: object
      properties:
        user_name:
          type: string
        password:
          type: string
        type:
          $ref: '#/components/schemas/robotapiRobotUserPassType'
        enable_password:
          $ref: '#/components/schemas/robotapiRobotUserPassEnable'
        enable_password_data:
          type: string
    robotapiRobotSnmpV3SecurityLevel:
      type: string
      enum:
      - SL_UNKNOWN
      - SL_NO_AUTH_NO_PRIV
      - SL_AUTH_NO_PRIV
      - SL_AUTH_PRIV
      default: SL_UNKNOWN
    robotapiRobotNodeCredentialsList:
      description: List of Credential profiles.
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/robotapiRobotNodeCredentials'
        user:
          type: string
    robotapiRobotSnmpV2:
      type: object
      properties:
        read_community:
          type: string
        write_community:
          type: string
      description: SNMPv2 credential information
    robotapiRobotUserPassType:
      type: string
      enum:
      - ROBOT_USERPASS_UNKNOWN
      - ROBOT_USERPASS_TCP
      - ROBOT_USERPASS_UDP
      - ROBOT_USERPASS_HTTP
      - ROBOT_USERPASS_HTTPS
      - ROBOT_USERPASS_GRPC
      - ROBOT_USERPASS_SSH
      - ROBOT_USERPASS_NETCONF
      - ROBOT_USERPASS_TELNET
      - ROBOT_USERPASS_SNMP
      - ROBOT_USERPASS_TL1
      - ROBOT_USERPASS_TL1_SECURE
      - ROBOT_USERPASS_ADMIN
      - ROBOT_USERPASS_ENABLE
      - ROBOT_USERPASS_MAX
      default: ROBOT_USERPASS_UNKNOWN
      description: Connectivity types for robot micro-services
    robotapiRobotSnmpV3:
      type: object
      properties:
        user_name:
          type: string
        auth_type:
          $ref: '#/components/schemas/robotapiRobotSnmpV3AuthType'
        auth_password:
          type: string
        priv_type:
          $ref: '#/components/schemas/robotapiRobotSnmpV3PrivType'
        priv_password:
          type: string
        security_level:
          $ref: '#/components/schemas/robotapiRobotSnmpV3SecurityLevel'
      description: SNMPv3  Credential information
    robotapiRobotNodeJob:
      type: object
      properties:
        job_id:
          type: string
          description: Job id
        inst_id:
          type: string
          description: Server instance identifier
        state:
          $ref: '#/components/schemas/robotapiRobotJobState'
          description: Current State of the Job
        type:
          type: string
          description: Job type. Debug purpose
        error:
          type: string
          description: If any error
        completion_time:
          type: string
          format: int64
          description: Remaining time to complete
        creation_time:
          type: string
          format: int64
          description: Job creation time in epoch seconds
        created_by:
          type: string
          description: User
        impacted_count:
          type: integer
          format: int64
          description: Impacted nodes/tags, provider or profiles
      impacted:
        type: array
        items:
          type: string
        title: Impacted elements list
      description: Every Action related to Inventory will have a Job
    robotapiRobotNodeCredentials:
      type: object
      description: Node credentials data
      properties:
        profile:
          type: string
        v2_info:
          $ref: '#/components/schemas/robotapiRobotSnmpV2'
        v3_info:
          $ref: '#/components/schemas/robotapiRobotSnmpV3'
        user_pass:
          type: array
          items:
            $ref: '#/components/schemas/robotapiRobotUserPass'
    robotapiRobotJobState:
      description: Various Job Resulting states.
      type: string
      enum:
      - JOB_INVALID
      - JOB_REJECTED
      - JOB_ACCEPTED
      - JOB_DB_UPDATED
      - JOB_NOTIFICATION_PUBLISHED
      - JOB_COMPLETED
      - JOB_FAILED
      default: JOB_INVALID
    robotapiRobotSnmpV3PrivType:
      type: string
      enum:
      - PT_UNKNOWN
      - PT_CFB_AES_128
      - PT_CBC_DES_56
      default: PT_UNKNOWN
  securitySchemes:
    bearerAuth:
      type: apiKey
      name: Authorization
      in: header