ApplicationLoadBalancersApi
ApplicationLoadBalancersApi
All URIs are relative to https://api.ionos.com/cloudapi/v6
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, pretty, depth, xContractNumber)
Delete an Application Load Balancer by ID
Removes the specified Application Load Balancer from the data center.
Parameters
datacenterId
String
The unique ID of the data center.
applicationLoadBalancerId
String
The unique ID of the Application Load Balancer.
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
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
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
null (empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the datacentersApplicationloadbalancersDeleteWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersApplicationloadbalancersDelete instead
Example
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
datacentersApplicationloadbalancersFindByApplicationLoadBalancerId
ApplicationLoadBalancer datacentersApplicationloadbalancersFindByApplicationLoadBalancerId(datacenterId, applicationLoadBalancerId, pretty, depth, xContractNumber)
Get an Application Load Balancer by ID
Retrieves the properties of the specified Application Load Balancer within the data center.
Parameters
datacenterId
String
The unique ID of the data center.
applicationLoadBalancerId
String
The unique ID of the Application Load Balancer.
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
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
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the datacentersApplicationloadbalancersFindByApplicationLoadBalancerIdWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersApplicationloadbalancersFindByApplicationLoadBalancerId instead
Example
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
datacentersApplicationloadbalancersFlowlogsDelete
datacentersApplicationloadbalancersFlowlogsDelete(datacenterId, applicationLoadBalancerId, flowLogId, pretty, depth, xContractNumber)
Delete an ALB Flow Log by ID
Deletes the Application Load Balancer flow log specified by its ID.
Parameters
datacenterId
String
The unique ID of the data center.
applicationLoadBalancerId
String
The unique ID of the Application Load Balancer.
flowLogId
String
The unique ID of the flow log.
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
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
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
null (empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the datacentersApplicationloadbalancersFlowlogsDeleteWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersApplicationloadbalancersFlowlogsDelete instead
Example
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
datacentersApplicationloadbalancersFlowlogsFindByFlowLogId
FlowLog datacentersApplicationloadbalancersFlowlogsFindByFlowLogId(datacenterId, applicationLoadBalancerId, flowLogId, pretty, depth, xContractNumber)
Get an ALB Flow Log by ID
Retrieves the Application Load Balancer flow log specified by its ID.
Parameters
datacenterId
String
The unique ID of the data center.
applicationLoadBalancerId
String
The unique ID of the Application Load Balancer.
flowLogId
String
The unique ID of the flow log.
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
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
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the datacentersApplicationloadbalancersFlowlogsFindByFlowLogIdWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersApplicationloadbalancersFlowlogsFindByFlowLogId instead
Example
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
datacentersApplicationloadbalancersFlowlogsGet
FlowLogs datacentersApplicationloadbalancersFlowlogsGet(datacenterId, applicationLoadBalancerId, pretty, depth, xContractNumber)
Get ALB Flow Logs
Retrieves the flow logs for the specified Application Load Balancer.
Parameters
datacenterId
String
The unique ID of the data center.
applicationLoadBalancerId
String
The unique ID of the Application Load Balancer.
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
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
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
orderBy
String
Sorts the results alphanumerically in ascending order based on the specified property.
[optional]
maxResults
Integer
Limits the number of results returned.
[optional]
filters
Map<String, String>
Limit results to those containing a matching value for a specific property.
[optional]
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the datacentersApplicationloadbalancersFlowlogsGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersApplicationloadbalancersFlowlogsGet instead
Example
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
datacentersApplicationloadbalancersFlowlogsPatch
FlowLog datacentersApplicationloadbalancersFlowlogsPatch(datacenterId, applicationLoadBalancerId, flowLogId, applicationLoadBalancerFlowLogProperties, pretty, depth, xContractNumber)
Partially Modify an ALB Flow Log by ID
Updates the properties of the Application Load Balancer flow log specified by its ID.
Parameters
datacenterId
String
The unique ID of the data center.
applicationLoadBalancerId
String
The unique ID of the Application Load Balancer.
flowLogId
String
The unique ID of the flow log.
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
Integer
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
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the datacentersApplicationloadbalancersFlowlogsPatchWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersApplicationloadbalancersFlowlogsPatch instead
Example
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
datacentersApplicationloadbalancersFlowlogsPost
FlowLog datacentersApplicationloadbalancersFlowlogsPost(datacenterId, applicationLoadBalancerId, applicationLoadBalancerFlowLog, pretty, depth, xContractNumber)
Create an ALB Flow Log
Creates a flow log for the Application Load Balancer specified by ID.
Parameters
datacenterId
String
The unique ID of the data center.
applicationLoadBalancerId
String
The unique ID of the Application Load Balancer.
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
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
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
⚠️ Note: the example bellow uses the datacentersApplicationloadbalancersFlowlogsPostWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersApplicationloadbalancersFlowlogsPost instead
Example
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
datacentersApplicationloadbalancersFlowlogsPut
FlowLog datacentersApplicationloadbalancersFlowlogsPut(datacenterId, applicationLoadBalancerId, flowLogId, applicationLoadBalancerFlowLog, pretty, depth, xContractNumber)
Modify an ALB Flow Log by ID
Modifies the Application Load Balancer flow log specified by its ID.
Parameters
datacenterId
String
The unique ID of the data center.
applicationLoadBalancerId
String
The unique ID of the Application Load Balancer.
flowLogId
String
The unique ID of the flow log.
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
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
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
⚠️ Note: the example bellow uses the datacentersApplicationloadbalancersFlowlogsPutWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersApplicationloadbalancersFlowlogsPut instead
Example
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
datacentersApplicationloadbalancersForwardingrulesDelete
datacentersApplicationloadbalancersForwardingrulesDelete(datacenterId, applicationLoadBalancerId, forwardingRuleId, pretty, depth, xContractNumber)
Delete an ALB Forwarding Rule by ID
Deletes the Application Load Balancer forwarding rule specified by its ID.
Parameters
datacenterId
String
The unique ID of the data center.
applicationLoadBalancerId
String
The unique ID of the Application Load Balancer.
forwardingRuleId
String
The unique ID of the forwarding rule.
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
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
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
null (empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the datacentersApplicationloadbalancersForwardingrulesDeleteWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersApplicationloadbalancersForwardingrulesDelete instead
Example
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
datacentersApplicationloadbalancersForwardingrulesFindByForwardingRuleId
ApplicationLoadBalancerForwardingRule datacentersApplicationloadbalancersForwardingrulesFindByForwardingRuleId(datacenterId, applicationLoadBalancerId, forwardingRuleId, pretty, depth, xContractNumber)
Get an ALB Forwarding Rule by ID
Retrieves the Application Load Balancer forwarding rule specified by its ID.
Parameters
datacenterId
String
The unique ID of the data center.
applicationLoadBalancerId
String
The unique ID of the Application Load Balancer.
forwardingRuleId
String
The unique ID of the forwarding rule.
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
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
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
ApplicationLoadBalancerForwardingRule
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the datacentersApplicationloadbalancersForwardingrulesFindByForwardingRuleIdWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersApplicationloadbalancersForwardingrulesFindByForwardingRuleId instead
Example
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
datacentersApplicationloadbalancersForwardingrulesGet
ApplicationLoadBalancerForwardingRules datacentersApplicationloadbalancersForwardingrulesGet(datacenterId, applicationLoadBalancerId, pretty, depth, xContractNumber)
Get ALB Forwarding Rules
Lists the forwarding rules of the specified Application Load Balancer.
Parameters
datacenterId
String
The unique ID of the data center.
applicationLoadBalancerId
String
The unique ID of the Application Load Balancer.
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
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
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
orderBy
String
Sorts the results alphanumerically in ascending order based on the specified property.
[optional]
maxResults
Integer
Limits the number of results returned.
[optional]
filters
Map<String, String>
Limit results to those containing a matching value for a specific property.
[optional]
Return type
ApplicationLoadBalancerForwardingRules
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the datacentersApplicationloadbalancersForwardingrulesGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersApplicationloadbalancersForwardingrulesGet instead
Example
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
datacentersApplicationloadbalancersForwardingrulesPatch
ApplicationLoadBalancerForwardingRule datacentersApplicationloadbalancersForwardingrulesPatch(datacenterId, applicationLoadBalancerId, forwardingRuleId, applicationLoadBalancerForwardingRuleProperties, pretty, depth, xContractNumber)
Partially modify an ALB Forwarding Rule by ID
Updates the properties of the Application Load Balancer forwarding rule specified by its ID.
Parameters
datacenterId
String
The unique ID of the data center.
applicationLoadBalancerId
String
The unique ID of the Application Load Balancer.
forwardingRuleId
String
The unique ID of the forwarding rule.
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
Integer
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
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
ApplicationLoadBalancerForwardingRule
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the datacentersApplicationloadbalancersForwardingrulesPatchWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersApplicationloadbalancersForwardingrulesPatch instead
Example
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
datacentersApplicationloadbalancersForwardingrulesPost
ApplicationLoadBalancerForwardingRule datacentersApplicationloadbalancersForwardingrulesPost(datacenterId, applicationLoadBalancerId, applicationLoadBalancerForwardingRule, pretty, depth, xContractNumber)
Create an ALB Forwarding Rule
Creates a forwarding rule for the specified Application Load Balancer.
Parameters
datacenterId
String
The unique ID of the data center.
applicationLoadBalancerId
String
The unique ID of the Application Load Balancer.
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
Integer
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
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
ApplicationLoadBalancerForwardingRule
HTTP request headers
Content-Type: application/json
Accept: application/json
⚠️ Note: the example bellow uses the datacentersApplicationloadbalancersForwardingrulesPostWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersApplicationloadbalancersForwardingrulesPost instead
Example
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
datacentersApplicationloadbalancersForwardingrulesPut
ApplicationLoadBalancerForwardingRule datacentersApplicationloadbalancersForwardingrulesPut(datacenterId, applicationLoadBalancerId, forwardingRuleId, applicationLoadBalancerForwardingRule, pretty, depth, xContractNumber)
Modify an ALB Forwarding Rule by ID
Modifies the Application Load Balancer forwarding rule specified by its ID.
Parameters
datacenterId
String
The unique ID of the data center.
applicationLoadBalancerId
String
The unique ID of the Application Load Balancer.
forwardingRuleId
String
The unique ID of the forwarding rule.
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
Integer
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
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
ApplicationLoadBalancerForwardingRule
HTTP request headers
Content-Type: application/json
Accept: application/json
⚠️ Note: the example bellow uses the datacentersApplicationloadbalancersForwardingrulesPutWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersApplicationloadbalancersForwardingrulesPut instead
Example
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
datacentersApplicationloadbalancersGet
ApplicationLoadBalancers datacentersApplicationloadbalancersGet(datacenterId, pretty, depth, xContractNumber, offset, limit)
Get Application Load Balancers
Lists all Application Load Balancers within a data center.
Parameters
datacenterId
String
The unique ID of the data center.
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
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
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
offset
Integer
The first element (from the complete list of the elements) to include in the response (used together with <b><i>limit</i></b> for pagination).
[optional] [default to 0]
limit
Integer
The maximum number of elements to return (use together with offset for pagination).
[optional] [default to 1000]
orderBy
String
Sorts the results alphanumerically in ascending order based on the specified property.
[optional]
maxResults
Integer
Limits the number of results returned.
[optional]
filters
Map<String, String>
Limit results to those containing a matching value for a specific property.
[optional]
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the datacentersApplicationloadbalancersGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersApplicationloadbalancersGet instead
Example
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
datacentersApplicationloadbalancersPatch
ApplicationLoadBalancer datacentersApplicationloadbalancersPatch(datacenterId, applicationLoadBalancerId, applicationLoadBalancerProperties, pretty, depth, xContractNumber)
Partially Modify an Application Load Balancer by ID
Updates the properties of the specified Application Load Balancer within the data center.
Parameters
datacenterId
String
The unique ID of the data center.
applicationLoadBalancerId
String
The unique ID of the Application Load Balancer.
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
Integer
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
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the datacentersApplicationloadbalancersPatchWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersApplicationloadbalancersPatch instead
Example
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
datacentersApplicationloadbalancersPost
ApplicationLoadBalancer datacentersApplicationloadbalancersPost(datacenterId, applicationLoadBalancer, pretty, depth, xContractNumber)
Create an Application Load Balancer
Creates an Application Load Balancer within the data center.
Parameters
datacenterId
String
The unique ID of the data center.
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
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
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
⚠️ Note: the example bellow uses the datacentersApplicationloadbalancersPostWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersApplicationloadbalancersPost instead
Example
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
datacentersApplicationloadbalancersPut
ApplicationLoadBalancer datacentersApplicationloadbalancersPut(datacenterId, applicationLoadBalancerId, applicationLoadBalancer, pretty, depth, xContractNumber)
Modify an Application Load Balancer by ID
Modifies the properties of the specified Application Load Balancer within the data center.
Parameters
datacenterId
String
The unique ID of the data center.
applicationLoadBalancerId
String
The unique ID of the Application Load Balancer.
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
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
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
⚠️ Note: the example bellow uses the datacentersApplicationloadbalancersPutWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersApplicationloadbalancersPut instead
Example
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
Last updated
