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
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'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
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'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
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
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'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
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'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
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
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'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
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
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 | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
xContractNumber | number | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional][default to undefined] |
Return type
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
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 | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
xContractNumber | number | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional][default to undefined] |
Return type
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
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 | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
xContractNumber | number | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional][default to undefined] |
Return type
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
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 | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
xContractNumber | number | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional][default to undefined] |
Return type
nil (empty response body)
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
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
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 | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
xContractNumber | number | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional][default to undefined] |
Return type
ApplicationLoadBalancerForwardingRule
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
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'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
ApplicationLoadBalancerForwardingRules
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
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 | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
xContractNumber | number | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional][default to undefined] |
Return type
ApplicationLoadBalancerForwardingRule
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
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 | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
xContractNumber | number | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional][default to undefined] |
Return type
ApplicationLoadBalancerForwardingRule
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
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 | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
xContractNumber | number | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional][default to undefined] |
Return type
ApplicationLoadBalancerForwardingRule
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
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 | 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] |
offset | number | The first element (from the complete list of the elements) to include in the response (used together with <b><i>limit</i></b> for pagination). | [optional][default to 0] |
limit | number | The maximum number of elements to return (use together with offset for pagination). | [optional][default to 1000] |
Return type
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
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 | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
xContractNumber | number | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional][default to undefined] |
Return type
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
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 | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
xContractNumber | number | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional][default to undefined] |
Return type
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
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 | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | [optional][default to 0] |
xContractNumber | number | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional][default to undefined] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
Last updated