Links
Comment on page

ServersApi

All URIs are relative to https://api.ionos.com/cloudapi/v6
Method
HTTP request
Description
DELETE /datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId}
Detach a CD-ROM by ID
GET /datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId}
Get Attached CD-ROM by ID
GET /datacenters/{datacenterId}/servers/{serverId}/cdroms
Get Attached CD-ROMs
POST /datacenters/{datacenterId}/servers/{serverId}/cdroms
Attach a CD-ROM
DELETE /datacenters/{datacenterId}/servers/{serverId}
Delete servers
GET /datacenters/{datacenterId}/servers/{serverId}
Retrieve servers by ID
GET /datacenters/{datacenterId}/servers
List servers
PATCH /datacenters/{datacenterId}/servers/{serverId}
Partially modify servers
POST /datacenters/{datacenterId}/servers
Create a Server
PUT /datacenters/{datacenterId}/servers/{serverId}
Modify a Server by ID
POST /datacenters/{datacenterId}/servers/{serverId}/reboot
Reboot servers
GET /datacenters/{datacenterId}/servers/{serverId}/remoteconsole
Get Remote Console link
POST /datacenters/{datacenterId}/servers/{serverId}/resume
Resume a Cube Server by ID
POST /datacenters/{datacenterId}/servers/{serverId}/start
Start an Enterprise Server by ID
POST /datacenters/{datacenterId}/servers/{serverId}/stop
Stop an Enterprise Server by ID
POST /datacenters/{datacenterId}/servers/{serverId}/suspend
Suspend a Cube Server by ID
GET /datacenters/{datacenterId}/servers/{serverId}/token
Get JASON Web Token
POST /datacenters/{datacenterId}/servers/{serverId}/upgrade
Upgrade a Server by ID
DELETE /datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId}
Detach a Volume by ID
GET /datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId}
Get Attached Volume by ID
GET /datacenters/{datacenterId}/servers/{serverId}/volumes
Get Attached Volumes
POST /datacenters/{datacenterId}/servers/{serverId}/volumes
Attach a Volume to a Server

datacentersServersCdromsDelete

datacentersServersCdromsDelete(datacenterId, serverId, cdromId, opts)
Detach a CD-ROM by ID
Detachs the specified CD-ROM from the server. Detaching a CD-ROM deletes the CD-ROM. The image will not be deleted. Note that detaching a CD-ROM leads to a reset of the server.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.ServersApi(config);
// Detach a CD-ROM by ID
api_instance
.datacentersServersCdromsDelete({
datacenterId: datacenterId_example,
serverId: serverId_example,
cdromId: cdromId_example,
pretty: true,
depth: 56,
xContractNumber: 56,
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));

Parameters

Name
Type
Description
Notes
datacenterId
string
The unique ID of the data center.
[default to undefined]
serverId
string
The unique ID of the server.
[default to undefined]
cdromId
string
The unique ID of the CD-ROM.
[default to undefined]
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]

Return type

nil (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

datacentersServersCdromsFindById

datacentersServersCdromsFindById(datacenterId, serverId, cdromId, opts)
Get Attached CD-ROM by ID
Retrieves the properties of the CD-ROM attached to the specified server.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.ServersApi(config);
// Get Attached CD-ROM by ID
api_instance
.datacentersServersCdromsFindById({
datacenterId: datacenterId_example,
serverId: serverId_example,
cdromId: cdromId_example,
pretty: true,
depth: 56,
xContractNumber: 56,
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));

Parameters

Name
Type
Description
Notes
datacenterId
string
The unique ID of the data center.
[default to undefined]
serverId
string
The unique ID of the server.
[default to undefined]
cdromId
string
The unique ID of the CD-ROM.
[default to undefined]
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]

Return type

Image

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

datacentersServersCdromsGet

datacentersServersCdromsGet(datacenterId, serverId, opts)
Get Attached CD-ROMs
Lists all CD-ROMs attached to the specified server.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.ServersApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// Get Attached CD-ROMs
api_instance
.datacentersServersCdromsGet({
datacenterId: datacenterId_example,
serverId: serverId_example,
pretty: true,
depth: 56,
xContractNumber: 56,
offset: 56,
limit: 56,
orderBy: "<property_name>"
maxResults: 2,
filters: filterMap
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));

Parameters

Name
Type
Description
Notes
datacenterId
string
The unique ID of the data center.
[default to undefined]
serverId
string
The unique ID of the server.
[default to undefined]
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children&#39;s children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]
offset
number
The first element (from the complete list of the elements) to include in the response (used together with <b><i>limit</i></b> for pagination).
[optional][default to 0]
limit
number
The maximum number of elements to return (use together with offset for pagination).
[optional][default to 1000]

Return type

Cdroms

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

datacentersServersCdromsPost

datacentersServersCdromsPost(datacenterId, serverId, cdrom, opts)
Attach a CD-ROM
Attachs a CD-ROM to an existing server specified by its ID. CD-ROMs cannot be created stand-alone like volumes. They are either attached to a server or do not exist. They always have an ISO-Image associated; empty CD-ROMs can not be provisioned. It is possible to attach up to two CD-ROMs to the same server. Note that attaching a CD-ROM leads to a reset of the server.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.ServersApi(config);
// Attach a CD-ROM
api_instance
.datacentersServersCdromsPost({
datacenterId: datacenterId_example,
serverId: serverId_example,
cdrom: cdrom_example,
pretty: true,
depth: 56,
xContractNumber: 56,
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));

Parameters

Name
Type
Description
Notes
datacenterId
string
The unique ID of the data center.
[default to undefined]
serverId
string
The unique ID of the server.
[default to undefined]
cdrom
Image
The CD-ROM to be attached.
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children&#39;s children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]

Return type

Image

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

datacentersServersDelete

datacentersServersDelete(datacenterId, serverId, opts)
Delete servers
Delete the specified server in your data center. The attached storage volumes will also be removed if the query parameter is set to true otherwise a separate API call must be made for these actions.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.ServersApi(config);
// Delete servers
api_instance
.datacentersServersDelete({
datacenterId: datacenterId_example,
serverId: serverId_example,
pretty: true,
depth: 56,
xContractNumber: 56,
deleteVolumes: true,
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));

Parameters

Name
Type
Description
Notes
datacenterId
string
The unique ID of the data center.
[default to undefined]
serverId
string
The unique ID of the server.
[default to undefined]
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children&#39;s children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]
deleteVolumes
boolean
If true, all attached storage volumes will also be deleted.
[optional][default to undefined]

Return type

nil (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

datacentersServersFindById

datacentersServersFindById(datacenterId, serverId, opts)
Retrieve servers by ID
Retrieve information about the specified server within the data center, such as its configuration, provisioning status, and so on.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.ServersApi(config);
// Retrieve servers by ID
api_instance
.datacentersServersFindById({
datacenterId: datacenterId_example,
serverId: serverId_example,
pretty: true,
depth: 56,
xContractNumber: 56,
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));

Parameters

Name
Type
Description
Notes
datacenterId
string
The unique ID of the data center.
[default to undefined]
serverId
string
The unique ID of the server.
[default to undefined]
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children&#39;s children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]

Return type

Server

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

datacentersServersGet

datacentersServersGet(datacenterId, opts)
List servers
List all servers within the data center.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.ServersApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List servers
api_instance
.datacentersServersGet({
datacenterId: datacenterId_example,
pretty: true,
depth: 56,
upgradeNeeded: true,
xContractNumber: 56,
offset: 56,
limit: 56,
orderBy: "<property_name>"
maxResults: 2,
filters: filterMap
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));

Parameters

Name
Type
Description
Notes
datacenterId
string
The unique ID of the data center.
[default to undefined]
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children&#39;s children are included. - depth=... and so on
[optional][default to 0]
upgradeNeeded
boolean
Filter servers that can or that cannot be upgraded.
[optional][default to undefined]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]
offset
number
The first element (from the complete list of the elements) to include in the response (used together with <b><i>limit</i></b> for pagination).
[optional][default to 0]
limit
number
The maximum number of elements to return (use together with offset for pagination).
[optional][default to 1000]

Return type

Servers

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

datacentersServersPatch

datacentersServersPatch(datacenterId, serverId, server, opts)
Partially modify servers
Update the properties of the specified server within the data center.

Examples

const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.ServersApi(config);
// Partially modify servers
api_instance
.datacentersServersPatch({
datacenterId: datacenterId_example,
serverId: serverId_example,
server: server_example,
pretty: true,
depth: 56,
xContractNumber: 56,
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));

Parameters

Name
Type
Description
Notes
datacenterId
string
The unique ID of the data center.
[default to undefined]
serverId
string