Credential APIs

Get Devices Credentials 

• Description – Gets devices' credentials.

• Request URL – GET /cablevalidation/creds

• Response Content Type – application/json

• Status Codes200 – OK

• Response Data: 

  [
      {
          "node": "default",
          "user": "admin",
          "pwd": "****",
          "type": "switch",
          "save": true
      },
      {
          "node": "sw-hdr-proton01.mtr.labs.mlnx",
          "user": "admin",
          "pwd": "****",
          "type": "",
          "save": false
      }
  ]

Upload Credentials File

Description – Uploads and loads credentials from a credential file (JSON or INI format).

Request URL – POST /cablevalidation/creds/upload

Request Content Type – multipart/form-data

Form Fields:

• file (required) – The credential file (format auto-detected from filename)

• replace (optional) – Whether to replace existing credentials: 'true' or 'false' (default: false)

Response Content Type – application/json

Status Codes:

• 200 – OK

• 400 – Bad Request (invalid file content, unsupported format, or failed to apply credentials)

• {
      "total": 10,
      "success": 9,
      "failed": 1,
      "errors": ["Failed to apply credential_profile..."]
  }
  
  

Set Node Credentials

Description – Sets credentials for a specific node.

Request URL – POST /cablevalidation/creds/nodes/{node_id}

Parameters:

• node_id – Node identifier (hostname or IP address)

Request Content Type – application/jsonRequest

 Request Body:

• {
      "user": "admin",
      "pwd": "password",
      "save": true
  }
  

Response Content Type – application/json

Status Codes:

• 200 – OK

• 400 – Bad Request (missing required fields or invalid JSON)

Response Body :

• {
      "message": "Credentials set for node node_id"
  }
  
  

Delete Node Credentials

Description – Removes credentials for a specific node.

Request URL – DELETE  /cablevalidation/creds/nodes/{node_id}

 Parameters:

• node_id – Node identifier (hostname or IP address)

Response Content Type – application/json

Status Codes:

• 200 – OK

• {
      "message": "Credentials removed for node sw-hdr-proton01.mtr.labs.mlnx"
  }
  
  

Set Default Credentials

Description – Sets default credentials for a node type (switch or host).

Request URL – POST /cablevalidation/creds/defaults/{node_type}

Parameters:

• node_type – Node type: switch or host

Request Content Type – application/json

Status Codes:

• 200 – OK

• 400 – Bad Request (missing required fields, invalid node_type, or invalid JSON)

Response  Data:

• {
          "message": "Default credentials set for switch"
  
  }
  
  

Delete Default Credentials

Description – Removes default credentials for a node type.

Request URL – DELETE /cablevalidation/creds/defaults/{node_type}

Parameters:

• node_type – Node type: switch or host

Response Content Type – application/json

Status Codes:

• 200 – OK

• 400 – Bad Request (invalid node_type)

• {
      "message": "Default credentials removed for switch"
  }
  
  

Set Profile Credentials

Description – Sets credentials for a credential profile.

Request URL – POST /cablevalidation/creds/profiles/{profile_name}

Parameters:

• profile_name – Name of the credential profile

Request Content Type – application/json

Request Body:

• {
      "user": "admin",
      "pwd": "password",
      "save": true
  }
  
  

Response Content Type – application/json

Status Codes:

• 200 – OK

• 400 – Bad Request (missing required fields or invalid JSON)

• 404 – Not Found (profile not found

Response Data:

• {
      "message": "Credentials set for profile profile1"
  }
  
  

Delete Profile Credentials

Description – Removes credentials for a credential profile.

Request URL – DELETE /cablevalidation/creds/profiles/{profile_name}

Parameters:

• profile_name – Name of the credential profile

Response Content Type – application/json

Status Codes:

• 200 – OK

Response Data:

• {
      "message": "Credentials removed for profile profile1"
  
  }
  
  

Last updated: June 03, 2026