GitHub
DevOps Service
Backend service & agents
24
DevOps UI
Dashboard & frontend
1

Machines endpoints

This document contains the endpoints for the Machines category.

Gets all the virtual machines

/api/v1/machines Authorized

This endpoint returns all the virtual machines

Parameters
Name Type In Required Description
filter header header optional -

Gets a virtual machine

/api/v1/machines/{id} Authorized

This endpoint returns a virtual machine

Parameters
Name Type In Required Description
id string path required Machine ID

Starts a virtual machine

/api/v1/machines/{id}/start Authorized

This endpoint starts a virtual machine

Parameters
Name Type In Required Description
id string path required Machine ID

Stops a virtual machine

/api/v1/machines/{id}/stop Authorized

This endpoint stops a virtual machine

Parameters
Name Type In Required Description
id string path required Machine ID

Restarts a virtual machine

/api/v1/machines/{id}/restart Authorized

This endpoint restarts a virtual machine

Parameters
Name Type In Required Description
id string path required Machine ID

Suspends a virtual machine

/api/v1/machines/{id}/suspend Authorized

This endpoint suspends a virtual machine

Parameters
Name Type In Required Description
id string path required Machine ID

Resumes a virtual machine

/api/v1/machines/{id}/resume Authorized

This endpoint resumes a virtual machine

Parameters
Name Type In Required Description
id string path required Machine ID

Reset a virtual machine

/api/v1/machines/{id}/reset Authorized

This endpoint reset a virtual machine

Parameters
Name Type In Required Description
id string path required Machine ID

Pauses a virtual machine

/api/v1/machines/{id}/pause Authorized

This endpoint pauses a virtual machine

Parameters
Name Type In Required Description
id string path required Machine ID

Deletes a virtual machine

/api/v1/machines/{id} Authorized

This endpoint deletes a virtual machine

Parameters
Name Type In Required Description
id string path required Machine ID

Get the current state of a virtual machine

/api/v1/machines/{id}/status Authorized

This endpoint returns the current state of a virtual machine

Parameters
Name Type In Required Description
id string path required Machine ID

Configures a virtual machine

/api/v1/machines/{id}/set Authorized

This endpoint configures a virtual machine

Parameters
Name Type In Required Description
id string path required Machine ID
configRequest object body optional Machine Set Request
Schema 
{
  "operations": "[]*VirtualMachineConfigRequestOperation",
  "owner": "string"
}

Clones a virtual machine

/api/v1/machines/{id}/clone Authorized

This endpoint clones a virtual machine

Parameters
Name Type In Required Description
id string path required Machine ID
configRequest object body optional Machine Clone Request
Schema 
{
  "clone_name": "string"
}

Executes a command on a virtual machine

/api/v1/machines/{id}/execute Authorized

This endpoint executes a command on a virtual machine

Parameters
Name Type In Required Description
id string path required Machine ID
executeRequest object body optional Machine Execute Command Request
Schema 
{
  "command": "string",
  "environment_variables": "map[string]string",
  "script": "*VirtualMachineExecuteCommandScript",
  "use_ssh": "bool",
  "use_sudo": "bool",
  "user": "string"
}

Uploads a file to a virtual machine

/api/v1/machines/{id}/upload Authorized

This endpoint executes a command on a virtual machine

Parameters
Name Type In Required Description
id string path required Machine ID
executeRequest object body optional Machine Upload file Command Request
Schema 
{
  "path": "string",
  "remote_path": "string"
}

Renames a virtual machine

/api/v1/machines/{id}/rename Authorized

This endpoint Renames a virtual machine

Parameters
Name Type In Required Description
id string path required Machine ID
renameRequest object body optional Machine Rename Request
Schema 
{
  "current_name": "string",
  "description": "string",
  "id": "string",
  "new_name": "string"
}

Registers a virtual machine

/api/v1/machines/register Authorized

This endpoint registers a virtual machine

Parameters
Name Type In Required Description
id string path required Machine ID
registerRequest object body optional Machine Register Request
Schema 
{
  "delay_applying_restrictions": "bool",
  "force": "bool",
  "machine_name": "string",
  "owner": "string",
  "path": "string",
  "regenerate_source_uuid": "bool",
  "uuid": "string"
}

Unregister a virtual machine

/api/v1/machines/{id}/unregister Authorized

This endpoint unregister a virtual machine

Parameters
Name Type In Required Description
id string path required Machine ID
unregisterRequest object body optional Machine Unregister Request
Schema 
{
  "clean_source_uuid": "bool",
  "id": "string",
  "owner": "string"
}

Creates a virtual machine

/api/v1/machines Authorized

This endpoint creates a virtual machine

Parameters
Name Type In Required Description
createRequest object body optional New Machine Request
Schema 
{
  "architecture": "string",
  "catalog_manifest": "*CreateCatalogVirtualMachineRequest",
  "name": "string",
  "owner": "string",
  "packer_template": "*CreatePackerVirtualMachineRequest",
  "start_on_create": "bool",
  "vagrant_box": "*CreateVagrantMachineRequest"
}