GET /bsus/api/v1/ssh_keys/{name} - Adaptive Applications - BlueCat Gateway - 22.1

BlueCat Server Update Services Administration Guide

Locale
English (United States)
Product name
BlueCat Gateway
Version
22.1

Description

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

Parameters

Name Description
name Location: query

Type: string

The user-facing name of the SSH key (not the username) that you want to retrieve information about.

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: 401

Unauthorized user.

Code: 404

No matching private key found.

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.