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 |
datacenters_applicationloadbalancers_delete
datacenters_applicationloadbalancers_delete(datacenter_id, application_load_balancer_id, opts)
Delete an Application Load Balancer by ID
Removes the specified Application Load Balancer from the data center.
Examples
Using the datacenters_applicationloadbalancers_delete_with_http_info variant
This returns an Array which contains the response data (nil
in this case), status code and headers.
<Array(nil, Integer, Hash)> datacenters_applicationloadbalancers_delete_with_http_info(datacenter_id, application_load_balancer_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
application_load_balancer_id | 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] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Return type
nil (empty response body)
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_applicationloadbalancers_find_by_application_load_balancer_id
datacenters_applicationloadbalancers_find_by_application_load_balancer_id(datacenter_id, application_load_balancer_id, opts)
Get an Application Load Balancer by ID
Retrieves the properties of the specified Application Load Balancer within the data center.
Examples
Using the datacenters_applicationloadbalancers_find_by_application_load_balancer_id_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_applicationloadbalancers_find_by_application_load_balancer_id_with_http_info(datacenter_id, application_load_balancer_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
application_load_balancer_id | 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] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_applicationloadbalancers_flowlogs_delete
datacenters_applicationloadbalancers_flowlogs_delete(datacenter_id, application_load_balancer_id, flow_log_id, opts)
Delete an ALB Flow Log by ID
Deletes the Application Load Balancer flow log specified by its ID.
Examples
Using the datacenters_applicationloadbalancers_flowlogs_delete_with_http_info variant
This returns an Array which contains the response data (nil
in this case), status code and headers.
<Array(nil, Integer, Hash)> datacenters_applicationloadbalancers_flowlogs_delete_with_http_info(datacenter_id, application_load_balancer_id, flow_log_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
application_load_balancer_id | String | The unique ID of the Application Load Balancer. | |
flow_log_id | 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] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Return type
nil (empty response body)
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_applicationloadbalancers_flowlogs_find_by_flow_log_id
datacenters_applicationloadbalancers_flowlogs_find_by_flow_log_id(datacenter_id, application_load_balancer_id, flow_log_id, opts)
Get an ALB Flow Log by ID
Retrieves the Application Load Balancer flow log specified by its ID.
Examples
Using the datacenters_applicationloadbalancers_flowlogs_find_by_flow_log_id_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_applicationloadbalancers_flowlogs_find_by_flow_log_id_with_http_info(datacenter_id, application_load_balancer_id, flow_log_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
application_load_balancer_id | String | The unique ID of the Application Load Balancer. | |
flow_log_id | 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] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_applicationloadbalancers_flowlogs_get
datacenters_applicationloadbalancers_flowlogs_get(datacenter_id, application_load_balancer_id, opts)
Get ALB Flow Logs
Retrieves the flow logs for the specified Application Load Balancer.
Examples
Using the datacenters_applicationloadbalancers_flowlogs_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_applicationloadbalancers_flowlogs_get_with_http_info(datacenter_id, application_load_balancer_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
application_load_balancer_id | 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] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_applicationloadbalancers_flowlogs_patch
datacenters_applicationloadbalancers_flowlogs_patch(datacenter_id, application_load_balancer_id, flow_log_id, application_load_balancer_flow_log_properties, opts)
Partially Modify an ALB Flow Log by ID
Updates the properties of the Application Load Balancer flow log specified by its ID.
Examples
Using the datacenters_applicationloadbalancers_flowlogs_patch_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_applicationloadbalancers_flowlogs_patch_with_http_info(datacenter_id, application_load_balancer_id, flow_log_id, application_load_balancer_flow_log_properties, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
application_load_balancer_id | String | The unique ID of the Application Load Balancer. | |
flow_log_id | String | The unique ID of the flow log. | |
application_load_balancer_flow_log_properties | 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] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_applicationloadbalancers_flowlogs_post
datacenters_applicationloadbalancers_flowlogs_post(datacenter_id, application_load_balancer_id, application_load_balancer_flow_log, opts)
Create an ALB Flow Log
Creates a flow log for the Application Load Balancer specified by ID.
Examples
Using the datacenters_applicationloadbalancers_flowlogs_post_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_applicationloadbalancers_flowlogs_post_with_http_info(datacenter_id, application_load_balancer_id, application_load_balancer_flow_log, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
application_load_balancer_id | String | The unique ID of the Application Load Balancer. | |
application_load_balancer_flow_log | The flow log 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] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
datacenters_applicationloadbalancers_flowlogs_put
datacenters_applicationloadbalancers_flowlogs_put(datacenter_id, application_load_balancer_id, flow_log_id, application_load_balancer_flow_log, opts)
Modify an ALB Flow Log by ID
Modifies the Application Load Balancer flow log specified by its ID.
Examples
Using the datacenters_applicationloadbalancers_flowlogs_put_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_applicationloadbalancers_flowlogs_put_with_http_info(datacenter_id, application_load_balancer_id, flow_log_id, application_load_balancer_flow_log, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
application_load_balancer_id | String | The unique ID of the Application Load Balancer. | |
flow_log_id | String | The unique ID of the flow log. | |
application_load_balancer_flow_log | The modified ALB 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] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
datacenters_applicationloadbalancers_forwardingrules_delete
datacenters_applicationloadbalancers_forwardingrules_delete(datacenter_id, application_load_balancer_id, forwarding_rule_id, opts)
Delete an ALB Forwarding Rule by ID
Deletes the Application Load Balancer forwarding rule specified by its ID.
Examples
Using the datacenters_applicationloadbalancers_forwardingrules_delete_with_http_info variant
This returns an Array which contains the response data (nil
in this case), status code and headers.
<Array(nil, Integer, Hash)> datacenters_applicationloadbalancers_forwardingrules_delete_with_http_info(datacenter_id, application_load_balancer_id, forwarding_rule_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
application_load_balancer_id | String | The unique ID of the Application Load Balancer. | |
forwarding_rule_id | 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] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Return type
nil (empty response body)
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_applicationloadbalancers_forwardingrules_find_by_forwarding_rule_id
datacenters_applicationloadbalancers_forwardingrules_find_by_forwarding_rule_id(datacenter_id, application_load_balancer_id, forwarding_rule_id, opts)
Get an ALB Forwarding Rule by ID
Retrieves the Application Load Balancer forwarding rule specified by its ID.
Examples
Using the datacenters_applicationloadbalancers_forwardingrules_find_by_forwarding_rule_id_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_applicationloadbalancers_forwardingrules_find_by_forwarding_rule_id_with_http_info(datacenter_id, application_load_balancer_id, forwarding_rule_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
application_load_balancer_id | String | The unique ID of the Application Load Balancer. | |
forwarding_rule_id | 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] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Return type
ApplicationLoadBalancerForwardingRule
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_applicationloadbalancers_forwardingrules_get
datacenters_applicationloadbalancers_forwardingrules_get(datacenter_id, application_load_balancer_id, opts)
Get ALB Forwarding Rules
Lists the forwarding rules of the specified Application Load Balancer.
Examples
Using the datacenters_applicationloadbalancers_forwardingrules_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_applicationloadbalancers_forwardingrules_get_with_http_info(datacenter_id, application_load_balancer_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
application_load_balancer_id | 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] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Return type
ApplicationLoadBalancerForwardingRules
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_applicationloadbalancers_forwardingrules_patch
datacenters_applicationloadbalancers_forwardingrules_patch(datacenter_id, application_load_balancer_id, forwarding_rule_id, application_load_balancer_forwarding_rule_properties, opts)
Partially modify an ALB Forwarding Rule by ID
Updates the properties of the Application Load Balancer forwarding rule specified by its ID.
Examples
Using the datacenters_applicationloadbalancers_forwardingrules_patch_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_applicationloadbalancers_forwardingrules_patch_with_http_info(datacenter_id, application_load_balancer_id, forwarding_rule_id, application_load_balancer_forwarding_rule_properties, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
application_load_balancer_id | String | The unique ID of the Application Load Balancer. | |
forwarding_rule_id | String | The unique ID of the forwarding rule. | |
application_load_balancer_forwarding_rule_properties | 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] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Return type
ApplicationLoadBalancerForwardingRule
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_applicationloadbalancers_forwardingrules_post
datacenters_applicationloadbalancers_forwardingrules_post(datacenter_id, application_load_balancer_id, application_load_balancer_forwarding_rule, opts)
Create an ALB Forwarding Rule
Creates a forwarding rule for the specified Application Load Balancer.
Examples
Using the datacenters_applicationloadbalancers_forwardingrules_post_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_applicationloadbalancers_forwardingrules_post_with_http_info(datacenter_id, application_load_balancer_id, application_load_balancer_forwarding_rule, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
application_load_balancer_id | String | The unique ID of the Application Load Balancer. | |
application_load_balancer_forwarding_rule | 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] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Return type
ApplicationLoadBalancerForwardingRule
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
datacenters_applicationloadbalancers_forwardingrules_put
datacenters_applicationloadbalancers_forwardingrules_put(datacenter_id, application_load_balancer_id, forwarding_rule_id, application_load_balancer_forwarding_rule, opts)
Modify an ALB Forwarding Rule by ID
Modifies the Application Load Balancer forwarding rule specified by its ID.
Examples
Using the datacenters_applicationloadbalancers_forwardingrules_put_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_applicationloadbalancers_forwardingrules_put_with_http_info(datacenter_id, application_load_balancer_id, forwarding_rule_id, application_load_balancer_forwarding_rule, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
application_load_balancer_id | String | The unique ID of the Application Load Balancer. | |
forwarding_rule_id | String | The unique ID of the forwarding rule. | |
application_load_balancer_forwarding_rule | 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] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Return type
ApplicationLoadBalancerForwardingRule
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
datacenters_applicationloadbalancers_get
datacenters_applicationloadbalancers_get(datacenter_id, opts)
Get Application Load Balancers
Lists all Application Load Balancers within a data center.
Examples
Using the datacenters_applicationloadbalancers_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_applicationloadbalancers_get_with_http_info(datacenter_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | 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] |
x_contract_number | 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] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_applicationloadbalancers_patch
datacenters_applicationloadbalancers_patch(datacenter_id, application_load_balancer_id, application_load_balancer_properties, opts)
Partially Modify an Application Load Balancer by ID
Updates the properties of the specified Application Load Balancer within the data center.
Examples
Using the datacenters_applicationloadbalancers_patch_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_applicationloadbalancers_patch_with_http_info(datacenter_id, application_load_balancer_id, application_load_balancer_properties, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
application_load_balancer_id | String | The unique ID of the Application Load Balancer. | |
application_load_balancer_properties | 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] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_applicationloadbalancers_post
datacenters_applicationloadbalancers_post(datacenter_id, application_load_balancer, opts)
Create an Application Load Balancer
Creates an Application Load Balancer within the data center.
Examples
Using the datacenters_applicationloadbalancers_post_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_applicationloadbalancers_post_with_http_info(datacenter_id, application_load_balancer, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
application_load_balancer | 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 | 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] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
datacenters_applicationloadbalancers_put
datacenters_applicationloadbalancers_put(datacenter_id, application_load_balancer_id, application_load_balancer, opts)
Modify an Application Load Balancer by ID
Modifies the properties of the specified Application Load Balancer within the data center.
Examples
Using the datacenters_applicationloadbalancers_put_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_applicationloadbalancers_put_with_http_info(datacenter_id, application_load_balancer_id, application_load_balancer, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
application_load_balancer_id | String | The unique ID of the Application Load Balancer. | |
application_load_balancer | The modified 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] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
Last updated