Issue SSH certificate

POST 
/api/v1/users/:machineIdOrAlias/ssh/certificate

This API endpoint issues an SSH certificate for the machine identified by the provided machineId or machine alias. A SSH certificate is a digital certificate used to authenticate and secure connections in the SSH (Secure Shell) protocol, which is commonly used for secure remote access to servers and systems.

Request

Path Parameters

machineIdOrAlias stringrequired

The machineId - unique id of the machine, alias - machine alias

application/json

Body

required

The request body containing the required details to issue SSH certificate

principals string[]required
publicKey stringrequired

Responses

200

Success response

application/json

Schema

Schema

success boolean
message string
status string
statusCode int32
errorCode string
subErrors object[]

payload

object

Schema for issue SSH certificate response

signedKey string

serialNumber string

Example (from schema)

{
  "success": true,
  "message": "string",
  "status": "string",
  "statusCode": 0,
  "errorCode": "string",
  "subErrors": [
    {}
  ],
  "payload": {
    "signedKey": "string",
    "serialNumber": "string"
  }
}

Issue SSH certificate example

Issue SSH certificate response example

{
  "success": true,
  "message": "SSH certificate issued successfully",
  "status": "OK",
  "statusCode": 200,
  "errorCode": "",
  "subErrors": [
    {}
  ],
  "payload": {
    "signedKey": "[email protected] AAAAHHNzaC1y...",
    "serialNumber": "a34b3660efeb55b"
  }
}

Loading...