Modify an ALB Forwarding Rule by ID

1 min

PUT

https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}

Modifies the Application Load Balancer forwarding rule specified by its ID.

Path Parameters

datacenterIdstringrequired
Description
The unique ID of the data center.
applicationLoadBalancerIdstringrequired
Description
The unique ID of the Application Load Balancer.
forwardingRuleIdstringrequired
Description
The unique ID of the forwarding rule.

Query Parameters

prettyboolean
Description
Controls whether the response is pretty-printed (with indentations and new lines).
Default
true
depthinteger<int32>
Description
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
0
Format
int32
Minimum
0
Maximum
10

Header Parameters

X-Contract-Numberinteger<int32>
Description
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Format
int32

Body Parameters

bodyApplicationLoadBalancerForwardingRulePutrequired
Description
The modified ALB forwarding rule.
- typeobject
  - Type
- propertiesApplicationLoadBalancerForwardingRulePropertiesrequired
  - namestringrequired
    Example
    My Application Load Balancer forwarding rule
    Description
    The name of the Application Load Balancer forwarding rule.
  - protocolstring<HTTP>required
    Example
    HTTP
    Description
    The balancing protocol.
    Allowed
    HTTP
  - listenerIpstringrequired
    Example
    81.173.1.2
    Description
    The listening (inbound) IP.
  - listenerPortinteger<int32>required
    Example
    8080
    Description
    The listening (inbound) port number; the valid range is 1 to 65535.
    Format
    int32
  - clientTimeoutinteger<int32>
    Example
    50
    Description
    The maximum time in milliseconds to wait for the client to acknowledge or send data; default is 50,000 (50 seconds).
    Format
    int32
  - serverCertificatesstring[]
    Example
    [ "3839d24f-57bd-408e-96ee-8da3d2db5a03", "a6b4f7d5-b23a-4f53-b83e-8a6528ab4612" ]
    Description
    Array of items in the collection.
  - httpRulesApplicationLoadBalancerHttpRule[]
    Description
    An array of items in the collection. The original order of rules is preserved during processing, except that rules of the 'FORWARD' type are processed after the rules with other defined actions. The relative order of the 'FORWARD' type rules is also preserved during the processing.
    - namestringrequired
      Example
      My Application Load Balancer HTTP rule
      Description
      The unique name of the Application Load Balancer HTTP rule.
    - typestring<FORWARD | STATIC | REDIRECT>required
      Example
      FORWARD
      Description
      The HTTP rule type.
      Allowed
      FORWARDSTATICREDIRECT
    - targetGroupstring
      Example
      96e514d0-73e4-4abd-8fbc-c0f53b79bfae
      Description
      The ID of the target group; this parameter is mandatory and is valid only for 'FORWARD' actions.
    - dropQueryboolean
      Example
      true
      Description
      Indicates whether the query part of the URI should be dropped and is valid only for 'REDIRECT' actions. Default value is 'FALSE', the redirect URI does not contain any query parameters.
    - locationstring
      Example
      www.ionos.com
      Description
      The location for the redirection; this parameter is mandatory and valid only for 'REDIRECT' actions.
    - statusCodeinteger<int32>
      Example
      301
      Description
      The status code is for 'REDIRECT' and 'STATIC' actions only.
      
      If the HTTP rule is 'REDIRECT' the valid values are: 301, 302, 303, 307, 308; default value is '301'.
      
      If the HTTP rule is 'STATIC' the valid values are from the range 200-599; default value is '503'.
      Format
      int32
    - responseMessagestring
      Example
      Application Down
      Description
      The response message of the request; this parameter is mandatory for 'STATIC' actions.
    - contentTypestring
      Example
      text/html
      Description
      Specifies the content type and is valid only for 'STATIC' actions.
    - conditionsApplicationLoadBalancerHttpRuleCondition[]
      Description
      An array of items in the collection. The action will be executed only if each condition is met; the rule will always be applied if no conditions are set.
      - typestring<HEADER | PATH | QUERY | METHOD | HOST | COOKIE | SOURCE_IP>required
        Example
        HEADER
        Description
        The HTTP rule condition type.
        Allowed
        HEADERPATHQUERYMETHODHOSTCOOKIESOURCE_IP
      - conditionstring<EXISTS | CONTAINS | EQUALS | MATCHES | STARTS_WITH | ENDS_WITH>required
        Example
        STARTS_WITH
        Description
        The matching rule for the HTTP rule condition attribute; this parameter is mandatory for 'HEADER', 'PATH', 'QUERY', 'METHOD', 'HOST', and 'COOKIE' types. It must be 'null' if the type is 'SOURCE_IP'.
        Allowed
        EXISTSCONTAINSEQUALSMATCHESSTARTS_WITHENDS_WITH
      - negateboolean
        Description
        Specifies whether the condition should be negated; the default value is 'FALSE'.
      - keystring
        Example
        forward-at
        Description
        The key can only be set when the HTTP rule condition type is 'COOKIES', 'HEADER', or 'QUERY'. For the type 'PATH', 'METHOD', 'HOST', or 'SOURCE_IP' the value must be 'null'.
      - valuestring
        Example
        Friday
        Description
        This parameter is mandatory for the conditions 'CONTAINS', 'EQUALS', 'MATCHES', 'STARTS_WITH', 'ENDS_WITH', or if the type is 'SOURCE_IP'. Specify a valid CIDR. If the condition is 'EXISTS', the value must be 'null'.

Responses

202Successful operation

ApplicationLoadBalancerForwardingRule
- idstring
  Example
  15f67991-0f51-4efc-a8ad-ef1fb31a480c
  Description
  The resource's unique identifier.
- typeobject
  - Type
- hrefstring<uri>
  Example
  <RESOURCE-URI>
  Description
  The URL to the object representation (absolute path).
  Format
  uri
- metadataDatacenterElementMetadata
  - etagstring
    Example
    45480eb3fbfc31f1d916c1eaa4abdcc3
    Description
    Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter.
  - createdDatestring<date-time>
    Example
    2015-12-04T14:34:09.809Z
    Description
    The last time the resource was created.
    Format
    date-time
  - createdBystring
    Example
    [email protected]
    Description
    The user who created the resource.
  - createdByUserIdstring
    Example
    [email protected]
    Description
    The unique ID of the user who created the resource.
  - lastModifiedDatestring<date-time>
    Example
    2015-12-04T14:34:09.809Z
    Description
    The last time the resource was modified.
    Format
    date-time
  - lastModifiedBystring
    Example
    [email protected]
    Description
    The user who last modified the resource.
  - lastModifiedByUserIdstring
    Example
    63cef532-26fe-4a64-a4e0-de7c8a506c90
    Description
    The unique ID of the user who last modified the resource.
  - statestring<AVAILABLE | INACTIVE | BUSY | DEPLOYING | ACTIVE | FAILED | SUSPENDED | FAILED_SUSPENDED | UPDATING | FAILED_UPDATING | DESTROYING | FAILED_DESTROYING | TERMINATED | HIBERNATING | FAILED_HIBERNATING | MAINTENANCE | FAILED_MAINTENANCE | UNKNOWN>
    Example
    AVAILABLE
    Description
    State of the resource. AVAILABLE There are no pending modification requests for this item; BUSY There is at least one modification request pending and all following requests will be queued; INACTIVE Resource has been de-provisioned; DEPLOYING Resource state DEPLOYING - relevant for Kubernetes cluster/nodepool; ACTIVE Resource state ACTIVE - relevant for Kubernetes cluster/nodepool; FAILED Resource state FAILED - relevant for Kubernetes cluster/nodepool; SUSPENDED Resource state SUSPENDED - relevant for Kubernetes cluster/nodepool; FAILED_SUSPENDED Resource state FAILED_SUSPENDED - relevant for Kubernetes cluster; UPDATING Resource state UPDATING - relevant for Kubernetes cluster/nodepool; FAILED_UPDATING Resource state FAILED_UPDATING - relevant for Kubernetes cluster/nodepool; DESTROYING Resource state DESTROYING - relevant for Kubernetes cluster; FAILED_DESTROYING Resource state FAILED_DESTROYING - relevant for Kubernetes cluster/nodepool; TERMINATED Resource state TERMINATED - relevant for Kubernetes cluster/nodepool; HIBERNATING Resource state HIBERNATING - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool; MAINTENANCE Resource state MAINTENANCE - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool.
    Allowed
    AVAILABLEINACTIVEBUSYDEPLOYINGACTIVEFAILEDSUSPENDEDFAILED_SUSPENDEDUPDATINGFAILED_UPDATINGDESTROYINGFAILED_DESTROYINGTERMINATEDHIBERNATINGFAILED_HIBERNATINGMAINTENANCEFAILED_MAINTENANCEUNKNOWN
- propertiesApplicationLoadBalancerForwardingRulePropertiesrequired
  - namestringrequired
    Example
    My Application Load Balancer forwarding rule
    Description
    The name of the Application Load Balancer forwarding rule.
  - protocolstring<HTTP>required
    Example
    HTTP
    Description
    The balancing protocol.
    Allowed
    HTTP
  - listenerIpstringrequired
    Example
    81.173.1.2
    Description
    The listening (inbound) IP.
  - listenerPortinteger<int32>required
    Example
    8080
    Description
    The listening (inbound) port number; the valid range is 1 to 65535.
    Format
    int32
  - clientTimeoutinteger<int32>
    Example
    50
    Description
    The maximum time in milliseconds to wait for the client to acknowledge or send data; default is 50,000 (50 seconds).
    Format
    int32
  - serverCertificatesstring[]
    Example
    [ "3839d24f-57bd-408e-96ee-8da3d2db5a03", "a6b4f7d5-b23a-4f53-b83e-8a6528ab4612" ]
    Description
    Array of items in the collection.
  - httpRulesApplicationLoadBalancerHttpRule[]
    Description
    An array of items in the collection. The original order of rules is preserved during processing, except that rules of the 'FORWARD' type are processed after the rules with other defined actions. The relative order of the 'FORWARD' type rules is also preserved during the processing.
    - namestringrequired
      Example
      My Application Load Balancer HTTP rule
      Description
      The unique name of the Application Load Balancer HTTP rule.
    - typestring<FORWARD | STATIC | REDIRECT>required
      Example
      FORWARD
      Description
      The HTTP rule type.
      Allowed
      FORWARDSTATICREDIRECT
    - targetGroupstring
      Example
      96e514d0-73e4-4abd-8fbc-c0f53b79bfae
      Description
      The ID of the target group; this parameter is mandatory and is valid only for 'FORWARD' actions.
    - dropQueryboolean
      Example
      true
      Description
      Indicates whether the query part of the URI should be dropped and is valid only for 'REDIRECT' actions. Default value is 'FALSE', the redirect URI does not contain any query parameters.
    - locationstring
      Example
      www.ionos.com
      Description
      The location for the redirection; this parameter is mandatory and valid only for 'REDIRECT' actions.
    - statusCodeinteger<int32>
      Example
      301
      Description
      The status code is for 'REDIRECT' and 'STATIC' actions only.
      
      If the HTTP rule is 'REDIRECT' the valid values are: 301, 302, 303, 307, 308; default value is '301'.
      
      If the HTTP rule is 'STATIC' the valid values are from the range 200-599; default value is '503'.
      Format
      int32
    - responseMessagestring
      Example
      Application Down
      Description
      The response message of the request; this parameter is mandatory for 'STATIC' actions.
    - contentTypestring
      Example
      text/html
      Description
      Specifies the content type and is valid only for 'STATIC' actions.
    - conditionsApplicationLoadBalancerHttpRuleCondition[]
      Description
      An array of items in the collection. The action will be executed only if each condition is met; the rule will always be applied if no conditions are set.
      - typestring<HEADER | PATH | QUERY | METHOD | HOST | COOKIE | SOURCE_IP>required
        Example
        HEADER
        Description
        The HTTP rule condition type.
        Allowed
        HEADERPATHQUERYMETHODHOSTCOOKIESOURCE_IP
      - conditionstring<EXISTS | CONTAINS | EQUALS | MATCHES | STARTS_WITH | ENDS_WITH>required
        Example
        STARTS_WITH
        Description
        The matching rule for the HTTP rule condition attribute; this parameter is mandatory for 'HEADER', 'PATH', 'QUERY', 'METHOD', 'HOST', and 'COOKIE' types. It must be 'null' if the type is 'SOURCE_IP'.
        Allowed
        EXISTSCONTAINSEQUALSMATCHESSTARTS_WITHENDS_WITH
      - negateboolean
        Description
        Specifies whether the condition should be negated; the default value is 'FALSE'.
      - keystring
        Example
        forward-at
        Description
        The key can only be set when the HTTP rule condition type is 'COOKIES', 'HEADER', or 'QUERY'. For the type 'PATH', 'METHOD', 'HOST', or 'SOURCE_IP' the value must be 'null'.
      - valuestring
        Example
        Friday
        Description
        This parameter is mandatory for the conditions 'CONTAINS', 'EQUALS', 'MATCHES', 'STARTS_WITH', 'ENDS_WITH', or if the type is 'SOURCE_IP'. Specify a valid CIDR. If the condition is 'EXISTS', the value must be 'null'.

Response Headers

X-RateLimit-Remaininginteger<int32>
Description
The number of requests that can still be made without triggering a failure response.
Format
int32
X-RateLimit-Limitinteger<int32>
Description
The average number of requests per minute allowed.
Format
int32
X-RateLimit-Burstinteger<int32>
Description
The maximum number of concurrent API requests allowed.
Format
int32

default

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

Error
- httpStatusinteger<int32>
  Example
  400
  Description
  HTTP status code of the operation.
  Format
  int32
- messagesErrorMessage[]
  - errorCodestring
    Example
    123
    Description
    Application internal error code.
  - messagestring
    Example
    Error message example.
    Description
    A human-readable message.

curl

curl --request PUT \
     --url 'https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}?pretty=true&depth=integer%3Cint32%3E' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "type": {},
     "properties": {
     "name": "My Application Load Balancer forwarding rule",
     "protocol": "HTTP",
     "listenerIp": "81.173.1.2",
     "listenerPort": 8080,
     "httpRules": [
     {
     "name": "My Application Load Balancer HTTP rule",
     "type": "FORWARD",
     "conditions": [
     {
     "type": "HEADER",
     "condition": "STARTS_WITH"
     }
     ]
     }
     ]
     }
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "type": {},
   "properties": {
      "name": "My Application Load Balancer forwarding rule",
      "protocol": "HTTP",
      "listenerIp": "81.173.1.2",
      "listenerPort": 8080,
      "httpRules": [
         {
            "name": "My Application Load Balancer HTTP rule",
            "type": "FORWARD",
            "conditions": [
               {
                  "type": "HEADER",
                  "condition": "STARTS_WITH"
               }
            ]
         }
      ]
   }
});

var requestOptions = {
   method: 'PUT',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}?pretty=true&depth=integer<int32>", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}?pretty=true&depth=integer<int32>")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Put.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "type": {},
   "properties": {
      "name": "My Application Load Balancer forwarding rule",
      "protocol": "HTTP",
      "listenerIp": "81.173.1.2",
      "listenerPort": 8080,
      "httpRules": [
         {
            "name": "My Application Load Balancer HTTP rule",
            "type": "FORWARD",
            "conditions": [
               {
                  "type": "HEADER",
                  "condition": "STARTS_WITH"
               }
            ]
         }
      ]
   }
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.ionos.com/cloudapi/v6/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}?pretty=true&depth=integer<int32>"

payload = json.dumps({
   "type": {},
   "properties": {
      "name": "My Application Load Balancer forwarding rule",
      "protocol": "HTTP",
      "listenerIp": "81.173.1.2",
      "listenerPort": 8080,
      "httpRules": [
         {
            "name": "My Application Load Balancer HTTP rule",
            "type": "FORWARD",
            "conditions": [
               {
                  "type": "HEADER",
                  "condition": "STARTS_WITH"
               }
            ]
         }
      ]
   }
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)

202

// Successful operation
{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": {},
  "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": [
      ""
    ],
    "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"
          }
        ]
      }
    ]
  }
}

default

// Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).
{
  "httpStatus": 400,
  "messages": [
    {
      "errorCode": "123",
      "message": "Error message example."
    }
  ]
}

Have a question?

Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.

To ask a question or participate in discussions, you'll need to authenticate first.