GET/security/keys/{uuid}

Get a private key

Retrieves a private key by its UUID. Use this endpoint to get the key's details and key material. The uuid path parameter identifies the key to retrieve.

1 parameter
uuidstringrequired
The UUID of the private key to retrieve.

4 status codes
200Returns the private key object, including its UUID, name, description, fingerprint, public key, and private key.
created_atstringoptional
descriptionstringoptional
fingerprintstringoptional
The fingerprint of the private key.
idintegeroptional
is_git_relatedbooleanoptional
namestringoptional
private_keystringoptional
public_keystringoptional
The public key of the private key.
team_idintegeroptional
updated_atstringoptional
uuidstringoptional
400Returned when the token is invalid.
messagestringoptional
401Returned when the request is unauthenticated.
messagestringoptional
404Returned when the private key is not found.

Error handling

A 400 is returned when the token is invalid. A 401 is returned when the request is unauthenticated. A 404 is returned when the private key is not found; the uuid path parameter must identify an existing private key.