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
Delete an Application Load Balancer by ID
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
applicationLoadBalancerId
string
The unique ID of the Application Load Balancer.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersApplicationloadbalancersDeleteRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
(empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersApplicationloadbalancersFindByApplicationLoadBalancerId
Get an Application Load Balancer by ID
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
applicationLoadBalancerId
string
The unique ID of the Application Load Balancer.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersApplicationloadbalancersFindByApplicationLoadBalancerIdRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersApplicationloadbalancersFlowlogsDelete
Delete an ALB Flow Log by ID
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
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.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersApplicationloadbalancersFlowlogsDeleteRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
(empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersApplicationloadbalancersFlowlogsFindByFlowLogId
Get an ALB Flow Log by ID
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
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.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersApplicationloadbalancersFlowlogsFindByFlowLogIdRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersApplicationloadbalancersFlowlogsGet
Get ALB Flow Logs
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
applicationLoadBalancerId
string
The unique ID of the Application Load Balancer.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersApplicationloadbalancersFlowlogsGetRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersApplicationloadbalancersFlowlogsPatch
Partially Modify an ALB Flow Log by ID
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
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.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersApplicationloadbalancersFlowlogsPatchRequest struct via the builder pattern
applicationLoadBalancerFlowLogProperties
The properties of the ALB flow log to be updated.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersApplicationloadbalancersFlowlogsPost
Create an ALB Flow Log
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
applicationLoadBalancerId
string
The unique ID of the Application Load Balancer.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersApplicationloadbalancersFlowlogsPostRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
DatacentersApplicationloadbalancersFlowlogsPut
Modify an ALB Flow Log by ID
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
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.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersApplicationloadbalancersFlowlogsPutRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
DatacentersApplicationloadbalancersForwardingrulesDelete
Delete an ALB Forwarding Rule by ID
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
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.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersApplicationloadbalancersForwardingrulesDeleteRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
(empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersApplicationloadbalancersForwardingrulesFindByForwardingRuleId
Get an ALB Forwarding Rule by ID
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
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.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersApplicationloadbalancersForwardingrulesFindByForwardingRuleIdRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
ApplicationLoadBalancerForwardingRule
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersApplicationloadbalancersForwardingrulesGet
Get ALB Forwarding Rules
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
applicationLoadBalancerId
string
The unique ID of the Application Load Balancer.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersApplicationloadbalancersForwardingrulesGetRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
ApplicationLoadBalancerForwardingRules
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersApplicationloadbalancersForwardingrulesPatch
Partially modify an ALB Forwarding Rule by ID
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
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.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersApplicationloadbalancersForwardingrulesPatchRequest struct via the builder pattern
applicationLoadBalancerForwardingRuleProperties
The properties of the forwarding rule to be updated.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
ApplicationLoadBalancerForwardingRule
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersApplicationloadbalancersForwardingrulesPost
Create an ALB Forwarding Rule
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
applicationLoadBalancerId
string
The unique ID of the Application Load Balancer.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersApplicationloadbalancersForwardingrulesPostRequest struct via the builder pattern
applicationLoadBalancerForwardingRule
The forwarding rule to create.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
ApplicationLoadBalancerForwardingRule
HTTP request headers
Content-Type: application/json
Accept: application/json
DatacentersApplicationloadbalancersForwardingrulesPut
Modify an ALB Forwarding Rule by ID
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
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.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersApplicationloadbalancersForwardingrulesPutRequest struct via the builder pattern
applicationLoadBalancerForwardingRule
The modified ALB forwarding rule.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
ApplicationLoadBalancerForwardingRule
HTTP request headers
Content-Type: application/json
Accept: application/json
DatacentersApplicationloadbalancersGet
Get Application Load Balancers
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersApplicationloadbalancersGetRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
offset
int32
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).
[default to 0]
limit
int32
The maximum number of elements to return (use together with offset for pagination).
[default to 1000]
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersApplicationloadbalancersPatch
Partially Modify an Application Load Balancer by ID
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
applicationLoadBalancerId
string
The unique ID of the Application Load Balancer.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersApplicationloadbalancersPatchRequest struct via the builder pattern
applicationLoadBalancerProperties
The Application Load Balancer properties to be updated.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersApplicationloadbalancersPost
Create an Application Load Balancer
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersApplicationloadbalancersPostRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
DatacentersApplicationloadbalancersPut
Modify an Application Load Balancer by ID
Example
Path Parameters
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
applicationLoadBalancerId
string
The unique ID of the Application Load Balancer.
Other Parameters
Other parameters are passed through a pointer to an apiDatacentersApplicationloadbalancersPutRequest struct via the builder pattern
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
Last updated
