Private Key

September 12, 2025 18:59

SSH Keys

Specification

{
  "name": "<string>",
  "description": "<string>",
  "privateKeyType": "<string>",
  "privateKey": "<string>",
  "publicKey": "<string>",
  "hostname": "<string>"
}

Structure Values

Field Name	Type	Description	Required	Default
name	String	Private key name. Must be unique within an organization.	Required
description	String	Expanded, user-generated description of the private key.	Optional	None
privateKeyType	String	The type of private key. `SSH` for SSH Keys.	Required
privateKey	String	The private key to use as an identity for when making outbound SSH connections from a Magpie Cluster.	Required
publicKey	String	The public key corresponding to the private key. This field is for your records only and is not used by Magpie.	Optional	None
hostname	String	The hostname corresponding to the SSH key. If left blank, the SSH key will be used by default for connecting to all SSH hosts.	Optional	None

Example

SSH key for Github.com

{
  "name": "github",
  "description": "SSH Key to authenticate with Github to download private libraries",
  "privateKeyType": "SSH",
  "privateKey": "-----BEGIN RSA PRIVATE KEY----- ...", // Special characters must be escaped to create valid JSON. Recommend defining as part of the Create command instead.
  "publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAAD ...",
  "hostname": "github.com"
}

Google Cloud Platform (GCP) Keys

Specification

{
  "name": "<string>",
  "description": "<string>",
  "privateKeyType": "<string>",
  "privateKey": "<string>",
}

Structure Values

Field Name	Type	Description	Required	Default
name	String	Private key name. Must be unique within an organization.	Required
description	String	Expanded, user-generated description of the private key.	Optional	None
privateKeyType	String	The type of private key. `SSH` for SSH Keys.	Required
privateKey	String	The private key to use as an identity for when making outbound SSH connections from a Magpie Cluster.	Required

Example

GCP Key

{
  "name": "gcp_prod_lake",
  "description": "Google Cloud Platform key with access to Prod Bigquery Table",
  "privateKeyType": "GCP",
  "privateKey": "{<JSON GCP Key>}", // Special characters must be escaped to create valid JSON. Recommend defining as part of the Create command instead.
}