Links
Comment on page

NetworkInterfacesApi

All URIs are relative to https://api.ionos.com/cloudapi/v6
Method
HTTP request
Description
DELETE /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}
Delete NICs
GET /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}
Retrieve NICs
GET /datacenters/{datacenterId}/servers/{serverId}/nics
List NICs
PATCH /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}
Partially modify NICs
POST /datacenters/{datacenterId}/servers/{serverId}/nics
Create a NIC
PUT /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}
Modify NICs

datacentersServersNicsDelete

datacentersServersNicsDelete(datacenterId, serverId, nicId, opts)
Delete NICs
Remove the specified NIC.

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.NetworkInterfacesApi(config);
// Delete NICs
api_instance
.datacentersServersNicsDelete({
datacenterId: datacenterId_example,
serverId: serverId_example,
nicId: nicId_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]
nicId
string
The unique ID of the NIC.
[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

datacentersServersNicsFindById

datacentersServersNicsFindById(datacenterId, serverId, nicId, opts)
Retrieve NICs
Retrieve the properties of the specified NIC.

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.NetworkInterfacesApi(config);
// Retrieve NICs
api_instance
.datacentersServersNicsFindById({
datacenterId: datacenterId_example,
serverId: serverId_example,
nicId: nicId_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]
nicId
string
The unique ID of the NIC.
[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

Nic

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersServersNicsGet

datacentersServersNicsGet(datacenterId, serverId, opts)
List NICs
List all NICs, 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.NetworkInterfacesApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List NICs
api_instance
.datacentersServersNicsGet({
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

Nics

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersServersNicsPatch

datacentersServersNicsPatch(datacenterId, serverId, nicId, nic, opts)
Partially modify NICs
Update the properties of the specified NIC.

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.NetworkInterfacesApi(config);
// Partially modify NICs
api_instance
.datacentersServersNicsPatch({
datacenterId: datacenterId_example,
serverId: serverId_example,
nicId: nicId_example,
nic: nic_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]
nicId
string
The unique ID of the NIC.
[default to undefined]
nic
The properties of the NIC to be updated.
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

Nic

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersServersNicsPost

datacentersServersNicsPost(datacenterId, serverId, nic, opts)
Create a NIC
Adds a NIC to the specified server. The combined total of NICs and attached volumes cannot exceed 24 per 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.NetworkInterfacesApi(config);
// Create a NIC
api_instance
.datacentersServersNicsPost({
datacenterId: datacenterId_example,
serverId: serverId_example,
nic: nic_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]
nic
Nic
The NIC to create.
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

Nic

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersServersNicsPut

datacentersServersNicsPut(datacenterId, serverId, nicId, nic, opts)
Modify NICs
Modify the properties of the specified NIC.

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.NetworkInterfacesApi(config);
// Modify NICs
api_instance
.datacentersServersNicsPut({
datacenterId: datacenterId_example,
serverId: serverId_example,
nicId: nicId_example,
nic: nic_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]
nicId
string
The unique ID of the NIC.
[default to undefined]
nic
NicPut
The modified NIC
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

Nic

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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