NicApi
All URIs are relative to https://api.ionos.com/cloudapi/v5
DELETE /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}
Delete a Nic
GET /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}
Retrieve a Nic
DELETE /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}
Delete a Firewall Rule
GET /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}
Retrieve a Firewall Rule
GET /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules
List Firewall Rules
PATCH /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}
Partially modify a Firewall Rule
POST /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules
Create a Firewall Rule
PUT /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}
Modify a Firewall Rule
GET /datacenters/{datacenterId}/servers/{serverId}/nics
List Nics
PATCH /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}
Partially modify a Nic
POST /datacenters/{datacenterId}/servers/{serverId}/nics
Create a Nic
PUT /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}
Modify a Nic
datacentersServersNicsDelete
object datacentersServersNicsDelete(datacenterId, serverId, nicId, opts)
Delete a Nic
Deletes the specified NIC.
Examples
Parameters
datacenterId
string
The unique ID of the datacenter
[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 response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
Return type
object
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacentersServersNicsFindById
datacentersServersNicsFindById(datacenterId, serverId, nicId, opts)
Retrieve a Nic
Retrieves the attributes of a given NIC
Examples
Parameters
datacenterId
string
The unique ID of the datacenter
[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 response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacentersServersNicsFirewallrulesDelete
object datacentersServersNicsFirewallrulesDelete(datacenterId, serverId, nicId, firewallruleId, opts)
Delete a Firewall Rule
Removes the specific Firewall Rule
Examples
Parameters
datacenterId
string
The unique ID of the datacenter
[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]
firewallruleId
string
The unique ID of the Firewall Rule
[default to undefined]
pretty
boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
Return type
object
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacentersServersNicsFirewallrulesFindById
datacentersServersNicsFirewallrulesFindById(datacenterId, serverId, nicId, firewallruleId, opts)
Retrieve a Firewall Rule
Retrieves the attributes of a given Firewall Rule.
Examples
Parameters
datacenterId
string
The unique ID of the datacenter
[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]
firewallruleId
string
The unique ID of the Firewall Rule
[default to undefined]
pretty
boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacentersServersNicsFirewallrulesGet
datacentersServersNicsFirewallrulesGet(datacenterId, serverId, nicId, opts)
List Firewall Rules
Retrieves a list of firewall rules associated with a particular NIC
Examples
Parameters
datacenterId
string
The unique ID of the datacenter
[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 response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
offset
number
the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)
[optional][default to 0]
limit
number
the maximum number of elements to return (use together with <code>offset</code> for pagination)
[optional][default to 1000]
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacentersServersNicsFirewallrulesPatch
datacentersServersNicsFirewallrulesPatch(datacenterId, serverId, nicId, firewallruleId, firewallrule, opts)
Partially modify a Firewall Rule
You can use update attributes of a resource
Examples
Parameters
datacenterId
string
The unique ID of the datacenter
[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]
firewallruleId
string
The unique ID of the Firewall Rule
[default to undefined]
firewallrule
Modified Firewall Rule
pretty
boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
datacentersServersNicsFirewallrulesPost
datacentersServersNicsFirewallrulesPost(datacenterId, serverId, nicId, firewallrule, opts)
Create a Firewall Rule
This will add a Firewall Rule to the NIC
Examples
Parameters
datacenterId
string
The unique ID of the datacenter
[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]
firewallrule
Firewall Rule to be created
pretty
boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
datacentersServersNicsFirewallrulesPut
datacentersServersNicsFirewallrulesPut(datacenterId, serverId, nicId, firewallruleId, firewallrule, opts)
Modify a Firewall Rule
You can use update attributes of a resource
Examples
Parameters
datacenterId
string
The unique ID of the datacenter
[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]
firewallruleId
string
The unique ID of the Firewall Rule
[default to undefined]
firewallrule
Modified Firewall Rule
pretty
boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
datacentersServersNicsGet
datacentersServersNicsGet(datacenterId, serverId, opts)
List Nics
Retrieves a list of NICs.
Examples
Parameters
datacenterId
string
The unique ID of the datacenter
[default to undefined]
serverId
string
The unique ID of the Server
[default to undefined]
pretty
boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
offset
number
the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)
[optional][default to 0]
limit
number
the maximum number of elements to return (use together with <code>offset</code> for pagination)
[optional][default to 1000]
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacentersServersNicsPatch
datacentersServersNicsPatch(datacenterId, serverId, nicId, nic, opts)
Partially modify a Nic
You can use update attributes of a Nic
Examples
Parameters
datacenterId
string
The unique ID of the datacenter
[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
Modified properties of Nic
pretty
boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
Return type
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 target server. Combine count of Nics and volumes attached to the server should not exceed size 24.
Examples
Parameters
datacenterId
string
The unique ID of the datacenter
[default to undefined]
serverId
string
The unique ID of the Server
[default to undefined]
nic
Nic to be created
pretty
boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
datacentersServersNicsPut
datacentersServersNicsPut(datacenterId, serverId, nicId, nic, opts)
Modify a Nic
You can use update attributes of a Nic
Examples
Parameters
datacenterId
string
The unique ID of the datacenter
[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
Modified Nic
pretty
boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
Last updated