Apache CloudStack 4.17.0.0 Root Admin API Reference

listSSHKeyPairs

List registered keypairs

Request parameters

Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
domainidlist only resources belonging to the domain specifiedfalse
fingerprintA public key fingerprint to look forfalse
idthe ID of the ssh keypairfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.false
nameA key pair name to look forfalse
pagefalse
pagesizefalse
projectidlist objects by project; if projectid=-1 lists All VMsfalse

Response Tags

Response NameDescription
idID of the ssh keypair
accountthe owner of the keypair
domainthe domain name of the keypair owner
domainidthe domain id of the keypair owner
fingerprintFingerprint of the public key
nameName of the keypair