Terrakube
Latest
Search
⌃K
Comment on page

SSH Key

This endpoint is used to create, update, search or delete ssh keys.
To use this endpoint you should have "manageVcs" access at team level and a Terrakube Organization

Entity fields:

Path
Type
Description
data.type
string
Should be "ssh"
data.attributes.name
string
Unique ssh key name for an Terrakube organization
data.attributes.description
string
Free text for description
data.attributes.privateKey
string
SSH Key content
data.attributes.sshType
string
rsa or ed25519

Example:

{
"data": {
"type": "ssh",
"attributes": {
"name": "Sample SSH Key",
"description": "SSH Key Description",
"privateKey": "{{sshPrivateKey}}",
"sshType": "{{sshKeyType}}"
}
}
}

Supported Operations

get
/organization/{organizationId}/ssh
post
/organization/{organizationId}/ssh
delete
/organization/{organizationId}/ssh/{sshId}
patch
/organization/{organizationId}/ssh/{sshId}
Last modified 1yr ago