Servers

Contents

• Contents
• Servers
  • List servers
  • Show server
  • Commission server
  • Update server
  • Boot server
  • Reboot server
  • Shut down server
  • Override server
  • Decommission server
  • Get credentials of server
  • List events of a server
  • List operational scripts of a server
  • Execute script on a server
  • List floating IPs of a server
  • List volumes of a server
  • Generate brownfield token for a server
  • Converge brownfield server
  • Override brownfield server
  • Discard brownfield server

Servers

Servers represent computational resources or virtual machines the user deploys on a cloud provider.

List servers

GET /v3/cloud/servers

This action returns information about all the server inside a customer.

Inputs

None

Returns

An array of servers, ordered from less to most recent, with the following fields:

Field	Type	Description	Deprecation notices	Notes
id	String	Identifier of the server.
name	String	Logical name of the server.
fqdn	String	Fully qualified domain name (FQDN) of the server.
state	String	State of the server. It can be any of the following: commissioning, inactive, booting, bootstrapping, operational, stalled, shutting_down,decommissioning, commission_stalled.
public_ip	String	Public IP of the server or null if it does not have one yet.
private_ip	String	Private IP of the server or null if it does not have one yet.
workspace_id	String	Identifier of the workspace to which the server belongs.	No longer available from 7.3 onwards
template_id	String	Identifier of the template defining the software configuration the server uses.
server_plan_id	String	Identifier of the server plan with which the server is deployed.
cloud_account_id	String	Identifier of the cloud account in which the server is deployed.
ssh_profile_id	String	Identifier of the ssh profile the server uses. First of ssh_profile_ids.	Deprecated from version 9 onwards.
ssh_profile_ids	Array of string	Identifiers of the ssh profiles the server uses.		Available from version 9 onwards.
firewall_profile_id	String	Identifier of the firewall profile applied on the server.
server_array_id	String	Identifier of the server array to which the server belongs if any or null.
brownfield_state	String	A string describing the level of integration with the platform achieved. It must be one of "M1", "M1-M2", "M2", "M2-M3", "Overriden", "Certified" or "Pure".
subnet_id	String	Identifier of the subnet on which the server is deployed if any or null.
vpc_id	String	Identifier of the VPC on which the server is deployed if any or null.
privateness	Boolean	Flag indicating whether the server will get only a private IP
variable_value_ids	Object	An object defining variable values for the configuration in the template. It has a key for each variable defined and arrays of two elements as values:The first element of the array is the id of the variable value.The second element of the array is the resource_type of the variable value.
label_ids	String	List of ids corresponding to the labels the server has assigned.
supports_volume_attachment	Boolean	True if the server supports volume attachments, false otherwise.
desired_remote_id	String	Identifier that the user wants to have as Identifier of the resource on the cloud.		Available from version 10.3 onwards.
resource_type	String	An identifier for the type of resource, specifically "server".

Back to top

Show server

GET /v3/cloud/servers/:id

This action returns information about the server identified by the given id.

Inputs

None

Returns

Field	Type	Description	Deprecation notices	Notes
id	String	Identifier of the server.
name	String	Logical name of the server.
fqdn	String	Fully qualified domain name (FQDN) of the server.
state	String	State of the server. It can be any of the following: commissioning, inactive, booting, bootstrapping, operational, stalled, shutting_down,decommissioning, commission_stalled.
public_ip	String	Public IP of the server or null if it does not have one yet.
private_ip	String	Private IP of the server or null if it does not have one yet.
workspace_id	String	Identifier of the workspace to which the server belongs.	No longer available from 7.3 onwards
template_id	String	Identifier of the template defining the software configuration the server uses.
server_plan_id	String	Identifier of the server plan with which the server is deployed.
cloud_account_id	String	Identifier of the cloud account in which the server is deployed.
ssh_profile_id	String	Identifier of the ssh profile the server uses. First of ssh_profile_ids.	Deprecated from version 9 onwards.
ssh_profile_ids	Array of string	Identifiers of the ssh profiles the server uses.		Available from version 9 onwards.
firewall_profile_id	String	Identifier of the firewall profile applied on the server.
server_array_id	String	Identifier of the server array to which the server belongs if any or null.
brownfield_state	String	A string describing the level of integration with the platform achieved. It must be one of "M1", "M1-M2", "M2", "M2-M3", "Overriden", "Certified" or "Pure".
subnet_id	String	Identifier of the subnet on which the server is deployed if any or null.
vpc_id	String	Identifier of the VPC on which the server is deployed if any or null.
privateness	Boolean	Flag indicating whether the server will get only a private IP
variable_value_ids	Object	An object defining variable values for the configuration in the template. It has a key for each variable defined and arrays of two elements as values:The first element of the array is the id of the variable value.The second element of the array is the resource_type of the variable value.
label_ids	String	List of ids corresponding to the labels the server has assigned.
supports_volume_attachment	Boolean	True if the server supports volume attachments, false otherwise.
desired_remote_id	String	Identifier that the user wants to have as Identifier of the resource on the cloud.		Available from version 10.3 onwards.
resource_type	String	An identifier for the type of resource, specifically "server".

Back to top

Commission server

POST /v3/cloud/servers/

This action creates a new server and commissions it at the cloud provider.

Inputs

Field	Type	Description	Required
name	String	Logical name of the server.	Yes
workspace_id	String	Identifier of the workspace to which the server shall belong.	Yes before 7.3, no from 7.3 onwards.
template_id	String	Identifier of the template which the server shall use.	Yes
server_plan_id	String	Identifier of the server plan in which the server shall bedeployed.	Yes
cloud_account_id	String	Identifier of the cloud account in which the server is deployed.	Yes
firewall_profile_id	String	Identifier of the firewall profile to which the server shall belong.It will take the default firewall profile if it is not given.	No
desired_remote_id	String	Identifier that the user wants to have as Identifier of the resource on the cloud. Available from version 10.3 onwards.	No
ssh_profile_id	String	Identifier of the ssh profile to which the server is deployed.	No
ssh_profile_ids	Array of string	Identifiers of the ssh profiles to which the server will belong. On version 9 onwards, that's the default way to set ssh profiles to a server. If ssh_profile_id and ssh_profile_ids are given, ssh_profile_id will not be taken into account.	No
subnet_id	String	Identifier of the subnet to which the server belongs.It will not be on any subnet managed by IMCO if not given.	No
privateness	Boolean	Flag indicating whether the server will get only a private IP.	No
template_addons_ids	Array of String	A list of Ids of template addons that may be applied to this server.	No
variable_value_ids	Object	An object defining variable values for the configuration in the template. It has a key for each variable defined and arrays of two elements as values:The first element of the array is the id of the variable value.The second element of the array is the resource_type of the variable value.Only available from 7.3 onwards.	No
label_ids	Array of strings	List of ids corresponding to the labels to assign to the server.	No

Returns

Field	Type	Description	Deprecation notices	Notes
id	String	Identifier of the server.
name	String	Logical name of the server.
fqdn	String	Fully qualified domain name (FQDN) of the server.
state	String	State of the server. It can be any of the following: commissioning, inactive, booting, bootstrapping, operational, stalled, shutting_down,decommissioning, commission_stalled.
public_ip	String	Public IP of the server or null if it does not have one yet.
private_ip	String	Private IP of the server or null if it does not have one yet.
workspace_id	String	Identifier of the workspace to which the server belongs.	No longer available from 7.3 onwards
template_id	String	Identifier of the template defining the software configuration the server uses.
server_plan_id	String	Identifier of the server plan with which the server is deployed.
cloud_account_id	String	Identifier of the cloud account in which the server is deployed.
ssh_profile_id	String	Identifier of the ssh profile the server uses. First of ssh_profile_ids.	Deprecated from version 9 onwards.
ssh_profile_ids	Array of string	Identifiers of the ssh profiles the server uses.		Available from version 9 onwards.
firewall_profile_id	String	Identifier of the firewall profile applied on the server.
server_array_id	String	Identifier of the server array to which the server belongs if any or null.
brownfield_state	String	A string describing the level of integration with the platform achieved. It must be one of "M1", "M1-M2", "M2", "M2-M3", "Overriden", "Certified" or "Pure".
subnet_id	String	Identifier of the subnet on which the server is deployed if any or null.
vpc_id	String	Identifier of the VPC on which the server is deployed if any or null.
privateness	Boolean	Flag indicating whether the server will get only a private IP
variable_value_ids	Object	An object defining variable values for the configuration in the template. It has a key for each variable defined and arrays of two elements as values:The first element of the array is the id of the variable value.The second element of the array is the resource_type of the variable value.
label_ids	String	List of ids corresponding to the labels the server has assigned.
supports_volume_attachment	Boolean	True if the server supports volume attachments, false otherwise.
desired_remote_id	String	Identifier that the user wants to have as Identifier of the resource on the cloud.		Available from version 10.3 onwards.
resource_type	String	An identifier for the type of resource, specifically "server".

Back to top

Update server

PUT /v3/cloud/servers/:id

This action modifies the server with the given parameters.

Inputs

Field	Type	Description	Required
name	String	Logical name of the server.	No
template_id	String	Identifier of the template defining the software configuration the server uses. Only if the server is in M1, M1-M2 or M2 brownfield state.	No
ssh_profile_ids	Array of string	Identifiers of the ssh profiles to which the server will belong.	No
variable_values_ids	Hash	An object defining variable values for the configuration in the template. It has a key for each variable defined and arrays of two elements as values:The first element of the array is the id of the variable value.The second element of the array is the resource_type of the variable value.	No

Returns

Field	Type	Description	Deprecation notices	Notes
id	String	Identifier of the server.
name	String	Logical name of the server.
fqdn	String	Fully qualified domain name (FQDN) of the server.
state	String	State of the server. It can be any of the following: commissioning, inactive, booting, bootstrapping, operational, stalled, shutting_down, decommissioning, commission_stalled.
public_ip	String	Public IP of the server or null if it does not have one yet.
private_ip	String	Private IP of the server or null if it does not have one yet.
workspace_id	String	Identifier of the workspace to which the server belongs.	No longer available from 7.3 onwards
template_id	String	Identifier of the template defining the software configuration the server uses.
server_plan_id	String	Identifier of the server plan with which the server is deployed.
cloud_account_id	String	Identifier of the cloud account in which the server is deployed.
ssh_profile_id	String	Identifier of the ssh profile the server uses. First of ssh_profile_ids.	Deprecated from version 9 onwards.
ssh_profile_ids	Array of string	Identifiers of the ssh profiles the server uses.		Available from version 9 onwards.
firewall_profile_id	String	Identifier of the firewall profile applied on the server.
server_array_id	String	Identifier of the server array to which the server belongs if any or null.
brownfield_state	String	A string describing the level of integration with the platform achieved. It must be one of "M1", "M1-M2", "M2", "M2-M3", "Overriden", "Certified" or "Pure".
subnet_id	String	Identifier of the subnet on which the server is deployed if any or null.
vpc_id	String	Identifier of the VPC on which the server is deployed if any or null.
privateness	Boolean	Flag indicating whether the server will get only a private IP
variable_value_ids	Object	An object defining variable values for the configuration in the template. It has a key for each variable defined and arrays of two elements as values:The first element of the array is the id of the variable value.The second element of the array is the resource_type of the variable value.
label_ids	String	List of ids corresponding to the labels the server has assigned.
supports_volume_attachment	Boolean	True if the server supports volume attachments, false otherwise.
desired_remote_id	String	Identifier that the user wants to have as Identifier of the resource on the cloud.		Available from version 10.3 onwards.
resource_type	String	An identifier for the type of resource, specifically "server".

Back to top

Boot server

PUT /v3/cloud/servers/:id/boot

This action boots the server with the given id. The server must be in an inactive state.

Inputs

None

Returns

Field	Type	Description	Deprecation notices	Notes
id	String	Identifier of the server.
name	String	Logical name of the server.
fqdn	String	Fully qualified domain name (FQDN) of the server.
state	String	State of the server. It can be any of the following: commissioning, inactive, booting, bootstrapping, operational, stalled, shutting_down, decommissioning, commission_stalled.
public_ip	String	Public IP of the server or null if it does not have one yet.
private_ip	String	Private IP of the server or null if it does not have one yet.
workspace_id	String	Identifier of the workspace to which the server belongs.	No longer available from 7.3 onwards
template_id	String	Identifier of the template defining the software configuration the server uses.
server_plan_id	String	Identifier of the server plan with which the server is deployed.
cloud_account_id	String	Identifier of the cloud account in which the server is deployed.
ssh_profile_id	String	Identifier of the ssh profile the server uses. First of ssh_profile_ids.	Deprecated from version 9 onwards.
ssh_profile_ids	Array of string	Identifiers of the ssh profiles the server uses.		Available from version 9 onwards.
firewall_profile_id	String	Identifier of the firewall profile applied on the server.
server_array_id	String	Identifier of the server array to which the server belongs if any or null.
brownfield_state	String	A string describing the level of integration with the platform achieved. It must be one of "M1", "M1-M2", "M2", "M2-M3", "Overriden", "Certified" or "Pure".
subnet_id	String	Identifier of the subnet on which the server is deployed if any or null.
vpc_id	String	Identifier of the VPC on which the server is deployed if any or null.
privateness	Boolean	Flag indicating whether the server will get only a private IP
variable_value_ids	Object	An object defining variable values for the configuration in the template. It has a key for each variable defined and arrays of two elements as values:The first element of the array is the id of the variable value.The second element of the array is the resource_type of the variable value.
label_ids	String	List of ids corresponding to the labels the server has assigned.
supports_volume_attachment	Boolean	True if the server supports volume attachments, false otherwise.
desired_remote_id	String	Identifier that the user wants to have as Identifier of the resource on the cloud.		Available from version 10.3 onwards.
resource_type	String	An identifier for the type of resource, specifically "server".

Back to top

Reboot server

PUT /v3/cloud/servers/:id/reboot

This action reboots the server with the given id. The server must be in an operational state.

Inputs

None

Returns

Field	Type	Description	Deprecation notices	Notes
id	String	Identifier of the server.
name	String	Logical name of the server.
fqdn	String	Fully qualified domain name (FQDN) of the server.
state	String	State of the server. It can be any of the following: commissioning, inactive, booting, bootstrapping, operational, stalled, shutting_down,decommissioning, commission_stalled.
public_ip	String	Public IP of the server or null if it does not have one yet.
private_ip	String	Private IP of the server or null if it does not have one yet.
workspace_id	String	Identifier of the workspace to which the server belongs.	No longer available from 7.3 onwards
template_id	String	Identifier of the template defining the software configuration the server uses.
server_plan_id	String	Identifier of the server plan with which the server is deployed.
cloud_account_id	String	Identifier of the cloud account in which the server is deployed.
ssh_profile_id	String	Identifier of the ssh profile the server uses. First of ssh_profile_ids.	Deprecated from version 9 onwards.
ssh_profile_ids	Array of string	Identifiers of the ssh profiles the server uses.		Available from version 9 onwards.
firewall_profile_id	String	Identifier of the firewall profile applied on the server.
server_array_id	String	Identifier of the server array to which the server belongs if any or null.
brownfield_state	String	A string describing the level of integration with the platform achieved. It must be one of "M1", "M1-M2", "M2", "M2-M3", "Overriden", "Certified" or "Pure".
subnet_id	String	Identifier of the subnet on which the server is deployed if any or null.
vpc_id	String	Identifier of the VPC on which the server is deployed if any or null.
privateness	Boolean	Flag indicating whether the server will get only a private IP
variable_value_ids	Object	An object defining variable values for the configuration in the template. It has a key for each variable defined and arrays of two elements as values:The first element of the array is the id of the variable value.The second element of the array is the resource_type of the variable value.
label_ids	String	List of ids corresponding to the labels the server has assigned.
supports_volume_attachment	Boolean	True if the server supports volume attachments, false otherwise.
desired_remote_id	String	Identifier that the user wants to have as Identifier of the resource on the cloud.		Available from version 10.3 onwards.
resource_type	String	An identifier for the type of resource, specifically "server".

Back to top

Shut down server

PUT /v3/cloud/servers/:id/shutdown

This action shuts the server with the given id down. The server must be in a bootstrapping, operational or stalled state.

Inputs

None

Returns

Field	Type	Description	Deprecation notices	Notes
id	String	Identifier of the server.
name	String	Logical name of the server.
fqdn	String	Fully qualified domain name (FQDN) of the server.
state	String	State of the server. It can be any of the following: commissioning, inactive, booting, bootstrapping, operational, stalled, shutting_down, decommissioning, commission_stalled.
public_ip	String	Public IP of the server or null if it does not have one yet.
private_ip	String	Private IP of the server or null if it does not have one yet.
workspace_id	String	Identifier of the workspace to which the server belongs.	No longer available from 7.3 onwards
template_id	String	Identifier of the template defining the software configuration the server uses.
server_plan_id	String	Identifier of the server plan with which the server is deployed.
cloud_account_id	String	Identifier of the cloud account in which the server is deployed.
ssh_profile_id	String	Identifier of the ssh profile the server uses. First of ssh_profile_ids.	Deprecated from version 9 onwards.
ssh_profile_ids	Array of string	Identifiers of the ssh profiles the server uses.		Available from version 9 onwards.
firewall_profile_id	String	Identifier of the firewall profile applied on the server.
server_array_id	String	Identifier of the server array to which the server belongs if any or null.
brownfield_state	String	A string describing the level of integration with the platform achieved. It must be one of "M1", "M1-M2", "M2", "M2-M3", "Overriden", "Certified" or "Pure".
subnet_id	String	Identifier of the subnet on which the server is deployed if any or null.
vpc_id	String	Identifier of the VPC on which the server is deployed if any or null.
privateness	Boolean	Flag indicating whether the server will get only a private IP
variable_value_ids	Object	An object defining variable values for the configuration in the template. It has a key for each variable defined and arrays of two elements as values:The first element of the array is the id of the variable value.The second element of the array is the resource_type of the variable value.
label_ids	String	List of ids corresponding to the labels the server has assigned.
supports_volume_attachment	Boolean	True if the server supports volume attachments, false otherwise.
desired_remote_id	String	Identifier that the user wants to have as Identifier of the resource on the cloud.		Available from version 10.3 onwards.
resource_type	String	An identifier for the type of resource, specifically "server".

Back to top

Override server

PUT /v3/cloud/servers/:id/override

This action takes the server with the given id from a stalled state to the operational state, at the user's own risk.

Inputs

None

Returns

Field	Type	Description	Deprecation notices	Notes
id	String	Identifier of the server.
name	String	Logical name of the server.
fqdn	String	Fully qualified domain name (FQDN) of the server.
state	String	State of the server. It can be any of the following: commissioning, inactive, booting, bootstrapping, operational, stalled, shutting_down, decommissioning, commission_stalled.
public_ip	String	Public IP of the server or null if it does not have one yet.
private_ip	String	Private IP of the server or null if it does not have one yet.
workspace_id	String	Identifier of the workspace to which the server belongs.	No longer available from 7.3 onwards
template_id	String	Identifier of the template defining the software configuration the server uses.
server_plan_id	String	Identifier of the server plan with which the server is deployed.
cloud_account_id	String	Identifier of the cloud account in which the server is deployed.
ssh_profile_id	String	Identifier of the ssh profile the server uses. First of ssh_profile_ids.	Deprecated from version 9 onwards.
ssh_profile_ids	Array of string	Identifiers of the ssh profiles the server uses.		Available from version 9 onwards.
firewall_profile_id	String	Identifier of the firewall profile applied on the server.
server_array_id	String	Identifier of the server array to which the server belongs if any or null.
brownfield_state	String	A string describing the level of integration with the platform achieved. It must be one of "M1", "M1-M2", "M2", "M2-M3", "Overriden", "Certified" or "Pure".
subnet_id	String	Identifier of the subnet on which the server is deployed if any or null.
vpc_id	String	Identifier of the VPC on which the server is deployed if any or null.
privateness	Boolean	Flag indicating whether the server will get only a private IP
variable_value_ids	Object	An object defining variable values for the configuration in the template. It has a key for each variable defined and arrays of two elements as values:The first element of the array is the id of the variable value.The second element of the array is the resource_type of the variable value.
label_ids	String	List of ids corresponding to the labels the server has assigned.
supports_volume_attachment	Boolean	True if the server supports volume attachments, false otherwise.
desired_remote_id	String	Identifier that the user wants to have as Identifier of the resource on the cloud.		Available from version 10.3 onwards.
resource_type	String	An identifier for the type of resource, specifically "server".

Back to top

Decommission server

DELETE /v3/cloud/servers/:id

This action decommissions the server with the given id. The server must be in an inactive, stalled or commission_stalled state.

Inputs

None

Returns

Field	Type	Description	Deprecation notices	Notes
id	String	Identifier of the server.
name	String	Logical name of the server.
fqdn	String	Fully qualified domain name (FQDN) of the server.
state	String	State of the server. It can be any of the following: commissioning, inactive, booting, bootstrapping, operational, stalled, shutting_down, decommissioning, commission_stalled.
public_ip	String	Public IP of the server or null if it does not have one yet.
private_ip	String	Private IP of the server or null if it does not have one yet.
workspace_id	String	Identifier of the workspace to which the server belongs.	No longer available from 7.3 onwards
template_id	String	Identifier of the template defining the software configuration the server uses.
server_plan_id	String	Identifier of the server plan with which the server is deployed.
cloud_account_id	String	Identifier of the cloud account in which the server is deployed.
ssh_profile_id	String	Identifier of the ssh profile the server uses. First of ssh_profile_ids.	Deprecated from version 9 onwards.
ssh_profile_ids	Array of string	Identifiers of the ssh profiles the server uses.		Available from version 9 onwards.
firewall_profile_id	String	Identifier of the firewall profile applied on the server.
server_array_id	String	Identifier of the server array to which the server belongs if any or null.
brownfield_state	String	A string describing the level of integration with the platform achieved. It must be one of "M1", "M1-M2", "M2", "M2-M3", "Overriden", "Certified" or "Pure".
subnet_id	String	Identifier of the subnet on which the server is deployed if any or null.
vpc_id	String	Identifier of the VPC on which the server is deployed if any or null.
privateness	Boolean	Flag indicating whether the server will get only a private IP
variable_value_ids	Object	An object defining variable values for the configuration in the template. It has a key for each variable defined and arrays of two elements as values:The first element of the array is the id of the variable value.The second element of the array is the resource_type of the variable value.
label_ids	String	List of ids corresponding to the labels the server has assigned.
supports_volume_attachment	Boolean	True if the server supports volume attachments, false otherwise.
desired_remote_id	String	Identifier that the user wants to have as Identifier of the resource on the cloud.		Available from version 10.3 onwards.
resource_type	String	An identifier for the type of resource, specifically "server".

Back to top

Get credentials of server

PUT /v3/cloud/servers/:id/credentials

This action returns the credentials of a server. If the server belongs to Azure cloud provider, it will return the credentials only once, for security reasons.

Inputs

None

Returns

Field	Type	Description	Deprecation notices
credentials	Array of string	An array with the username of the server in the first element and the password of the server in the last element.

Back to top

List events of a server

GET /v3/cloud/servers/:server_id/events

This action returns information about the events related to the server with the given id.

Inputs

None

Returns

An array of events, ordered from most to less recent, with the following fields:

Field	Type	Description
id	String	Identifier of the event.
timestamp	Time	Time of the event.
level	String	Level of the event, either info, warning or error.
header	String	Short description of the event.
description	String	A longer description of the event.
resource_type	String	An identifier for the type of resource, specifically "event".

Back to top

List operational scripts of a server

GET /v3/cloud/servers/:server_id/operational_scripts

This action returns information about the operational scripts characterizations related to the server with the given id.

Inputs

None

Returns

An array of operational parametrized scripts with the following fields:

Field	Type	Description
id	String	Identifier of the operational parametrized script.
type	String	Type of parametrized script, it will be operational.
parameter_values	Object	The values associated with each parameter of the script.
template_id	String	Identifier of the template to which the parameterized scriptbelongs.
script_id	String	Identifier of the script which the parametrized script parametrizes.
resource_type	String	An identifier for the type of resource, specifically "template_script".

Back to top

Execute script on a server

PUT /v3/cloud/servers/:server_id/operational_scripts/:id/execute

This action initiates the execution of the parametrized script with the given id on the server with the given id.

Inputs

None

Returns

An event describing the initiation of the action with the following fields:

Field	Type	Description
id	String	Identifier of the event.
timestamp	Time	Time of the event.
level	String	Level of the event, either info, warning or error.
header	String	Short description of the event.
description	String	A longer description of the event.
resource_type	String	An identifier for the type of resource, specifically "event".

Back to top

List floating IPs of a server

GET /v3/cloud/servers/:server_id/floating_ips

This action returns information about the floating IPs attached to the server with the given id.

Inputs

None

Returns

An array of floating IPs with the following fields:

Field	Type	Description
id	String	Identifier of the operational parametrized script.
type	String	Type of parametrized script, it will be operational.
parameter_values	Object	The values associated with each parameter of the script.
template_id	String	Identifier of the template to which the parameterized scriptbelongs.
script_id	String	Identifier of the script which the parametrized script parametrizes.
resource_type	String	An identifier for the type of resource, specifically "template_script".

Back to top

List volumes of a server

GET /v3/cloud/servers/:server_id/volumes

This action returns information about the volumes attached to the server with the given id.

Inputs

None

Returns

An array of volumes with the following fields:

Field	Type	Description
id	String	Identifier of the volume.
name	String	Name of the volume.
size	Integer	Size of the volume, in GB
device	String	The logical device where the volume is mounted inside the server, when available.
state	String	State of the floating IP.
remote_id	String	Identifier of the volume resource on the cloud provider
storage_plan_id	String	Identifier of the storage plan of the cloud provider.
cloud_account_id	String	Identifier of the cloud account of the volume.
realm_id	String	Identifier of the realm in which the volume is.
attached_server_id	String	Identifier of the server which the volume is attached. Nil If the volume is not attached.
brownfield	Boolean	Flag indicating if the volume is brownfield (imported).
resource_type	String	An identifier for the type of resource, specifically "volume".
desired_remote_id	String	Identifier that the user wants to have as Identifier of the resource on the cloud. Available from version 10.3 onwards.
label_ids	Array of Strings	List of ids corresponding to the labels the volume has assigned.

Back to top

Generate brownfield token for a server

POST /v3/cloud/servers/:server_id/brownfield_token

This action generates a brownfield token to ensure the communication between the downloaded CIO executable inside the brownfield server and IMCO. Brownfield state of the server must be "M1".

Inputs

None

Returns

Field	Type	Description	Deprecation notices	Notes
id	String	Identifier of the server.
name	String	Logical name of the server.
fqdn	String	Fully qualified domain name (FQDN) of the server.
state	String	State of the server. It can be any of the following: commissioning, inactive, booting, bootstrapping, operational, stalled, shutting_down, decommissioning, commission_stalled.
public_ip	String	Public IP of the server or null if it does not have one yet.
private_ip	String	Private IP of the server or null if it does not have one yet.
workspace_id	String	Identifier of the workspace to which the server belongs.	No longer available from 7.3 onwards
template_id	String	Identifier of the template defining the software configuration the server uses.
server_plan_id	String	Identifier of the server plan with which the server is deployed.
cloud_account_id	String	Identifier of the cloud account in which the server is deployed.
ssh_profile_id	String	Identifier of the ssh profile the server uses. First of ssh_profile_ids.	Deprecated from version 9 onwards.
ssh_profile_ids	Array of string	Identifiers of the ssh profiles the server uses.		Available from version 9 onwards.
firewall_profile_id	String	Identifier of the firewall profile applied on the server.
server_array_id	String	Identifier of the server array to which the server belongs if any or null.
brownfield_state	String	A string describing the level of integration with the platform achieved. It must be one of "M1", "M1-M2", "M2", "M2-M3", "Overriden", "Certified" or "Pure".
brownfield_token	String	A string with the brownfield token generated for the brownfield server.
brownfield_token_expiry	Time	Timestamp indicating the time the brownfield token will expire.
subnet_id	String	Identifier of the subnet on which the server is deployed if any or null.
vpc_id	String	Identifier of the VPC on which the server is deployed if any or null.
privateness	Boolean	Flag indicating whether the server will get only a private IP
variable_value_ids	Object	An object defining variable values for the configuration in the template. It has a key for each variable defined and arrays of two elements as values:The first element of the array is the id of the variable value.The second element of the array is the resource_type of the variable value.
label_ids	String	List of ids corresponding to the labels the server has assigned.
supports_volume_attachment	Boolean	True if the server supports volume attachments, false otherwise.
desired_remote_id	String	Identifier that the user wants to have as Identifier of the resource on the cloud.		Available from version 10.3 onwards.
resource_type	String	An identifier for the type of resource, specifically "server".

Back to top

Converge brownfield server

POST /v3/cloud/servers/:server_id/brownfield_converge

This action indicates to IMCO that it should start the convergence of the brownfield server to the configuration indicated by the blueprint template. Server must be in "M2" state.

Inputs

None

Returns

Field	Type	Description	Deprecation notices	Notes
id	String	Identifier of the server.
name	String	Logical name of the server.
fqdn	String	Fully qualified domain name (FQDN) of the server.
state	String	State of the server. It can be any of the following: commissioning, inactive, booting, bootstrapping, operational, stalled, shutting_down, decommissioning, commission_stalled.
public_ip	String	Public IP of the server or null if it does not have one yet.
private_ip	String	Private IP of the server or null if it does not have one yet.
workspace_id	String	Identifier of the workspace to which the server belongs.	No longer available from 7.3 onwards
template_id	String	Identifier of the template defining the software configuration the server uses.
server_plan_id	String	Identifier of the server plan with which the server is deployed.
cloud_account_id	String	Identifier of the cloud account in which the server is deployed.
ssh_profile_id	String	Identifier of the ssh profile the server uses. First of ssh_profile_ids.	Deprecated from version 9 onwards.
ssh_profile_ids	Array of string	Identifiers of the ssh profiles the server uses.		Available from version 9 onwards.
firewall_profile_id	String	Identifier of the firewall profile applied on the server.
server_array_id	String	Identifier of the server array to which the server belongs if any or null.
brownfield_state	String	A string describing the level of integration with the platform achieved. It must be one of "M1", "M1-M2", "M2", "M2-M3", "Overriden", "Certified" or "Pure".
brownfield_token	String	A string with the brownfield token generated for the brownfield server.
brownfield_token_expiry	Time	Timestamp indicating the time the brownfield token will expire.
subnet_id	String	Identifier of the subnet on which the server is deployed if any or null.
vpc_id	String	Identifier of the VPC on which the server is deployed if any or null.
privateness	Boolean	Flag indicating whether the server will get only a private IP
variable_value_ids	Object	An object defining variable values for the configuration in the template. It has a key for each variable defined and arrays of two elements as values:The first element of the array is the id of the variable value.The second element of the array is the resource_type of the variable value.
label_ids	String	List of ids corresponding to the labels the server has assigned.
supports_volume_attachment	Boolean	True if the server supports volume attachments, false otherwise.
desired_remote_id	String	Identifier that the user wants to have as Identifier of the resource on the cloud.		Available from version 10.3 onwards.
resource_type	String	An identifier for the type of resource, specifically "server".

Back to top

Override brownfield server

POST /v3/cloud/servers/:server_id/brownfield_override

This action indicates to IMCO that the user overrides the server, that is to say, user explicitly indicates to IMCO that the server has finished its brownfield process and should become a greenfield server. Server must be in "M3" state.

Inputs

None

Returns

Field	Type	Description	Deprecation notices	Notes
id	String	Identifier of the server.
name	String	Logical name of the server.
fqdn	String	Fully qualified domain name (FQDN) of the server.
state	String	State of the server. It can be any of the following: commissioning, inactive, booting, bootstrapping, operational, stalled, shutting_down, decommissioning, commission_stalled.
public_ip	String	Public IP of the server or null if it does not have one yet.
private_ip	String	Private IP of the server or null if it does not have one yet.
workspace_id	String	Identifier of the workspace to which the server belongs.	No longer available from 7.3 onwards
template_id	String	Identifier of the template defining the software configuration the server uses.
server_plan_id	String	Identifier of the server plan with which the server is deployed.
cloud_account_id	String	Identifier of the cloud account in which the server is deployed.
ssh_profile_id	String	Identifier of the ssh profile the server uses. First of ssh_profile_ids.	Deprecated from version 9 onwards.
ssh_profile_ids	Array of string	Identifiers of the ssh profiles the server uses.		Available from version 9 onwards.
firewall_profile_id	String	Identifier of the firewall profile applied on the server.
server_array_id	String	Identifier of the server array to which the server belongs if any or null.
brownfield_state	String	A string describing the level of integration with the platform achieved. It must be one of "M1", "M1-M2", "M2", "M2-M3", "Overriden", "Certified" or "Pure".
brownfield_token	String	A string with the brownfield token generated for the brownfield server.
brownfield_token_expiry	Time	Timestamp indicating the time the brownfield token will expire.
subnet_id	String	Identifier of the subnet on which the server is deployed if any or null.
vpc_id	String	Identifier of the VPC on which the server is deployed if any or null.
privateness	Boolean	Flag indicating whether the server will get only a private IP
variable_value_ids	Object	An object defining variable values for the configuration in the template. It has a key for each variable defined and arrays of two elements as values:The first element of the array is the id of the variable value.The second element of the array is the resource_type of the variable value.
label_ids	String	List of ids corresponding to the labels the server has assigned.
supports_volume_attachment	Boolean	True if the server supports volume attachments, false otherwise.
desired_remote_id	String	Identifier that the user wants to have as Identifier of the resource on the cloud.		Available from version 10.3 onwards.
resource_type	String	An identifier for the type of resource, specifically "server".

Back to top

Discard brownfield server

POST /v3/cloud/servers/:server_id/brownfield_discard

This action indicates to IMCO that the user discards the brownfield server, that is to say, it deletes the server on IMCO but not in the cloud provider. Server must be in a brownfield state.

Inputs

None

Returns

None

Back to top