Managed Application Load Balancer
Lists all Application Load Balancers within a data center.
The unique ID of the data center.
Controls whether the response is pretty-printed (with indentations and new lines).
trueControls 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
0The first element (from the complete list of the elements) to include in the response (used together with limit for pagination).
0The maximum number of elements to return (use together with offset for pagination).
1000Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
GET /cloudapi/v6/datacenters/{datacenterId}/applicationloadbalancers HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*
{
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "collection",
"href": "<RESOURCE-URI>",
"items": [
{
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "applicationloadbalancer",
"href": "<RESOURCE-URI>",
"metadata": {
"etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
"createdDate": "2015-12-04T14:34:09.809Z",
"createdBy": "[email protected]",
"createdByUserId": "[email protected]",
"lastModifiedDate": "2015-12-04T14:34:09.809Z",
"lastModifiedBy": "[email protected]",
"lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
"state": "AVAILABLE"
},
"properties": {
"name": "My Application Load Balancer",
"listenerLan": 1,
"ips": [
"81.173.1.2",
"22.231.2.2",
"22.231.2.3"
],
"targetLan": 2,
"lbPrivateIps": [
"81.173.1.5/24",
"22.231.2.5/24"
],
"centralLogging": true,
"loggingFormat": "%{+Q}o %{-Q}ci - - [%trg] %r %ST %B \"\" \"\" %cp %ms %ft %b %s %TR %Tw %Tc %Tr %Ta %tsc %ac %fc %bc %sc %rc %sq %bq %CC %CS %hrl %hsl"
},
"entities": {
"forwardingrules": {
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "collection",
"href": "<RESOURCE-URI>",
"items": [
{
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "forwarding-rule",
"href": "<RESOURCE-URI>",
"metadata": {
"etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
"createdDate": "2015-12-04T14:34:09.809Z",
"createdBy": "[email protected]",
"createdByUserId": "[email protected]",
"lastModifiedDate": "2015-12-04T14:34:09.809Z",
"lastModifiedBy": "[email protected]",
"lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
"state": "AVAILABLE"
},
"properties": {
"name": "My Application Load Balancer forwarding rule",
"protocol": "HTTP",
"listenerIp": "81.173.1.2",
"listenerPort": 8080,
"clientTimeout": 50,
"serverCertificates": [
"3839d24f-57bd-408e-96ee-8da3d2db5a03",
"a6b4f7d5-b23a-4f53-b83e-8a6528ab4612"
],
"httpRules": [
{
"name": "My Application Load Balancer HTTP rule",
"type": "FORWARD",
"targetGroup": "96e514d0-73e4-4abd-8fbc-c0f53b79bfae",
"dropQuery": true,
"location": "www.ionos.com",
"statusCode": 301,
"responseMessage": "Application Down",
"contentType": "text/html",
"conditions": [
{
"type": "HEADER",
"condition": "STARTS_WITH",
"negate": false,
"key": "forward-at",
"value": "Friday"
}
]
}
]
}
}
],
"offset": 0,
"limit": 1000,
"_links": {
"prev": "<PREVIOUS-PAGE-URI>",
"self": "<THIS-PAGE-URI>",
"next": "<NEXT-PAGE-URI>"
}
}
}
}
],
"offset": 0,
"limit": 1000,
"_links": {
"prev": "<PREVIOUS-PAGE-URI>",
"self": "<THIS-PAGE-URI>",
"next": "<NEXT-PAGE-URI>"
}
}Creates an Application Load Balancer within the data center.
The unique ID of the data center.
Controls whether the response is pretty-printed (with indentations and new lines).
trueControls 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
0Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
The resource's unique identifier.
15f67991-0f51-4efc-a8ad-ef1fb31a480cThe type of object that has been created.
applicationloadbalancerThe URL to the object representation (absolute path).
<RESOURCE-URI>POST /cloudapi/v6/datacenters/{datacenterId}/applicationloadbalancers HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 491
{
"type": "applicationloadbalancer",
"metadata": {},
"properties": {
"name": "My Application Load Balancer",
"listenerLan": 1,
"ips": [
"81.173.1.2",
"22.231.2.2",
"22.231.2.3"
],
"targetLan": 2,
"lbPrivateIps": [
"81.173.1.5/24",
"22.231.2.5/24"
],
"centralLogging": true,
"loggingFormat": "%{+Q}o %{-Q}ci - - [%trg] %r %ST %B \"\" \"\" %cp %ms %ft %b %s %TR %Tw %Tc %Tr %Ta %tsc %ac %fc %bc %sc %rc %sq %bq %CC %CS %hrl %hsl"
},
"entities": {
"forwardingrules": {
"type": "collection",
"offset": 0,
"limit": 1000,
"_links": {}
}
}
}{
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "applicationloadbalancer",
"href": "<RESOURCE-URI>",
"metadata": {
"etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
"createdDate": "2015-12-04T14:34:09.809Z",
"createdBy": "[email protected]",
"createdByUserId": "[email protected]",
"lastModifiedDate": "2015-12-04T14:34:09.809Z",
"lastModifiedBy": "[email protected]",
"lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
"state": "AVAILABLE"
},
"properties": {
"name": "My Application Load Balancer",
"listenerLan": 1,
"ips": [
"81.173.1.2",
"22.231.2.2",
"22.231.2.3"
],
"targetLan": 2,
"lbPrivateIps": [
"81.173.1.5/24",
"22.231.2.5/24"
],
"centralLogging": true,
"loggingFormat": "%{+Q}o %{-Q}ci - - [%trg] %r %ST %B \"\" \"\" %cp %ms %ft %b %s %TR %Tw %Tc %Tr %Ta %tsc %ac %fc %bc %sc %rc %sq %bq %CC %CS %hrl %hsl"
},
"entities": {
"forwardingrules": {
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "collection",
"href": "<RESOURCE-URI>",
"items": [
{
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "forwarding-rule",
"href": "<RESOURCE-URI>",
"metadata": {
"etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
"createdDate": "2015-12-04T14:34:09.809Z",
"createdBy": "[email protected]",
"createdByUserId": "[email protected]",
"lastModifiedDate": "2015-12-04T14:34:09.809Z",
"lastModifiedBy": "[email protected]",
"lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
"state": "AVAILABLE"
},
"properties": {
"name": "My Application Load Balancer forwarding rule",
"protocol": "HTTP",
"listenerIp": "81.173.1.2",
"listenerPort": 8080,
"clientTimeout": 50,
"serverCertificates": [
"3839d24f-57bd-408e-96ee-8da3d2db5a03",
"a6b4f7d5-b23a-4f53-b83e-8a6528ab4612"
],
"httpRules": [
{
"name": "My Application Load Balancer HTTP rule",
"type": "FORWARD",
"targetGroup": "96e514d0-73e4-4abd-8fbc-c0f53b79bfae",
"dropQuery": true,
"location": "www.ionos.com",
"statusCode": 301,
"responseMessage": "Application Down",
"contentType": "text/html",
"conditions": [
{
"type": "HEADER",
"condition": "STARTS_WITH",
"negate": false,
"key": "forward-at",
"value": "Friday"
}
]
}
]
}
}
],
"offset": 0,
"limit": 1000,
"_links": {
"prev": "<PREVIOUS-PAGE-URI>",
"self": "<THIS-PAGE-URI>",
"next": "<NEXT-PAGE-URI>"
}
}
}
}Retrieves the properties of the specified Application Load Balancer within the data center.
The unique ID of the data center.
The unique ID of the Application Load Balancer.
Controls whether the response is pretty-printed (with indentations and new lines).
trueControls 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
0Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
GET /cloudapi/v6/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*
{
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "applicationloadbalancer",
"href": "<RESOURCE-URI>",
"metadata": {
"etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
"createdDate": "2015-12-04T14:34:09.809Z",
"createdBy": "[email protected]",
"createdByUserId": "[email protected]",
"lastModifiedDate": "2015-12-04T14:34:09.809Z",
"lastModifiedBy": "[email protected]",
"lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
"state": "AVAILABLE"
},
"properties": {
"name": "My Application Load Balancer",
"listenerLan": 1,
"ips": [
"81.173.1.2",
"22.231.2.2",
"22.231.2.3"
],
"targetLan": 2,
"lbPrivateIps": [
"81.173.1.5/24",
"22.231.2.5/24"
],
"centralLogging": true,
"loggingFormat": "%{+Q}o %{-Q}ci - - [%trg] %r %ST %B \"\" \"\" %cp %ms %ft %b %s %TR %Tw %Tc %Tr %Ta %tsc %ac %fc %bc %sc %rc %sq %bq %CC %CS %hrl %hsl"
},
"entities": {
"forwardingrules": {
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "collection",
"href": "<RESOURCE-URI>",
"items": [
{
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "forwarding-rule",
"href": "<RESOURCE-URI>",
"metadata": {
"etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
"createdDate": "2015-12-04T14:34:09.809Z",
"createdBy": "[email protected]",
"createdByUserId": "[email protected]",
"lastModifiedDate": "2015-12-04T14:34:09.809Z",
"lastModifiedBy": "[email protected]",
"lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
"state": "AVAILABLE"
},
"properties": {
"name": "My Application Load Balancer forwarding rule",
"protocol": "HTTP",
"listenerIp": "81.173.1.2",
"listenerPort": 8080,
"clientTimeout": 50,
"serverCertificates": [
"3839d24f-57bd-408e-96ee-8da3d2db5a03",
"a6b4f7d5-b23a-4f53-b83e-8a6528ab4612"
],
"httpRules": [
{
"name": "My Application Load Balancer HTTP rule",
"type": "FORWARD",
"targetGroup": "96e514d0-73e4-4abd-8fbc-c0f53b79bfae",
"dropQuery": true,
"location": "www.ionos.com",
"statusCode": 301,
"responseMessage": "Application Down",
"contentType": "text/html",
"conditions": [
{
"type": "HEADER",
"condition": "STARTS_WITH",
"negate": false,
"key": "forward-at",
"value": "Friday"
}
]
}
]
}
}
],
"offset": 0,
"limit": 1000,
"_links": {
"prev": "<PREVIOUS-PAGE-URI>",
"self": "<THIS-PAGE-URI>",
"next": "<NEXT-PAGE-URI>"
}
}
}
}Modifies the properties of the specified Application Load Balancer within the data center.
The unique ID of the data center.
The unique ID of the Application Load Balancer.
Controls whether the response is pretty-printed (with indentations and new lines).
trueControls 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
0Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
The resource's unique identifier.
15f67991-0f51-4efc-a8ad-ef1fb31a480cThe type of object that has been created.
applicationloadbalancerThe URL to the object representation (absolute path).
<RESOURCE-URI>PUT /cloudapi/v6/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 388
{
"type": "applicationloadbalancer",
"properties": {
"name": "My Application Load Balancer",
"listenerLan": 1,
"ips": [
"81.173.1.2",
"22.231.2.2",
"22.231.2.3"
],
"targetLan": 2,
"lbPrivateIps": [
"81.173.1.5/24",
"22.231.2.5/24"
],
"centralLogging": true,
"loggingFormat": "%{+Q}o %{-Q}ci - - [%trg] %r %ST %B \"\" \"\" %cp %ms %ft %b %s %TR %Tw %Tc %Tr %Ta %tsc %ac %fc %bc %sc %rc %sq %bq %CC %CS %hrl %hsl"
}
}{
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "applicationloadbalancer",
"href": "<RESOURCE-URI>",
"metadata": {
"etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
"createdDate": "2015-12-04T14:34:09.809Z",
"createdBy": "[email protected]",
"createdByUserId": "[email protected]",
"lastModifiedDate": "2015-12-04T14:34:09.809Z",
"lastModifiedBy": "[email protected]",
"lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
"state": "AVAILABLE"
},
"properties": {
"name": "My Application Load Balancer",
"listenerLan": 1,
"ips": [
"81.173.1.2",
"22.231.2.2",
"22.231.2.3"
],
"targetLan": 2,
"lbPrivateIps": [
"81.173.1.5/24",
"22.231.2.5/24"
],
"centralLogging": true,
"loggingFormat": "%{+Q}o %{-Q}ci - - [%trg] %r %ST %B \"\" \"\" %cp %ms %ft %b %s %TR %Tw %Tc %Tr %Ta %tsc %ac %fc %bc %sc %rc %sq %bq %CC %CS %hrl %hsl"
},
"entities": {
"forwardingrules": {
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "collection",
"href": "<RESOURCE-URI>",
"items": [
{
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "forwarding-rule",
"href": "<RESOURCE-URI>",
"metadata": {
"etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
"createdDate": "2015-12-04T14:34:09.809Z",
"createdBy": "[email protected]",
"createdByUserId": "[email protected]",
"lastModifiedDate": "2015-12-04T14:34:09.809Z",
"lastModifiedBy": "[email protected]",
"lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
"state": "AVAILABLE"
},
"properties": {
"name": "My Application Load Balancer forwarding rule",
"protocol": "HTTP",
"listenerIp": "81.173.1.2",
"listenerPort": 8080,
"clientTimeout": 50,
"serverCertificates": [
"3839d24f-57bd-408e-96ee-8da3d2db5a03",
"a6b4f7d5-b23a-4f53-b83e-8a6528ab4612"
],
"httpRules": [
{
"name": "My Application Load Balancer HTTP rule",
"type": "FORWARD",
"targetGroup": "96e514d0-73e4-4abd-8fbc-c0f53b79bfae",
"dropQuery": true,
"location": "www.ionos.com",
"statusCode": 301,
"responseMessage": "Application Down",
"contentType": "text/html",
"conditions": [
{
"type": "HEADER",
"condition": "STARTS_WITH",
"negate": false,
"key": "forward-at",
"value": "Friday"
}
]
}
]
}
}
],
"offset": 0,
"limit": 1000,
"_links": {
"prev": "<PREVIOUS-PAGE-URI>",
"self": "<THIS-PAGE-URI>",
"next": "<NEXT-PAGE-URI>"
}
}
}
}Removes the specified Application Load Balancer from the data center.
The unique ID of the data center.
The unique ID of the Application Load Balancer.
Controls whether the response is pretty-printed (with indentations and new lines).
trueControls 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
0Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
DELETE /cloudapi/v6/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*
No content
Updates the properties of the specified Application Load Balancer within the data center.
The unique ID of the data center.
The unique ID of the Application Load Balancer.
Controls whether the response is pretty-printed (with indentations and new lines).
trueControls 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
0Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
The Application Load Balancer name.
My Application Load BalancerThe ID of the listening (inbound) LAN.
1Collection of the Application Load Balancer IP addresses. (Inbound and outbound) IPs of the 'listenerLan' are customer-reserved public IPs for the public load balancers, and private IPs for the private load balancers.
["81.173.1.2","22.231.2.2","22.231.2.3"]The ID of the balanced private target LAN (outbound).
2Collection of private IP addresses with the subnet mask of the Application Load Balancer. IPs must contain valid a subnet mask. If no IP is provided, the system will generate an IP with /24 subnet.
["81.173.1.5/24","22.231.2.5/24"]Turn logging on and off for this product. Default value is 'false'.
trueSpecifies the format of the logs.
%{+Q}o %{-Q}ci - - [%trg] %r %ST %B "" "" %cp %ms %ft %b %s %TR %Tw %Tc %Tr %Ta %tsc %ac %fc %bc %sc %rc %sq %bq %CC %CS %hrl %hslPATCH /cloudapi/v6/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: */*
Accept: */*
Content-Length: 340
{
"name": "My Application Load Balancer",
"listenerLan": 1,
"ips": [
"81.173.1.2",
"22.231.2.2",
"22.231.2.3"
],
"targetLan": 2,
"lbPrivateIps": [
"81.173.1.5/24",
"22.231.2.5/24"
],
"centralLogging": true,
"loggingFormat": "%{+Q}o %{-Q}ci - - [%trg] %r %ST %B \"\" \"\" %cp %ms %ft %b %s %TR %Tw %Tc %Tr %Ta %tsc %ac %fc %bc %sc %rc %sq %bq %CC %CS %hrl %hsl"
}{
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "applicationloadbalancer",
"href": "<RESOURCE-URI>",
"metadata": {
"etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
"createdDate": "2015-12-04T14:34:09.809Z",
"createdBy": "[email protected]",
"createdByUserId": "[email protected]",
"lastModifiedDate": "2015-12-04T14:34:09.809Z",
"lastModifiedBy": "[email protected]",
"lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
"state": "AVAILABLE"
},
"properties": {
"name": "My Application Load Balancer",
"listenerLan": 1,
"ips": [
"81.173.1.2",
"22.231.2.2",
"22.231.2.3"
],
"targetLan": 2,
"lbPrivateIps": [
"81.173.1.5/24",
"22.231.2.5/24"
],
"centralLogging": true,
"loggingFormat": "%{+Q}o %{-Q}ci - - [%trg] %r %ST %B \"\" \"\" %cp %ms %ft %b %s %TR %Tw %Tc %Tr %Ta %tsc %ac %fc %bc %sc %rc %sq %bq %CC %CS %hrl %hsl"
},
"entities": {
"forwardingrules": {
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "collection",
"href": "<RESOURCE-URI>",
"items": [
{
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "forwarding-rule",
"href": "<RESOURCE-URI>",
"metadata": {
"etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
"createdDate": "2015-12-04T14:34:09.809Z",
"createdBy": "[email protected]",
"createdByUserId": "[email protected]",
"lastModifiedDate": "2015-12-04T14:34:09.809Z",
"lastModifiedBy": "[email protected]",
"lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
"state": "AVAILABLE"
},
"properties": {
"name": "My Application Load Balancer forwarding rule",
"protocol": "HTTP",
"listenerIp": "81.173.1.2",
"listenerPort": 8080,
"clientTimeout": 50,
"serverCertificates": [
"3839d24f-57bd-408e-96ee-8da3d2db5a03",
"a6b4f7d5-b23a-4f53-b83e-8a6528ab4612"
],
"httpRules": [
{
"name": "My Application Load Balancer HTTP rule",
"type": "FORWARD",
"targetGroup": "96e514d0-73e4-4abd-8fbc-c0f53b79bfae",
"dropQuery": true,
"location": "www.ionos.com",
"statusCode": 301,
"responseMessage": "Application Down",
"contentType": "text/html",
"conditions": [
{
"type": "HEADER",
"condition": "STARTS_WITH",
"negate": false,
"key": "forward-at",
"value": "Friday"
}
]
}
]
}
}
],
"offset": 0,
"limit": 1000,
"_links": {
"prev": "<PREVIOUS-PAGE-URI>",
"self": "<THIS-PAGE-URI>",
"next": "<NEXT-PAGE-URI>"
}
}
}
}Lists the forwarding rules of the specified Application Load Balancer.
The unique ID of the data center.
The unique ID of the Application Load Balancer.
Controls whether the response is pretty-printed (with indentations and new lines).
trueControls 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
0Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
GET /cloudapi/v6/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*
{
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "collection",
"href": "<RESOURCE-URI>",
"items": [
{
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "forwarding-rule",
"href": "<RESOURCE-URI>",
"metadata": {
"etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
"createdDate": "2015-12-04T14:34:09.809Z",
"createdBy": "[email protected]",
"createdByUserId": "[email protected]",
"lastModifiedDate": "2015-12-04T14:34:09.809Z",
"lastModifiedBy": "[email protected]",
"lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
"state": "AVAILABLE"
},
"properties": {
"name": "My Application Load Balancer forwarding rule",
"protocol": "HTTP",
"listenerIp": "81.173.1.2",
"listenerPort": 8080,
"clientTimeout": 50,
"serverCertificates": [
"3839d24f-57bd-408e-96ee-8da3d2db5a03",
"a6b4f7d5-b23a-4f53-b83e-8a6528ab4612"
],
"httpRules": [
{
"name": "My Application Load Balancer HTTP rule",
"type": "FORWARD",
"targetGroup": "96e514d0-73e4-4abd-8fbc-c0f53b79bfae",
"dropQuery": true,
"location": "www.ionos.com",
"statusCode": 301,
"responseMessage": "Application Down",
"contentType": "text/html",
"conditions": [
{
"type": "HEADER",
"condition": "STARTS_WITH",
"negate": false,
"key": "forward-at",
"value": "Friday"
}
]
}
]
}
}
],
"offset": 0,
"limit": 1000,
"_links": {
"prev": "<PREVIOUS-PAGE-URI>",
"self": "<THIS-PAGE-URI>",
"next": "<NEXT-PAGE-URI>"
}
}Creates a forwarding rule for the specified Application Load Balancer.
The unique ID of the data center.
The unique ID of the Application Load Balancer.
Controls whether the response is pretty-printed (with indentations and new lines).
trueControls 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
0Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
The resource's unique identifier.
15f67991-0f51-4efc-a8ad-ef1fb31a480cThe type of object that has been created.
forwarding-ruleThe URL to the object representation (absolute path).
<RESOURCE-URI>POST /cloudapi/v6/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 661
{
"type": "forwarding-rule",
"metadata": {},
"properties": {
"name": "My Application Load Balancer forwarding rule",
"protocol": "HTTP",
"listenerIp": "81.173.1.2",
"listenerPort": 8080,
"clientTimeout": 50,
"serverCertificates": [
"3839d24f-57bd-408e-96ee-8da3d2db5a03",
"a6b4f7d5-b23a-4f53-b83e-8a6528ab4612"
],
"httpRules": [
{
"name": "My Application Load Balancer HTTP rule",
"type": "FORWARD",
"targetGroup": "96e514d0-73e4-4abd-8fbc-c0f53b79bfae",
"dropQuery": true,
"location": "www.ionos.com",
"statusCode": 301,
"responseMessage": "Application Down",
"contentType": "text/html",
"conditions": [
{
"type": "HEADER",
"condition": "STARTS_WITH",
"negate": false,
"key": "forward-at",
"value": "Friday"
}
]
}
]
}
}{
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "forwarding-rule",
"href": "<RESOURCE-URI>",
"metadata": {
"etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
"createdDate": "2015-12-04T14:34:09.809Z",
"createdBy": "[email protected]",
"createdByUserId": "[email protected]",
"lastModifiedDate": "2015-12-04T14:34:09.809Z",
"lastModifiedBy": "[email protected]",
"lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
"state": "AVAILABLE"
},
"properties": {
"name": "My Application Load Balancer forwarding rule",
"protocol": "HTTP",
"listenerIp": "81.173.1.2",
"listenerPort": 8080,
"clientTimeout": 50,
"serverCertificates": [
"3839d24f-57bd-408e-96ee-8da3d2db5a03",
"a6b4f7d5-b23a-4f53-b83e-8a6528ab4612"
],
"httpRules": [
{
"name": "My Application Load Balancer HTTP rule",
"type": "FORWARD",
"targetGroup": "96e514d0-73e4-4abd-8fbc-c0f53b79bfae",
"dropQuery": true,
"location": "www.ionos.com",
"statusCode": 301,
"responseMessage": "Application Down",
"contentType": "text/html",
"conditions": [
{
"type": "HEADER",
"condition": "STARTS_WITH",
"negate": false,
"key": "forward-at",
"value": "Friday"
}
]
}
]
}
}Retrieves the Application Load Balancer forwarding rule specified by its ID.
The unique ID of the data center.
The unique ID of the Application Load Balancer.
The unique ID of the forwarding rule.
Controls whether the response is pretty-printed (with indentations and new lines).
trueControls 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
0Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
GET /cloudapi/v6/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*
{
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "forwarding-rule",
"href": "<RESOURCE-URI>",
"metadata": {
"etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
"createdDate": "2015-12-04T14:34:09.809Z",
"createdBy": "[email protected]",
"createdByUserId": "[email protected]",
"lastModifiedDate": "2015-12-04T14:34:09.809Z",
"lastModifiedBy": "[email protected]",
"lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
"state": "AVAILABLE"
},
"properties": {
"name": "My Application Load Balancer forwarding rule",
"protocol": "HTTP",
"listenerIp": "81.173.1.2",
"listenerPort": 8080,
"clientTimeout": 50,
"serverCertificates": [
"3839d24f-57bd-408e-96ee-8da3d2db5a03",
"a6b4f7d5-b23a-4f53-b83e-8a6528ab4612"
],
"httpRules": [
{
"name": "My Application Load Balancer HTTP rule",
"type": "FORWARD",
"targetGroup": "96e514d0-73e4-4abd-8fbc-c0f53b79bfae",
"dropQuery": true,
"location": "www.ionos.com",
"statusCode": 301,
"responseMessage": "Application Down",
"contentType": "text/html",
"conditions": [
{
"type": "HEADER",
"condition": "STARTS_WITH",
"negate": false,
"key": "forward-at",
"value": "Friday"
}
]
}
]
}
}Deletes the Application Load Balancer forwarding rule specified by its ID.
The unique ID of the data center.
The unique ID of the Application Load Balancer.
The unique ID of the forwarding rule.
Controls whether the response is pretty-printed (with indentations and new lines).
trueControls 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
0Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
DELETE /cloudapi/v6/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*
No content
Updates the properties of the Application Load Balancer forwarding rule specified by its ID.
The unique ID of the data center.
The unique ID of the Application Load Balancer.
The unique ID of the forwarding rule.
Controls whether the response is pretty-printed (with indentations and new lines).
trueControls 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
0Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
The name of the Application Load Balancer forwarding rule.
My Application Load Balancer forwarding ruleThe balancing protocol.
HTTPPossible values: The listening (inbound) IP.
81.173.1.2The listening (inbound) port number; the valid range is 1 to 65535.
8080The maximum time in milliseconds to wait for the client to acknowledge or send data; default is 50,000 (50 seconds).
50Array of items in the collection.
["3839d24f-57bd-408e-96ee-8da3d2db5a03","a6b4f7d5-b23a-4f53-b83e-8a6528ab4612"]PATCH /cloudapi/v6/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: */*
Accept: */*
Content-Length: 607
{
"name": "My Application Load Balancer forwarding rule",
"protocol": "HTTP",
"listenerIp": "81.173.1.2",
"listenerPort": 8080,
"clientTimeout": 50,
"serverCertificates": [
"3839d24f-57bd-408e-96ee-8da3d2db5a03",
"a6b4f7d5-b23a-4f53-b83e-8a6528ab4612"
],
"httpRules": [
{
"name": "My Application Load Balancer HTTP rule",
"type": "FORWARD",
"targetGroup": "96e514d0-73e4-4abd-8fbc-c0f53b79bfae",
"dropQuery": true,
"location": "www.ionos.com",
"statusCode": 301,
"responseMessage": "Application Down",
"contentType": "text/html",
"conditions": [
{
"type": "HEADER",
"condition": "STARTS_WITH",
"negate": false,
"key": "forward-at",
"value": "Friday"
}
]
}
]
}{
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "forwarding-rule",
"href": "<RESOURCE-URI>",
"metadata": {
"etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
"createdDate": "2015-12-04T14:34:09.809Z",
"createdBy": "[email protected]",
"createdByUserId": "[email protected]",
"lastModifiedDate": "2015-12-04T14:34:09.809Z",
"lastModifiedBy": "[email protected]",
"lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
"state": "AVAILABLE"
},
"properties": {
"name": "My Application Load Balancer forwarding rule",
"protocol": "HTTP",
"listenerIp": "81.173.1.2",
"listenerPort": 8080,
"clientTimeout": 50,
"serverCertificates": [
"3839d24f-57bd-408e-96ee-8da3d2db5a03",
"a6b4f7d5-b23a-4f53-b83e-8a6528ab4612"
],
"httpRules": [
{
"name": "My Application Load Balancer HTTP rule",
"type": "FORWARD",
"targetGroup": "96e514d0-73e4-4abd-8fbc-c0f53b79bfae",
"dropQuery": true,
"location": "www.ionos.com",
"statusCode": 301,
"responseMessage": "Application Down",
"contentType": "text/html",
"conditions": [
{
"type": "HEADER",
"condition": "STARTS_WITH",
"negate": false,
"key": "forward-at",
"value": "Friday"
}
]
}
]
}
}Retrieves the flow logs for the specified Application Load Balancer.
The unique ID of the data center.
The unique ID of the Application Load Balancer.
Controls whether the response is pretty-printed (with indentations and new lines).
trueControls 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
0Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
GET /cloudapi/v6/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*
{
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "collection",
"href": "<RESOURCE-URI>",
"items": [
{
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "flow-log",
"href": "<RESOURCE-URI>",
"metadata": {
"etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
"createdDate": "2015-12-04T14:34:09.809Z",
"createdBy": "[email protected]",
"createdByUserId": "[email protected]",
"lastModifiedDate": "2015-12-04T14:34:09.809Z",
"lastModifiedBy": "[email protected]",
"lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
"state": "AVAILABLE"
},
"properties": {
"name": "My resource",
"action": "ACCEPTED",
"direction": "INGRESS",
"bucket": "bucketName/key"
}
}
],
"offset": 0,
"limit": 1000,
"_links": {
"prev": "<PREVIOUS-PAGE-URI>",
"self": "<THIS-PAGE-URI>",
"next": "<NEXT-PAGE-URI>"
}
}Creates a flow log for the Application Load Balancer specified by ID.
The unique ID of the data center.
The unique ID of the Application Load Balancer.
Controls whether the response is pretty-printed (with indentations and new lines).
trueControls 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
0Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
The resource's unique identifier.
15f67991-0f51-4efc-a8ad-ef1fb31a480cThe type of object that has been created.
flow-logThe URL to the object representation (absolute path).
<RESOURCE-URI>POST /cloudapi/v6/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 137
{
"type": "flow-log",
"metadata": {},
"properties": {
"name": "My resource",
"action": "ACCEPTED",
"direction": "INGRESS",
"bucket": "bucketName/key"
}
}{
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "flow-log",
"href": "<RESOURCE-URI>",
"metadata": {
"etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
"createdDate": "2015-12-04T14:34:09.809Z",
"createdBy": "[email protected]",
"createdByUserId": "[email protected]",
"lastModifiedDate": "2015-12-04T14:34:09.809Z",
"lastModifiedBy": "[email protected]",
"lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
"state": "AVAILABLE"
},
"properties": {
"name": "My resource",
"action": "ACCEPTED",
"direction": "INGRESS",
"bucket": "bucketName/key"
}
}Retrieves the Application Load Balancer flow log specified by its ID.
The unique ID of the data center.
The unique ID of the Application Load Balancer.
The unique ID of the flow log.
Controls whether the response is pretty-printed (with indentations and new lines).
trueControls 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
0Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
GET /cloudapi/v6/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*
{
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "flow-log",
"href": "<RESOURCE-URI>",
"metadata": {
"etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
"createdDate": "2015-12-04T14:34:09.809Z",
"createdBy": "[email protected]",
"createdByUserId": "[email protected]",
"lastModifiedDate": "2015-12-04T14:34:09.809Z",
"lastModifiedBy": "[email protected]",
"lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
"state": "AVAILABLE"
},
"properties": {
"name": "My resource",
"action": "ACCEPTED",
"direction": "INGRESS",
"bucket": "bucketName/key"
}
}Modifies the Application Load Balancer flow log specified by its ID.
The unique ID of the data center.
The unique ID of the Application Load Balancer.
The unique ID of the flow log.
Controls whether the response is pretty-printed (with indentations and new lines).
trueControls 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
0Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
The resource's unique identifier.
15f67991-0f51-4efc-a8ad-ef1fb31a480cThe type of object that has been created.
flow-logURL to the object representation (absolute path).
<RESOURCE-URI>PUT /cloudapi/v6/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 123
{
"type": "flow-log",
"properties": {
"name": "My resource",
"action": "ACCEPTED",
"direction": "INGRESS",
"bucket": "bucketName/key"
}
}{
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "flow-log",
"href": "<RESOURCE-URI>",
"metadata": {
"etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
"createdDate": "2015-12-04T14:34:09.809Z",
"createdBy": "[email protected]",
"createdByUserId": "[email protected]",
"lastModifiedDate": "2015-12-04T14:34:09.809Z",
"lastModifiedBy": "[email protected]",
"lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
"state": "AVAILABLE"
},
"properties": {
"name": "My resource",
"action": "ACCEPTED",
"direction": "INGRESS",
"bucket": "bucketName/key"
}
}Deletes the Application Load Balancer flow log specified by its ID.
The unique ID of the data center.
The unique ID of the Application Load Balancer.
The unique ID of the flow log.
Controls whether the response is pretty-printed (with indentations and new lines).
trueControls 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
0Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
DELETE /cloudapi/v6/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*
No content
Updates the properties of the Application Load Balancer flow log specified by its ID.
The unique ID of the data center.
The unique ID of the Application Load Balancer.
The unique ID of the flow log.
Controls whether the response is pretty-printed (with indentations and new lines).
trueControls 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
0Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
The resource name.
My resourceSpecifies the traffic action pattern.
ACCEPTEDPossible values: Specifies the traffic direction pattern.
INGRESSPossible values: The bucket name of an existing IONOS Cloud Object storage bucket.
bucketName/keyPATCH /cloudapi/v6/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: */*
Accept: */*
Content-Length: 90
{
"name": "My resource",
"action": "ACCEPTED",
"direction": "INGRESS",
"bucket": "bucketName/key"
}{
"id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
"type": "flow-log",
"href": "<RESOURCE-URI>",
"metadata": {
"etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
"createdDate": "2015-12-04T14:34:09.809Z",
"createdBy": "[email protected]",
"createdByUserId": "[email protected]",
"lastModifiedDate": "2015-12-04T14:34:09.809Z",
"lastModifiedBy": "[email protected]",
"lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
"state": "AVAILABLE"
},
"properties": {
"name": "My resource",
"action": "ACCEPTED",
"direction": "INGRESS",
"bucket": "bucketName/key"
}
}Last updated
Was this helpful?