LogoLogo
cegedim.cloudITCareAPIPrivacy
Français
Français
  • Documentation
  • ITCare
    • ITCare, c'est quoi ?
      • Débuter avec ITCare
      • Démos
    • Enercare
      • Empreinte carbone
    • Notes de mise à jour
  • ITCare API
    • Aperçu
    • Authentication
    • Erreurs
    • Pagination
    • Reference API
      • Démarrage rapide
      • Analytics
        • Matomo
      • Changes
        • Changes
      • Compute
        • Application Servers
        • Backup Policies
        • Containers
        • Environments
        • Instances
        • Platform
        • Resource Filters
        • Resource Types
        • Resources
        • Services
        • Statuses
        • Tag Keys
        • Tag Values
        • Types
      • Databases
        • Databases
        • MariaDB
        • OpenSearch
        • PostgreSQL
        • Redis
        • SQL Server
      • Hardwares
        • Hardwares
      • Messaging
        • Apache Kafka
        • Message Brokers
        • RabbitMQ
      • Networking
        • Domains
        • Load Balancers
        • Network Clusters
        • Networks
      • Operations
        • Actions
        • Operations
      • Storage
        • Glusterfs
        • Overdrive
      • Topology
        • Topology
  • Services
    • Produits
    • Politique de support
    • Politique de patch
    • RACI
  • Analytique
    • Matomo
      • Matomo - Architecture
      • Matomo - Didacticiels
  • Calcul
    • Instances virtuelles
      • Instances virtuelles - Architectures
        • Linux - Renforcement
      • Instances virtuelles - Didacticiels
    • Conteneurs (K8s)
      • K8s - Architecture
        • Hardening
        • Stockage Persistant
      • K8s - Didacticiels
        • Haute Disponibilité
  • Bases de données
    • MariaDB
      • MariaDB - Architecture
      • MariaDB - Didacticiels
    • OpenSearch
      • OpenSearch - Architecture
        • v2 - Changements
      • OpenSearch - Didacticiels
    • PostgreSQL
      • PostgreSQL - Architecture
      • PostgreSQL - Didacticiels
      • PostgreSQL - Mise à jour
    • Redis
      • Redis - Architecture
      • Redis - Didacticiels
      • Redis - Mise à jour
    • SQL Server
      • SQL Server - Architecture
      • SQL Server - Didacticiels
  • Message
    • Apache Kafka
      • Apache Kafka - Architecture
      • Apache Kafka - Didacticiels
      • Apache Kafka - Mise à jour
    • RabbitMQ
      • RabbitMQ - Architecture
      • RabbitMQ - Didacticiels
    • SMS
      • SMS - Didacticiels
  • Securité
    • Advanced Vulnerability Assessment
    • Bot Defense
      • Bot Defense - Architecture
    • Campagne de Phishing
    • Data Masking
      • Data Masking - Didacticiels
  • Surveillance
    • ExtraHop
  • Stockage
    • GlusterFS
      • GlusterFS - Architecture
      • GlusterFS - Didacticiels
    • OverDrive
      • OverDrive - Architecture
    • Stockage Objet
      • Stockage Objet - Architecture
        • Compatibilité API S3
        • Limitation et bonnes pratiques
        • URL pré-signée
        • Politiques de Buckets
        • Configuration de cycle de vie
        • Object Lock
      • Stockage Objet - Didacticiels
        • Gérer des Objects Users
        • Gérer des versions dans un Bucket
        • Gérer l'accès à un Bucket
Powered by GitBook
On this page
Export as PDF
  1. ITCare API
  2. Reference API
  3. Networking

Load Balancers

PreviousDomainsNextNetwork Clusters

Last updated 4 months ago

Get Load Balancer URLs

get
Authorizations
Path parameters
idinteger · int64Required
Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
get
GET /itcare/networking/loadbalancers/{id}/urls HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
[
  {
    "comment": "text",
    "creationTime": "text",
    "creationUser": "text",
    "description": "text",
    "endOfSalesAt": "2025-05-08T20:58:40.134Z",
    "endOfSupportAt": "2025-05-08T20:58:40.134Z",
    "environment": "text",
    "extendedSupportAt": "2025-05-08T20:58:40.134Z",
    "id": 1,
    "monitoringAlerting": true,
    "monitoringEnabled": true,
    "monitoringMode": "text",
    "monitoringOnCallEnabled": true,
    "name": "text",
    "releasedAt": "2025-05-08T20:58:40.134Z",
    "serviceId": 1,
    "serviceKey": "text",
    "serviceName": "text",
    "specificChecks": [
      {
        "name": "text",
        "parameter": {
          "authentification": {
            "password": "text",
            "user": "text"
          },
          "criticalContent": "text",
          "criticalStatus": "text",
          "expectedContent": "text",
          "headers": [
            {
              "key": "text",
              "value": "text"
            }
          ],
          "method": "text",
          "parameters": [
            {
              "key": "text",
              "value": "text"
            }
          ],
          "path": "text",
          "port": 1,
          "prefix": "text",
          "protocol": "text",
          "warningContent": "text"
        }
      }
    ],
    "status": "text",
    "supportPhase": "text",
    "tags": [
      {
        "tagKey": "text",
        "tagValue": "text"
      }
    ],
    "type": "text"
  }
]

Get Load Balancer pool members

get
Authorizations
Path parameters
idinteger · int64Required
Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
get
GET /itcare/networking/loadbalancers/{id}/members HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
[
  {
    "address": "text",
    "category": "text",
    "family": "text",
    "internalType": "text",
    "labelArea": "text",
    "name": "text",
    "port": 1,
    "productName": "text",
    "resourceId": 1,
    "serviceId": 1,
    "state": "text",
    "status": "text",
    "technicalId": "text",
    "technology": "text"
  }
]

Get Load Balancers by id

get
Authorizations
Path parameters
idinteger · int64Required
Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
get
GET /itcare/networking/loadbalancers/{id} HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
{
  "backupPolicyDetails": {
    "backups": [
      {
        "backupLastDate": "2025-05-08T20:58:40.134Z",
        "backupSize": 1,
        "id": 1,
        "type": "text"
      }
    ],
    "policies": [
      {
        "backupLastDate": "2025-05-08T20:58:40.134Z",
        "backupSize": 1,
        "durationInHours": 1,
        "frequencies": {},
        "label": "text",
        "name": "text",
        "policyId": "text",
        "replication": true,
        "scope": "text",
        "startTime": "text",
        "timezone": "text",
        "type": "text"
      }
    ]
  },
  "backupStatus": true,
  "botDefenseEnabled": true,
  "botDefenseUpdating": true,
  "category": "text",
  "certificate": {
    "certificateName": "text",
    "commonName": "text",
    "description": "text",
    "expirationDate": "text",
    "id": 1
  },
  "cloudId": 1,
  "cloudName": "text",
  "comment": "text",
  "creationTime": "text",
  "creationUser": "text",
  "defaultPersistence": "text",
  "endOfSalesAt": "2025-05-08T20:58:40.134Z",
  "endOfSupportAt": "2025-05-08T20:58:40.134Z",
  "environment": "text",
  "extendedSupportAt": "2025-05-08T20:58:40.134Z",
  "fallbackPersistence": "text",
  "family": "text",
  "healthChecks": [
    {
      "comment": "text",
      "description": "text",
      "id": 1,
      "name": "text"
    }
  ],
  "id": 1,
  "internalResourceId": 1,
  "internalType": "text",
  "ipAddress": "text",
  "irules": [
    {
      "description": "text",
      "name": "text"
    }
  ],
  "label": "text",
  "loadBalancingMode": "text",
  "members": [
    {
      "area": {
        "availabilityZones": [
          {
            "availabilityZoneGroup": "text",
            "datacenterId": "text",
            "defaultZone": true,
            "id": "text",
            "location": "text",
            "routable": true
          }
        ],
        "defaultArea": true,
        "id": "text",
        "location": "text",
        "regulation": "text"
      },
      "authenticationDomain": "text",
      "availabilityZone": {
        "availabilityZoneGroup": "text",
        "datacenterId": "text",
        "defaultZone": true,
        "id": "text",
        "location": "text",
        "routable": true
      },
      "backup": {
        "backupSystem": "text",
        "filesNb": 1,
        "lastDate": "2025-05-08T20:58:40.134Z",
        "size": 1,
        "type": "text"
      },
      "backupPolicyDetails": {
        "backups": [
          {
            "backupLastDate": "2025-05-08T20:58:40.134Z",
            "backupSize": 1,
            "id": 1,
            "type": "text"
          }
        ],
        "policies": [
          {
            "backupLastDate": "2025-05-08T20:58:40.134Z",
            "backupSize": 1,
            "durationInHours": 1,
            "frequencies": {},
            "label": "text",
            "name": "text",
            "policyId": "text",
            "replication": true,
            "scope": "text",
            "startTime": "text",
            "timezone": "text",
            "type": "text"
          }
        ]
      },
      "backupStatus": true,
      "category": "text",
      "cloudId": 1,
      "cloudName": "text",
      "comment": "text",
      "cpu": 1,
      "creationTime": "text",
      "creationUser": "text",
      "endOfSalesAt": "2025-05-08T20:58:40.134Z",
      "endOfSupportAt": "2025-05-08T20:58:40.134Z",
      "environment": "text",
      "extendedSupportAt": "2025-05-08T20:58:40.134Z",
      "family": "text",
      "id": 1,
      "imageCode": "text",
      "internalResourceId": 1,
      "internalType": "text",
      "ipAddress": "text",
      "isExternalIngressNode": true,
      "isInternalIngressNode": true,
      "isMemberOFLoadBalancer": true,
      "label": "text",
      "labelArea": "text",
      "labelAvailabilityZone": "text",
      "labelDataCenter": "text",
      "labelRegion": "text",
      "loadbalancers": [
        {
          "id": 1,
          "memberCount": 1,
          "monitoringEnabled": true,
          "name": "text",
          "serviceId": 1,
          "status": "text"
        }
      ],
      "metrologyUrl": "text",
      "monitoringAlerting": true,
      "monitoringEnabled": true,
      "monitoringOnCallEnabled": true,
      "monitoringRequested": true,
      "name": "text",
      "network": {
        "area": "text",
        "cidr": "text",
        "cloud": "text",
        "defaultNetwork": true,
        "description": "text",
        "dns": [
          {
            "alias": "text",
            "domain": "text"
          }
        ],
        "environment": "text",
        "gateway": "text",
        "id": 1,
        "ipAddress": "text",
        "ipFreeNumber": 1,
        "isIpRangePublic": true,
        "mask": "text",
        "networkShortDescription": "text",
        "region": "text",
        "scope": "text",
        "shortDescription": "text",
        "technicalId": "text",
        "usedPercent": 1
      },
      "osName": "text",
      "osType": "text",
      "parentResourceType": "text",
      "patchParty": {
        "excluded": true,
        "excludedBy": "text",
        "exclusionDate": "2025-05-08T20:58:40.134Z",
        "exclusionReason": "text",
        "id": 1,
        "name": "text",
        "patchDate": "2025-05-08T20:58:40.134Z",
        "patchGroup": "text",
        "patchTag": "text"
      },
      "path": "text",
      "prettyLabel": "text",
      "productCode": "text",
      "productName": "text",
      "productVersion": "text",
      "ram": 1,
      "region": {
        "areas": [
          {
            "availabilityZones": [
              {
                "availabilityZoneGroup": "text",
                "datacenterId": "text",
                "defaultZone": true,
                "id": "text",
                "location": "text",
                "routable": true
              }
            ],
            "defaultArea": true,
            "id": "text",
            "location": "text",
            "regulation": "text"
          }
        ],
        "dataCenter": "text",
        "id": "text",
        "location": "text"
      },
      "releasedAt": "2025-05-08T20:58:40.134Z",
      "replication": {
        "noStoRplExplanation": "text",
        "storageClass": "text",
        "storageClassOverride": "text",
        "storageMoveInProgress": true,
        "storageMoveTicket": "text",
        "storageReplicationClass": "text"
      },
      "replicationStatus": true,
      "resourceType": "text",
      "serviceId": 1,
      "serviceKey": "text",
      "serviceName": "text",
      "snapshot": {
        "changeReference": "text",
        "createdAt": "2025-05-08T20:58:40.134Z",
        "createdBy": "text",
        "description": "text",
        "expiresAt": "2025-05-08T20:58:40.134Z",
        "id": "text",
        "label": "text",
        "recoveredAt": "2025-05-08T20:58:40.134Z",
        "snapshotSize": 1
      },
      "status": "text",
      "storage": 1,
      "storageInformation": {
        "fileSystems": [
          {
            "free": 1,
            "mountingPoint": "text",
            "sizeOf": 1,
            "type": "text"
          }
        ],
        "totalSizeDisks": 1,
        "totalSizeFileSystems": 1
      },
      "storageMoveInProgress": true,
      "supportPhase": "text",
      "technology": "text",
      "type": "text"
    }
  ],
  "metrologyUrl": "text",
  "monitoringAlerting": true,
  "monitoringEnabled": true,
  "monitoringOnCallEnabled": true,
  "monitoringRequested": true,
  "name": "text",
  "network": {
    "area": "text",
    "cidr": "text",
    "cloud": "text",
    "defaultNetwork": true,
    "description": "text",
    "dns": [
      {
        "alias": "text",
        "domain": "text"
      }
    ],
    "environment": "text",
    "gateway": "text",
    "id": 1,
    "ipAddress": "text",
    "ipFreeNumber": 1,
    "isIpRangePublic": true,
    "mask": "text",
    "networkShortDescription": "text",
    "region": "text",
    "scope": "text",
    "shortDescription": "text",
    "technicalId": "text",
    "usedPercent": 1
  },
  "nodeCount": 1,
  "parentResource": {
    "backupPolicyDetails": {
      "backups": [
        {
          "backupLastDate": "2025-05-08T20:58:40.134Z",
          "backupSize": 1,
          "id": 1,
          "type": "text"
        }
      ],
      "policies": [
        {
          "backupLastDate": "2025-05-08T20:58:40.134Z",
          "backupSize": 1,
          "durationInHours": 1,
          "frequencies": {},
          "label": "text",
          "name": "text",
          "policyId": "text",
          "replication": true,
          "scope": "text",
          "startTime": "text",
          "timezone": "text",
          "type": "text"
        }
      ]
    },
    "backupStatus": true,
    "category": "text",
    "cloudId": 1,
    "cloudName": "text",
    "comment": "text",
    "creationTime": "text",
    "creationUser": "text",
    "endOfSalesAt": "2025-05-08T20:58:40.134Z",
    "endOfSupportAt": "2025-05-08T20:58:40.134Z",
    "environment": "text",
    "extendedSupportAt": "2025-05-08T20:58:40.134Z",
    "family": "text",
    "id": 1,
    "internalResourceId": 1,
    "internalType": "text",
    "label": "text",
    "metrologyUrl": "text",
    "monitoringAlerting": true,
    "monitoringEnabled": true,
    "monitoringOnCallEnabled": true,
    "monitoringRequested": true,
    "name": "text",
    "patchParty": {
      "excluded": true,
      "excludedBy": "text",
      "exclusionDate": "2025-05-08T20:58:40.134Z",
      "exclusionReason": "text",
      "id": 1,
      "name": "text",
      "patchDate": "2025-05-08T20:58:40.134Z",
      "patchGroup": "text",
      "patchTag": "text"
    },
    "path": "text",
    "prettyLabel": "text",
    "productCode": "text",
    "productName": "text",
    "productVersion": "text",
    "releasedAt": "2025-05-08T20:58:40.134Z",
    "replicationStatus": true,
    "resourceType": "text",
    "serviceId": 1,
    "serviceKey": "text",
    "serviceName": "text",
    "status": "text",
    "supportPhase": "text",
    "technology": "text",
    "type": "text"
  },
  "patchParty": {
    "excluded": true,
    "excludedBy": "text",
    "exclusionDate": "2025-05-08T20:58:40.134Z",
    "exclusionReason": "text",
    "id": 1,
    "name": "text",
    "patchDate": "2025-05-08T20:58:40.134Z",
    "patchGroup": "text",
    "patchTag": "text"
  },
  "path": "text",
  "prettyLabel": "text",
  "productCode": "text",
  "productName": "text",
  "productVersion": "text",
  "protocols": [
    {
      "comment": "text",
      "isCertificateRequired": true,
      "name": "text",
      "order": 1,
      "persistence": true,
      "port": 1,
      "profileNoPersistenceNoRedirect": "text",
      "profileNoPersistenceOnly": "text",
      "profileNoPersistenceRedirect": "text",
      "profilePersistenceNoRedirect": "text",
      "profilePersistenceOnly": "text",
      "profilePersistenceRedirect": "text",
      "protocol": "text",
      "redirectToHttps": true
    }
  ],
  "releasedAt": "2025-05-08T20:58:40.134Z",
  "replicationStatus": true,
  "resourceType": "text",
  "securityProfile": {
    "comment": "text",
    "description": "text",
    "enforcement": "text",
    "id": "text",
    "name": "text",
    "profile": "text",
    "template": "text",
    "whiteList": [
      {
        "comment": "text",
        "ip": "text",
        "url": "text"
      }
    ]
  },
  "serviceId": 1,
  "serviceKey": "text",
  "serviceName": "text",
  "snatAutomap": true,
  "status": "text",
  "supportPhase": "text",
  "technology": "text",
  "type": "text",
  "urls": [
    {
      "comment": "text",
      "creationTime": "text",
      "creationUser": "text",
      "description": "text",
      "endOfSalesAt": "2025-05-08T20:58:40.134Z",
      "endOfSupportAt": "2025-05-08T20:58:40.134Z",
      "environment": "text",
      "extendedSupportAt": "2025-05-08T20:58:40.134Z",
      "id": 1,
      "monitoringAlerting": true,
      "monitoringEnabled": true,
      "monitoringMode": "text",
      "monitoringOnCallEnabled": true,
      "name": "text",
      "releasedAt": "2025-05-08T20:58:40.134Z",
      "serviceId": 1,
      "serviceKey": "text",
      "serviceName": "text",
      "specificChecks": [
        {
          "name": "text",
          "parameter": {
            "authentification": {
              "password": "text",
              "user": "text"
            },
            "criticalContent": "text",
            "criticalStatus": "text",
            "expectedContent": "text",
            "headers": [
              {
                "key": "text",
                "value": "text"
              }
            ],
            "method": "text",
            "parameters": [
              {
                "key": "text",
                "value": "text"
              }
            ],
            "path": "text",
            "port": 1,
            "prefix": "text",
            "protocol": "text",
            "warningContent": "text"
          }
        }
      ],
      "status": "text",
      "supportPhase": "text",
      "tags": [
        {
          "tagKey": "text",
          "tagValue": "text"
        }
      ],
      "type": "text"
    }
  ]
}

Delete load balancer url

delete

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

Authorizations
Path parameters
idinteger · int64Required

Load Balancer Id, example: 123

urlIdinteger · int64Required

Load Balancer Url Id, example: 123

Responses
202
Accepted
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
delete
DELETE /itcare/networking/loadbalancers/{id}/urls/{urlId} HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-05-08T20:58:40.134Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

Delete a member from a Load Balancer pool

delete
Authorizations
Path parameters
idinteger · int64Required
memberIdstringRequired
Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
delete
DELETE /itcare/networking/loadbalancers/{id}/members/{memberId} HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
[
  {
    "address": "text",
    "category": "text",
    "family": "text",
    "internalType": "text",
    "labelArea": "text",
    "name": "text",
    "port": 1,
    "productName": "text",
    "resourceId": 1,
    "serviceId": 1,
    "state": "text",
    "status": "text",
    "technicalId": "text",
    "technology": "text"
  }
]

Get Load Balancer Stats

get
Authorizations
Path parameters
idinteger · int64Required
Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
get
GET /itcare/networking/loadbalancers/{id}/stats HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
[
  {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  }
]

Get Load Balancer SSL profile configuration

get
Authorizations
Path parameters
idinteger · int64Required
Query parameters
urlstringOptional

url, example: url

Default: url
Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
get
GET /itcare/networking/loadbalancers/{id}/ssl-profiles HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
{
  "isValidSSLProfilInstalled": true,
  "validSSLProfiles": [
    {
      "certificat": "text",
      "description": "text",
      "id": 1,
      "name": "text",
      "serverName": "text",
      "sniDefault": true
    }
  ]
}

Get Load Balancer Events

get
Authorizations
Path parameters
idinteger · int64Required

id, example: 500067154

Query parameters
fromstring · date-timeRequired

From Date (ISO8601 format), example: 2023-03-15T00:00:00.000Z

tostring · date-timeRequired

To Date (ISO8601 format), example: 2023-03-16T00:00:00.000Z

typestringOptional

type, example: security

Default: security
criteriastringOptional

criteria, example: bot

Default: bot
sizeinteger · int32Optional

size, example: 20

Default: 20
Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
get
GET /itcare/networking/loadbalancers/{id}/events HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
[
  {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
]

Get Load Balancers protocols

get
Authorizations
Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
get
GET /itcare/networking/loadbalancers/protocols HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
[
  {
    "comment": "text",
    "isCertificateRequired": true,
    "name": "text",
    "order": 1,
    "persistence": true,
    "port": 1,
    "profileNoPersistenceNoRedirect": "text",
    "profileNoPersistenceOnly": "text",
    "profileNoPersistenceRedirect": "text",
    "profilePersistenceNoRedirect": "text",
    "profilePersistenceOnly": "text",
    "profilePersistenceRedirect": "text",
    "protocol": "text",
    "redirectToHttps": true
  }
]

Get Load Balancers Internal Whitelist

get
Authorizations
Responses
200
OK
application/vnd.cegedim-it.v1+json
Responsestring[]
400
Bad Request
*/*
get
GET /itcare/networking/loadbalancers/internal-whitelist HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
[
  "text"
]
  • GETList Load Balancer
  • POSTCreate a new load balancer
  • GETGet Load Balancer URLs
  • POSTCreate a new load balancer url
  • GETGet Load Balancer pool members
  • POSTAdd Load Balancer pool member.
  • GETGet Load Balancers by id
  • DELETEDelete load balancer
  • PATCHUpdate Load Balancer
  • DELETEDelete load balancer url
  • PATCHUpdate Load Balancer Url
  • DELETEDelete a member from a Load Balancer pool
  • PATCHUpdate Load Balancer pool member
  • GETGet Load Balancer Stats
  • GETGet Load Balancer SSL profile configuration
  • GETGet Load Balancer Events
  • GETGet Load Balancers protocols
  • GETGet Load Balancers Internal Whitelist

List Load Balancer

get
Authorizations
Query parameters
servicesinteger · int64[]Optional
namesstring[]Optional

Names, example: resource01,!resource02,resource42

environmentsstring[]Optional

Environments, example: PRODUCTION,DEVELOPMENT

statusesstring[]Optional

Status, example: ACTIVE,INACTIVE

tagsstring[]Optional

Tags, example: mytagkey:mytagvalue,application:itcare

botdefensebooleanOptional
monitoringStatusbooleanOptional

Filter list by monitoring status

monitoringOnCallStatusbooleanOptional

Filter list by monitoring on call status

urlsstring[]Optional

URLs, example: .cegedim.cloud

iRulesstring[]Optional

IRules, iRule-Redirect-gis-workflow

defaultPersistencestring[]Optional

Default Persistence, example: cookie,hash, or source_addr etc...

fallbackPersistencestring[]Optional

Fallback Persistence, example: dest_addr, source_addr, etc...

loadBalancingModestring[]Optional

Load Balancing Mode, example: least-connections-node, round-robin, etc...

protocolsstring[]Optional

Protocols, example: HTTP, HTTPS, MYSQL, etc...

vlanstring[]Optional

VLAN, example: EB_1125_DMZ8

cloudsintegerOptional
pagestringOptional

Results page you want to retrieve (0..N)

sizestringOptional

Number of records per page.

sortanyOptional

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria is not supported.

Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
get
GET /itcare/networking/loadbalancers HTTP/1.1
Host: api.cegedim.cloud
Accept: */*
{
  "content": [
    {
      "backupPolicyDetails": {
        "backups": [
          {
            "backupLastDate": "2025-05-08T20:58:40.134Z",
            "backupSize": 1,
            "id": 1,
            "type": "text"
          }
        ],
        "policies": [
          {
            "backupLastDate": "2025-05-08T20:58:40.134Z",
            "backupSize": 1,
            "durationInHours": 1,
            "frequencies": {},
            "label": "text",
            "name": "text",
            "policyId": "text",
            "replication": true,
            "scope": "text",
            "startTime": "text",
            "timezone": "text",
            "type": "text"
          }
        ]
      },
      "backupStatus": true,
      "botDefenseEnabled": true,
      "botDefenseUpdating": true,
      "category": "text",
      "certificate": {
        "certificateName": "text",
        "commonName": "text",
        "description": "text",
        "expirationDate": "text",
        "id": 1
      },
      "cloudId": 1,
      "cloudName": "text",
      "comment": "text",
      "creationTime": "text",
      "creationUser": "text",
      "defaultPersistence": "text",
      "endOfSalesAt": "2025-05-08T20:58:40.134Z",
      "endOfSupportAt": "2025-05-08T20:58:40.134Z",
      "environment": "text",
      "extendedSupportAt": "2025-05-08T20:58:40.134Z",
      "fallbackPersistence": "text",
      "family": "text",
      "healthChecks": [
        {
          "comment": "text",
          "description": "text",
          "id": 1,
          "name": "text"
        }
      ],
      "id": 1,
      "internalResourceId": 1,
      "internalType": "text",
      "ipAddress": "text",
      "irules": [
        {
          "description": "text",
          "name": "text"
        }
      ],
      "label": "text",
      "loadBalancingMode": "text",
      "members": [
        {
          "area": {
            "availabilityZones": [
              {
                "availabilityZoneGroup": "text",
                "datacenterId": "text",
                "defaultZone": true,
                "id": "text",
                "location": "text",
                "routable": true
              }
            ],
            "defaultArea": true,
            "id": "text",
            "location": "text",
            "regulation": "text"
          },
          "authenticationDomain": "text",
          "availabilityZone": {
            "availabilityZoneGroup": "text",
            "datacenterId": "text",
            "defaultZone": true,
            "id": "text",
            "location": "text",
            "routable": true
          },
          "backup": {
            "backupSystem": "text",
            "filesNb": 1,
            "lastDate": "2025-05-08T20:58:40.134Z",
            "size": 1,
            "type": "text"
          },
          "backupPolicyDetails": {
            "backups": [
              {
                "backupLastDate": "2025-05-08T20:58:40.134Z",
                "backupSize": 1,
                "id": 1,
                "type": "text"
              }
            ],
            "policies": [
              {
                "backupLastDate": "2025-05-08T20:58:40.134Z",
                "backupSize": 1,
                "durationInHours": 1,
                "frequencies": {},
                "label": "text",
                "name": "text",
                "policyId": "text",
                "replication": true,
                "scope": "text",
                "startTime": "text",
                "timezone": "text",
                "type": "text"
              }
            ]
          },
          "backupStatus": true,
          "category": "text",
          "cloudId": 1,
          "cloudName": "text",
          "comment": "text",
          "cpu": 1,
          "creationTime": "text",
          "creationUser": "text",
          "endOfSalesAt": "2025-05-08T20:58:40.134Z",
          "endOfSupportAt": "2025-05-08T20:58:40.134Z",
          "environment": "text",
          "extendedSupportAt": "2025-05-08T20:58:40.134Z",
          "family": "text",
          "id": 1,
          "imageCode": "text",
          "internalResourceId": 1,
          "internalType": "text",
          "ipAddress": "text",
          "isExternalIngressNode": true,
          "isInternalIngressNode": true,
          "isMemberOFLoadBalancer": true,
          "label": "text",
          "labelArea": "text",
          "labelAvailabilityZone": "text",
          "labelDataCenter": "text",
          "labelRegion": "text",
          "loadbalancers": [
            {
              "id": 1,
              "memberCount": 1,
              "monitoringEnabled": true,
              "name": "text",
              "serviceId": 1,
              "status": "text"
            }
          ],
          "metrologyUrl": "text",
          "monitoringAlerting": true,
          "monitoringEnabled": true,
          "monitoringOnCallEnabled": true,
          "monitoringRequested": true,
          "name": "text",
          "network": {
            "area": "text",
            "cidr": "text",
            "cloud": "text",
            "defaultNetwork": true,
            "description": "text",
            "dns": [
              {
                "alias": "text",
                "domain": "text"
              }
            ],
            "environment": "text",
            "gateway": "text",
            "id": 1,
            "ipAddress": "text",
            "ipFreeNumber": 1,
            "isIpRangePublic": true,
            "mask": "text",
            "networkShortDescription": "text",
            "region": "text",
            "scope": "text",
            "shortDescription": "text",
            "technicalId": "text",
            "usedPercent": 1
          },
          "osName": "text",
          "osType": "text",
          "parentResourceType": "text",
          "patchParty": {
            "excluded": true,
            "excludedBy": "text",
            "exclusionDate": "2025-05-08T20:58:40.134Z",
            "exclusionReason": "text",
            "id": 1,
            "name": "text",
            "patchDate": "2025-05-08T20:58:40.134Z",
            "patchGroup": "text",
            "patchTag": "text"
          },
          "path": "text",
          "prettyLabel": "text",
          "productCode": "text",
          "productName": "text",
          "productVersion": "text",
          "ram": 1,
          "region": {
            "areas": [
              {
                "availabilityZones": [
                  {
                    "availabilityZoneGroup": "text",
                    "datacenterId": "text",
                    "defaultZone": true,
                    "id": "text",
                    "location": "text",
                    "routable": true
                  }
                ],
                "defaultArea": true,
                "id": "text",
                "location": "text",
                "regulation": "text"
              }
            ],
            "dataCenter": "text",
            "id": "text",
            "location": "text"
          },
          "releasedAt": "2025-05-08T20:58:40.134Z",
          "replication": {
            "noStoRplExplanation": "text",
            "storageClass": "text",
            "storageClassOverride": "text",
            "storageMoveInProgress": true,
            "storageMoveTicket": "text",
            "storageReplicationClass": "text"
          },
          "replicationStatus": true,
          "resourceType": "text",
          "serviceId": 1,
          "serviceKey": "text",
          "serviceName": "text",
          "snapshot": {
            "changeReference": "text",
            "createdAt": "2025-05-08T20:58:40.134Z",
            "createdBy": "text",
            "description": "text",
            "expiresAt": "2025-05-08T20:58:40.134Z",
            "id": "text",
            "label": "text",
            "recoveredAt": "2025-05-08T20:58:40.134Z",
            "snapshotSize": 1
          },
          "status": "text",
          "storage": 1,
          "storageInformation": {
            "fileSystems": [
              {
                "free": 1,
                "mountingPoint": "text",
                "sizeOf": 1,
                "type": "text"
              }
            ],
            "totalSizeDisks": 1,
            "totalSizeFileSystems": 1
          },
          "storageMoveInProgress": true,
          "supportPhase": "text",
          "technology": "text",
          "type": "text"
        }
      ],
      "metrologyUrl": "text",
      "monitoringAlerting": true,
      "monitoringEnabled": true,
      "monitoringOnCallEnabled": true,
      "monitoringRequested": true,
      "name": "text",
      "network": {
        "area": "text",
        "cidr": "text",
        "cloud": "text",
        "defaultNetwork": true,
        "description": "text",
        "dns": [
          {
            "alias": "text",
            "domain": "text"
          }
        ],
        "environment": "text",
        "gateway": "text",
        "id": 1,
        "ipAddress": "text",
        "ipFreeNumber": 1,
        "isIpRangePublic": true,
        "mask": "text",
        "networkShortDescription": "text",
        "region": "text",
        "scope": "text",
        "shortDescription": "text",
        "technicalId": "text",
        "usedPercent": 1
      },
      "nodeCount": 1,
      "parentResource": {
        "backupPolicyDetails": {
          "backups": [
            {
              "backupLastDate": "2025-05-08T20:58:40.134Z",
              "backupSize": 1,
              "id": 1,
              "type": "text"
            }
          ],
          "policies": [
            {
              "backupLastDate": "2025-05-08T20:58:40.134Z",
              "backupSize": 1,
              "durationInHours": 1,
              "frequencies": {},
              "label": "text",
              "name": "text",
              "policyId": "text",
              "replication": true,
              "scope": "text",
              "startTime": "text",
              "timezone": "text",
              "type": "text"
            }
          ]
        },
        "backupStatus": true,
        "category": "text",
        "cloudId": 1,
        "cloudName": "text",
        "comment": "text",
        "creationTime": "text",
        "creationUser": "text",
        "endOfSalesAt": "2025-05-08T20:58:40.134Z",
        "endOfSupportAt": "2025-05-08T20:58:40.134Z",
        "environment": "text",
        "extendedSupportAt": "2025-05-08T20:58:40.134Z",
        "family": "text",
        "id": 1,
        "internalResourceId": 1,
        "internalType": "text",
        "label": "text",
        "metrologyUrl": "text",
        "monitoringAlerting": true,
        "monitoringEnabled": true,
        "monitoringOnCallEnabled": true,
        "monitoringRequested": true,
        "name": "text",
        "patchParty": {
          "excluded": true,
          "excludedBy": "text",
          "exclusionDate": "2025-05-08T20:58:40.134Z",
          "exclusionReason": "text",
          "id": 1,
          "name": "text",
          "patchDate": "2025-05-08T20:58:40.134Z",
          "patchGroup": "text",
          "patchTag": "text"
        },
        "path": "text",
        "prettyLabel": "text",
        "productCode": "text",
        "productName": "text",
        "productVersion": "text",
        "releasedAt": "2025-05-08T20:58:40.134Z",
        "replicationStatus": true,
        "resourceType": "text",
        "serviceId": 1,
        "serviceKey": "text",
        "serviceName": "text",
        "status": "text",
        "supportPhase": "text",
        "technology": "text",
        "type": "text"
      },
      "patchParty": {
        "excluded": true,
        "excludedBy": "text",
        "exclusionDate": "2025-05-08T20:58:40.134Z",
        "exclusionReason": "text",
        "id": 1,
        "name": "text",
        "patchDate": "2025-05-08T20:58:40.134Z",
        "patchGroup": "text",
        "patchTag": "text"
      },
      "path": "text",
      "prettyLabel": "text",
      "productCode": "text",
      "productName": "text",
      "productVersion": "text",
      "protocols": [
        {
          "comment": "text",
          "isCertificateRequired": true,
          "name": "text",
          "order": 1,
          "persistence": true,
          "port": 1,
          "profileNoPersistenceNoRedirect": "text",
          "profileNoPersistenceOnly": "text",
          "profileNoPersistenceRedirect": "text",
          "profilePersistenceNoRedirect": "text",
          "profilePersistenceOnly": "text",
          "profilePersistenceRedirect": "text",
          "protocol": "text",
          "redirectToHttps": true
        }
      ],
      "releasedAt": "2025-05-08T20:58:40.134Z",
      "replicationStatus": true,
      "resourceType": "text",
      "securityProfile": {
        "comment": "text",
        "description": "text",
        "enforcement": "text",
        "id": "text",
        "name": "text",
        "profile": "text",
        "template": "text",
        "whiteList": [
          {
            "comment": "text",
            "ip": "text",
            "url": "text"
          }
        ]
      },
      "serviceId": 1,
      "serviceKey": "text",
      "serviceName": "text",
      "snatAutomap": true,
      "status": "text",
      "supportPhase": "text",
      "technology": "text",
      "type": "text",
      "urls": [
        {
          "comment": "text",
          "creationTime": "text",
          "creationUser": "text",
          "description": "text",
          "endOfSalesAt": "2025-05-08T20:58:40.134Z",
          "endOfSupportAt": "2025-05-08T20:58:40.134Z",
          "environment": "text",
          "extendedSupportAt": "2025-05-08T20:58:40.134Z",
          "id": 1,
          "monitoringAlerting": true,
          "monitoringEnabled": true,
          "monitoringMode": "text",
          "monitoringOnCallEnabled": true,
          "name": "text",
          "releasedAt": "2025-05-08T20:58:40.134Z",
          "serviceId": 1,
          "serviceKey": "text",
          "serviceName": "text",
          "specificChecks": [
            {
              "name": "text",
              "parameter": {
                "authentification": {
                  "password": "text",
                  "user": "text"
                },
                "criticalContent": "text",
                "criticalStatus": "text",
                "expectedContent": "text",
                "headers": [
                  {
                    "key": "text",
                    "value": "text"
                  }
                ],
                "method": "text",
                "parameters": [
                  {
                    "key": "text",
                    "value": "text"
                  }
                ],
                "path": "text",
                "port": 1,
                "prefix": "text",
                "protocol": "text",
                "warningContent": "text"
              }
            }
          ],
          "status": "text",
          "supportPhase": "text",
          "tags": [
            {
              "tagKey": "text",
              "tagValue": "text"
            }
          ],
          "type": "text"
        }
      ]
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 1,
  "numberOfElements": 1,
  "pageable": {
    "offset": 1,
    "pageNumber": 1,
    "pageSize": 1,
    "paged": true,
    "sort": [
      {
        "ascending": true,
        "direction": "text",
        "ignoreCase": true,
        "nullHandling": "text",
        "property": "text"
      }
    ],
    "unpaged": true
  },
  "size": 1,
  "sort": [
    {
      "ascending": true,
      "direction": "text",
      "ignoreCase": true,
      "nullHandling": "text",
      "property": "text"
    }
  ],
  "totalElements": 1,
  "totalPages": 1
}

Create a new load balancer

post

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"
	 }
  }
  ]
}
Authorizations
Body

Describes a load balancer.

areastringOptional

Area. Refer to an Area of a Region, that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.

backupEnabledbooleanOptional

Indicates if backup has to be setup on instance. If absent, backup will be setup automatically if instance is in a production service.

certificateNamestringOptional

certificate of the load balancer., example: wildcard_cegedim.com

cloudIdinteger · int64Optional
dbBackupPolicyIdstringOptional

BackupPolicy id. Refers to desired backup policy to be applied for the database, must be set when backup is enabled.

healthcheckstringRequired

healtcheck of load balancer., example: http

monitoringAlertingbooleanOptional

Indicates if alerting should be activated. If absent, set to false.

monitoringEnabledbooleanOptional

Indicates if monitoring will be setup. If absent, it will be automatically be setup if this is an production environment, or if backup is enabled.

networkIdinteger · int64Optional

Network id. Refer to networks available in List Networks method. If absent, a default network of AZ will be used.

noBackupProdReasonstringOptional

Indicates why a production resource is not under backup.

noMonitoringProdReasonstringOptional

Indicates why a production resource is not under monitoring.

noReplicationProdReasonstringOptional

Indicates why a production resource is not replicated.

onCallSupervisionbooleanOptional

Indicates if on call teams will be called on non business hours if an incident occurs on instance. If absent, set to false.

persistencebooleanOptional
portMembersstringRequired

port member of load balancer., example: 80, 443, ...

profileNamestringRequired

profile name of load balancer.

redirectToHttpsbooleanOptional
regionstringRequired

Region. that is a low-latency network area, available in List Regions method. If absent, default Area of Region will be used.

regulationstringOptional

Regulation. Refer to the regulation of the Area (HDS|STANDARD). If absent, default 'STANDARD' will be used.

replicationEnabledbooleanOptional

Indicates if replication will be setup. If absent, it will be automatically be setup if this is an production environment

serverBackupPolicyIdstringOptional

BackupPolicy id. Refers to desired backup policy to be applied for the virtual machine, must be set when backup is enabled.

serviceIdinteger · int64Required

id of service to put instance in.

setUpDNSEnabledbooleanOptional

Indicates if a DNS record is to be set. If absent, set to false.

sslProfilestringOptional

ssl profile of the load balancer., example: profile_wildcard.cegedim.com_secure

urlstringRequired

url of load balancer. Must be unique, and fit naming rules convention., example: url.cegedim.com

Pattern: ^(https?:\\/\\/)?(www\\.)?[a-zA-Z][a-zA-Z0-9.-]{2,63}+$
vsPortinteger · int32Optional

port of load balancer in case of TCP VS Profile

Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
post
POST /itcare/networking/loadbalancers HTTP/1.1
Host: api.cegedim.cloud
Content-Type: application/json
Accept: */*
Content-Length: 712

{
  "area": "text",
  "backupEnabled": true,
  "certificateName": "text",
  "cloudId": 1,
  "dbBackupPolicyId": "text",
  "healthcheck": "text",
  "members": [
    {
      "id": 1,
      "name": "text",
      "network": {
        "area": "text",
        "cidr": "text",
        "id": 1,
        "ipAddress": "text",
        "name": "text",
        "region": "text",
        "technicalId": "text"
      }
    }
  ],
  "monitoringAlerting": true,
  "monitoringEnabled": true,
  "networkId": 1,
  "noBackupProdReason": "text",
  "noMonitoringProdReason": "text",
  "noReplicationProdReason": "text",
  "onCallSupervision": true,
  "persistence": true,
  "portMembers": "text",
  "profileName": "text",
  "redirectToHttps": true,
  "region": "text",
  "regulation": "text",
  "replicationEnabled": true,
  "serverBackupPolicyId": "text",
  "serviceId": 1,
  "setUpDNSEnabled": true,
  "sslProfile": "text",
  "url": "text",
  "vsPort": 1
}
{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-05-08T20:58:40.134Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

Create a new load balancer url

post

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
}
Authorizations
Path parameters
idinteger · int64Required
Body

Describes a load balancer.

monitoringEnabledbooleanOptional

Indicates if monitoring will be setup.

namestringRequired

url of load balancer. Must be unique, and fit naming rules convention., example: url.cegedim.com

Pattern: ^(https?:\\/\\/)?(www\\.)?[a-zA-Z][a-zA-Z0-9.-]{2,63}+$
onCallSupervisionbooleanOptional

Indicates if on call teams will be called on non business hours if an incident occurs on instance. If absent, set to false.

setUpDNSEnabledbooleanOptional

Indicates if a DNS record is to be set. If absent, set to false.

sslProfilestringOptional

ssl profile of the load balancer., example: profile_wildcard.cegedim.com_secure

Responses
202
Accepted
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
post
POST /itcare/networking/loadbalancers/{id}/urls HTTP/1.1
Host: api.cegedim.cloud
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "monitoringEnabled": true,
  "name": "text",
  "onCallSupervision": true,
  "setUpDNSEnabled": true,
  "sslProfile": "text"
}
{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-05-08T20:58:40.134Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

Add Load Balancer pool member.

post

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

Authorizations
Path parameters
idinteger · int64Required
Body
addressstringOptional

IP address of the member.

categorystringOptional

Category of the member

familystringOptional

Family of the member

internalTypestringOptional

Internal type of the member of the member

labelAreastringOptional

Area on which the member is located

namestringOptional

Name of the member on the loadbalancer

portinteger · int32 · max: 65535Required

port of the member., example: 80, 443, ...

productNamestringOptional

Name of the member of the member

resourceIdinteger · int64Required

Id of the resource. Required when an operation is performed.

serviceIdinteger · int64Optional

serviceId on which this member belongs to

statestringOptional

Member state. (enabled, disabled, offline)

statusstringOptional

Status of the member. (up, down, user_down)

technicalIdstringOptional

Technical Network on which the member is located

technologystringOptional

Technology of the member

Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
post
POST /itcare/networking/loadbalancers/{id}/members HTTP/1.1
Host: api.cegedim.cloud
Content-Type: application/json
Accept: */*
Content-Length: 238

{
  "address": "text",
  "category": "text",
  "family": "text",
  "internalType": "text",
  "labelArea": "text",
  "name": "text",
  "port": 1,
  "productName": "text",
  "resourceId": 1,
  "serviceId": 1,
  "state": "text",
  "status": "text",
  "technicalId": "text",
  "technology": "text"
}
[
  {
    "address": "text",
    "category": "text",
    "family": "text",
    "internalType": "text",
    "labelArea": "text",
    "name": "text",
    "port": 1,
    "productName": "text",
    "resourceId": 1,
    "serviceId": 1,
    "state": "text",
    "status": "text",
    "technicalId": "text",
    "technology": "text"
  }
]

Delete load balancer

delete
Authorizations
Path parameters
idinteger · int64Required
Body

Parameters when deleting a resource

changeReferencestring · max: 10Optional

Optional reference for change

Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
delete
DELETE /itcare/networking/loadbalancers/{id} HTTP/1.1
Host: api.cegedim.cloud
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "changeReference": "text"
}
{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-05-08T20:58:40.134Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

Update Load Balancer

patch

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"
       ]
    }
}
Authorizations
Path parameters
idinteger · int64Required

Load Balancer Id, example: 123

Body

Object describing a partial modification of an object to perform. Please refer to documentation to get list of operations available and their specific payload.

operationstringRequired

Operation to perform on target object, example: operation_name

Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
patch
PATCH /itcare/networking/loadbalancers/{id} HTTP/1.1
Host: api.cegedim.cloud
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "operation": "text",
  "options": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}
{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-05-08T20:58:40.134Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

Update Load Balancer Url

patch

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
    }
}
Authorizations
Path parameters
idinteger · int64Required

Load Balancer Id, example: 123

urlIdinteger · int64Required

Load Balancer Url Id, example: 123

Body

Object describing a partial modification of an object to perform. Please refer to documentation to get list of operations available and their specific payload.

operationstringRequired

Operation to perform on target object, example: operation_name

Responses
202
Accepted
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
patch
PATCH /itcare/networking/loadbalancers/{id}/urls/{urlId} HTTP/1.1
Host: api.cegedim.cloud
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "operation": "text",
  "options": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}
{
  "family": "text",
  "id": 1,
  "internalId": 1,
  "lastUpdatedAt": "2025-05-08T20:58:40.134Z",
  "message": "text",
  "process": "text",
  "resourceName": "text",
  "resourceType": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR"
}

Update Load Balancer pool member

patch

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"
  }
Authorizations
Path parameters
idinteger · int64Required
memberIdstringRequired
Body
operationstringOptional
Responses
200
OK
application/vnd.cegedim-it.v1+json
400
Bad Request
*/*
patch
PATCH /itcare/networking/loadbalancers/{id}/members/{memberId} HTTP/1.1
Host: api.cegedim.cloud
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "operation": "text",
  "options": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}
{
  "address": "text",
  "category": "text",
  "family": "text",
  "internalType": "text",
  "labelArea": "text",
  "name": "text",
  "port": 1,
  "productName": "text",
  "resourceId": 1,
  "serviceId": 1,
  "state": "text",
  "status": "text",
  "technicalId": "text",
  "technology": "text"
}