SSH Key

SSH key pairs injected into instances at launch for password-less authentication.

Resource base path: /restapi/sshkey

Method	Path	Description
POST	/restapi/sshkey/createSSHkey	Create SSH Key
GET	/restapi/sshkey/sshkeyList	SSH Key List
DELETE	/restapi/sshkey/deleteSSHkey/{uuid}	Delete SSH Key

note

apikey and secretkey are required HTTP headers on every request and are omitted from the parameter tables below. See Authentication.

---

Create SSH Key

Create SSH Key.

POST /restapi/sshkey/createSSHkey

Request body

Field	Type	Required	Description
name	string	No	Name of the resource.
publicKey	string	No

{
  "name": "example-name",
  "publicKey": "string"
}

Example request

curl -X POST \
  "https://portal.your-domain.com/restapi/sshkey/createSSHkey" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "example-name",
  "publicKey": "string"
}'

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "count": 1,
  "listSSHKeyResponse": [
    {
      "domainName": "example-name",
      "name": "example-name",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "Active"
    }
  ]
}

---

SSH Key List

SSH Key List.

GET /restapi/sshkey/sshkeyList

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/sshkey/sshkeyList" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "count": 1,
  "listSSHKeyResponse": [
    {
      "domainName": "example-name",
      "name": "example-name",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "status": "Active"
    }
  ]
}

---

Delete SSH Key

Delete SSH Key.

DELETE /restapi/sshkey/deleteSSHkey/{uuid}

Parameters

Parameter	In	Type	Required	Description
uuid	path	string	✅ Yes	UUID of the resource.

Example request

curl -X DELETE \
  "https://portal.your-domain.com/restapi/sshkey/deleteSSHkey/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

true