Template

Templates contain the OS and the initial setup of a Compute instance.

Read more

get-template

Retrieve Template details

GET /template/{id}

Path parameters

• id in path (required)

Responses

• 200: 200
  • application/json
    • application-consistent-snapshot-enabled (boolean): Template with Qemu Guest Agent installed for application consistent snapshot
    • maintainer (string): Template maintainer
    • description (string): Template description
    • ssh-key-enabled (boolean): Enable SSH key-based login
    • family (string): Template family
    • name (string): Template name
    • default-user (string): Template default user
    • size (integer): Template size
    • password-enabled (boolean): Enable password-based login
    • build (string): Template build
    • checksum (string): Template MD5 checksum
    • boot-mode (string): Boot mode (default: legacy)
    • id (string): Template ID
    • zones (array[string]): Zones availability
    • url (string): Template source URL
    • version (string): Template version
    • created-at (string): Template creation date
    • visibility (string): Template visibility

SDK reference for get-template: golang | Python | Java

CLI: exo api get-template

update-template

Update template attributes

PUT /template/{id}

Path parameters

• id in path (required)

Request body

• application/json
  • name (string): Template name
  • description (string): Template Description

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for update-template: golang | Python | Java

CLI: exo api update-template

delete-template

Delete a Template

DELETE /template/{id}

Path parameters

• id in path (required)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for delete-template: golang | Python | Java

CLI: exo api delete-template

Other Operations

copy-template

Copy a Template from a zone to another

POST /template/{id}

Path parameters

• id in path (required)

Request body

• application/json
  • target-zone (required) (object): Zone - schema details

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for copy-template: golang | Python | Java

CLI: exo api copy-template

register-template

Register a Template

POST /template

Request body

• application/json
  • application-consistent-snapshot-enabled (boolean): Template with support for Application Consistent Snapshots
  • maintainer (string): Template maintainer
  • description (string): Template description
  • ssh-key-enabled (required) (boolean): Enable SSH key-based login
  • name (required) (string): Template name
  • default-user (string): Template default user
  • size (integer): Template size
  • password-enabled (required) (boolean): Enable password-based login
  • build (string): Template build
  • checksum (required) (string): Template MD5 checksum
  • boot-mode (string): Boot mode (default: legacy)
  • url (required) (string): Template source URL
  • version (string): Template version

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for register-template: golang | Python | Java

CLI: exo api register-template

list-templates

List Templates

GET /template

Query parameters

• visibility in query (optional)
• family in query (optional)

Responses

• 200: 200
  • application/json
    • templates (array[object]) - schema details

SDK reference for list-templates: golang | Python | Java

CLI: exo api list-templates