Comment on page

ApplicationLoadBalancersApi

All URIs are relative to https://api.ionos.com/cloudapi/v6
Method
HTTP request
Description
​datacentersApplicationloadbalancersDelete​
DELETE /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}
Delete an Application Load Balancer by ID
​datacentersApplicationloadbalancersFindByApplicationLoadBalancerId​
GET /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}
Get an Application Load Balancer by ID
​datacentersApplicationloadbalancersFlowlogsDelete​
DELETE /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}
Delete an ALB Flow Log by ID
​datacentersApplicationloadbalancersFlowlogsFindByFlowLogId​
GET /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}
Get an ALB Flow Log by ID
​datacentersApplicationloadbalancersFlowlogsGet​
GET /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs
Get ALB Flow Logs
​datacentersApplicationloadbalancersFlowlogsPatch​
PATCH /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}
Partially Modify an ALB Flow Log by ID
​datacentersApplicationloadbalancersFlowlogsPost​
POST /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs
Create an ALB Flow Log
​datacentersApplicationloadbalancersFlowlogsPut​
PUT /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}
Modify an ALB Flow Log by ID
​datacentersApplicationloadbalancersForwardingrulesDelete​
DELETE /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}
Delete an ALB Forwarding Rule by ID
​datacentersApplicationloadbalancersForwardingrulesFindByForwardingRuleId​
GET /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}
Get an ALB Forwarding Rule by ID
​datacentersApplicationloadbalancersForwardingrulesGet​
GET /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules
Get ALB Forwarding Rules
​datacentersApplicationloadbalancersForwardingrulesPatch​
PATCH /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}
Partially modify an ALB Forwarding Rule by ID
​datacentersApplicationloadbalancersForwardingrulesPost​
POST /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules
Create an ALB Forwarding Rule
​datacentersApplicationloadbalancersForwardingrulesPut​
PUT /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}
Modify an ALB Forwarding Rule by ID
​datacentersApplicationloadbalancersGet​
GET /datacenters/{datacenterId}/applicationloadbalancers
Get Application Load Balancers
​datacentersApplicationloadbalancersPatch​
PATCH /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}
Partially Modify an Application Load Balancer by ID
​datacentersApplicationloadbalancersPost​
POST /datacenters/{datacenterId}/applicationloadbalancers
Create an Application Load Balancer
​datacentersApplicationloadbalancersPut​
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
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children&#39;s children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]
Return type
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
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children&#39;s children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]
Return type
​ApplicationLoadBalancer​
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
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children&#39;s children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]
Return type
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
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children&#39;s children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]
Return type
​FlowLog​
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
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children&#39;s children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]
Return type
​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
​FlowLogProperties​
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
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children&#39;s children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]
Return type
​FlowLog​
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
​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
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children&#39;s children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]
Return type
​FlowLog​
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
​FlowLogPut​
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
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children&#39;s children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]
Return type
​FlowLog​
Authorization
Basic Authentication, Token Authentication
HTTP request headers

Method	HTTP request	Description
datacentersApplicationloadbalancersDelete	DELETE /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}	Delete an Application Load Balancer by ID
datacentersApplicationloadbalancersFindByApplicationLoadBalancerId	GET /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}	Get an Application Load Balancer by ID
datacentersApplicationloadbalancersFlowlogsDelete	DELETE /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}	Delete an ALB Flow Log by ID
datacentersApplicationloadbalancersFlowlogsFindByFlowLogId	GET /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}	Get an ALB Flow Log by ID
datacentersApplicationloadbalancersFlowlogsGet	GET /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs	Get ALB Flow Logs
datacentersApplicationloadbalancersFlowlogsPatch	PATCH /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}	Partially Modify an ALB Flow Log by ID
datacentersApplicationloadbalancersFlowlogsPost	POST /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs	Create an ALB Flow Log
datacentersApplicationloadbalancersFlowlogsPut	PUT /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}	Modify an ALB Flow Log by ID
datacentersApplicationloadbalancersForwardingrulesDelete	DELETE /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}	Delete an ALB Forwarding Rule by ID
datacentersApplicationloadbalancersForwardingrulesFindByForwardingRuleId	GET /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}	Get an ALB Forwarding Rule by ID
datacentersApplicationloadbalancersForwardingrulesGet	GET /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules	Get ALB Forwarding Rules
datacentersApplicationloadbalancersForwardingrulesPatch	PATCH /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}	Partially modify an ALB Forwarding Rule by ID
datacentersApplicationloadbalancersForwardingrulesPost	POST /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules	Create an ALB Forwarding Rule
datacentersApplicationloadbalancersForwardingrulesPut	PUT /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}	Modify an ALB Forwarding Rule by ID
datacentersApplicationloadbalancersGet	GET /datacenters/{datacenterId}/applicationloadbalancers	Get Application Load Balancers
datacentersApplicationloadbalancersPatch	PATCH /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}	Partially Modify an Application Load Balancer by ID
datacentersApplicationloadbalancersPost	POST /datacenters/{datacenterId}/applicationloadbalancers	Create an Application Load Balancer
datacentersApplicationloadbalancersPut	PUT /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}	Modify an Application Load Balancer by ID

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	Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on	[optional][default to 0]
xContractNumber	number	Users with multiple contracts must provide the contract number, for which all API requests are to be executed.	[optional][default to undefined]