Partially modify an ALB Forwarding Rule by ID

Updates the properties of the Application Load Balancer forwarding rule specified by its ID.

patch

Authorizations

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials.

Note:

• Basic Authentication is supported only when 2-Factor Authentication is not configured.
• Users with 2-Factor Authentication activated must generate new 2FA-secured tokens in the DCD using [Token Manager](https://docs.ionos.com/cloud/set-up-ionos-cloud/management/identity-access-management/token-manager). These tokens do not inherit the 2FA-secured property by default.
• Token deletion is only possible using the Token Manager.

Separate your username and password with a colon, i.e., username:password and send it as 'Authorization' request header. More details: https://en.wikipedia.org/wiki/Basic_access_authentication

Path parameters

datacenterIdstringRequired

The unique ID of the data center.

applicationLoadBalancerIdstringRequired

The unique ID of the Application Load Balancer.

forwardingRuleIdstringRequired

The unique ID of the forwarding rule.

Query parameters

prettybooleanOptional

Controls whether the response is pretty-printed (with indentations and new lines).

Default: true

depthinteger · int32 · max: 10Optional

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

Header parameters

X-Contract-Numberinteger · int32Optional

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Body

namestringRequired

The name of the Application Load Balancer forwarding rule.

Example: My Application Load Balancer forwarding rule

protocolstring · enumRequired

The balancing protocol.

Example: HTTPPossible values:

listenerIpstringRequired

The listening (inbound) IP.

Example: 81.173.1.2

listenerPortinteger · int32Required

The listening (inbound) port number; the valid range is 1 to 65535.

Example: 8080

clientTimeoutinteger · int32Optional

The maximum time in milliseconds to wait for the client to acknowledge or send data; default is 50,000 (50 seconds).

Example: 50

serverCertificatesstring · uuid[]Optional

Array of items in the collection.

Example: ["3839d24f-57bd-408e-96ee-8da3d2db5a03","a6b4f7d5-b23a-4f53-b83e-8a6528ab4612"]

Responses

202

Successful operation

application/json

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).

application/json

patch/datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}

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": "[e-mail]",
    "createdByUserId": "[e-mail]",
    "lastModifiedDate": "2015-12-04T14:34:09.809Z",
    "lastModifiedBy": "[e-mail]",
    "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"
          }
        ]
      }
    ]
  }
}