Cloud API NodeJS SDK

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersGet

datacentersGet(opts)

List your data centers

List the data centers for your account. Default limit is the first 100 items; use pagination query parameters for listing more items.

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.DataCentersApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List your data centers
api_instance
  .datacentersGet({
    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

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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 limit 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

Datacenters

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersPatch

datacentersPatch(datacenterId, datacenter, opts)

Partially modify a Data Center by ID

Updates the properties of the specified data center, rename it, or change the description.

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.DataCentersApi(config);
// Partially modify a Data Center by ID
api_instance
  .datacentersPatch({
    datacenterId: datacenterId_example,
    datacenter: datacenter_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]

datacenter

The properties of the data center to be updated.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersPost

datacentersPost(datacenter, opts)

Create a Data Center

Creates new data centers, and data centers that already contain elements, such as servers and storage volumes. Virtual data centers are the foundation of the platform; they act as logical containers for all other objects you create, such as servers and storage volumes. You can provision as many data centers as needed. Data centers have their own private networks and are logically segmented from each other to create isolation.

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.DataCentersApi(config);
// Create a Data Center
api_instance
  .datacentersPost({
    datacenter: datacenter_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

datacenter

The data center to create.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersPut

datacentersPut(datacenterId, datacenter, opts)

Modify a Data Center by ID

Modifies the properties of the specified data center, rename it, or change the description.

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.DataCentersApi(config);
// Modify a Data Center by ID
api_instance
  .datacentersPut({
    datacenterId: datacenterId_example,
    datacenter: datacenter_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]

datacenter

The modified data center.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

TargetGroupsApi

All URIs are relative to https://api.ionos.com/cloudapi/v6

Method

HTTP request

Description

DELETE /targetgroups/{targetGroupId}

Delete a Target Group by ID

GET /targetgroups/{targetGroupId}

Get a Target Group by ID

GET /targetgroups

Get Target Groups

PATCH /targetgroups/{targetGroupId}

Partially Modify a Target Group by ID

POST /targetgroups

Create a Target Group

PUT /targetgroups/{targetGroupId}

Modify a Target Group by ID

targetGroupsDelete

targetGroupsDelete(targetGroupId, opts)

Delete a Target Group by ID

Deletes the target group specified by its ID.

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.TargetGroupsApi(config);
// Delete a Target Group by ID
api_instance
  .targetGroupsDelete({
    targetGroupId: targetGroupId_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

targetGroupId

string

The unique ID of the target group.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

targetgroupsFindByTargetGroupId

targetgroupsFindByTargetGroupId(targetGroupId, opts)

Get a Target Group by ID

Retrieves the properties of the target group specified by its ID.

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.TargetGroupsApi(config);
// Get a Target Group by ID
api_instance
  .targetgroupsFindByTargetGroupId({
    targetGroupId: targetGroupId_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

targetGroupId

string

The unique ID of the target group.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

targetgroupsGet

targetgroupsGet(opts)

Get Target Groups

Lists target groups. A target group is a set of one or more registered targets. You must specify an IP address, a port number, and a weight for each target. Any object with an IP address in your VDC can be a target, for example, a VM, another load balancer, etc. You can register a target with multiple target groups.

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.TargetGroupsApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// Get Target Groups
api_instance
  .targetgroupsGet({
    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

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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 limit for pagination).

[optional][default to 0]

limit

number

The maximum number of elements to return (used together with offset for pagination). It must not exceed 200.

[optional][default to 100]

Return type

TargetGroups

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

targetgroupsPatch

targetgroupsPatch(targetGroupId, targetGroupProperties, opts)

Partially Modify a Target Group by ID

Updates the properties of the target group specified by its ID.

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.TargetGroupsApi(config);
// Partially Modify a Target Group by ID
api_instance
  .targetgroupsPatch({
    targetGroupId: targetGroupId_example,
    targetGroupProperties: targetGroupProperties_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

targetGroupId

string

The unique ID of the target group.

[default to undefined]

targetGroupProperties

The target group properties to be updated.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

targetgroupsPost

targetgroupsPost(targetGroup, opts)

Create a Target Group

Creates a target group.

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.TargetGroupsApi(config);
// Create a Target Group
api_instance
  .targetgroupsPost({
    targetGroup: targetGroup_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

targetGroup

The target group to create.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

targetgroupsPut

targetgroupsPut(targetGroupId, targetGroup, opts)

Modify a Target Group by ID

Modifies the properties of the target group specified by its ID.

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.TargetGroupsApi(config);
// Modify a Target Group by ID
api_instance
  .targetgroupsPut({
    targetGroupId: targetGroupId_example,
    targetGroup: targetGroup_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

targetGroupId

string

The unique ID of the target group.

[default to undefined]

targetGroup

The modified target group.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

IPBlocksApi

All URIs are relative to https://api.ionos.com/cloudapi/v6

Method

HTTP request

Description

DELETE /ipblocks/{ipblockId}

Delete IP blocks

GET /ipblocks/{ipblockId}

Retrieve IP blocks

GET /ipblocks

List IP blocks

PATCH /ipblocks/{ipblockId}

Partially modify IP blocks

POST /ipblocks

Reserve a IP Block

PUT /ipblocks/{ipblockId}

Modify a IP Block by ID

ipblocksDelete

ipblocksDelete(ipblockId, opts)

Delete IP blocks

Remove the specified IP block.

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.IPBlocksApi(config);
// Delete IP blocks
api_instance
  .ipblocksDelete({
    ipblockId: ipblockId_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

ipblockId

string

The unique ID of the IP block.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

ipblocksFindById

ipblocksFindById(ipblockId, opts)

Retrieve IP blocks

Retrieve the properties of the specified IP block.

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.IPBlocksApi(config);
// Retrieve IP blocks
api_instance
  .ipblocksFindById({
    ipblockId: ipblockId_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

ipblockId

string

The unique ID of the IP block.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

ipblocksGet

ipblocksGet(opts)

List IP blocks

List all reserved IP blocks.

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.IPBlocksApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List IP blocks 
api_instance
  .ipblocksGet({
    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

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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 limit for pagination).

[optional][default to 0]

limit

number

The maximum number of elements to return (use together with offset for pagination).

[optional][default to 100]

Return type

IpBlocks

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

ipblocksPatch

ipblocksPatch(ipblockId, ipblock, opts)

Partially modify IP blocks

Update the properties of the specified IP block.

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.IPBlocksApi(config);
// Partially modify IP blocks
api_instance
  .ipblocksPatch({
    ipblockId: ipblockId_example,
    ipblock: ipblock_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

ipblockId

string

The unique ID of the IP block.

[default to undefined]

ipblock

The properties of the IP block to be updated.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

ipblocksPost

ipblocksPost(ipblock, opts)

Reserve a IP Block

Reserves a new IP block.

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.IPBlocksApi(config);
// Reserve a IP Block
api_instance
  .ipblocksPost({
    ipblock: ipblock_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

ipblock

The IP block to be reserved.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

ipblocksPut

ipblocksPut(ipblockId, ipblock, opts)

Modify a IP Block by ID

Modifies the properties of the specified IP block.

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.IPBlocksApi(config);
// Modify a IP Block by ID
api_instance
  .ipblocksPut({
    ipblockId: ipblockId_example,
    ipblock: ipblock_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

ipblockId

string

The unique ID of the IP block.

[default to undefined]

ipblock

The modified IP block.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

BackupUnitsApi

All URIs are relative to https://api.ionos.com/cloudapi/v6

Method

HTTP request

Description

DELETE /backupunits/{backupunitId}

Delete backup units

GET /backupunits/{backupunitId}

Retrieve backup units

GET /backupunits

List backup units

PATCH /backupunits/{backupunitId}

Partially modify backup units

POST /backupunits

Create backup units

PUT /backupunits/{backupunitId}

Modify backup units

GET /backupunits/{backupunitId}/ssourl

Retrieve BU single sign-on URLs

backupunitsDelete

backupunitsDelete(backupunitId, opts)

Delete backup units

Remove the specified backup unit. This process will delete: 1) The backup plans inside the backup unit 2) All backups, associated with this backup unit 3) The backup user 4) The backup unit itself

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.BackupUnitsApi(config);
// Delete backup units
api_instance
  .backupunitsDelete({
    backupunitId: backupunitId_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

backupunitId

string

The unique ID of the backup unit.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

backupunitsFindById

backupunitsFindById(backupunitId, opts)

Retrieve backup units

Retrieve the properties of the specified backup unit.

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.BackupUnitsApi(config);
// Retrieve backup units
api_instance
  .backupunitsFindById({
    backupunitId: backupunitId_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

backupunitId

string

The unique ID of the backup unit.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

backupunitsGet

backupunitsGet(opts)

List backup units

List all available backup units.

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.BackupUnitsApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List backup units
api_instance
  .backupunitsGet({
    pretty: true,
    depth: 56,
    xContractNumber: 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

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

BackupUnits

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

backupunitsPatch

backupunitsPatch(backupunitId, backupUnit, opts)

Partially modify backup units

Update the properties of the specified backup unit.

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.BackupUnitsApi(config);
// Partially modify backup units
api_instance
  .backupunitsPatch({
    backupunitId: backupunitId_example,
    backupUnit: backupUnit_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

backupunitId

string

The unique ID of the backup unit.

[default to undefined]

backupUnit

The properties of the backup unit to be updated.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

backupunitsPost

backupunitsPost(backupUnit, opts)

Create backup units

Create a backup unit. Backup units are resources, same as storage volumes or snapshots; they can be shared through groups in User management.

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.BackupUnitsApi(config);
// Create backup units
api_instance
  .backupunitsPost({
    backupUnit: backupUnit_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

backupUnit

The backup unit to create.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

backupunitsPut

backupunitsPut(backupunitId, backupUnit, opts)

Modify backup units

Modify the properties of the specified backup unit.

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.BackupUnitsApi(config);
// Modify backup units
api_instance
  .backupunitsPut({
    backupunitId: backupunitId_example,
    backupUnit: backupUnit_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

backupunitId

string

The unique ID of the backup unit.

[default to undefined]

backupUnit

The modified backup unit.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

backupunitsSsourlGet

backupunitsSsourlGet(backupunitId, opts)

Retrieve BU single sign-on URLs

Retrieve a single sign-on URL for the specified backup unit.

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.BackupUnitsApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// Retrieve BU single sign-on URLs
api_instance
  .backupunitsSsourlGet({
    backupunitId: backupunitId_example,
    pretty: true,
    xContractNumber: 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

backupunitId

string

The unique ID of the backup unit.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

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

BackupUnitSSO

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

[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

[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

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

[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 limit 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

[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

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

The NIC to create.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

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

The modified NIC

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

FlowLogsApi

All URIs are relative to https://api.ionos.com/cloudapi/v6

Method

HTTP request

Description

DELETE /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogs/{flowlogId}

Delete Flow Logs

GET /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogs/{flowlogId}

Retrieve Flow Logs

GET /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogs

List Flow Logs

PATCH /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogs/{flowlogId}

Partially modify Flow Logs

POST /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogs

Create a Flow Log

PUT /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogs/{flowlogId}

Modify Flow Logs

datacentersServersNicsFlowlogsDelete

datacentersServersNicsFlowlogsDelete(datacenterId, serverId, nicId, flowlogId, opts)

Delete Flow Logs

Delete the specified Flow Log.

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.FlowLogsApi(config);
// Delete Flow Logs
api_instance
  .datacentersServersNicsFlowlogsDelete({
    datacenterId: datacenterId_example,
    serverId: serverId_example,
    nicId: nicId_example,
    flowlogId: flowlogId_example,
    pretty: true,
    depth: 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]

flowlogId

string

The unique ID of the Flow Log.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[optional][default to 0]

Return type

nil (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersServersNicsFlowlogsFindById

datacentersServersNicsFlowlogsFindById(datacenterId, serverId, nicId, flowlogId, opts)

Retrieve Flow Logs

Retrieve the properties of the specified Flow Log.

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.FlowLogsApi(config);
// Retrieve Flow Logs
api_instance
  .datacentersServersNicsFlowlogsFindById({
    datacenterId: datacenterId_example,
    serverId: serverId_example,
    nicId: nicId_example,
    flowlogId: flowlogId_example,
    pretty: true,
    depth: 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]

flowlogId

string

The unique ID of the Flow Log.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[optional][default to 0]

Return type

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersServersNicsFlowlogsGet

datacentersServersNicsFlowlogsGet(datacenterId, serverId, nicId, opts)

List Flow Logs

List all the Flow Logs for 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.FlowLogsApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List Flow Logs
api_instance
  .datacentersServersNicsFlowlogsGet({
    datacenterId: datacenterId_example,
    serverId: serverId_example,
    nicId: nicId_example,
    pretty: true,
    depth: 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]

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

[optional][default to 0]

offset

number

The first element (from the complete list of the elements) to include in the response (used together with limit 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

FlowLogs

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersServersNicsFlowlogsPatch

datacentersServersNicsFlowlogsPatch(datacenterId, serverId, nicId, flowlogId, flowlog, opts)

Partially modify Flow Logs

Update the specified Flow Log record.

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.FlowLogsApi(config);
// Partially modify Flow Logs
api_instance
  .datacentersServersNicsFlowlogsPatch({
    datacenterId: datacenterId_example,
    serverId: serverId_example,
    nicId: nicId_example,
    flowlogId: flowlogId_example,
    flowlog: flowlog_example,
    pretty: true,
    depth: 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]

flowlogId

string

The unique ID of the Flow Log.

[default to undefined]

flowlog

The Flow Log record to be updated.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[optional][default to 0]

Return type

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersServersNicsFlowlogsPost

datacentersServersNicsFlowlogsPost(datacenterId, serverId, nicId, flowlog, opts)

Create a Flow Log

Adds a new Flow Log for 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.FlowLogsApi(config);
// Create a Flow Log
api_instance
  .datacentersServersNicsFlowlogsPost({
    datacenterId: datacenterId_example,
    serverId: serverId_example,
    nicId: nicId_example,
    flowlog: flowlog_example,
    pretty: true,
    depth: 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]

flowlog

The Flow Log to create.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[optional][default to 0]

Return type

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersServersNicsFlowlogsPut

datacentersServersNicsFlowlogsPut(datacenterId, serverId, nicId, flowlogId, flowlog, opts)

Modify Flow Logs

Modify the specified Flow Log record.

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.FlowLogsApi(config);
// Modify Flow Logs
api_instance
  .datacentersServersNicsFlowlogsPut({
    datacenterId: datacenterId_example,
    serverId: serverId_example,
    nicId: nicId_example,
    flowlogId: flowlogId_example,
    flowlog: flowlog_example,
    pretty: true,
    depth: 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]

flowlogId

string

The unique ID of the Flow Log.

[default to undefined]

flowlog

The modified Flow Log.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[optional][default to 0]

Return type

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

FirewallRulesApi

All URIs are relative to https://api.ionos.com/cloudapi/v6

Method

HTTP request

Description

DELETE /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}

Delete firewall rules

GET /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}

Retrieve firewall rules

GET /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules

List firewall rules

PATCH /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}

Partially modify firewall rules

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

datacentersServersNicsFirewallrulesDelete

datacentersServersNicsFirewallrulesDelete(datacenterId, serverId, nicId, firewallruleId, opts)

Delete firewall rules

Delete the specified firewall rule.

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.FirewallRulesApi(config);
// Delete firewall rules
api_instance
  .datacentersServersNicsFirewallrulesDelete({
    datacenterId: datacenterId_example,
    serverId: serverId_example,
    nicId: nicId_example,
    firewallruleId: firewallruleId_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]

firewallruleId

string

The unique ID of the firewall rule.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

datacentersServersNicsFirewallrulesFindById

datacentersServersNicsFirewallrulesFindById(datacenterId, serverId, nicId, firewallruleId, opts)

Retrieve firewall rules

Retrieve the properties of the specified firewall rule.

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.FirewallRulesApi(config);
// Retrieve firewall rules
api_instance
  .datacentersServersNicsFirewallrulesFindById({
    datacenterId: datacenterId_example,
    serverId: serverId_example,
    nicId: nicId_example,
    firewallruleId: firewallruleId_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]

firewallruleId

string

The unique ID of the firewall rule.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersServersNicsFirewallrulesGet

datacentersServersNicsFirewallrulesGet(datacenterId, serverId, nicId, opts)

List firewall rules

List all firewall rules for 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.FirewallRulesApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List firewall rules
api_instance
  .datacentersServersNicsFirewallrulesGet({
    datacenterId: datacenterId_example,
    serverId: serverId_example,
    nicId: nicId_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]

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

[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 limit 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

FirewallRules

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 firewall rules

Update the properties of the specified firewall rule.

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.FirewallRulesApi(config);
// Partially modify firewall rules
api_instance
  .datacentersServersNicsFirewallrulesPatch({
    datacenterId: datacenterId_example,
    serverId: serverId_example,
    nicId: nicId_example,
    firewallruleId: firewallruleId_example,
    firewallrule: firewallrule_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]

firewallruleId

string

The unique ID of the firewall rule.

[default to undefined]

firewallrule

The properties of the firewall rule to be updated.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

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

Creates a firewall rule for 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.FirewallRulesApi(config);
// Create a Firewall Rule
api_instance
  .datacentersServersNicsFirewallrulesPost({
    datacenterId: datacenterId_example,
    serverId: serverId_example,
    nicId: nicId_example,
    firewallrule: firewallrule_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]

firewallrule

The firewall rule to create.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

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

Modifies the properties of the specified firewall rule.

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.FirewallRulesApi(config);
// Modify a Firewall Rule
api_instance
  .datacentersServersNicsFirewallrulesPut({
    datacenterId: datacenterId_example,
    serverId: serverId_example,
    nicId: nicId_example,
    firewallruleId: firewallruleId_example,
    firewallrule: firewallrule_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]

firewallruleId

string

The unique ID of the firewall rule.

[default to undefined]

firewallrule

The modified firewall rule.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

VolumesApi

All URIs are relative to https://api.ionos.com/cloudapi/v6

Method

HTTP request

Description

POST /datacenters/{datacenterId}/volumes/{volumeId}/create-snapshot

Create volume snapshots

DELETE /datacenters/{datacenterId}/volumes/{volumeId}

Delete volumes

GET /datacenters/{datacenterId}/volumes/{volumeId}

Retrieve volumes

GET /datacenters/{datacenterId}/volumes

List volumes

PATCH /datacenters/{datacenterId}/volumes/{volumeId}

Partially modify volumes

POST /datacenters/{datacenterId}/volumes

Create a Volume

PUT /datacenters/{datacenterId}/volumes/{volumeId}

Modify a Volume by ID

POST /datacenters/{datacenterId}/volumes/{volumeId}/restore-snapshot

Restore volume snapshots

datacentersVolumesCreateSnapshotPost

datacentersVolumesCreateSnapshotPost(datacenterId, volumeId, opts)

Create volume snapshots

Create a snapshot of the specified volume within the data center; this snapshot can later be used to restore this volume.

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.VolumesApi(config);
// Create volume snapshots
api_instance
  .datacentersVolumesCreateSnapshotPost({
    datacenterId: datacenterId_example,
    volumeId: volumeId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56,
    name: name_example,
    description: description_example,
    secAuthProtection: true,
    licenceType: licenceType_example, 
        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]

volumeId

string

The unique ID of the volume.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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]

name

string

Snapshot name

[optional][default to undefined]

description

string

Snapshot description

[optional][default to undefined]

secAuthProtection

boolean

Flag for enabling extra protection for this snapshot, such as two-step verification.

[optional][default to undefined]

licenceType

string

The OS type for this snapshot.

[optional][default to undefined]

Return type

Snapshot

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

datacentersVolumesDelete

datacentersVolumesDelete(datacenterId, volumeId, opts)

Delete volumes

Delete the specified volume within the data center. Use with caution, the volume will be permanently removed!

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.VolumesApi(config);
// Delete volumes
api_instance
  .datacentersVolumesDelete({
    datacenterId: datacenterId_example,
    volumeId: volumeId_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]

volumeId

string

The unique ID of the volume.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

datacentersVolumesFindById

datacentersVolumesFindById(datacenterId, volumeId, opts)

Retrieve volumes

Retrieve the properties of the specified volume 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.VolumesApi(config);
// Retrieve volumes
api_instance
  .datacentersVolumesFindById({
    datacenterId: datacenterId_example,
    volumeId: volumeId_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]

volumeId

string

The unique ID of the volume.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersVolumesGet

datacentersVolumesGet(datacenterId, opts)

List volumes

List all the volumes 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.VolumesApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List volumes
api_instance
  .datacentersVolumesGet({
    datacenterId: datacenterId_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]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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 limit 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

Volumes

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersVolumesPatch

datacentersVolumesPatch(datacenterId, volumeId, volume, opts)

Partially modify volumes

Update the properties of the specified storage volume 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.VolumesApi(config);
// Partially modify volumes
api_instance
  .datacentersVolumesPatch({
    datacenterId: datacenterId_example,
    volumeId: volumeId_example,
    volume: volume_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]

volumeId

string

The unique ID of the volume.

[default to undefined]

volume

The properties of the volume to be updated.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersVolumesPost

datacentersVolumesPost(datacenterId, volume, opts)

Create a Volume

Creates a storage volume within the specified data center. The volume will not be attached! Attaching volumes is described in the Servers section.

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.VolumesApi(config);
// Create a Volume
api_instance
  .datacentersVolumesPost({
    datacenterId: datacenterId_example,
    volume: volume_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]

volume

The volume to create.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersVolumesPut

datacentersVolumesPut(datacenterId, volumeId, volume, opts)

Modify a Volume by ID

Modifies the properties of the specified volume 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.VolumesApi(config);
// Modify a Volume by ID
api_instance
  .datacentersVolumesPut({
    datacenterId: datacenterId_example,
    volumeId: volumeId_example,
    volume: volume_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]

volumeId

string

The unique ID of the volume.

[default to undefined]

volume

The modified volume

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersVolumesRestoreSnapshotPost

datacentersVolumesRestoreSnapshotPost(datacenterId, volumeId, opts)

Restore volume snapshots

Restore a snapshot for the specified volume within the data center. A snapshot is an image of a volume, which can be used to restore this volume at a later time.

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.VolumesApi(config);
// Restore volume snapshots
api_instance
  .datacentersVolumesRestoreSnapshotPost({
    datacenterId: datacenterId_example,
    volumeId: volumeId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56,
    snapshotId: snapshotId_example, 
        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]

volumeId

string

The unique ID of the volume.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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]

snapshotId

string

The unique ID of the snapshot.

[optional][default to undefined]

Return type

nil (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

LANsApi

All URIs are relative to https://api.ionos.com/cloudapi/v6

Method

HTTP request

Description

DELETE /datacenters/{datacenterId}/lans/{lanId}

Delete LANs

GET /datacenters/{datacenterId}/lans/{lanId}

Retrieve LANs

GET /datacenters/{datacenterId}/lans

List LANs

GET /datacenters/{datacenterId}/lans/{lanId}/nics/{nicId}

Retrieve attached NICs

GET /datacenters/{datacenterId}/lans/{lanId}/nics

List LAN members

POST /datacenters/{datacenterId}/lans/{lanId}/nics

Attach NICs

PATCH /datacenters/{datacenterId}/lans/{lanId}

Partially modify LANs

POST /datacenters/{datacenterId}/lans

Create LANs

PUT /datacenters/{datacenterId}/lans/{lanId}

Modify LANs

datacentersLansDelete

datacentersLansDelete(datacenterId, lanId, opts)

Delete LANs

Delete the specified LAN 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.LANsApi(config);
// Delete LANs
api_instance
  .datacentersLansDelete({
    datacenterId: datacenterId_example,
    lanId: lanId_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]

lanId

string

The unique ID of the LAN.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

datacentersLansFindById

datacentersLansFindById(datacenterId, lanId, opts)

Retrieve LANs

Retrieve the properties of the specified LAN 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.LANsApi(config);
// Retrieve LANs
api_instance
  .datacentersLansFindById({
    datacenterId: datacenterId_example,
    lanId: lanId_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]

lanId

string

The unique ID of the LAN.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Lan

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersLansGet

datacentersLansGet(datacenterId, opts)

List LANs

List all LANs 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.LANsApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List LANs
api_instance
  .datacentersLansGet({
    datacenterId: datacenterId_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]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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 limit 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

Lans

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersLansNicsFindById

datacentersLansNicsFindById(datacenterId, lanId, nicId, opts)

Retrieve attached NICs

Retrieve the properties of the NIC, attached to the specified LAN.

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.LANsApi(config);
// Retrieve attached NICs
api_instance
  .datacentersLansNicsFindById({
    datacenterId: datacenterId_example,
    lanId: lanId_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]

lanId

string

The unique ID of the LAN.

[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

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersLansNicsGet

datacentersLansNicsGet(datacenterId, lanId, opts)

List LAN members

List all NICs, attached to the specified LAN.

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.LANsApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List LAN members
api_instance
  .datacentersLansNicsGet({
    datacenterId: datacenterId_example,
    lanId: lanId_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]

lanId

string

The unique ID of the LAN.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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 limit 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

LanNics

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersLansNicsPost

datacentersLansNicsPost(datacenterId, lanId, nic, opts)

Attach NICs

Attach an existing NIC to the specified LAN.

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.LANsApi(config);
// Attach NICs
api_instance
  .datacentersLansNicsPost({
    datacenterId: datacenterId_example,
    lanId: lanId_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]

lanId

string

The unique ID of the LAN.

[default to undefined]

nic

The NIC to be attached.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersLansPatch

datacentersLansPatch(datacenterId, lanId, lan, opts)

Partially modify LANs

Update the properties of the specified LAN 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.LANsApi(config);
// Partially modify LANs
api_instance
  .datacentersLansPatch({
    datacenterId: datacenterId_example,
    lanId: lanId_example,
    lan: lan_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]

lanId

string

The unique ID of the LAN.

[default to undefined]

lan

The properties of the LAN to be updated.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Lan

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersLansPost

datacentersLansPost(datacenterId, lan, opts)

Create LANs

Creates a LAN 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.LANsApi(config);
// Create LANs
api_instance
  .datacentersLansPost({
    datacenterId: datacenterId_example,
    lan: lan_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]

lan

The LAN to create.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

LanPost

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersLansPut

datacentersLansPut(datacenterId, lanId, lan, opts)

Modify LANs

Modify the properties of the specified LAN 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.LANsApi(config);
// Modify LANs
api_instance
  .datacentersLansPut({
    datacenterId: datacenterId_example,
    lanId: lanId_example,
    lan: lan_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]

lanId

string

The unique ID of the LAN.

[default to undefined]

lan

The modified LAN

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Lan

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

LoadBalancersApi

All URIs are relative to https://api.ionos.com/cloudapi/v6

Method

HTTP request

Description

DELETE /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics/{nicId}

Detach balanced NICs

GET /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics/{nicId}

Retrieve balanced NICs

GET /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics

List balanced NICs

POST /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics

Attach balanced NICs

DELETE /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}

Delete Load Balancers

GET /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}

Retrieve Load Balancers

GET /datacenters/{datacenterId}/loadbalancers

List Load Balancers

PATCH /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}

Partially modify Load Balancers

POST /datacenters/{datacenterId}/loadbalancers

Create a Load Balancer

PUT /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}

Modify a Load Balancer by ID

datacentersLoadbalancersBalancednicsDelete

datacentersLoadbalancersBalancednicsDelete(datacenterId, loadbalancerId, nicId, opts)

Detach balanced NICs

Detach the specified NIC from the Load Balancer.

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.LoadBalancersApi(config);
// Detach balanced NICs
api_instance
  .datacentersLoadbalancersBalancednicsDelete({
    datacenterId: datacenterId_example,
    loadbalancerId: loadbalancerId_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]

loadbalancerId

string

The unique ID of the Load Balancer.

[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

[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

datacentersLoadbalancersBalancednicsFindByNicId

datacentersLoadbalancersBalancednicsFindByNicId(datacenterId, loadbalancerId, nicId, opts)

Retrieve balanced NICs

Retrieve the properties of the specified NIC, attached to the Load Balancer.

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.LoadBalancersApi(config);
// Retrieve balanced NICs
api_instance
  .datacentersLoadbalancersBalancednicsFindByNicId({
    datacenterId: datacenterId_example,
    loadbalancerId: loadbalancerId_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]

loadbalancerId

string

The unique ID of the Load Balancer.

[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

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersLoadbalancersBalancednicsGet

datacentersLoadbalancersBalancednicsGet(datacenterId, loadbalancerId, opts)

List balanced NICs

List all NICs, attached to the specified Load Balancer.

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.LoadBalancersApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List balanced NICs
api_instance
  .datacentersLoadbalancersBalancednicsGet({
    datacenterId: datacenterId_example,
    loadbalancerId: loadbalancerId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 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]

loadbalancerId

string

The unique ID of the Load Balancer.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

BalancedNics

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersLoadbalancersBalancednicsPost

datacentersLoadbalancersBalancednicsPost(datacenterId, loadbalancerId, nic, opts)

Attach balanced NICs

Attachs an existing NIC to the specified Load Balancer.

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.LoadBalancersApi(config);
// Attach balanced NICs
api_instance
  .datacentersLoadbalancersBalancednicsPost({
    datacenterId: datacenterId_example,
    loadbalancerId: loadbalancerId_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]

loadbalancerId

string

The unique ID of the Load Balancer.

[default to undefined]

nic

The NIC to be attached.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersLoadbalancersDelete

datacentersLoadbalancersDelete(datacenterId, loadbalancerId, opts)

Delete Load Balancers

Remove the specified Load Balancer from 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.LoadBalancersApi(config);
// Delete Load Balancers
api_instance
  .datacentersLoadbalancersDelete({
    datacenterId: datacenterId_example,
    loadbalancerId: loadbalancerId_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]

loadbalancerId

string

The unique ID of the Load Balancer.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

datacentersLoadbalancersFindById

datacentersLoadbalancersFindById(datacenterId, loadbalancerId, opts)

Retrieve Load Balancers

Retrieve the properties of the specified Load Balancer 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.LoadBalancersApi(config);
// Retrieve Load Balancers
api_instance
  .datacentersLoadbalancersFindById({
    datacenterId: datacenterId_example,
    loadbalancerId: loadbalancerId_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]

loadbalancerId

string

The unique ID of the Load Balancer.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersLoadbalancersGet

datacentersLoadbalancersGet(datacenterId, opts)

List Load Balancers

List all the Load Balancers 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.LoadBalancersApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List Load Balancers
api_instance
  .datacentersLoadbalancersGet({
    datacenterId: datacenterId_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]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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 limit 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

Loadbalancers

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersLoadbalancersPatch

datacentersLoadbalancersPatch(datacenterId, loadbalancerId, loadbalancer, opts)

Partially modify Load Balancers

Update the properties of the specified Load Balancer 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.LoadBalancersApi(config);
// Partially modify Load Balancers
api_instance
  .datacentersLoadbalancersPatch({
    datacenterId: datacenterId_example,
    loadbalancerId: loadbalancerId_example,
    loadbalancer: loadbalancer_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]

loadbalancerId

string

The unique ID of the Load Balancer.

[default to undefined]

loadbalancer

The properties of the Load Balancer to be updated.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersLoadbalancersPost

datacentersLoadbalancersPost(datacenterId, loadbalancer, opts)

Create a Load Balancer

Creates a Load Balancer 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.LoadBalancersApi(config);
// Create a Load Balancer
api_instance
  .datacentersLoadbalancersPost({
    datacenterId: datacenterId_example,
    loadbalancer: loadbalancer_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]

loadbalancer

The Load Balancer to create.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersLoadbalancersPut

datacentersLoadbalancersPut(datacenterId, loadbalancerId, loadbalancer, opts)

Modify a Load Balancer by ID

Modifies the properties of the specified Load Balancer 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.LoadBalancersApi(config);
// Modify a Load Balancer by ID
api_instance
  .datacentersLoadbalancersPut({
    datacenterId: datacenterId_example,
    loadbalancerId: loadbalancerId_example,
    loadbalancer: loadbalancer_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]

loadbalancerId

string

The unique ID of the Load Balancer.

[default to undefined]

loadbalancer

The modified Load Balancer.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

KubernetesApi

All URIs are relative to https://api.ionos.com/cloudapi/v6

Method

HTTP request

Description

DELETE /k8s/{k8sClusterId}

Delete a Kubernetes Cluster by ID

GET /k8s/{k8sClusterId}

Get a Kubernetes Cluster by ID

GET /k8s

Get Kubernetes Clusters

GET /k8s/{k8sClusterId}/kubeconfig

Get Kubernetes Configuration File

DELETE /k8s/{k8sClusterId}/nodepools/{nodepoolId}

Delete a Kubernetes Node Pool by ID

GET /k8s/{k8sClusterId}/nodepools/{nodepoolId}

Get a Kubernetes Node Pool by ID

GET /k8s/{k8sClusterId}/nodepools

Get Kubernetes Node Pools

DELETE /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}

Delete a Kubernetes Node by ID

GET /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}

Get Kubernetes Node by ID

GET /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes

Get Kubernetes Nodes

POST /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}/replace

Recreate a Kubernetes Node by ID

POST /k8s/{k8sClusterId}/nodepools

Create a Kubernetes Node Pool

PUT /k8s/{k8sClusterId}/nodepools/{nodepoolId}

Modify a Kubernetes Node Pool by ID

POST /k8s

Create a Kubernetes Cluster

PUT /k8s/{k8sClusterId}

Modify a Kubernetes Cluster by ID

GET /k8s/versions/default

Get Default Kubernetes Version

GET /k8s/versions

Get Kubernetes Versions

k8sDelete

k8sDelete(k8sClusterId, opts)

Delete a Kubernetes Cluster by ID

Deletes the K8s cluster specified by its ID.

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.KubernetesApi(config);
// Delete a Kubernetes Cluster by ID
api_instance
  .k8sDelete({
    k8sClusterId: k8sClusterId_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

k8sClusterId

string

The unique ID of the Kubernetes cluster.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

k8sFindByClusterId

k8sFindByClusterId(k8sClusterId, opts)

Get a Kubernetes Cluster by ID

Retrieves the K8s cluster specified by its ID.

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.KubernetesApi(config);
// Get a Kubernetes Cluster by ID
api_instance
  .k8sFindByClusterId({
    k8sClusterId: k8sClusterId_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

k8sClusterId

string

The unique ID of the K8s cluster to be retrieved.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

KubernetesCluster

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

k8sGet

k8sGet(opts)

Get Kubernetes Clusters

Retrieves a list of all K8s clusters provisioned under your account.

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.KubernetesApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// Get Kubernetes Clusters
api_instance
  .k8sGet({
    pretty: true,
    depth: 56,
    xContractNumber: 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

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

KubernetesClusters

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

k8sKubeconfigGet

string k8sKubeconfigGet(k8sClusterId, opts)

Get Kubernetes Configuration File

Retrieves the configuration file for the specified K8s cluster. You can define the format (YAML or JSON) of the returned file in the Accept header. By default, 'application/yaml' is specified.

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.KubernetesApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// Get Kubernetes Configuration File
api_instance
  .k8sKubeconfigGet({
    k8sClusterId: k8sClusterId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 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

k8sClusterId

string

The unique ID of the Kubernetes cluster.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

string

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/yaml, application/x-yaml, application/json

k8sNodepoolsDelete

k8sNodepoolsDelete(k8sClusterId, nodepoolId, opts)

Delete a Kubernetes Node Pool by ID

Deletes the K8s node pool specified by its ID.

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.KubernetesApi(config);
// Delete a Kubernetes Node Pool by ID
api_instance
  .k8sNodepoolsDelete({
    k8sClusterId: k8sClusterId_example,
    nodepoolId: nodepoolId_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

k8sClusterId

string

The unique ID of the Kubernetes cluster.

[default to undefined]

nodepoolId

string

The unique ID of the Kubernetes node pool.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

k8sNodepoolsFindById

k8sNodepoolsFindById(k8sClusterId, nodepoolId, opts)

Get a Kubernetes Node Pool by ID

Retrieves the K8s node pool specified by its ID.

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.KubernetesApi(config);
// Get a Kubernetes Node Pool by ID
api_instance
  .k8sNodepoolsFindById({
    k8sClusterId: k8sClusterId_example,
    nodepoolId: nodepoolId_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

k8sClusterId

string

The unique ID of the Kubernetes cluster.

[default to undefined]

nodepoolId

string

The unique ID of the Kubernetes node pool.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

KubernetesNodePool

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

k8sNodepoolsGet

k8sNodepoolsGet(k8sClusterId, opts)

Get Kubernetes Node Pools

Retrieves a list of K8s node pools of a cluster specified by its ID.

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.KubernetesApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// Get Kubernetes Node Pools
api_instance
  .k8sNodepoolsGet({
    k8sClusterId: k8sClusterId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 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

k8sClusterId

string

The unique ID of the Kubernetes cluster.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

KubernetesNodePools

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

k8sNodepoolsNodesDelete

k8sNodepoolsNodesDelete(k8sClusterId, nodepoolId, nodeId, opts)

Delete a Kubernetes Node by ID

Deletes the K8s node specified by its ID.

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.KubernetesApi(config);
// Delete a Kubernetes Node by ID
api_instance
  .k8sNodepoolsNodesDelete({
    k8sClusterId: k8sClusterId_example,
    nodepoolId: nodepoolId_example,
    nodeId: nodeId_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

k8sClusterId

string

The unique ID of the Kubernetes cluster.

[default to undefined]

nodepoolId

string

The unique ID of the Kubernetes node pool.

[default to undefined]

nodeId

string

The unique ID of the Kubernetes node.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

k8sNodepoolsNodesFindById

k8sNodepoolsNodesFindById(k8sClusterId, nodepoolId, nodeId, opts)

Get Kubernetes Node by ID

Retrieves the K8s node specified by its ID.

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.KubernetesApi(config);
// Get Kubernetes Node by ID
api_instance
  .k8sNodepoolsNodesFindById({
    k8sClusterId: k8sClusterId_example,
    nodepoolId: nodepoolId_example,
    nodeId: nodeId_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

k8sClusterId

string

The unique ID of the Kubernetes cluster.

[default to undefined]

nodepoolId

string

The unique ID of the Kubernetes node pool.

[default to undefined]

nodeId

string

The unique ID of the Kubernetes node.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

KubernetesNode

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

k8sNodepoolsNodesGet

k8sNodepoolsNodesGet(k8sClusterId, nodepoolId, opts)

Get Kubernetes Nodes

Retrieves the list of all K8s nodes of the specified node pool.

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.KubernetesApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// Get Kubernetes Nodes
api_instance
  .k8sNodepoolsNodesGet({
    k8sClusterId: k8sClusterId_example,
    nodepoolId: nodepoolId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 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

k8sClusterId

string

The unique ID of the Kubernetes cluster.

[default to undefined]

nodepoolId

string

The unique ID of the Kubernetes node pool.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

KubernetesNodes

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

k8sNodepoolsNodesReplacePost

k8sNodepoolsNodesReplacePost(k8sClusterId, nodepoolId, nodeId, opts)

Recreate a Kubernetes Node by ID

Recreates the K8s node specified by its ID. If a node becomes unusable, Managed Kubernetes allows you to recreate it with a configuration based on the node pool template. Once the status is 'Active,' all the pods from the failed node will be migrated to the new node. The node pool has an additional billable 'active' node during this process.

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.KubernetesApi(config);
// Recreate a Kubernetes Node by ID
api_instance
  .k8sNodepoolsNodesReplacePost({
    k8sClusterId: k8sClusterId_example,
    nodepoolId: nodepoolId_example,
    nodeId: nodeId_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

k8sClusterId

string

The unique ID of the Kubernetes cluster.

[default to undefined]

nodepoolId

string

The unique ID of the Kubernetes node pool.

[default to undefined]

nodeId

string

The unique ID of the Kubernetes node.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

k8sNodepoolsPost

k8sNodepoolsPost(k8sClusterId, kubernetesNodePool, opts)

Create a Kubernetes Node Pool

Creates a node pool inside the specified K8s cluster.

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.KubernetesApi(config);
// Create a Kubernetes Node Pool
api_instance
  .k8sNodepoolsPost({
    k8sClusterId: k8sClusterId_example,
    kubernetesNodePool: kubernetesNodePool_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

k8sClusterId

string

The unique ID of the Kubernetes cluster.

[default to undefined]

kubernetesNodePool

The Kubernetes node pool to create.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

KubernetesNodePool

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

k8sNodepoolsPut

k8sNodepoolsPut(k8sClusterId, nodepoolId, kubernetesNodePool, opts)

Modify a Kubernetes Node Pool by ID

Modifies the K8s node pool specified by its ID.

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.KubernetesApi(config);
// Modify a Kubernetes Node Pool by ID
api_instance
  .k8sNodepoolsPut({
    k8sClusterId: k8sClusterId_example,
    nodepoolId: nodepoolId_example,
    kubernetesNodePool: kubernetesNodePool_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

k8sClusterId

string

The unique ID of the Kubernetes cluster.

[default to undefined]

nodepoolId

string

The unique ID of the Kubernetes node pool.

[default to undefined]

kubernetesNodePool

Details of the Kubernetes Node Pool

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

KubernetesNodePool

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

k8sPost

k8sPost(kubernetesCluster, opts)

Create a Kubernetes Cluster

Creates a K8s cluster provisioned under your account.

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.KubernetesApi(config);
// Create a Kubernetes Cluster
api_instance
  .k8sPost({
    kubernetesCluster: kubernetesCluster_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

kubernetesCluster

The Kubernetes cluster to create.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

KubernetesCluster

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

k8sPut

k8sPut(k8sClusterId, kubernetesCluster, opts)

Modify a Kubernetes Cluster by ID

Modifies the K8s cluster specified by its ID.

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.KubernetesApi(config);
// Modify a Kubernetes Cluster by ID
api_instance
  .k8sPut({
    k8sClusterId: k8sClusterId_example,
    kubernetesCluster: kubernetesCluster_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

k8sClusterId

string

The unique ID of the Kubernetes cluster.

[default to undefined]

kubernetesCluster

The modified Kubernetes cluster.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

KubernetesCluster

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

k8sVersionsDefaultGet

string k8sVersionsDefaultGet

Get Default Kubernetes Version

Retrieves the current default K8s version to be used by the clusters and node pools.

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.KubernetesApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// Get Default Kubernetes Version
api_instance
  .k8sVersionsDefaultGet()
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

This endpoint does not need any parameter.

Return type

string

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

k8sVersionsGet

Array<string> k8sVersionsGet

Get Kubernetes Versions

Lists available K8s versions.

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.KubernetesApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// Get Kubernetes Versions
api_instance
  .k8sVersionsGet()
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));

Parameters

This endpoint does not need any parameter.

Return type

Array<string>

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

ApplicationLoadBalancersApi

All URIs are relative to https://api.ionos.com/cloudapi/v6

Method

HTTP request

Description

DELETE /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}

Delete an Application Load Balancer by ID

GET /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}

Get an Application Load Balancer by ID

DELETE /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}

Delete an ALB Flow Log by ID

GET /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}

Get an ALB Flow Log by ID

GET /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs

Get ALB Flow Logs

PATCH /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}

Partially Modify an ALB Flow Log by ID

POST /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs

Create an ALB Flow Log

PUT /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}

Modify an ALB Flow Log by ID

DELETE /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}

Delete an ALB Forwarding Rule by ID

GET /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}

Get an ALB Forwarding Rule by ID

GET /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules

Get ALB Forwarding Rules

PATCH /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}

Partially modify an ALB Forwarding Rule by ID

POST /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules

Create an ALB Forwarding Rule

PUT /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}

Modify an ALB Forwarding Rule by ID

GET /datacenters/{datacenterId}/applicationloadbalancers

Get Application Load Balancers

PATCH /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}

Partially Modify an Application Load Balancer by ID

POST /datacenters/{datacenterId}/applicationloadbalancers

Create an Application Load Balancer

PUT /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}

Modify an Application Load Balancer by ID

datacentersApplicationloadbalancersDelete

datacentersApplicationloadbalancersDelete(datacenterId, applicationLoadBalancerId, opts)

Delete an Application Load Balancer by ID

Removes the specified Application Load Balancer from 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.ApplicationLoadBalancersApi(config);
// Delete an Application Load Balancer by ID
api_instance
  .datacentersApplicationloadbalancersDelete({
    datacenterId: datacenterId_example,
    applicationLoadBalancerId: applicationLoadBalancerId_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]

applicationLoadBalancerId

string

The unique ID of the Application Load Balancer.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

datacentersApplicationloadbalancersFindByApplicationLoadBalancerId

datacentersApplicationloadbalancersFindByApplicationLoadBalancerId(datacenterId, applicationLoadBalancerId, opts)

Get an Application Load Balancer by ID

Retrieves the properties of the specified Application Load Balancer 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.ApplicationLoadBalancersApi(config);
// Get an Application Load Balancer by ID
api_instance
  .datacentersApplicationloadbalancersFindByApplicationLoadBalancerId({
    datacenterId: datacenterId_example,
    applicationLoadBalancerId: applicationLoadBalancerId_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]

applicationLoadBalancerId

string

The unique ID of the Application Load Balancer.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersApplicationloadbalancersFlowlogsDelete

datacentersApplicationloadbalancersFlowlogsDelete(datacenterId, applicationLoadBalancerId, flowLogId, opts)

Delete an ALB Flow Log by ID

Deletes the Application Load Balancer flow log specified by its ID.

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.ApplicationLoadBalancersApi(config);
// Delete an ALB Flow Log by ID
api_instance
  .datacentersApplicationloadbalancersFlowlogsDelete({
    datacenterId: datacenterId_example,
    applicationLoadBalancerId: applicationLoadBalancerId_example,
    flowLogId: flowLogId_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]

applicationLoadBalancerId

string

The unique ID of the Application Load Balancer.

[default to undefined]

flowLogId

string

The unique ID of the flow log.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

datacentersApplicationloadbalancersFlowlogsFindByFlowLogId

datacentersApplicationloadbalancersFlowlogsFindByFlowLogId(datacenterId, applicationLoadBalancerId, flowLogId, opts)

Get an ALB Flow Log by ID

Retrieves the Application Load Balancer flow log specified by its ID.

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.ApplicationLoadBalancersApi(config);
// Get an ALB Flow Log by ID
api_instance
  .datacentersApplicationloadbalancersFlowlogsFindByFlowLogId({
    datacenterId: datacenterId_example,
    applicationLoadBalancerId: applicationLoadBalancerId_example,
    flowLogId: flowLogId_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]

applicationLoadBalancerId

string

The unique ID of the Application Load Balancer.

[default to undefined]

flowLogId

string

The unique ID of the flow log.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersApplicationloadbalancersFlowlogsGet

datacentersApplicationloadbalancersFlowlogsGet(datacenterId, applicationLoadBalancerId, opts)

Get ALB Flow Logs

Retrieves the flow logs for the specified Application Load Balancer.

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.ApplicationLoadBalancersApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// Get ALB Flow Logs
api_instance
  .datacentersApplicationloadbalancersFlowlogsGet({
    datacenterId: datacenterId_example,
    applicationLoadBalancerId: applicationLoadBalancerId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 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]

applicationLoadBalancerId

string

The unique ID of the Application Load Balancer.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

FlowLogs

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersApplicationloadbalancersFlowlogsPatch

datacentersApplicationloadbalancersFlowlogsPatch(datacenterId, applicationLoadBalancerId, flowLogId, applicationLoadBalancerFlowLogProperties, opts)

Partially Modify an ALB Flow Log by ID

Updates the properties of the Application Load Balancer flow log specified by its ID.

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.ApplicationLoadBalancersApi(config);
// Partially Modify an ALB Flow Log by ID
api_instance
  .datacentersApplicationloadbalancersFlowlogsPatch({
    datacenterId: datacenterId_example,
    applicationLoadBalancerId: applicationLoadBalancerId_example,
    flowLogId: flowLogId_example,
    applicationLoadBalancerFlowLogProperties: applicationLoadBalancerFlowLogProperties_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]

applicationLoadBalancerId

string

The unique ID of the Application Load Balancer.

[default to undefined]

flowLogId

string

The unique ID of the flow log.

[default to undefined]

applicationLoadBalancerFlowLogProperties

The properties of the ALB flow log to be updated.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersApplicationloadbalancersFlowlogsPost

datacentersApplicationloadbalancersFlowlogsPost(datacenterId, applicationLoadBalancerId, applicationLoadBalancerFlowLog, opts)

Create an ALB Flow Log

Creates a flow log for the Application Load Balancer specified by ID.

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.ApplicationLoadBalancersApi(config);
// Create an ALB Flow Log
api_instance
  .datacentersApplicationloadbalancersFlowlogsPost({
    datacenterId: datacenterId_example,
    applicationLoadBalancerId: applicationLoadBalancerId_example,
    applicationLoadBalancerFlowLog: applicationLoadBalancerFlowLog_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]

applicationLoadBalancerId

string

The unique ID of the Application Load Balancer.

[default to undefined]

applicationLoadBalancerFlowLog

The flow log to create.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersApplicationloadbalancersFlowlogsPut

datacentersApplicationloadbalancersFlowlogsPut(datacenterId, applicationLoadBalancerId, flowLogId, applicationLoadBalancerFlowLog, opts)

Modify an ALB Flow Log by ID

Modifies the Application Load Balancer flow log specified by its ID.

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.ApplicationLoadBalancersApi(config);
// Modify an ALB Flow Log by ID
api_instance
  .datacentersApplicationloadbalancersFlowlogsPut({
    datacenterId: datacenterId_example,
    applicationLoadBalancerId: applicationLoadBalancerId_example,
    flowLogId: flowLogId_example,
    applicationLoadBalancerFlowLog: applicationLoadBalancerFlowLog_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]

applicationLoadBalancerId

string

The unique ID of the Application Load Balancer.

[default to undefined]

flowLogId

string

The unique ID of the flow log.

[default to undefined]

applicationLoadBalancerFlowLog

The modified ALB flow log.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersApplicationloadbalancersForwardingrulesDelete

datacentersApplicationloadbalancersForwardingrulesDelete(datacenterId, applicationLoadBalancerId, forwardingRuleId, opts)

Delete an ALB Forwarding Rule by ID

Deletes the Application Load Balancer forwarding rule specified by its ID.

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.ApplicationLoadBalancersApi(config);
// Delete an ALB Forwarding Rule by ID
api_instance
  .datacentersApplicationloadbalancersForwardingrulesDelete({
    datacenterId: datacenterId_example,
    applicationLoadBalancerId: applicationLoadBalancerId_example,
    forwardingRuleId: forwardingRuleId_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]

applicationLoadBalancerId

string

The unique ID of the Application Load Balancer.

[default to undefined]

forwardingRuleId

string

The unique ID of the forwarding rule.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

datacentersApplicationloadbalancersForwardingrulesFindByForwardingRuleId

datacentersApplicationloadbalancersForwardingrulesFindByForwardingRuleId(datacenterId, applicationLoadBalancerId, forwardingRuleId, opts)

Get an ALB Forwarding Rule by ID

Retrieves the Application Load Balancer forwarding rule specified by its ID.

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.ApplicationLoadBalancersApi(config);
// Get an ALB Forwarding Rule by ID
api_instance
  .datacentersApplicationloadbalancersForwardingrulesFindByForwardingRuleId({
    datacenterId: datacenterId_example,
    applicationLoadBalancerId: applicationLoadBalancerId_example,
    forwardingRuleId: forwardingRuleId_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]

applicationLoadBalancerId

string

The unique ID of the Application Load Balancer.

[default to undefined]

forwardingRuleId

string

The unique ID of the forwarding rule.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

ApplicationLoadBalancerForwardingRules

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersApplicationloadbalancersForwardingrulesGet

datacentersApplicationloadbalancersForwardingrulesGet(datacenterId, applicationLoadBalancerId, opts)

Get ALB Forwarding Rules

Lists the forwarding rules of the specified Application Load Balancer.

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.ApplicationLoadBalancersApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// Get ALB Forwarding Rules
api_instance
  .datacentersApplicationloadbalancersForwardingrulesGet({
    datacenterId: datacenterId_example,
    applicationLoadBalancerId: applicationLoadBalancerId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 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]

applicationLoadBalancerId

string

The unique ID of the Application Load Balancer.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersApplicationloadbalancersForwardingrulesPatch

datacentersApplicationloadbalancersForwardingrulesPatch(datacenterId, applicationLoadBalancerId, forwardingRuleId, applicationLoadBalancerForwardingRuleProperties, opts)

Partially modify an ALB Forwarding Rule by ID

Updates the properties of the Application Load Balancer forwarding rule specified by its ID.

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.ApplicationLoadBalancersApi(config);
// Partially modify an ALB Forwarding Rule by ID
api_instance
  .datacentersApplicationloadbalancersForwardingrulesPatch({
    datacenterId: datacenterId_example,
    applicationLoadBalancerId: applicationLoadBalancerId_example,
    forwardingRuleId: forwardingRuleId_example,
    applicationLoadBalancerForwardingRuleProperties: applicationLoadBalancerForwardingRuleProperties_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]

applicationLoadBalancerId

string

The unique ID of the Application Load Balancer.

[default to undefined]

forwardingRuleId

string

The unique ID of the forwarding rule.

[default to undefined]

applicationLoadBalancerForwardingRuleProperties

The properties of the forwarding rule to be updated.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersApplicationloadbalancersForwardingrulesPost

datacentersApplicationloadbalancersForwardingrulesPost(datacenterId, applicationLoadBalancerId, applicationLoadBalancerForwardingRule, opts)

Create an ALB Forwarding Rule

Creates a forwarding rule for the specified Application Load Balancer.

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.ApplicationLoadBalancersApi(config);
// Create an ALB Forwarding Rule
api_instance
  .datacentersApplicationloadbalancersForwardingrulesPost({
    datacenterId: datacenterId_example,
    applicationLoadBalancerId: applicationLoadBalancerId_example,
    applicationLoadBalancerForwardingRule: applicationLoadBalancerForwardingRule_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]

applicationLoadBalancerId

string

The unique ID of the Application Load Balancer.

[default to undefined]

applicationLoadBalancerForwardingRule

The forwarding rule to create.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersApplicationloadbalancersForwardingrulesPut

datacentersApplicationloadbalancersForwardingrulesPut(datacenterId, applicationLoadBalancerId, forwardingRuleId, applicationLoadBalancerForwardingRule, opts)

Modify an ALB Forwarding Rule by ID

Modifies the Application Load Balancer forwarding rule specified by its ID.

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.ApplicationLoadBalancersApi(config);
// Modify an ALB Forwarding Rule by ID
api_instance
  .datacentersApplicationloadbalancersForwardingrulesPut({
    datacenterId: datacenterId_example,
    applicationLoadBalancerId: applicationLoadBalancerId_example,
    forwardingRuleId: forwardingRuleId_example,
    applicationLoadBalancerForwardingRule: applicationLoadBalancerForwardingRule_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]

applicationLoadBalancerId

string

The unique ID of the Application Load Balancer.

[default to undefined]

forwardingRuleId

string

The unique ID of the forwarding rule.

[default to undefined]

applicationLoadBalancerForwardingRule

The modified ALB forwarding rule.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

ApplicationLoadBalancers

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersApplicationloadbalancersGet

datacentersApplicationloadbalancersGet(datacenterId, opts)

Get Application Load Balancers

Lists all Application Load Balancers within a 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.ApplicationLoadBalancersApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// Get Application Load Balancers
api_instance
  .datacentersApplicationloadbalancersGet({
    datacenterId: datacenterId_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]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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 limit 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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersApplicationloadbalancersPatch

datacentersApplicationloadbalancersPatch(datacenterId, applicationLoadBalancerId, applicationLoadBalancerProperties, opts)

Partially Modify an Application Load Balancer by ID

Updates the properties of the specified Application Load Balancer 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.ApplicationLoadBalancersApi(config);
// Partially Modify an Application Load Balancer by ID
api_instance
  .datacentersApplicationloadbalancersPatch({
    datacenterId: datacenterId_example,
    applicationLoadBalancerId: applicationLoadBalancerId_example,
    applicationLoadBalancerProperties: applicationLoadBalancerProperties_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]

applicationLoadBalancerId

string

The unique ID of the Application Load Balancer.

[default to undefined]

applicationLoadBalancerProperties

The Application Load Balancer properties to be updated.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersApplicationloadbalancersPost

datacentersApplicationloadbalancersPost(datacenterId, applicationLoadBalancer, opts)

Create an Application Load Balancer

Creates an Application Load Balancer 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.ApplicationLoadBalancersApi(config);
// Create an Application Load Balancer
api_instance
  .datacentersApplicationloadbalancersPost({
    datacenterId: datacenterId_example,
    applicationLoadBalancer: applicationLoadBalancer_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]

applicationLoadBalancer

The Application Load Balancer to create.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersApplicationloadbalancersPut

datacentersApplicationloadbalancersPut(datacenterId, applicationLoadBalancerId, applicationLoadBalancer, opts)

Modify an Application Load Balancer by ID

Modifies the properties of the specified Application Load Balancer 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.ApplicationLoadBalancersApi(config);
// Modify an Application Load Balancer by ID
api_instance
  .datacentersApplicationloadbalancersPut({
    datacenterId: datacenterId_example,
    applicationLoadBalancerId: applicationLoadBalancerId_example,
    applicationLoadBalancer: applicationLoadBalancer_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]

applicationLoadBalancerId

string

The unique ID of the Application Load Balancer.

[default to undefined]

applicationLoadBalancer

The modified Application Load Balancer.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

NATGatewaysApi

All URIs are relative to https://api.ionos.com/cloudapi/v6

Method

HTTP request

Description

DELETE /datacenters/{datacenterId}/natgateways/{natGatewayId}

Delete NAT Gateways

GET /datacenters/{datacenterId}/natgateways/{natGatewayId}

Retrieve NAT Gateways

DELETE /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}

Delete NAT Gateway Flow Logs

GET /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}

Retrieve NAT Gateway Flow Logs

GET /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs

List NAT Gateway Flow Logs

PATCH /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}

Partially modify NAT Gateway Flow Logs

POST /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs

Create a NAT Gateway Flow Log

PUT /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}

Modify NAT Gateway Flow Logs

GET /datacenters/{datacenterId}/natgateways

List NAT Gateways

PATCH /datacenters/{datacenterId}/natgateways/{natGatewayId}

Partially modify NAT Gateways

POST /datacenters/{datacenterId}/natgateways

Create a NAT Gateway

PUT /datacenters/{datacenterId}/natgateways/{natGatewayId}

Modify NAT Gateways

DELETE /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}

Delete NAT Gateway rules

GET /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}

Retrieve NAT Gateway rules

GET /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules

List NAT Gateway rules

PATCH /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}

Partially Modify a NAT Gateway Rule by ID

POST /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules

Create a NAT Gateway Rule

PUT /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}

Modify a NAT Gateway Rule by ID

datacentersNatgatewaysDelete

datacentersNatgatewaysDelete(datacenterId, natGatewayId, opts)

Delete NAT Gateways

Remove the specified NAT Gateway from 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.NATGatewaysApi(config);
// Delete NAT Gateways
api_instance
  .datacentersNatgatewaysDelete({
    datacenterId: datacenterId_example,
    natGatewayId: natGatewayId_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]

natGatewayId

string

The unique ID of the NAT Gateway.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

datacentersNatgatewaysFindByNatGatewayId

datacentersNatgatewaysFindByNatGatewayId(datacenterId, natGatewayId, opts)

Retrieve NAT Gateways

Retrieve the properties of the specified NAT Gateway 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.NATGatewaysApi(config);
// Retrieve NAT Gateways
api_instance
  .datacentersNatgatewaysFindByNatGatewayId({
    datacenterId: datacenterId_example,
    natGatewayId: natGatewayId_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]

natGatewayId

string

The unique ID of the NAT Gateway.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersNatgatewaysFlowlogsDelete

datacentersNatgatewaysFlowlogsDelete(datacenterId, natGatewayId, flowLogId, opts)

Delete NAT Gateway Flow Logs

Delete the specified NAT Gateway Flow Log.

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.NATGatewaysApi(config);
// Delete NAT Gateway Flow Logs
api_instance
  .datacentersNatgatewaysFlowlogsDelete({
    datacenterId: datacenterId_example,
    natGatewayId: natGatewayId_example,
    flowLogId: flowLogId_example,
    pretty: true,
    depth: 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]

natGatewayId

string

The unique ID of the NAT Gateway.

[default to undefined]

flowLogId

string

The unique ID of the Flow Log.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[optional][default to 0]

Return type

nil (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersNatgatewaysFlowlogsFindByFlowLogId

datacentersNatgatewaysFlowlogsFindByFlowLogId(datacenterId, natGatewayId, flowLogId, opts)

Retrieve NAT Gateway Flow Logs

Retrieve the specified NAT Gateway Flow Log.

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.NATGatewaysApi(config);
// Retrieve NAT Gateway Flow Logs
api_instance
  .datacentersNatgatewaysFlowlogsFindByFlowLogId({
    datacenterId: datacenterId_example,
    natGatewayId: natGatewayId_example,
    flowLogId: flowLogId_example,
    pretty: true,
    depth: 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]

natGatewayId

string

The unique ID of the NAT Gateway.

[default to undefined]

flowLogId

string

The unique ID of the Flow Log.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[optional][default to 0]

Return type

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersNatgatewaysFlowlogsGet

datacentersNatgatewaysFlowlogsGet(datacenterId, natGatewayId, opts)

List NAT Gateway Flow Logs

List all the Flow Logs for the specified NAT Gateway.

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.NATGatewaysApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List NAT Gateway Flow Logs
api_instance
  .datacentersNatgatewaysFlowlogsGet({
    datacenterId: datacenterId_example,
    natGatewayId: natGatewayId_example,
    pretty: true,
    depth: 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]

natGatewayId

string

The unique ID of the NAT Gateway.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[optional][default to 0]

offset

number

The first element (from the complete list of the elements) to include in the response (used together with limit 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

FlowLogs

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersNatgatewaysFlowlogsPatch

datacentersNatgatewaysFlowlogsPatch(datacenterId, natGatewayId, flowLogId, natGatewayFlowLogProperties, opts)

Partially modify NAT Gateway Flow Logs

Update the properties of the specified NAT Gateway Flow Log.

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.NATGatewaysApi(config);
// Partially modify NAT Gateway Flow Logs
api_instance
  .datacentersNatgatewaysFlowlogsPatch({
    datacenterId: datacenterId_example,
    natGatewayId: natGatewayId_example,
    flowLogId: flowLogId_example,
    natGatewayFlowLogProperties: natGatewayFlowLogProperties_example,
    pretty: true,
    depth: 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]

natGatewayId

string

The unique ID of the NAT Gateway.

[default to undefined]

flowLogId

string

The unique ID of the Flow Log.

[default to undefined]

natGatewayFlowLogProperties

The properties of the Flow Log to be updated.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[optional][default to 0]

Return type

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersNatgatewaysFlowlogsPost

datacentersNatgatewaysFlowlogsPost(datacenterId, natGatewayId, natGatewayFlowLog, opts)

Create a NAT Gateway Flow Log

Adds a new Flow Log to the specified NAT Gateway.

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.NATGatewaysApi(config);
// Create a NAT Gateway Flow Log
api_instance
  .datacentersNatgatewaysFlowlogsPost({
    datacenterId: datacenterId_example,
    natGatewayId: natGatewayId_example,
    natGatewayFlowLog: natGatewayFlowLog_example,
    pretty: true,
    depth: 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]

natGatewayId

string

The unique ID of the NAT Gateway.

[default to undefined]

natGatewayFlowLog

The Flow Log to create.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[optional][default to 0]

Return type

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersNatgatewaysFlowlogsPut

datacentersNatgatewaysFlowlogsPut(datacenterId, natGatewayId, flowLogId, natGatewayFlowLog, opts)

Modify NAT Gateway Flow Logs

Modify the specified NAT Gateway Flow Log.

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.NATGatewaysApi(config);
// Modify NAT Gateway Flow Logs
api_instance
  .datacentersNatgatewaysFlowlogsPut({
    datacenterId: datacenterId_example,
    natGatewayId: natGatewayId_example,
    flowLogId: flowLogId_example,
    natGatewayFlowLog: natGatewayFlowLog_example,
    pretty: true,
    depth: 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]

natGatewayId

string

The unique ID of the NAT Gateway.

[default to undefined]

flowLogId

string

The unique ID of the Flow Log.

[default to undefined]

natGatewayFlowLog

The modified NAT Gateway Flow Log.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[optional][default to 0]

Return type

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersNatgatewaysGet

datacentersNatgatewaysGet(datacenterId, opts)

List NAT Gateways

List all NAT Gateways 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.NATGatewaysApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List NAT Gateways
api_instance
  .datacentersNatgatewaysGet({
    datacenterId: datacenterId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 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

[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

NatGateways

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersNatgatewaysPatch

datacentersNatgatewaysPatch(datacenterId, natGatewayId, natGatewayProperties, opts)

Partially modify NAT Gateways

Update the properties of the specified NAT Gateway 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.NATGatewaysApi(config);
// Partially modify NAT Gateways
api_instance
  .datacentersNatgatewaysPatch({
    datacenterId: datacenterId_example,
    natGatewayId: natGatewayId_example,
    natGatewayProperties: natGatewayProperties_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]

natGatewayId

string

The unique ID of the NAT Gateway.

[default to undefined]

natGatewayProperties

The properties of the NAT Gateway to be updated.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersNatgatewaysPost

datacentersNatgatewaysPost(datacenterId, natGateway, opts)

Create a NAT Gateway

Creates a NAT Gateway within the data center. This operation is restricted to contract owner, admin, and users with 'createInternetAccess' privileges.

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.NATGatewaysApi(config);
// Create a NAT Gateway
api_instance
  .datacentersNatgatewaysPost({
    datacenterId: datacenterId_example,
    natGateway: natGateway_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]

natGateway

The NAT Gateway to create.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersNatgatewaysPut

datacentersNatgatewaysPut(datacenterId, natGatewayId, natGateway, opts)

Modify NAT Gateways

Modify the properties of the specified NAT Gateway 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.NATGatewaysApi(config);
// Modify NAT Gateways
api_instance
  .datacentersNatgatewaysPut({
    datacenterId: datacenterId_example,
    natGatewayId: natGatewayId_example,
    natGateway: natGateway_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]

natGatewayId

string

The unique ID of the NAT Gateway.

[default to undefined]

natGateway

The modified NAT Gateway.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersNatgatewaysRulesDelete

datacentersNatgatewaysRulesDelete(datacenterId, natGatewayId, natGatewayRuleId, opts)

Delete NAT Gateway rules

Delete the specified NAT Gateway rule.

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.NATGatewaysApi(config);
// Delete NAT Gateway rules
api_instance
  .datacentersNatgatewaysRulesDelete({
    datacenterId: datacenterId_example,
    natGatewayId: natGatewayId_example,
    natGatewayRuleId: natGatewayRuleId_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]

natGatewayId

string

The unique ID of the NAT Gateway.

[default to undefined]

natGatewayRuleId

string

The unique ID of the NAT Gateway rule.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

datacentersNatgatewaysRulesFindByNatGatewayRuleId

datacentersNatgatewaysRulesFindByNatGatewayRuleId(datacenterId, natGatewayId, natGatewayRuleId, opts)

Retrieve NAT Gateway rules

Retrieve the properties of the specified NAT Gateway rule.

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.NATGatewaysApi(config);
// Retrieve NAT Gateway rules
api_instance
  .datacentersNatgatewaysRulesFindByNatGatewayRuleId({
    datacenterId: datacenterId_example,
    natGatewayId: natGatewayId_example,
    natGatewayRuleId: natGatewayRuleId_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]

natGatewayId

string

The unique ID of the NAT Gateway.

[default to undefined]

natGatewayRuleId

string

The unique ID of the NAT Gateway rule.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersNatgatewaysRulesGet

datacentersNatgatewaysRulesGet(datacenterId, natGatewayId, opts)

List NAT Gateway rules

List all rules for the specified NAT Gateway.

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.NATGatewaysApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List NAT Gateway rules
api_instance
  .datacentersNatgatewaysRulesGet({
    datacenterId: datacenterId_example,
    natGatewayId: natGatewayId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 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]

natGatewayId

string

The unique ID of the NAT Gateway.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

NatGatewayRules

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersNatgatewaysRulesPatch

datacentersNatgatewaysRulesPatch(datacenterId, natGatewayId, natGatewayRuleId, natGatewayRuleProperties, opts)

Partially Modify a NAT Gateway Rule by ID

Updates the properties of the specified NAT Gateway rule.

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.NATGatewaysApi(config);
// Partially Modify a NAT Gateway Rule by ID
api_instance
  .datacentersNatgatewaysRulesPatch({
    datacenterId: datacenterId_example,
    natGatewayId: natGatewayId_example,
    natGatewayRuleId: natGatewayRuleId_example,
    natGatewayRuleProperties: natGatewayRuleProperties_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]

natGatewayId

string

The unique ID of the NAT Gateway.

[default to undefined]

natGatewayRuleId

string

The unique ID of the NAT Gateway rule.

[default to undefined]

natGatewayRuleProperties

The properties of the NAT Gateway rule to be updated.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersNatgatewaysRulesPost

datacentersNatgatewaysRulesPost(datacenterId, natGatewayId, natGatewayRule, opts)

Create a NAT Gateway Rule

Creates a rule for the specified NAT Gateway.

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.NATGatewaysApi(config);
// Create a NAT Gateway Rule
api_instance
  .datacentersNatgatewaysRulesPost({
    datacenterId: datacenterId_example,
    natGatewayId: natGatewayId_example,
    natGatewayRule: natGatewayRule_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]

natGatewayId

string

The unique ID of the NAT Gateway.

[default to undefined]

natGatewayRule

The NAT Gateway rule to create.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersNatgatewaysRulesPut

datacentersNatgatewaysRulesPut(datacenterId, natGatewayId, natGatewayRuleId, natGatewayRule, opts)

Modify a NAT Gateway Rule by ID

Modify the specified NAT Gateway rule.

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.NATGatewaysApi(config);
// Modify a NAT Gateway Rule by ID
api_instance
  .datacentersNatgatewaysRulesPut({
    datacenterId: datacenterId_example,
    natGatewayId: natGatewayId_example,
    natGatewayRuleId: natGatewayRuleId_example,
    natGatewayRule: natGatewayRule_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]

natGatewayId

string

The unique ID of the NAT Gateway.

[default to undefined]

natGatewayRuleId

string

The unique ID of the NAT Gateway rule.

[default to undefined]

natGatewayRule

The modified NAT Gateway rule.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

UserManagementApi

All URIs are relative to https://api.ionos.com/cloudapi/v6

Method

HTTP request

Description

DELETE /um/groups/{groupId}

Delete groups

GET /um/groups/{groupId}

Retrieve groups

GET /um/groups

List all groups

POST /um/groups

Create groups

PUT /um/groups/{groupId}

Modify groups

GET /um/groups/{groupId}/resources

Retrieve group resources

DELETE /um/groups/{groupId}/shares/{resourceId}

Remove group shares

GET /um/groups/{groupId}/shares/{resourceId}

Retrieve group shares

GET /um/groups/{groupId}/shares

List group shares

POST /um/groups/{groupId}/shares/{resourceId}

Add group shares

PUT /um/groups/{groupId}/shares/{resourceId}

Modify group share privileges

DELETE /um/groups/{groupId}/users/{userId}

Remove users from groups

GET /um/groups/{groupId}/users

List group members

POST /um/groups/{groupId}/users

Add a Group Member

GET /um/resources/{resourceType}

List resources by type

GET /um/resources/{resourceType}/{resourceId}

Retrieve resources by type

GET /um/resources

List all resources

DELETE /um/users/{userId}

Delete users

GET /um/users/{userId}

Retrieve users

GET /um/users

List all users

GET /um/users/{userId}/groups

Retrieve group resources by user ID

GET /um/users/{userId}/owns

Retrieve user resources by user ID

POST /um/users

Create users

PUT /um/users/{userId}

Modify users

umGroupsDelete

umGroupsDelete(groupId, opts)

Delete groups

Remove the specified group.

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.UserManagementApi(config);
// Delete groups
api_instance
  .umGroupsDelete({
    groupId: groupId_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

groupId

string

The unique ID of the group.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

umGroupsFindById

umGroupsFindById(groupId, opts)

Retrieve groups

Retrieve a group by the group ID. This value is in the response body when the group is created, and in the list of the groups, returned by GET.

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.UserManagementApi(config);
// Retrieve groups
api_instance
  .umGroupsFindById({
    groupId: groupId_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

groupId

string

The unique ID of the group.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Group

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

umGroupsGet

umGroupsGet(opts)

List all groups

List all the available user groups.

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.UserManagementApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List all groups
api_instance
  .umGroupsGet({
    pretty: true,
    depth: 56,
    xContractNumber: 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

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Groups

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

umGroupsPost

umGroupsPost(group, opts)

Create groups

Create a group.

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.UserManagementApi(config);
// Create groups
api_instance
  .umGroupsPost({
    group: group_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

group

The group to create.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Group

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

umGroupsPut

umGroupsPut(groupId, group, opts)

Modify groups

Modify the properties of the specified group.

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.UserManagementApi(config);
// Modify groups
api_instance
  .umGroupsPut({
    groupId: groupId_example,
    group: group_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

groupId

string

The unique ID of the group.

[default to undefined]

group

The modified group.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Group

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

umGroupsResourcesGet

umGroupsResourcesGet(groupId, opts)

Retrieve group resources

List the resources assigned to the group, by group ID.

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.UserManagementApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// Retrieve group resources
api_instance
  .umGroupsResourcesGet({
    groupId: groupId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 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

groupId

string

The unique ID of the group.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

ResourceGroups

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

umGroupsSharesDelete

umGroupsSharesDelete(groupId, resourceId, opts)

Remove group shares

Remove the specified share from the group.

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.UserManagementApi(config);
// Remove group shares
api_instance
  .umGroupsSharesDelete({
    groupId: groupId_example,
    resourceId: resourceId_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

groupId

string

The unique ID of the group.

[default to undefined]

resourceId

string

The unique ID of the resource.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

umGroupsSharesFindByResourceId

umGroupsSharesFindByResourceId(groupId, resourceId, opts)

Retrieve group shares

Retrieve the properties of the specified group share.

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.UserManagementApi(config);
// Retrieve group shares
api_instance
  .umGroupsSharesFindByResourceId({
    groupId: groupId_example,
    resourceId: resourceId_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

groupId

string

The unique ID of the group.

[default to undefined]

resourceId

string

The unique ID of the resource.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

GroupShare

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

umGroupsSharesGet

umGroupsSharesGet(groupId, opts)

List group shares

List all shares and share privileges for the specified group.

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.UserManagementApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List group shares 
api_instance
  .umGroupsSharesGet({
    groupId: groupId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 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

groupId

string

The unique ID of the group.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

GroupShares

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

umGroupsSharesPost

umGroupsSharesPost(groupId, resourceId, resource, opts)

Add group shares

Add the specified share to the group.

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.UserManagementApi(config);
// Add group shares
api_instance
  .umGroupsSharesPost({
    groupId: groupId_example,
    resourceId: resourceId_example,
    resource: resource_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

groupId

string

The unique ID of the group.

[default to undefined]

resourceId

string

The unique ID of the resource.

[default to undefined]

resource

The resource to add.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

GroupShare

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

umGroupsSharesPut

umGroupsSharesPut(groupId, resourceId, resource, opts)

Modify group share privileges

Modify share permissions for the specified group. With an empty body, no updates are performed, and the current share permissions for the group are returned with response code 200.

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.UserManagementApi(config);
// Modify group share privileges
api_instance
  .umGroupsSharesPut({
    groupId: groupId_example,
    resourceId: resourceId_example,
    resource: resource_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

groupId

string

The unique ID of the group.

[default to undefined]

resourceId

string

The unique ID of the resource.

[default to undefined]

resource

The modified resource

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

GroupShare

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

umGroupsUsersDelete

umGroupsUsersDelete(groupId, userId, opts)

Remove users from groups

Remove the specified user from the group.

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.UserManagementApi(config);
// Remove users from groups
api_instance
  .umGroupsUsersDelete({
    groupId: groupId_example,
    userId: userId_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

groupId

string

The unique ID of the group.

[default to undefined]

userId

string

The unique ID of the user.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

umGroupsUsersGet

umGroupsUsersGet(groupId, opts)

List group members

List all members of the specified user group.

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.UserManagementApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List group members
api_instance
  .umGroupsUsersGet({
    groupId: groupId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 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

groupId

string

The unique ID of the group.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

GroupMembers

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

umGroupsUsersPost

umGroupsUsersPost(groupId, user, opts)

Add a Group Member

Adds an existing user to the specified group.

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.UserManagementApi(config);
// Add a Group Member
api_instance
  .umGroupsUsersPost({
    groupId: groupId_example,
    user: user_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

groupId

string

The unique ID of the group.

[default to undefined]

user

The user to add.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

umResourcesFindByType

umResourcesFindByType(resourceType, opts)

List resources by type

List all resources of the specified type. Resource types are: {datacenter, snapshot, image, ipblock, pcc, backupunit, k8s} Resource types are in the list of resources, returned by GET.

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.UserManagementApi(config);
// List resources by type
api_instance
  .umResourcesFindByType({
    resourceType: resourceType_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

resourceType

string

The resource type

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Resources

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

umResourcesFindByTypeAndId

umResourcesFindByTypeAndId(resourceType, resourceId, opts)

Retrieve resources by type

Retrieve a resource by the resource type and resource ID. Resource types are: {datacenter, snapshot, image, ipblock, pcc, backupunit, k8s} Resource types are in the list of resources, returned by GET.

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.UserManagementApi(config);
// Retrieve resources by type
api_instance
  .umResourcesFindByTypeAndId({
    resourceType: resourceType_example,
    resourceId: resourceId_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

resourceType

string

The resource type

[default to undefined]

resourceId

string

The resource ID

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Resource

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

umResourcesGet

umResourcesGet(opts)

List all resources

List all the available resources.

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.UserManagementApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List all resources
api_instance
  .umResourcesGet({
    pretty: true,
    depth: 56,
    xContractNumber: 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

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Resources

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

umUsersDelete

umUsersDelete(userId, opts)

Delete users

Delete the specified user.

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.UserManagementApi(config);
// Delete users
api_instance
  .umUsersDelete({
    userId: userId_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

userId

string

The unique ID of the user.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

umUsersFindById

umUsersFindById(userId, opts)

Retrieve users

Retrieve user properties by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.

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.UserManagementApi(config);
// Retrieve users
api_instance
  .umUsersFindById({
    userId: userId_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

userId

string

The unique ID of the user.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

umUsersGet

umUsersGet(opts)

List all users

List all the users in your account.

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.UserManagementApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List all users 
api_instance
  .umUsersGet({
    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

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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 limit 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 100]

Return type

Users

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

umUsersGroupsGet

umUsersGroupsGet(userId, opts)

Retrieve group resources by user ID

Retrieve group resources of the user by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.

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.UserManagementApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// Retrieve group resources by user ID
api_instance
  .umUsersGroupsGet({
    userId: userId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 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

userId

string

The unique ID of the user.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

ResourceGroups

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

umUsersOwnsGet

umUsersOwnsGet(userId, opts)

Retrieve user resources by user ID

Retrieve own resources of the user by user ID. The user ID is in the response body when the user is created, and in the list of the users, returned by GET.

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.UserManagementApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// Retrieve user resources by user ID
api_instance
  .umUsersOwnsGet({
    userId: userId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 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

userId

string

The unique ID of the user.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

ResourcesUsers

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

umUsersPost

umUsersPost(user, opts)

Create users

Create a user.

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.UserManagementApi(config);
// Create users
api_instance
  .umUsersPost({
    user: user_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

user

The user to create.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

umUsersPut

umUsersPut(userId, user, opts)

Modify users

Modify the properties of the specified user.

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.UserManagementApi(config);
// Modify users
api_instance
  .umUsersPut({
    userId: userId_example,
    user: user_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

userId

string

The unique ID of the user.

[default to undefined]

user

The modified user

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

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

[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

[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

[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 limit 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

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

[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

[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

[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

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

[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 limit 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

The unique ID of the server.

[default to undefined]

server

The properties of the server to be updated.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersServersPost

datacentersServersPost(datacenterId, server, opts)

Create a Server

Creates a server within the specified data center. You can also use this request to configure the boot volumes and connect to existing LANs at the same time.

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);
// Create a Server
api_instance
  .datacentersServersPost({
    datacenterId: datacenterId_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]

server

The server to create.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersServersPut

datacentersServersPut(datacenterId, serverId, server, opts)

Modify a Server by ID

Modifies the properties of the specified server within the data center. Starting with v5, the 'allowReboot' attribute is retired; while previously required for changing certain server properties, this behavior is now implicit, and the backend will perform this automatically. For example, in earlier versions, when the CPU family is changed, 'allowReboot' had to be set to 'true'; this is no longer required, the reboot will be performed automatically.

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);
// Modify a Server by ID
api_instance
  .datacentersServersPut({
    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

The unique ID of the server.

[default to undefined]

server

The modified server

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersServersRebootPost

datacentersServersRebootPost(datacenterId, serverId, opts)

Reboot servers

Force a hard reboot of the specified server within the data center. Don't use this method if you wish to reboot gracefully. This is an equivalent of powering down a computer and turning it back 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);
// Reboot servers
api_instance
  .datacentersServersRebootPost({
    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

[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

datacentersServersRemoteConsoleGet

datacentersServersRemoteConsoleGet(datacenterId, serverId, opts)

Get Remote Console link

Retrieve a link with a JSON Web Token for accessing the server's Remote Console.

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 Remote Console link
api_instance
  .datacentersServersRemoteConsoleGet({
    datacenterId: datacenterId_example,
    serverId: serverId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 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

[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

RemoteConsoleUrl

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersServersResumePost

datacentersServersResumePost(datacenterId, serverId, opts)

Resume a Cube Server by ID

Resumes a suspended Cube Server specified by its ID. Since the suspended instance was not deleted the allocated resources continue to be billed. You can perform this operation only for Cube Servers. To check the status of the request, you can use the 'Location' HTTP header in the response (see 'Requests' for more information).

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);
// Resume a Cube Server by ID
api_instance
  .datacentersServersResumePost({
    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

[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

datacentersServersStartPost

datacentersServersStartPost(datacenterId, serverId, opts)

Start an Enterprise Server by ID

Starts the Enterprise Server specified by its ID. >Note that you cannot use this method to start a Cube Server. By starting the Enterprise Server, cores and RAM are provisioned, and the billing continues. If the server's public IPv4 address has been deallocated, a new IPv4 address will be assigned. IPv6 blocks and addresses will remain unchanged when stopping and starting a server. To check the status of the request, you can use the 'Location' HTTP header in the response (see 'Requests' for more information).

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);
// Start an Enterprise Server by ID
api_instance
  .datacentersServersStartPost({
    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

[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

datacentersServersStopPost

datacentersServersStopPost(datacenterId, serverId, opts)

Stop an Enterprise Server by ID

Stops the Enterprise Server specified by its ID. >Note that you cannot use this method to stop a Cube Server. By stopping the Enterprise Server, cores and RAM are freed and no longer charged. Public IPv4 IPs that are not reserved are returned to the IPv4 pool. IPv6 blocks and addresses will remain unchanged when stopping and starting a server. To check the status of the request, you can use the 'Location' HTTP header in the response (see 'Requests' for more information).

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);
// Stop an Enterprise Server by ID
api_instance
  .datacentersServersStopPost({
    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

[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

datacentersServersSuspendPost

datacentersServersSuspendPost(datacenterId, serverId, opts)

Suspend a Cube Server by ID

Suspends the specified Cubes instance within the data center. The instance is not deleted and allocated resources continue to be billed. You can perform this operation only for Cube Servers. To check the status of the request, you can use the 'Location' HTTP header in the response (see 'Requests' for more information).

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);
// Suspend a Cube Server by ID
api_instance
  .datacentersServersSuspendPost({
    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

[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

datacentersServersTokenGet

datacentersServersTokenGet(datacenterId, serverId, opts)

Get JASON Web Token

Retrieve a JSON Web Token from the server for use in login operations (such as accessing the server's console).

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 JASON Web Token
api_instance
  .datacentersServersTokenGet({
    datacenterId: datacenterId_example,
    serverId: serverId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 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

[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

Token

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersServersUpgradePost

datacentersServersUpgradePost(datacenterId, serverId, opts)

Upgrade a Server by ID

Upgrades the server version.

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);
// Upgrade a Server by ID
api_instance
  .datacentersServersUpgradePost({
    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

[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

datacentersServersVolumesDelete

datacentersServersVolumesDelete(datacenterId, serverId, volumeId, opts)

Detach a Volume by ID

Detachs the specified volume from the server. Note that only the volume's connection to the specified server is disconnected. If you want to delete the volume, you must submit a separate request to perform the deletion.

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 Volume by ID
api_instance
  .datacentersServersVolumesDelete({
    datacenterId: datacenterId_example,
    serverId: serverId_example,
    volumeId: volumeId_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]

volumeId

string

The unique ID of the volume.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

datacentersServersVolumesFindById

datacentersServersVolumesFindById(datacenterId, serverId, volumeId, opts)

Get Attached Volume by ID

Retrieves the properties of the volume 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 Volume by ID
api_instance
  .datacentersServersVolumesFindById({
    datacenterId: datacenterId_example,
    serverId: serverId_example,
    volumeId: volumeId_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]

volumeId

string

The unique ID of the volume.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersServersVolumesGet

datacentersServersVolumesGet(datacenterId, serverId, opts)

Get Attached Volumes

Lists all volumes 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 Volumes
api_instance
  .datacentersServersVolumesGet({
    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

[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 limit 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

AttachedVolumes

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersServersVolumesPost

datacentersServersVolumesPost(datacenterId, serverId, volume, opts)

Attach a Volume to a Server

Attachs an existing storage volume to the specified server. You can attach an existing volume in the VDC to a server. To move a volume from one server to another, you must first detach the volume from the first server and attach it to the second server. It is also possible to create and attach a volume in one step by simply providing a new volume description as a payload. The only difference is the URL; see 'Creating a Volume' for details about volumes. Note that the combined total of attached volumes and NICs 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.ServersApi(config);
// Attach a Volume to a Server
api_instance
  .datacentersServersVolumesPost({
    datacenterId: datacenterId_example,
    serverId: serverId_example,
    volume: volume_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]

volume

The volume to be attached (or created and attached).

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

LabelsApi

All URIs are relative to https://api.ionos.com/cloudapi/v6

Method

HTTP request

Description

DELETE /datacenters/{datacenterId}/labels/{key}

Delete data center labels

GET /datacenters/{datacenterId}/labels/{key}

Retrieve data center labels

GET /datacenters/{datacenterId}/labels

List data center labels

POST /datacenters/{datacenterId}/labels

Create a Data Center Label

PUT /datacenters/{datacenterId}/labels/{key}

Modify a Data Center Label by Key

DELETE /datacenters/{datacenterId}/servers/{serverId}/labels/{key}

Delete server labels

GET /datacenters/{datacenterId}/servers/{serverId}/labels/{key}

Retrieve server labels

GET /datacenters/{datacenterId}/servers/{serverId}/labels

List server labels

POST /datacenters/{datacenterId}/servers/{serverId}/labels

Create a Server Label

PUT /datacenters/{datacenterId}/servers/{serverId}/labels/{key}

Modify a Server Label

DELETE /datacenters/{datacenterId}/volumes/{volumeId}/labels/{key}

Delete volume labels

GET /datacenters/{datacenterId}/volumes/{volumeId}/labels/{key}

Retrieve volume labels

GET /datacenters/{datacenterId}/volumes/{volumeId}/labels

List volume labels

POST /datacenters/{datacenterId}/volumes/{volumeId}/labels

Create a Volume Label

PUT /datacenters/{datacenterId}/volumes/{volumeId}/labels/{key}

Modify a Volume Label

DELETE /ipblocks/{ipblockId}/labels/{key}

Delete IP block labels

GET /ipblocks/{ipblockId}/labels/{key}

Retrieve IP block labels

GET /ipblocks/{ipblockId}/labels

List IP block labels

POST /ipblocks/{ipblockId}/labels

Create IP block labels

PUT /ipblocks/{ipblockId}/labels/{key}

Modify a IP Block Label by ID

GET /labels/{labelurn}

Retrieve labels by URN

GET /labels

List labels

DELETE /snapshots/{snapshotId}/labels/{key}

Delete snapshot labels

GET /snapshots/{snapshotId}/labels/{key}

Retrieve snapshot labels

GET /snapshots/{snapshotId}/labels

List snapshot labels

POST /snapshots/{snapshotId}/labels

Create a Snapshot Label

PUT /snapshots/{snapshotId}/labels/{key}

Modify a Snapshot Label by ID

datacentersLabelsDelete

datacentersLabelsDelete(datacenterId, key, opts)

Delete data center labels

Delete the specified data center label.

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.LabelsApi(config);
// Delete data center labels
api_instance
  .datacentersLabelsDelete({
    datacenterId: datacenterId_example,
    key: key_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]

key

string

The label key

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

datacentersLabelsFindByKey

datacentersLabelsFindByKey(datacenterId, key, opts)

Retrieve data center labels

Retrieve the properties of the specified data center label.

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.LabelsApi(config);
// Retrieve data center labels
api_instance
  .datacentersLabelsFindByKey({
    datacenterId: datacenterId_example,
    key: key_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]

key

string

The label key

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersLabelsGet

datacentersLabelsGet(datacenterId, opts)

List data center labels

List all the the labels for the specified 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.LabelsApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List data center labels
api_instance
  .datacentersLabelsGet({
    datacenterId: datacenterId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 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

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersLabelsPost

datacentersLabelsPost(datacenterId, label, opts)

Create a Data Center Label

Adds a new label to the specified 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.LabelsApi(config);
// Create a Data Center Label
api_instance
  .datacentersLabelsPost({
    datacenterId: datacenterId_example,
    label: label_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]

label

The label to create.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersLabelsPut

datacentersLabelsPut(datacenterId, key, label, opts)

Modify a Data Center Label by Key

Modifies the specified data center label.

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.LabelsApi(config);
// Modify a Data Center Label by Key
api_instance
  .datacentersLabelsPut({
    datacenterId: datacenterId_example,
    key: key_example,
    label: label_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]

key

string

The label key

[default to undefined]

label

The modified label

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersServersLabelsDelete

datacentersServersLabelsDelete(datacenterId, serverId, key, opts)

Delete server labels

Delete the specified server label.

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.LabelsApi(config);
// Delete server labels
api_instance
  .datacentersServersLabelsDelete({
    datacenterId: datacenterId_example,
    serverId: serverId_example,
    key: key_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]

key

string

The label key

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

datacentersServersLabelsFindByKey

datacentersServersLabelsFindByKey(datacenterId, serverId, key, opts)

Retrieve server labels

Retrieve the properties of the specified server label.

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.LabelsApi(config);
// Retrieve server labels
api_instance
  .datacentersServersLabelsFindByKey({
    datacenterId: datacenterId_example,
    serverId: serverId_example,
    key: key_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]

key

string

The label key

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersServersLabelsGet

datacentersServersLabelsGet(datacenterId, serverId, opts)

List server labels

List all the the labels for 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.LabelsApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List server labels
api_instance
  .datacentersServersLabelsGet({
    datacenterId: datacenterId_example,
    serverId: serverId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 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

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersServersLabelsPost

datacentersServersLabelsPost(datacenterId, serverId, label, opts)

Create a Server Label

Adds a new label 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.LabelsApi(config);
// Create a Server Label
api_instance
  .datacentersServersLabelsPost({
    datacenterId: datacenterId_example,
    serverId: serverId_example,
    label: label_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]

label

The label to create.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersServersLabelsPut

datacentersServersLabelsPut(datacenterId, serverId, key, label, opts)

Modify a Server Label

Modifies the specified server label.

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.LabelsApi(config);
// Modify a Server Label
api_instance
  .datacentersServersLabelsPut({
    datacenterId: datacenterId_example,
    serverId: serverId_example,
    key: key_example,
    label: label_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]

key

string

The label key

[default to undefined]

label

The modified label

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersVolumesLabelsDelete

datacentersVolumesLabelsDelete(datacenterId, volumeId, key, opts)

Delete volume labels

Delete the specified volume label.

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.LabelsApi(config);
// Delete volume labels
api_instance
  .datacentersVolumesLabelsDelete({
    datacenterId: datacenterId_example,
    volumeId: volumeId_example,
    key: key_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]

volumeId

string

The unique ID of the volume.

[default to undefined]

key

string

The label key

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

datacentersVolumesLabelsFindByKey

datacentersVolumesLabelsFindByKey(datacenterId, volumeId, key, opts)

Retrieve volume labels

Retrieve the properties of the specified volume label.

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.LabelsApi(config);
// Retrieve volume labels
api_instance
  .datacentersVolumesLabelsFindByKey({
    datacenterId: datacenterId_example,
    volumeId: volumeId_example,
    key: key_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]

volumeId

string

The unique ID of the volume.

[default to undefined]

key

string

The label key

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersVolumesLabelsGet

datacentersVolumesLabelsGet(datacenterId, volumeId, opts)

List volume labels

List all the the labels for the specified volume.

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.LabelsApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List volume labels
api_instance
  .datacentersVolumesLabelsGet({
    datacenterId: datacenterId_example,
    volumeId: volumeId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 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]

volumeId

string

The unique ID of the volume.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

datacentersVolumesLabelsPost

datacentersVolumesLabelsPost(datacenterId, volumeId, label, opts)

Create a Volume Label

Adds a new label to the specified volume.

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.LabelsApi(config);
// Create a Volume Label
api_instance
  .datacentersVolumesLabelsPost({
    datacenterId: datacenterId_example,
    volumeId: volumeId_example,
    label: label_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]

volumeId

string

The unique ID of the volume.

[default to undefined]

label

The label to create.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

datacentersVolumesLabelsPut

datacentersVolumesLabelsPut(datacenterId, volumeId, key, label, opts)

Modify a Volume Label

Modifies the specified volume label.

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.LabelsApi(config);
// Modify a Volume Label
api_instance
  .datacentersVolumesLabelsPut({
    datacenterId: datacenterId_example,
    volumeId: volumeId_example,
    key: key_example,
    label: label_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]

volumeId

string

The unique ID of the volume.

[default to undefined]

key

string

The label key

[default to undefined]

label

The modified label

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

ipblocksLabelsDelete

ipblocksLabelsDelete(ipblockId, key, opts)

Delete IP block labels

Delete the specified IP block label.

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.LabelsApi(config);
// Delete IP block labels
api_instance
  .ipblocksLabelsDelete({
    ipblockId: ipblockId_example,
    key: key_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

ipblockId

string

The unique ID of the IP block.

[default to undefined]

key

string

The label key

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

ipblocksLabelsFindByKey

ipblocksLabelsFindByKey(ipblockId, key, opts)

Retrieve IP block labels

Retrieve the properties of the specified IP block label.

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.LabelsApi(config);
// Retrieve IP block labels
api_instance
  .ipblocksLabelsFindByKey({
    ipblockId: ipblockId_example,
    key: key_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

ipblockId

string

The unique ID of the IP block.

[default to undefined]

key

string

The label key

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

ipblocksLabelsGet

ipblocksLabelsGet(ipblockId, opts)

List IP block labels

List all the the labels for the specified IP block.

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.LabelsApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List IP block labels
api_instance
  .ipblocksLabelsGet({
    ipblockId: ipblockId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 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

ipblockId

string

The unique ID of the IP block.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

ipblocksLabelsPost

ipblocksLabelsPost(ipblockId, label, opts)

Create IP block labels

Add a new label to the specified IP block.

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.LabelsApi(config);
// Create IP block labels
api_instance
  .ipblocksLabelsPost({
    ipblockId: ipblockId_example,
    label: label_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

ipblockId

string

The unique ID of the IP block.

[default to undefined]

label

The label to create.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

ipblocksLabelsPut

ipblocksLabelsPut(ipblockId, key, label, opts)

Modify a IP Block Label by ID

Modifies the specified IP block label.

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.LabelsApi(config);
// Modify a IP Block Label by ID
api_instance
  .ipblocksLabelsPut({
    ipblockId: ipblockId_example,
    key: key_example,
    label: label_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

ipblockId

string

The unique ID of the IP block.

[default to undefined]

key

string

The label key

[default to undefined]

label

The modified label

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

labelsFindByUrn

labelsFindByUrn(labelurn, opts)

Retrieve labels by URN

Retrieve a label by label URN. The URN is unique for each label, and consists of: urn🏷️<resource_type>:<resource_uuid>:

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.LabelsApi(config);
// Retrieve labels by URN
api_instance
  .labelsFindByUrn({
    labelurn: labelurn_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

labelurn

string

The label URN; URN is unique for each label, and consists of: urn🏷️<resource_type>:<resource_uuid>:<key><key>

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Label

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

labelsGet

labelsGet(opts)

List labels

List all available labels.

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.LabelsApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List labels 
api_instance
  .labelsGet({
    pretty: true,
    depth: 56,
    xContractNumber: 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

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Labels

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

snapshotsLabelsDelete

snapshotsLabelsDelete(snapshotId, key, opts)

Delete snapshot labels

Delete the specified snapshot label.

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.LabelsApi(config);
// Delete snapshot labels
api_instance
  .snapshotsLabelsDelete({
    snapshotId: snapshotId_example,
    key: key_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

snapshotId

string

The unique ID of the snapshot.

[default to undefined]

key

string

The label key

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

snapshotsLabelsFindByKey

snapshotsLabelsFindByKey(snapshotId, key, opts)

Retrieve snapshot labels

Retrieve the properties of the specified snapshot label.

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.LabelsApi(config);
// Retrieve snapshot labels
api_instance
  .snapshotsLabelsFindByKey({
    snapshotId: snapshotId_example,
    key: key_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

snapshotId

string

The unique ID of the snapshot.

[default to undefined]

key

string

The label key

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

snapshotsLabelsGet

snapshotsLabelsGet(snapshotId, opts)

List snapshot labels

List all the the labels for the specified snapshot.

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.LabelsApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List snapshot labels
api_instance
  .snapshotsLabelsGet({
    snapshotId: snapshotId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 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

snapshotId

string

The unique ID of the snapshot.

[default to undefined]

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

Content-Type: Not defined
Accept: application/json

snapshotsLabelsPost

snapshotsLabelsPost(snapshotId, label, opts)

Create a Snapshot Label

Adds a new label to the specified snapshot.

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.LabelsApi(config);
// Create a Snapshot Label
api_instance
  .snapshotsLabelsPost({
    snapshotId: snapshotId_example,
    label: label_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

snapshotId

string

The unique ID of the snapshot.

[default to undefined]

label

The label to create.

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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

Authorization

Basic Authentication, Token Authentication

HTTP request headers

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

snapshotsLabelsPut

snapshotsLabelsPut(snapshotId, key, label, opts)

Modify a Snapshot Label by ID

Modifies the specified snapshot label.

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.LabelsApi(config);
// Modify a Snapshot Label by ID
api_instance
  .snapshotsLabelsPut({
    snapshotId: snapshotId_example,
    key: key_example,
    label: label_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

snapshotId

string

The unique ID of the snapshot.

[default to undefined]

key

string

The label key

[default to undefined]

label

The modified label

pretty

boolean

Controls whether the response is pretty-printed (with indentations and new lines).

[optional][default to true]

depth

number

[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