REST - Operating Systems

Listing Operating Systems

Request

GET /v2/templates

Returns an array containing a list of existing operating systems.

Response

{  
  "success":true,
  "templates": [
     {
       "id":"$template_id",
       "label":"$template_label",

       "supports": [   // contents of the array varies depending on the system
           "password",
           "sshkey",
           "cloudinit" 
       ],

       // 'owner' field exists if
       // the template has been created by a user
       "owner": {
           "id": $owner_id,
           "name": $owner_name
       }
     },
     { ... }
  ]
}

Returned information

• $template_id (string) - ID of the image
• $template_label (string) - name of the operating system
• $owner_id (string) - ID of the image owner (for images created by a user)
• $owner_name (string) - name of the image owner (for images created by a user)
• supports (array) - array of methods specifying additional options supported during installation. Possible values:
  • password - system supports setting a password during installation
  • sshkey - system supports setting an SSH key during installation
  • cloudinit - system supports configurations using Cloud-init

Updated on 05 Sep 2023