An SSH Private Key is a private key credential stored in the platform and used for automated SSH access to external VMs. At present the only such use is reaching the external peer of a VPC Peering.

Key concepts

• Private key material — the secret half of the key pair, marked sensitive. Note: it is currently stored unencrypted at rest

• Automation use — pair it with an SSH Key (the public half) on the external host you need to reach

Security note

Private keys are only accessible to users with explicit permission, but the key material is currently held unencrypted at rest. Avoid storing personal private keys here; use dedicated organization-level service keys instead.

Examples

Terraform

Python SDK

kc CLI

---

Related pages

Resource docs

• SSH Key resource docs

Examples

• CLI VMs example
• Terraform VMs example

More in this section

• Virtual Machine
• Volume
• Volume Attachment
• Floating IP
• Certificate
• Image
• Image Schedule
• On/Off Schedule
• VM Command Schedule