Gets domains by name.

By default,The user's clouds are used to filter the final output

This method allows to delete a URL of Load Balancer.

This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.

DELETE /loadbalancers/123/urls/456

This method allows to create a URL for a LoadBalancer.

• name is the name of the url.
• setUpDNSEnabled setup dns or not.
• monitoringEnabled enable monitoring for url
• onCallSupervision enable 24/7 monitoring for url

This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.

POST /loadbalancers/124/urls
{
  "name": "url.cegedim.com",
  "setUpDNSEnabled": false,
  "monitoringEnabled": true,
  "onCallSupervision": true
}

List Load Balancing Networks

This method returns the list of accessible networks from a Load balancing Zone.

Available Parameters:

• scope query parameter to filter private, interco, internet networks. for 'frontend' and 'backend' networks, use scope=private
• environment query parameter to filter production, non_production networks. for 'production' networks, use environment=production
• onlyNonFull if you want only networks with available IP addresses to be listed.
• clouds parameter (comma-separated list of long) to restrict results to specified Clouds IDs (use the /me to obtain the list of your Clouds).

This method allows to update a url of load balancer.

Structure of payload is generic and describes :

• operation you want to be performed
• options data relative to the operation performed - see details.

Below are different operations currently implemented.

Update Monitoring for Load Balancer and its URLs

Use the update_monitoring operation to update monitoring status for load balancer.

This method is synchronous (status code 202).

PATCH /loadbalancers/1234/urls/5678
{
    "operation": "update_monitoring",
    "options": {
       "state": true,
       "onCall": true
    }
}

This method allows to update a load balancer.

Structure of payload is generic and describes :

• operation you want to be performed
• options data relative to the operation performed - see details.

Below are different operations currently implemented.

Start Load Balancer

Use the start operation to start the load balancer.

This method is synchronous (status code 202).

Example :

PATCH /loadbalancers/1234
{
    "operation": "start",
    "options": {
        "changeReference": "5678"
    }
}

Stop Load Balancer

Use the stop operation to stop the load balancer.

This method is synchronous (status code 202).

PATCH /loadbalancers/1234
{
    "operation": "stop",
    "options": {
        "changeReference": "5678"
    }
}

Create Bot Defense for Load Balancer

Use the activate_bot operation to Update Security Profile for load balancer. Use the template with values strict, standard to set the template to be applied. Default template value is standard. Use the mode with values transparent, blocking to set the mode to be applied. Mode is optional and default mode is blocking.

This method is synchronous (status code 202).

PATCH /loadbalancers/1234
{
    "operation": "activate_bot",
    "options": {
        "changeReference": "5678",
        "template": "strict",
        "mode" : "blocking"
    }
}

Update Bot Defense for Load Balancer

Use the update_bot operation to Update Security Profile for load balancer. Use the template with values strict, standard to set the template to be applied. Default template value is standard. Use the mode with values transparent, blocking to set the mode to be applied. Mode is optional and default mode is blocking.

This method is synchronous (status code 202).

PATCH /loadbalancers/1234
{
    "operation": "update_bot",
    "options": {
        "changeReference": "5678",
        "template": "strict",
        "mode" : "blocking"
    }
}

When the Security Profile is applied, Use the mode with values transparent, blocking to set the mode to be applied. Mode is optional and default mode is blocking. In transparent mode, requests considered to be malicious generate an alarm but are not blocked. blocking mode blocks the requests identified as malicious by Bot Defense

PATCH /loadbalancers/1234
{
    "operation": "update_bot",
    "options": {
        "changeReference": "5678",
        "mode" : "transparent"
    }
}

Delete Bot Defense Security Profile from Load Balancer

When Security Profile is activated on a Load Balancer, the attribut botDefenseEnabled on the PATCH /loadbalancers/1234 is true. To remove the Bot Defense Security Profile from a Load Balancer, use : Use the delete_bot operation to remove Security Profile from the load balancer.

This method is synchronous (status code 202).

PATCH /loadbalancers/1234
{
    "operation": "delete_bot",
    "options": {
        "changeReference": "5678"
    }
}

Update IP to whitelist for Load Balancer

Use the edit_bot_whitelist operation to update/add IP to whitelist for load balancer.

This method is synchronous (status code 202).

PATCH /loadbalancers/1234
{
    "operation": "edit_bot_whitelist",
    "options": {
        "ip": "10.0.3.40",
        "changeReference": "5678"
    }
}

Remove IP Address from whitelist for Load Balancer

Use the delete_bot_whitelist operation to remove IP from whitelist for load balancer.

This method is synchronous (status code 202).

PATCH /loadbalancers/1234
{
    "operation": "delete_bot_whitelist",
    "options": {
        "ip": "10.0.3.40",
        "changeReference": "5678"
    }
}

** changeReference (optional) is the RFC Number if available.

Update Monitoring for Load Balancer and its URLs

Use the update_monitoring operation to update monitoring status for load balancer.

This method is synchronous (status code 202).

• Update Monitoring for load balancer and all related URLs.

PATCH /loadbalancers/1234
{
    "operation": "update_monitoring",
    "options": {
       "state": true,
       "on_call": true
    }
}

• Update Monitoring for load balancer and url1 and url4 form its list of URLs.

PATCH /loadbalancers/1234
{
    "operation": "update_monitoring",
    "options": {
       "state": true,
       "on_call": true,
       "updateUrls": [
        "url1",
        "url4"
       ]
    }
}

Add a member to an existing loadbalancer.

The member must be a valid ITCare resource and must be in the same network as the other members of the loadbalancer.

Request example :

POST /compute/loadbalancers/my-service.cegedim.cloud/members
{
    "resourceId": 5050706,
    "port": 80,
    "state": "enabled",
    "name": "REBITCGDM1032",
    "ip": "10.25.19.158"
}

Minimum payload must contain the following information :

• resourceId : Mandatory, ITCare's resource's id to add
• port : Mandatory, port of the member (0 to 65535)

Other field will be ignored. The following payload is valid:

POST /compute/loadbalancers/my-service.cegedim.cloud/members
{
    "resourceId": 5050706,
    "port": 80,
}

This method is synchronous (status code 200) and will return loadbalancer's members list with the new member added :

[
  {
    "resourceId": 1050975,
    "name": "PEB4APP01",
    "port": 443,
    "state": "enabled",
    "status": "up",
    "ip": "10.26.12.11"
  },
  {
    "resourceId": 1050976,
    "name": "PEB4APP02",
    "port": 443,
    "state": "enabled",
    "status": "up",
    "ip": "10.26.12.12"
  },
  {
    "resourceId": 898734,
    "name": "PEB4APP03",
    "port": 443,
    "state": "enabled",
    "status": "up",
    "ip": "10.26.12.13"
  }
]

Note: New member will added with state enabled.

Note: Member statistic are not included in the response body

Set the state of a loadbalancer member.

The member must be a valid ITCare resource and must be a member of the specified loadbalancer.

Possible state value are :

• enabled : Member is up and accept connection
• disabled : Member is disabled and no longer accept new connection. Connections already established remain.
• offline : Member is disabled and no longer accept new connection. Connections already established are interrupted.

Example :

PATCH /compute/loadbalancers/123/members/1050975
{
  "operation": "disabled"
}

This method is synchronous (status code 200) and will return loadbalancer's member object :

  {
    "resourceId": 1050975,
    "name": PEB4APP01,
    "port": 443,
    "state": "disabled",
    "status": "up",
    "name": "PEB4APP01",
    "address": "10.26.12.11"
  }

This method allows to create a LoadBalancer.

You will have to know at the minimum :

• the area of the region where you want to host your cluster (area attribute). Areas can be available in List Regions method.

• url (url attribute). The url you want to create and respect URLs naming convention.

• network ID of the cluster (networkId attribute).

• On which service the LoadBalancer belongs to (serviceId attribute).

• On which domain the url should be belong to (domain attribute).

• Healthcheck to check that your url is responding (healthcheck attribute).

• Persistence configuration (persistence attribute).

• Port member : port on which the members of the loadbalancer should be listening to (portMembers attribute). Example: 80

• Profile Names (profileName attribute). Ex : HTTP, HTTPS, TCP. For HTTP, profileName = 80.

• Redirection rules (redirectToHttps attribute). Redirect to HTTPS or not.

• Members (members attribute). Members of the loadbalancer

optional fields:

• Region (region attribute).
• DNS setup (setUpDNSEnabled attribute). If True, the domain must support the DNS creation. If the attribut is set to True and the domain do not support DNS setup, an error 400 will be raised.
• Network (networkId attribute). If not set, the system will choose the default network available on the Availability Zone.

This method is asynchronous (status code 202) and you'll have to wait for async action to be completed by checking its status.

POST /loadbalancers
{
  "url": "url.cegedim.com",
  "serviceId": 46922,
  "area": "EB-QA",
  "networkId": 4242,
  "healthcheck":"CDGM",
  "persistence": true,
  "portMembers": 80,
  "profileName": "HTTP",
  "redirectToHttps":false,
  "setUpDNSEnabled":false,
  "members": [
  {
	 "id": 42,
	 "network": {
	   "id": 42,
	   "ipAddress" : "1.2.3.4"
	 }
  }
  ]
}

When the LoadBalancer supports SSL

POST /loadbalancers
{
  "url": "url.cegedim.com",
  "serviceId": 46922,
  "area": "EB-QA",
  "networkId": 4242,
  "healthcheck":"CDGM",
  "persistence": true,
  "portMembers": 80,
  "profileName": "HTTPS",
  "redirectToHttps":true,
  "setUpDNSEnabled":false,
  "sslProfile":"my_ssl_profle",
  "certificateName":"my_cert.crt",
  "members": [
  {
	 "id": 42,
	 "network": {
	   "id": 42,
	   "ip" : "1.2.3.4"
	 }
  }
  ]
}