Sign in

v4

latestOpenAPI 3.0.32026-07-312,317012.2 MB
SSH Certificates

Issue SSH credentials (certificate + key)

post/api/v1/ssh/certificates/issue

Request body

certificateTemplateIdstring required

The ID of the SSH certificate template to issue the SSH credentials with.

keyAlgorithm'RSA_2048' | 'RSA_4096' | 'EC_prime256v1' | 'EC_secp384r1' | 'ED25519'

The type of public key algorithm and size, in bits, of the key pair for the SSH CA.

certType'user' | 'host'

The type of certificate to issue. This can be one of user or host.

principalsstring[] required

The list of principals (usernames, hostnames) to include in the certificate.

ttlstring

The time to live for the certificate such as 1m, 1h, 1d, ... If not specified, the default TTL for the template will be used.

keyIdstring

The key ID to include in the certificate. If not specified, a default key ID will be generated.

Response

Default Response

serialNumberstring required

The serial number of the issued SSH certificate.

signedKeystring required

The SSH certificate or signed SSH public key.

privateKeystring required

The private key corresponding to the issued SSH certificate.

publicKeystring required

The public key of the issued SSH certificate.

keyAlgorithm'RSA_2048' | 'RSA_4096' | 'EC_prime256v1' | 'EC_secp384r1' | 'ED25519' required

The type of public key algorithm and size, in bits, of the key pair for the SSH CA.