POST /bsus/api/v1/ssh_keys/{name} - Adaptive Applications - BlueCat Gateway - 23.1

BlueCat Server Update Services Administration Guide
Locale
English
Product name
BlueCat Gateway
Version
23.1

Description

Updates information about a specific SSH key based on a provided name.

Parameters

Name Description
payload (body) Location: body

Type: application/json

{
  "username": "string",
  "private_key": "string",
  "passphrase": "string",
  "root_password": "string"
}
Parameter
  • username—the new name for the SSH key entry.
  • private_key—the SSH private key data that was produced when creating the SSH key pair.
  • passphrase—the key's passphrase, if one was used when generating the SSH key pair.
  • root_password—the root user's password.

    If your system does not require an additional password to switch to the root user after signing in, you do not need to use this parameter.

name Location: path

Type: string

The user-facing label of the SSH key (not the sign-in username) that you want to update.

Responses

Status Description
Successful

Code: 200

Body:
[
  {
    "id":"string",
    "name":"string",
    "username": "testuser"
  }
]
Results:

Details about the matching key:

  • id—a hashed ID for the SSH private key.
  • name—the user-facing label given to the SSH key.
  • username—the username for use when logging in with the SSH key.
Error

Code: 400

{
  "error": "string"
}

Bad request.

Code: 401

Unauthorized user.

Code: 409

{
  "error": "The private key with name <name> is already exists"
}

Duplicate name

Code: 500

Internal server error.

Body:
{
    "error": "string"
}

This can be caused when an unknown application error is encountered on the Server side. The API attempts to return additional details within the error parameter.